governor_comments 0.1.0

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

@@ -0,0 +1,7 @@
+<div id="blog">
+    <div class="articles">
+       <%= render resource %>
+    </div>
+    <%= render_plugin_partial('after_article_on_article_page', :locals => {:article => resource}) %>
+</div>
+<%= link_to 'Back', polymorphic_path(mapping.plural) %>

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"
+  unauthorized_edit: "You're not allowed to edit this %{resource_type}."

data/governor_comments.gemspec

@@ -0,0 +1,196 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{governor_comments}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Liam Morley"]
+  s.date = %q{2011-04-10}
+  s.description = %q{Comments plugin for the Rails 3-based Governor blogging system.}
+  s.email = %q{liam@carpeliam.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/governor/comments_controller.rb",
+    "app/helpers/governor_comments_helper.rb",
+    "app/views/governor/articles/_comment_link.html.erb",
+    "app/views/governor/articles/_comments.html.erb",
+    "app/views/governor/comments/_comment.html.erb",
+    "app/views/governor/comments/new.html.erb",
+    "config/locales/en.yml",
+    "governor_comments.gemspec",
+    "lib/generators/governor/create_comments_generator.rb",
+    "lib/generators/governor/templates/migrations/create_comments.rb",
+    "lib/generators/governor/templates/models/comment.rb",
+    "lib/generators/governor/templates/models/guest.rb",
+    "lib/governor_comments.rb",
+    "lib/governor_comments/comment.rb",
+    "lib/governor_comments/rails.rb",
+    "log/development.log",
+    "script/rails",
+    "spec/controllers/governor/comments_controller_spec.rb",
+    "spec/governor_comments_spec.rb",
+    "spec/rails_app/.gitignore",
+    "spec/rails_app/Gemfile",
+    "spec/rails_app/Gemfile.lock",
+    "spec/rails_app/README",
+    "spec/rails_app/Rakefile",
+    "spec/rails_app/app/controllers/application_controller.rb",
+    "spec/rails_app/app/controllers/home_controller.rb",
+    "spec/rails_app/app/helpers/application_helper.rb",
+    "spec/rails_app/app/helpers/home_helper.rb",
+    "spec/rails_app/app/models/article.rb",
+    "spec/rails_app/app/models/comment.rb",
+    "spec/rails_app/app/models/guest.rb",
+    "spec/rails_app/app/models/user.rb",
+    "spec/rails_app/app/views/home/index.html.erb",
+    "spec/rails_app/app/views/layouts/application.html.erb",
+    "spec/rails_app/config.ru",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/database.yml",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/devise.rb",
+    "spec/rails_app/config/initializers/governor.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/mime_types.rb",
+    "spec/rails_app/config/initializers/rakismet.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/initializers/session_store.rb",
+    "spec/rails_app/config/locales/devise.en.yml",
+    "spec/rails_app/config/locales/en.yml",
+    "spec/rails_app/config/routes.rb",
+    "spec/rails_app/db/migrate/20110329032256_devise_create_users.rb",
+    "spec/rails_app/db/migrate/20110330020108_governor_create_articles.rb",
+    "spec/rails_app/db/migrate/20110405030324_governor_create_comments.rb",
+    "spec/rails_app/db/schema.rb",
+    "spec/rails_app/db/seeds.rb",
+    "spec/rails_app/lib/tasks/.gitkeep",
+    "spec/rails_app/public/404.html",
+    "spec/rails_app/public/422.html",
+    "spec/rails_app/public/500.html",
+    "spec/rails_app/public/favicon.ico",
+    "spec/rails_app/public/images/rails.png",
+    "spec/rails_app/public/javascripts/application.js",
+    "spec/rails_app/public/javascripts/controls.js",
+    "spec/rails_app/public/javascripts/dragdrop.js",
+    "spec/rails_app/public/javascripts/effects.js",
+    "spec/rails_app/public/javascripts/prototype.js",
+    "spec/rails_app/public/javascripts/rails.js",
+    "spec/rails_app/public/robots.txt",
+    "spec/rails_app/public/stylesheets/.gitkeep",
+    "spec/rails_app/script/rails",
+    "spec/rails_app/spec/factories.rb",
+    "spec/rails_app/vendor/plugins/.gitkeep",
+    "spec/spec_helper.rb",
+    "spec/views/governor/articles/show.html.erb_spec.rb"
+  ]
+  s.homepage = %q{http://carpeliam.github.com/governor}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Comments plugin for the Rails 3-based Governor blogging system.}
+  s.test_files = [
+    "spec/controllers/governor/comments_controller_spec.rb",
+    "spec/governor_comments_spec.rb",
+    "spec/rails_app/app/controllers/application_controller.rb",
+    "spec/rails_app/app/controllers/home_controller.rb",
+    "spec/rails_app/app/helpers/application_helper.rb",
+    "spec/rails_app/app/helpers/home_helper.rb",
+    "spec/rails_app/app/models/article.rb",
+    "spec/rails_app/app/models/comment.rb",
+    "spec/rails_app/app/models/guest.rb",
+    "spec/rails_app/app/models/user.rb",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/devise.rb",
+    "spec/rails_app/config/initializers/governor.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/mime_types.rb",
+    "spec/rails_app/config/initializers/rakismet.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/initializers/session_store.rb",
+    "spec/rails_app/config/routes.rb",
+    "spec/rails_app/db/migrate/20110329032256_devise_create_users.rb",
+    "spec/rails_app/db/migrate/20110330020108_governor_create_articles.rb",
+    "spec/rails_app/db/migrate/20110405030324_governor_create_comments.rb",
+    "spec/rails_app/db/schema.rb",
+    "spec/rails_app/db/seeds.rb",
+    "spec/rails_app/spec/factories.rb",
+    "spec/spec_helper.rb",
+    "spec/views/governor/articles/show.html.erb_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.5"])
+      s.add_runtime_dependency(%q<governor>, [">= 0.2.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, ["~> 2.0.0.beta"])
+      s.add_development_dependency(%q<factory_girl_rails>, ["~> 1.1.beta"])
+      s.add_development_dependency(%q<activerecord-nulldb-adapter>, [">= 0"])
+      s.add_development_dependency(%q<governor_comments>, [">= 0"])
+      s.add_development_dependency(%q<devise>, [">= 0"])
+      s.add_development_dependency(%q<dynamic_form>, [">= 0"])
+      s.add_development_dependency(%q<rakismet>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.0.5"])
+      s.add_dependency(%q<governor>, [">= 0.2.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, ["~> 2.0.0.beta"])
+      s.add_dependency(%q<factory_girl_rails>, ["~> 1.1.beta"])
+      s.add_dependency(%q<activerecord-nulldb-adapter>, [">= 0"])
+      s.add_dependency(%q<governor_comments>, [">= 0"])
+      s.add_dependency(%q<devise>, [">= 0"])
+      s.add_dependency(%q<dynamic_form>, [">= 0"])
+      s.add_dependency(%q<rakismet>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.0.5"])
+    s.add_dependency(%q<governor>, [">= 0.2.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, ["~> 2.0.0.beta"])
+    s.add_dependency(%q<factory_girl_rails>, ["~> 1.1.beta"])
+    s.add_dependency(%q<activerecord-nulldb-adapter>, [">= 0"])
+    s.add_dependency(%q<governor_comments>, [">= 0"])
+    s.add_dependency(%q<devise>, [">= 0"])
+    s.add_dependency(%q<dynamic_form>, [">= 0"])
+    s.add_dependency(%q<rakismet>, [">= 0"])
+  end
+end
+

data/lib/generators/governor/create_comments_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Governor
+  class CreateCommentsGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+  
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.new.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+    
+    def create_models
+      template 'models/comment.rb', "app/models/comment.rb"
+      template 'models/guest.rb', "app/models/guest.rb"
+    end
+  
+    def create_migration_file
+      migration_template 'migrations/create_comments.rb', "db/migrate/governor_create_comments.rb", :skip => true
+    end
+  end
+end

data/lib/generators/governor/templates/migrations/create_comments.rb

@@ -0,0 +1,23 @@
+class GovernorCreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.string      :title, :content
+      t.boolean     :hidden, :default => false
+      t.references  :commenter, :polymorphic => true
+      t.references  :<%= article %>
+      t.timestamps
+    end
+  
+    create_table :guests do |t|
+      t.string      :name
+      t.string      :email
+      t.string      :website
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comments
+    drop_table :guests
+  end
+end

data/lib/generators/governor/templates/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  include GovernorComments::Comment
+end

data/lib/generators/governor/templates/models/guest.rb

@@ -0,0 +1,14 @@
+class Guest < ActiveRecord::Base
+    
+  validates_presence_of     :name
+  validates_format_of       :name,     :with => /\A[^[:cntrl:]\\<>\/&]*\z/,  :message => 'avoid non-printing characters and \\&gt;&lt;&amp;/ please.'
+  validates_length_of       :name,     :maximum => 100
+
+  validates_presence_of     :email
+  validates_length_of       :email,    :within => 6..100 #r@a.wk
+  validates_format_of       :email,    :with => /\A[\w\.%\+\-]+@(?:[A-Z0-9\-]+\.)+(?:[A-Z]{2}|com|org|net|edu|gov|mil|biz|info|mobi|name|aero|jobs|museum)\z/i, :message => "should look like an email address."
+  
+  def website=(website)
+    self[:website] = (website.blank? or website.starts_with? 'http://') ? website : 'http://' + website
+  end
+end

data/lib/governor_comments.rb

@@ -0,0 +1,15 @@
+require 'governor_comments/comment'
+require 'governor_comments/rails'
+
+comments = Governor::Plugin.new('comments')
+comments.add_migration(File.join(File.dirname(__FILE__), 'templates', 'create_comments.rb'))
+comments.add_child_resource :comments do
+  member do
+    put 'mark_spam', 'not_spam'
+  end
+end
+comments.add_helper "GovernorCommentsHelper"
+comments.register_partial :after_article_whole, 'articles/comments'
+comments.register_partial :after_article_description, 'articles/comment_link'
+
+Governor::PluginManager.register comments

data/lib/governor_comments/comment.rb

@@ -0,0 +1,31 @@
+module GovernorComments
+  module Comment
+    require 'md5'
+    def self.included(base)
+      if Governor.resources.size == 1
+        base.belongs_to Governor.default_resource.singular
+      else
+        base.belongs_to :resource, :polymorphic => true
+      end
+      base.belongs_to :commenter, :polymorphic => true
+      if defined?(Rakismet)
+        base.send :include, Rakismet::Model
+        base.rakismet_attrs :author => proc { commenter.name },
+                            :author_email => proc { commenter.email },
+                            :author_url => proc { commenter.website },
+                            :comment_type => 'comment'
+      end
+      
+      base.validates_presence_of :content
+    end
+    
+    def gravatar_url(size = 48, default = "http://github.com/images/gravatars/gravatar-#{size}.png")
+      if commenter.respond_to? :email
+        hash = MD5::md5 commenter.email.downcase
+        "http://www.gravatar.com/avatar/#{hash}?s=#{size}&r=pg&d=#{CGI::escape(default)}"
+      else
+        default
+      end
+    end
+  end
+end

data/lib/governor_comments/rails.rb

@@ -0,0 +1,5 @@
+module GovernorComments
+  class Engine < ::Rails::Engine
+    
+  end
+end

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/controllers/governor/comments_controller_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Governor
+  describe CommentsController do
+    include Devise::TestHelpers
+    
+    before(:each) do
+      @user = Factory(:user)
+      @article = Factory(:article, :author => @user)
+      @comment = Factory(:comment, :article => @article, :commenter => @user)
+      sign_in @user
+    end
+    
+    context "#create" do
+      it "creates a new comment" do
+        post :create, :governor_mapping => :articles, :article_id => @article.id, :comment => {:content => "$$$"}
+        assigns[:comment].should_not be_a_new_record
+        assigns[:comment].commenter.should == @user
+        assigns[:article].should == @article
+      end
+    end
+    
+    context "#mark_spam" do
+      it "hides the comment" do
+        put :mark_spam, :governor_mapping => :articles, :article_id => @article.id, :id => @comment.id
+        assigns[:comment].should be_hidden
+      end
+    end
+    
+    context "#not_spam" do
+      before(:each) { @comment.update_attribute(:hidden, true) }
+      it "unhides the comment" do
+        put :not_spam, :governor_mapping => :articles, :article_id => @article.id, :id => @comment.id
+        assigns[:comment].should_not be_hidden
+      end
+    end
+  end
+end

data/spec/governor_comments_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module Governor
+  describe GovernorComments do
+    it "registers the plugin" do
+      Governor::PluginManager.plugins.size == 1
+    end
+  
+    it "registers one child resource" do
+      PluginManager.resources(:child_resources).size.should == 1
+      options = PluginManager.resources(:child_resources)[:comments]
+      options.keys.should == [:block]
+      options[:block].should be_a Proc
+    end
+  end
+end

data/spec/rails_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/spec/rails_app/Gemfile

@@ -0,0 +1,40 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.5'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+gem 'devise'
+gem 'rakismet'
+gem 'governor', '>= 0.2.0'
+gem 'governor_comments', :path => '../..'
+
+gem 'dynamic_form'
+
+gem 'will_paginate', '~> 3.0.beta'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end