consul 0.4.2 → 0.5.0

data/README.md

@@ -141,6 +141,21 @@ You can query it like any other power. E.g. if a non-admin queries this power sh
     power.assignable_note_state!('published') # => raises Consul::Powerless
 
 
+Defining multiple powers at once
+--------------------------------
+
+You can define multiple powers at once by giving multiple power names:
+
+    class Power
+      ...
+
+      power :destroyable_users, updatable_users do
+        User if admin?
+      end
+
+    end
+
+
 Role-based permissions
 ----------------------
 

data/lib/consul.rb

@@ -1,4 +1,5 @@
 require 'memoizer'
+require 'consul/util'
 require 'consul/power'
 require 'consul/errors'
 require 'consul/controller'

data/lib/consul/power.rb

@@ -13,12 +13,17 @@ module Consul
       if record.nil?
         !!power_value
       else
+        # record is given
         if power_value.nil?
           false
-        elsif scope?(power_value)
-          power_ids_name = self.class.power_ids_name(name)
-          send(power_ids_name, *args).include?(record.id)
-        elsif collection?(power_value)
+        elsif Util.scope?(power_value)
+          if Util.scope_selects_all_records?(power_value)
+            true
+          else
+            power_ids_name = self.class.power_ids_name(name)
+            send(power_ids_name, *args).include?(record.id)
+          end
+        elsif Util.collection?(power_value)
           power_value.include?(record)
         else
           raise Consul::NoCollection, "can only call #include? on a collection, but power was of type #{power_value.class.name}"
@@ -36,35 +41,12 @@ module Consul
       [TrueClass, FalseClass, NilClass].include?(value.class)
     end
 
-    def scope?(value)
-      value.respond_to?(:scoped)
-    end
-
-    def collection?(value)
-      value.is_a?(Array) || value.is_a?(Set)
-    end
-
     module ClassMethods
 
-      def power(name, &block)
-        define_method(name, &block)
-        define_method("#{name.to_s}?") { |*args| include?(name, *args) }
-        define_method("#{name.to_s}!") { |*args| include!(name, *args) }
-        define_method("#{name.to_s.singularize}?") { |*args| include?(name, *args) }
-        define_method("#{name.to_s.singularize}!") { |*args| include!(name, *args) }
-        ids_method = power_ids_name(name)
-        define_method(ids_method) do |*args|
-          scope = send(name, *args)
-          scope = scope.scoped(:select => "`#{scope.table_name}`.`id`")
-          query = if scope.respond_to?(:to_sql)
-            scope.to_sql
-          else
-            scope.construct_finder_sql({})
-          end
-          ::ActiveRecord::Base.connection.select_values(query).collect(&:to_i)
+      def power(*names, &block)
+        names.each do |name|
+          define_power(name, &block)
         end
-        memoize ids_method
-        name
       end
 
       def power_ids_name(name)
@@ -84,6 +66,25 @@ module Consul
         self.current = old_power
       end
 
+      private
+
+      def define_power(name, &block)
+        define_method(name, &block)
+        define_method("#{name.to_s}?") { |*args| include?(name, *args) }
+        define_method("#{name.to_s}!") { |*args| include!(name, *args) }
+        define_method("#{name.to_s.singularize}?") { |*args| include?(name, *args) }
+        define_method("#{name.to_s.singularize}!") { |*args| include!(name, *args) }
+        ids_method = power_ids_name(name)
+        define_method(ids_method) do |*args|
+          scope = send(name, *args)
+          scope = scope.scoped(:select => "`#{scope.table_name}`.`id`")
+          query = Util.scope_to_sql(scope)
+          ::ActiveRecord::Base.connection.select_values(query).collect(&:to_i)
+        end
+        memoize ids_method
+        name
+      end
+
     end
 
   end

data/lib/consul/util.rb

