bcms_page_comments 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,61 @@
+# Page Comments Module for BrowserCMS
+
+A simple comments module that can be embedded into pages to allow users to leave comments. It adds the following capabilities:
+
+* A page comment block, which stores the user name, email, url and comment of public visitors.
+* A comments portlet, which can be added to any template, and will record comments for that page.
+
+## Installation
+To install this module, do the following:
+
+### A. Build and install the gem from source
+This assumes you have the latest copy of the code from github on your machine.
+
+        gem build bcms_page_comments.gemspec
+        sudo gem install bcms_page_comments-1.0.0.gem
+
+At this point, the Page Comments gem should be installed as a gem on your system, and can be added to your projects.
+
+### B. Adding the Page Comments to your project
+In your BrowserCMS application, do the following steps.
+
+#### 1. Edit the confing/environment.rb file
+
+		config.gem 'browsercms'
+
+		# Add this next line after the browsercms gem
+		config.gem "bcms_page_comments"
+
+#### 2. Edit the routes.rb file
+
+		# Add this route. It must be before the core browser_cms route.
+		map.routes_for_bcms_page_comments
+		map.routes_for_browser_cms
+
+#### 3. Install the new module code
+From the root directory of your cms project, run:
+
+		script/generate browser_cms
+
+This will copy all the necessary views and migrations from the gems into your local project. You should messages checking to see if files already exist or were created.
+
+#### 4. Run migrations and start the server
+Modules will often add new data types, like content blocks, so you need to run the migrations to add them to your project.
+
+		rake db:migrate
+		script/server
+
+#### 5. Create a Comments portlet and embed into your templates
+* Open your browser to localhost:3000/cms/portlets and login 
+* Click 'Add New Content', and select 'Page Comments Portlet'
+* Set the name to 'Page Comments' 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 "Page Comments" %>
+
+This will render embed the portlet named "Page Comments" into any page which uses the Sub Page template. 
+
+* Now add a new page using the "Sub Page" template and you should see the comments form. Adding a new comment will display on that page.
+
+

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_comments_controller.rb

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

data/app/controllers/page_comments_controller.rb

@@ -0,0 +1,19 @@
+class PageCommentsController < Cms::ApplicationController
+
+  before_filter :verify_user_is_logged_in
+
+  def create
+    @page_comment = PageComment.new(params[:page_comment])
+    @page_comment.ip = request.remote_ip
+    if @page_comment.save
+      flash[:notice] = "Comment was created"
+    end
+    redirect_to @page_comment.page.path
+  end
+
+  private
+  
+  def verify_user_is_logged_in
+    raise Cms::Errors::AccessDenied if current_user.guest?
+  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_comment.rb

@@ -0,0 +1,11 @@
+class PageComment < ActiveRecord::Base
+  acts_as_content_block
+  belongs_to :page
+
+  validates_presence_of :page_id
+
+  named_scope :for_page, lambda{|p| {:conditions => ["page_comments.page_id = ?", p.id]}}
+
+
+
+end

data/app/portlets/most_commented_on_portlet.rb

@@ -0,0 +1,18 @@
+class MostCommentedOnPortlet < Portlet
+    
+  def render
+    @pages = most_popular_pages(@portlet.number_to_show)
+  end
+
+  def most_popular_pages (limit)
+    Page.find(:all,
+              :select => 'pages.*, COUNT(page_comments.id) AS comments_count',
+              :joins  => 'INNER JOIN page_comments ON page_comments.page_id = pages.id',
+              :group  => 'pages.id',
+              :limit => limit,
+              :order => "comments_count desc")
+
+
+  end
+
+end

data/app/portlets/page_comments_portlet.rb

@@ -0,0 +1,14 @@
+class PageCommentsPortlet < Portlet
+    
+  def render
+    @page = @controller.instance_variable_get("@page")
+    if @page
+      # The list of comments to show
+      @page_comments = PageComment.for_page(@page).all(:order => "created_at desc")
+    
+      # For the form to create a new comment
+      @page_comment = PageComment.new(:page => @page)
+    end
+  end
+    
+end

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

@@ -0,0 +1,5 @@
+<%= f.cms_drop_down :page_id, Page.all(:order => "path").map{|p| ["#{p.path} (#{p.name})", p.id]}%>
+<%= f.cms_text_field :name %>
+<%= f.cms_text_field :email %>
+<%= f.cms_text_field :url %>
+<%= f.cms_text_area :body %>

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

@@ -0,0 +1,6 @@
+<p><b>Page:</b> <%= @content_block.page.name %></p>
+<p><b>Name:</b> <%= @content_block.name %></p>
+<p><b>Email:</b> <%= @content_block.email %></p>
+<p><b>Url:</b> <%= @content_block.url %></p>
+<p><b>Body:</b> <%= h(@content_block.body).gsub(/\n/,'<br/>') %></p>
+<p><b>Ip:</b> <%= @content_block.ip %></p>

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

@@ -0,0 +1,3 @@
+<%= f.cms_text_field :name, :default_value=>"Most Commented On Pages" %>
+<%= f.cms_text_field :number_to_show, :default_value=>5 %>
+<%= f.cms_text_area :template, :default_value=>MostCommentedOnPortlet.default_template %>

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

@@ -0,0 +1,7 @@
+<h2>Most Commented On Pages</h2>
+<p>The list of pages below shows the most frequently commented on pages, in order of popularity.</p>
+<ol>
+<% @pages.each do |page| %>
+    <li><%= link_to page.name, page.path %> (<%= page.comments_count %> comments)</li>
+  <% end %>
+</ol>

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

@@ -0,0 +1,2 @@
+<%= f.cms_text_field :name %>
+<%= f.cms_text_area :template, :default_value => PageCommentsPortlet.default_template %>

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

@@ -0,0 +1,31 @@
+<% if @page %>
+  <% @page_comments.each do |page_comment| %>
+    <div id="page_comment_<%= page_comment.id %>" class="page_comment">
+      Comment by 
+      <strong><%= h(page_comment.name) %></strong>
+      on <em><%= page_comment.created_at.strftime("%A, %B %e %Y") %></em>
+      at <em><%= page_comment.created_at.strftime("%l:%M %p") %></em>
+      <br />
+      <%= h(page_comment.body).gsub(/\n/,'<br/>') %>
+    </div>
+    <hr style="margin: 10px 0"/>
+  <% end %>
+
+  <% unless current_user.guest? %>
+      <% form_for @page_comment do |f| %>
+        <%= f.hidden_field :page_id %>
+        <%= f.label :name %>
+        <%= f.text_field :name %>
+        <br/>
+        <%= f.label :email %>
+        <%= f.text_field :email %>
+        <br/>
+        <%= f.label :url %>
+        <%= f.text_field :url %>
+        <br/>
+        <%= f.text_area :body, :size => "80x5" %>
+        <br/>
+        <%= f.submit "Post Comment" %>
+      <% end %>
+  <% end %>
+<% end %>

data/db/migrate/20090417155756_create_page_comments.rb

@@ -0,0 +1,21 @@
+class CreatePageComments < ActiveRecord::Migration
+  def self.up
+    create_versioned_table :page_comments do |t|
+      t.belongs_to :page 
+      t.string :name 
+      t.string :email 
+      t.string :url 
+      t.text :body 
+      t.string :ip 
+    end
+    
+    
+    ContentType.create!(:name => "PageComment", :group_name => "Comments")
+  end
+
+  def self.down
+    ContentType.delete_all(['name = ?', 'PageComment'])
+    drop_table :page_comment_versions
+    drop_table :page_comments
+  end
+end

data/lib/bcms_page_comments/routes.rb

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

data/lib/bcms_page_comments.rb

@@ -0,0 +1 @@
+require 'bcms_page_comments/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/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/portlets/most_commented_on_portlet_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class MostCommentedOnPortletTest < ActiveSupport::TestCase
+
+
+
+  def teardown
+
+  end
+
+  class StubPortlet
+    attr_accessor :number_to_show
+  end
+
+  test "Finds only a limited # of pages" do
+    build_pages
+    portlet = MostCommentedOnPortlet.new
+
+    portlet = MostCommentedOnPortlet.new
+    params = StubPortlet.new
+    params.number_to_show = 1
+    portlet.instance_variable_set(:@portlet, params)
+
+    portlet.render
+
+    assert_equal 1, portlet.instance_variable_get(:@pages).size
+
+  end
+
+
+
+
+  test "Find pages" do
+    build_pages
+    portlet = MostCommentedOnPortlet.new
+
+    pages = portlet.most_popular_pages(2)
+    assert_equal 2, pages.size
+    assert_equal @popular.name, pages[0].name
+    assert_equal "3", pages[0].comments_count
+    assert_equal "/popular", pages[0].path
+
+    assert_equal @middle.name, pages[1].name
+    assert_equal "/middle", pages[1].path
+  end
+  private
+
+  def build_pages
+    @lonely = Page.create!(:name => "Lonely", :path=>"/lonely")
+    @popular = Page.create!(:name => "Popular", :path=>"/popular")
+    @middle = Page.create!(:name => "Middle", :path=>"/middle")
+
+    PageComment.create!(:page=>@lonely)
+
+    PageComment.create!(:page=>@middle)
+    PageComment.create!(:page=>@middle)
+
+    PageComment.create!(:page=>@popular)
+    PageComment.create!(:page=>@popular)
+    PageComment.create!(:page=>@popular)
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_page_comments
+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: The Page Comments 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_comments_controller.rb
+- app/controllers/page_comments_controller.rb
+- app/helpers/application_helper.rb
+- app/models/page_comment.rb
+- app/portlets/most_commented_on_portlet.rb
+- app/portlets/page_comments_portlet.rb
+- app/views/cms/page_comments/_form.html.erb
+- app/views/cms/page_comments/render.html.erb
+- app/views/portlets/most_commented_on/_form.html.erb
+- app/views/portlets/most_commented_on/render.html.erb
+- app/views/portlets/page_comments/_form.html.erb
+- app/views/portlets/page_comments/render.html.erb
+- db/migrate/20090417155756_create_page_comments.rb
+- lib/bcms_page_comments.rb
+- lib/bcms_page_comments/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: The Page Comments Module for BrowserCMS
+test_files: 
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/portlets/most_commented_on_portlet_test.rb