consul 0.10.0 → 0.10.1

data/README.md

@@ -171,8 +171,8 @@ When a non-admin queries the `:users` power, she will get the following behavior
 
 ### Powers that only check a given object
 
-Sometimes it is not convenient to define powers as a collection. Sometimes you only want to store a method that
-checks whether a given object is accessible.
+Sometimes it is not convenient to define powers as a collection or scope (relation).
+Sometimes you only want to store a method that checks whether a given object is accessible.
 
 To do so, simply define a power that ends in a question mark:
 
@@ -241,20 +241,17 @@ Sometimes it can be useful to define powers that require context. To do so, just
     class Power
       ...
 
-      power :assignable_story_states do |story|
-        if story.finished?
-          %w[delivered archived]
-        else
-          %w[committed started finished]
-        end
+      power :client_notes do |client|
+        client.notes.where(:state => 'published')
       end
       
     end
 
 When querying such a power, you always need to provide the context, e.g.:
 
-    story = ...
-    Power.current.assignable_story_state?(story, 'finished')
+    client = ...
+    note = ...
+    Power.current.client_note?(client, note)
 
 
 ### Optimizing record checks for scope powers
@@ -386,16 +383,32 @@ Because this pattern is so common, there is a shortcut `:crud` to do the same:
     end
 
 
+And if your power [requires context](#powers-that-require-context-arguments) (is parametrized), you can give it using the `:context` method:
+
+    class ClientNotesController < ApplicationController
+
+      power :client_notes, :context => :load_client
+
+      private
+
+      def load_client
+        @client ||= Client.find(params[:client_id])
+      end
+
+    end
+
+
+
 ### Auto-mapping a power scope to a controller method
 
 It is often convenient to map a power scope to a private controller method:
 
     class NotesController < ApplicationController
 
-      power :notes, :as => end_of_association_chain
+      power :notes, :as => note_scope
 
       def show
-        @note = end_of_association_chain.find(params[:id])
+        @note = note_scope.find(params[:id])
       end
 
     end
@@ -403,6 +416,58 @@ It is often convenient to map a power scope to a private controller method:
 This is especially useful when you are using a RESTful controller library like [resource_controller](https://github.com/jamesgolick/resource_controller). The mapped method is aware of the `:map` option.
 
 
+### Multiple power-mappings for nested resources
+
+When using [nested resources](http://guides.rubyonrails.org/routing.html#nested-resources) you probably want two power
+checks and method mappings: One for the parent resource, another for the child resource.
+
+Say you have the following routes:
+
+    resources :clients do
+      resources :notes
+    end
+
+And the following power definitions:
+
+    class Power
+      ...
+
+      power :clients do |client|
+        Client.active if signed_in?
+      end
+
+      power :client_notes do |client|
+        client.notes.where(:state => 'published')
+      end
+
+    end
+
+You can now check and map both powers in the nested `NotesController`:
+
+    class NotesController < ApplicationController
+
+      power :clients, :as => :client_scope
+      power :client_notes, :context => :load_client, :as => :note_scope
+
+      def show
+        load_note
+      end
+
+      private
+
+      def load_client
+        @client ||= client_scope.find(params[:client_id])
+      end
+
+      def load_note
+        @note ||= note_scope.find(params[:id])
+      end
+
+    end
+
+Note how we provide the `Client` parameter for the `:client_notes` power by using the `:context => :load_client`
+option in the `power` directive.
+
 ### How to never forget a power check
 
 You can force yourself to use a `power` check in every controller. This will raise `Consul::UncheckedPower` if you ever forget it:

data/lib/consul/power.rb

@@ -10,8 +10,15 @@ module Consul
     private
 
     def default_include_power?(power_name, *context)
-      # Everything that is not nil is considered as included
-      !!send(power_name, *context)
+      result = send(power_name, *context)
+      # Everything that is not nil is considered as included.
+      # We are short-circuiting for #scoped first since sometimes
+      # has_many associations (which behave scopish) trigger their query
+      # when you try to negate them, compare them or even retrieve their
+      # class. Unfortunately we can only reproduce this in live Rails
+      # apps, not in Consul tests. Might be some standard gem that is not
+      # loaded in Consul tests.
+      result.respond_to?(:scoped) || !!result
     end
 
     def default_include_object?(power_name, *args)

data/lib/consul/version.rb

@@ -1,3 +1,3 @@
 module Consul
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

data/spec/rails-2.3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    consul (0.9.1)
+    consul (0.10.1)
       edge_rider
       memoizer
       rails

data/spec/rails-3.0/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    consul (0.9.1)
+    consul (0.10.1)
       edge_rider
       memoizer
       rails

data/spec/rails-3.2/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    consul (0.9.1)
+    consul (0.10.1)
       edge_rider
       memoizer
       rails

data/spec/shared/consul/power_spec.rb

@@ -94,6 +94,18 @@ describe Consul::Power do
           @user.power.clients?.should be_true
         end
 
+        it 'should not trigger a query if the power returns a scope' do
+          Client.count.should > 0 # show that we have records in the database
+          Client.should_not_receive(:new) # show that no query was triggered by showing that no record was instantiated
+          @user.power.clients?
+        end
+
+        it 'should not trigger a query if the power returns a has many association' do
+          Note.count.should > 0 # show that we have records in the database
+          Note.should_not_receive(:new) # show that no query was triggered by showing that no record was instantiated
+          @user.power.client_notes?(@client1.reload)
+        end
+
       end
 
       context 'with a given record' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: consul
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 0
   - 10
-  - 0
-  version: 0.10.0
+  - 1
+  version: 0.10.1
 platform: ruby
 authors: 
 - Henning Koch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-21 00:00:00 +02:00
+date: 2013-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency