radiant-comments-extension 0.0.6

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.svn
+pkg/*

data/CHANGELOG

@@ -0,0 +1,40 @@
+= Git
+
+= 0.0.6
+
+* Added spam_answer_tag for simple spam protection or CAPTCHA
+* Added comments.notify_creator and comments.notify_updater to send emails to the page creator/updater [Jim Gay]
+* Added accept.png icon and rake task to copy it. [ryan@artofmission.com]
+
+= 0.0.5
+
+* Pluralized the `comments` tag so that it does not conflict with the standard Radiant `comment` tag. [nathaniel@terralien.com]
+* Added posting confirmation support. [nathaniel@terralien.com]
+* Added validation support. [nathaniel@terralien.com]
+* Allow disabling of input filters. [nathaniel@terralien.com]
+* Updated to work with Radiant 0.6.7. [nathaniel@terralien.com]
+
+= 0.0.4
+* Added additional options and formatting to admin interface [rch]
+* Added comment approval options [rch]
+* Comments must now be approved before they will show up [rch]
+
+= 0.0.3
+* Changed dependency from admin_parts to shards. [hcf]
+* Added the snippets to a migration, so that the users no longer have to do this manually. [hcf]
+* Changed filter_id from integer to string to make it similar to radiant core. [hcf]
+* Removed the 'Comments' tab, and moved the functionality to the 'Pages' tab instead using shards. [hcf]
+* Added support for filters in comments, through the comment:filter_box_tag tag. [hcf]
+* Simplified the comment snippets. [hcf]
+
+= 0.0.2
+
+* Added Akismet support. 
+* Added admin tools for moderating comments. 
+* Added destroy dependency to Page#Comments association. 
+* Added no_login_required to CommentsController. Comment should no longer force login when posted. 
+
+= 0.0.1
+
+* Basic comment functionality in place
+

data/HELP_admin.markdown

@@ -0,0 +1,52 @@
+You have the capability to use 3 different methods of spam blocking with this extension.
+
+1. Logic CAPTCHA (asking a question a spambot would not know)
+2. [Akismet](http://akismet.com/) 
+3. [Mollom](http://mollom.com/)
+
+## Spam Blocking
+
+By default, you will have sample questions that you may ask of your visitors. These questions are difficult
+to easily interpret by robots that may crawl your site looking to leave spam. See your Snippet
+'comment\_spam\_block' for examples of this.
+
+You will need to use the spam\_answer\_tag in your comment forms to present these questions to the user.
+
+If you wish disable this simple spam protection mechanism, you can do so using the `require_simple_spam_filter`
+config key, e.g. Radiant::Config['comments.require_simple_spam_filter'] = false
+
+To enable the Akismet protection, get yourself an account at http://akismet.com/personal/ for your personal
+blog or at http://akismet.com/commercial/ for your commercial sites. Then set your personal key and url
+in the Radiant::Config.
+
+For example:
+
+    Radiant::Config['comments.akismet_key'] = "6a009ca6ab4e"
+    Radiant::Config['comments.akismet_url'] = "yoursite.com"
+
+To enable Mollom protection, get yourself an account at http://mollom.com/user/register, add your site and
+set the public and private key pair in the Radiant::Config.
+
+    Radiant::Config['comments.mollom_privatekey'] = "deadbeef012345"
+    Radiant::Config['comments.mollom_publickey'] = "c00fee012345"
+
+If both services are configured, this plugin will use the Akismet service. Unset the akismet_key if you
+want to use Mollom.
+
+## Exporting Data
+
+To customize the CSV fields you can add an initializer like this:
+
+    Comment.class_eval do
+      def export_columns(format = nil)
+        %w[approved? author author_email content referrer]
+      end
+    end
+    
+## Viewing comments
+
+You may set the per page number of comments in the Radiant configuration options:
+    
+    Radiant::Config['comments.per_page'] = 100
+    
+By default, the number of comments per page is 50.

data/HELP_designer.markdown

@@ -0,0 +1,36 @@
+## Spam-blocking Questions
+
+By default you'll have a Snippet called 'comment\_spam\_block' which will provide a way to
+ask your site commenters a simple question.
+
+        <r:random>
+      <r:error on="spam_answer"><p style="color:red">Answer <r:message /></p></r:error>
+      <r:option>
+        <p><label for="comment_spam_answer">What day of the week has the letter "h" in it's name?</label> (required)<br />
+        <r:spam_answer_tag answer="Thursday" /></p>
+      </r:option>
+      <r:option>
+        <p><label for="comment_spam_answer">Yellow and blue together make what color?</label> (required)<br />
+        <r:spam_answer_tag answer="green" /></p>
+      </r:option>
+      <r:option>
+        <p><label for="comment_spam_answer">What is SPAM spelled backwards?</label> (required)<br />
+        <r:spam_answer_tag answer="MAPS" /></p>
+      </r:option>
+    </r:random> 
+    
+The snippet takes advantage of the built-in Radius tags `r:random` and `r:option` to provide a random 
+and less predictable selection of questions for commenters.
+
+Be sure to alter this snippet for your site!
+
+## Displaying comments and the comment form
+
+In your site layout (or another appropriate place) use the following code to display your comment form:
+
+    <r:snippet name="comments" />
+    
+### After comments are posted...
+
+Relative urls will *not* work on comment pages if they fail validation, since the page gets re-rendered
+at a (probably) different level of the hierarchy. Always use absolute urls and you won't have any issues.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Ryan Heneise
+  
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= Radiant Comments Extension
+
+Adds blog-like comment functionality to Radiant. Currently maintained by http://github.com/saturnflyer
+
+== Patches
+
+If you want to contribute features or fixes please write your specs and code and submit pull requests to these github.com users:
+
+- saturnflyer
+- artofmission
+
+== Dependencies
+
+* Requires Radiant 0.7.1 or greater.
+* Requires will_paginate Rails plugin (http://github.com/mislav/will_paginate/tree/master)
+* Requires fastercsv 1.2.3 or greater.
+* Requires sanitize 1.0.8 or greater.
+
+== Installation 
+
+To install Comments, run: 
+
+  rake radiant:extensions:comments:install
+
+This _WILL_ delete any snippets named 'comment', 'comments' and 'comment_form' if these exist.
+
+== More Help
+
+See the included HELP docs here or read them in your Radiant interface with the Help extension installed.
+
+== Contributors
+
+* John Muhl
+* Sven Schwyn
+* Gerrit Kaiser
+* Stephen Lombardo
+* Benny Degezelle
+* Frank Louwers (thanks to Jan De Poorter for the Mollom ruby lib)
+* Jim Gay of http://www.saturnflyer.com, sponsored by http://ignitesocialmedia.com/.
+* Michael Hale of http://halethegeek.com/, sponsored by http://ignitesocialmedia.com/.
+* Nathaniel Talbott of http://terralien.com/, sponsored by http://ignitesocialmedia.com/.
+* John Croisant
+* Jon Leighton
+* Witter Cheng
+* Keith Bingman
+* Sean Cribbs, partly sponsored by http://opscode.com/
+* Ryan Heneise
+
+If you contribute, go ahead and add your name to the list! 
+
+== Credits
+
+Included icons come from the FamFamFam Silk icon set.  http://famfamfam.com

data/Rakefile

@@ -0,0 +1,133 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-comments-extension"
+    gem.summary = %Q{Comments Extension for Radiant CMS}
+    gem.description = %Q{Adds blog-like comment functionality to Radiant.}
+    gem.email = "jim@saturnflyer.com"
+    gem.homepage = "http://github.com/saturnflyer/radiant-comments-extension"
+    gem.authors = ['Jim Gay', 'Ryan Heneise', 'Sean Cribbs','John Muhl', 'Sven Schwyn', 'Gerrit Kaiser', 'Stephen Lombardo', 'Benny Degezelle', 'Frank Louwers', 'Michael Hale', 'Nathaniel Talbott', 'John Croisant', 'Jon Leighton', 'Witter Cheng', 'Keith Bingman']
+    gem.add_development_dependency "radiant"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package dashboard as a gem."
+end
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the comments extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CommentsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the comments extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/TODO

@@ -0,0 +1,6 @@
+= TODO: 
+
+* Write better specs.
+* Move tests to specs.
+* Add user notification message when a comment is posted.
+* captcha mollom implementation

data/VERSION

@@ -0,0 +1 @@
+0.0.6

data/app/controllers/admin/comments_controller.rb

@@ -0,0 +1,130 @@
+class Admin::CommentsController < ApplicationController
+
+  def index
+    @comments = load_comments
+    respond_to do |format|
+      format.html
+      format.csv { send_data @comments.to_csv, :filename => "#{File.basename(request.request_uri)}", :type => 'text/csv' }
+    end
+  end
+
+  def destroy
+    @comment = Comment.find(params[:id])
+    @comment.destroy
+    announce_comment_removed
+    clear_single_page_cache(@comment)
+    redirect_to :back
+  rescue ActiveRecord::RecordNotFound
+    redirect_to admin_comments_path
+  end
+
+  def destroy_unapproved
+    if Comment.unapproved.destroy_all
+      flash[:notice] = "You have removed all unapproved comments."
+    else
+      flash[:notice] = "I was unable to remove all unapproved comments."
+    end
+    redirect_to :back
+  end
+
+  def edit
+    @comment = Comment.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    redirect_to admin_comments_path
+  end
+
+  def show
+    redirect_to edit_admin_comment_path(params[:id])
+  end
+
+  def update
+    @comment = Comment.find(params[:id])
+    begin
+      TextFilter.descendants.each do |filter|
+        @comment.content_html = filter.filter(@comment.content) if filter.filter_name == @comment.filter_id
+      end
+      @comment.update_attributes!(params[:comment])
+      clear_cache
+      flash[:notice] = "Comment Saved"
+      redirect_to :action => :index
+    rescue Exception => e
+      flash[:notice] = "There was an error saving the comment: #{e.message}"
+      render :action => :edit
+    end
+  end
+
+  def enable
+    @page = Page.find(params[:page_id])
+    @page.enable_comments = true
+    @page.save!
+    clear_cache
+    flash[:notice] = "Comments have been enabled for #{@page.title}"
+    redirect_to admin_pages_url
+  end
+
+  def approve
+    @comment = Comment.find(params[:id])
+    begin
+      @comment.approve!
+    rescue Comment::AntispamWarning => e
+      antispamnotice = "The antispam engine gave a warning: #{e}<br />"
+    end
+    clear_single_page_cache(@comment)
+    flash[:notice] = "Comment was successfully approved on page #{@comment.page.title}" + (antispamnotice ? " (#{antispamnotice})" : "")
+    redirect_to :back
+  end
+
+  def unapprove
+    @comment = Comment.find(params[:id])
+    begin
+      @comment.unapprove!
+    rescue Comment::AntispamWarning => e
+      antispamnotice = "The antispam engine gave a warning: #{e}"
+    end
+    clear_single_page_cache(@comment)
+    flash[:notice] = "Comment was successfully unapproved on page #{@comment.page.title}" + (antispamnotice ? " (#{antispamnotice})" : "" )
+    redirect_to :back
+  end
+
+
+  protected
+
+  def load_comments
+    status_scope.paginate(:page => params[:page])
+  end
+
+  def status_scope
+    case params[:status]
+    when 'approved'
+      base_scope.approved
+    when 'unapproved'
+      base_scope.unapproved
+    else
+      base_scope
+    end
+  end
+
+  def base_scope
+    @page = Page.find(params[:page_id]) if params[:page_id]
+    @page ? @page.comments : Comment.recent
+  end
+
+  def announce_comment_removed
+    flash[:notice] = "The comment was successfully removed from the site."
+  end
+
+  def clear_cache
+    if defined?(ResponseCache)
+      ResponseCache.instance.clear
+    else
+      Radiant::Cache.clear
+    end
+  end
+
+  def clear_single_page_cache(comment)
+    if comment && comment.page
+      clear_cache
+    end
+  end
+
+end