rails_blog_engine 0.0.3 → 0.0.4

data/README.md

@@ -2,9 +2,8 @@
 
 **Pre-beta release.  Public APIs may change.**
 
-Add a blog to any Rails 3.1 site using `rails_blog_engine`.  If you're
-already using `cancan` for authorization, then add the following line to
-your `Gemfile`:
+Add a blog to any Rails 3.1 site using `rails_blog_engine`.  First, add the
+following line to your `Gemfile`:
 
     gem 'rails_blog_engine'
 
@@ -14,31 +13,26 @@ your `Gemfile`:
     rails generate rails_blog_engine:install
     rake db:migrate
 
-Then edit your `app/models/ability.rb` file to authorize reading and
-writing the blog.  For example:
-
-    class Ability
-      include CanCan::Ability
-      include RailsBlogEngine::Ability
-      
-      def initialize(user)
-        # Everybody can read the blog, even if they're not logged in.
-        can_read_blog
-        
-        # Test to see whether a user can manage the blog.  For example,
-        # if you identify administrators using an 'admin?' flag, you
-        # might write 'if user.admin?' instead.
-        if user
-          can_manage_blog
-        end
+Check the configuration in the newly-generated
+`config/initializers/rails_blog_engine.rb` and tweak as necessary.
+
+If you're using Devise, or another framework which defines `current_user`
+on `ActionController::Base`, then all you need to do is add a `blog_admin?`
+method to your user model:
+
+    class User
+      # ...other stuff here...
+    
+      # Return true if the user is allowed to post to the blog,
+      # moderate comments, etc.
+      def blog_admin?
+        # Your code here.
       end
     end
 
 You should now be able to access your blog at `http://0.0.0.0:3000/blog`
 and start posting!
 
-If you're not using CanCan, keep reading for setup instructions.
-
 ## Philosophy and planned features
 
 `rails_blog_engine` should...
@@ -64,54 +58,19 @@ The following features are on my wishlist:
 In other words, we want just enough features to make blogging pleasant, and
 nothing more.
 
-## What if I'm not already using CanCan?
-
-You can still use `rails_blog_engine`!  First, install `rails_blog_engine`
-as described above, and then add the following lines to your `Gemfile`:
-
-    gem 'devise'  # Optional.
-    gem 'cancan'
-
-You don't have to use `devise`—you can use `rails_blog_engine` with the
-authentication framework of your choice.  If you are using Devise, however,
-you will now need to generate a user class:
-
-    rails generate devise:install
-    rails generate devise User
-
-To prevent random members of the public from signing up for a user account,
-edit `app/models/user.rb` and remove `:registerable`.  To create a new user,
-you must now run the following command from the Rails console:
+## What if I'm don't have `ActionController::Base#current_user`?
 
-    User.create!(:email => "me@example.com", :password => "12345",
-                 :password_confirmation => "12345")
+Add something like the following to
+`config/initializers/rails_blog_engine.rb`:
 
-(Alternatively, you keep `:registerable` on your `User` model, and add a
-new field `admin?` which you set from the console.)
-
-Once you have a working user model, you can generate a new
-`app/models/ability.rb` file:
-
-    rails generate cancan:ability
-
-...and edit it as described above.
-
-### How can I make this work without a Devise `User` class?
-
-Basically, all CanCan cares about is whether your controller defines a
-`current_ability` class.  So for example, if you don't use Devise, but the
-currently logged-in administrator is available as `current_admin`, you can
-edit `app/controllers/application_controller.rb` to override
-`current_ability`:
-
-    class ApplicationController < ActionController::Base
-      # ...other stuff here...
-      
-      def current_ability
-        @current_ability ||= ::Ability.new(current_admin)
+    class RailsBlogEngine::ApplicationController
+      def current_user
+        # Check session, etc., here.
       end
     end
 
+Please open an issue if you have any questions or problems.
+
 ## Setting up titles and <head> tags
 
 To set up titles, add the two following `yield` lines to the `<head>` tag

data/TODO.txt

@@ -1,6 +1,7 @@
 Before public release
 
 , Integrate into Kidd Software site
+  Add blog. helper prefix to generated route
 
 Needed for 3rd-party use
 

data/app/controllers/rails_blog_engine/application_controller.rb

@@ -7,6 +7,17 @@ module RailsBlogEngine
 
     protected
 
+    # Construct a CanCan Ability object to control access to the blog.
+    def current_ability
+      method = Rails.configuration.rails_blog_engine.current_user_method
+      if respond_to?(method)
+        user = send(method)
+      else
+        raise "You must define #{method} on RailsBlogEngine::ApplicationController, as described in README.md"
+      end
+      RailsBlogEngine::Ability.new(user)
+    end
+
     # We normally use one of our parent application's layouts, so that we
     # "auto-blend" into the existing look-and-feel of the site.  The
     # specific layout is specified by our initializer.

data/app/models/rails_blog_engine/ability.rb

@@ -0,0 +1,36 @@
+module RailsBlogEngine
+  class Ability
+    include CanCan::Ability
+
+    def initialize(user)
+      can_read_blog
+      if user && blog_admin?(user)
+        can_manage_blog
+      end
+    end
+
+    protected
+
+    def blog_admin?(user)
+      method = Rails.configuration.rails_blog_engine.blog_admin_method
+      if user.respond_to?(method)
+        user.send(method)
+      else
+        raise "You must define #{method} on your user model, as described in README.md"
+      end
+    end
+
+    def can_read_blog
+      can :read, RailsBlogEngine::Post
+      can [:read, :create], RailsBlogEngine::Comment
+    end
+
+    def can_manage_blog
+      alias_action :mark_as_spam, :to => :update
+      alias_action :mark_as_ham, :to => :update
+
+      can :manage, RailsBlogEngine::Post
+      can :update, RailsBlogEngine::Comment
+    end
+  end
+end

data/lib/generators/rails_blog_engine/install/templates/rails_blog_engine.rb

@@ -1,5 +1,19 @@
 # Configure RailsBlogEngine here.
 
+# Retrieve the current user.  This is currently used together with
+# blog_admin_method to determine whether the user is an administrator.
+#
+# Note that this method will be called on controllers that subclass
+# RailsBlogEngine::ApplicationController, which means that methods
+# defined on your main ApplicationController are _not_ available.  This
+# doesn't present any challenges if you're using Devise, or another
+# library which defines current_user on ActionController::Base.
+#Rails.application.config.rails_blog_engine.current_user_method = :current_user
+
+# Does the current user have administrator privileges?  This will be called
+# on the values returned by current_user_method, above.
+#Rails.application.config.rails_blog_engine.blog_admin_method = :blog_admin?
+
 # Which application layout should we use to render the blog?
 #Rails.application.config.rails_blog_engine.layout = 'application'
 

data/lib/rails_blog_engine.rb

@@ -11,7 +11,6 @@ require "kaminari"
 require "rakismet"
 
 require "rails_blog_engine/engine"
-require "rails_blog_engine/ability"
 require "rails_blog_engine/filters"
 
 module RailsBlogEngine

data/lib/rails_blog_engine/engine.rb

@@ -5,6 +5,8 @@ module RailsBlogEngine
     # Define some initialization parameters and their default values.
     config.rails_blog_engine = ActiveSupport::OrderedOptions.new
     config.rails_blog_engine.layout = 'application'
+    config.rails_blog_engine.current_user_method = :current_user
+    config.rails_blog_engine.blog_admin_method = :blog_admin?
 
     config.to_prepare do
       ::ApplicationHelper.class_eval do

data/lib/rails_blog_engine/version.rb

@@ -1,3 +1,3 @@
 module RailsBlogEngine
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/dummy/app/models/user.rb

@@ -6,4 +6,10 @@ class User < ActiveRecord::Base
 
   # Setup accessible (or protected) attributes for your model
   attr_accessible :email, :password, :password_confirmation, :remember_me
+
+  # Is the current user a blog administrator?  Always true for this example
+  # application.
+  def blog_admin?
+    true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_blog_engine
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000Z
+date: 2012-01-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &18672980 !ruby/object:Gem::Requirement
+  requirement: &13187680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *18672980
+  version_requirements: *13187680
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &18672480 !ruby/object:Gem::Requirement
+  requirement: &13187180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *18672480
+  version_requirements: *13187180
 - !ruby/object:Gem::Dependency
   name: sass-rails
-  requirement: &18672020 !ruby/object:Gem::Requirement
+  requirement: &13186720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *18672020
+  version_requirements: *13186720
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &18671560 !ruby/object:Gem::Requirement
+  requirement: &13186260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *18671560
+  version_requirements: *13186260
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &18671100 !ruby/object:Gem::Requirement
+  requirement: &13185800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *18671100
+  version_requirements: *13185800
 - !ruby/object:Gem::Dependency
   name: kaminari
-  requirement: &18670640 !ruby/object:Gem::Requirement
+  requirement: &13185340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.12.4
   type: :runtime
   prerelease: false
-  version_requirements: *18670640
+  version_requirements: *13185340
 - !ruby/object:Gem::Dependency
   name: cancan
-  requirement: &18670180 !ruby/object:Gem::Requirement
+  requirement: &13217000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *18670180
+  version_requirements: *13217000
 - !ruby/object:Gem::Dependency
   name: rakismet
-  requirement: &18669720 !ruby/object:Gem::Requirement
+  requirement: &13216540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *18669720
+  version_requirements: *13216540
 - !ruby/object:Gem::Dependency
   name: simple_form
-  requirement: &18669260 !ruby/object:Gem::Requirement
+  requirement: &13216080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *18669260
+  version_requirements: *13216080
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &18668800 !ruby/object:Gem::Requirement
+  requirement: &13215620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *18668800
+  version_requirements: *13215620
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &18668340 !ruby/object:Gem::Requirement
+  requirement: &13215160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *18668340
+  version_requirements: *13215160
 - !ruby/object:Gem::Dependency
   name: sanitize
