indulgence 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGZlMzlkNTA5ZjYyN2RmNjMxMjJkODc4MzY3ZDEyYWUwNmIxMTg5OA==
+    ZmJiMTU1MDg5ZDRhOWRmZjgwYTNhOTU1ZWRiMTcxNDMzMjU4YWU0Mg==
   data.tar.gz: !binary |-
-    MWI5NDhhZjljNGJlNTI0MGNmNGRhN2RjNjc0M2Y1MjkxOGVkOWE4Mw==
+    MTA3MjYwOTkwMGQyNjk2NzZmNWE3NzdmM2I4NDYyNTMxNjFlM2Q2MQ==
 SHA512:
   metadata.gz: !binary |-
-    Mjk3YmNkZDQ1NmI4YzQ3YTk3ZjUzYjlmNmY5MzBjMTk4NTdkZmExYzRmNWI1
-    YzRhZDE5ZjBmYzQ4YTY2YmQwZjg3Y2Y2YmQ0OWI0ODY3ZTZhZjlkZjBmNjU5
-    MzA5YWQzNWVmNzkyZmIzZWQwYjZlOTI3YmUxMzAxNzYwNzNjMjE=
+    YTYyOWE1ZWMwODMxZjkzNjUzNmQ1NjY4OTVlM2IxZWYxODJlNGQ5YzE2YTJk
+    MzI4NmNiOGFmNjI0YTc0N2MxMGVhNzFlZjc4YzdmYTMxY2ZhNTJkY2VkYzQw
+    N2FmYjM1NTA1YTFhNGZlNjFkYzM5MzU3MTA4YjFmY2I2YjA1M2I=
   data.tar.gz: !binary |-
-    NGYwZGE1N2I1Y2RjNGJkYzg4ODUzZWZlZGU0ODgwYTllNDg0NGYzNWQ5ZGQz
-    OWY2OWNmOTc0ZjQzOTE4MjA5NDZkOWZjNjQzYzE0ZTVlOTYxNDE4YWJkYzNl
-    ZTMyMmU4M2U0M2FjYzUxNjEzMGJiN2FjODRkOGI0MDYzYjlhYjA=
+    ZDY4Y2ZhYTZmZDE0MjBmZDZmNTQ1ZWIzNjA2OGRmYjE5ZmYwM2ZhNjczMGQ1
+    N2IzYmE2NjVlZGIwZGFhMmNiMTExYThlODgzMmI3ZjkzY2E0N2NlYmY3YTBl
+    ODFiNTJlZmE5N2U0ZmVmNDNjZmM0OTIzOTU1Y2VmYTM5ZTU3MzA=

data/README.rdoc

@@ -455,6 +455,36 @@ With that in place:
     work_process.indulge?(user, :update) == false
     WorkProcess.indulgence(user, :create, :beginning) == [work_process]
 
+== Strict mode
+
+Imagine we have a Dog class:
+
+    class Dog
+    end
+
+And we use a dog as an entity:
+
+    fido = Dog.new
+    thing.indulge? fido, :edit
+
+There are two ways that we may want indulgence to behave:
+* go bang;
+* or handle the problem as if the entity has no role (that is: return the default abilities.)
+
+The default behaviour is to raise a method not found error. However, if
+Indulgence.strict = false, the response will match the default ability:
+
+    Indulgence.strict = true  # default
+    thing.indulge?(fido, :edit) ---> Raises No Method Error
+
+    Indulgence.strict = false
+    thing.indulge?(fido, :edit) == false
+    thing.indulge?(fido, :read) == true
+
+That is, in Strict mode, Indulgence will expect an entity to behave like a user
+with roles, and will go bang if this is no the case. It strict mode is turned
+off, Indulgence will make a best effort to guess how to behave.
+
 == Examples
 
 For some examples, have a look at the tests. In particular, look at the object

data/lib/indulgence/permission.rb

@@ -91,22 +91,32 @@ module Indulgence
 
     private
     def entity_role_name
