cantango-core 0.1.0

data/lib/cantango/rules/relation.rb

@@ -0,0 +1,67 @@
+require 'active_support/inflector'
+
+module CanTango
+  module Rules
+    class Relation
+      attr_reader :attribute, :permit, :scope, :models
+
+      include CanTango::Rules::Adaptor
+      include CanTango::Rules::RuleClass
+
+      def initialize attribute, permit, scope, *models, &block
+        @attribute = attribute
+        @scope = scope
+        @permit = permit
+        @models = models
+
+        check_models
+        use_adaptor! self, user_scope
+      end
+
+      def can(action)
+        models.each do |model|
+          rules << rule_class.new(true, action, model, nil, condition_block(model))
+        end
+      end
+
+      def cannot(action)
+        models.each do |model|
+          rules << rule_class.new(false, action, model, nil, condition_block(model))
+        end
+      end
+
+      protected
+
+      def condition_block model
+        return attribute_condition(attribute, user_scope) if model.new.respond_to?(attribute)
+        return include_condition(plural_attribute, user_scope) if model.new.respond_to?(plural_attribute)
+      end
+
+      def user_scope
+        @user_scope ||= (scope == :account) ? permit.user_account : permit.user
+      end
+
+      def scope_key
+        @scope_key ||= (scope == :account) ? :user_account : :user
+      end
+
+      def ability
+        permit.ability
+      end
+
+      def rules
+        ability.send :rules
+      end
+
+      def plural_attribute
+        :"#{attribute.to_s.pluralize}"
+      end
+
+      def check_models
+        models.each do |model|
+          raise "#{model} has no :#{attribute} or :#{plural_attribute} defined" if !model.new.respond_to?(attribute) && !model.new.respond_to?(plural_attribute)
+        end
+      end
+    end
+  end
+end

data/lib/cantango/rules/rule_class.rb

@@ -0,0 +1,11 @@
+module CanTango
+  module Rules
+    module RuleClass
+      # CanCan 1.5 compatibility
+      def rule_class
+        return CanCan::Rule if defined? CanCan::Rule
+        CanCan::CanDefinition
+      end
+    end
+  end
+end

data/lib/cantango/rules/scope.rb

@@ -0,0 +1,24 @@
+module CanTango
+  module Rules
+    class Scope
+      attr_reader :name, :permit
+
+      def initialize name, permit, &block
+        @name = name.to_sym
+        @permit = permit
+      end
+
+      ::CanTango.config.user.relations.each do |relationship|
+        base.class_eval %{
+          def #{relationship}_of *models, &block
+            options = models.extract_options!
+            scope = options[:scope] || name
+            relation = UserRelation.new :#{relationship}, permit, scope, models, &block
+            yield relation if block
+            relation
+          end
+        }
+      end
+    end
+  end
+end

data/lib/cantango/scope.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module Scope
+    autoload_modules :Ability
+  end
+end

data/lib/cantango/scope/ability.rb

@@ -0,0 +1,20 @@
+module CanTango
+  module Scope
+    class Ability
+      attr_accessor :ability
+
+      def initialize ability
+        @ability = ability
+      end
+
+      def can? *args
+        ability.can? *args
+      end
+
+      def cannot? *args
+        ability.cannot? *args
+      end
+    end
+  end
+end
+ 

data/lib/generators/cantango/install/install_generator.rb

@@ -0,0 +1,37 @@
+module Cantango
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Add role strategy to a User model"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :categories,       :type => :boolean,     :default => true,  :desc => "Create categories"
+      class_option :permissions,      :type => :boolean,     :default => true,  :desc => "Create yaml permissions store"
+
+      def copy_initializer
+        template "cantango.rb", "config/initializers/cantango.rb"
+      end
+
+      def copy_categories
+        return unless categories?
+        template "categories.yml", "config/categories.yml"
+      end
+
+      def copy_permissions
+        return unless permissions?
+        template "permissions.yml", "config/permissions.yml"
+      end
+
+      protected
+
+      def permissions?
+        options[:permissions]
+      end
+
+      def categories?
+        options[:categories]
+      end
+    end
+  end
+end
+

data/lib/generators/cantango/install/templates/cantango.rb

@@ -0,0 +1,4 @@
+CanTango.config do |config|
+  config.engines.all :on
+  # more configuration here...
+end

