governor_comments 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,21 @@
+source 'http://rubygems.org'
+
+gem 'rails', '~> 3.0.5'
+
+gem 'governor', '>= 0.2.0'
+
+group :development, :test do
+  gem 'jeweler', '~> 1.5.2'
+  gem 'sqlite3'
+  gem 'rspec-rails'
+  gem 'mocha'
+  gem 'factory_girl', '~> 2.0.0.beta'
+  gem 'factory_girl_rails', '~> 1.1.beta'
+  gem 'activerecord-nulldb-adapter'
+  
+  gem 'governor_comments', :path => './'
+  
+  gem 'devise'
+  gem 'dynamic_form'
+  gem 'rakismet'
+end

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: ./
+  specs:
+    governor_comments (0.0.0)
+      rails (~> 3.0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activerecord-nulldb-adapter (0.2.1)
+      activerecord (>= 2.0.0, < 3.1)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    bcrypt-ruby (2.1.4)
+    builder (2.1.2)
+    devise (1.1.7)
+      bcrypt-ruby (~> 2.1.2)
+      warden (~> 1.0.2)
+    diff-lcs (1.1.2)
+    dynamic_form (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (2.0.0.beta2)
+    factory_girl_rails (1.1.beta1)
+      factory_girl (~> 2.0.0.beta)
+      rails (>= 3.0.0)
+    git (1.2.5)
+    governor (0.2.0)
+      rails (~> 3.0.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.12)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rakismet (1.0.1)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.5.0)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    warden (1.0.3)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-nulldb-adapter
+  devise
+  dynamic_form
+  factory_girl (~> 2.0.0.beta)
+  factory_girl_rails (~> 1.1.beta)
+  governor (>= 0.2.0)
+  governor_comments!
+  jeweler (~> 1.5.2)
+  mocha
+  rails (~> 3.0.5)
+  rakismet
+  rspec-rails
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Liam Morley
+
+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.markdown

@@ -0,0 +1,59 @@
+governor_comments
+=================
+
+**[Governor](http://carpeliam.github.com/governor/)** (named after Rod
+Blagojevich) is the pluggable blogging platform for Rails, built for people
+who want to build their blog into their website, not build their website into
+their blog.
+
+**governor_comments** is a plugin for Governor, allowing users and guests to
+comment on your blog.
+
+Dependencies
+------------
+
+* Governor, version 0.2.0 or higher. In addition, it requires that your User
+  class (or whatever classes can be associated with an article) have `name`,
+  `email`, and `website` fields.
+* ActiveRecord
+* Optional: [Rakismet](https://github.com/joshfrench/rakismet/) to integrate
+  Akismet spam filtering.
+
+Setting Up
+----------
+
+First, install [Governor](http://carpeliam.github.com/governor/). Then, in
+your Gemfile, add the following:
+
+    gem 'governor_comments'
+
+Once you've installed the gem into your app, you need to run the generator:
+
+    rails generate governor:create_comments
+
+This will create a Comment class and associated migration. Make sure to add
+the `name`, `email`, and `website` fields to your User model if they don't
+exist already.
+
+Usage
+-----
+
+Now, when you browse to an article, you'll see places to add comments right in
+the page. You really don't have to do anything special at this point.
+
+Contributing to governor_comments
+---------------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright © 2011 Liam Morley. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "governor_comments"
+  gem.homepage = "http://carpeliam.github.com/governor"
+  gem.license = "MIT"
+  gem.summary = %Q{Comments plugin for the Rails 3-based Governor blogging system.}
+  gem.description = %Q{Comments plugin for the Rails 3-based Governor blogging system.}
+  gem.email = "liam@carpeliam.com"
+  gem.authors = ["Liam Morley"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "governor_comments #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/governor/comments_controller.rb

@@ -0,0 +1,93 @@
+module Governor
+  class CommentsController < ApplicationController
+    include Governor::Controllers::Helpers
+    
+    before_filter :init_resource
+    before_filter :authorize_commenter!, :except => [:new, :create]
+    before_filter :get_comment, :only => [:edit, :update, :destroy, :mark_spam, :not_spam]
+    
+    helper :governor
+    helper Governor::Controllers::Helpers
+    
+    def create
+      params[:comment][:commenter] = governor_logged_in? ? the_governor : Guest.new(params[:commenter])
+    
+      @comment = resource.comments.new(params[:comment])
+    
+      respond_to do |format|
+        if @comment.save
+          @comment.update_attribute(:hidden, true) if @comment.respond_to?(:spam) and @comment.spam?
+          flash[:notice] = 'Your comment was successfully added.'
+          format.html { redirect_to resource }
+          format.xml  { render :xml => @comment, :status => :created, :location => @comment }
+        else
+          flash[:error] = 'There was a problem with your submission.'
+          format.html { render :action => "new" }
+          format.xml  { render :xml => @comment.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+  
+    def edit
+    end
+  
+    def update
+      respond_to do |format|
+        if @comment.update_attributes(params[:comment])
+          flash[:notice] = 'Comment was successfully updated.'
+          format.html { redirect_to resource }
+          format.xml  { head :ok }
+        else
+          format.html { render :action => "edit" }
+          format.xml  { render :xml => @comment.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+  
+    def destroy
+      @comment.destroy
+    
+      flash[:notice] = 'Comment successfully deleted.'
+
+      respond_to do |format|
+        format.html { redirect_to resource }
+        format.xml  { head :ok }
+      end
+    end
+  
+    def mark_spam
+      @comment.update_attribute(:hidden, true)
+      if @comment.respond_to?(:spam!)
+        @comment.spam!
+        flash[:notice] = 'That comment has been marked as spam, and will no longer be visible to other viewers. To remove it completely, you can delete it.'
+      else
+        flash[:warning] = 'Spam protection has not been installed. Please install and configure rakismet before continuing.'
+      end
+      redirect_to resource
+    end
+  
+    def not_spam
+      @comment.update_attribute(:hidden, false)
+      if @comment.respond_to?(:ham!)
+        @comment.ham!
+        flash[:notice] = 'That comment has been marked as not spam, and will now be visible to other viewers.'
+      else
+        flash[:warning] = 'Spam protection has not been installed. Please install and configure rakismet before continuing.'
+      end
+      redirect_to resource
+    end
+    
+    def get_comment
+      @comment = resource.comments.find(params[:id])
+    end
+    
+    private
+    def authorize_commenter!
+      if %(edit update destroy).include? action_name
+        authorize_governor!
+      else
+        redirect_to root_path unless governor_authorized?(:edit, resource)
+      end
+    end
+  end
+end

data/app/helpers/governor_comments_helper.rb

@@ -0,0 +1,7 @@
+module GovernorCommentsHelper
+  def comment_count(article)
+    governor_authorized?(:edit, article) ?
+      article.comments.size :
+      article.comments.select{|comment| !comment.hidden? }.size
+  end
+end

data/app/views/governor/articles/_comment_link.html.erb

@@ -0,0 +1,2 @@
+[ <%= link_to pluralize(comment_count(article), 'comment'), polymorphic_path(article, :anchor => 'comments') %> |
+<%= link_to 'add a comment', polymorphic_path(article, :anchor => 'comments') %> ]

data/app/views/governor/articles/_comments.html.erb

@@ -0,0 +1,17 @@
+<div id="comments">
+    <p><%= link_to 'add a comment', '#new_comment' %></p>
+    <% unless resource.comments.empty? %><ul><%= render resource.comments %></ul><% end %>
+    <p><%= form_for [resource, resource.comments.new] do |f| %>
+      <%= f.error_messages %>
+      <% unless governor_logged_in? %>
+        <%= fields_for :commenter, Guest.new do |gf| %>
+          <%= gf.text_field :name %> <%= gf.label :name, 'Name (required)' %><br/>
+          <%= gf.text_field :email %> <%= gf.label :email, 'E-Mail (required, will not be published)' %><br/>
+          <%= gf.text_field :website %> <%= gf.label :website %><br/>
+        <% end %>
+      <% end %>
+    <%= f.text_field :title %> <%= f.label :title %><br/>
+    <%= f.text_area :content, :size => '50x7' %>
+    <p><%= f.submit 'New Comment' %></p>
+    <% end %></p>
+</div>

data/app/views/governor/comments/_comment.html.erb

@@ -0,0 +1,27 @@
+<% if !comment.hidden? or governor_authorized?(:edit, resource) %>
+    <%= content_tag_for(:li, comment, :class => cycle('odd', 'even')) do %>
+        <% unless comment.title.blank? %><div class="comment_title"><%= comment.title %></div><% end %>
+        <div class='comment_gravatar'>
+            <%= image_tag comment.gravatar_url, :size => '48x48', :alt => comment.commenter.name %>
+        </div>
+        <div class='comment_body'>
+            <%= comment.content %>
+            <div class='comment_footer'>
+                posted <%= show_time_ago comment.updated_at %> by
+                <%= link_to_if comment.commenter.website.present?, comment.commenter.name, comment.commenter.website %>
+            </div>
+        </div>
+        <% if comment.respond_to?(:spam?) and governor_authorized?(:edit, resource) %>
+            <div class="spam_check">
+              <% if comment.hidden? %>
+                <span class="spam_warning">This comment has been marked as spam.</span>
+                <%= link_to 'Not spam?', polymorphic_path([resource, comment], :action => :not_spam), :method => :put, :class => 'not_spam' %>
+                <%= link_to 'Delete', [resource, comment], :method => :delete, :confirm => 'Are you sure you want to remove this comment?', :class => 'delete' %>
+              <% else %>
+                <%= link_to 'Mark as spam', polymorphic_path([resource, comment], :action => :mark_spam), :method => :put, :class => 'mark_spam', :confirm => 'Are you sure this is spam?' %>
+                <%= link_to 'Delete', [resource, comment], :method => :delete, :confirm => 'Are you sure you want to remove this comment? It has not been marked as spam.', :class => 'delete' %>
+              <% end %>
+            </div>
+        <% end %>
+    <% end %>
+<% end %>