rolify 0.7.0 → 1.0.0

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - ruby-head

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+= 1.0
+* added a new parameter to disable dynamic shortcut methods due to potential incompatibility with other gems using method_missing with the same pattern
+  * add <tt>Rolify.dynamic_shortcuts = false</tt> in the initializer file or 
+  * use the generator command with a third parameter: 
+    * <tt>rails g rolify:role Role User false</tt>
+* removed the railtie as it created more problems than it solved
+* code refactoring to do some speed improvements and code clean up
+* added a lot of specs to improve tests coverage
+* wrote a tutorial showing how to use rolify with CanCan and Devise
+* rolify is now on travis-ci
+
 = 0.7
 * added a method_missing to catch newly created role outside the current ruby process (i.e. dynamic shortcut methods are not defined within this process) 
   * dynamic shortcut is created on the fly in the method_missing to avoid extra method_missing for the same dynamic shortcut 

data/Gemfile

@@ -8,4 +8,5 @@ gemspec
 group :test do
   gem "sqlite3"
   gem "rspec"
-end
+  gem "rake"
+end

data/README.rdoc

@@ -1,5 +1,4 @@
-= rolify
-
+= rolify http://travis-ci.org/EppO/rolify.png
 Very simple Roles library without any authorization enforcement supporting scope on resource object.
 
 Let's see an example:  

data/Rakefile

@@ -1,2 +1,9 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run all specs"
+task "spec" do
+  exec "bundle exec rspec spec"
+end

data/lib/generators/rolify/role/role_generator.rb

@@ -8,6 +8,7 @@ module Rolify
       source_root File.expand_path('../templates', __FILE__)
       argument :role_cname, :type => :string, :default => "Role"
       argument :user_cname, :type => :string, :default => "User"
+      class_option :dynamic_shortcuts, :type => :boolean, :default => true
 
       desc "Generates a model with the given NAME and a migration file."
 
@@ -15,7 +16,7 @@ module Rolify
         template "role.rb", "app/models/#{role_cname.downcase}.rb"
         inject_into_class(model_path, user_cname.camelize) do
           "  include Rolify::Roles\n" + 
-          "  extend Rolify::Reloaded\n" + 
+          "#{"  extend Rolify::Reloaded\n" if options[:dynamic_shortcuts]}" + 
           "  has_and_belongs_to_many :roles#{", :class_name => \"" + role_cname.camelize + "\"" if role_cname != "Role"}, :join_table => :#{user_cname.tableize + "_" + role_cname.tableize}\n"
         end
       end

data/lib/generators/rolify/role/templates/initializer.rb

@@ -1,2 +1,3 @@
 Rolify.user_cname = <%= user_cname.camelize %>
 Rolify.role_cname = <%= role_cname.camelize %>
+Rolify.dynamic_shortcuts = <%= options[:dynamic_shortcuts].to_s %> if ARGV[0] != "db:migrate"

data/lib/rolify.rb

@@ -1,5 +1,4 @@
 require 'active_record'
 
 require 'rolify/role'
-require 'rolify/rolify_railtie.rb' if defined?(Rails)
 

data/lib/rolify/role.rb

@@ -16,6 +16,14 @@ module Rolify
     @@user_cname = user_cname
   end
 
+  def self.dynamic_shortcuts
+    @@dynamic_shortcuts || false
+  end
+
+  def self.dynamic_shortcuts=(is_dynamic)
+    @@dynamic_shortcuts = is_dynamic
+    Rolify.user_cname.load_dynamic_methods if is_dynamic
+  end
 
   module Roles
 
@@ -24,7 +32,7 @@ module Rolify
                                                                                   :resource_type => (resource.class.name if resource), 
                                                                                   :resource_id => (resource.id if resource))
       if !roles.include?(role)
-        self.class.define_dynamic_method role_name, resource
+        self.class.define_dynamic_method(role_name, resource) if Rolify.dynamic_shortcuts
         self.roles << role
       end
     end
@@ -35,8 +43,6 @@ module Rolify
     end
 
     def has_all_roles?(*args)
-      conditions = []
-      values = []
       args.each do |arg|
         if arg.is_a? Hash
           return false if !self.has_role?(arg[:name], arg[:resource])
@@ -50,19 +56,7 @@ module Rolify
     end
 
     def has_any_role?(*args)
-      conditions = []
-      values = []
-      args.each do |arg|
-        if arg.is_a? Hash
-          a, v = build_query(arg[:name], arg[:resource])
-        elsif arg.is_a? String
-          a, v = build_query(arg)
-        else
-          raise ArgumentError, "Invalid argument type: only hash or string allowed"
-        end
-        conditions << a
-        values += v
-      end
+      conditions, values = sql_conditions(args)
       self.roles.where([ conditions.join(' OR '), *values ]).size > 0
     end
   
