Added RSS feed per tag

* Modularized RSS link in head code; added add_rss_feed_to_head helper method * Modularized RSS generation in FeedWriter class + Refactored RssFeed to use FeedWriter + removed feed_item_description (this fixes ActionItem1463) (ActionItem1518)

Added RSS feed per tag
* Modularized RSS link in head code; added add_rss_feed_to_head helper method * Modularized RSS generation in FeedWriter class + Refactored RssFeed to use FeedWriter + removed feed_item_description (this fixes ActionItem1463) (ActionItem1518)
Antonio Terceiro
1 parent c892d918
Showing 17 changed files with 130 additions and 92 deletions Show diff stats
app/controllers/public/profile_controller.rb
app/helpers/application_helper.rb
app/models/blog.rb
app/models/rss_feed.rb
app/views/cms/_blog.rhtml
app/views/content_viewer/blog_page.rhtml
app/views/content_viewer/view_page.rhtml
app/views/layouts/application-ng.rhtml
app/views/layouts/application.rhtml
app/views/profile/tag.rhtml
config/routes.rb
features/profile_tags.feature
features/support/paths.rb
lib/feed_writer.rb
test/unit/blog_test.rb
test/unit/feed_writer_test.rb
test/unit/rss_feed_test.rb
@@ -29,6 +29,19 @@ class ProfileController &lt; PublicController
     end
   end
+  def tag_feed
+    @tag = params[:id]
+    tagged = profile.find_tagged_with(@tag).paginate(:per_page => 20, :page => 1)
+    feed_writer = FeedWriter.new
+    data = feed_writer.write(
+      tagged,
+      :title => _("%s's contents tagged with \"%s\"") % [profile.name, @tag],
+      :description => _("%s's contents tagged with \"%s\"") % [profile.name, @tag],
+      :link => url_for(:action => 'tag')
+    )
+    render :text => data, :content_type => "text/xml"
+  end
+
   def communities
     if is_cache_expired?(profile.communities_cache_key(params))
       @communities = profile.communities.paginate(:per_page => per_page, :page => params[:npage])
@@ -869,12 +869,9 @@ module ApplicationHelper
     article_helper.cms_label_for_edit
   end
-  def meta_tags_for_article(article)
-    if @controller.controller_name == 'content_viewer'
-      if article and (article.blog? or (article.parent and article.parent.blog?))
-        blog = article.blog? ? article : article.parent
-        "<link rel='alternate' type='application/rss+xml' title='#{blog.feed.title}' href='#{url_for blog.feed.url}' />"
-      end
+  def add_rss_feed_to_head(title, url)
+    content_for :feeds do
+      "<link rel='alternate' type='application/rss+xml' title='#{h(title)}' href='#{url_for(url)}' />"
     end
   end
@@ -6,7 +6,7 @@ class Blog &lt; Folder
   attr_accessor :filter
   after_create do |blog|
-    blog.children << RssFeed.new(:name => 'feed', :profile => blog.profile, :feed_item_description => 'body')
+    blog.children << RssFeed.new(:name => 'feed', :profile => blog.profile)
     blog.feed = blog.feed_attrs
   end
@@ -41,16 +41,6 @@ class RssFeed &lt; Article
   end
   validates_inclusion_of :include, :in => [ 'all', 'parent_and_children' ], :if => :include
-  # determinates what to include in the feed as items' description. Possible
-  # values are +:body+ (default) and +:abstract+.
-  def feed_item_description
-    settings[:feed_item_description]
-  end
-  def feed_item_description=(value)
-    settings[:feed_item_description] = value
-  end
-  validates_inclusion_of :feed_item_description, :in => [ 'body', 'abstract' ], :if => :feed_item_description
-
   # TODO
   def to_html(options = {})
   end
@@ -74,38 +64,13 @@ class RssFeed &lt; Article
       end
   end
   def data
-    articles = fetch_articles
-    result = ""
-    xml = Builder::XmlMarkup.new(:target => result)
-
-    xml.instruct! :xml, :version=>"1.0" 
-    xml.rss(:version=>"2.0") do
-      xml.channel do
-        xml.title(_("%s's RSS feed") % (self.profile.name))
-        xml.link(url_for(self.profile.url))
-        xml.description(_("%s's content published at %s") % [self.profile.name, self.profile.environment.name])
-        xml.language("pt_BR")
-        for article in articles
-          unless self == article
-            xml.item do
-              xml.title(article.name)
-              if self.feed_item_description == 'body'
-                xml.description(article.to_html)
-              else
-                xml.description(article.abstract)
-              end
-              # rfc822
-              xml.pubDate(article.created_at.rfc2822)
-              # link to article
-              xml.link(url_for(article.url))
-              xml.guid(url_for(article.url))
-            end
-          end
-        end
-      end
-    end
-
-    result
+    articles = fetch_articles.select { |a| a != self }
+    FeedWriter.new.write(
+      articles,
+      :title => _("%s's RSS feed") % (self.profile.name),
+      :description => _("%s's content published at %s") % [self.profile.name, self.profile.environment.name],
+      :link => url_for(self.profile.url)
+    )
   end
   def self.short_description
@@ -56,7 +56,6 @@
 <% f.fields_for 'feed', @article.feed do |feed| %>
   <%= labelled_form_field(_('Limit of posts in RSS Feed'), feed.select(:limit, [5, 10, 20, 50])) %>
-  <%= labelled_form_field(_('Use as description in RSS Feed:'), feed.select(:feed_item_description, [ [ _('Article body'), 'body'], [ _('Article abstract'), 'abstract'] ])) %>
 <% end %>
 <% f.fields_for 'external_feed_builder', @article.external_feed do |efeed| %>
+<% add_rss_feed_to_head(article.name, article.feed.url)  if article.blog? && article.feed %>
+
 <%= content_tag('em', _('(external feed was not loaded yet)'), :id => 'external-feed-info', :class => 'metadata') if article.blog? && article.external_feed && article.external_feed.enabled && article.external_feed.fetched_at.nil? %>
 <div>
+<%
+  if @page.parent && @page.parent.blog? && @page.parent.feed
+    add_rss_feed_to_head(@page.parent.name, @page.parent.feed.url)
+  end
+%>
+
 <div id="article">
 <%
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>">
   <head>
     <title><%= h page_title %></title>
-    <%= meta_tags_for_article(@page) %>
+    <%= yield(:feeds) %>
     <!--<meta http-equiv="refresh" content="1"/>-->
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
     <meta name="description" content="<%= @environment.name %>" />
@@ -6,7 +6,7 @@
     <meta name="description" content="<%= @environment.name %>" />
     <meta name="keywords" content="Noosfero, Community, Open Source" />
     <link rel="shortcut icon" href="<%= image_path('/designs/themes/' + current_theme + '/favicon.ico') %>" type="image/x-icon" />
-    <!-- ok --><%= meta_tags_for_article(@page) %>
+    <%= yield(:feeds) %>
     <%= noosfero_javascript %>
     <%= javascript_include_tag 'menu', 'auto-open-menu', 'menu-config', :cache => 'cache-menu' %>
+<% add_rss_feed_to_head(_("%s's contents tagged with \"%s\"") % [profile.name, @tag], tag_feed_path) %>
+
 <h1><%= _('Content tagged with "%s"') % @tag %></h1>
+<p>
+<%= link_to image_tag('icons-mime/rss-feed.png', :alt => _('Feed for this tag'), :title => _('Feed for this tag')), tag_feed_path, :class => 'blog-feed-link'%>
+</p>
+
 <% cache_timeout(@tag_cache_key, 4.hour.from_now) do %>
   <div class='search-tagged-items'>
     <ul>
@@ -65,6 +65,9 @@ ActionController::Routing::Routes.draw do |map|
   # invite
   map.invite 'profile/:profile/invite/:action', :controller => 'invite', :profile => /#{Noosfero.identifier_format}/
+  # feeds per tag
+  map.tag_feed 'profile/:profile/tag/:id/feed', :controller => 'profile', :action =>'tag_feed', :id => /.*/, :profile => /#{Noosfero.identifier_format}/
+
   # public profile information
   map.profile 'profile/:profile/:action/:id', :controller => 'profile', :action => 'index', :id => /.*/, :profile => /#{Noosfero.identifier_format}/
@@ -0,0 +1,20 @@
+Feature: profile tags
+  As a Noosfero user
+  I want to to view content tagged
+  So that I can follow the subjects I care about
+
+  Background:
+    Given the following users
+      | login    |
+      | terceiro |
+    And the following articles
+      | owner    | name   | body           | tag_list   |
+      | terceiro | text 1 | text 1 content | tag1, tag2 |
+      | terceiro | text 2 | text 2 content | tag1, tag3 |
+
+  Scenario: tag feed
+    When I go to terceiro's profile
+    And I follow "tag1"
+    And I follow "Feed for this tag"
+    Then I should see "text 1"
+    And I should see "text 2"
@@ -30,6 +30,9 @@ module NavigationHelpers
     when /^(.*)'s sitemap/
       '/profile/%s/sitemap' % Profile.find_by_name($1).identifier
+    when /^(.*)'s profile/
+      '/profile/%s' % Profile.find_by_name($1).identifier
+
     when /^login page$/
       '/account/login'
@@ -0,0 +1,37 @@
+class FeedWriter
+
+  include ActionController::UrlWriter
+
+  def write(articles, options = {})
+    result = ""
+    xml = Builder::XmlMarkup.new(:target => result)
+
+    xml.instruct! :xml, :version=>"1.0"
+    xml.rss(:version=>"2.0") do
+      xml.channel do
+        xml.title(options[:title] || _('Feed'))
+        if options[:link]
+          xml.link(options[:link])
+        end
+        if options[:description]
+          xml.description(options[:description])
+        end
+        for article in articles
+          xml.item do
+            xml.title(article.name)
+            xml.description(article.to_html)
+            if article.created_at
+              # rfc822
+              xml.pubDate(article.created_at.rfc2822)
+            end
+            # link to article
+            xml.link(url_for(article.url))
+            xml.guid(url_for(article.url))
+          end
+        end
+      end
+    end
+
+    result
+  end
+end
@@ -32,12 +32,6 @@ class BlogTest &lt; ActiveSupport::TestCase
     assert_kind_of RssFeed, b.feed
   end
-  should 'include articles body in feed by default' do
-    p = create_user('testuser').person
-    b = Blog.create!(:profile => p, :name => 'blog_feed_test')
-    assert_equal 'body', b.feed.feed_item_description
-  end
-
   should 'save feed options' do
     p = create_user('testuser').person
     p.articles << Blog.new(:profile => p, :name => 'blog_feed_test')
@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class FeedWriterTest < Test::Unit::TestCase
+
+  should 'generate feeds' do
+    articles = []
+    profile = fast_create(:profile, :identifier => "tagger")
+    articles << fast_create(:article, :name => 'text 1', :slug => 'text-1', :path => 'text-1', :profile_id => profile.id)
+    articles << fast_create(:article, :name => 'text 2', :slug => 'text-2', :path => 'text-2', :profile_id => profile.id) 
+    writer = FeedWriter.new
+
+    feed = writer.write(articles)
+    assert_match('text 1', feed)
+    assert_match('/tagger/' + articles.first.slug, feed)
+  end
+
+  should 'use title, link and description' do
+    writer = FeedWriter.new
+    rss = writer.write([], :title => "my title", :description => "my description", :link => "http://example.com/")
+    assert_match("my title", rss)
+    assert_match("my description", rss)
+    assert_match("http://example.com/", rss)
+  end
+
+end
+
@@ -62,24 +62,6 @@ class RssFeedTest &lt; Test::Unit::TestCase
     feed.data
   end
-  should 'be able to choose to put abstract or entire body on feed' do
-    profile = create_user('testuser').person
-    a1 = profile.articles.build(:name => 'article 1', 'abstract' => 'my abstract', 'body' => 'my text'); a1.save!
-
-    feed = RssFeed.new(:name => 'testfeed')
-    feed.profile = profile
-    feed.save!
-
-    rss = feed.data
-    assert_match /<description>my abstract<\/description>/, rss
-    assert_no_match /<description>my text<\/description>/, rss
-
-    feed.feed_item_description = 'body'
-    rss = feed.data
-    assert_match /<description>my text<\/description>/, rss
-    assert_no_match /<description>my abstract<\/description>/, rss
-  end
-
   should "be able to search only children of feed's parent" do
     profile = create_user('testuser').person
     a1 = profile.articles.build(:name => 'article 1'); a1.save!
@@ -201,21 +183,6 @@ class RssFeedTest &lt; Test::Unit::TestCase
     assert !feed.errors.invalid?(:include)
   end
-  should 'allow only body and abstract as feed_item_description' do
-    feed = RssFeed.new
-    feed.feed_item_description = :something_else
-    feed.valid?
-    assert feed.errors.invalid?(:feed_item_description)
-
-    feed.feed_item_description = 'body'
-    feed.valid?
-    assert !feed.errors.invalid?(:feed_item_description)
-
-    feed.feed_item_description = 'abstract'
-    feed.valid?
-    assert !feed.errors.invalid?(:feed_item_description)
-  end
-
   should 'provide proper short description' do
     assert_kind_of String, RssFeed.short_description
   end
@@ -246,7 +213,7 @@ class RssFeedTest &lt; Test::Unit::TestCase
     blog = fast_create(Blog, :profile_id => profile.id)
     published_article = PublishedArticle.create!(:reference_article => article, :profile => profile)
     blog.posts << published_article
-    feed = RssFeed.new(:parent => blog, :profile => profile, :feed_item_description => 'body')
+    feed = RssFeed.new(:parent => blog, :profile => profile)
     assert_match published_article.to_html, feed.data
   end
	@@ -29,6 +29,19 @@ class ProfileController < PublicController		@@ -29,6 +29,19 @@ class ProfileController < PublicController
29	end	29	end
30	end	30	end
31		31
		32	+ def tag_feed
		33	+ @tag = params[:id]
		34	+ tagged = profile.find_tagged_with(@tag).paginate(:per_page => 20, :page => 1)
		35	+ feed_writer = FeedWriter.new
		36	+ data = feed_writer.write(
		37	+ tagged,
		38	+ :title => _("%s's contents tagged with \"%s\"") % [profile.name, @tag],
		39	+ :description => _("%s's contents tagged with \"%s\"") % [profile.name, @tag],
		40	+ :link => url_for(:action => 'tag')
		41	+ )
		42	+ render :text => data, :content_type => "text/xml"
		43	+ end
		44	+
32	def communities	45	def communities
33	if is_cache_expired?(profile.communities_cache_key(params))	46	if is_cache_expired?(profile.communities_cache_key(params))
34	@communities = profile.communities.paginate(:per_page => per_page, :page => params[:npage])	47	@communities = profile.communities.paginate(:per_page => per_page, :page => params[:npage])
	@@ -6,7 +6,7 @@ class Blog < Folder		@@ -6,7 +6,7 @@ class Blog < Folder
6	attr_accessor :filter	6	attr_accessor :filter
7		7
8	after_create do \|blog\|	8	after_create do \|blog\|
9	- blog.children << RssFeed.new(:name => 'feed', :profile => blog.profile, :feed_item_description => 'body')	9	+ blog.children << RssFeed.new(:name => 'feed', :profile => blog.profile)
10	blog.feed = blog.feed_attrs	10	blog.feed = blog.feed_attrs
11	end	11	end
12		12
	@@ -41,16 +41,6 @@ class RssFeed < Article		@@ -41,16 +41,6 @@ class RssFeed < Article
41	end	41	end
42	validates_inclusion_of :include, :in => [ 'all', 'parent_and_children' ], :if => :include	42	validates_inclusion_of :include, :in => [ 'all', 'parent_and_children' ], :if => :include
43		43
44	- # determinates what to include in the feed as items' description. Possible
45	- # values are +:body+ (default) and +:abstract+.
46	- def feed_item_description
47	- settings[:feed_item_description]
48	- end
49	- def feed_item_description=(value)
50	- settings[:feed_item_description] = value
51	- end
52	- validates_inclusion_of :feed_item_description, :in => [ 'body', 'abstract' ], :if => :feed_item_description
53	-
54	# TODO	44	# TODO
55	def to_html(options = {})	45	def to_html(options = {})
56	end	46	end
	@@ -74,38 +64,13 @@ class RssFeed < Article		@@ -74,38 +64,13 @@ class RssFeed < Article
74	end	64	end
75	end	65	end
76	def data	66	def data
77	- articles = fetch_articles
78	- result = ""
79	- xml = Builder::XmlMarkup.new(:target => result)
80	-
81	- xml.instruct! :xml, :version=>"1.0"
82	- xml.rss(:version=>"2.0") do
83	- xml.channel do
84	- xml.title(_("%s's RSS feed") % (self.profile.name))
85	- xml.link(url_for(self.profile.url))
86	- xml.description(_("%s's content published at %s") % [self.profile.name, self.profile.environment.name])
87	- xml.language("pt_BR")
88	- for article in articles
89	- unless self == article
90	- xml.item do
91	- xml.title(article.name)
92	- if self.feed_item_description == 'body'
93	- xml.description(article.to_html)
94	- else
95	- xml.description(article.abstract)
96	- end
97	- # rfc822
98	- xml.pubDate(article.created_at.rfc2822)
99	- # link to article
100	- xml.link(url_for(article.url))
101	- xml.guid(url_for(article.url))
102	- end
103	- end
104	- end
105	- end
106	- end
107	-
108	- result	67	+ articles = fetch_articles.select { \|a\| a != self }
		68	+ FeedWriter.new.write(
		69	+ articles,
		70	+ :title => _("%s's RSS feed") % (self.profile.name),
		71	+ :description => _("%s's content published at %s") % [self.profile.name, self.profile.environment.name],
		72	+ :link => url_for(self.profile.url)
		73	+ )
109	end	74	end
110		75
111	def self.short_description	76	def self.short_description
	@@ -56,7 +56,6 @@		@@ -56,7 +56,6 @@
56		56
57	<% f.fields_for 'feed', @article.feed do \|feed\| %>	57	<% f.fields_for 'feed', @article.feed do \|feed\| %>
58	<%= labelled_form_field(_('Limit of posts in RSS Feed'), feed.select(:limit, [5, 10, 20, 50])) %>	58	<%= labelled_form_field(_('Limit of posts in RSS Feed'), feed.select(:limit, [5, 10, 20, 50])) %>
59	- <%= labelled_form_field(_('Use as description in RSS Feed:'), feed.select(:feed_item_description, [ [ _('Article body'), 'body'], [ _('Article abstract'), 'abstract'] ])) %>
60	<% end %>	59	<% end %>
61		60
62	<% f.fields_for 'external_feed_builder', @article.external_feed do \|efeed\| %>	61	<% f.fields_for 'external_feed_builder', @article.external_feed do \|efeed\| %>
		1	+<% add_rss_feed_to_head(article.name, article.feed.url) if article.blog? && article.feed %>
		2	+
1	<%= content_tag('em', _('(external feed was not loaded yet)'), :id => 'external-feed-info', :class => 'metadata') if article.blog? && article.external_feed && article.external_feed.enabled && article.external_feed.fetched_at.nil? %>	3	<%= content_tag('em', _('(external feed was not loaded yet)'), :id => 'external-feed-info', :class => 'metadata') if article.blog? && article.external_feed && article.external_feed.enabled && article.external_feed.fetched_at.nil? %>
2		4
3	<div>	5	<div>
		1	+<%
		2	+ if @page.parent && @page.parent.blog? && @page.parent.feed
		3	+ add_rss_feed_to_head(@page.parent.name, @page.parent.feed.url)
		4	+ end
		5	+%>
		6	+
1	<div id="article">	7	<div id="article">
2		8
3	<%	9	<%
	@@ -2,7 +2,7 @@		@@ -2,7 +2,7 @@
2	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>">	2	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= html_language %>" lang="<%= html_language %>">
3	<head>	3	<head>
4	<title><%= h page_title %></title>	4	<title><%= h page_title %></title>
5	- <%= meta_tags_for_article(@page) %>	5	+ <%= yield(:feeds) %>
6	<!--<meta http-equiv="refresh" content="1"/>-->	6	<!--<meta http-equiv="refresh" content="1"/>-->
7	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>	7	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
8	<meta name="description" content="<%= @environment.name %>" />	8	<meta name="description" content="<%= @environment.name %>" />
	@@ -6,7 +6,7 @@		@@ -6,7 +6,7 @@
6	<meta name="description" content="<%= @environment.name %>" />	6	<meta name="description" content="<%= @environment.name %>" />
7	<meta name="keywords" content="Noosfero, Community, Open Source" />	7	<meta name="keywords" content="Noosfero, Community, Open Source" />
8	<link rel="shortcut icon" href="<%= image_path('/designs/themes/' + current_theme + '/favicon.ico') %>" type="image/x-icon" />	8	<link rel="shortcut icon" href="<%= image_path('/designs/themes/' + current_theme + '/favicon.ico') %>" type="image/x-icon" />
9	- <!-- ok --><%= meta_tags_for_article(@page) %>	9	+ <%= yield(:feeds) %>
10		10
11	<%= noosfero_javascript %>	11	<%= noosfero_javascript %>
12	<%= javascript_include_tag 'menu', 'auto-open-menu', 'menu-config', :cache => 'cache-menu' %>	12	<%= javascript_include_tag 'menu', 'auto-open-menu', 'menu-config', :cache => 'cache-menu' %>
		1	+<% add_rss_feed_to_head(_("%s's contents tagged with \"%s\"") % [profile.name, @tag], tag_feed_path) %>
		2	+
1	<h1><%= _('Content tagged with "%s"') % @tag %></h1>	3	<h1><%= _('Content tagged with "%s"') % @tag %></h1>
2		4
		5	+<p>
		6	+<%= link_to image_tag('icons-mime/rss-feed.png', :alt => _('Feed for this tag'), :title => _('Feed for this tag')), tag_feed_path, :class => 'blog-feed-link'%>
		7	+</p>
		8	+
3	<% cache_timeout(@tag_cache_key, 4.hour.from_now) do %>	9	<% cache_timeout(@tag_cache_key, 4.hour.from_now) do %>
4	<div class='search-tagged-items'>	10	<div class='search-tagged-items'>
5	<ul>	11	<ul>
@@ -0,0 +1,20 @@		@@ -0,0 +1,20 @@
	1	+Feature: profile tags
	2	+ As a Noosfero user
	3	+ I want to to view content tagged
	4	+ So that I can follow the subjects I care about
	5	+
	6	+ Background:
	7	+ Given the following users
	8	+ \| login \|
	9	+ \| terceiro \|
	10	+ And the following articles
	11	+ \| owner \| name \| body \| tag_list \|
	12	+ \| terceiro \| text 1 \| text 1 content \| tag1, tag2 \|
	13	+ \| terceiro \| text 2 \| text 2 content \| tag1, tag3 \|
	14	+
	15	+ Scenario: tag feed
	16	+ When I go to terceiro's profile
	17	+ And I follow "tag1"
	18	+ And I follow "Feed for this tag"
	19	+ Then I should see "text 1"
	20	+ And I should see "text 2"