indulgence 0.0.5 → 0.0.6

data/README.rdoc

@@ -24,7 +24,21 @@ Indulgence can be added to a class via acts_as_indulgent:
     end
 
 Used in this way, permissions need to be defined in an Indulgence::Permission
-object called ThingPermission, with an instance method :default
+object called ThingPermission.
+
+    class ThingPermission < Indulgence::Permission
+
+    end
+
+This needs to be available to the Thing class. For example, in a rails app, by
+placing it in app/permissions/thing_permission.rb
+
+=== Default permissions
+
+The Permission class has a default method, that matches all the CRUD actions to 
+the ability *none*.
+
+This behaviour can be overridden by explicitly defining the default method.
 
     class ThingPermission < Indulgence::Permission
 
@@ -39,13 +53,10 @@ object called ThingPermission, with an instance method :default
 
     end
 
-This needs to be available to the Thing class. For example, in a rails app, by
-placing it in app/permissions/thing_permission.rb
-
 == Users and Roles
 
 Indulgence assumes that permissions will be tested against an entity object
-(e.g. User). The default behaviour assumes that the entity object has a :role 
+(e.g. User). The standard behaviour assumes that the entity object has a :role
 method that returns the role object, and that the role object has a :name method. 
 
 So typically, these objects could look like this:
@@ -73,7 +84,7 @@ Simple true/false permission can be determined using the :indulge? method:
     thing = Thing.first
 
     thing.indulge?(user, :create) == false
-    thing.indulge?(user, :read)   == true
+    thing.indulge?(user, :read)   == true      # Note default has be overridden
     thing.indulge?(user, :update) == false
     thing.indulge?(user, :delete) == false
 
@@ -94,8 +105,8 @@ So to find all the blue things that the user has permission to read:
 
 === Adding other roles
 
-Up until now, all users get the same permissions irrespective of role. Let's
-give Emperors the right to see and do anything by first creating an emperor
+Up until now, all users get the same permissions (default) irrespective of role.
+Let's give Emperors the right to see and do anything by first creating an emperor
 
     emperor = Role.create(:name => 'emperor')
     caesar = User.create(

data/lib/indulgence/permission.rb

@@ -14,7 +14,12 @@ module Indulgence
     end
     
     def default
-      raise 'There must always be a default'
+      {
+        create: none,
+        read: none,
+        update: none,
+        delete: none
+      }
     end
     
     def filter_many(things)

data/lib/indulgence/version.rb

@@ -1,9 +1,12 @@
 module Indulgence
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end
 
 # History
 # =======
+#
+# 0.0.6   Specifies the default behaviour as assigning the none ability to
+#         all CRUD actions.
 # 
 # 0.0.5   Allows simplified ability definition to be used with has_many
 # 

data/test/lib/thing_permission.rb

@@ -11,19 +11,10 @@ class ThingPermission < Indulgence::Permission
     }
   end
   
-  
-  def default
-    {
-      create: none,
-      read: all,
-      update: none,
-      delete: none
-    }
-  end
-  
   def god
     {
       create: all,
+      read: all,
       update: all,
       delete: all
     }
@@ -32,6 +23,7 @@ class ThingPermission < Indulgence::Permission
   def demigod
     {
       create: things_they_own,
+      read: all,
       update: things_they_own,
       delete: things_they_own
     }
@@ -39,12 +31,14 @@ class ThingPermission < Indulgence::Permission
   
   def thief
     {
+      read: all,
       update: things_they_stole
     }
   end
   
   def friend
     {
+      read: all,
       update: things_they_borrow
     }
   end

data/test/units/indulgence/permission_test.rb

@@ -6,10 +6,9 @@ require 'ability'
 module Indulgence
   class PermissionTest < Test::Unit::TestCase
     
-    def test_creation_fails_as_methods_undefined_in_parent_class
-      assert_raise RuntimeError do
-        Permission.new(User.create(:name => 'Whisp'), :read)
-      end
+    def test_creation
+      permission = Permission.new(User.create(:name => 'Whisp'), :read)
+      assert_equal Permission.none, permission.default[:read]
     end
     
     def test_define_ability_uses_cache_rather_than_duplicates

data/test/units/thing_permission_test.rb

@@ -25,7 +25,7 @@ class ThingPermissionTest < Test::Unit::TestCase
   
   def test_default_permissions
     assert_equal Permission.none, ThingPermission.new(@user, :create).ability  
-    assert_equal Permission.all, ThingPermission.new(@user, :read).ability 
+    assert_equal Permission.none, ThingPermission.new(@user, :read).ability
     assert_equal Permission.none, ThingPermission.new(@user, :update).ability
     assert_equal Permission.none, ThingPermission.new(@user, :delete).ability 
   end

data/test/units/thing_test.rb

@@ -21,7 +21,7 @@ class ThingTest < Test::Unit::TestCase
   
   def test_indulge
     make_second_thing
-    assert_equal(true, @thing.indulge?(@owner, :read))
+    assert_equal(false, @thing.indulge?(@owner, :read))
     assert_equal(false, @thing.indulge?(@owner, :delete))
     assert_equal(false, @other_thing.indulge?(@owner, :delete))
   end
@@ -66,7 +66,7 @@ class ThingTest < Test::Unit::TestCase
     
   def test_indulge_other_thing
     other_thing = OtherThing.create(:name => 'Other Stuff', :owner => @owner)
-    assert_equal(true, other_thing.indulge?(@owner, :read))
+    assert_equal(false, other_thing.indulge?(@owner, :read))
     assert_equal(false, other_thing.indulge?(@owner, :delete))
   end
   
@@ -74,7 +74,9 @@ class ThingTest < Test::Unit::TestCase
     make_second_thing
     @owner.update_attribute(:role, @demigod)
     assert_equal(Thing.order('id'), Thing.indulgence(@owner, :read).order('id'))
-    assert_equal(Thing.order('id'), Thing.indulgence(@user, :read).order('id'))
+    assert_raise ActiveRecord::RecordNotFound do
+      Thing.indulgence(@user, :read).order('id')
+    end
     assert_equal([@thing], Thing.indulgence(@owner, :delete))
     assert_raise ActiveRecord::RecordNotFound do
       Thing.indulgence(@user, :delete)
@@ -110,7 +112,7 @@ class ThingTest < Test::Unit::TestCase
   
   def test_aliased_compare_single_method
     make_second_thing
-    assert_equal(true, @thing.permit?(@owner, :read))
+    assert_equal(false, @thing.permit?(@owner, :read))
     assert_equal(false, @thing.permit?(@owner, :delete))
     assert_equal(false, @other_thing.permit?(@owner, :delete))
   end
@@ -119,7 +121,9 @@ class ThingTest < Test::Unit::TestCase
     make_second_thing
     @owner.update_attribute(:role, @demigod)
     assert_equal(Thing.order('id'), Thing.permitted(@owner, :read).order('id'))
-    assert_equal(Thing.order('id'), Thing.permitted(@user, :read).order('id'))
+    assert_raise ActiveRecord::RecordNotFound do
+      Thing.permitted(@user, :read).order('id')
+    end
     assert_equal([@thing], Thing.permitted(@owner, :delete))
     assert_raise ActiveRecord::RecordNotFound do
       Thing.permitted(@user, :delete)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indulgence
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord