walruz 0.0.11 → 0.0.12

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+source 'http://gems.github.com'
+
+gem 'jeweler'
+gem 'yard'
+gem 'rdoc', '~> 2.4.2'
+
+group :test do
+  gem 'rspec', '= 1.3.2'
+end
+

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  remote: http://gems.github.com/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rdoc (2.4.3)
+    rspec (1.3.2)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rdoc (~> 2.4.2)
+  rspec (= 1.3.2)
+  yard

data/README.rdoc

@@ -77,8 +77,6 @@ Actor classes can use several methods to check if the <em>actor</em> instance ca
 
 [<b><tt>satisfies?(policy_label, subject)</tt></b>] It behaves just like the <tt>can?</tt> method, but instead of giving an action to be executed to the <em>subject</em>, it receives a <em>policy label</em> (More on <em>policy labels</em> next).
 
-[<b><tt>satisfies(policy_label, subject)</tt></b>] It behaves just like the <tt>authorize</tt> method, but instead of giving an action to be executed to the <em>subject</em>, it receives a <em>policy label</em> 
-
 In case the given action is not assigned to any <em>policy</em>, a default Policy will be executed (if given), if no default <em>policy</em> is given then a <tt>Walruz::ActionNotFound</tt> exception will be raised.
 
 Examples:

data/Rakefile

@@ -1,14 +1,19 @@
 require 'rubygems'
-require 'rake'
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
 
 begin
-  require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "walruz"
-    gem.summary = %Q{Walruz is a gem that provides an easy yet powerful way to implement authorization policies in a system, relying on the composition of simple policies to create more complex ones.}
+    gem.summary = %Q{Walruz is a gem that provides an easy yet powerful 
+                     way to implement authorization policies in a system, 
+                     relying on the composition of simple policies to create 
+                     more complex ones.}
     gem.description = %Q{
-      Walruz provides an easy to use DSL to do composition of basic authorization policies to create
-    more complex ones, and then register this composed policies on actions performed to the model begin accessed
+      Walruz provides an easy to use DSL to do composition of basic 
+      authorization policies to create more complex ones, and then register 
+      this composed policies on actions performed to the model begin accessed
     }
     gem.email = "roman@noomi.com"
     gem.homepage = "http://github.com/noomii/walruz"
@@ -19,14 +24,15 @@ begin
     gem.add_development_dependency("rspec")
     gem.add_development_dependency("yard")
   
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    # gem is a Gem::Specification... 
+    # see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   
   Jeweler::GemcutterTasks.new
-  Jeweler::RubyforgeTasks.new 
-  
+
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler not available. Install it with: sudo gem \
+  install technicalpickles-jeweler -s http://gems.github.com"
 end
 
 require 'spec/rake/spectask'
@@ -51,7 +57,7 @@ YARD::Rake::YardocTask.new do |t|
 end
 
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION.yml')
     config = YAML.load(File.read('VERSION.yml'))

data/VERSION.yml

@@ -2,4 +2,4 @@
 :build: 
 :major: 0
 :minor: 0
-:patch: 11
+:patch: 12

data/lib/walruz/config.rb

@@ -1,19 +1,69 @@
 module Walruz
 
   class Config
-    
+
+    # Given a list of classes, it will include the Actor module
+    # in each of them.
+    #
+    # @param [Class] actors The list of classes that will be Actors in the
+    # system
     def actors=(actors)
       Array(actors).each do |actor|
         actor.send(:include, Actor)
       end
     end
 
+    # Given a list of classes, it will include the Subject module
+    # in each of them.
+    #
+    # @param [Class] subjects The list of classes that will be Subject in the
+    # system
     def subjects=(subjects)
       Array(subjects).each do |subject|
         subject.send(:include, Subject)
       end
     end
-    
+
+    def enable_will_paginate_extension(options = {})
+      options = { :include_rails => false }.merge!(options)
+      gem 'mislav-will_paginate'
+      require 'will_paginate'
+      require File.expand_path(
+        File.join(File.dirname(__FILE__),  'more', 'pagination')
+      )
+
+      safe_include(WillPaginate::Collection,
+                   Walruz::More::Pagination::WillPaginateCollection)
+      safe_include(Array, Walruz::More::Pagination::Base)
+
+      if options[:include_rails]
+        raise LoadError.new("You ask to enable Walruz extensions on \
+ActiveRecord::Base, but it was not found. Maybe you should require \
+'active_record' first?") unless defined?("ActiveRecord::Base")
+        safe_include(::ActiveRecord::Base, Walruz::More::Pagination::Base)
+      end
+    rescue Gem::LoadError
+      raise LoadError.new("You ask to enable Walruz extensions on \
+WillPaginate, but it was not found, Maybe you should \
+require 'will_paginate' first")
+    end
+
+    # Will include the Walruz:CoreExt:Array module
+    # to the Array class
+    def enable_array_extension
+      require File.expand_path(
+          File.join(File.dirname(__FILE__), 'core_ext', 'array')
+      )
+      safe_include(Array, Walruz::CoreExt::Array)
+    end
+
+    protected
+
+    def safe_include(base, module_to_include)
+      return if base.included_modules.include?(module_to_include)
+      base.send(:include, module_to_include)
+    end
+
   end
 
 end