-  requirement: &18667880 !ruby/object:Gem::Requirement
+  requirement: &13214700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,10 +142,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *18667880
+  version_requirements: *13214700
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &18667500 !ruby/object:Gem::Requirement
+  requirement: &13214320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18667500
+  version_requirements: *13214320
 - !ruby/object:Gem::Dependency
   name: devise
-  requirement: &18667040 !ruby/object:Gem::Requirement
+  requirement: &13213860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18667040
+  version_requirements: *13213860
 - !ruby/object:Gem::Dependency
   name: steak
-  requirement: &18666620 !ruby/object:Gem::Requirement
+  requirement: &13213440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18666620
+  version_requirements: *13213440
 - !ruby/object:Gem::Dependency
   name: foreman
-  requirement: &18666200 !ruby/object:Gem::Requirement
+  requirement: &13213020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,10 +186,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18666200
+  version_requirements: *13213020
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
-  requirement: &18665700 !ruby/object:Gem::Requirement
+  requirement: &13212520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -197,10 +197,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *18665700
+  version_requirements: *13212520
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &18687340 !ruby/object:Gem::Requirement
+  requirement: &13212100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -208,10 +208,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18687340
+  version_requirements: *13212100
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
-  requirement: &18686880 !ruby/object:Gem::Requirement
+  requirement: &13211640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -219,10 +219,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18686880
+  version_requirements: *13211640
 - !ruby/object:Gem::Dependency
   name: generator_spec
-  requirement: &18686460 !ruby/object:Gem::Requirement
+  requirement: &13211220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -230,10 +230,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18686460
+  version_requirements: *13211220
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &18685960 !ruby/object:Gem::Requirement
+  requirement: &13210720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -241,10 +241,10 @@ dependencies:
         version: 2.0.0.beta2
   type: :development
   prerelease: false
-  version_requirements: *18685960
+  version_requirements: *13210720
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &18685540 !ruby/object:Gem::Requirement
+  requirement: &13210300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -252,10 +252,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18685540
+  version_requirements: *13210300
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &18685080 !ruby/object:Gem::Requirement
+  requirement: &13209840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -263,10 +263,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18685080
+  version_requirements: *13209840
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &18684660 !ruby/object:Gem::Requirement
+  requirement: &13209420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -274,10 +274,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18684660
+  version_requirements: *13209420
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &18684240 !ruby/object:Gem::Requirement
+  requirement: &13209000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -285,10 +285,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18684240
+  version_requirements: *13209000
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &18683820 !ruby/object:Gem::Requirement
+  requirement: &13231200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -296,7 +296,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18683820
+  version_requirements: *13231200
 description: Rails 3.1 drop-in blog engine for existing Rails applications
 email:
 - eric@kiddsoftware.com
@@ -326,6 +326,7 @@ files:
 - app/helpers/rails_blog_engine/application_helper.rb
 - app/helpers/rails_blog_engine/comments_helper.rb
 - app/helpers/rails_blog_engine/posts_helper.rb
+- app/models/rails_blog_engine/ability.rb
 - app/models/rails_blog_engine/comment.rb
 - app/models/rails_blog_engine/post.rb
 - app/views/layouts/rails_blog_engine/_blog_page.html.haml
@@ -362,7 +363,6 @@ files:
 - lib/generators/rails_blog_engine/install/install_generator.rb
 - lib/generators/rails_blog_engine/install/templates/rails_blog_engine.rb
 - lib/rails_blog_engine.rb
-- lib/rails_blog_engine/ability.rb
 - lib/rails_blog_engine/engine.rb
 - lib/rails_blog_engine/filters.rb
 - lib/rails_blog_engine/filters/base.rb
@@ -388,7 +388,6 @@ files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
-- spec/dummy/app/models/ability.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/views/home/index.html.haml
 - spec/dummy/app/views/layouts/application.html.erb

data/lib/rails_blog_engine/ability.rb

@@ -1,16 +0,0 @@
-module RailsBlogEngine
-  module Ability
-    def can_read_blog
-      can :read, RailsBlogEngine::Post
-      can [:read, :create], RailsBlogEngine::Comment
-    end
-
-    def can_manage_blog
-      alias_action :mark_as_spam, :to => :update
-      alias_action :mark_as_ham, :to => :update
-
-      can :manage, RailsBlogEngine::Post
-      can :update, RailsBlogEngine::Comment
-    end
-  end
-end

data/spec/dummy/app/models/ability.rb

@@ -1,11 +0,0 @@
-class Ability
-  include CanCan::Ability
-  include RailsBlogEngine::Ability
-
-  def initialize(user)
-    can_read_blog
-    if user
-      can_manage_blog
-    end
-  end
-end