consul 0.9.1 → 0.10.0

data/lib/consul.rb

@@ -4,5 +4,6 @@ require 'consul/util'
 require 'consul/power/dynamic_access'
 require 'consul/power'
 require 'consul/errors'
+require 'consul/guard'
 require 'consul/controller'
 require 'consul/active_record'

data/lib/consul/controller.rb

@@ -31,6 +31,7 @@ module Consul
         before_filter :unchecked_power, options
       end
 
+      # This is badly named, since it doesn't actually skip the :check_power filter
       def skip_power_check(options = {})
         skip_before_filter :unchecked_power, options
       end
@@ -41,62 +42,26 @@ module Consul
         helper_method :current_power
       end
 
-      def power(*args)
-
-        args_copy = args.dup
-        options = args_copy.extract_options!
-        default_power = args_copy.shift # might be nil
-
-        filter_options = options.slice(:except, :only)
-        skip_power_check filter_options
-
-        power_method = options[:power] || :current_power
-
-        actions_map = (options[:map] || {})
+      def consul_guards
+        @consul_guards ||= []
+      end
 
-        if crud_resource = options[:crud]
-          default_power ||= crud_resource
-          actions_map[[:show, :index]] = crud_resource.to_sym
-          actions_map[[:new, :create]] = "creatable_#{crud_resource}".to_sym
-          actions_map[[:edit, :update]] = "updatable_#{crud_resource}".to_sym
-          actions_map[:destroy] = "destroyable_#{crud_resource}".to_sym
-        end
+      def power(*args)
 
-        direct_access_method = options[:as]
+        guard = Consul::Guard.new(*args)
+        consul_guards << guard
+        skip_power_check guard.filter_options
 
         # Store arguments for testing
-        @consul_power_args = args
-
-        before_filter :check_power, filter_options
-
-        singleton_class.send(:define_method, :power_name_for_action) do |action_name|
-          action_name = action_name.to_s
-          key = actions_map.keys.detect do |actions|
-            Array(actions).collect(&:to_s).include?(action_name)
-          end
-          if key
-            actions_map[key]
-          elsif default_power
-            default_power
-          else
-            raise Consul::UnmappedAction, "Could not map the action ##{action_name} to a power"
-          end
-        end
+        (@consul_power_args ||= []) << args
 
-        private
-
-        define_method :check_power do
-          send(power_method).include_power!(power_name_for_current_action)
-        end
+        before_filter :check_power, guard.filter_options
 
-        if direct_access_method
-          define_method direct_access_method do
-            send(power_method).send(power_name_for_current_action)
+        if guard.direct_access_method
+          define_method guard.direct_access_method do
+            guard.power_value(self, action_name)
           end
-        end
-
-        define_method :power_name_for_current_action do
-          self.class.power_name_for_action(action_name)
+          private guard.direct_access_method
         end
 
       end
@@ -107,6 +72,12 @@ module Consul
 
       private
 
+      define_method :check_power do
+        self.class.send(:consul_guards).each do |guard|
+          guard.ensure!(self, action_name)
+        end
+      end
+
       def unchecked_power
         raise Consul::UncheckedPower, "This controller does not check against a power"
       end

data/lib/consul/errors.rb

@@ -5,5 +5,5 @@ module Consul
   class UnmappedAction < Error; end
   class UnreachablePower < Error; end
   class NoCollection < Error; end
-  class InsufficientContext < Error; end
+  class MissingContext < Error; end
 end

data/lib/consul/guard.rb

@@ -0,0 +1,113 @@
+module Consul
+  class Guard
+
+    class ActionMap
+
+      def initialize(default_power, custom_mappings)
+        @default_power = default_power
+        @map = {}
+        if custom_mappings.present?
+          custom_mappings.each do |action_or_actions, power|
+            Array.wrap(action_or_actions).each do |action|
+              action = action.to_s
+              @map[action] = power
+            end
+          end
+        end
+      end
+
+      def self.crud(resource, custom_map)
+        map = {}
+        map[[:show, :index]] = resource.to_sym
+        map[[:new, :create]] = "creatable_#{resource}".to_sym
+        map[[:edit, :update]] = "updatable_#{resource}".to_sym
+        map[:destroy] = "destroyable_#{resource}".to_sym
+        map = normalize_map(map).merge(normalize_map(custom_map)) # allow people to override the defaults
+        new(resource, map)
+      end
+
+      def self.normalize_map(map)
+        normalized_map = {}
+        if map.present?
+            map.each do |action_or_actions, power|
+            Array.wrap(action_or_actions).each do |action|
+              action = action.to_s
+              normalized_map[action] = power
+            end
+          end
+        end
+        normalized_map
+      end
+
+      def power_name(action_name)
+        action_name = action_name.to_s
+        @map[action_name] || @default_power or raise Consul::UnmappedAction, "Could not map the action ##{action_name} to a power"
+      end
+
+    end
+
+    def initialize(*args)
+
+      args_copy = args.dup
+      @options = args_copy.extract_options!
+
+      default_power = args_copy.shift # might be nil
+
+      custom_action_mappings = @options[:map]
+
+      if @options[:crud]
+        @map = ActionMap.crud(@options[:crud], custom_action_mappings)
+      else
+        @map = ActionMap.new(default_power, custom_action_mappings)
+      end
+
+    end
+
+    def power_value(controller, action_name)
+      repository(controller).send(*power_name_with_context(controller, action_name))
+    end
+
+    def ensure!(controller, action_name)
+      repository(controller).include_power!(*power_name_with_context(controller, action_name))
+    end
+
+    def filter_options
+      @options.slice(:except, :only)
+    end
+
+    def direct_access_method
+      @options[:as]
+    end
+
+    private
+
+    def power_name(action_name)
+      @map.power_name(action_name)
+    end
+
+    def power_name_with_context(controller, action_name)
+      [power_name(action_name), *context(controller)]
+    end
+
+    def repository(controller)
+      controller.send(repository_method)
+    end
+
+    def repository_method
+      @options[:power] || :current_power
+    end
+
+    def context(controller)
+      context = []
+      Array.wrap(@options[:context]).each do |context_method|
+        arg = controller.send(context_method)
+        if arg.nil?
+          raise Consul::MissingContext
+        end
+        context << arg
+      end
+      context
+    end
+
+  end
+end

data/lib/consul/spec/matchers.rb

@@ -11,7 +11,7 @@ module Consul
         def matches?(controller)
           @controller_class = controller.class
           @actual_args = @controller_class.instance_variable_get('@consul_power_args')
-          @actual_args == @expected_args
+          @actual_args.present? && @actual_args.include?(@expected_args)
         end
 
         def failure_message

data/lib/consul/version.rb

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

data/spec/rails-2.3/Gemfile.lock

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

data/spec/rails-2.3/app_root/config/routes.rb

@@ -10,4 +10,12 @@ ActionController::Routing::Routes.draw do |map|
 
   map.resources :cakes, :member => { :custom_action => :get }
 
+  map.resources :colors
+
+  map.resources :notes
+
+  map.resources :clients do
+    map.resources :notes
+  end
+
 end

data/spec/rails-3.0/Gemfile.lock

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

data/spec/rails-3.2/Gemfile.lock

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

data/spec/shared/app_root/app/controllers/application_controller.rb

@@ -7,7 +7,6 @@ class ApplicationController < ActionController::Base
     Power.new(User.new)
   end
 
-
   private
 
   def render_nothing

data/spec/shared/app_root/app/controllers/client_notes_controller.rb

@@ -0,0 +1,13 @@
+class ClientNotesController < ApplicationController
+
+  power :clients, :as => :client_scope
+
+  power :client_notes, :context => :client, :as => :note_scope
+
+  private
+
+  def client
+    @client ||= client_scope.find(params[:client_id])
+  end
+
+end

data/spec/shared/app_root/app/controllers/colors_controller.rb

@@ -0,0 +1,10 @@
+class ColorsController < ApplicationController
+
+  power :red, :as => :red_scope
+  power :blue, :as => :blue_scope
+
+  def show
+    render_nothing
+  end
+
+end

data/spec/shared/app_root/app/models/power.rb

@@ -1,8 +1,9 @@
 class Power
   include Consul::Power
 
-  def initialize(user = nil)
-    @user = user
+  def initialize(*args)
+    @options = args.extract_options!
+    @user = args.first
   end
 
   power :clients do
@@ -105,6 +106,14 @@ class Power
     'deal_items power'
   end
 
+  power :red do
+    'red' if @options[:red]
+  end
+
+  power :blue do
+    'blue' if @options[:blue]
+  end
+
   private
 
   attr_accessor :user

data/spec/shared/consul/controllers/client_notes_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ClientNotesController, :type => :controller do
+
+  it 'should map powers with context' do
+    @client1 = Client.create!
+    @client1_note1 = @client1.notes.create!
+    @client2 = Client.create!
+    @client2_note1 = @client2.notes.create!
+    controller.stub(
+      :current_power => Power.new,
+      :client => @client1
+    )
+    controller.send(:note_scope).to_a.should == [@client1_note1]
+  end
+
+  it 'should fail if a context is missing' do
+    controller.stub(
+      :current_power => Power.new,
+      :client => nil
+    )
+    expect { controller.send(:note_scope) }.to raise_error(Consul::MissingContext)
+  end
+
+end

