consul 0.3.0 → 0.4.0

data/README.md

@@ -259,7 +259,7 @@ You can not only authorize scalar attributes like strings or integers that way,
     class Power
       ...
 
-      def assignable_story_projects(story)
+      power :assignable_story_projects do |story|
         user.account.projects
       end
     end
@@ -269,6 +269,53 @@ The `authorize_values_for` macro comes with many useful options and details best
     assignable_values_for :field, :through => lambda { Power.current }
 
 
+Testing
+-------
+
+This section Some hints for testing authorization with Consul.
+
+### Test that a controller checks against a power
+
+You can say this in any controller spec:
+
+    describe CakesController do
+
+      it { should check_power(:cakes) }
+
+    end
+
+You can test against all options of the `power` macro:
+
+    describe CakesController do
+
+      it { should check_power(:cakes, :map => { [:edit, :update] => :updatable_cakes }) }
+
+    end
+
+### Temporarily change the current power
+
+When you set `Power.current` to a power in an RSpec example, you must remember to nilify it afterwards. Otherwise other examples will see your global changes.
+
+A better way is to use the `.with_power` method to change the current power for the duration of a block:
+
+    admin = User.new(:role => 'admin')
+    admin_power = Power.new(admin)
+
+    Power.with_power(admin_power) do
+      # run code that uses Power.current
+    end
+
+`Power.current` will be `nil` (or its former value) after the block has ended.
+
+A nice shortcut is that when you call `with_power` with an argument that is not already a `Power`, Consul will instantiate a `Power` for you:
+
+    admin = User.new(:role => 'admin')
+
+    Power.with_power(admin) do
+      # run code that uses Power.current
+    end
+
+
 Installation
 ------------
 
@@ -292,7 +339,7 @@ If you would like to contribute:
 - Push your changes **with specs**.
 - Send me a pull request.
 
-I'm very eager to keep this gem leightweight and on topic. If you're unsure whether a change would make it into the gem, [talk to me beforehand](henning.koch@makandra.de).
+I'm very eager to keep this gem leightweight and on topic. If you're unsure whether a change would make it into the gem, [talk to me beforehand](mailto:henning.koch@makandra.de).
 
 
 Credits

data/Rakefile

@@ -1,12 +1,32 @@
 require 'rake'
-require 'spec/rake/spectask'
 require 'bundler/gem_tasks'
 
 desc 'Default: Run all specs.'
-task :default => :spec
+task :default => 'all:spec'
 
-desc "Run all specs"
-Spec::Rake::SpecTask.new() do |t|
-  t.spec_opts = ['--options', "\"spec/support/spec.opts\""]
-  t.spec_files = FileList['spec/**/*_spec.rb']
+namespace :all do
+
+  desc "Run specs on all spec apps"
+  task :spec do
+    for_each_directory_of('spec/**/Rakefile') do |directory|
+      env = "SPEC=../../#{ENV['SPEC']} " if ENV['SPEC']
+      system("cd #{directory} && #{env} bundle exec rake spec")
+    end
+  end
+
+  desc "Bundle all spec apps"
+  task :bundle do
+    for_each_directory_of('spec/**/Gemfile') do |directory|
+      system("cd #{directory} && bundle install")
+    end
+  end
+
+end
+
+def for_each_directory_of(path, &block)
+  Dir[path].sort.each do |rakefile|
+    directory = File.dirname(rakefile)
+    puts '', "\033[44m#{directory}\033[0m", ''
+    block.call(directory)
+  end
 end

data/consul.gemspec

@@ -15,13 +15,14 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency('memoizer')
   s.add_dependency('rails')
-  s.add_dependency('assignable_values')
 
-  # s.add_development_dependency('assignable_values')
-  s.add_development_dependency('rails', '~>2.3')
-  s.add_development_dependency('rspec', '~>1.3')
-  s.add_development_dependency('rspec-rails', '~>1.3')
-  s.add_development_dependency('shoulda-matchers')
-  s.add_development_dependency('sqlite3')
+  ## s.add_development_dependency('assignable_values')
+  #s.add_development_dependency('assignable_values')
+  #s.add_development_dependency('rails', '~>2.3')
+  #s.add_development_dependency('rspec', '~>1.3')
+  #s.add_development_dependency('rspec-rails', '~>1.3')
+  #s.add_development_dependency('shoulda-matchers')
+  #s.add_development_dependency('sqlite3')
 end

data/lib/consul.rb

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

data/lib/consul/active_record.rb

@@ -4,7 +4,11 @@ module Consul
     private
 
     def authorize_values_for(property, options = {})
-      assignable_values_for property, options.merge(:through => lambda { ::Power.current })
+      if defined?(AssignableValues)
+        assignable_values_for property, options.merge(:through => lambda { ::Power.current })
+      else
+        raise "To use .authorize_values_for, add the gem 'assignable_values' to your Gemfile"
+      end
     end
 
   end

data/lib/consul/controller.rb

@@ -69,17 +69,8 @@ module Consul
 
         before_filter :check_power, filter_options
 
-        private
-
-        define_method :check_power do
-          send(power_method).include!(power_method_for_action)
-        end
-
-        define_method direct_access_method do
-          send(power_method).send(power_method_for_action)
-        end if direct_access_method
-
-        define_method :power_method_for_action do
+        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
@@ -92,6 +83,22 @@ module Consul
           end
         end
 
+        private
+
+        define_method :check_power do
+          send(power_method).include!(power_name_for_current_action)
+        end
+
+        if direct_access_method
+          define_method direct_access_method do
+            send(power_method).send(power_name_for_current_action)
+          end
+        end
+
+        define_method :power_name_for_current_action do
+          self.class.power_name_for_action(action_name)
+        end
+
       end
 
     end

data/lib/consul/errors.rb

@@ -4,4 +4,5 @@ module Consul
   class UncheckedPower < Error; end
   class UnmappedAction < Error; end
   class UnreachablePower < Error; end
+  class NoCollection < Error; end
 end

data/lib/consul/power.rb

@@ -2,19 +2,25 @@ module Consul
   module Power
 
     def self.included(base)
-      base.extend ActiveSupport::Memoizable
       base.extend ClassMethods
+      base.send :include, Memoizer
     end
 
     def include?(name, *args)
       args = args.dup
       record = args.shift
       power_value = send(name)
-      if record.nil? || boolean_or_nil?(power_value)
+      if record.nil?
         !!power_value
       else
-        power_ids_name = self.class.power_ids_name(name)
-        send(power_ids_name, *args).include?(record.id)
+        if scope?(power_value)
+          power_ids_name = self.class.power_ids_name(name)
+          send(power_ids_name, *args).include?(record.id)
+        elsif 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}"
+        end
       end
     end
 
@@ -28,6 +34,14 @@ 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)
@@ -57,6 +71,17 @@ module Consul
 
       attr_accessor :current
 
+      def with_power(inner_power, &block)
+        unless inner_power.is_a?(self)
+          inner_power = new(inner_power)
+        end
+        old_power = current
+        self.current = inner_power
+        block.call
+      ensure
+        self.current = old_power
+      end
+
     end
 
   end

data/lib/consul/version.rb

@@ -1,3 +1,3 @@
 module Consul
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/rails-2.3/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'assignable_values'
+gem 'rails', '~>2.3'
+gem 'rspec', '~>1.3'
+gem 'rspec-rails', '~>1.3'
+gem 'shoulda-matchers'
+gem 'sqlite3'
+gem 'rspec_candy'
+gem 'ruby-debug'
+
+gem 'consul', :path => '../..'

data/spec/rails-2.3/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: Run all specs for a specific rails version.'
+task :default => :spec
+
+desc "Run all specs for a specific rails version"
+Spec::Rake::SpecTask.new() do |t|
+  t.spec_opts = ['--options', "\"spec.opts\""]
+  t.spec_files = defined?(SPEC) ? SPEC : FileList['**/*_spec.rb', '../shared/**/*_spec.rb']
+end

data/spec/{app_root → rails-2.3/app_root}/app/models/power.rb

@@ -6,7 +6,7 @@ class Power
   end
 
   power :clients do
-    Client.active
+    Client.active unless guest?
   end
 
   power :client_notes do |client|
@@ -49,4 +49,28 @@ class Power
     %w[guest admin]
   end
 
+  power :key_figures do
+    %w[amount working_costs] unless guest?
+  end
+
+  power :api_key do
+    'secret-api-key' unless guest?
+  end
+
+  private
+
+  attr_accessor :user
+
+  def role
+    user.role
+  end
+
+  def admin?
+    user.role == 'admin'
+  end
+
+  def guest?
+    user.role == 'guest'
+  end
+
 end

data/spec/{app_root → rails-2.3/app_root}/config/boot.rb

@@ -110,5 +110,19 @@ module Rails
   end
 end
 
+class Rails::Boot
+  def run
+    load_initializer
+
+    Rails::Initializer.class_eval do
+      def load_gems
+        @bundler_loaded ||= Bundler.require :default, Rails.env
+      end
+    end
+
+    Rails::Initializer.run(:set_load_path)
+  end
+end
+
 # All that for this:
 Rails.boot!

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

@@ -0,0 +1,20 @@
+begin
+  require "rubygems"
+  require "bundler"
+rescue LoadError
+  raise "Could not load the bundler gem. Install it with `gem install bundler`."
+end
+
+if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.24")
+  raise RuntimeError, "Your bundler version is too old for Rails 2.3." +
+   "Run `gem install bundler` to upgrade."
+end
+
+begin
+  # Set up load paths for all bundled gems
+  ENV["BUNDLE_GEMFILE"] = File.expand_path("../../Gemfile", __FILE__)
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end

data/spec/rails-2.3/app_root/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/{spec_helper.rb → rails-2.3/spec_helper.rb}

@@ -7,12 +7,15 @@ ENV['RAILS_ENV'] ||= 'in_memory'
 require "#{File.dirname(__FILE__)}/app_root/config/environment"
 require 'spec/rails'
 
-# Load dependencies
-require 'assignable_values'
-require 'shoulda-matchers'
-
-# Load the gem itself
-require "#{File.dirname(__FILE__)}/../lib/consul"
+### Load dependencies
+#require 'memoizer'
+#require 'shoulda-matchers'
+#require 'assignable_values'
+#
+## Load the gem itself
+#require "#{File.dirname(__FILE__)}/../../lib/consul"
+
+require 'rspec_candy/helpers'
 
 # Undo changes to RAILS_ENV
 silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}