@@ -82,13 +76,31 @@ module Rolify
         if Rolify.role_cname.where(:name => $1).count > 0
           resource = args.first
           self.class.define_dynamic_method $1, resource
-          has_role?("#{$1}", resource)
+          return has_role?("#{$1}", resource)
         end
-      end
+      end unless !Rolify.dynamic_shortcuts
+      super
     end
  
     private
  
+    def sql_conditions(args)
+      conditions = []
+      values = []
+      args.each do |arg|
+        if arg.is_a? Hash
+          a, v = build_query(arg[:name], arg[:resource])
+        elsif arg.is_a? String
+          a, v = build_query(arg)
+        else
+          raise ArgumentError, "Invalid argument type: only hash or string allowed"
+        end
+        conditions << a
+        values += v
+      end
+      [ conditions, values ]
+    end
+
     def build_query(role, resource = nil)
       query = "((name = ?) AND (resource_type IS NULL) AND (resource_id IS NULL))"
       values = [ role ]

data/lib/rolify/version.rb

@@ -1,3 +1,3 @@
 module Rolify
-  VERSION = "0.7.0"
+  VERSION = "1.0.0"
 end

data/spec/rolify/role_spec.rb

@@ -1,10 +1,12 @@
 require "spec_helper"
 
-shared_examples_for "Rolify module" do
+shared_examples_for "Rolify module" do |dynamic|
     context "in a Instance level" do 
       before(:all) do
         Rolify.user_cname = user_cname
         Rolify.role_cname = role_cname
+        Rolify.dynamic_shortcuts = dynamic_shortcuts
+        Rolify.role_cname.destroy_all
         @admin = Rolify.user_cname.first
         @admin.has_role "admin"
         @admin.has_role "moderator", Forum.first
@@ -35,23 +37,28 @@ shared_examples_for "Rolify module" do
         @admin.should respond_to(:has_no_role).with(2).arguments
       end
 
-      it "should respond to dynamic methods" do
+      it "should respond to dynamic methods", :if => dynamic do
         @admin.should respond_to(:is_admin?).with(0).arguments
         @admin.should respond_to(:is_moderator_of?).with(1).arguments
       end
 
-      it "should not respond to any unknown methods" do
+      it "should not respond to any unknown methods", :if => dynamic do
         @admin.should_not respond_to(:is_god?)
       end
 
-      it "should create a new dynamic method if role exists in database" do 
+      it "should create a new dynamic method if role exists in database", :if => dynamic do 
         Rolify.role_cname.create(:name => "superman")
-        @admin.is_superman?.should be(false)
         @admin.should respond_to(:is_superman?).with(0).arguments
+        @admin.is_superman?.should be(false)
         Rolify.role_cname.create(:name => "batman", :resource => Forum.first)
-        @admin.is_batman_of?(Forum.first).should be(false)
         @admin.should respond_to(:is_batman_of?).with(1).arguments
         @admin.should respond_to(:is_batman?).with(0).arguments
+        @admin.is_batman_of?(Forum.first).should be(false)
+      end
+
+      it "should not have any dynamic methods if dynamic_shortcuts is disabled", :if => dynamic == false do
+        @admin.should_not respond_to(:is_admin?)
+        @admin.should_not respond_to(:is_moderator_of?)
       end
     end
 
@@ -79,7 +86,7 @@ shared_examples_for "Rolify module" do
         @admin.has_role?("admin").should be(true)
       end
 
-      it "should be able to use dynamic shortcut" do
+      it "should be able to use dynamic shortcut", :if => dynamic do
         @admin.is_admin?.should be(true)
       end
     
@@ -102,13 +109,14 @@ shared_examples_for "Rolify module" do
       end
 
       it "should check if user has all of a global roles set" do
-        @admin.has_role?("staff").should be(true)
+        @admin.has_all_roles?("staff").should be(true)
         @admin.has_all_roles?("admin", "staff").should be(true)
         @admin.has_all_roles?("admin", "dummy").should be(false)
         @admin.has_all_roles?("dummy", "dumber").should be(false)
       end
 
       it "should check if user has any of a global roles set" do
+        @admin.has_any_role?("staff").should be(true)
         @admin.has_any_role?("admin", "staff").should be(true)
         @admin.has_any_role?("admin", "moderator").should be(true)
         @admin.has_any_role?("dummy", "dumber").should be(false)
@@ -155,7 +163,7 @@ shared_examples_for "Rolify module" do
         @moderator.has_role?("moderator", Forum.first).should be(true)
       end
 
-      it "should be able to use dynamic shortcut" do
+      it "should be able to use dynamic shortcut", :if => dynamic do
         @moderator.is_moderator?.should be(false)
         @moderator.is_moderator_of?(Forum.first).should be(true)
         @moderator.is_moderator_of?(Forum.last).should be(false)
@@ -181,6 +189,7 @@ shared_examples_for "Rolify module" do
       end
     
       it "should check if user has all of a scoped roles set" do
+        @moderator.has_all_roles?({ :name => "visitor", :resource => Forum.last }).should be(true)
         @moderator.has_all_roles?({ :name => "moderator", :resource => Forum.first }, 
                                   { :name => "visitor", :resource => Forum.last }).should be(true)
         @moderator.has_all_roles?({ :name => "moderator", :resource => Forum.first }, 
@@ -190,6 +199,7 @@ shared_examples_for "Rolify module" do
       end
 
       it "should check if user has any of a scoped roles set" do
+        @moderator.has_any_role?( { :name => "visitor", :resource => Forum.last }).should be(true)
         @moderator.has_any_role?( { :name => "moderator", :resource => Forum.first }, 
                                   { :name => "visitor", :resource => Forum.last }).should be(true)
         @moderator.has_any_role?( { :name => "moderator", :resource => Forum.first }, 
@@ -235,12 +245,14 @@ shared_examples_for "Rolify module" do
       it "should check if user has all of a mix of global and scoped roles set" do
         @user.has_all_roles?("admin", { :name => "moderator", :resource => Forum.first }).should be(true)
         @user.has_all_roles?("admin", { :name => "moderator", :resource => Forum.last }).should be(false)
+        @user.has_all_roles?({ :name => "admin", :resource => Forum.first }, { :name => "moderator", :resource => Forum.first }).should be(true)
         @user.has_all_roles?("dummy", { :name => "dumber", :resource => Forum.last }).should be(false)
       end
 
       it "should check if user has any of a mix of global and scoped roles set" do
         @user.has_any_role?("admin", { :name => "moderator", :resource => Forum.first }).should be(true)
         @user.has_any_role?("admin", { :name => "moderator", :resource => Forum.last }).should be(true)
+        @user.has_any_role?({ :name => "admin", :resource => Forum.first }, { :name => "moderator", :resource => Forum.last }).should be(true)
         @user.has_any_role?("dummy", { :name => "dumber", :resource => Forum.last }).should be(false)
       end
     end
@@ -248,17 +260,35 @@ shared_examples_for "Rolify module" do
 end
 
 describe Rolify do
-  context "using default Role and User class names" do 
+  context "using default Role and User class names with dynamic shortcuts", true do 
+    it_behaves_like "Rolify module" do
+      let(:user_cname) { User } 
+      let(:role_cname) { Role }
+      let(:dynamic_shortcuts) { true }
+    end
+  end
+
+  context "using default Role and User class names without dynamic shortcuts", false do 
     it_behaves_like "Rolify module" do
       let(:user_cname) { User } 
       let(:role_cname) { Role }
+      let(:dynamic_shortcuts) { false }
+    end
+  end
+
+  context "using custom User and Role class names with dynamic shortcuts", true do 
+    it_behaves_like "Rolify module" do
+      let(:user_cname) { Customer }
+      let(:role_cname) { Privilege }
+      let(:dynamic_shortcuts) { true }
     end
- end
+  end
 
-  context "using custom User and Role class names" do 
+  context "using custom User and Role class names without dynamic shortcuts", false do 
     it_behaves_like "Rolify module" do
       let(:user_cname) { Customer }
       let(:role_cname) { Privilege }
+      let(:dynamic_shortcuts) { false }
     end
   end
 end

metadata

@@ -1,50 +1,49 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rolify
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  version: 0.7.0
 platform: ruby
-authors: 
+authors:
 - Florent Monbillard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sqlite3
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &79887380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *79887380
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &79887130 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 3.1.0.rc1
   type: :runtime
-  version_requirements: *id002
-description: "Very simple Roles library without any authorization enforcement (built to use with cancan) supporting scope on resource: user.is_moderator?(Forum.first) => # return false if user is moderator of another Forum "
-email: 
+  prerelease: false
+  version_requirements: *79887130
+description: ! 'Very simple Roles library without any authorization enforcement (built
+  to use with cancan) supporting scope on resource: user.is_moderator?(Forum.first)
+  => # return false if user is moderator of another Forum '
+email:
 - f.monbillard@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - LICENSE
@@ -56,7 +55,6 @@ files:
 - lib/generators/rolify/role/templates/role.rb
 - lib/rolify.rb
 - lib/rolify/role.rb
-- lib/rolify/rolify_railtie.rb
 - lib/rolify/version.rb
 - rolify.gemspec
 - spec/rolify/role_spec.rb
@@ -67,30 +65,26 @@ files:
 - spec/support/schema.rb
 homepage: https://github.com/EppO/rolify
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rolify
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Roles library with resource scoping
 test_files: []
-

data/lib/rolify/rolify_railtie.rb

@@ -1,9 +0,0 @@
-module Rolify
-  class RoleRailtie < ::Rails::Railtie
-    initializer "instantiate roles methods" do
-      ActiveSupport.on_load :active_record do
-        Rolify.user_cname.load_dynamic_methods if defined? Rails.server
-      end
-    end
-  end
-end