-      role = entity.send(self.class.role_method)
-      name_method = self.class.role_name_method
-      if role and abilities.keys.include?(role.send(name_method).to_sym)
-        role.send(name_method).to_sym
+      role = entity.send(self.class.role_method) if entity_has_role_method
+      if role and abilities.keys.include?(role.send(role_name_method).to_sym)
+        role.send(role_name_method).to_sym
       else
         :default
       end
     end
 
+    def entity_has_role_method
+      return true if entity.respond_to?(self.class.role_method)
+      if Indulgence.strict?
+        raise NoMethodError.new("#{entity} has no role method '#{role_name_method}'. Unable to process #{self.class}")
+      end
+    end
+
     def all
       self.class.all
     end
 
     def none
       self.class.none
-    end 
+    end
+
+    def role_name_method
+      self.class.role_name_method
+    end
     
     def self.ability_cache
       @ability_cache ||= {}

data/lib/indulgence/version.rb

@@ -1,9 +1,13 @@
 module Indulgence
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end
 
 # History
 # =======
+#
+# 0.1.2   Adds strict mode - to allow more flexible use (if a none user object
+#         is passed to indulge?, in strict mode a no method error is raised. When
+#         indulgence.strict = false, indulge? will use the default abilities)
 # 
 # 0.1.1   Makes it easier to use the state of an object to determine permissions
 #         rather than a user's role.

data/lib/indulgence.rb

@@ -5,5 +5,11 @@ require_relative 'indulgence/indulgent'
 require_relative 'active_record/acts/indulgent'
 
 module Indulgence
-    
+  def self.strict?
+    @strict.nil? || @strict
+  end
+
+  def self.strict=(boolean)
+    @strict = boolean
+  end
 end

data/test/units/indulgence/permission_test.rb

@@ -1,5 +1,6 @@
 require_relative '../../test_helper'
 require 'user'
+require 'indulgence'
 require 'permission'
 require 'ability'
 
@@ -30,5 +31,13 @@ module Indulgence
       assert_equal Permission.none, permission.ability
     end
 
+    def test_creation_with_entity_that_does_not_respond_to_role
+      before = Indulgence.strict?
+      Indulgence.strict = false
+      permission = Permission.new([], :read)
+      assert_equal Permission.none, permission.ability
+      Indulgence.strict = before
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indulgence
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rob Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -119,28 +119,28 @@ signing_key:
 specification_version: 4
 summary: Yet another permissions gem
 test_files:
-- test/lib/work_process.rb
+- test/units/role_test.rb
+- test/units/indulgence/permission_test.rb
+- test/units/indulgence/ability_test.rb
+- test/units/indulgence/ability_tests/method_only.rb
+- test/units/indulgence/ability_tests/with_lambdas.rb
+- test/units/user_test.rb
+- test/units/role_permission_test.rb
+- test/units/work_process_test.rb
+- test/units/thing_permission_test.rb
+- test/units/thing_test.rb
 - test/lib/role.rb
-- test/lib/thing_permission.rb
-- test/lib/role_permission.rb
-- test/lib/thing.rb
+- test/lib/work_process.rb
 - test/lib/user.rb
+- test/lib/thing.rb
+- test/lib/thing_permission.rb
 - test/lib/work_process_permission.rb
-- test/db/migrate/20141008101147_create_work_processes.rb
-- test/db/migrate/20130408132217_create_things.rb
-- test/db/migrate/20130408085511_create_users.rb
+- test/lib/role_permission.rb
 - test/db/migrate/20130408103015_create_roles.rb
+- test/db/migrate/20130408085511_create_users.rb
+- test/db/migrate/20130408132217_create_things.rb
+- test/db/migrate/20141008101147_create_work_processes.rb
 - test/db/config.yml
 - test/db/test.sqlite3.db
 - test/db/schema.rb
 - test/test_helper.rb
-- test/units/role_test.rb
-- test/units/thing_test.rb
-- test/units/user_test.rb
-- test/units/work_process_test.rb
-- test/units/role_permission_test.rb
-- test/units/indulgence/permission_test.rb
-- test/units/indulgence/ability_test.rb
-- test/units/indulgence/ability_tests/with_lambdas.rb
-- test/units/indulgence/ability_tests/method_only.rb
-- test/units/thing_permission_test.rb