@@ -0,0 +1,39 @@
+module Consul
+  module Util
+    extend self
+
+    def scope_to_sql(scope)
+      if scope.respond_to?(:to_sql)
+        scope.to_sql
+      else
+        scope.send(:construct_finder_sql, {})
+      end
+    end
+
+    def scope_selects_all_records?(scope)
+      scope = scope.scoped({})
+      scope_sql = scope_to_sql(scope)
+      quoted_table_name = Regexp.quote(scope.connection.quote_table_name(scope.table_name))
+      all_sql_pattern = /\ASELECT (#{quoted_table_name}\.)?\* FROM #{quoted_table_name}\z/
+      scope_sql.squish =~ all_sql_pattern
+    end
+
+    def scope?(value)
+      value.respond_to?(:scoped)
+    end
+
+    def collection?(value)
+      value.is_a?(Array) || value.is_a?(Set)
+    end
+
+    def define_scope(klass, name, options)
+      if Rails.version.to_i < 3
+        klass.send(:named_scope, name, options)
+      else
+        klass.send(:scope, name, options)
+      end
+    end
+
+  end
+end
+

data/lib/consul/version.rb

@@ -1,3 +1,3 @@
 module Consul
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/spec/rails-2.3/spec/spec_helper.rb

@@ -3,6 +3,8 @@ $: << File.join(File.dirname(__FILE__), "/../../lib" )
 # Set the default environment to sqlite3's in_memory database
 ENV['RAILS_ENV'] = 'in_memory'
 
+FileUtils.rm(Dir.glob("db/*.db"), :force => true)
+
 # Load the Rails environment and testing framework
 require "#{File.dirname(__FILE__)}/../app_root/config/environment"
 require 'spec/rails'

data/spec/rails-3.0/spec/spec_helper.rb

@@ -4,14 +4,14 @@ $: << File.join(File.dirname(__FILE__), "/../../lib" )
 ENV['RAILS_ENV'] ||= 'test'
 ENV['RAILS_ROOT'] = 'app_root'
 
+FileUtils.rm(Dir.glob("db/*.db"), :force => true)
+
 # Load the Rails environment and testing framework
 require "#{File.dirname(__FILE__)}/../app_root/config/environment"
 require 'rspec/rails'
 
 require 'rspec_candy/helpers'
 
-FileUtils.rm(Dir.glob("#{Rails.root}/db/*.db"), :force => true)
-
 # Run the migrations
 print "\033[30m" # dark gray text
 ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")

data/spec/rails-3.2/spec/spec_helper.rb

@@ -3,7 +3,7 @@ $: << File.join(File.dirname(__FILE__), "/../../lib" )
 ENV['RAILS_ENV'] ||= 'test'
 ENV['RAILS_ROOT'] = 'app_root'
 
-FileUtils.rm(Dir.glob("#{ENV['RAILS_ROOT']}/db/*.db"), :force => true)
+FileUtils.rm(Dir.glob("db/*.db"), :force => true)
 
 # Load the Rails environment and testing framework
 require "#{File.dirname(__FILE__)}/../app_root/config/environment"
@@ -13,7 +13,6 @@ require 'rspec/rails'
 
 require 'rspec_candy/helpers'
 
-
 # Run the migrations
 print "\033[30m" # dark gray text
 ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")

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

@@ -9,6 +9,10 @@ class Power
     Client.active unless guest?
   end
 
+  power :all_clients do
+    Client
+  end
+
   power :client_notes do |client|
     client.notes
   end
@@ -57,6 +61,18 @@ class Power
     'secret-api-key' unless guest?
   end
 
+  power :shorthand1, :shorthand2, :shorthand3 do
+    'shorthand'
+  end
+
+  power :songs do
+    Song
+  end
+
+  power :recent_songs do
+    Song.recent
+  end
+
   private
 
   attr_accessor :user

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

@@ -0,0 +1,7 @@
+class Song < ActiveRecord::Base
+
+  default_scope :conditions => { :trashed => true }
+
+  Consul::Util.define_scope(self, :recent, :conditions  => ['created_at > ?', 1.week.ago])
+
+end

data/spec/shared/app_root/db/migrate/004_create_songs.rb

@@ -0,0 +1,14 @@
+class CreateSongs < ActiveRecord::Migration
+
+  def self.up
+    create_table :songs do |t|
+      t.boolean :trashed
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :songs
+  end
+
+end

data/spec/shared/consul/power_spec.rb

@@ -112,6 +112,26 @@ describe Consul::Power do
           @user.power.client?(@deleted_client)
         end
 
+        it 'should trigger a query if the scope defines a condition' do
+          ActiveRecord::Base.connection.should_receive(:select_values).and_return([])
+          @user.power.client?(@client1)
+        end
+
+        it 'should not trigger a query if the scope defines no conditions' do
+          ActiveRecord::Base.connection.should_not_receive(:select_values)
+          @user.power.all_client?(@client1)
+        end
+
+        it 'should always trigger a query if a returned model has a default scope, even if it defines no additional conditions' do
+          ActiveRecord::Base.connection.should_receive(:select_values).and_return([])
+          @user.power.song?(Song.new)
+        end
+
+        it 'should trigger query if a returned model has a default scope and defines additional conditions' do
+          ActiveRecord::Base.connection.should_receive(:select_values).and_return([])
+          @user.power.recent_song?(Song.new)
+        end
+
       end
 
     end
@@ -351,6 +371,16 @@ describe Consul::Power do
 
   end
 
+  describe '.power' do
+
+    it 'should allow to define multiple powers at once' do
+      @user.power.shorthand1.should == 'shorthand'
+      @user.power.shorthand2.should == 'shorthand'
+      @user.power.shorthand3.should == 'shorthand'
+    end
+
+  end
+
   describe '.current' do
 
     it 'should provide a class method to set and get the current Power' do

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Henning Koch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-14 00:00:00 +01:00
+date: 2013-01-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,7 @@ files:
 - lib/consul/errors.rb
 - lib/consul/power.rb
 - lib/consul/spec/matchers.rb
+- lib/consul/util.rb
 - lib/consul/version.rb
 - spec/rails-2.3/Gemfile
 - spec/rails-2.3/Rakefile
@@ -131,10 +132,12 @@ files:
 - spec/shared/app_root/app/models/client.rb
 - spec/shared/app_root/app/models/note.rb
 - spec/shared/app_root/app/models/power.rb
+- spec/shared/app_root/app/models/song.rb
 - spec/shared/app_root/app/models/user.rb
 - spec/shared/app_root/db/migrate/001_create_users.rb
 - spec/shared/app_root/db/migrate/002_create_clients.rb
 - spec/shared/app_root/db/migrate/003_create_notes.rb
+- 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/dashboards_controller_spec.rb
@@ -172,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.9.4
+rubygems_version: 1.3.9.5
 signing_key: 
 specification_version: 3
 summary: A scope-based authorization solution for Ruby on Rails.