data/spec/shared/consul/controllers/colors_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ColorsController, :type => :controller do
+
+  it "should allow multiple .power directives" do
+    controller.stub :current_power => Power.new(:red => true, :blue => false)
+    expect { get :show, :id => '1' }.to raise_error(Consul::Powerless)
+    controller.stub :current_power => Power.new(:red => false, :blue => true)
+    expect { get :show, :id => '1' }.to raise_error(Consul::Powerless)
+    controller.stub :current_power => Power.new(:red => true, :blue => true)
+    expect { get :show, :id => '1' }.to_not raise_error
+  end
+
+  it 'should be able to map multiple powers to methods' do
+    controller.stub :current_power => Power.new(:red => true, :blue => false)
+    controller.send(:red_scope).should == 'red'
+    controller.send(:blue_scope).should be_nil
+    controller.stub :current_power => Power.new(:red => false, :blue => true)
+    controller.send(:red_scope).should be_nil
+    controller.send(:blue_scope).should == 'blue'
+  end
+
+  it 'should make a mapped power method private' do
+    controller.stub :current_power => Power.new
+    expect { controller.red_scope }.to raise_error(NoMethodError)
+    expect { controller.send(:red_scope) }.to_not raise_error
+  end
+
+end

data/spec/shared/consul/controllers/users_controller_spec.rb

@@ -11,15 +11,15 @@ describe UsersController, :type => :controller do
   end
 
 
-  describe '.power_name_for_action' do
-
-    it 'should return the name of the power for the given action (feature request from devolute)' do
-      UsersController.power_name_for_action(:show).should == :always_true
-      UsersController.power_name_for_action('show').should == :always_true
-      UsersController.power_name_for_action(:update).should == :always_false
-      UsersController.power_name_for_action('update').should == :always_false
-    end
-
-  end
+  #describe '.power_name_for_action' do
+  #
+  #  it 'should return the name of the power for the given action (feature request from devolute)' do
+  #    UsersController.power_name_for_action(:show).should == :always_true
+  #    UsersController.power_name_for_action('show').should == :always_true
+  #    UsersController.power_name_for_action(:update).should == :always_false
+  #    UsersController.power_name_for_action('update').should == :always_false
+  #  end
+  #
+  #end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: consul
 version: !ruby/object:Gem::Version 
-  hash: 57
+  hash: 55
   prerelease: 
   segments: 
   - 0
-  - 9
-  - 1
-  version: 0.9.1
+  - 10
+  - 0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Henning Koch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-26 00:00:00 +02:00
+date: 2013-08-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,6 +79,7 @@ files:
 - lib/consul/active_record.rb
 - lib/consul/controller.rb
 - lib/consul/errors.rb
+- lib/consul/guard.rb
 - lib/consul/power.rb
 - lib/consul/power/dynamic_access.rb
 - lib/consul/spec/matchers.rb
@@ -144,6 +145,8 @@ files:
 - spec/rails-3.2/spec/spec_helper.rb
 - spec/shared/app_root/app/controllers/application_controller.rb
 - spec/shared/app_root/app/controllers/cakes_controller.rb
+- spec/shared/app_root/app/controllers/client_notes_controller.rb
+- spec/shared/app_root/app/controllers/colors_controller.rb
 - spec/shared/app_root/app/controllers/dashboards_controller.rb
 - spec/shared/app_root/app/controllers/risks_controller.rb
 - spec/shared/app_root/app/controllers/songs_controller.rb
@@ -161,12 +164,14 @@ files:
 - spec/shared/app_root/db/migrate/004_create_songs.rb
 - spec/shared/consul/active_record_spec.rb
 - spec/shared/consul/controllers/cakes_controller_spec.rb
+- spec/shared/consul/controllers/client_notes_controller_spec.rb
+- spec/shared/consul/controllers/colors_controller_spec.rb
 - spec/shared/consul/controllers/dashboards_controller_spec.rb
 - spec/shared/consul/controllers/risks_controller_spec.rb
 - spec/shared/consul/controllers/songs_controller_spec.rb
 - spec/shared/consul/controllers/users_controller_spec.rb
-- spec/shared/consul/controllers/util_spec.rb
 - spec/shared/consul/power_spec.rb
+- spec/shared/consul/util_spec.rb
 has_rdoc: true
 homepage: https://github.com/makandra/consul
 licenses: