ActionItem908: selected witch articles can display hits

added the hit counter Added the hits column and the option to display it on the page

ActionItem908: selected witch articles can display hits
added the hit counter Added the hits column and the option to display it on the page
Moises Machado · Antonio Terceiro
1 parent 534ae2b7
Showing 17 changed files with 124 additions and 4 deletions Show diff stats
app/controllers/public/content_viewer_controller.rb
app/helpers/article_helper.rb
app/models/article.rb
app/models/enterprise_homepage.rb
app/models/folder.rb
app/models/rss_feed.rb
app/models/uploaded_file.rb
app/views/content_viewer/view_page.rhtml
db/migrate/058_add_hits_to_articles.rb
db/schema.rb
public/stylesheets/article.css
test/functional/content_viewer_controller_test.rb
test/unit/article_test.rb
test/unit/enterprise_homepage_test.rb
test/unit/folder_test.rb
test/unit/rss_feed_test.rb
test/unit/uploaded_file_test.rb
@@ -49,6 +49,9 @@ class ContentViewerController &lt; ApplicationController
       render :action => 'access_denied', :status => 403, :layout => false
     end
+    # At this point the page will be showed
+    @page.hit
+
     if @page.mime_type != 'text/html'
       headers['Content-Type'] = @page.mime_type
       data = @page.data
@@ -18,8 +18,13 @@ module ArticleHelper
         'div',
         check_box(:article, :notify_comments) +
         content_tag('label', _('I want to receive a notification of each comment written by e-mail'), :for => 'article_notify_comments') +
-        observe_field(:article_accept_comments, :function => "$('article_notify_comments').disabled = ! $('article_accept_comments').checked")
-      )
+        observe_field(:article_accept_comments, :function => "$('article_notify_comments').disabled = ! $('article_accept_comments').checked") 
+      ) + (article.can_display_hits? ?
+      content_tag(
+        'div',
+        check_box(:article, :display_hits) +
+        content_tag('label', _('I want this article to display the number of hits it received'), :for => 'article_display_hits')
+      ) : '')
     )
   end
@@ -16,6 +16,10 @@ class Article &lt; ActiveRecord::Base
   has_many :article_categorizations, :conditions => [ 'articles_categories.virtual = ?', false ]
   has_many :categories, :through => :article_categorizations
+  acts_as_having_settings :field => :setting
+
+  settings_items :display_hits, :type => :boolean, :default => true
+
   def self.human_attribute_name(attrib)
     case attrib.to_sym
     when :name
@@ -209,13 +213,26 @@ class Article &lt; ActiveRecord::Base
   end
   def article_attr_blacklist
-    ['id', 'profile_id', 'parent_id', 'slug', 'path', 'updated_at', 'created_at', 'last_changed_by_id', 'version', 'lock_version', 'type', 'children_count', 'comments_count']
+    ['id', 'profile_id', 'parent_id', 'slug', 'path', 'updated_at', 'created_at', 'last_changed_by_id', 'version', 'lock_version', 'type', 'children_count', 'comments_count', 'hits']
   end
   def self.find_by_old_path(old_path)
     find(:first, :include => :versions, :conditions => ['article_versions.path = ?', old_path], :order => 'article_versions.id desc')
   end
+  def hit
+    self.hits += 1
+    save!
+  end
+
+  def can_display_hits?
+    true
+  end
+
+  def display_hits?
+    can_display_hits? && display_hits
+  end
+
   private
   def sanitize_tag_list
@@ -26,4 +26,8 @@ class EnterpriseHomepage &lt; Article
     (self.profile.environment.enabled?('disable_products_for_enterprises') ? '' : display_products_list(self.profile, products))
   end
+  def can_display_hits?
+    false
+  end
+
 end
@@ -29,4 +29,8 @@ class Folder &lt; Article
     true
   end
+  def can_display_hits?
+    false
+  end
+
 end
@@ -119,4 +119,8 @@ class RssFeed &lt; Article
     'rss-feed'
   end
+  def can_display_hits?
+    false
+  end
+
 end
@@ -49,4 +49,8 @@ class UploadedFile &lt; Article
     false
   end
+  def can_display_hits?
+    false
+  end
+
 end
@@ -61,6 +61,12 @@
   </div>
 <% end %>
+<% if @page.display_hits? %>
+  <div id="article-hits">
+    <%= n_('Viewed one time', 'Viewed %{num} times', @page.hits) % { :num => @page.hits } %>
+  </div>
+<% end %>
+
 <% if @page.parent && !@page.parent.path.blank? %>
 <div id="article-parent">
   <%= link_to_document(@page.parent, _('Up')) %>
@@ -0,0 +1,11 @@
+class AddHitsToArticles < ActiveRecord::Migration
+  def self.up
+    add_column :articles, :hits, :integer, :default => 0
+    add_column :article_versions, :hits, :integer, :default => 0
+  end
+
+  def self.down
+    remove_column :articles, :hits
+    remove_column :article_versions, :hits
+  end
+end
@@ -9,7 +9,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
-ActiveRecord::Schema.define(:version => 57) do
+ActiveRecord::Schema.define(:version => 58) do
   create_table "article_versions", :force => true do |t|
     t.integer  "article_id"
@@ -41,6 +41,7 @@ ActiveRecord::Schema.define(:version =&gt; 57) do
     t.integer  "reference_article_id"
     t.text     "setting"
     t.boolean  "notify_comments",      :default => false
+    t.integer  "hits",                 :default => 0
   end
   create_table "articles", :force => true do |t|
@@ -73,6 +74,7 @@ ActiveRecord::Schema.define(:version =&gt; 57) do
     t.integer  "reference_article_id"
     t.text     "setting"
     t.boolean  "notify_comments",      :default => false
+    t.integer  "hits",                 :default => 0
   end
   create_table "articles_categories", :id => false, :force => true do |t|
@@ -23,6 +23,11 @@
   text-decoration: none;
 }
+#article-hits {
+  font-size: 10px;
+  text-align: right;
+}
+
 #article-cat {
   font-size: 10px;
 }
@@ -644,4 +644,11 @@ class ContentViewerControllerTest &lt; Test::Unit::TestCase
     assert_tag :tag => 'div', :attributes => { :id => "post-#{t.id}" }, :descendant => { :tag => 'a', :content => 'No comments yet', :attributes => { :href => /#{profile.identifier}\/blog\/first-post\?form=opened#comment_form/ } }
   end
+  should 'hit the article when viewed' do
+    a = profile.articles.create!(:name => 'test article')
+    get :view_page, :profile => profile.identifier, :page => [a.path]
+    a.reload
+    assert_equal 1, a.hits
+  end
+
 end
@@ -589,4 +589,30 @@ class ArticleTest &lt; Test::Unit::TestCase
     assert !a.notify_comments?
   end
+  should 'hold hits count' do
+    a = Article.create!(:name => 'Test article', :profile => profile)
+    a.hits = 10
+    a.save!
+    a.reload
+    assert_equal 10, a.hits
+  end
+
+  should 'increment hit counter when hitted' do
+    a = Article.create!(:name => 'Test article', :profile => profile, :hits => 10)
+    a.hit
+    a.reload
+    assert_equal 11, a.hits
+  end
+
+  should 'have display_hits setting with default true' do
+    a = Article.create!(:name => 'Test article', :profile => profile)
+    assert_respond_to a, :display_hits
+    assert_equal true, a.display_hits
+  end
+
+  should 'can display hits' do
+    a = Article.create!(:name => 'Test article', :profile => profile)
+    assert_respond_to a, :can_display_hits?
+    assert_equal true, a.can_display_hits?
+  end
 end
@@ -53,4 +53,10 @@ class EnterpriseHomepageTest &lt; Test::Unit::TestCase
     result = a.to_html
     assert_match /catalog\/test_enterprise\/#{prod.id}/, result
   end
+
+  should 'can display hits' do
+    a = EnterpriseHomepage.new(:name => 'Test article')
+    assert_equal false, a.can_display_hits?
+  end
+
 end
@@ -46,4 +46,9 @@ class FolderTest &lt; ActiveSupport::TestCase
     assert Folder.new.folder?, 'folder must identity itself as folder'
   end
+  should 'can display hits' do
+    a = Folder.create!(:name => 'Test article', :profile => profile)
+    assert_equal false, a.can_display_hits?
+  end
+
 end
@@ -220,4 +220,10 @@ class RssFeedTest &lt; Test::Unit::TestCase
     assert !feed.advertise?
   end
+  should 'can display hits' do
+    p = create_user('testuser').person
+    a = RssFeed.create!(:name => 'Test article', :profile => p)
+    assert_equal false, a.can_display_hits?
+  end
+
 end
@@ -68,4 +68,9 @@ class UploadedFileTest &lt; Test::Unit::TestCase
     assert_includes file.attachment_validation_options, :size
   end
+  should 'can display hits' do
+    file = UploadedFile.new(:uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'))
+    assert_equal false, file.can_display_hits?
+  end
+
 end
	@@ -26,4 +26,8 @@ class EnterpriseHomepage < Article		@@ -26,4 +26,8 @@ class EnterpriseHomepage < Article
26	(self.profile.environment.enabled?('disable_products_for_enterprises') ? '' : display_products_list(self.profile, products))	26	(self.profile.environment.enabled?('disable_products_for_enterprises') ? '' : display_products_list(self.profile, products))
27	end	27	end
28		28
		29	+ def can_display_hits?
		30	+ false
		31	+ end
		32	+
29	end	33	end
	@@ -29,4 +29,8 @@ class Folder < Article		@@ -29,4 +29,8 @@ class Folder < Article
29	true	29	true
30	end	30	end
31		31
		32	+ def can_display_hits?
		33	+ false
		34	+ end
		35	+
32	end	36	end
	@@ -119,4 +119,8 @@ class RssFeed < Article		@@ -119,4 +119,8 @@ class RssFeed < Article
119	'rss-feed'	119	'rss-feed'
120	end	120	end
121		121
		122	+ def can_display_hits?
		123	+ false
		124	+ end
		125	+
122	end	126	end
	@@ -49,4 +49,8 @@ class UploadedFile < Article		@@ -49,4 +49,8 @@ class UploadedFile < Article
49	false	49	false
50	end	50	end
51		51
		52	+ def can_display_hits?
		53	+ false
		54	+ end
		55	+
52	end	56	end
	@@ -61,6 +61,12 @@		@@ -61,6 +61,12 @@
61	</div>	61	</div>
62	<% end %>	62	<% end %>
63		63
		64	+<% if @page.display_hits? %>
		65	+ <div id="article-hits">
		66	+ <%= n_('Viewed one time', 'Viewed %{num} times', @page.hits) % { :num => @page.hits } %>
		67	+ </div>
		68	+<% end %>
		69	+
64	<% if @page.parent && !@page.parent.path.blank? %>	70	<% if @page.parent && !@page.parent.path.blank? %>
65	<div id="article-parent">	71	<div id="article-parent">
66	<%= link_to_document(@page.parent, _('Up')) %>	72	<%= link_to_document(@page.parent, _('Up')) %>
@@ -0,0 +1,11 @@		@@ -0,0 +1,11 @@
	1	+class AddHitsToArticles < ActiveRecord::Migration
	2	+ def self.up
	3	+ add_column :articles, :hits, :integer, :default => 0
	4	+ add_column :article_versions, :hits, :integer, :default => 0
	5	+ end
	6	+
	7	+ def self.down
	8	+ remove_column :articles, :hits
	9	+ remove_column :article_versions, :hits
	10	+ end
	11	+end
	@@ -644,4 +644,11 @@ class ContentViewerControllerTest < Test::Unit::TestCase		@@ -644,4 +644,11 @@ class ContentViewerControllerTest < Test::Unit::TestCase
644	assert_tag :tag => 'div', :attributes => { :id => "post-#{t.id}" }, :descendant => { :tag => 'a', :content => 'No comments yet', :attributes => { :href => /#{profile.identifier}\/blog\/first-post\?form=opened#comment_form/ } }	644	assert_tag :tag => 'div', :attributes => { :id => "post-#{t.id}" }, :descendant => { :tag => 'a', :content => 'No comments yet', :attributes => { :href => /#{profile.identifier}\/blog\/first-post\?form=opened#comment_form/ } }
645	end	645	end
646		646
		647	+ should 'hit the article when viewed' do
		648	+ a = profile.articles.create!(:name => 'test article')
		649	+ get :view_page, :profile => profile.identifier, :page => [a.path]
		650	+ a.reload
		651	+ assert_equal 1, a.hits
		652	+ end
		653	+
647	end	654	end
	@@ -589,4 +589,30 @@ class ArticleTest < Test::Unit::TestCase		@@ -589,4 +589,30 @@ class ArticleTest < Test::Unit::TestCase
589	assert !a.notify_comments?	589	assert !a.notify_comments?
590	end	590	end
591		591
		592	+ should 'hold hits count' do
		593	+ a = Article.create!(:name => 'Test article', :profile => profile)
		594	+ a.hits = 10
		595	+ a.save!
		596	+ a.reload
		597	+ assert_equal 10, a.hits
		598	+ end
		599	+
		600	+ should 'increment hit counter when hitted' do
		601	+ a = Article.create!(:name => 'Test article', :profile => profile, :hits => 10)
		602	+ a.hit
		603	+ a.reload
		604	+ assert_equal 11, a.hits
		605	+ end
		606	+
		607	+ should 'have display_hits setting with default true' do
		608	+ a = Article.create!(:name => 'Test article', :profile => profile)
		609	+ assert_respond_to a, :display_hits
		610	+ assert_equal true, a.display_hits
		611	+ end
		612	+
		613	+ should 'can display hits' do
		614	+ a = Article.create!(:name => 'Test article', :profile => profile)
		615	+ assert_respond_to a, :can_display_hits?
		616	+ assert_equal true, a.can_display_hits?
		617	+ end
592	end	618	end
	@@ -53,4 +53,10 @@ class EnterpriseHomepageTest < Test::Unit::TestCase		@@ -53,4 +53,10 @@ class EnterpriseHomepageTest < Test::Unit::TestCase
53	result = a.to_html	53	result = a.to_html
54	assert_match /catalog\/test_enterprise\/#{prod.id}/, result	54	assert_match /catalog\/test_enterprise\/#{prod.id}/, result
55	end	55	end
		56	+
		57	+ should 'can display hits' do
		58	+ a = EnterpriseHomepage.new(:name => 'Test article')
		59	+ assert_equal false, a.can_display_hits?
		60	+ end
		61	+
56	end	62	end
	@@ -46,4 +46,9 @@ class FolderTest < ActiveSupport::TestCase		@@ -46,4 +46,9 @@ class FolderTest < ActiveSupport::TestCase
46	assert Folder.new.folder?, 'folder must identity itself as folder'	46	assert Folder.new.folder?, 'folder must identity itself as folder'
47	end	47	end
48		48
		49	+ should 'can display hits' do
		50	+ a = Folder.create!(:name => 'Test article', :profile => profile)
		51	+ assert_equal false, a.can_display_hits?
		52	+ end
		53	+
49	end	54	end