bcms_rankings 1.0.0 → 2.0.0

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+gem "jquery-rails"
+gem 'sqlite3'

data/README.markdown

@@ -1,8 +1,38 @@
 # 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.
+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.
+
+## Installation
+
+	
+The Ranking module installs like most other BrowserCMS modules (http://guides.browsercms.org/installing_modules.html)
+
+### 1. Install the module 
+
+$ rails g cms:install bcms_rankings
+
+### 2. Run the following commands
+
+    $ rake db:migrate
+  	$ rake db:seed
+
+For projects with existing databases, you may need to comment out other lines in db/seeds.rb so only the module seed data runs.
+
+### 3. Create a Ranking portlet and embed into your templates
+
+* Open your browser to localhost:3000/cms/portlets and login 
+* Click 'Add New Content', and select 'Rank This Page Portlet'
+* Set the name to 'Rank This Page' and click save.
+* Now go to Administration -> Page Templates -> Sub Page -> Edit
+* Add the following line to your template, somewhere in the body (preferably after your main content area)
+
+		<%= render_portlet "Rank This Page" %>
+
+This will render embed the portlet named "Rank This Page" into any page which uses the Sub Page template. 
+
+* Now add a new page using the "Sub Page" template and you should see the radio buttons to rank the page. Ranking a page will update the associated page rank.

data/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/bcms_rankings/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/bcms_rankings/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/bcms_rankings/application_controller.rb

@@ -0,0 +1,4 @@
+module BcmsRankings
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/bcms_rankings/page_rankings_controller.rb

@@ -0,0 +1,4 @@
+module BcmsRankings
+  class PageRankingsController < Cms::ContentBlockController
+  end
+end

data/app/controllers/page_rankings_controller.rb

@@ -1,7 +1,7 @@
 class PageRankingsController < ApplicationController
 
   def create
-    @page_ranking = PageRanking.new(params[:page_ranking])
+    @page_ranking = BcmsRankings::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

data/app/helpers/bcms_rankings/application_helper.rb

@@ -0,0 +1,4 @@
+module BcmsRankings
+  module ApplicationHelper
+  end
+end

data/app/models/bcms_rankings/page_ranking.rb

@@ -0,0 +1,16 @@
+module BcmsRankings
+  class PageRanking < ActiveRecord::Base
+    acts_as_content_block
+  
+    belongs_to :page, :class_name => 'Cms::Page'
+    validates_presence_of :page_id
+    attr_accessible :page
+    
+    scope :for_page, lambda{|p| {:conditions => ["#{table_name}.page_id = ?", p.id]}}
+
+
+    def self.rank(page, rank)
+      PageRanking.create!(:page=>page, :rank=>rank)    
+    end
+  end
+end

data/app/portlets/highest_ranked_pages_portlet.rb

@@ -1,11 +1,11 @@
-class HighestRankedPagesPortlet < Portlet
+class HighestRankedPagesPortlet < Cms::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',
+            Cms::Page.find(:all,
+              :select => "#{Cms::Page.table_name}.*, COUNT(#{BcmsRankings::PageRanking.table_name}.id) AS rankings_count, AVG(#{BcmsRankings::PageRanking.table_name}.rank) as avg_rank",
+              :joins  => "INNER JOIN #{BcmsRankings::PageRanking.table_name} ON #{BcmsRankings::PageRanking.table_name}.page_id = #{Cms::Page.table_name}.id",
+              :group  => "#{Cms::Page.table_name}.id",
               :limit => @portlet.number_to_show,
               :order => "avg_rank desc")
   end

data/app/portlets/rank_this_page_portlet.rb

@@ -1,13 +1,13 @@
-class RankThisPagePortlet < Portlet
+class RankThisPagePortlet < Cms::Portlet
     
   def render
     @page = @controller.instance_variable_get("@page")
     if @page
-      @rankings = PageRanking.for_page(@page)
+      @rankings = ranking().for_page(@page)
       @average_rank = average_ranking(@rankings)
       
       # For the form to create a new ranking
-      @page_ranking = PageRanking.new(:page => @page)
+      @page_ranking = ranking().new(:page => @page)
     end
   end
 
@@ -17,7 +17,14 @@ class RankThisPagePortlet < Portlet
     rankings.each do |r|
       total = total + r.rank
     end
-    (total/rankings.size).round_with_precision(1)
+    (total/rankings.size).round(1)
 
   end
+  
+  private
+  
+  # Faux class like method for less typing
+  def ranking()
+    BcmsRankings::PageRanking
+  end
 end

data/app/views/bcms_rankings/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, Cms::Page.all(:order => "path").map{|p| ["#{p.path} (#{p.name})", p.id]}%>

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

@@ -2,6 +2,6 @@
 <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>
+        <li><%= link_to page.name, page.path %>: Average is <%= page.avg_rank.to_f.round(1) %> with <%= page.rankings_count %> total votes.</li>
     <% end %>
 </ol>

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

@@ -2,7 +2,7 @@
     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| %>
+    <%= form_for @page_ranking do |f| %>
         <%= f.hidden_field :page_id %>
         <% (1..5).each do |count| %>
             <%= count %><%= f.radio_button :rank, count %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+BcmsRankings::Engine.routes.draw do
+  content_blocks :page_rankings
+end

data/db/bcms_rankings.seeds.rb

@@ -0,0 +1 @@
+Cms::ContentType.create!(:name => "BcmsRankings::PageRanking", :group_name => "Page Ranking")

data/db/migrate/20090430194533_create_page_rankings.rb

@@ -1,19 +1,10 @@
 class CreatePageRankings < ActiveRecord::Migration
-  def self.up
+  def change
     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/db/migrate/20120703191943_page_ranking_v2_0_0.rb

@@ -0,0 +1,7 @@
+require 'cms/upgrades/v3_5_0'
+
+class PageRankingV200 < ActiveRecord::Migration
+  def change
+      v3_5_0_apply_namespace_to_block("BcmsRankings", "PageRanking")
+  end
+end

data/lib/bcms_rankings.rb

@@ -1 +1,5 @@
-require 'bcms_rankings/routes'
+require "bcms_rankings/engine"
+require "bcms_rankings/route_extensions"
+
+module BcmsRankings
+end

data/lib/bcms_rankings/engine.rb

@@ -0,0 +1,11 @@
+require 'browsercms'
+module BcmsRankings
+  class Engine < ::Rails::Engine
+    isolate_namespace BcmsRankings
+		include Cms::Module
+		
+    initializer 'bcms_rankings.route_extensions', :after => 'action_dispatch.prepare_dispatcher' do |app|
+      ActionDispatch::Routing::Mapper.send :include, BcmsRankings::RouteExtensions
+    end
+  end
+end

data/lib/bcms_rankings/route_extensions.rb

@@ -0,0 +1,9 @@
+module BcmsRankings::RouteExtensions
+  def mount_bcms_rankings
+    mount BcmsRankings::Engine => "/bcms_rankings"
+    post '/page_rankings' => 'page_rankings#create', :as=>'page_rankings'
+  end
+  
+  alias :routes_for_bcms_rankings :mount_bcms_rankings
+  
+end

data/lib/bcms_rankings/version.rb

@@ -0,0 +1,3 @@
+module BcmsRankings
+  VERSION = "2.0.0"
+end

data/lib/generators/bcms_rankings/install/USAGE

@@ -0,0 +1,3 @@
+Installs bcms_rankings into a project. Typically invoked indirectly via:
+
+   rails generate cms:install bcms_rankings

data/lib/generators/bcms_rankings/install/install_generator.rb

@@ -0,0 +1,19 @@
+require 'cms/module_installation'
+
+class BcmsRankings::InstallGenerator < Cms::ModuleInstallation
+  add_migrations_directory_to_source_root __FILE__
+  
+  def copy_migrations
+    rake 'bcms_rankings:install:migrations'
+  end
+
+  def add_seed_data_to_project
+    copy_file "../bcms_rankings.seeds.rb", "db/bcms_rankings.seeds.rb"
+    append_to_file "db/seeds.rb", "load File.expand_path('../bcms_rankings.seeds.rb', __FILE__)\n"
+  end
+  
+  def add_routes
+    route 'mount_bcms_rankings'
+  end
+    
+end

data/lib/tasks/bcms_rankings_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bcms_rankings do
+#   # Task goes here
+# end

metadata

@@ -1,77 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bcms_rankings
-version: !ruby/object:Gem::Version 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - BrowserMedia
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-07-02 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: browsercms
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 description: A Page ranking Module for BrowserCMS
 email: github@browsermedia.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
+extra_rdoc_files:
 - README.markdown
-files: 
-- app/controllers/application_controller.rb
-- app/controllers/cms/page_rankings_controller.rb
+files:
+- app/assets/javascripts/application.js
+- app/assets/javascripts/bcms_rankings/application.js
+- app/assets/stylesheets/application.css
+- app/assets/stylesheets/bcms_rankings/application.css
+- app/controllers/bcms_rankings/application_controller.rb
+- app/controllers/bcms_rankings/page_rankings_controller.rb
 - app/controllers/page_rankings_controller.rb
-- app/helpers/application_helper.rb
-- app/models/page_ranking.rb
+- app/helpers/bcms_rankings/application_helper.rb
+- app/models/bcms_rankings/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/bcms_rankings/page_rankings/_form.html.erb
+- app/views/bcms_rankings/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
+- config/routes.rb
+- db/bcms_rankings.seeds.rb
 - db/migrate/20090430194533_create_page_rankings.rb
+- db/migrate/20120703191943_page_ranking_v2_0_0.rb
+- lib/bcms_rankings/engine.rb
+- lib/bcms_rankings/route_extensions.rb
+- lib/bcms_rankings/version.rb
 - lib/bcms_rankings.rb
-- lib/bcms_rankings/routes.rb
-- rails/init.rb
-- LICENSE.txt
+- lib/generators/bcms_rankings/install/install_generator.rb
+- lib/generators/bcms_rankings/install/USAGE
+- lib/tasks/bcms_rankings_tasks.rake
 - README.markdown
-has_rdoc: true
-homepage: http://browsercms.org
+- Gemfile
+- LICENSE.txt
+- COPYRIGHT.txt
+- GPL.txt
+homepage: http://www.github.com/browsermedia/bcms_rankings
+licenses: []
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+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: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1733280016254060861
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1733280016254060861
 requirements: []
-
-rubyforge_project: browsercms
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 2
+specification_version: 3
 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
+test_files: []