cantango-core 0.1.2 → 0.1.3

data/lib/cantango/ability/helper/engine.rb

@@ -1,32 +1,28 @@
-module CanTango
-  class Ability
-    module Helper
-      module Engine
-        def execute_engines!
-          each_engine do |engine|
-            engine_rules = engine.new(self).execute! if engine
-            @rules << engine_rules if !engine_rules.blank?
-          end
-        end
+module CanTango::Ability::Helper
+  module Engine
+    def execute_engines!
+      each_engine do |engine|
+        engine_rules = engine.new(self).execute! if engine
+        @rules << engine_rules if !engine_rules.blank?
+      end
+    end
 
-        def each_engine &block
-          engines.execution_order.each do |name|
-            yield engines.registered[name] if engines.active? name
-          end
-        end
+    def each_engine &block
+      engines.execution_order.each do |name|
+        yield engines.registered[name] if engines.active? name
+      end
+    end
 
-        def opts_engines_off?
-          options[:engines] == :off
-        end
+    def opts_engines_off?
+      options[:engines] == :off
+    end
 
-         def engines_on?
-          CanTango.config.engines.any?(:on) && !opts_engines_off?
-        end
+     def engines_on?
+      CanTango.config.engines.any?(:on) && !opts_engines_off?
+    end
 
-        def engines
-          CanTango.config.engines
-        end
-      end
+    def engines
+      CanTango.config.engines
     end
   end
-end
+end

data/lib/cantango/ability/helper/user.rb

@@ -1,18 +1,14 @@
-module CanTango
-  class Ability
-    module Helper
-      module User
-        def user
-          return subject.user if subject.respond_to? :user
-          subject
-        end
+module CanTango::Ability::Helper
+  module User
+    def user
+      return subject.user if subject.respond_to? :user
+      subject
+    end
 
-        def user_key_field
-          key_field = config.user.unique_key_field
-          raise "\nModel <#{user.class}> has no ##{key_field} as defined in CanTango.config.user.unique_key_field" if !user.respond_to?(key_field)
-          key_field
-        end
-      end
+    def user_key_field
+      key_field = CanTango.config.user.unique_key_field
+      raise "\nModel <#{user.class}> has no ##{key_field} as defined in CanTango.config.user.unique_key_field" if !user.respond_to?(key_field)
+      key_field
     end
   end
 end

data/lib/cantango/ability/helper.rb

@@ -2,7 +2,7 @@ module CanTango
   module Ability
     module Helper
       def self.modules
-        [:Account, :Cache, :Engine, :Masquerade, :Permit, :PermitStore, :Role, :RoleGroup, :User]
+        [:Account, :Engine, :User]
       end
       
       autoload_modules *modules

data/lib/cantango/ability.rb

@@ -1,5 +1,10 @@
 module CanTango
-  module Ability    
-    autoload_modules :Base, :Cache, :Cached, :Executor, :Helper
+  module Ability
+    autoload_modules :Base, :Cache, :Executor, :Helper
+    
+    # by default add callbacks?
+    class Base
+      include Callbacks
+    end
   end
 end

data/lib/cantango/adaptor/active_record.rb

@@ -0,0 +1,6 @@
+module CanTango::Adaptor
+  module ActiveRecord
+    include CanTango::Rules::Adaptor::Relational
+  end
+end
+

data/lib/cantango/adaptor/data_mapper.rb

@@ -0,0 +1,5 @@
+module CanTango::Adaptor
+  module DataMapper
+    include CanTango::Rules::Adaptor::Relational
+  end
+end

data/lib/cantango/adaptor/generic.rb

@@ -0,0 +1,12 @@
+module CanTango::Adaptor
+  module Generic
+
+    def attribute_condition attribute, candidate
+      Proc.new { |model| model.send(attribute) == candidate }
+    end
+
+    def include_condition attribute, candidate
+      Proc.new { |model| model.send(attribute).include? candidate }
+    end
+  end
+end

data/lib/cantango/adaptor/mongo.rb

@@ -0,0 +1,13 @@
+module CanTango::Adaptor
+  module Mongo
+    #include CanTango::Rules::Adaptor::Generic
+    # using #in on Hash (Mongoid query)
+    def include_condition attribute, candidate
+      { attribute.to_sym.in => candidate.send(attribute) }
+    end
+
+    def attribute_condition attribute, user_scope
+      { attribute.to_sym => candidate.send(attribute) }
+    end
+  end
+end

data/lib/cantango/adaptor/mongo_mapper.rb

@@ -0,0 +1,5 @@
+module CanTango::Adaptor
+  module MongoMapper
+    include module CanTango::Rules::Adaptor::Mongo
+  end
+end

data/lib/cantango/adaptor/mongoid.rb

@@ -0,0 +1,5 @@
+module CanTango::Adaptor
+  module Mongoid
+    include module CanTango::Rules::Adaptor::Mongo
+  end
+end

data/lib/cantango/adaptor/relational.rb

@@ -0,0 +1,8 @@
+module CanTango::Adaptor
+  module Relational
+    def attribute_condition attribute, candidate
+      { attribute.to_sym => candidate.send(attribute) }
+    end
+    alias_method :include_condition, :attribute_condition
+  end
+end

data/lib/cantango/{rules/adaptor.rb → adaptor.rb}

@@ -25,10 +25,10 @@ module CanTango
 
       def orm_map
         {
-          :active_record => "ActiveRecord::Base",
-          :data_mapper => "DataMapper::Resource",
-          :mongoid => "Mongoid::Document",
-          :mongo_mapper => "MongoMapper::Document"
+          :active_record  => "ActiveRecord::Base",
+          :data_mapper    => "DataMapper::Resource",
+          :mongoid        => "Mongoid::Document",
+          :mongo_mapper   => "MongoMapper::Document"
         }
       end
     end

data/lib/cantango/{rules → cancan}/rule_class.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module Rules
+  module CanCan
     module RuleClass
       # CanCan 1.5 compatibility
       def rule_class

data/lib/cantango/cancan.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module CanCan
+    autoload_modules :Rule, :RuleClass
+  end
+end

data/lib/cantango/core.rb

@@ -1,10 +1,3 @@
-require 'cantango/rails/railtie' if defined?(Rails)
-require 'cantango/rails/engine' if defined?(Rails)
-
-# essential cantango extensions
-# require 'cantango/config'
-# require 'cantango/api'
-
 require 'cancan'
 require 'active_support' # for Delegate module
 require 'active_support/core_ext/module/delegation'
@@ -15,12 +8,11 @@ require 'sugar-high/blank'
 require 'hashie'
 require 'sweetloader'
 
-AutoLoader.namespaces = {:CanTango => 'cantango'}
+SweetLoader.namespaces = {:CanTango => 'cantango'}
+SweetLoader.mode = :require
 
 module CanTango
-  autoload_modules :Ability, :Engine, :Filter
-  autoload_modules :Helpers, :Loader, :Macros, :Model
-  autoload_modules :Rules, :Scope
+  autoload_modules :Helpers, :Ability, :Engine, :Filter
+  autoload_modules :Loader, :Model
+  autoload_modules :Scope
 end
-
-require 'cantango/macros'

data/lib/cantango/engine.rb

@@ -2,12 +2,12 @@ module CanTango
   class Engine
     include CanTango::Helpers::Debug
 
-    attr_reader :ability
+    attr_reader :ability, :options
 
     delegate :session, :user, :subject, :candidate, :cached?, :to => :ability
 
-    def initialize ability
-      @ability = ability
+    def initialize ability, options = {}
+      @ability, @options = [ability, options]
     end
 
     def execute!
@@ -18,22 +18,12 @@ module CanTango
       raise NotImplementedError
     end
 
-    protected
-
-    def valid_mode?
-      valid_cache_mode? || valid_no_cache_mode?
-    end
-
-    def valid_cache_mode?
-      modes.include?(:cache) && cached?
-    end
-
-    def valid_no_cache_mode?
-      modes.include?(:no_cache) && !cached?
+    def valid_mode? mode
+      modes.include? mode.to_sym
     end
 
     def modes
-      CanTango.config.engine(engine_name.to_sym).modes
+      @modes ||= options[:modes] || []
     end
   end
 end

