allowance 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,50 @@
 # Allowance
 
-TODO: Write a gem description
+Allowance is a general-use permission management library that can be used
+in any framework or application.
+
+A simple Example:
+
+``` ruby
+p = Allowance.define do |can|
+  can.sing!
+  can.play!
+end
+
+p.sing?   # true
+p.play?   # true
+p.dance?  # false
+```
+
+You can specify permissions on objects (and their classes), too:
+
+``` ruby
+p = Allowance.define do |can|
+  # Everyone can view posts that have been published
+  can.view! Post, :published => true
+
+  # Post owners can delete their own posts
+  can.delete! Post, :user_id => current_user.id
+
+  # Admin users can view and delete all posts
+  if current_user.admin?
+    can.view! Post
+    can.delete! Post 
+  end
+end
+```
+
+Instead of condition hashes, you can specify lambdas. This is great for model
+classes that are ActiveModel based (eg. ActiveRecord, Mongoid etc.):
+
+``` ruby
+p = Allowance.define do |can|
+  # Everyone can view posts that have been published
+  can.view! Post, lambda { |posts| posts.visible_posts }
+end
+```
+
+More documentation coming up soon.
 
 ## Installation
 

data/lib/allowance/permissions.rb

@@ -43,7 +43,7 @@ module Allowance
         if p.is_a?(Hash)
           model.where(p)
         elsif p.is_a?(Proc)
-          model.instance_exec(&p)
+          p.call(model)
         else
           model
         end

data/lib/allowance/version.rb

@@ -1,3 +1,3 @@
 module Allowance
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/allowance.rb

@@ -2,4 +2,7 @@ require 'allowance/version'
 require 'allowance/permissions'
 
 module Allowance
+  def self.define(&blk)
+    Permissions.new(&blk)
+  end
 end

data/spec/allowance_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module Allowance
+  describe "#define" do
+    it "should return an instance of Allowance::Permissions" do
+      Allowance.define.should be_kind_of(Allowance::Permissions)
+    end
+
+    it "should make sure the passed block is executed" do
+      p = Allowance.define do |allow|
+        allow.sing!
+      end
+
+      insist p.sing?
+    end
+  end
+end

data/spec/permissions_spec.rb

@@ -21,6 +21,19 @@ module Allowance
       insist p.sing?
     end
 
+    it "should not modify the block's scope" do
+      yup = true
+      nope = false
+
+      p = Permissions.new do |can|
+        can.sing!  if yup
+        can.dance! if nope
+      end
+
+      insist p.sing?
+      refuse p.dance?
+    end
+
     it "should allow verbs and objects" do
       subject.update! SomeClass
 
@@ -46,7 +59,7 @@ module Allowance
 
       model_class.should_receive(:find).and_return(model_instance)
 
-      subject.view! model_class, lambda { some_scope }
+      subject.view! model_class, lambda { |r| r.some_scope }
 
       insist subject.view? model_instance
     end
@@ -56,7 +69,7 @@ module Allowance
         model = mock
         model.should_receive(:some_scope).and_return(scoped_model = mock)
 
-        subject.view! model, lambda { some_scope }
+        subject.view! model, lambda { |r| r.some_scope }
         subject.scoped_model(:view, model).should == scoped_model
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allowance
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-27 00:00:00.000000000 Z
+date: 2012-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70251993567840 !ruby/object:Gem::Requirement
+  requirement: &70168031557120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251993567840
+  version_requirements: *70168031557120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70251993566520 !ruby/object:Gem::Requirement
+  requirement: &70168031554220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251993566520
+  version_requirements: *70168031554220
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &70251993563400 !ruby/object:Gem::Requirement
+  requirement: &70168031553600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251993563400
+  version_requirements: *70168031553600
 description: A generic, but decidedly awesome authorization control layer.
 email:
 - hendrik@mans.de
@@ -63,6 +63,7 @@ files:
 - lib/allowance.rb
 - lib/allowance/permissions.rb
 - lib/allowance/version.rb
+- spec/allowance_spec.rb
 - spec/permissions_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -90,6 +91,7 @@ signing_key:
 specification_version: 3
 summary: A generic, but decidedly awesome authorization control layer.
 test_files:
+- spec/allowance_spec.rb
 - spec/permissions_spec.rb
 - spec/spec_helper.rb
 has_rdoc: