cantango-config 0.1.0

data/lib/cantango/configuration/models.rb

@@ -0,0 +1,77 @@
+module CanTango
+  class Configuration
+    class Models
+      autoload_modules :Generic, :ActiveRecord, :DataMapper, :MongoMapper, :Mongoid
+      autoload_modules :Actions
+
+      include CanTango::Helpers::Debug
+      include Singleton
+      include ClassExt
+
+      def actions
+        @actions ||= HashRegistry.new
+      end
+
+      def by_reg_exp reg_exp
+        raise "Must be a Regular Expression like: /xyz/ was #{reg_exp.inspect}" if !reg_exp.kind_of? Regexp
+
+        grep(reg_exp).map do |model_string|
+          try_model(model_string)
+        end
+      end
+
+      def by_category label
+        categories[label].map do |model|
+          model.class == String ? try_model(model) : model
+        end
+      end
+
+      def exclude *names
+        @excluded = names.flatten.select_labels
+      end
+
+      def excluded
+        @excluded ||= []
+      end
+
+      def available_models
+        all_models - excluded.map {|m| m.to_s.camelize}
+      end
+
+      protected
+
+      def all_models
+        CanTango.config.orms.registered.compact.inject([]) do |result, orm|
+          adapter = adapter_for(orm)
+          result << (adapter.models.map(&:name) if adapter)
+          result
+        end.flatten.compact
+      end
+
+      private
+
+      def adapter_for orm
+        clazz_name = "CanTango::Configuration::Models::#{orm.to_s.camelize}"
+        clazz = clazz_name.constantize
+        clazz.new
+      rescue Exception => e
+        debug "Unknown ORM: #{orm} - no adapter defined for this ORM - #{e}"
+      end
+
+      def try_model model_string
+        model = find_first_class(model_string.singularize, model_string) 
+        raise "No model #{model_string} defined!" if !model
+        model
+      end
+
+      def grep reg_exp
+        available_models.grep reg_exp
+      end
+
+      def categories
+        CanTango.config.categories
+      end
+    end
+  end
+end
+

data/lib/cantango/configuration/modes.rb

@@ -0,0 +1,21 @@
+module CanTango
+  class Configuration
+    module Modes
+      def modes
+        @modes ||= [:no_cache]
+      end
+
+      def mode= mode_name
+        mode_name = mode_name.to_sym
+        raise ArgumentError, "Not a valid mode name" if !valid_mode_names.include? mode_name
+        @modes = (mode_name == :both) ? [:cache, :no_cache] : [mode_name]
+      end
+
+      private
+
+      def valid_mode_names
+        [:cache, :no_cache]
+      end
+    end
+  end
+end

data/lib/cantango/configuration/orms.rb

@@ -0,0 +1,8 @@
+module CanTango
+  class Configuration
+    class Orms < Registry
+      include Singleton
+    end
+  end
+end
+

data/lib/cantango/configuration/registry.rb

@@ -0,0 +1,56 @@
+require 'singleton'
+require 'sugar-high/kind_of'
+
+module CanTango
+  class Configuration
+    class Registry
+
+      attr_writer   :default
+      attr_accessor :registered
+
+      def types= *types
+        @types = types.select {|t| t.is_a? Class }
+      end
+
+      def types
+        @types ||= [Symbol, String]
+        @types
+      end
+
+      def clean!
+        @registered = []
+      end
+
+      alias_method :clear!, :clean!
+
+      def default!
+        @registered = default
+      end
+
+      def register *list
+        registered << list.select_kinds_of(*types)
+        @registered.flat_uniq!
+      end
+
+      alias_method :<<, :register
+
+      def [] index
+        registered[index]
+      end
+
+      def registered
+        @registered ||= default
+      end
+
+      def registered? label
+        registered.map(&:to_s).include? label.to_s
+      end
+
+      def default
+        @default ||= []
+      end
+    end
+  end
+end
+
+

data/lib/cantango/configuration/user.rb

@@ -0,0 +1,47 @@
+module CanTango
+  class Configuration
+    class User
+      include Singleton
+
+      include ClassExt
+
+      def clear!
+        @clazz = nil
+        @unique_key_field = nil
+        @relations = nil
+      end
+
+      def base_class
+        @clazz ||= (::User if defined? ::User)
+      end
+
+      def base_class= clazz
+        raise ArgumentError, "Must be a class, was: #{clazz}" unless is_class? clazz
+        @clazz = clazz
+      end
+
+      def unique_key_field
+        @unique_key_field || :email
+      end
+
+      def unique_key_field= key
+        raise ArgumentError, "Not a valid key" unless key.kind_of_label?
+        @unique_key_field = key.to_sym
+      end
+
+      def relations= *relations
+        @relations = relations.select_labels
+      end
+
+      def relations
+        @relations ||= default_relations
+      end
+
+      def default_relations
+        [:owner, :author, :writer, :user]
+      end
+    end
+  end
+end
+
+

data/lib/cantango/configuration/users.rb

@@ -0,0 +1,8 @@
+module CanTango
+  class Configuration
+    class Users < CandidateRegistry
+      include Singleton
+    end
+  end
+end
+

data/lib/cantango/configuration.rb

@@ -0,0 +1,99 @@
+require 'set'
+require 'singleton'
+
+module CanTango
+  class Configuration
+    autoload_modules :Categories
+    autoload_modules :Models, :Engines, :Ability
+    autoload_modules :Registry, :RoleRegistry, :HashRegistry, :CandidateRegistry
+    autoload_modules :Roles, :RoleGroups, :SpecialPermits
+    autoload_modules :Factory, :Autoload, :Adapters, :Debug, :Modes, :Orms, :Localhosts, :Hooks
+    autoload_modules :Account, :Accounts
+    autoload_modules :User, :Guest, :Users
+
+    include Singleton
+
+    def ability
+      @ability ||= conf::Ability.instance
+      @ability.default_class ||= CanTango::Ability::Executor::Base
+      @ability
+    end
+
+    def self.components
+      [
+        :guest, :autoload, :user, :account, :models, :modes, :roles, :role_groups,
+        :engines, :users, :accounts, :categories, :adapters, :debug,
+        :localhosts, :orms, :hooks
+      ]
+    end
+
+    components.each do |conf_module|
+      class_eval %{
+        def #{conf_module} &block
+          conf = conf::#{conf_module.to_s.camelize}.instance
+          yield conf if block
+          conf
+        end
+      }
+    end
+
+    def debug!
+      debug.set :on
+    end
+
+    # Turn on default engines and enable compile adapter 
+    # i.e compilation of rules via sourcify
+    def enable_defaults!
+      engines.all :off
+      adapters.use :compiler
+    end
+
+    def enable_helpers *names
+      names = names.to_symbols
+      enable_rest_helper if names.include? :rest
+    end
+
+    def enable_rest_helper
+      raise 'ApplicationController not defined' if !defined?(::ApplicationController)
+      ::ApplicationController.send :include, CanTango::Rails::Helpers::RestHelper
+    end
+
+    def clear!
+      CanTango::Configuration.components.each do |component|
+        if respond_to? component
+          component = send(component) 
+          component.send(:clear!) if component.respond_to? :clear!
+        end
+      end
+      engines.clear!
+    end
+
+    def include_models *names
+      names = names.select_symbols
+      if names.include? :default_guest_user
+        require 'cantango/user/guest'
+      end
+    end
+
+    # allow either block or direct access
+    # engine(:permission) do |permission|
+    # engine(:permission).config_path
+    def engine name, &block
+      engine = find_engine(name)
+      yield engine if block
+      engine
+    end
+
+    protected
+
+    def find_engine name
+      raise ArgumentError, "Must be label for an engine" if !name.kind_of_label?
+      name = name.to_s.singularize
+      engines.send(name) if engines.available? name
+    end
+
+    def conf
+      CanTango::Configuration
+    end
+  end
+end

data/spec/cantango/config_spec.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'cantango/config'
+
+describe 'cantango/config' do
+  specify do 
+    lambda { CanTango::Configuration }.should_not raise_error
+  end
+end

data/spec/cantango/configuration/ability_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'cantango/configuration/shared/factory_ex'
+require 'cantango/configuration/shared/modes_ex'
+
+describe CanTango::Configuration::Ability do
+  subject { CanTango.config.ability }
+    
+  it_should_behave_like 'Factory'
+
+  it_should_behave_like 'Modes'
+end
+
+

data/spec/cantango/configuration/account_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+class BaseAccount
+  def initialize
+  end
+end
+
+
+describe CanTango::Configuration::Account do
+  subject { CanTango.config.account }
+
+  describe 'set base class' do
+    before do
+      subject.base_class = BaseAccount
+    end
+
+    its(:base_class) { should == BaseAccount }
+  end
+end
+
+

data/spec/cantango/configuration/accounts_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'cantango/configuration/shared/candidate_registry_ex'
+
+class UserAccount
+end
+
+class AdminAccount
+end
+
+describe CanTango::Configuration::Accounts do
+  subject { CanTango.config.accounts }
+
+  it_should_behave_like "Candidate Registry" do
+    let(:hash1) do
+      {:a => UserAccount, :b => AdminAccount}
+    end    
+  end
+end

data/spec/cantango/configuration/adapters_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe CanTango::Configuration::Adapters do
+  subject { CanTango.config.adapters }
+
+  describe 'should run adapter for moneta' do
+    before do
+      subject.adapter :moneta
+    end
+
+    specify { CanTango.config.adapters.registered?(:moneta).should be_true }
+    # specify { lambda { CanTango::MonetaCache }.should_not raise_error }
+    # specify { lambda { CanTango::MonetaAbilityCache }.should_not raise_error }
+    # specify { lambda { CanTango::MonetaPermitStore }.should_not raise_error }
+  end
+
+  specify { lambda { CanTango::Ability::Cache::Kompiler }.should raise_error }
+
+  describe 'should run adapter for sourcify compiler' do
+
+    before do
+      subject.adapter :compiler
+    end
+
+    specify { CanTango.config.adapters.registered?(:compiler).should be_true }
+    # specify { lambda { CanTango::Ability::Cache::Kompiler }.should_not raise_error }
+  end
+end
+
+