data/lib/cantango/filter/base.rb

@@ -5,7 +5,7 @@ module CanTango
 
       def initialize item, list = nil
         @item         = item.to_sym
-        @include_list = list || []
+        @include_list = list.map(&:to_sym) || []
       end
 
       def valid?

data/lib/cantango/helpers/debug.rb

@@ -1,9 +1,39 @@
 module CanTango
   module Helpers
     module Debug
+      attr_writer :do_debug, :debug_writer
+      
+      def self.included base
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        attr_writer :do_debug, :debug_writer
+
+        def debug?
+          @do_debug ||= false
+        end
+
+        def debug_writer
+          @debug_writer ||= lambda {|m| puts m }
+        end        
+      end
+      
       # you can set another writer on CanTango.config.debug, fx to spec it!
       def debug msg
-        CanTango.config.debug.write msg if CanTango.debug?
+        if debug?
+          return debug_writer.write msg if debug_writer.respond_to? :write
+          return debug_writer.call(msg) if debug_writer.respond_to? :call
+          raise "No debug_writer set!"
+        end
+      end
+      
+      def debug?
+        @do_debug ||= self.class.debug?
+      end
+      
+      def debug_writer
+        @debug_writer ||= self.class.debug_writer
       end
     end
   end

data/lib/cantango/loader/yaml.rb

@@ -14,19 +14,10 @@ module CanTango
       def yml_content
         YAML.load_file(file_name)
       rescue
-        raise "Couldn't load permissions file: #{file_name}. Either disable Permission engine or add this file."
+        raise "Couldn't YAML file: #{file_name}"
       end
-
+      
       module ClassMethods
-        protected
-
-        def config_file name
-          File.join(config_path, "#{name}.yml") if rails?
-        end
-
-        def config_path
-          CanTango.config.permissions.config_path
-        end
       end
     end
   end

data/lib/cantango/model/guest.rb

@@ -5,12 +5,14 @@ module CanTango
     module Guest
       def self.included(base)
         base.extend  ::ActiveModel::Naming
+        base.extend  ::ActiveModel::Callbacks
+
         base.send :include, ::ActiveModel::Conversion
         base.send :include, ::ActiveModel::Validations
       end
 
       def email
-        'guest@info.com'
+        'guest@example.com'
       end
 
       def has_role? role

data/spec/cantango/ability/base_spec.rb

@@ -1,73 +1,23 @@
-require 'rspec'
-require 'cantango'
+require 'spec_helper'
 require 'fixtures/models'
-require 'cantango/rspec'
 
-def config_folder
-  File.dirname(__FILE__)+ "/../fixtures/config/"
-end
-
-CanTango.configure do |config|
-  config.clear!
-  # config.permissions.set :on
-  config.engines.all :on
-
-  config.permission_engine.config_path = config_folder
-  config.categories.register :blog_items => [Article, Post]
-end
-
-class PublishersRoleGroupPermit < CanTango::RoleGroupPermit
-  def initialize ability
-    super
-  end
-
-  protected
-
-  def static_rules
-    can :write, category(:blog_items)
-    cannot :write, Post
+module CanTango::Ability
+  class Base
+    include CanTango::Ability::Helper::Account
+    
+    def permit_rules
+      can :edit, Project
+    end
   end
 end
 
-class EditorRolePermit < CanTango::RolePermit
-  def initialize ability
-    super
-  end
-
-  protected
-
-  def static_rules
-    can :read, Comment
-  end
-end
-
-
-describe CanTango::Ability do
-  let (:user) do
-    User.new 'krisy', 'krisy@gmail.com'
-  end
-
-  let (:user_account) do
-    ua = UserAccount.new user, :roles => [:editor], :role_groups => [:publishers]
-    user.account = ua
-  end
-
+describe CanTango::Ability::Base do
   before do
-    CanTango.config.clear!
-    @ability = CanTango::Ability.new user_account
+    user = User.new 'krisy', 'krisy@gmail.com'
+    @account = Account.new user
   end
 
