allowy 0.2.6 → 0.3.0

data/README.md

@@ -103,6 +103,33 @@ class PagesController < ApplicationController
 end
 ```
 
+
+## Customising access class
+
+The "access" class, by convention, will be determined by the class of the original object plus the "Access" suffix.
+It may be a problem if you decorate the class using `draper` gem or using similar approach where the actual class name is different.
+
+The version `0.3` of has built-in support for the `draper` gem and it should "just work".
+
+But additionally it provides a customisation option for you if you need that.
+
+So if you need to change the access class for your object you need to do the following:
+
+
+```ruby
+# This will just work provided there's a PageAccess class
+class PageDecorator < Draper::Decorator
+end
+
+class PageViewModel < SimpleDelegator
+  # This will allow using PageViewModel as it would be just Page
+  def self.source_class
+    Page
+  end
+end
+
+```
+
 ## More comprehensive example
 
 You probably have multiple classes that you want to protect.

data/lib/allowy/access_control.rb

@@ -1,6 +1,6 @@
 module Allowy
   # This module provides the interface for implementing the access control actions.
-  # In order to use it, mix it into a poor Ruby class and define methods ending with `?`.
+  # In order to use it, mix it into a plain Ruby class and define methods ending with `?`.
   # For example:
   #
   #   @example
@@ -10,6 +10,7 @@ module Allowy
   #     def view?(page)
   #       page and page.wiki? and context.user_signed_in?
   #     end
+  #   end
   #
   # And then you can check the permissions from a controller:
   #
@@ -20,17 +21,20 @@ module Allowy
   #   end
   #
   #
-  # You can also check the permissions outside of the controller, but you need a similar `Allowy::Context` class:
+  # You can also check the permissions outside of the controller, but you need an object that
+  # includes `Allowy::Context` class:
   #
   #   @example
   #   class CucumberContext
   #     include Allowy::Context
   #     attr_accessor :current_user
+  #
   #     def initialize(user)
   #       @current_user = user
   #     end
   #   end
   #
+  #   CucumberContext.new(that_user).can?(:create, Blog)
   #   CucumberContext.new(that_user).should be_able_to :create, Blog
   #
   module AccessControl

data/lib/allowy/context.rb

@@ -2,11 +2,11 @@ module Allowy
 
   # This module provides the default and common context for checking the permissions.
   # It is mixed into controllers in Rails by default and provides an easy way to reuse it
-  # in other parts of the application (in RSpec or Cucumber) without needing a controller.
+  # in other parts of the application (RSpec, Cucumber or standalone).
   # For example, you can use this code in your Cucumber features:
   #
   #   @example
-  #   class CustomContext
+  #   class CucumberContext
   #     include Allowy::Context
   #     attr_accessor :current_user
   #
@@ -17,7 +17,8 @@ module Allowy
   # And then you can easily check the permissions like so:
   #
   #   @example
-  #   CustomContext.new(that_user).should be_able_to :create, Blog
+  #   CucumberContext.new(that_user).can?(:create, Blog)
+  #   CucumberContext.new(that_user).should be_able_to :create, Blog
   module Context
     extend ActiveSupport::Concern
 

data/lib/allowy/registry.rb

@@ -13,8 +13,12 @@ module Allowy
 
     def access_control_for(subject)
       return unless subject
+
+      # Try subject as decorated object
+      clazz = class_for "#{subject.class.source_class.name}Access" if subject.class.respond_to?(:source_class)
+
       # Try subject as an object
-      clazz = class_for "#{subject.class.name}Access"
+      clazz = class_for "#{subject.class.name}Access" unless clazz
 
       # Try subject as a class
       clazz = class_for "#{subject.name}Access" if !clazz && subject.is_a?(Class)
@@ -25,7 +29,7 @@ module Allowy
     end
 
     def class_for(name)
-      name.constantize rescue nil #TODO: Handle just the NameError
+      name.safe_constantize
     end
 
   end

data/lib/allowy/version.rb

@@ -1,3 +1,3 @@
 module Allowy
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/spec/registry_spec.rb

@@ -31,6 +31,16 @@ module Allowy
         first.should === secnd
       end
 
+      it "should support objects that provide source_class method (such as Draper)" do
+        decorator_class = Class.new do
+          def self.source_class
+            Sample
+          end
+        end
+        decorated_object = decorator_class.new
+        subject.access_control_for!(decorated_object).should be_a SampleAccess
+      end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allowy
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n