Changeset 8529

Timestamp:

01/02/08 19:45:53 (4 months ago)

Author:

rick

Message:

Fix atom_feed_helper to comply with the atom spec. Closes #10672 [xaviershay]

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_view/helpers/atom_feed_helper.rb (modified) (6 diffs)
• trunk/actionpack/test/template/atom_feed_helper_test.rb (modified) (4 diffs)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Fix atom_feed_helper to comply with the atom spec.  Closes #10672 [xaviershay]
+
+  * The tags created do not contain a date (http://feedvalidator.org/docs/error/InvalidTAG.html)
+  * IDs are not guaranteed unique
+  * A default self link was not provided, contrary to the documentation
+  * NOTE:  This changes tags for existing atom entries, but at least they validate now.
-
-* Correct indentation in tests.  Closes #10671 [l.guidi]

trunk/actionpack/lib/action_view/helpers/atom_feed_helper.rb

@@ -27 +27 @@
-      #
-      #   app/views/posts/index.atom.builder:
-
+(:tag_uri => "2008")
-      #       feed.title("My great blog!")
-      #       feed.updated((@posts.first.created_at))
@@ -45 +45 @@
-      # The options are for atom_feed are:
-      #
+      # * <tt>:schema_date</tt>: Required. The date at which the tag scheme for the feed was first used. A good default is the year you created the feed. See http://feedvalidator.org/docs/error/InvalidTAG.html for more information.
-      # * <tt>:language</tt>: Defaults to "en-US".
-      # * <tt>:root_url</tt>: The HTML alternative that this feed is doubling for. Defaults to / on the current host.
@@ -51 +52 @@
-      # atom_feed yields a AtomFeedBuilder instance.
-      def atom_feed(options = {}, &block)
+        if options[:schema_date].blank?
+          logger.warn("You must provide the :schema_date option to atom_feed for your feed to be valid. A good default is the year you first created this feed.") unless logger.nil?
+        else
+          options[:schema_date] = options[:schema_date].strftime("%Y-%m-%d") if options[:schema_date].respond_to?(:strftime)
+        end
+        
-        xml = options[:xml] || eval("xml", block.binding)
-        xml.instruct!
-
-        xml.feed "xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom' do
-:#{request.request_uri.split(".")[0].gsub("/", "")
+,#{options[:schema_date]}:#{request.request_uri.split(".")[0]
-          xml.link(:rel => 'alternate', :type => 'text/html', :href => options[:root_url] || (request.protocol + request.host_with_port))
-
-
-
-
-
-
+
+
+
-        end
-      end
@@ -68 +72 @@
-
-      class AtomFeedBuilder
-
- = xml, view
+, feed_options = {}
+, @feed_options = xml, view, feed_options
-        end
-        
@@ -86 +90 @@
-        def entry(record, options = {})
-          @xml.entry do 
-_with_port}:#{record.class}
+},#{@feed_options[:schema_date]}:#{record.class}/
-
-            if options[:published] || (record.respond_to?(:created_at) && record.created_at)
@@ -103 +107 @@
-
-        private
-
-
+, &block
+, &block
-          end
-      end

trunk/actionpack/test/template/atom_feed_helper_test.rb

@@ -6 +6 @@
-  FEEDS = {}
-  FEEDS["defaults"] = <<-EOT
-
+(:schema_date => '2008')
-          feed.title("My great blog!")
-          feed.updated((@scrolls.first.created_at))
@@ -39 +39 @@
-        end
-    EOT
+    FEEDS["xml_block"] = <<-EOT
+        atom_feed do |feed|
+          feed.title("My great blog!")
+          feed.updated((@scrolls.first.created_at))
-
+          feed.author do |author|
+            author.name("DHH")
+          end
+
+          for scroll in @scrolls
+            feed.entry(scroll, :url => "/otherstuff/" + scroll.to_param, :updated => Time.utc(2007, 1, scroll.id)) do |entry|
+              entry.title(scroll.title)
+              entry.content(scroll.body, :type => 'html')
+            end
+          end
+        end
+    EOT
-  def index
-    @scrolls = [
@@ -47 +63 @@
-    
-    render :inline => FEEDS[params[:id]], :type => :builder
+  end
+
+  protected
+
+  def rescue_action(e)
+    raise(e)
-  end
-end
@@ -89 +111 @@
-  end
-
+  def test_self_url_should_default_to_current_request_url
+    with_restful_routing(:scrolls) do
+      get :index, :id => "defaults"
+      assert_select "link[rel=self][href=http://www.nextangle.com/scrolls?id=defaults]"
+    end
+  end
+
+  def test_feed_id_should_be_a_valid_tag
+    with_restful_routing(:scrolls) do
+      get :index, :id => "defaults"
+      assert_select "id", :text => "tag:www.nextangle.com,2008:/scrolls?id=defaults"
+    end
+  end
+
+  def test_entry_id_should_be_a_valid_tag
+    with_restful_routing(:scrolls) do
+      get :index, :id => "defaults"
+      assert_select "entry id", :text => "tag:www.nextangle.com,2008:Scroll/1"
+      assert_select "entry id", :text => "tag:www.nextangle.com,2008:Scroll/2"
+    end
+  end
+
+  def test_feed_should_allow_nested_xml_blocks
+    with_restful_routing(:scrolls) do
+      get :index, :id => "xml_block"
+      assert_select "author name", :text => "DHH"
+    end
+  end
-
-  private