cream 0.5.6

data/spec/generator_spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec/core'    
+require 'generator-spec'
+require 'devise-spec'
+require 'roles-spec'
+require 'cream'
+
+RSpec::Generator.configure do |config|
+  config.debug = false
+  config.remove_temp_dir = false # true
+  config.default_rails_root(__FILE__) 
+  config.lib = File.dirname(__FILE__) + '/../lib'
+  config.logger = :stdout    
+end
+
+RSpec.configure do |config|
+  config.mock_with :mocha 
+   
+  config.before do
+    create_rails_app
+  end
+  
+  config.after do
+    remove_rails_app
+  end  
+end
+

data/spec/generators/cream/config/devise/existing_devise_users.rb

@@ -0,0 +1,61 @@
+require 'generator_spec_helper'
+require_generator :cream => :config
+
+LOGFILE = File.expand_path File.dirname(__FILE__) + '/../../config_generator-init.log'
+
+describe 'Cream config generator: strategy "admin_flag", init Devise user model User' do
+  use_helpers :model, :controller, :permit, :files, :file
+  
+  before :each do              
+    setup_generator 'config_generator' do
+      tests Cream::Generators::ConfigGenerator
+    end    
+    remove_all_permits
+    remove_locale :cream
+    
+    File.remove_from controller_file(:application) do
+          %{
+  rescue_from CanCan::AccessDenied do |exception|
+    flash[:error] = exception.message
+    redirect_to root_url
+  end
+}
+    end
+  end
+
+  after :each do
+    remove_all_permits
+  end
+
+  describe "Configure Rails 3 app with Cream using init devise" do
+    before do    
+      puts "Running generator"
+      Dir.chdir Rails.root do        
+        @generator = with_generator do |g|
+          arguments = "--strategy admin_flag --init-devise --logfile #{LOGFILE}".args 
+          puts "arguments: #{arguments}"
+          g.run_generator arguments
+        end
+      end
+    end # before
+      
+    it "should generate a Devise User with only a :guest role using :role_string strategy" do
+      @generator.should generate_model :user do |clazz|
+        clazz.should have_default_devise_options
+
+        # clazz.should use_roles :generic
+        # clazz.should include_module 'Roles::Generic'
+        # clazz.should have_call :roles,          :args => ':guest'
+        # clazz.should have_call :role_strategy,  :args => ":role_string"
+      end
+    end # it  
+  
+    # it "should generate a Devise Admin user" do
+    #   @generator.should generate_model :admin do |clazz|
+    #     # clazz.should use_roles    :generic
+    #     # clazz.should include_module 'Roles::Generic'
+    #     clazz.should inherit_from :user
+    #   end        
+    # end # it
+  end # desc
+end

data/spec/generators/cream/config/empty_app/default_args_spec.rb

@@ -0,0 +1,51 @@
+require 'generator_spec_helper'
+require_generator :cream => :config
+
+LOGFILE = File.expand_path File.dirname(__FILE__) + '/../../config_generator-default.log'
+
+puts "Logfile at: #{LOGFILE}"
+
+describe 'role strategy generator: admin_flag' do
+  use_helpers :model, :controller, :permit, :files, :file  
+  
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests Cream::Generators::ConfigGenerator
+    end    
+    remove_all_permits
+    remove_locale :cream if locale_file? :cream
+    
+    File.remove_from controller_file(:application) do
+          %{
+  rescue_from CanCan::AccessDenied do |exception|
+    flash[:error] = exception.message
+    redirect_to root_url
+  end
+}
+    end if controller_file? :application
+  end
+
+  after :each do
+    remove_all_permits
+  end
+
+  describe "Configure Rails 3 app with Cream using default options" do
+    before do    
+      puts "Running generator"
+      Dir.chdir Rails.root do
+        @generator = with_generator do |g|
+          arguments = "--strategy admin_flag --logfile #{LOGFILE}".args 
+          puts "arguments: #{arguments}"
+          g.run_generator arguments
+        end
+      end
+    end # before
+      
+    it "should generate a Devise User with only a :guest role using :role_string strategy" do
+      @generator.should_not generate_model :user
+      @generator.should have_gems :devise, :cancan, :roles_active_record
+    end # it
+  end # desc  
+end # desc
+
+

data/spec/generators/cream/config/roles/default_roles.rb

@@ -0,0 +1,51 @@
+require 'generator_spec_helper'
+require_generator :cream => :config
+
+LOGFILE = File.expand_path File.dirname(__FILE__) + '/../../config_generator-default.log'
+
+puts "Logfile at: #{LOGFILE}"
+
+describe 'role strategy generator: admin_flag' do
+  use_helpers :model, :controller, :permit, :files, :file  
+  
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests Cream::Generators::ConfigGenerator
+    end    
+    remove_all_permits
+    remove_locale :cream if locale_file? :cream
+    
+    File.remove_from controller_file(:application) do
+          %{
+  rescue_from CanCan::AccessDenied do |exception|
+    flash[:error] = exception.message
+    redirect_to root_url
+  end
+}
+    end if controller_file? :application
+  end
+
+  after :each do
+    remove_all_permits
+  end
+
+  describe "Configure Rails 3 app with Cream using default options" do
+    before do    
+      puts "Running generator"
+      Dir.chdir Rails.root do
+        @generator = with_generator do |g|
+          arguments = "--strategy admin_flag --logfile #{LOGFILE}".args 
+          puts "arguments: #{arguments}"
+          g.run_generator arguments
+        end
+      end
+    end # before
+      
+    it "should generate a Devise User with only a :guest role using :role_string strategy" do
+      @generator.should_not generate_model :user
+      @generator.should have_gems :devise, :cancan, :roles_active_record
+    end # it
+  end # desc  
+end # desc
+
+

data/spec/generators/cream/config/roles/roles_spec.rb

@@ -0,0 +1,60 @@
+require 'generator_spec_helper'
+require_generator :cream => :config
+
+LOGFILE = File.expand_path File.dirname(__FILE__) + '/../../config_generator-roles.log'
+
+describe 'role strategy generator: admin_flag' do
+  use_helpers :model, :controller, :permit, :files, :file
+  
+  before :each do              
+    setup_generator 'config_generator' do
+      tests Cream::Generators::ConfigGenerator
+    end    
+    remove_all_permits
+    remove_locale :cream
+    
+    File.remove_from controller_file(:application) do
+          %{
+  rescue_from CanCan::AccessDenied do |exception|
+    flash[:error] = exception.message
+    redirect_to root_url
+  end
+}
+    end
+  end
+
+  after :each do
+    remove_all_permits
+  end
+
+  describe "Configure Rails 3 app with Cream using init devise" do
+    before do    
+      puts "Running generator"
+      Dir.chdir Rails.root do        
+        @generator = with_generator do |g|
+          arguments = "--strategy role_string --init-devise --roles editor author --logfile #{LOGFILE}".args 
+          puts "arguments: #{arguments}"
+          g.run_generator arguments
+        end
+      end
+    end # before
+      
+    it "should generate a Devise User with only a :guest role using :role_string strategy" do
+
+      # Devise User with Roles setup
+      @generator.should generate_model :user do |clazz|
+        clazz.should have_devise_options :defaults
+        clazz.should use_roles :generic
+        clazz.should include_module 'Roles::ActiveRecord'
+        clazz.should have_call :valid_roles_are, :args => ':admin, :guest, :editor, :author'
+        clazz.should have_call :role_strategy,  :args => ":role_string"
+      end
+      
+      # Gemfile
+      @generator.should have_gems :devise, :cancan, :roles_active_record
+
+      # Permissions
+      @generator.should generate_permits :admin, :guest, :editor, :author      
+    end # it    
+  end # desc
+end

data/spec/generators/cream/shared_examples.rb

@@ -0,0 +1,18 @@
+it "should generate Permits for Guest and Admin roles"
+  @generator.should generate_permits :guest, :admin
+end
+
+it "should generate Permits for Guest and Admin roles"
+  @generator.should generate_permits :guest, :admin
+end 
+
+
+it "should inject permission exception handling into controller 'application_controller'"
+  @generator.should update_controller :application do |clazz|
+    clazz.should match /rescue_from CanCan::AccessDenied/
+  end
+end 
+
+it "should generate 'cream' locale file"
+  @generator.should generate_locale_file :cream
+end 

data/spec/generators/cream/views_generator_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Generator' do
+  with_generator do |g, c|
+    g.tests Cream::Generators::ViewsGenerator
+    c.setup
+  end
+
+  def check_generated_views folder=nil
+    with_generator do |g, check|
+      if folder
+        g.run_generator folder 
+      else             
+        g.run_generator
+        folder = 'menu'
+      end
+      check.view folder, '_admin_login_items.html.erb', %w{admin_block not_admin_block}
+      check.view folder, '_login_items.html.erb',       %w{user_block  not_user_block}
+      check.view folder, 'registration_items.html.erb', %w{user_block  not_user_block}
+    end    
+  end
+
+  it "should create views in default scope 'menu' " do
+    check_generated_views
+  end
+  
+  it "should create views in explicit scope 'login' " do
+    check_generated_views 'login'
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rspec/core'
+require 'rspec-action_view'
+require 'generator-spec'
+require 'cream'
+
+RSpec::Generator.configure do |config|
+  config.debug = false
+  config.remove_temp_dir = false # true
+  config.default_rails_root(__FILE__) 
+  config.lib = File.dirname(__FILE__) + '/../lib'
+  config.logger = :stdout    
+end
+
+
+RSpec.configure do |config|
+  config.mock_with :mocha 
+end
+

data/wiki/CONFIG_GENERATOR.txt

@@ -0,0 +1,21 @@
+The *config* generator generates a configuration initializer file for setting up `cream` to use a particular role strategy.
+
+<pre>$ rails g cream:config --strategy NAME</pre>
+
+NAME is the name of a role strategy. 
+
+Strategies with a single role for each user
+* admin_field
+* role_string
+* one_role
+
+Strategies with multiple roles for each user
+* roles_mask
+* many_roles
+
+Currently role groups are not supported. Feel free to provide an add-on to support this or integrate with an existing 'role group' solution.  
+
+Example usage:
+
+<pre>$ rails g cream:config --strategy admin_field</pre>
+

data/wiki/DESIGN.txt

@@ -0,0 +1,21 @@
+# Design and plans for the future...
+
+1) Specs for generators
+Currently there are a few generators. I have found some good examples of how to write generator tests (using test_unit) in the rails3-generators project.
+I am porting this to RSpec 2 and will then write generator specs next.
+
+2) New hook-in approach for controller and view methods
+I will change how the methods are added to Rails controllers and views using a new approach I found and used in the Netzke project.
+
+3) Create specs for the custom methods
+4) Create cucumber features for various Role scenarios
+5) Add Mongoid and Mongo Mapper ORM support
+Mongoid currently supported by Devise, and Mongo Mapper will be supported after Rails 3 release I think (have heard?)
+
+6) Add Data Mapper support
+dm-devise project almost done by jm81 as per. July 9, 2010
+
+7) Add support for Canable (jnunemaker), an even simpler permission system alternative to CanCan.
+I already added generators and specs to this gem.
+
+Feel free to suggest other improvements etc ;)

data/wiki/INSTALLATION.txt

@@ -0,0 +1,6 @@
+This gem has been designed for Rails 3 only. Any back port to Rails 2 is most welcome ;)
+
+Insert <pre>gem 'auth-assistant'</pre> in your Rails 3 Gemfile
+
+<pre>$ bundle install</pre>
+

data/wiki/PERMITS.txt

@@ -0,0 +1,32 @@
+Authorization is setup by designing permits for each can of role to do certain actions.
+The config generator generates a default permits.rb file in /lib
+
+Please see "cancan 1.3 wiki":http://wiki.github.com/ryanb/cancan/upgrading-to-13 for more options 
+you can use in designing your Permits. The 'owns' convenience method provided, now uses the new hash option so it
+is also available in the controller using fx:
+
+<pre>Book.accessible_by(current_ability)</pre>
+
+The user can manage any Comment instance if 'user' field on instance points to the user, marking ownership
+<pre>user.owns(Comment)</pre>
+
+Override default 'user_id' field used by owns, to instead use 'author' as ownership key (foreign key) pointing to the user (user.id).  
+<pre>user.owns(Book, :author)</pre>
+
+Example:
+<pre>module RolePermit
+  class Moderator
+    def initialize(ability)
+      super
+    end
+
+    def permit?(user)
+      super
+      return if !user.role?(:moderator)
+      can :read, :all    
+      
+      user.owns(Comment) 
+      user.owns(Book, :author)       
+    end  
+  end
+end</pre>

data/wiki/ROLE_STRATEGIES.txt

@@ -0,0 +1,40 @@
+*Auth assistant* supports single and multiple role strategies. Currently groups are not supported. 
+
+Note: Maybe roles support could be integrated in the future using an existing solution for roles and groups? 
+
+h2. Single role per user
+
+* admin_field 
+* role_field (role : string in users table)
+* role_assignment (role_id -> role.id)
+
+h3. admin_field
+Uses the field *admin : boolean* in the _users_ table
+
+h3. role_field
+Uses the field *role : string* in the _users_ table
+
+h3. role_assignment
+Uses the field *role_id :integer* in the _users_ table. 
+A _roles_ table has id and name fields, where name is the name of the role.
+`users.role_id` points to `role.id` in a 1-M relation. 
+
+Many (M) users can have the same (1) role. Any user can however only have a single role.
+
+h2. Multiple roles per user
+* roles mask
+* roles_field 
+* multi_role_assignment
+
+h3. roles mask
+Uses the field *role_masks : integer* in the _users_ table.
+Each bit of the integer matches a given role.
+
+h3. roles_field
+Uses the field *roles : string* in the _users_ table.
+Currently "experimental".
+
+h3. multi_role_assignment
+Uses the field *role_assignment_id : integer* in the _users_ table.
+A _roles_ table has id and name fields, where name is the name of the role.
+A _role_assignments_ table has _role_id_ and _user_id_ fields, linking the assignment to a user in the users table and a role in the roles table.