Adding option to choose how posts will be displayed

A blog can display the full content of posts or only the first paragraph (ActionItem1515)

Adding option to choose how posts will be displayed
A blog can display the full content of posts or only the first paragraph (ActionItem1515)
Daniela Feitosa · Joenio Costa
1 parent 45521292
Showing 11 changed files with 122 additions and 14 deletions Show diff stats
app/helpers/blog_helper.rb
app/helpers/content_viewer_helper.rb
app/models/article.rb
app/models/blog.rb
app/views/cms/_blog.rhtml
app/views/content_viewer/blog_page.rhtml
public/stylesheets/application.css
test/functional/cms_controller_test.rb
test/functional/content_viewer_controller_test.rb
test/unit/blog_helper_test.rb
test/unit/blog_test.rb
@@ -14,7 +14,7 @@ module BlogHelper
     _('Edit blog')
   end
-  def list_posts(user, articles)
+  def list_posts(user, articles, format = 'full')
     pagination = will_paginate(articles, {
       :param_name => 'npage',
       :prev_label => _('&laquo; Newer posts'),
@@ -32,7 +32,7 @@ module BlogHelper
         css_add << position + '-inner'
         content << content_tag('div',
                     content_tag('div',
-                       display_post(art) + '<br style="clear:both"/>',
+                       display_post(art, format) + '<br style="clear:both"/>',
                        :class => 'blog-post ' + css_add.join(' '),
                        :id => "post-#{art.id}"), :class => position
                    )
@@ -41,10 +41,29 @@ module BlogHelper
     content.join("\n<hr class='sep-posts'/>\n") + (pagination or '')
   end
-  def display_post(article)
+  def display_post(article, format = 'full')
+    no_comments = (format == 'full') ? false : true
+    html = send("display_#{format}_format", article)
+
+    article_title(article, :no_comments => no_comments) + html
+  end
+
+  def display_short_format(article)
+    html = content_tag('div',
+             article.first_paragraph +
+             content_tag('div',
+               link_to_comments(article) +
+               link_to( _('Read more'), article.url),
+               :class => 'read-more'),
+             :class => 'short-post'
+           )
+    html
+  end
+
+  def display_full_format(article)
     html = article_to_html(article)
     html = content_tag('p', html) if ! html.include?('</p>')
-    article_title(article) + html
+    html
   end
 end
@@ -19,12 +19,13 @@ module ContentViewerHelper
       unless args[:no_link]
         title = content_tag('h1', link_to(article.name, article.url), :class => 'title')
       end
-      title << content_tag('span', _("%s, by %s - %s") % [show_date(article.published_at), link_to(article.author.name, article.author.url), link_to_comments(article)], :class => 'created-at')
+      comments = args[:no_comments] ? '' : (("- %s") % link_to_comments(article))
+      title << content_tag('span', _("%s, by %s %s") % [show_date(article.published_at), link_to(article.author.name, article.author.url), comments], :class => 'created-at')
     end
     title
   end
-  def link_to_comments(article)
+  def link_to_comments(article, args = {})
     link_to( number_of_comments(article), article.url.merge(:anchor => 'comments_list') )
   end
@@ -332,7 +332,7 @@ class Article &lt; ActiveRecord::Base
   def first_paragraph
     to_html =~ /(.*<\/p>)/
-    $1
+    $1 || ''
   end
   def self.find_tagged_with(tag)
@@ -99,4 +99,8 @@ class Blog &lt; Folder
     end
   end
+  settings_items :visualization_format, :type => :string, :default => 'full'
+  validates_inclusion_of :visualization_format, :in => [ 'full', 'short' ], :if => :visualization_format
+
+
 end
@@ -52,6 +52,8 @@
 <%= labelled_form_field(_('Description:'), text_area(:article, :body, :cols => 64, :rows => 10)) %>
+<%= labelled_form_field(_('How to display posts:'), f.select(:visualization_format, [ [ _('Full post'), 'full'], [ _('First paragraph'), 'short'] ])) %>
+
 <%= labelled_form_field(_('Posts per page:'), f.select(:posts_per_page, [5, 10, 20, 50, 100])) %>
 <% f.fields_for 'feed', @article.feed do |feed| %>
@@ -10,5 +10,5 @@
 </div>
 <hr class="pre-posts"/>
 <div class="blog-posts">
-  <%= (children.compact.empty? ? content_tag('em', _('(no posts)')) : list_posts(user, children)) %>
+  <%= (children.compact.empty? ? content_tag('em', _('(no posts)')) : list_posts(user, children, article.visualization_format)) %>
 </div>
@@ -1171,6 +1171,14 @@ a.comment-picture {
   max-width: 100%;
 }
+#content .blog-post .read-more {
+  text-align: right;
+  clear: both;
+}
+#content .blog-post .read-more a {
+  margin: 0 10px;
+}
+
 /* NOT PUBLISHED BLOG POSTS */
 .blog-post.not-published {
@@ -736,6 +736,12 @@ class CmsControllerTest &lt; Test::Unit::TestCase
     assert_tag :tag => 'select', :attributes => { :name => 'article[posts_per_page]' }, :child => { :tag => 'option', :attributes => {:value => n, :selected => 'selected'} }
   end
+  should 'display options for blog visualization with default value on edit blog' do
+    format = Blog.new.visualization_format
+    get :new, :profile => profile.identifier, :type => 'Blog'
+    assert_tag :tag => 'select', :attributes => { :name => 'article[visualization_format]' }, :child => { :tag => 'option', :attributes => {:value => 'full', :selected => 'selected'} }
+  end
+
   should 'not offer to create special article types' do
     get :new, :profile => profile.identifier
     assert_no_tag :tag => 'a', :attributes => { :href => "/myprofile/#{profile.identifier}/cms/new?type=Blog"}
@@ -857,4 +857,17 @@ class ContentViewerControllerTest &lt; Test::Unit::TestCase
     assert_tag :tag => 'div', :attributes => { :class => 'post_comment_box opened' }
   end
+  should 'show only first paragraph of blog posts if visualization_format is short' do
+    login_as(profile.identifier)
+
+    blog = Blog.create!(:name => 'A blog test', :profile => profile, :visualization_format => 'short')
+
+    blog.posts << TinyMceArticle.create!(:name => 'first post', :parent => blog, :profile => profile, :body => '<p>Content to be displayed.</p> Anything')
+
+    get :view_page, :profile => profile.identifier, :page => blog.explode_path
+
+    assert_tag :tag => 'div', :attributes => { :class => 'short-post'}, :content => /Content to be displayed./
+    assert_no_tag :tag => 'div', :attributes => { :class => 'short-post'}, :content => /Anything/
+  end
+
 end
@@ -23,7 +23,7 @@ class BlogHelperTest &lt; Test::Unit::TestCase
   should 'list published posts with class blog-post' do
     blog.children << published_post = TextileArticle.create!(:name => 'Post', :profile => profile, :parent => blog, :published => true)
-    expects(:display_post).with(anything).returns('POST')
+    expects(:display_post).with(anything, anything).returns('POST')
     expects(:content_tag).with('div', "POST<br style=\"clear:both\"/>", :class => 'blog-post position-1 first last odd-post-inner', :id => "post-#{published_post.id}").returns('POST')
     expects(:content_tag).with('div', 'POST', {:class => 'odd-post'}).returns('RESULT')
@@ -33,7 +33,7 @@ class BlogHelperTest &lt; Test::Unit::TestCase
   should 'list unpublished posts to owner with a different class' do
     blog.children << unpublished_post = TextileArticle.create!(:name => 'Post', :profile => profile, :parent => blog, :published => false)
-    expects(:display_post).with(anything).returns('POST')
+    expects(:display_post).with(anything, anything).returns('POST')
     expects(:content_tag).with('div', "POST<br style=\"clear:both\"/>", :class => 'blog-post position-1 first last not-published odd-post-inner', :id => "post-#{unpublished_post.id}").returns('POST')
     expects(:content_tag).with('div', 'POST', {:class => 'odd-post'}).returns('RESULT')
     assert_equal 'RESULT', list_posts(profile, blog.posts)
@@ -44,7 +44,7 @@ class BlogHelperTest &lt; Test::Unit::TestCase
     blog.children << published_post = TextileArticle.create!(:name => 'Second post', :profile => profile, :parent => blog, :published => true)
-    expects(:display_post).with(anything).returns('POST')
+    expects(:display_post).with(anything, anything).returns('POST')
     expects(:content_tag).with('div', "POST<br style=\"clear:both\"/>", has_entries(:id => "post-#{unpublished_post.id}")).never
     expects(:content_tag).with('div', "POST<br style=\"clear:both\"/>", has_entries(:id => "post-#{published_post.id}")).returns('POST')
     expects(:content_tag).with('div', 'POST', {:class => 'odd-post'}).returns('RESULT')
@@ -56,7 +56,7 @@ class BlogHelperTest &lt; Test::Unit::TestCase
     blog.children << newer_post = TextileArticle.create!(:name => 'Second post', :profile => profile, :parent => blog, :published => true)
-    expects(:display_post).with(anything).returns('POST').times(2)
+    expects(:display_post).with(anything, anything).returns('POST').times(2)
     expects(:content_tag).with('div', "POST<br style=\"clear:both\"/>", :class => 'blog-post position-1 first odd-post-inner', :id => "post-#{newer_post.id}").returns('POST 1')
     expects(:content_tag).with('div', "POST 1", :class => 'odd-post').returns('ODD-POST')
@@ -70,7 +70,7 @@ class BlogHelperTest &lt; Test::Unit::TestCase
   should 'display post' do
     blog.children << article = TextileArticle.create!(:name => 'Second post', :profile => profile, :parent => blog, :published => true)
-    expects(:article_title).with(article).returns('TITLE')
+    expects(:article_title).with(article, anything).returns('TITLE')
     expects(:content_tag).with('p', article.to_html).returns(' TO_HTML')
     self.stubs(:params).returns({:npage => nil})
@@ -79,13 +79,39 @@ class BlogHelperTest &lt; Test::Unit::TestCase
   should 'display empty post if body is nil' do
     blog.children << article = fast_create(Article, :profile_id => profile.id, :parent_id => blog.id, :body => nil)
-    expects(:article_title).with(article).returns('TITLE')
+    expects(:article_title).with(article, anything).returns('TITLE')
     expects(:content_tag).with('p', '').returns('')
     self.stubs(:params).returns({:npage => nil})
     assert_equal 'TITLE', display_post(article)
   end
+  should 'display full post by default' do
+    blog.children << article = fast_create(Article, :profile_id => profile.id, :parent_id => blog.id, :body => nil)
+    expects(:article_title).with(article, anything).returns('')
+    expects(:display_full_format).with(article).returns('FULL POST')
+
+    assert_equal 'FULL POST', display_post(article)
+  end
+
+  should 'no_comments is false if blog displays full post' do
+    blog.children << article = fast_create(Article, :profile_id => profile.id, :parent_id => blog.id, :body => nil)
+    expects(:article_title).with(article, :no_comments => false).returns('')
+    expects(:display_full_format).with(article).returns('FULL POST')
+
+    assert_equal 'FULL POST', display_post(article, 'full')
+  end
+
+  should 'no_comments is true if blog displays short post' do
+    blog.update_attribute(:visualization_format, 'short')
+    blog.children << article = fast_create(Article, :profile_id => profile.id, :parent_id => blog.id, :body => nil)
+    expects(:article_title).with(article, :no_comments => true).returns('')
+    expects(:display_short_format).with(article).returns('SHORT POST')
+
+    assert_equal 'SHORT POST', display_post(article, 'short')
+  end
+
+
   should 'display link to file if post is an uploaded_file' do
     file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/test.txt', 'text/plain'), :profile => profile, :published => true, :parent => blog)
@@ -149,4 +149,33 @@ class BlogTest &lt; ActiveSupport::TestCase
     assert_not_equal 'changed-name', blog.slug
   end
+  should 'display full posts by default' do
+    blog = Blog.new
+    assert_equal 'full', blog.visualization_format
+  end
+
+  should 'update visualization_format setting' do
+    p = create_user('testuser').person
+    p.articles << Blog.new(:profile => p, :name => 'Blog test')
+    blog = p.blog
+    blog.visualization_format = 'short'
+    assert blog.save!
+    assert_equal 'short', p.blog.visualization_format
+  end
+
+  should 'allow only full and short as visualization_format' do
+    blog = Blog.new(:name => 'blog')
+    blog.visualization_format = 'wrong_format'
+    blog.valid?
+    assert blog.errors.invalid?(:visualization_format)
+
+    blog.visualization_format = 'short'
+    blog.valid?
+    assert !blog.errors.invalid?(:visualization_format)
+
+    blog.visualization_format = 'full'
+    blog.valid?
+    assert !blog.errors.invalid?(:visualization_format)
+  end
+
 end
	@@ -332,7 +332,7 @@ class Article < ActiveRecord::Base		@@ -332,7 +332,7 @@ class Article < ActiveRecord::Base
332		332
333	def first_paragraph	333	def first_paragraph
334	to_html =~ /(.*<\/p>)/	334	to_html =~ /(.*<\/p>)/
335	- $1	335	+ $1 \|\| ''
336	end	336	end
337		337
338	def self.find_tagged_with(tag)	338	def self.find_tagged_with(tag)
	@@ -99,4 +99,8 @@ class Blog < Folder		@@ -99,4 +99,8 @@ class Blog < Folder
99	end	99	end
100	end	100	end
101		101
		102	+ settings_items :visualization_format, :type => :string, :default => 'full'
		103	+ validates_inclusion_of :visualization_format, :in => [ 'full', 'short' ], :if => :visualization_format
		104	+
		105	+
102	end	106	end
	@@ -52,6 +52,8 @@		@@ -52,6 +52,8 @@
52		52
53	<%= labelled_form_field(_('Description:'), text_area(:article, :body, :cols => 64, :rows => 10)) %>	53	<%= labelled_form_field(_('Description:'), text_area(:article, :body, :cols => 64, :rows => 10)) %>
54		54
		55	+<%= labelled_form_field(_('How to display posts:'), f.select(:visualization_format, [ [ _('Full post'), 'full'], [ _('First paragraph'), 'short'] ])) %>
		56	+
55	<%= labelled_form_field(_('Posts per page:'), f.select(:posts_per_page, [5, 10, 20, 50, 100])) %>	57	<%= labelled_form_field(_('Posts per page:'), f.select(:posts_per_page, [5, 10, 20, 50, 100])) %>
56		58
57	<% f.fields_for 'feed', @article.feed do \|feed\| %>	59	<% f.fields_for 'feed', @article.feed do \|feed\| %>
	@@ -10,5 +10,5 @@		@@ -10,5 +10,5 @@
10	</div>	10	</div>
11	<hr class="pre-posts"/>	11	<hr class="pre-posts"/>
12	<div class="blog-posts">	12	<div class="blog-posts">
13	- <%= (children.compact.empty? ? content_tag('em', _('(no posts)')) : list_posts(user, children)) %>	13	+ <%= (children.compact.empty? ? content_tag('em', _('(no posts)')) : list_posts(user, children, article.visualization_format)) %>
14	</div>	14	</div>
	@@ -1171,6 +1171,14 @@ a.comment-picture {		@@ -1171,6 +1171,14 @@ a.comment-picture {
1171	max-width: 100%;	1171	max-width: 100%;
1172	}	1172	}
1173		1173
		1174	+#content .blog-post .read-more {
		1175	+ text-align: right;
		1176	+ clear: both;
		1177	+}
		1178	+#content .blog-post .read-more a {
		1179	+ margin: 0 10px;
		1180	+}
		1181	+
1174	/* NOT PUBLISHED BLOG POSTS */	1182	/* NOT PUBLISHED BLOG POSTS */
1175		1183
1176	.blog-post.not-published {	1184	.blog-post.not-published {
	@@ -736,6 +736,12 @@ class CmsControllerTest < Test::Unit::TestCase		@@ -736,6 +736,12 @@ class CmsControllerTest < Test::Unit::TestCase
736	assert_tag :tag => 'select', :attributes => { :name => 'article[posts_per_page]' }, :child => { :tag => 'option', :attributes => {:value => n, :selected => 'selected'} }	736	assert_tag :tag => 'select', :attributes => { :name => 'article[posts_per_page]' }, :child => { :tag => 'option', :attributes => {:value => n, :selected => 'selected'} }
737	end	737	end
738		738
		739	+ should 'display options for blog visualization with default value on edit blog' do
		740	+ format = Blog.new.visualization_format
		741	+ get :new, :profile => profile.identifier, :type => 'Blog'
		742	+ assert_tag :tag => 'select', :attributes => { :name => 'article[visualization_format]' }, :child => { :tag => 'option', :attributes => {:value => 'full', :selected => 'selected'} }
		743	+ end
		744	+
739	should 'not offer to create special article types' do	745	should 'not offer to create special article types' do
740	get :new, :profile => profile.identifier	746	get :new, :profile => profile.identifier
741	assert_no_tag :tag => 'a', :attributes => { :href => "/myprofile/#{profile.identifier}/cms/new?type=Blog"}	747	assert_no_tag :tag => 'a', :attributes => { :href => "/myprofile/#{profile.identifier}/cms/new?type=Blog"}
	@@ -857,4 +857,17 @@ class ContentViewerControllerTest < Test::Unit::TestCase		@@ -857,4 +857,17 @@ class ContentViewerControllerTest < Test::Unit::TestCase
857	assert_tag :tag => 'div', :attributes => { :class => 'post_comment_box opened' }	857	assert_tag :tag => 'div', :attributes => { :class => 'post_comment_box opened' }
858	end	858	end
859		859
		860	+ should 'show only first paragraph of blog posts if visualization_format is short' do
		861	+ login_as(profile.identifier)
		862	+
		863	+ blog = Blog.create!(:name => 'A blog test', :profile => profile, :visualization_format => 'short')
		864	+
		865	+ blog.posts << TinyMceArticle.create!(:name => 'first post', :parent => blog, :profile => profile, :body => '<p>Content to be displayed.</p> Anything')
		866	+
		867	+ get :view_page, :profile => profile.identifier, :page => blog.explode_path
		868	+
		869	+ assert_tag :tag => 'div', :attributes => { :class => 'short-post'}, :content => /Content to be displayed./
		870	+ assert_no_tag :tag => 'div', :attributes => { :class => 'short-post'}, :content => /Anything/
		871	+ end
		872	+
860	end	873	end
	@@ -149,4 +149,33 @@ class BlogTest < ActiveSupport::TestCase		@@ -149,4 +149,33 @@ class BlogTest < ActiveSupport::TestCase
149	assert_not_equal 'changed-name', blog.slug	149	assert_not_equal 'changed-name', blog.slug
150	end	150	end
151		151
		152	+ should 'display full posts by default' do
		153	+ blog = Blog.new
		154	+ assert_equal 'full', blog.visualization_format
		155	+ end
		156	+
		157	+ should 'update visualization_format setting' do
		158	+ p = create_user('testuser').person
		159	+ p.articles << Blog.new(:profile => p, :name => 'Blog test')
		160	+ blog = p.blog
		161	+ blog.visualization_format = 'short'
		162	+ assert blog.save!
		163	+ assert_equal 'short', p.blog.visualization_format
		164	+ end
		165	+
		166	+ should 'allow only full and short as visualization_format' do
		167	+ blog = Blog.new(:name => 'blog')
		168	+ blog.visualization_format = 'wrong_format'
		169	+ blog.valid?
		170	+ assert blog.errors.invalid?(:visualization_format)
		171	+
		172	+ blog.visualization_format = 'short'
		173	+ blog.valid?
		174	+ assert !blog.errors.invalid?(:visualization_format)
		175	+
		176	+ blog.visualization_format = 'full'
		177	+ blog.valid?
		178	+ assert !blog.errors.invalid?(:visualization_format)
		179	+ end
		180	+
152	end	181	end