data/lib/walruz/more/pagination.rb

@@ -0,0 +1,25 @@
+module Walruz
+  module More
+    
+    # This module can be included into association like objects
+    module Pagination
+      
+      base_path = File.dirname(__FILE__)
+      autoload :Base, base_path + '/pagination/base'
+      autoload :WillPaginateCollection, base_path + '/pagination/will_paginate_collection'
+      autoload :ViewHelper, base_path + '/pagination/view_helper'
+
+
+      def self.included(base)
+        if base.instance_methods.include?('paginate')
+          # We are talking about an already paginated element, we use WillPaginate extension instead
+          base.send(:include, Base)
+        else
+          raise RuntimeError.new("Walruz::More::Paginate needs WillPaginate in order to work")
+        end
+      end
+
+    end # Pagination
+
+  end
+end

data/lib/walruz/more/pagination/base.rb

@@ -0,0 +1,53 @@
+module Walruz
+  module More
+    module Pagination
+
+      module Base
+
+        def authorized_paginate(actor, action, *args)
+          # All the args are forwarded to WillPaginate, he knows best what to do
+          options = args.last if Hash === args.last  
+
+          options[:page] ||= 1
+          options[:page] = options[:page].to_i
+          offset  = options.delete(:offset).to_i # defaults to 0
+
+          acum = []
+          while true
+            paginated_collection = self.paginate(*args)
+            filter_authorized_items_in_collection(actor, action, acum, paginated_collection, offset)
+            if complete_authorized_items_page?(acum, paginated_collection)
+              break
+            else
+              offset = 0
+              options[:page] += 1
+            end
+          end
+          paginated_collection.replace(acum)
+        end
+
+        protected
+
+        def complete_authorized_items_page?(items, pcollection)
+          items.size == pcollection.per_page || 
+            pcollection.next_page.nil?
+        end
+
+        def filter_authorized_items_in_collection(actor, action, acum, pcollection, offset = 0)
+          return if offset > pcollection.size
+          pcollection[offset, pcollection.size].each_with_index do |item, i|
+            if Walruz.can?(actor, action, item)
+              acum << item
+              unless acum.size < pcollection.per_page
+                pcollection.walruz_offset = i + 1
+                break
+              end # unless
+            end # if
+          end # each_with_index
+        end # filter
+
+      end
+
+    end
+  end
+end

data/lib/walruz/more/pagination/view_helper.rb

@@ -0,0 +1,11 @@
+module Walruz
+  module More
+    module Paginate
+      
+      module ViewHelper
+        
+      end
+
+    end
+  end
+end

data/lib/walruz/more/pagination/will_paginate_collection.rb

@@ -0,0 +1,27 @@
+module Walruz
+  module More
+    module Pagination
+
+      module WillPaginateCollection
+
+        def self.included(base)
+          base.class_eval do
+            attr_accessor :walruz_offset
+            alias_method :next_page_without_walruz, :next_page
+            alias_method :next_page, :next_page_with_walruz
+          end
+        end
+        
+        def next_page_with_walruz
+          if self.walruz_offset.nil? || self.walruz_offset == 0
+            next_page_without_walruz
+          else
+            self.current_page
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
-require 'spec'
-require 'pp'
+require 'bundler/setup'
+
+Bundler.require(:test)
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/walruz.gemspec

@@ -1,87 +1,87 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{walruz}
-  s.version = "0.0.11"
+  s.version = "0.0.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roman Gonzalez"]
-  s.date = %q{2010-11-15}
+  s.date = %q{2011-07-12}
   s.description = %q{
-      Walruz provides an easy to use DSL to do composition of basic authorization policies to create
-    more complex ones, and then register this composed policies on actions performed to the model begin accessed
+      Walruz provides an easy to use DSL to do composition of basic 
+      authorization policies to create more complex ones, and then register 
+      this composed policies on actions performed to the model begin accessed
     }
   s.email = %q{roman@noomi.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "CHANGELOG",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION.yml",
-     "lib/walruz.rb",
-     "lib/walruz/actor.rb",
-     "lib/walruz/config.rb",
-     "lib/walruz/core_ext/array.rb",
-     "lib/walruz/core_ext/memoization.rb",
-     "lib/walruz/exceptions.rb",
-     "lib/walruz/manager.rb",
-     "lib/walruz/policy.rb",
-     "lib/walruz/subject.rb",
-     "lib/walruz/utils.rb",
-     "spec/scenario.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "spec/walruz/actor_spec.rb",
-     "spec/walruz/core_ext/array_spec.rb",
-     "spec/walruz/core_ext/memoization_spec.rb",
-     "spec/walruz/manager_spec.rb",
-     "spec/walruz/policy_spec.rb",
-     "spec/walruz/subject_spec.rb",
-     "spec/walruz/utils_spec.rb",
-     "spec/walruz/walruz_spec.rb",
-     "walruz.gemspec"
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "lib/walruz.rb",
+    "lib/walruz/actor.rb",
+    "lib/walruz/config.rb",
+    "lib/walruz/core_ext/array.rb",
+    "lib/walruz/core_ext/memoization.rb",
+    "lib/walruz/exceptions.rb",
+    "lib/walruz/manager.rb",
+    "lib/walruz/more/pagination.rb",
+    "lib/walruz/more/pagination/base.rb",
+    "lib/walruz/more/pagination/view_helper.rb",
+    "lib/walruz/more/pagination/will_paginate_collection.rb",
+    "lib/walruz/policy.rb",
+    "lib/walruz/subject.rb",
+    "lib/walruz/utils.rb",
+    "spec/scenario.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/walruz/actor_spec.rb",
+    "spec/walruz/core_ext/array_spec.rb",
+    "spec/walruz/core_ext/memoization_spec.rb",
+    "spec/walruz/manager_spec.rb",
+    "spec/walruz/policy_spec.rb",
+    "spec/walruz/subject_spec.rb",
+    "spec/walruz/utils_spec.rb",
+    "spec/walruz/walruz_spec.rb",
+    "walruz.gemspec"
   ]
-  s.has_rdoc = %q{yard}
   s.homepage = %q{http://github.com/noomii/walruz}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{walruz}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Walruz is a gem that provides an easy yet powerful way to implement authorization policies in a system, relying on the composition of simple policies to create more complex ones.}
-  s.test_files = [
-    "spec/scenario.rb",
-     "spec/spec_helper.rb",
-     "spec/walruz/actor_spec.rb",
-     "spec/walruz/core_ext/array_spec.rb",
-     "spec/walruz/core_ext/memoization_spec.rb",
-     "spec/walruz/manager_spec.rb",
-     "spec/walruz/policy_spec.rb",
-     "spec/walruz/subject_spec.rb",
-     "spec/walruz/utils_spec.rb",
-     "spec/walruz/walruz_spec.rb"
-  ]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Walruz is a gem that provides an easy yet powerful  way to implement authorization policies in a system,  relying on the composition of simple policies to create  more complex ones.}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<rdoc>, ["~> 2.4.2"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 2.4.2"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 2.4.2"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: walruz
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 11
-  version: 0.0.11
+  - 12
+  version: 0.0.12
 platform: ruby
 authors: 
 - Roman Gonzalez
@@ -15,12 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-15 00:00:00 -08:00
+date: 2011-07-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,12 +29,42 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  name: jeweler
   version_requirements: *id001
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: yard
+  version_requirements: *id002
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 4
+        - 2
+        version: 2.4.2
+  name: rdoc
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,9 +73,24 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  name: rspec
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id002
-description: "\n      Walruz provides an easy to use DSL to do composition of basic authorization policies to create\n    more complex ones, and then register this composed policies on actions performed to the model begin accessed\n    "
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: yard
+  version_requirements: *id005
+  prerelease: false
+description: "\n      Walruz provides an easy to use DSL to do composition of basic \n      authorization policies to create more complex ones, and then register \n      this composed policies on actions performed to the model begin accessed\n    "
 email: roman@noomi.com
 executables: []
 
@@ -57,8 +101,9 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - CHANGELOG
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -70,6 +115,10 @@ files:
 - lib/walruz/core_ext/memoization.rb
 - lib/walruz/exceptions.rb
 - lib/walruz/manager.rb
+- lib/walruz/more/pagination.rb
+- lib/walruz/more/pagination/base.rb
+- lib/walruz/more/pagination/view_helper.rb
+- lib/walruz/more/pagination/will_paginate_collection.rb
 - lib/walruz/policy.rb
 - lib/walruz/subject.rb
 - lib/walruz/utils.rb
@@ -85,13 +134,13 @@ files:
 - spec/walruz/utils_spec.rb
 - spec/walruz/walruz_spec.rb
 - walruz.gemspec
-has_rdoc: yard
+has_rdoc: true
 homepage: http://github.com/noomii/walruz
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -115,18 +164,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: walruz
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Walruz is a gem that provides an easy yet powerful way to implement authorization policies in a system, relying on the composition of simple policies to create more complex ones.
-test_files: 
-- spec/scenario.rb
-- spec/spec_helper.rb
-- spec/walruz/actor_spec.rb
-- spec/walruz/core_ext/array_spec.rb
-- spec/walruz/core_ext/memoization_spec.rb
-- spec/walruz/manager_spec.rb
-- spec/walruz/policy_spec.rb
-- spec/walruz/subject_spec.rb
-- spec/walruz/utils_spec.rb
-- spec/walruz/walruz_spec.rb
+summary: Walruz is a gem that provides an easy yet powerful  way to implement authorization policies in a system,  relying on the composition of simple policies to create  more complex ones.
+test_files: []
+

data/.gitignore

@@ -1,14 +0,0 @@
-*.sw?
-.DS_Store
-.yardoc
-coverage
-rdoc
-doc
-pkg
-tmp
-examples/rails/tmp/*
-examples/rails/log/*
-examples/rails/db/schema.rb
-examples/rails/db/*.sqlite3
-tags
-*.swp