data/spec/cantango/configuration/autoload_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'fixtures/models'
+
+describe CanTango::Configuration::Autoload do
+  subject { CanTango.config.autoload }
+
+  describe 'default settings' do
+      its(:permits)     { should be_true }
+      its(:models)      { should be_true }
+  end
+
+  describe 'permits' do
+    describe 'turn off' do
+      before do
+        subject.permits :off
+      end
+
+      its(:permits)     { should be_false }
+      its(:permits?)    { should be_false }
+    end
+
+    describe 'turn on' do
+      before do
+        subject.permits :on
+      end
+
+      its(:permits)     { should be_true }
+      its(:permits?)    { should be_true }
+    end
+  end
+
+  describe 'models' do
+    describe 'turn off' do
+      before do
+        subject.models :off
+      end
+
+      its(:models)      { should be_false }
+      its(:models?)     { should be_false }
+    end
+
+    describe 'turn on' do
+      before do
+        subject.models :on
+      end
+
+      its(:models)      { should be_true }
+      its(:models?)     { should be_true }
+    end
+  end
+end
+

data/spec/cantango/configuration/candidate_registry_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'cantango/configuration/shared/candidate_registry_ex'
+
+class MyReg < CanTango::Configuration::CandidateRegistry
+end
+
+describe MyReg do
+  subject { MyReg.new }
+
+  it_should_behave_like "Candidate Registry" do
+  end
+end

data/spec/cantango/configuration/categories_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'cantango/configuration/shared/hash_registry_ex'
+
+describe CanTango::Configuration::Categories::Category do
+  subject { CanTango::Configuration::Categories::Category.new }
+    specify { subject.has_any?(:x).should_not be_true }
+
+  subject { CanTango::Configuration::Categories::Category.new :a, :b }
+    specify { subject.has_any?(:a).should be_true }
+end
+
+describe CanTango::Configuration::Categories do
+  subject { CanTango.config.categories }
+
+  describe 'API' do
+    before(:each) do
+      categories = {:a => ['B', 'C'], 'x' => ['Y', 'Z'], 'v' => ['B', 'Z']}
+
+      subject.clean!
+      subject.register categories
+    end
+
+    describe 'get index []' do
+      specify {
+        subject.register(:w => 'something non-array!')
+        lambda { subject.category('w') }.should raise_error
+      }
+    end
+
+    describe 'category_has_subject?' do
+      specify {
+        subject.category('a').has_any?('B').should be_true 
+      }
+    end
+
+    describe 'has_subject?' do
+      specify { subject.has_any?('Y').should be_true }
+    end
+
+    describe 'category_names_of_subject' do
+      specify { subject.category_names_of_subject('B').last.should == 'v' }
+
+      specify { subject.category_names_of_subject('c').first.should == nil }
+    end
+
+    describe 'categories_of_subject' do
+      specify do
+        subject.categories_of_subject('B').should == {'a' => ['B', 'C'], 'v' => ['B', 'Z'],}
+      end
+
+      specify do
+        subject.categories_of_subject('blip').should == {}
+      end
+    end
+  end
+end
+
+

data/spec/cantango/configuration/debug_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+class Context
+  include CanTango::Api::Ability::User
+end
+
+# Note: This config feature is currently not used, but could potentially be of use in the future
+describe CanTango::Configuration::Debug do
+  let(:context) { Context.new }
+  subject       { CanTango.config.debug }
+
+  describe 'should set debug mode :on' do
+    before do
+      subject.set :on
+    end
+
+    its(:on?) { should be_true }
+    its(:off?) { should be_false }
+  end
+
+  describe 'should set debug mode :off' do
+    before do
+      subject.set :on
+    end
+
+    its(:on?)   { should be_true  }
+    its(:off?)  { should be_false }
+  end
+
+  describe 'debug! should set debug mode :on' do
+    before do
+      CanTango.debug!
+    end
+
+    its(:on?) { should be_true }
+    its(:off?) { should be_false }
+  end
+end
+

data/spec/cantango/configuration/engines/engine_shared.rb

@@ -0,0 +1,22 @@
+shared_examples_for 'Engine' do
+  describe 'turn off' do
+    before :each do
+      subject.set :off
+    end
+
+    its(:on?)   { should be_false }
+    its(:off?)  { should be_true  }
+ end
+
+  describe 'turn on' do
+    before :each do
+      subject.set :on
+    end
+
+    its(:on?)   { should be_true  }
+    its(:off?)  { should be_false }
+  end
+end
+
+
+