role_model 0.3.1 → 0.3.2

data/README.rdoc

@@ -1,17 +1,17 @@
 = RoleModel
 
-Ever needed to assign roles to a model, say a User, and build conditional
-behaviour on top of that?
+RoleModel is the framework agnostic, efficient and declarative way to do
+(user) roles. Assigned roles will be efficiently stored as a bitmask
+directly into your model within an configurable attribute.
 
-Assigned roles will be stored as a bitmask in an configurable attribute
-(default: <tt>roles_mask</tt>). Here's how to get started:
+It works like this:
 
   # given a User class with a roles_mask attribute
   require 'rubygems'
   require 'role_model'
 
   class User
-    attr_accessor :roles_mask # in real life this would be an persisted attribute / DB-column
+    attr_accessor :roles_mask # in real life this would be an persisted attribute
     
     include RoleModel
 
@@ -39,7 +39,7 @@ Assigned roles will be stored as a bitmask in an configurable attribute
   >> u.roles << :manager
   => [:admin, :manager]
   
-  # quering roles...
+  # querying roles...
 
   # ... retrieve all assigned roles
   >> u.roles # aliased to role_symbols for DeclarativeAuthorization
@@ -48,8 +48,6 @@ Assigned roles will be stored as a bitmask in an configurable attribute
   # ... check for individual roles
   >> u.has_role? :author
   => false
-  >> u.is_a? :admin  # has_role? is aliased as is_a?
-  => true
 
   # see the internal bitmask representation (3 = 0b0011)
   >> u.roles_mask

data/Rakefile

@@ -28,6 +28,9 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
+  spec.rcov_opts.concat ['--exclude', 'rcov.rb']
+  spec.rcov_opts.concat ['--exclude', '.*_spec.rb']
+  spec.rcov_opts.concat ['--exclude', 'spec_helper.rb']
 end
 
 task :spec => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/role_model/class_methods.rb

@@ -0,0 +1,32 @@
+module RoleModel
+  module ClassMethods
+    def inherited(subclass) # :nodoc:
+      ::RoleModel::INHERITABLE_CLASS_ATTRIBUTES.each do |attribute|
+        instance_var = "@#{attribute}"
+        subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
+      end
+      super
+    end
+
+    # set the bitmask attribute role assignments will be stored in
+    def roles_attribute(name)
+      self.roles_attribute = name
+    end
+
+    # alternative method signature: set the bitmask attribute role assignments will be stored in
+    def roles_attribute=(name)
+      self.roles_attribute_name = name.to_sym
+    end
+
+    # :call-seq:
+    #   roles(:role_1, ..., :role_n)
+    #   roles('role_1', ..., 'role_n')
+    #   roles([:role_1, ..., :role_n])
+    #   roles(['role_1', ..., 'role_n'])
+    #
+    # declare valid roles
+    def roles(*roles)
+      self.valid_roles = Array[*roles].flatten.map { |r| r.to_sym }
+    end
+  end
+end

data/lib/role_model/implementation.rb

@@ -0,0 +1,21 @@
+module RoleModel
+  module Implementation
+
+    # assign roles
+    def roles=(*roles)
+      self.send("#{self.class.roles_attribute_name}=", (Array[*roles].flatten.map { |r| r.to_sym } & self.class.valid_roles).map { |r| 2**self.class.valid_roles.index(r) }.inject { |sum, bitvalue| sum + bitvalue })
+    end
+
+    # query assigned roles
+    def roles
+      Roles.new(self, self.class.valid_roles.reject { |r| ((self.send(self.class.roles_attribute_name) || 0) & 2**self.class.valid_roles.index(r)).zero? })
+    end
+    alias role_symbols roles
+
+    # check if a given role has been assigned
+    def has_role?(role)
+      roles.include?(role.to_sym)
+    end
+
+  end
+end

data/lib/role_model/roles.rb

@@ -1,7 +1,7 @@
 require 'set'
 
 module RoleModel
-  class Roles < ::Set
+  class Roles < ::Set # :nodoc:
     attr_reader :model_instance
 
     def initialize(sender, *roles)

data/lib/role_model.rb

@@ -1,58 +1,20 @@
+require 'role_model/implementation'
+require 'role_model/class_methods'
 require 'role_model/roles'
 
 module RoleModel
 
   INHERITABLE_CLASS_ATTRIBUTES = [:roles_attribute_name, :valid_roles]
 
+  include Implementation
+
   def self.included(base) # :nodoc:
     base.extend ClassMethods
     base.class_eval do
       class << self
         attr_accessor(*::RoleModel::INHERITABLE_CLASS_ATTRIBUTES)
       end
-      roles_attribute :roles_mask
-    end
-
-    # assign roles
-    def roles=(*roles)
-      self.send("#{self.class.roles_attribute_name}=", (Array[*roles].flatten.map { |r| r.to_sym } & self.class.valid_roles).map { |r| 2**self.class.valid_roles.index(r) }.inject { |sum, bitvalue| sum + bitvalue })
-    end
-
-    # query assigned roles
-    def roles
-      Roles.new(self, self.class.valid_roles.reject { |r| ((self.send(self.class.roles_attribute_name) || 0) & 2**self.class.valid_roles.index(r)).zero? })
-    end
-    alias role_symbols roles
-
-    # check if a given role has been assigned
-    def has_role?(role)
-      roles.include?(role.to_sym)
-    end
-    alias is_a? has_role?
-  end
-
-  module ClassMethods
-    def inherited(subclass) # :nodoc:
-      ::RoleModel::INHERITABLE_CLASS_ATTRIBUTES.each do |attribute|
-        instance_var = "@#{attribute}"
-        subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
-      end
-      super
-    end
-
-    # set the bitmask attribute role assignment will be stored in
-    def roles_attribute(name)
-      self.roles_attribute = name
-    end
-
-    # alternative method signature: set the bitmask attribute role assignment will be stored in
-    def roles_attribute=(name)
-      self.roles_attribute_name = name.to_sym
-    end
-
-    # declare valid roles
-    def roles(*roles)
-      self.valid_roles = Array[*roles].flatten.map { |r| r.to_sym }
+      roles_attribute :roles_mask # set default bitmask attribute
     end
   end
 

data/role_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{role_model}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Rehfeld"]
-  s.date = %q{2010-05-29}
+  s.date = %q{2010-08-04}
   s.description = %q{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 = %q{martin.rehfeld@glnetworks.de}
   s.extra_rdoc_files = [
@@ -24,9 +24,12 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/role_model.rb",
+     "lib/role_model/class_methods.rb",
+     "lib/role_model/implementation.rb",
      "lib/role_model/roles.rb",
      "role_model.gemspec",
      "spec/custom_matchers.rb",
+     "spec/custom_matchers_spec.rb",
      "spec/role_model_spec.rb",
      "spec/roles_spec.rb",
      "spec/spec.opts",
@@ -35,10 +38,11 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/martinrehfeld/role_model}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Declare, assign and query roles with ease}
   s.test_files = [
     "spec/custom_matchers.rb",
+     "spec/custom_matchers_spec.rb",
      "spec/role_model_spec.rb",
      "spec/roles_spec.rb",
      "spec/spec_helper.rb"
@@ -48,7 +52,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])

data/spec/custom_matchers.rb

@@ -5,8 +5,9 @@ module CustomMatchers
     end
 
     def ==(actual)
+      return false if actual.size < @expected.size
       @expected.each do | value |
-        return false unless actual.include?(value)
+        return false unless actual.any? { |actual_value| value == actual_value }
       end
       true
     rescue NoMethodError => ex

data/spec/custom_matchers_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+module CustomMatchers
+  describe ArrayIncludingMatcher do
+  
+    it "should describe itself properly" do
+      ArrayIncludingMatcher.new(:a, :b).description.should == "array_including(:a, :b)"
+    end      
+
+    describe "passing" do
+      it "should match the same array" do
+        array_including(:a).should == [:a]
+      end
+
+      it "should match a array with extra stuff" do
+        array_including(:a).should == [:a, :b]
+      end
+    
+      it "should match a array regardless of element position" do
+        array_including(:a, :b).should == [:b, :a]
+      end
+
+      describe "when matching against other matchers" do
+        it "should match a symbol against anything()" do
+          array_including(anything, :b).should == [:a, :b]
+        end
+
+        it "should match an int against anything()" do
+          array_including(anything, :b).should == [1, :b]
+        end
+
+        it "should match a string against anything()" do
+          array_including(anything, :b).should == ["1", :b]
+        end
+
+        it "should match an arbitrary object against anything()" do
+          array_including(anything, :b).should == [Class.new.new, :b]
+        end
+      end
+    end
+  
+    describe "failing" do
+      it "should not match a non-array" do
+        array_including(:a).should_not == :a
+      end
+
+      it "should not match a array with a missing element" do
+        array_including(:a).should_not == [:b]
+      end
+    
+      it "should not match an empty array with a given key" do
+        array_including(:a).should_not == []
+      end
+
+      describe "when matching against other matchers" do
+        it "should not match without additional elements" do
+          array_including(anything, 1).should_not == [1]
+        end
+      end
+    end
+  end
+end

data/spec/role_model_spec.rb

@@ -180,7 +180,7 @@ describe RoleModel do
     end
   end
 
-  [:has_role?, :is_a?].each do |check_role_assignment_method|
+  [:has_role?].each do |check_role_assignment_method|
     describe "##{check_role_assignment_method}" do
       subject { model_class.new }
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: role_model
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Martin Rehfeld
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-29 00:00:00 +02:00
+date: 2010-08-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -48,9 +51,12 @@ files:
 - Rakefile
 - VERSION
 - lib/role_model.rb
+- lib/role_model/class_methods.rb
+- lib/role_model/implementation.rb
 - lib/role_model/roles.rb
 - role_model.gemspec
 - spec/custom_matchers.rb
+- spec/custom_matchers_spec.rb
 - spec/role_model_spec.rb
 - spec/roles_spec.rb
 - spec/spec.opts
@@ -65,28 +71,33 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Declare, assign and query roles with ease
 test_files: 
 - spec/custom_matchers.rb
+- spec/custom_matchers_spec.rb
 - spec/role_model_spec.rb
 - spec/roles_spec.rb
 - spec/spec_helper.rb