-  specify { CanTango.config.roles.excluded.should be_empty }
-  specify { CanTango.config.role_groups.excluded.should be_empty }
-
-  subject { @ability }
-    specify { @ability.should be_allowed_to(:read, Comment) }
-    specify { @ability.should be_allowed_to(:write, Article) }
-    specify { @ability.should_not be_allowed_to(:write, Post) }
-
-    its(:user_account)  { should be_a(UserAccount) }
-    its(:user)          { should be_a(User) }
+  subject { CanTango::Ability::Base.new @account }
 
-    its(:roles)         { should_not be_empty }
-    its(:role_groups)   { should_not be_empty }
+  specify { subject.should be_allowed_to(:edit, Project) }
 end

data/spec/cantango/ability/cache/simple_key_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'fixtures/models'
+
+describe CanTango::Ability::Cache::SimpleKey do
+  before do
+    @user = User.new 'krisy', 'krisy@gmail.com'
+    @account = Account.new user
+    @ability = CanTango::Ability::Base.new @account
+  end
+
+  context 'SimpleKey for user' do
+    subject { CanTango::Ability::Cache::SimpleKey.new @user }
+
+    specify do
+      subject.value.should == @user.email.hash
+    end
+    
+    specify do
+      subject.to_s.should match /#{@user.email.hash}/
+  end
+    
+  context '#Simplekey #create_for Ability' do
+    subject { CanTango::Ability::Cache::SimpleKey.create_for @ability }
+
+    specify do
+      subject.value.should == @user.email.hash
+    end
+  end
+end

data/spec/cantango/ability/executor/base_spec.rb

@@ -1,67 +1,27 @@
-require 'rspec'
-require 'cantango'
+require 'spec_helper'
 require 'fixtures/models'
-require 'cantango/rspec'
 
-def config_folder
-  File.dirname(__FILE__)+ "/../fixtures/config/"
-end
-
-CanTango.configure do |config|
-  config.clear!
-  config.ability.mode = :no_cache
-end
-
-class MyExecutor
-  include CanTango::Ability::Executor
-
-  attr_reader :ability
-
-  def initialize ability
-    @ability = ability
-  end
-
-  def valid?
-    true
-  end
-
-  def cache_key
-    :my_exec
-  end
-
-  def permit_rules
-    ability.permit_rules
-  end
-end
-
-module CanTango
-  class Ability
+module CanTango::Ability
+  class Base
     def permit_rules
-      can :edit, Project
+      can :read, Post
     end
   end
 end
 
-describe CanTango::Ability::Executor do
-  context 'no-cache' do
-    let (:ability) do
-      CanTango::Ability.new @user
-    end
-
+describe CanTango::Ability::Executor::Base do
+  context 'non-cached only' do
     before do
-      @user = User.new 'kris'
+      @user = User.new 'admin', 'admin@mail.ru'
     end
 
-    subject { MyExecutor.new ability }
+    subject { CanTango::Ability::Executor::Base.new @user }
 
-    describe '#execute!' do
-      before do
-        subject.execute!
-      end
+    its(:non_cached_rules)  { should_not be_empty }
 
-      specify { subject.ability.send(:rules).should_not be_empty }
+    describe 'rules contain only non-cached rules' do
+      specify { subject.rules.size.should == @abil.non_cached_rules.size }
+      specify { subject.rules.size.should == 1 }
     end
   end
 end
-
-

data/spec/cantango/ability/executor/custom_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'fixtures/models'
+
+class MyExecutor < CanTango::Ability::Executor::Base
+  attr_reader :ability
+
+  def initialize ability
+    super
+  end
+
+  def valid?
+    true
+  end
+
+  def cache_key
+    :my_exec
+  end
+
+  def permit_rules
+    ability.permit_rules
+  end
+end
+
+module CanTango::Ability
+  class Base
+    def permit_rules
+      can :edit, Project
+    end
+  end
+end
+
+describe CanTango::Ability::Executor::Base do
+  context 'Custom executor inheriting from Base' do
+    before do
+      @user = User.new 'kris'
+      @ability = CanTango::Ability::Base.new @user
+    end
+
+    subject { MyExecutor.new @ability }
+
+    describe '#execute!' do
+      before do
+        subject.execute!
+      end
+
+      specify { subject.ability.send(:rules).should_not be_empty }
+    end
+  end
+end
+
+