role_model 0.7.1 → 0.8.0

data/.travis.yml

@@ -1,6 +1,7 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
   - jruby
 notifications:
   recipients:

data/README.rdoc

@@ -11,12 +11,18 @@ It works like this:
   require 'role_model'
   
   class User
-    attr_accessor :roles_mask # in real life this would be an persisted attribute
-    
+    attr_accessor :roles_mask   # just for demo purposes
+    # in real life this would usuallt be a persistent attribute,
+    # e.g. if your User model is persisted in a SQL-DB add an integer
+    # column named roles_mask to your users table -- just remove/replace
+    # above attr_accessor line with whatever is needed for your
+    # persistence solution
+
     include RoleModel
     
-    # optionally set the integer attribute to store the roles in,
-    # :roles_mask is the default
+    # if you want to use a different integer attribute to store the
+    # roles in, set it with roles_attribute :my_roles_attribute,
+    # :roles_mask is the default name
     roles_attribute :roles_mask
     
     # declare the valid roles -- do not change the order if you add more

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/lib/role_model/class_methods.rb

@@ -34,7 +34,27 @@ module RoleModel
     #
     # declare valid roles
     def roles(*roles)
+      opts = roles.last.is_a?(Hash) ? roles.pop : {}
       self.valid_roles = roles.flatten.map(&:to_sym)
+      unless (opts[:dynamic] == false)
+        self.define_dynamic_queries(self.valid_roles)
+      end
+    end
+    
+    # Defines dynamic queries for :role
+    #   #is_<:role>?
+    #   #<:role>?
+    #
+    # Defines new methods which call #is?(:role)
+    def define_dynamic_queries(roles)
+      dynamic_module = Module.new do
+        roles.each do |role|
+          ["#{role}?".to_sym, "is_#{role}?".to_sym].each do |method|
+            define_method(method) { is? role }
+          end
+        end
+      end
+      include dynamic_module
     end
   end
 end

data/lib/role_model/implementation.rb

@@ -44,5 +44,20 @@ module RoleModel
     alias_method :is_any_of?, :has_any_role?
     alias_method :has_role?, :has_any_role?
 
+    # :call-seq:
+    #   has_only_roles?(:role)
+    #   has_only_roles?('role')
+    #   has_only_roles?(:role_1, ..., :role_n)
+    #   has_only_roles?('role_1', ..., 'role_n')
+    #   has_only_roles?([:role_1, ..., :role_n])
+    #   has_only_roles?(['role_1', ..., 'role_n'])
+    #
+    # check if ONLY of the given roles have been assigned
+    # this method is aliased as #is_exactly?
+    def has_only_roles?(*roles)
+      self.send("#{self.class.roles_attribute_name}") == self.class.mask_for(*roles)
+    end
+    alias_method :is_exactly?, :has_only_roles?
+
   end
 end

data/role_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "role_model"
-  s.version = "0.7.1"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Rehfeld"]
-  s.date = "2012-05-13"
+  s.date = "2012-10-29"
   s.description = "Ever needed to assign roles to a model, say a User, and build conditional behaviour on top of that? Enter RoleModel -- roles have never been easier! Just declare your roles and you are done. Assigned roles will be stored as a bitmask."
   s.email = "martin.rehfeld@glnetworks.de"
   s.extra_rdoc_files = [

data/spec/role_model_spec.rb

@@ -296,6 +296,78 @@ describe RoleModel do
       end
     end
   end
+  
+  describe "dynamically query for an individual role" do
+    subject { model_class.new }
+    
+    it "should return true when the given role was assigned" do
+      subject.roles = :foo
+      subject.is_foo?.should be_true
+      subject.foo?.should be_true
+    end
+
+    it "should return false when the given role was not assigned" do
+      subject.roles = :bar
+      subject.is_foo?.should be_false
+      subject.foo?.should be_false
+    end
+
+    it "should return false when no role was assigned" do
+      subject.is_foo?.should be_false
+      subject.bar?.should be_false
+    end
+
+    it "should throw NoMethodError when asked for an undefined role" do
+      lambda { subject.baz? }.should raise_error(NoMethodError)
+      lambda { subject.is_baz? }.should raise_error(NoMethodError)
+    end
+    
+    it "should not define dynamic finders when opting out" do
+      non_dynamic_klass = Class.new do
+        attr_accessor :roles_mask
+        attr_accessor :custom_roles_mask
+        include RoleModel
+        roles :foo, :bar, :third, :dynamic => false
+      end
+      
+      model = non_dynamic_klass.new
+      lambda { model.is_foo? }.should raise_error(NoMethodError)
+      lambda { model.bar? }.should raise_error(NoMethodError)
+    end
+    
+    it "should be able to override the default dynamic query methods and call super" do
+      klass = Class.new do
+        def bar?
+          return false
+        end
+        
+        attr_accessor :roles_mask
+        attr_accessor :custom_roles_mask
+        include RoleModel
+        roles :foo, :bar, :baz
+        
+        def is_baz?
+          return false
+        end
+        
+        def foo?
+          ret = super
+          !ret
+        end
+      end
+      
+      model = klass.new
+      model.roles = [:foo, :bar, :baz]
+      
+      model.foo?.should be_false
+      
+      model.bar?.should be_false
+      model.is_bar?.should be_true
+      
+      model.is_baz?.should be_false
+      model.baz?.should be_true
+    end
+  end
 
   context "query for multiple roles" do
     [:has_any_role?, :is_any_of?, :has_role?].each do |check_role_assignment_method|
@@ -318,6 +390,11 @@ describe RoleModel do
       describe "##{check_role_assignment_method}" do
         subject { model_class.new }
 
+        it "returns true when the assigned roles include the given roles" do
+          subject.roles = [:foo, :bar, :third]
+          subject.send(check_role_assignment_method, :foo, :bar).should be_true
+        end
+
         it "should return true when all of the given roles were assigned" do
           subject.roles = [:foo, :bar]
           subject.send(check_role_assignment_method, :foo, :bar).should be_true
@@ -336,6 +413,29 @@ describe RoleModel do
     end
   end
 
+  context "query for exact roles" do
+    [:has_only_roles?, :is_exactly?].each do |check_role_assignment_method|
+      describe "##{check_role_assignment_method}" do
+        subject { model_class.new }
+
+        it "returns false when the given roles are a subset of those assigned" do
+          subject.roles = [:foo, :bar, :third]
+          subject.send(check_role_assignment_method, :foo, :bar).should be_false
+        end
+
+        it "returns true when the given roles exactly match those assigned" do
+          subject.roles = [:foo, :bar]
+          subject.send(check_role_assignment_method, :foo, :bar).should be_true
+        end
+
+        it "should return false when only some of the given roles were assigned" do
+          subject.roles = [:foo, :bar]
+          subject.send(check_role_assignment_method, :bar, :baz).should be_false
+        end
+      end
+    end
+  end
+
   context "query for roles when none defined in model" do
     [:has_any_role?, :is_any_of?, :has_role?, :has_all_roles?, :is?, :has_roles?].each do |check_role_assignment_method|
       describe "##{check_role_assignment_method}" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: role_model
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Martin Rehfeld
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-13 00:00:00 Z
+date: 2012-10-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement