indulgence 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTA1YTM4YmFhMGUzMTIxNzYwOWQ4YzYzZTM3NmRhNjc2YjY3NzdiZQ==
+    NGZlMzlkNTA5ZjYyN2RmNjMxMjJkODc4MzY3ZDEyYWUwNmIxMTg5OA==
   data.tar.gz: !binary |-
-    OGNkZDE1ZDk0ZGE4ZjcyZTQzYjlhZGQxNTczOTVhMjY2ZTRlZTYyNg==
+    MWI5NDhhZjljNGJlNTI0MGNmNGRhN2RjNjc0M2Y1MjkxOGVkOWE4Mw==
 SHA512:
   metadata.gz: !binary |-
-    ZjNmNGMyZWEyNWIyNmRlYTJjMTcxODVkMGQ2ZWM0ODVmZGJhZTcyZWZmYzNi
-    ZTFlMTg2ODVmNzY4NDgzMzM1Y2NmN2Q0Mzc3NzM0NDBmMDEzNDYwZTc0ZGVk
-    YzY2ZWI2NzQ5ZDk3MjM3OWViNjNiYmQ0ZGNiNGM5NDA2OWNjMWU=
+    Mjk3YmNkZDQ1NmI4YzQ3YTk3ZjUzYjlmNmY5MzBjMTk4NTdkZmExYzRmNWI1
+    YzRhZDE5ZjBmYzQ4YTY2YmQwZjg3Y2Y2YmQ0OWI0ODY3ZTZhZjlkZjBmNjU5
+    MzA5YWQzNWVmNzkyZmIzZWQwYjZlOTI3YmUxMzAxNzYwNzNjMjE=
   data.tar.gz: !binary |-
-    NTg5ODNkMmJiYTllM2M5NjU5ODg3ODcxYzdmY2M1NTc2NTBiZGQ4YmI2NjY3
-    ZjM1YWY1OWZlMDY5NTdiMjE1NjBiMGFiYzcwYjA1MDBhNjZjNTI2MzMwYzdi
-    NGFiYzhkMWRiZDE0ZTYwMjZiMjhlYjE5ZWU0YWFlNDRmMGQ5NDA=
+    NGYwZGE1N2I1Y2RjNGJkYzg4ODUzZWZlZGU0ODgwYTllNDg0NGYzNWQ5ZGQz
+    OWY2OWNmOTc0ZjQzOTE4MjA5NDZkOWZjNjQzYzE0ZTVlOTYxNDE4YWJkYzNl
+    ZTMyMmU4M2U0M2FjYzUxNjEzMGJiN2FjODRkOGI0MDYzYjlhYjA=

data/README.rdoc

@@ -380,6 +380,81 @@ Indulgence falls back to the *none* ability if _nil_ is passed as the entity.
     thing.indule?(nil, :read) == false
     Thing.indulgence(nil, :read) --> raises ActiveRecord::RecordNotFound
 
+== Basing permissions on an object's state rather than a user's role
+
+A work process goes through a number of stages. Instead of permissions needing
+to change depending on a user's role, it may be required that permissions 
+are dependent of the process stage. To achieve this, the association between
+the host object and it's permission class would need to change. Rather than
+associating the work process to its permission via acts_as_indulgent, the
+indulge? and indulgence methods would need to be created directly:
+
+    class WorkProcess < ActiveRecord::Base
+
+      def indulge?(user, ability)
+        permission = WorkProcessPermission.new(user, ability, self.stage)
+        permission.compare_single self
+      end
+
+      def self.indulgence(user, ability, stage_name)
+        permission = WorkProcessPermission.new(user, ability, stage_name)
+        permission.filter_many(self).where(:stage => stage_name)
+
+      rescue Indulgence::NotFoundError, Indulgence::AbilityNotFound
+        raise ActiveRecord::RecordNotFound.new('Unable to find the item(s) you were looking for')
+      end
+
+    end
+
+With that in place, abilities would need to defined by each stage name rather
+than each user role. So:
+
+    class WorkProcessPermission < Indulgence::Permission
+
+      def abilities
+        {
+          beginning: beginning,
+          middle: middle,
+          finish: finish
+        }
+      end
+
+      def beginning
+        {
+          create: all,
+          read: all,
+          update: none,
+          delete: all
+        }
+      end
+
+      def middle
+        {
+          create: none,
+          read: all,
+          update: all,
+          delete: all
+        }
+      end
+
+      def finish
+        {
+          create: none,
+          read: all,
+          update: none,
+          delete: none
+        }
+      end
+
+    end
+
+With that in place:
+
+    work_process = WorkProcess.create(stage: 'beginning')
+    work_process.indulge?(user, :create) == true
+    work_process.indulge?(user, :update) == false
+    WorkProcess.indulgence(user, :create, :beginning) == [work_process]
+
 == Examples
 
 For some examples, have a look at the tests. In particular, look at the object

data/Rakefile

@@ -11,3 +11,10 @@ end
 require 'standalone_migrations'
 StandaloneMigrations::Tasks.load_tasks
 
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'indulgence' 
+  ARGV.clear
+  IRB.start
+end

data/lib/indulgence/permission.rb

@@ -2,9 +2,10 @@ module Indulgence
   class Permission
     attr_reader :entity, :ability
 
-    def initialize(entity, ability)
+    def initialize(entity, ability, role_method = nil)
       self
       @entity = entity
+      @role_name = role_method.to_sym if role_method
       @ability = abilities_for_role[ability]
       raise AbilityNotFound, "Unable to find an ability called #{ability}" unless @ability
     end

data/lib/indulgence/version.rb

@@ -1,9 +1,12 @@
 module Indulgence
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end
 
 # History
 # =======
+# 
+# 0.1.1   Makes it easier to use the state of an object to determine permissions
+#         rather than a user's role.
 #
 # 0.1.0   Handles a nil entity being passed to either indulge? or indulgence.
 #         Code now tried and tested in a number of applications, so

data/test/db/migrate/20141008101147_create_work_processes.rb

@@ -0,0 +1,9 @@
+class CreateWorkProcesses < ActiveRecord::Migration
+  def change
+    create_table :work_processes do |t|
+      t.string :name
+      t.string :stage
+      t.timestamps
+    end
+  end
+end

data/test/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20130408132217) do
+ActiveRecord::Schema.define(:version => 20141008101147) do
 
   create_table "roles", :force => true do |t|
     t.string   "name"
@@ -33,4 +33,11 @@ ActiveRecord::Schema.define(:version => 20130408132217) do
     t.datetime "updated_at", :null => false
   end
 
+  create_table "work_processes", :force => true do |t|
+    t.string   "name"
+    t.string   "stage"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
 end

data/test/lib/work_process.rb

@@ -0,0 +1,17 @@
+require 'indulgence'
+class WorkProcess < ActiveRecord::Base
+  
+  def indulge?(user, ability)
+    permission = WorkProcessPermission.new(user, ability, stage)
+    permission.compare_single self
+  end
+
+  def self.indulgence(user, ability, stage_name)
+    permission = WorkProcessPermission.new(user, ability, stage_name)
+    permission.filter_many(self).where(:stage => stage_name)
+
+  rescue Indulgence::NotFoundError, Indulgence::AbilityNotFound
+    raise ActiveRecord::RecordNotFound.new('Unable to find the item(s) you were looking for')
+  end
+
+end

data/test/lib/work_process_permission.rb

@@ -0,0 +1,40 @@
+require 'indulgence'
+
+class WorkProcessPermission < Indulgence::Permission
+  
+  def abilities
+    {
+      beginning: beginning,
+      middle: middle,
+      finish: finish
+    }
+  end
+  
+  def beginning
+    {
+      create: all,
+      read: all,
+      update: none,
+      delete: all
+    }
+  end
+  
+  def middle
+    {
+      create: none,
+      read: all,
+      update: all,
+      delete: all
+    }
+  end
+  
+  def finish
+    {
+      create: none,
+      read: all,
+      update: none,
+      delete: none
+    }
+  end
+  
+end

data/test/units/work_process_test.rb

