troles 0.5.2 → 0.6.0

data/Gemfile

@@ -1,28 +1,33 @@
 source :rubygems
 
-gem 'sugar-high',   '>= 0.4.4'
-gem 'sweetloader',  '>= 0.1.0'
-gem 'require_all',  '~> 1.2.0'
+gem 'sugar-high',   '>= 0.6.0'
+gem 'sweetloader',  '>= 0.1.1'
+gem 'schemaker',    '>= 0.1.4'
 
-group :development, :test do
-  gem 'yard',         '>  0.6.1'
+group :test do
   gem 'rails',        '>= 3.0.1'
   gem 'rspec-rails',  '>= 2.4.0'
-  gem 'sqlite3'
+
   gem 'capybara',     '> 0.4.0'
   gem 'shoulda'
   gem 'factory_girl_rails'
   gem 'mocha'
-  gem 'database_cleaner', '~> 0.6.8', :git => "git://github.com/kristianmandrup/database_cleaner.git" 
+  gem 'database_cleaner', '~> 0.6.8', :git =>"git://github.com/kristianmandrup/database_cleaner.git" 
+
+  gem 'require_all',  '~> 1.2.0'
+  gem 'sqlite3'
+
+  # To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+  # gem 'ruby-debug'
+  # gem 'ruby-debug19'
+end
 
-  gem 'rake',         '~> 0.9.0'
+group :development do
+  gem 'rake',         '>= 0.9.0'
+  gem 'rspec',        '>= 2.4'
   gem 'bundler',      '>= 1'
   gem 'jeweler',      '>= 1.6'
   gem 'rdoc',         '>= 3.6'
   gem 'rcov'
   gem 'yard',         '>  0.6.1'
-
-  # To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
-  # gem 'ruby-debug'
-  # gem 'ruby-debug19'
 end

data/Gemfile.lock

@@ -7,37 +7,35 @@ GIT
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.1.0)
-      actionpack (= 3.1.0)
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
       mail (~> 2.3.0)
-    actionpack (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       i18n (~> 0.6)
       rack (~> 1.3.2)
-      rack-cache (~> 1.0.3)
+      rack-cache (~> 1.1)
       rack-mount (~> 0.8.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.0.0)
-    activemodel (3.1.0)
-      activesupport (= 3.1.0)
-      bcrypt-ruby (~> 3.0.0)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
       arel (~> 2.2.1)
       tzinfo (~> 0.3.29)
-    activeresource (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-    activesupport (3.1.0)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
       multi_json (~> 1.0)
     arel (2.2.1)
-    bcrypt-ruby (3.0.1)
     builder (3.0.0)
     capybara (1.1.1)
       mime-types (>= 1.16)
@@ -63,6 +61,7 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    json (1.6.1)
     json_pure (1.6.1)
     mail (2.3.0)
       i18n (>= 0.4.0)
@@ -75,8 +74,8 @@ GEM
     multi_json (1.0.3)
     nokogiri (1.5.0)
     polyglot (0.3.2)
-    rack (1.3.3)
-    rack-cache (1.0.3)
+    rack (1.3.4)
+    rack-cache (1.1)
       rack (>= 0.4)
     rack-mount (0.8.3)
       rack (>= 1.0.0)
@@ -84,24 +83,25 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.1.0)
-      actionmailer (= 3.1.0)
-      actionpack (= 3.1.0)
-      activerecord (= 3.1.0)
-      activeresource (= 3.1.0)
-      activesupport (= 3.1.0)
+    rails (3.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
       bundler (~> 1.0)
-      railties (= 3.1.0)
-    railties (3.1.0)
-      actionpack (= 3.1.0)
-      activesupport (= 3.1.0)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
     rake (0.9.2)
-    rcov (0.9.10)
-    rdoc (3.9.4)
+    rcov (0.9.11)
+    rdoc (3.10)
+      json (~> 1.4)
     require_all (1.2.0)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
@@ -117,20 +117,22 @@ GEM
       railties (~> 3.0)
       rspec (~> 2.6.0)
     rubyzip (0.9.4)
-    selenium-webdriver (2.7.0)
+    schemaker (0.1.4)
+      sweetloader (>= 0.1.1)
+    selenium-webdriver (2.8.0)
       childprocess (>= 0.2.1)
       ffi (>= 1.0.7)
       json_pure
       rubyzip
     shoulda (2.11.3)
-    sprockets (2.0.1)
+    sprockets (2.0.2)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (!= 1.3.0, ~> 1.1)
     sqlite3 (1.3.4)
     sugar-high (0.6.0)
       activesupport (>= 3.0.1)
-    sweetloader (0.1.0)
+    sweetloader (0.1.1)
       activesupport (>= 3.0.1)
       i18n
     thor (0.14.6)
@@ -154,13 +156,15 @@ DEPENDENCIES
   jeweler (>= 1.6)
   mocha
   rails (>= 3.0.1)
-  rake (~> 0.9.0)
+  rake (>= 0.9.0)
   rcov
   rdoc (>= 3.6)
   require_all (~> 1.2.0)
+  rspec (>= 2.4)
   rspec-rails (>= 2.4.0)
+  schemaker (>= 0.1.4)
   shoulda
   sqlite3
-  sugar-high (>= 0.4.4)
-  sweetloader (>= 0.1.0)
+  sugar-high (>= 0.6.0)
+  sweetloader (>= 0.1.1)
   yard (> 0.6.1)

data/README.textile

@@ -13,6 +13,35 @@ The roles list cache of a role subject (fx a user) is only updated (retrieved fr
 
 Note: Troles is a full redesign of _roles generic_ and company, using lessons learned. Troles uses a much cleaner design. It is aimed at being easy to extend and easy to create adapters for etc.
 
+h2. Update: Oct. 12
+
+Updated to use the latest _sugar-high_, _sweetloader_ and _schemaker_ gems. 
+Fixed most specs so they pass again. 
+
+In general, troles should now be working with respect to the API and various implementation strategies. 
+
+h3. Yard documentation
+
+This project uses "Yard":http://rubydoc.info/docs/yard/file/docs/GettingStarted.md for documentation.
+
+<pre>$ yard server
+
+From browser, go to: http://0.0.0.0:8808/  # then you can enjoy! the nice documentation :) 
+</pre>
+
+There is now support for Caching and invalidation of the _role_list_ when the roles change. 
+The specs now validate that caching works as it should.
+
+Please help out to finalize this project! :)
+
+h2. Bug hunting by running specs
+
+Run specs for at most one strategy at the time for now...
+
+@$ rspec spec/troles/strategies/bit_many_spec.rb@ 
+
+Please see the document _spec/Guide to running specs.textile_ where I advise on how best to do "bug hunting" to help get this project off the ground!
+
 h2. Role strategies
 
 The following lists the role strategies to be supported

data/Rakefile

@@ -10,6 +10,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
+require 'rspec'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
@@ -23,26 +24,3 @@ Jeweler::Tasks.new do |gem|
   gem.authors = ["Kristian Mandrup"]
 end
 Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "mongoid_geo #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.6.0

data/lib/trole.rb

@@ -2,9 +2,5 @@
 require 'troles/common'
 
 module Trole
-  autoload :Config,         'trole/config'
-  autoload :Api,            'trole/api'
-  autoload :Operations,     'trole/operations'
-  autoload :Strategy,       'trole/strategy'
-  autoload :Storage,        'trole/storage'
+  autoload_modules :Config, :Api, :Operations, :Strategy, :Storage
 end

data/lib/trole_groups/macros.rb

@@ -13,7 +13,7 @@
 
 module TroleGroups
   module Macros
-    autoload :Configuration, 'trole_groups/macros/configuration'
+    autoload_modules :Configuration
     
     def trolegroups_strategy strategy, options = {}, &block
       configuration = Configuration.new self, strategy, options
@@ -39,4 +39,3 @@ module TroleGroups
   end  
 end
 
-Module.send :include, TroleGroups::Macros

data/lib/trole_groups.rb

@@ -1,10 +1,7 @@
 require 'troles/common'
-require 'troles/macros'
 
 module TroleGroups  
-  autoload :Config,         'trole_groups/config'
-  autoload :Api,            'trole_groups/api'
-  autoload :Operations,     'trole_groups/operations'
-  autoload :Strategy,       'trole_groups/strategy'
-  autoload :Storage,        'trole_groups/storage'
-end
+  autoload_modules :Config, :Api, :Operations, :Strategy, :Storage, :Macros
+end
+
+Module.send :include, TroleGroups::Macros

data/lib/troles/adapters/active_record/config.rb

@@ -1,8 +1,12 @@
 module Troles::ActiveRecord
   class Config < Troles::Common::Config  
+
+    attr_reader :models
     
     def initialize subject_class, options = {}
-      super 
+      super       
+      puts "models classes: #{subject_class}, #{object_model}, #{join_model}"
+      @models = ::Schemaker::Models.new(subject_class, object_model, join_model)
     end
     
     def configure_relation
@@ -10,8 +14,8 @@ module Troles::ActiveRecord
       when :join_ref_many
         configure_join_model
       when :ref_many
-        return configure_join_model if join_model
-        has_and_belongs_many subject_class, object_model, :key => :accounts         
+        return configure_join_model if join_model?        
+        subject.quick_join
       when :embed_many
         raise "Embed many configuration not yet implemented for ActiveRecord" 
       end
@@ -23,38 +27,37 @@ module Troles::ActiveRecord
     
     protected
 
-    def object_model
-      role_model
-    end
-
-    def join_model
-      role_join_model
+    def subject
+      @subject ||= models.subject_model
     end
 
+    def main_field
+      role_field
+    end      
 
-    def role_join_model
+    def join_model
       @join_model_found ||= begin
-        models = [@join_model, join_model_best_guess].select do |class_name|
-          try_class(class_name.to_s.camelize)
-        end.compact
-        # puts "role models found: #{models}"
-        raise "No #{subject_class} to #{object_model} join class defined, define a #{join_model_best_guess} model class or set which class to use, using the :role_join_model option on configuration" if models.empty?
-        models.first.to_s.constantize
+        find_first_class(@join_model, join_model_best_guess)
       end
+    rescue ClassExt::ClassNotFoundError
+      nil
+    end
+
+    def join_model?
+      join_model
     end
 
     def join_model_best_guess
       "#{subject_class.to_s.pluralize}#{object_model.to_s.pluralize}"
     end
 
-    def role_join_model= model_class
+    def join_model= model_class
       @join_model = model_class and return if model_class.any_kind_of?(Class, String, Symbol)
-      raise "The role model must be a Class, was: #{model_class}"
+      raise "The join model must be a Class, was: #{model_class}"
     end
 
-
     def join_key
-      make_key role_join_model
+      make_key join_model
     end
     
     def configure_join_model           
@@ -64,25 +67,11 @@ module Troles::ActiveRecord
         puts "Role class: #{object_model}"
         puts "Join class: #{join_model}"
       end
-
-      # UserAccount
-      # has_many :troles, :class_name => 'Role', :through => :users_roles
-      has_many_for subject_class, object_model, :opts => {:through => join_key.to_sym}
-      # has_many :user_roles, :class_name => 'UserRole'
-      has_many_for subject_class, role_join_model, :key => join_key
-
-      # UserRole (custom join class name)
-      # belongs_to :user, :class_name => 'UserAccount'      
-      belongs_to_for role_join_model, subject_class
-      # belongs_to :role, :class_name => 'Role'      
-      belongs_to_for role_join_model, role_model
-
-      # Role
-      # has_many :accounts, :class_name => 'User', :through => :user_roles      
-      has_many_for object_model, subject_class, :key => :accounts, :opts => {:through => join_key.to_sym}
-
-      # has_many :user_roles, :class_name => 'UserRole'
-      has_many_for object_model, role_join_model, :key => join_key      
+            
+      [:object, :subject, :join].each do |type|
+        clazz = "Schemaker::#{type.to_s.camelize}Model".constantize
+        clazz.new(model).configure
+      end      
     end
   end
 end

data/lib/troles/common/api/read.rb

@@ -34,6 +34,7 @@ module Troles::Common::Api
     def has_roles? *roles
       (roles.to_symbols - role_list).empty?
     end
+    alias_method :has_all_roles?, :has_roles?
 
     # Checks if the role subject has any of the listed roles
     # (see #has_roles?)

data/lib/troles/common/config/class_methods.rb

@@ -0,0 +1,44 @@
+module Troles::Common
+  class Config
+    module ClassMethods
+      attr_reader :default_orm, :auto_load
+      attr_accessor :log_on
+
+      def log_on?
+        log_on || false
+      end
+  
+      def default_orm= orm
+        @default_orm ||= orm
+      end
+  
+      def auto_load= mode
+        raise "Autoload must be set to true or false" if ![true, false].include? mode
+        @auto_load = mode
+      end
+
+      def auto_load?
+        @auto_load
+      end      
+
+      def auto_config
+        auto_config_setings
+      end 
+  
+      def auto_config? name
+        auto_config_setings[name]
+      end
+  
+      protected
+
+      def auto_config_setings
+        @auto_config_setings ||= auto_config_defaults
+      end
+
+      # default auto_config settings
+      def auto_config_defaults
+        {:models => true, :relations => true, :fields => true}
+      end      
+    end
+  end
+end

data/lib/troles/common/config/schema/helpers.rb

@@ -11,85 +11,6 @@ module Troles::Common
         def boolean? value
           [true, false].include? value
         end
-
-        # TODO: Needs extraction into helper module!
-
-        def belongs_to_for from, to, options = {}
-          make_relationship :belongs_to, from, to, options
-        end
-
-        def has_many_for from, to, options = {}
-          make_relationship :has_many, from, to, options
-        end
-
-        def has_one_for from, to, options = {}
-          make_relationship :has_one, from, to, options
-        end
-
-        # To setup sth like this:
-        #
-        # class UserAccount < ActiveRecord::Base    
-        #   has_and_belongs_to_many :troles, :class_name => 'Role'
-        # end
-        # 
-        # class Role < ActiveRecord::Base    
-        #   has_and_belongs_to_many :user_accounts, :class_name => 'User'
-        # end
-        def has_and_belongs_many from, to, options = {}
-          make_relationship :has_and_belongs_to_many, from, to, :key => role_field
-          make_relationship :has_and_belongs_to_many, to, from, options
-        end
-
-        def get_model_type class_name
-          return :subject if class_name == subject_class
-          return :object  if class_name == object_model
-          return :join    if class_name == role_join_model
-          raise "Not a known model: #{class_name}"
-        end
-
-        # options: 
-        # - :opts, extras options, fx to set the :through relationship
-        # - :key (usually to enforce use of role_field as key name)      
-        def make_relationship type, from, to, options = {}
-          # puts "type: #{type}, #{from}, #{to}"
-          from_type = get_model_type from
-          to_type = get_model_type to
-
-          key_opts = key_options(type, to_type)
-
-          model_key = options[:key] ? options[:key] : send("#{to_type}_key", key_opts)
-
-          class_name = send "#{to_type}_class_name"
-
-          rel_options = {:class_name => class_name}   
-
-          rel_options.merge!(options[:opts]) if options[:opts]
-
-          puts "#{from}.#{type} :#{model_key}, #{rel_options.inspect}" if log_on?
-          
-          from.send(type, model_key, rel_options)
-        end
-            
-        def object_key options = {}
-          make_key "#{object_class_name}", options
-        end
-
-        def key_options type, obj
-          return {:prefix => 't'} if (type == :has_many && obj == :object) 
-          {}
-        end
-        
-        def make_key name, options = {}
-          name = name.to_s.gsub(/::/, '__').underscore.pluralize
-          parts = name.split('_')
-          name = parts.inject([]) do |res, part|
-            res << (part != parts.last ? part.singularize : part)
-            res
-          end.join('_')
-          
-          key = name
-          options[:prefix] ? "t#{key}" : key
-        end
       end
     end
   end

data/lib/troles/common/config/schema.rb

@@ -1,66 +1,69 @@
+# 
+# @author Kristian Mandrup
+#
+# Schema configuration
+# Has responsibiloity to configure relationships between models
+#
 module Troles::Common
   class Config
     module Schema
-      autoload :Helpers,      'troles/common/config/schema/helpers'
-      autoload :RoleHelpers,  'troles/common/config/schema/role_helpers'
-      
+      autoload_modules :Helpers
+
+      # configures the models if set to do so
+      # first configures 
       def configure_models
-        configure_generic
+        configure_generic if generic?
         configure_field if auto_config?(:fields)
         configure_relation if auto_config?(:relations)
       end         
 
-      def configure_generic                    
-        subject_class.send(:attr_accessor, role_field)  if generic? || orm == :generic # create troles accessor      
+      # configures main field (fx role field) as a generic accessor
+      def configure_generic
+        raise "Subject class must be a Class" unless subject_class.is_a?(Class)
+        subject_class.send(:attr_accessor, main_field) # create troles accessor      
       end
 
-      # Adapter should customize this as needed 
+      # configures a single main field on the subject
+      # fx if the roles are stored as a Boolean, Integer or String
+      # @note adapter should customize this as needed 
       def configure_field
       end
 
-      # Adapter should customize this as needed 
+      # configures model relationships for roles
+      # fx if the roles are stored in an model, either embedded or referenced 
+      # @note adapter should customize this as needed 
       def configure_relation
       end
 
-      # Sets the role model to use
-      # allows different role subject classes (fx User Accounts) to have different role schemas
-      # @param [Class] the model class
-      def role_model= model_class
-        @role_model = model_class.to_s and return if model_class.any_kind_of?(Class, String, Symbol)
-        raise "The role model must be a Class, was: #{model_class}"
+      # Sets the object model to use
+      # allows different subject classes (fx User Accounts) to have different schemas
+      # @param [Class, String, Symbol] the model class
+      def object_model= model_class
+        @object_model = model_class.to_s and return if model_class.any_kind_of?(Class, String, Symbol)
+        raise "The object model must be a Class, was: #{model_class}"
       end
+      alias_method :role_mode=, :object_model=
 
-      # Gets the role model to be used
-      # see (#role_model=)
-      # @return [Class] the model class (defaults to Role)
-      def role_model
-        @role_model_found ||= begin
-          models = [@role_model, role_class_name].select do |class_name|
-            try_class(class_name.to_s.camelize)
-          end.compact
-          # puts "role models found: #{models}"
-          raise "No #{role_class_name} class defined, define a #{role_class_name} class or set which class to use, using the :role_model option on configuration" if models.empty?
-          models.first.to_s.constantize
-        end
+      # Gets the object model to be used
+      # see (#object_model=)
+      # see(#default_object_model_class_name)
+      #
+      # @return [Class] the model class
+      def object_model
+        @object_model_found ||= find_first_class(@object_model, default_object_model_class_name)
       end
+      alias_method :role_model, :object_model
 
       protected
 
-      def role_class_name
+      def default_object_model_class_name
         'Role'
       end
 
-      def try_class clazz
-        begin
-          clazz = clazz.constantize if clazz.kind_of?(String)
-          clazz
-        rescue          
-          false
-        end
-      end
+      # from sugar-high gem
+      include ClassExt
                      
-      include Helpers
-      include RoleHelpers      
+      include Helpers # ??
     end
   end
 end