data/lib/generators/cantango/install/templates/permissions.yml

@@ -0,0 +1,6 @@
+account_types:
+user_types:
+roles:
+role_groups:
+licenses:
+users:

data/spec/cantango/ability/base_spec.rb

@@ -0,0 +1,73 @@
+require 'rspec'
+require 'cantango'
+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
+  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
+
+  before do
+    CanTango.config.clear!
+    @ability = CanTango::Ability.new user_account
+  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) }
+
+    its(:roles)         { should_not be_empty }
+    its(:role_groups)   { should_not be_empty }
+end

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

@@ -0,0 +1,75 @@
+require 'rspec'
+require 'cantango'
+# require 'simple_roles'
+require 'fixtures/models'
+require 'cantango/rspec'
+
+def config_folder
+  File.dirname(__FILE__)+ "/../fixtures/config/"
+end
+
+CanTango.configure do |config|
+  config.clear!
+end
+# CanTango.debug!
+
+class User
+  tango_user
+  include_and_extend SimpleRoles
+end
+
+class AdminRolePermit < CanTango::RolePermit
+  def initialize ability
+    super
+  end
+
+  protected
+
+  def static_rules
+    can :read, Article
+  end
+
+  module Cached
+    def permit_rules
+      can :edit, Article
+      can :delete, Article
+    end
+  end
+end
+
+module CanTango
+  class Ability
+    def permit_rules
+      can :read, Post
+    end
+  end
+end
+
+describe CanTango::AbilityExecutor do
+  context 'non-cached only' do
+    before do
+      CanTango.configure.ability.mode = :no_cache
+
+      @user = User.new 'admin', 'admin@mail.ru', :role => 'admin'
+      @abil = CanTango::AbilityExecutor.new @user
+    end
+
+    subject { CanTango::AbilityExecutor.new @user }
+
+    describe 'config no_cache' do
+      specify { CanTango.configure.ability.modes.should == [:no_cache] }
+    end
+
+    describe 'engines_on?' do
+      specify { subject.engines_on?.should be_true }
+    end
+
+    its(:cached_rules)      { should be_empty }
+    its(:non_cached_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 == 2 }
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'rspec'
+require 'cantango'
+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
+    def permit_rules
+      can :edit, Project
+    end
+  end
+end
+
+describe CanTango::Ability::Executor do
+  context 'no-cache' do
+    let (:ability) do
+      CanTango::Ability.new @user
+    end
+
+    before do
+      @user = User.new 'kris'
+    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
+
+

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

@@ -0,0 +1,77 @@
+require 'rspec'
+require 'cantango'
+# require 'simple_roles'
+require 'fixtures/models'
+require 'cantango/rspec'
+
+def config_folder
+  File.dirname(__FILE__)+ "/../fixtures/config/"
+end
+
+CanTango.configure do |config|
+  config.clear!
+  config.ability.mode = :cache
+end
+# CanTango.debug!
+
+class User
+  tango_user
+  include_and_extend SimpleRoles
+end
+
+class AdminRolePermit < CanTango::Permit::Role
+  def initialize ability
+    super
+  end
+
+  protected
+
+  def static_rules
+    can :read, Article
+  end
+
+  module Cached
+    def permit_rules
+      can :edit, Article
+      can :delete, Article
+    end
+  end
+end
+
+module CanTango
+  class CachedAbility
+    def permit_rules
+      can :read, Post
+    end
+  end
+end
+
+describe CanTango::Ability::Executor::CacheMode do
+  context 'cached only' do
+    before do
+      CanTango.configure.ability.mode = :cache
+
+      @user = User.new 'admin', 'admin@mail.ru', :role => 'admin'
+      @abil = CanTango::AbilityExecutor.new @user
+    end
+
+    subject { CanTango::AbilityExecutor.new @user }
+
+    describe 'config cache' do
+      specify { CanTango.configure.ability.modes.should == [:cache] }
+    end
+
+    describe 'engines_on?' do
+      specify { subject.engines_on?.should be_true }
+    end
+
+    its(:cached_rules)      { should_not be_empty }
+    its(:non_cached_rules)  { should be_empty }
+
+    describe 'rules contain only non-cached rules' do
+      specify { subject.rules.size.should == @abil.cached_rules.size }
+      specify { subject.rules.size.should == 4 }
+    end
+  end
+end
+