rails_blog_engine 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,12 @@
+/Gemfile.lock
+/.bundle/
+/.sass-cache/
+/log/*.log
+/pkg/
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*.log
+/spec/dummy/tmp/
+/spec/dummy/.sass-cache/
+/spec/tmp/
+/.env
+/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,24 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in rails_blog_engine.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+group :development do
+  # We need a version which doesn't create objects in separate threads,
+  # cache them, or do anything else that breaks database-cleaning
+  # transactions in Steak.
+  gem 'machinist', :git => 'https://github.com/notahat/machinist.git'
+
+  # This is an optional runtime depedency.
+  gem 'pygments', :git => 'https://github.com/nathany/pygments-gem.git'
+end

data/Guardfile

@@ -0,0 +1,21 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|builder)$})          { |m| ["spec/controllers/#{m[1]}_controller_spec.rb", "spec/requests/#{m[1]}_spec.rb"] }
+end
+

data/Procfile

@@ -0,0 +1 @@
+web: bundle exec rails server -p $PORT

data/TODO.txt

@@ -0,0 +1,31 @@
+Before public release
+
+/ Spam filtering for comments: rakismet
+/   Moderation by administrators
+/ Secure comment fields using attr_accessible
+/ Secure HTML in comments
+X Table changes - Not going to collapse migrations, so there's no rush.
+X   Comment author_id polymorphic
+X   Comment state index
+X   Collapse migrations into 1 giant migration
+/ Quick refactoring pass
+, Integrate into Kidd Software site
+
+Needed for 3rd-party use
+
+  Generators
+    rails_blog_engine:templates
+    rails_blog_engine:filter
+  Config class?  Either implement or remove initializer
+
+Needed for use as a product or company blog
+
+  Caching
+  Editor polish
+    Auto-save
+    Publish / Unpublish button
+, SEO best practices
+
+Needed for 1.0
+
+  Recent articles list

data/app/controllers/rails_blog_engine/comments_controller.rb

@@ -1,5 +1,5 @@
 module RailsBlogEngine
-  class CommentsController < ApplicationController
+  class CommentsController < RailsBlogEngine::ApplicationController
     before_filter :load_post
 
     load_and_authorize_resource :class => "RailsBlogEngine::Comment"

data/app/controllers/rails_blog_engine/posts_controller.rb

@@ -1,5 +1,5 @@
 module RailsBlogEngine
-  class PostsController < ApplicationController
+  class PostsController < RailsBlogEngine::ApplicationController
     before_filter :load_recently_published, :only => :index
     before_filter :load_by_permalink, :only => :show
 

data/lib/rails_blog_engine.rb

@@ -15,4 +15,6 @@ require "rails_blog_engine/ability"
 require "rails_blog_engine/filters"
 
 module RailsBlogEngine
+  class Railtie < ::Rails::Railtie
+  end
 end

data/lib/rails_blog_engine/version.rb

@@ -1,3 +1,3 @@
 module RailsBlogEngine
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/rails_blog_engine.gemspec

@@ -0,0 +1,64 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "rails_blog_engine/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "rails_blog_engine"
+  s.version     = RailsBlogEngine::VERSION
+  s.authors     = ["Eric Kidd"]
+  s.email       = ["eric@kiddsoftware.com"]
+  s.homepage    = "http://github.com/kiddsoftware/rails_blog_engine"
+  s.summary     = "Rails 3.1 drop-in blog engine"
+  s.description = "Rails 3.1 drop-in blog engine for existing Rails applications"
+
+  s.files         = `git ls-files`.split("\n").sort
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Rails 3.1.
+  s.add_dependency "rails", "~> 3.1.0"
+
+  # Asset pipeline.  We use all the standard gems plus HAML.
+  s.add_dependency "jquery-rails", "~> 1.0"
+  s.add_dependency "sass-rails", "~> 3.1"
+  s.add_dependency "coffee-script", "~> 2.2"
+  s.add_dependency "haml", "~> 3.1"
+
+  # Pagination.
+  s.add_dependency "kaminari", "~> 0.12.4"
+
+  # User accounts and authentication.
+  s.add_dependency "cancan", "~> 1.6"
+
+  # Spam filtering.
+  s.add_dependency "rakismet", "~> 1.1"
+
+  # Other useful libraries.
+  s.add_dependency "simple_form", "~> 1.4"
+  s.add_dependency "state_machine", "~> 1.0.0"
+  s.add_dependency "rdiscount", "~> 1.6"
+  s.add_dependency "sanitize", "~> 2.0"
+
+  # Development-only gems.
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "devise"
+  s.add_development_dependency "steak"
+  s.add_development_dependency "foreman"
+  s.add_development_dependency "capybara-webkit", "~> 0.6.1"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "shoulda-matchers"
+  s.add_development_dependency "generator_spec"
+  s.add_development_dependency "vcr", ">= 2.0.0.beta2"
+  s.add_development_dependency "fakeweb"
+  #s.add_development_dependency "machinist" (see Gemfile)
+  #s.add_development_dependency "pygments" (see Gemfile)
+
+  # Auto-running our unit tests when things change.
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rb-inotify"
+  s.add_development_dependency "libnotify"
+  s.add_development_dependency "launchy"
+end

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#!/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.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/spec/acceptance/acceptance_helper.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+# Put your acceptance spec helpers inside spec/acceptance/support
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/acceptance/rails_blog_engine/posts_admin_spec.rb

@@ -0,0 +1,33 @@
+require 'acceptance/acceptance_helper'
+
+feature 'Posts admin', %q{
+  In order to publish information to the world
+  As a manager of the blog
+  I want to publish and manage posts
+} do
+
+  background do
+    sign_in_as_admin
+  end
+
+  scenario 'Adding and editing new post', :js => true do
+    visit '/blog'
+
+    click_link "New Post"
+    fill_in 'Title', :with => 'Test Post'
+    fill_in 'Permalink', :with => 'test-post'
+    fill_in 'Body', :with => 'My post <img src="a.png">'
+    click_button 'Create Post'
+    page.should have_content("Test Post")
+    page.should have_content("by sue")
+    page.should have_content("My post")
+    page.should have_selector(:xpath, '//img[@src="a.png"]')
+
+    click_link "Edit"
+    fill_in 'Title', :with => 'New Title'
+    fill_in 'Body', :with => 'New Body'
+    click_button "Update Post"
+    page.should have_content('New Title')
+    page.should have_content('New Body')
+  end
+end

data/spec/acceptance/rails_blog_engine/posts_spec.rb

@@ -0,0 +1,74 @@
+require 'acceptance/acceptance_helper'
+
+feature 'Posts', %q{
+  In order to learn intesting new things
+  As a site visitor
+  I want to read blog articles
+} do
+
+  background do
+    published_at = Time.utc(2011, 01, 02, 03)
+    RailsBlogEngine::Post.make!(:title => "Test Post", :body => "_Body_ ",
+                                :state => 'published',
+                                :published_at => published_at,
+                                :permalink => 'test')
+  end
+
+  scenario 'Viewing the index' do
+    visit '/blog'
+    page.should have_content("Test Post")
+    within('em') { page.should have_content("Body") }
+    page.should_not have_content("New Post")
+  end
+
+  scenario 'Navigating to a post' do
+    visit '/blog'
+    click_on "Test Post"
+    page.should have_content("Test Post")
+    page.should_not have_content("New Post")
+    within('em') { page.should have_content("Body") }
+    page.should_not have_content("Edit Post")
+  end
+
+  scenario 'Linking to a post directly' do
+    visit '/blog/2011/01/02/test'
+    page.should have_content("Test Post")
+  end
+
+  scenario 'Looking for posts on page 2' do
+    # Force our original post off the front page.
+    5.times { RailsBlogEngine::Post.make!(:published) }
+
+    visit '/blog'
+    page.should_not have_content("Test Post")
+    click_on "Next"
+    page.should have_content("Test Post")
+    current_path.should == '/blog/page/2'
+  end
+
+  scenario 'Adding a comment' do
+    visit '/blog'
+    click_on 'Comment'
+    fill_in "Your name", :with => "Jane Doe"
+    fill_in "Comment", :with => "Test comment"
+    click_on "Post Comment"
+    page.should have_content("Jane Doe")
+    page.should have_content("Test comment")
+
+    # Change comment link text.
+    visit '/blog'
+    click_on "1 comment"
+    page.should have_content("Jane Doe")
+  end
+
+  scenario 'Validating a comment' do
+    visit '/blog'
+    click_on 'Comment'
+    click_on 'Post Comment'
+    page.should have_content("can't be blank")
+    fill_in "Your name", :with => "Jane Doe"
+    fill_in "Comment", :with => "Test comment"
+    click_on "Post Comment"
+    page.should have_content("Jane Doe")
+  end
+end

data/spec/acceptance/rails_blog_engine/spam_filtering_spec.rb

@@ -0,0 +1,110 @@
+require 'acceptance/acceptance_helper'
+
+feature 'Spam filtering', %q{
+  In order to keep my site free of spam
+  As a manager of the blog
+  I want to identify spam posts and hide them automatically
+} do
+
+  background do
+    @post = RailsBlogEngine::Post.make!(:published, :title => "Example post")
+    visit '/blog'
+    click_on "Example post"
+  end
+
+  def enable_spam_filter
+    Rakismet.key = "fakekey"
+    Rakismet.url = "http://www.example.com/"
+  end
+
+  def disable_spam_filter
+    Rakismet.key = nil
+    Rakismet.url = nil
+  end
+
+  def post_ham_comment
+    fill_in "Your name", :with => "Jane Doe"
+    fill_in "Comment", :with => "An interesting and legitimate post."
+    click_on "Post Comment"
+  end
+
+  def post_spam_comment
+    fill_in "Your name", :with => "viagra-test-123"
+    fill_in "Comment", :with => "Buy toner cartridges today!"
+    click_on "Post Comment"
+  end
+
+  def last_comment
+    @last_comment ||= RailsBlogEngine::Comment.last
+  end
+
+  scenario 'Posting a real comment' do
+    enable_spam_filter
+    VCR.use_cassette('rakismet-ham') { post_ham_comment }
+    last_comment.should be_filtered_as_ham
+    page.should have_content(last_comment.body)
+    page.should_not have_content("moderation")
+  end
+
+  scenario 'Posting a spam comment' do
+    enable_spam_filter
+    VCR.use_cassette('rakismet-spam') { post_spam_comment }
+    last_comment.should be_filtered_as_spam
+    page.should_not have_content(last_comment.body)
+    page.should have_content("moderation")
+  end
+
+  scenario 'Posting a comment without configuring the spam filter' do
+    disable_spam_filter
+    post_spam_comment
+    last_comment.should be_unfiltered
+  end
+
+  # Wait for the comment to have the specified state.  This forces us to
+  # synchronize the current thread with the background thread the runs the
+  # webserver, which is helpful for ensuring that VCR cassettes will be
+  # left "in the VCR" until they've actually been used by the other thread.
+  def wait_for_comment_in_state(state)
+    Timeout.timeout(3) do
+      sleep 0.1 until RailsBlogEngine::Comment.where(:state => state.to_s).first
+    end
+  end
+
+  scenario 'Filtered as ham, mark as spam', :js => true do
+    enable_spam_filter
+    VCR.use_cassette('rakismet-ham', :match_requests_on => [:method]) do
+      post_spam_comment
+      wait_for_comment_in_state(:filtered_as_ham)
+    end
+    page.should have_content('viagra-test-123')
+    page.should have_selector('.ham')
+
+    sign_in_as_admin
+    VCR.use_cassette('rakismet-train-as-spam') do
+      click_on 'Spam'
+      wait_for_comment_in_state(:marked_as_spam)
+    end
+    page.should have_content('viagra-test-123')
+    page.should have_selector('.spam')
+  end
+
+  scenario 'Filtered as spam, mark as ham', :js => true do
+    enable_spam_filter
+    VCR.use_cassette('rakismet-spam', :match_requests_on => [:method]) do
+      post_ham_comment
+      wait_for_comment_in_state(:filtered_as_spam)
+    end
+    page.should_not have_content('Jane Doe')
+
+    sign_in_as_admin
+    page.should have_content('Jane Doe')
+    page.should have_selector('.spam')
+
+    VCR.use_cassette('rakismet-train-as-ham') do
+      click_on 'Not Spam'
+      wait_for_comment_in_state(:marked_as_ham)
+    end
+    page.should have_content('Jane Doe')
+    page.should have_selector('.ham')
+  end
+end

data/spec/acceptance/support/helpers.rb

@@ -0,0 +1,18 @@
+module RailsBlogEngine::AcceptanceHelperMethods
+  # Put helper methods you need to be available in all acceptance specs here.
+
+  # In our test application, any user counts as an administrator.
+  def sign_in_as_admin
+    saved_path = current_path
+    visit '/users/sign_up'
+    fill_in 'Email', :with => "sue@example.com"
+    fill_in 'Password', :with => "password"
+    fill_in 'Password confirmation', :with => "password"
+    click_button 'Sign up'
+    visit saved_path
+  end
+end
+
+RSpec.configuration.include(RailsBlogEngine::AcceptanceHelperMethods,
+                            :example_group =>
+                              { :file_path => /spec\/acceptance/ })