@@ -0,0 +1,79 @@
+require_relative '../test_helper'
+require 'user'
+require 'work_process'
+require 'work_process_permission'
+
+class WorkProcessTest < Test::Unit::TestCase
+  
+  def teardown
+    User.delete_all
+    WorkProcess.delete_all
+  end
+  
+  def test_indulge_beginning
+    {
+      create: true,
+      read: true,
+      update: false,
+      delete: true
+    }.each do |ability, expected|
+    
+    assert_equal(
+      expected, 
+      beginning_process.indulge?(user, ability),
+      "User should #{'not ' unless expected}be able to #{ability}"
+    )
+    end
+  end
+  
+  def test_indulge_middle
+    {
+      create: false,
+      read: true,
+      update: true,
+      delete: true
+    }.each do |ability, expected|
+    
+    assert_equal(
+      expected, 
+      middle_process.indulge?(user, ability),
+      "User should #{'not ' unless expected}be able to #{ability}"
+    )
+      
+    end
+  end
+  
+  def test_indulgence
+    expected = [beginning_process]
+    assert_equal expected, WorkProcess.indulgence(user, :create, :beginning)
+  end
+  
+  def test_indulgence_when_not_permitted
+    assert_raise ActiveRecord::RecordNotFound do
+      WorkProcess.indulgence(user, :update, :beginning)
+    end
+  end
+  
+  def user
+    @user ||= User.create(:name => 'Bob')
+  end
+  
+  def beginning_process
+    @beginning_process ||= create_process(:beginning)
+  end
+  
+  def middle_process
+    @middle_process ||= create_process(:middle)
+  end
+  
+  def finist_process
+    @finish_process ||= create_process(:finist)
+  end
+  
+  def create_process(stage)
+    WorkProcess.create(
+      name: "#{stage} process",
+      stage: stage.to_s
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indulgence
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rob Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -59,37 +59,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
 - lib/active_record/acts/indulgent.rb
-- lib/indulgence/version.rb
+- lib/indulgence.rb
+- lib/indulgence/ability.rb
 - lib/indulgence/exceptions.rb
 - lib/indulgence/indulgent.rb
-- lib/indulgence/ability.rb
 - lib/indulgence/permission.rb
-- lib/indulgence.rb
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
-- test/units/role_test.rb
-- test/units/indulgence/permission_test.rb
+- lib/indulgence/version.rb
+- test/db/config.yml
+- test/db/migrate/20130408085511_create_users.rb
+- test/db/migrate/20130408103015_create_roles.rb
+- test/db/migrate/20130408132217_create_things.rb
+- test/db/migrate/20141008101147_create_work_processes.rb
+- test/db/schema.rb
+- test/db/test.sqlite3.db
+- test/lib/role.rb
+- test/lib/role_permission.rb
+- test/lib/thing.rb
+- test/lib/thing_permission.rb
+- test/lib/user.rb
+- test/lib/work_process.rb
+- test/lib/work_process_permission.rb
+- test/test_helper.rb
 - test/units/indulgence/ability_test.rb
 - test/units/indulgence/ability_tests/method_only.rb
 - test/units/indulgence/ability_tests/with_lambdas.rb
-- test/units/user_test.rb
+- test/units/indulgence/permission_test.rb
 - test/units/role_permission_test.rb
+- test/units/role_test.rb
 - test/units/thing_permission_test.rb
 - test/units/thing_test.rb
-- test/lib/role.rb
-- test/lib/user.rb
-- test/lib/thing.rb
-- test/lib/thing_permission.rb
-- test/lib/role_permission.rb
-- test/db/migrate/20130408103015_create_roles.rb
-- test/db/migrate/20130408085511_create_users.rb
-- test/db/migrate/20130408132217_create_things.rb
-- test/db/config.yml
-- test/db/test.sqlite3.db
-- test/db/schema.rb
-- test/test_helper.rb
+- test/units/user_test.rb
+- test/units/work_process_test.rb
 homepage: https://github.com/reggieb/indulgence
 licenses:
 - MIT-LICENSE
@@ -110,29 +114,33 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Yet another permissions gem
 test_files:
-- test/units/role_test.rb
-- test/units/indulgence/permission_test.rb
-- test/units/indulgence/ability_test.rb
-- test/units/indulgence/ability_tests/method_only.rb
-- test/units/indulgence/ability_tests/with_lambdas.rb
-- test/units/user_test.rb
-- test/units/role_permission_test.rb
-- test/units/thing_permission_test.rb
-- test/units/thing_test.rb
+- test/lib/work_process.rb
 - test/lib/role.rb
-- test/lib/user.rb
-- test/lib/thing.rb
 - test/lib/thing_permission.rb
 - test/lib/role_permission.rb
-- test/db/migrate/20130408103015_create_roles.rb
-- test/db/migrate/20130408085511_create_users.rb
+- test/lib/thing.rb
+- test/lib/user.rb
+- test/lib/work_process_permission.rb
+- test/db/migrate/20141008101147_create_work_processes.rb
 - test/db/migrate/20130408132217_create_things.rb
+- test/db/migrate/20130408085511_create_users.rb
+- test/db/migrate/20130408103015_create_roles.rb
 - test/db/config.yml
 - test/db/test.sqlite3.db
 - test/db/schema.rb
 - test/test_helper.rb
+- test/units/role_test.rb
+- test/units/thing_test.rb
+- test/units/user_test.rb
+- test/units/work_process_test.rb
+- test/units/role_permission_test.rb
+- test/units/indulgence/permission_test.rb
+- test/units/indulgence/ability_test.rb
+- test/units/indulgence/ability_tests/with_lambdas.rb
+- test/units/indulgence/ability_tests/method_only.rb
+- test/units/thing_permission_test.rb