bcms_rankings 1.0.0

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.markdown

@@ -0,0 +1,8 @@
+# Rankings Module for BrowserCMS
+This is module for BrowserCMS, which allows users to rank pages. It includes the following features:
+
+* Rank This Page - Users can use a control on a page that allows users to rank a page from 1-5.
+* Highest Ranked Pages - Users can see a list of pages which have the highest rank.
+
+This module is primarily for demo purposes, and currently does not have any 'voter fraud' detection to prevent multiple
+votes. Ideally, this would need to be done client side, with a cookie, so as to keep pages cachable in the CMS.

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/cms/page_rankings_controller.rb

@@ -0,0 +1,2 @@
+class Cms::PageRankingsController < Cms::ContentBlockController
+end

data/app/controllers/page_rankings_controller.rb

@@ -0,0 +1,12 @@
+class PageRankingsController < ApplicationController
+
+  def create
+    @page_ranking = PageRanking.new(params[:page_ranking])
+    @page_ranking.ip = request.remote_ip
+    @page_ranking.name = "Page '#{@page_ranking.page.name}' ranked as #{@page_ranking.rank}"
+    if !@page_ranking.save
+      flash[:notice] = "New Ranking was created"
+    end
+    redirect_to @page_ranking.page.path
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/models/page_ranking.rb

@@ -0,0 +1,14 @@
+class PageRanking < ActiveRecord::Base
+  acts_as_content_block
+  
+  belongs_to :page
+
+  validates_presence_of :page_id
+
+  named_scope :for_page, lambda{|p| {:conditions => ["page_rankings.page_id = ?", p.id]}}
+
+
+  def self.rank(page, rank)
+    PageRanking.create!(:page=>page, :rank=>rank)    
+  end
+end

data/app/portlets/highest_ranked_pages_portlet.rb

@@ -0,0 +1,13 @@
+class HighestRankedPagesPortlet < Portlet
+    
+  def render
+    @pages =
+            Page.find(:all,
+              :select => 'pages.*, COUNT(page_rankings.id) AS rankings_count, AVG(page_rankings.rank) as avg_rank',
+              :joins  => 'INNER JOIN page_rankings ON page_rankings.page_id = pages.id',
+              :group  => 'pages.id',
+              :limit => @portlet.number_to_show,
+              :order => "avg_rank desc")
+  end
+
+end

data/app/portlets/rank_this_page_portlet.rb

@@ -0,0 +1,23 @@
+class RankThisPagePortlet < Portlet
+    
+  def render
+    @page = @controller.instance_variable_get("@page")
+    if @page
+      @rankings = PageRanking.for_page(@page)
+      @average_rank = average_ranking(@rankings)
+      
+      # For the form to create a new ranking
+      @page_ranking = PageRanking.new(:page => @page)
+    end
+  end
+
+  def average_ranking(rankings)
+    return 0 unless rankings.size > 0
+    total = 0.0
+    rankings.each do |r|
+      total = total + r.rank
+    end
+    (total/rankings.size).round_with_precision(1)
+
+  end
+end

data/app/views/cms/page_rankings/_form.html.erb

@@ -0,0 +1,2 @@
+<%= f.cms_text_field :rank, :instructions=>"Rank should be a number between 1 and 5." %>
+<%= f.cms_drop_down :page_id, Page.all(:order => "path").map{|p| ["#{p.path} (#{p.name})", p.id]}%>

data/app/views/cms/page_rankings/render.html.erb

@@ -0,0 +1,3 @@
+<p><b>Name:</b> <%= @content_block.name %></p>
+<p><b>Rank:</b> <%= @content_block.rank %></p>
+<p><b>Ip:</b> <%= @content_block.ip %></p>

data/app/views/portlets/highest_ranked_pages/_form.html.erb

@@ -0,0 +1,3 @@
+<%= f.cms_text_field :name, :default_value=>"Highest Ranked Pages" %>
+<%= f.cms_text_field :number_to_show, :default_value=>5 %>
+<%= f.cms_text_area :template, :default_value=>HighestRankedPagesPortlet.default_template %>

data/app/views/portlets/highest_ranked_pages/render.html.erb

@@ -0,0 +1,7 @@
+<h2>Highest Ranked Pages</h2>
+<p>The list of pages below shows the highest ranked pages, in order of popularity.</p>
+<ol>
+    <% @pages.each do |page| %>
+        <li><%= link_to page.name, page.path %>: Average is <%= page.avg_rank.to_f.round_with_precision(1) %> with <%= page.rankings_count %> total votes.</li>
+    <% end %>
+</ol>

data/app/views/portlets/rank_this_page/_form.html.erb

@@ -0,0 +1,2 @@
+<%= f.cms_text_field :name, :default_value=>"Rank This Page" %>
+<%= f.cms_text_area :template, :default_value=>RankThisPagePortlet.default_template %>

data/app/views/portlets/rank_this_page/render.html.erb

@@ -0,0 +1,15 @@
+<% if @page %>
+    Average rank is <%= @average_rank %> out of <%= @rankings.size %> total.
+    <h3>Rank this Page</h3>
+    <p>Please rank the quality of this page, with #1 being the worst, and #5 the best.</p>
+    <% form_for @page_ranking do |f| %>
+        <%= f.hidden_field :page_id %>
+        <% (1..5).each do |count| %>
+            <%= count %><%= f.radio_button :rank, count %>
+        <% end  %>
+        <%= f.submit "Rate It!" %>
+
+    <% end %>
+<% else %>
+    This portlet must be placed on a page in order to view it.
+<% end %>

data/db/migrate/20090430194533_create_page_rankings.rb

@@ -0,0 +1,19 @@
+class CreatePageRankings < ActiveRecord::Migration
+  def self.up
+    create_versioned_table :page_rankings do |t|
+      t.belongs_to :page
+      t.string :name
+      t.integer :rank 
+      t.string :ip 
+    end
+    
+    
+    ContentType.create!(:name => "PageRanking", :group_name => "Page Ranking")
+  end
+
+  def self.down
+    ContentType.delete_all(['name = ?', 'PageRanking'])
+    drop_table :page_ranking_versions
+    drop_table :page_rankings
+  end
+end

data/lib/bcms_rankings/routes.rb

@@ -0,0 +1,12 @@
+module Cms::Routes
+  def routes_for_bcms_rankings
+    page_rankings "/page_rankings",
+      :controller => "page_rankings",
+      :action => "create",
+      :conditions => {:method => :post}
+
+    namespace(:cms) do |cms|
+      cms.content_blocks :page_rankings
+    end  
+  end
+end

data/lib/bcms_rankings.rb

@@ -0,0 +1 @@
+require 'bcms_rankings/routes'

data/rails/init.rb

@@ -0,0 +1,3 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"

data/test/functional/page_rankings_controller_test.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), '/../test_helper')
+
+class PageRankingsControllerTest < ActionController::TestCase
+
+  def setup
+
+  end
+  
+  test "Should create a ranking with a name" do
+    page = Page.create!(:name => "Rank Me", :path=>"/path")
+    assert_equal "0.0.0.0", @request.remote_ip, "Verifies what the expected IP is from the Mock request"
+
+    post :create, :page_ranking => {:rank => 4, :page_id => page.id}
+
+    ranks = PageRanking.all
+
+
+    assert_equal 1, ranks.size
+    assert_equal page, ranks[0].page
+    assert_equal 4, ranks[0].rank
+    assert_equal "0.0.0.0", ranks[0].ip
+    assert_equal "Page 'Rank Me' ranked as 4", ranks[0].name
+  end
+end

data/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/unit/highest_ranked_pages_portlet_test.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), '/../test_helper')
+
+class HighestRankedPagesPortletTest < ActiveSupport::TestCase
+
+  def setup
+
+  end
+
+  def teardown
+
+  end
+
+
+  test "Portlet should find the highest ranked pages, in order of highest average ranking" do
+    page_b = Page.create!(:name=>"B", :path=>"/b")
+    page_c = Page.create!(:name=>"C", :path=>"/c")
+    page_a = Page.create!(:name=>"A", :path=>"/a")
+
+
+    PageRanking.rank(page_a, 1)
+    PageRanking.rank(page_a, 1)
+    PageRanking.rank(page_a, 1)
+    PageRanking.rank(page_b, 2)
+    PageRanking.rank(page_b, 1)
+    PageRanking.rank(page_c, 1)
+
+    portlet = HighestRankedPagesPortlet.new
+    portlet.number_to_show = 2
+    # This should be unnecessary, but Portlets can't internally reference their own properties atm.
+    portlet.instance_variable_set(:@portlet, portlet)
+
+    portlet.render
+
+    pages = portlet.instance_variable_get(:@pages)
+    assert_equal [page_b, page_a], pages
+    assert_equal "2", pages[0].rankings_count, "should include the total # of rankings"
+    assert_equal "3", pages[1].rankings_count
+    assert_equal 1.5, pages[0].avg_rank.to_f, "should include the average rank"
+    assert_equal 1, pages[1].avg_rank.to_f
+  end
+end

data/test/unit/page_ranking_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), '/../test_helper')
+
+class PageRankingTest < ActiveSupport::TestCase
+
+  def setup
+
+  end
+
+  def teardown
+
+  end
+
+
+  test "Page ranking can be found per page" do
+    page = Page.create!(:name=>"Ranked Page", :path => "/ranked")
+    rank = PageRanking.create!(:name=>"Testing", :page=>page)
+
+    list = PageRanking.for_page(page)
+    assert_equal [rank], list, "Should find all rankings for a given page."    
+
+  end
+
+  test "PageRanking.rank should create a rank for a given page" do
+    page = Page.create!(:name => "Name", :path=>"/path")
+
+    rank = PageRanking.rank(page, 1)
+
+    assert(PageRanking === rank, "Should create a PageRanking object")
+    assert_equal page, rank.page
+    assert_equal 1, rank.rank
+
+  end
+end

data/test/unit/rank_this_page_portlet_test.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), '/../test_helper')
+
+class RankThisPagePortletTest < ActiveSupport::TestCase
+
+  def setup
+
+  end
+
+  def teardown
+
+  end
+
+
+  test "Calculate average rankings" do
+    portlet = RankThisPagePortlet.new
+
+    assert_equal 3, portlet.average_ranking([PageRanking.new(:rank => 2), PageRanking.new(:rank=>4)])
+    assert_equal 2.5, portlet.average_ranking([PageRanking.new(:rank=>2), PageRanking.new(:rank=>3)])
+    assert_equal 2.7, portlet.average_ranking([PageRanking.new(:rank=>2), PageRanking.new(:rank=>3), PageRanking.new(:rank=>3)])
+  end
+
+
+  # Tests the fields made available to template. Since template is copied on creation, further versions should attempt
+  #   to be backwards compatible so as to not break previously created portlets.
+  test "Portlet should load all rankings, average them, and make all attributes avaiable to the template" do
+    page = Page.create!(:name=>"Ranked Page", :path => "/ranked")
+    rankings = [
+            PageRanking.create!(:page=>page, :rank=>3),
+            PageRanking.create!(:page=>page, :rank=>2)]
+    portlet = RankThisPagePortlet.new
+
+    class MockController
+      def initialize(page)
+        @page = page
+      end
+    end
+    portlet.instance_variable_set(:@controller, MockController.new(page))
+    
+    portlet.render
+
+    assert_equal page, portlet.instance_variable_get(:@page)
+    assert_equal 2.5, portlet.instance_variable_get(:@average_rank)
+    assert_not_nil  portlet.instance_variable_get(:@page_ranking), "Should create an empoty PageRanking for the form."
+    assert_equal rankings, portlet.instance_variable_get(:@rankings), "Should load all the rankings for the form." 
+  end
+
+  test "Calculate average with no rankings" do
+    portlet = RankThisPagePortlet.new
+
+    assert_equal 0, portlet.average_ranking([])
+
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_rankings
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- BrowserMedia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-02 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A Page ranking Module for BrowserCMS
+email: github@browsermedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- app/controllers/application_controller.rb
+- app/controllers/cms/page_rankings_controller.rb
+- app/controllers/page_rankings_controller.rb
+- app/helpers/application_helper.rb
+- app/models/page_ranking.rb
+- app/portlets/highest_ranked_pages_portlet.rb
+- app/portlets/rank_this_page_portlet.rb
+- app/views/cms/page_rankings/_form.html.erb
+- app/views/cms/page_rankings/render.html.erb
+- app/views/portlets/highest_ranked_pages/_form.html.erb
+- app/views/portlets/highest_ranked_pages/render.html.erb
+- app/views/portlets/rank_this_page/_form.html.erb
+- app/views/portlets/rank_this_page/render.html.erb
+- db/migrate/20090430194533_create_page_rankings.rb
+- lib/bcms_rankings.rb
+- lib/bcms_rankings/routes.rb
+- rails/init.rb
+- LICENSE.txt
+- README.markdown
+has_rdoc: true
+homepage: http://browsercms.org
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: browsercms
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A Page ranking Module for BrowserCMS
+test_files: 
+- test/functional/page_rankings_controller_test.rb
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/highest_ranked_pages_portlet_test.rb
+- test/unit/page_ranking_test.rb
+- test/unit/rank_this_page_portlet_test.rb