troles 0.5.2 → 0.6.0

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

@@ -1,10 +1,20 @@
+# 
+# @author Kristian Mandrup
+#
+# Valid roles module
+# Adds methods for operating on/with valid roles
+#
 module Troles::Common
   class Config
-    module ValidRoles
+    module ValidRoles    
+      # Add a list of valid roles
+      # @param [Array<Symbol>] names of roles to make valid
       def add_valid_roles *roles
         valid_roles =valid_roles & roles
       end
 
+      # Set a list of valid roles
+      # @param [Array<Symbol>] names of roles to make valid
       def valid_roles= *roles
         vrs = roles.flatten.map{|r| r.to_s.alpha_numeric}.map(&:to_sym).uniq
 
@@ -13,6 +23,8 @@ module Troles::Common
         @valid_roles ||= vrs
       end
 
+      # Get the list of valid roles
+      # @return [Array<Symbol>] names of roles that are currently valid
       def valid_roles
         raise "No valid roles defined" if !@valid_roles || @valid_roles.empty?
         @valid_roles

data/lib/troles/common/config.rb

@@ -1,130 +1,97 @@
 module Troles::Common
   class Config
-    autoload :ValidRoles,     'troles/common/config/valid_roles'        
-    autoload :StaticRoles,    'troles/common/config/static_roles'
-    autoload :Schema,         'troles/common/config/schema'
-    autoload :SchemaHelpers,  'troles/common/config/schema_helpers'
+    autoload_modules :ValidRoles, :StaticRoles, :Schema, :SchemaHelpers, :ClassMethods
 
     def self.sub_modules
       [:valid_roles, :static_roles, :schema]
     end
-    
+
+    # include sub-modules as needed
     sub_modules.each do |name|    
       send :include, "Troles::Common::Config::#{name.to_s.camelize}".constantize
     end
 
-    attr_accessor :subject_class, :strategy, :log_on, :generic, :auto_relations
+    attr_accessor :subject_class, :strategy, :log_on, :generic
     attr_writer   :orm
-    
+
+    # configure Config object with subject class and various options
     def initialize subject_class, options = {}
+      raise ArgumentError, "The first argument must be the Class which is the subject of the behavior" unless subject_class.is_a?(Class)
       @subject_class = subject_class
-      # set instance var for each pair in options
+
       apply_options! options
     end
 
-    class << self
-      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
+    extend ClassMethods
 
-      def auto_load?
-        @auto_load
+    # Call setter for each key/value pair
+    def apply_options! options = {}
+      options.each_pair do |key, value| 
+        send("#{key}=", value) if self.respond_to?(:"#{key}=")
       end      
+    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      
+    # Configure subject with behavior
+    # First apply any remaining options needed
+    # Then configure models if configured to do do
+    def configure! options = {}
+      apply_options! options
+      configure_models if auto_config?(:models)
     end
 
+    # is logging on?
     def log_on?
       log_on || Troles::Config.log_on
     end
 
+    # get the auto configuration settings hash
     def auto_config
-      auto_config_setings 
+      @auto_config ||= {}
     end 
-    
+
+    # is a certain type of auto configuration enabled?
     def auto_config? name
-      return auto_config_setings[name] if !auto_config_setings[name].nil?
+      return auto_config[name] if !auto_config[name].nil?
       Troles::Config.auto_config?(name)
     end
 
-    def apply_options! options = {}
-      options.each_pair do |key, value| 
-        send("#{key}=", value) if self.respond_to?(:"#{key}")
-      end      
-    end
-
-    def configure! options = {}
-      apply_options! options
-      configure_models if auto_config?(:models)
-    end
-    
-    # protected
-
-    def auto_config_setings
-      @auto_config_setings ||= {}
-    end
-
-    def role_field
-      @role_field ||= begin
-        default_role_field
+    # Get the main field name that is used for the behavior added, fx :troles for roles behavior
+    def main_field
+      @main_field ||= begin
+        default_main_field
       end
     end
+    alias_method :role_field, :main_field
 
-    def role_field= field_name
+    # Set the main field of the behavior
+    def main_field= field_name
       name = field_name.to_s.alpha_numeric.to_sym
-      raise ArgumentException, "Not a valid role field name: #{field_name}"  if !valid_field_name?(name)
-      @role_field ||= name
+      raise ArgumentException, "Not a valid field name: #{field_name}"  if !valid_field_name?(name)
+      @main_field ||= name
     end
+    alias_method :role_field=, :main_field=
 
-    def default_role_field
-      singularity == :many ? :troles : :trole
+    # get the default name of the main field
+    # for roles, it depends on the singularity (one or many) of the strategy
+    # see (#singularity)
+    def default_main_field
+      @default_main_field ||= (singularity == :many) ? :troles : :trole
     end
+    alias_method :default_role_field, :default_main_field
 
+    # get the orm name
     def orm
       @orm || self.class.default_orm
     end
 
+    # get the singularity (one or many) of the strategy
     def singularity
       @singularity ||= (strategy =~ /_many$/) ? :many : :one
     end
 
-    # def singularity= value
-    #   raise ArgumentError, "Must be :many or :one" if ![:one, :many].include?(value)      
-    #   @singularity ||= value
-    # end
-            
+    # is it a generic strategy/orm ?
     def generic?
-      return true if orm.nil?
+      return true if orm.nil? || orm == :generic
       @generic.nil? ? false : @generic
     end
   end

data/lib/troles/common/dependencies.rb

@@ -1,4 +1,5 @@
 require 'sweetloader'
+require 'schemaker'
 require 'sugar-high/kind_of'
 require 'sugar-high/string'
 require 'sugar-high/array'

data/lib/troles/common/macros/configuration/base_loader.rb

@@ -1,7 +1,9 @@
-module Troles::Macros
+module Troles::Common::Macros
   class Configuration  
     class BaseLoader
       attr_reader :strategy, :orm
+
+      include ClassExt
       
       def initialize strategy, orm
         @strategy = strategy
@@ -12,16 +14,10 @@ module Troles::Macros
         (strategy =~ /_many$/) ? :many : :one
       end
       
-      def try_module full_name
-        begin
-          full_name.constantize
-          true
-        rescue
-          # puts "module #{full_name} not found!"
-          false
-        end
+      def strategy_class
+        strategy.to_s.camelize
       end
-
+      
       def base_class
         "Base#{singularity.to_s.camelize}"
       end

data/lib/troles/common/macros/configuration/config_loader.rb

@@ -1,4 +1,4 @@
-module Troles::Macros
+module Troles::Common::Macros
   class Configuration  
     class ConfigLoader < BaseLoader
             
@@ -7,12 +7,7 @@ module Troles::Macros
       end
 
       def config_class
-        begin       
-          "#{orm_namespace}::Config".constantize
-        rescue
-          # use generic if no ORM specific strategy found!
-          "#{namespace}::Config".constantize
-        end        
+        @config_class ||= find_first_class("#{orm_namespace}::Config", "#{namespace}::Config")
       end
     end
   end

data/lib/troles/common/macros/configuration/storage_loader.rb

@@ -1,4 +1,4 @@
-module Troles::Macros
+module Troles::Common::Macros
   class Configuration  
     class StorageLoader < BaseLoader
 
@@ -7,13 +7,8 @@ module Troles::Macros
       end
 
       def storage_class
-        begin
-          "#{orm_namespace}::Storage::#{strategy.to_s.camelize}".constantize
-        rescue
-          # use generic if no ORM specific strategy found!
-          "#{namespace}::Storage::#{strategy.to_s.camelize}".constantize
-        end        
-      end      
+        @storage_class ||= find_first_class("#{orm_namespace}::Storage::#{strategy_class}", "#{namespace}::Storage::#{strategy_class}")
+      end
     end
   end
 end

data/lib/troles/common/macros/configuration/strategy_loader.rb

@@ -1,4 +1,4 @@
-module Troles::Macros
+module Troles::Common::Macros
   class Configuration  
     class StrategyLoader < BaseLoader
 
@@ -13,25 +13,11 @@ module Troles::Macros
       protected
 
       def orm_strategy_module
-        @orm_strategy_module ||= begin         
-          mods_found = ["#{orm_namespace}::Strategy::#{strategy.to_s.camelize}", "#{namespace}::Strategy::#{base_class}"].select do |full_name|
-            try_module(full_name)
-          end
-          !mods_found.empty? ? mods_found.first.constantize : nil
-        end
+        @orm_strategy_module ||= find_first_module("#{orm_namespace}::Strategy::#{strategy_class}", "#{namespace}::Strategy::#{base_class}")
       end
 
       def generic_strategy_module strategy_name, options
-        @generic_module ||= begin
-          base_class = base_name(strategy_name) 
-  
-          # use generic if no ORM specific strategy found!
-          ns = namespace(strategy_name, options)
-          mods_found = ["#{namespace}::Strategy::#{strategy.to_s.camelize}", "#{namespace}::Strategy::#{base_class}"].select do |full_name|
-            try_module(full_name)
-          end        
-          !mods_found.empty? ? mods_found.first.constantize : nil
-        end
+        @generic_module ||= find_first_module("#{namespace}::Strategy::#{strategy_class}", "#{namespace}::Strategy::#{base_class}")
       end
     end
   end

data/lib/troles/common/macros/configuration.rb

@@ -1,10 +1,7 @@
-module Troles  
+module Troles::Common  
   module Macros    
     class Configuration
-      autoload :BaseLoader,     'troles/common/macros/configuration/base_loader'
-      autoload :ConfigLoader,   'troles/common/macros/configuration/config_loader'
-      autoload :StrategyLoader, 'troles/common/macros/configuration/strategy_loader'
-      autoload :StorageLoader,  'troles/common/macros/configuration/storage_loader'      
+      autoload_modules :BaseLoader, :ConfigLoader, :StrategyLoader, :StorageLoader
       
       attr_reader :strategy, :singularity, :orm, :auto_load, :options, :subject_class
       

data/lib/troles/common/macros.rb

@@ -9,9 +9,9 @@
 #     troles_strategy :bit_many
 #
 
-module Troles  
+module Troles::Common  
   module Macros
-    autoload :Configuration, 'troles/common/macros/configuration'
+    autoload_modules :Configuration
     
     def troles_strategy strategy, options = {}, &block
       configuration = Configuration.new self, strategy, options
@@ -35,4 +35,3 @@ module Troles
   end  
 end
 
-Module.send :include, Troles::Macros

data/lib/troles/common/marshaller.rb

@@ -8,7 +8,6 @@
 # 
 module Troles::Common
   module Marshaller
-    autoload :Generic,   'troles/common/marshaller/generic'
-    autoload :Bitmask,   'troles/common/marshaller/bitmask'
+    autoload_modules :Generic, :Bitmask
   end
 end

data/lib/troles/common/operations.rb

@@ -8,8 +8,7 @@
 #
 module Troles::Common
   class Operations        
-    autoload :Read,     'troles/common/operations/read'
-    autoload :Write,    'troles/common/operations/write'
+    autoload_modules :Read, :Write
 
     include Read
     include Write

data/lib/troles/common.rb

@@ -7,11 +7,6 @@ require 'troles/common/dependencies'
 
 module Troles
   module Common
-    autoload :Api,          'troles/common/api'
-    autoload :Config,       'troles/common/config'
-    autoload :Operations,   'troles/common/operations'
-    autoload :Marshaller,   'troles/common/marshaller'
-    autoload :Storage,      'troles/common/storage'
-    autoload :EventManager, 'troles/common/event_manager'
+    autoload_modules :Api, :Config, :Operations, :Marshaller, :Storage,  :EventManager, :Macros
   end
 end

data/lib/troles/config.rb

@@ -3,13 +3,5 @@ module Troles
     def initialize subject_class, options = {}
       super
     end
-
-    def configure_models
-      super
-    end
-
-    def generic?
-      super
-    end
   end
 end

data/lib/troles/macros.rb

@@ -1,5 +1,3 @@
-require 'troles/common/macros'
-
 module Troles  
   module Macros
   end  

data/lib/troles/storage/base_many.rb

@@ -11,7 +11,7 @@ module Troles
       # @param  [Array<Symbol>] list of role names to find Roles for
       # @return [Array<Role>] references to Role instances
       def find_roles *roles
-        role_model.where(:name => roles.flatten).all
+        role_model.where(:name => roles.flatten)
       end
 
       # get list of embedded Role instances

data/lib/troles/storage.rb

@@ -4,11 +4,6 @@
 #
 module Troles
   module Storage
-    autoload :BaseMany,     'troles/storage/base_many'
-    autoload :BitMany,      'troles/storage/bit_many'
-    autoload :EmbedMany,    'troles/storage/embed_many'
-    autoload :RefMany,      'troles/storage/ref_many'
-    autoload :JoinRefMany,  'troles/storage/join_ref_many'
-    autoload :StringMany,   'troles/storage/string_many'    
+    autoload_modules :BaseMany, :BitMany, :EmbedMany, :RefMany, :JoinRefMany, :StringMany
   end
 end

data/lib/troles/strategy.rb

@@ -1,3 +1,5 @@
+puts "BaseMany"
+
 # @author Kristian Mandrup
 #
 # Base module for Many roles strategies

data/lib/troles.rb

@@ -1,6 +1,7 @@
 require 'troles/common'
-require 'troles/macros'
 
 module Troles
-  autoload_modules :Config, :Common, :Api, :Operations, :Strategy, :Storage
+  autoload_modules :Config, :Common, :Api, :Operations, :Strategy, :Storage, :Macros
 end
+
+Module.send :include, Troles::Common::Macros

data/spec/active_record/migrations/many/bit_many.rb

@@ -1,16 +1,10 @@
 class CreateBitMany < ActiveRecord::Migration
-  def self.up
-    # down
-    
+  def change
     create_table :users do |t|
       t.string  :name
       t.integer :troles
       t.timestamps
     end
   end
-  
-  def self.down  
-    drop_table :users
-  end
 end
     

data/spec/active_record/migrations/many/custom_join.rb

@@ -1,9 +1,8 @@
 class CreateCustomJoin < ActiveRecord::Migration
-  def self.up
-    # down
-
+  def change
     create_table :users do |t|
       # implicit user_id binds to user_id of roles_users join table
+      t.integer :troles
       t.string :name
       t.timestamps
     end
@@ -21,11 +20,5 @@ class CreateCustomJoin < ActiveRecord::Migration
       t.timestamps
     end    
   end
-  
-  def self.down  
-    drop_table :users
-    drop_table :roles
-    drop_table :users_roles
-  end
 end
 

data/spec/active_record/migrations/many/join_ref_many.rb

@@ -1,7 +1,5 @@
 class CreateJoinRefMany < ActiveRecord::Migration
-  def self.up
-    # down
-
+  def change
     create_table :users do |t|
       # implicit user_id binds to user_id of roles_users join table
       t.string :name
@@ -13,7 +11,6 @@ class CreateJoinRefMany < ActiveRecord::Migration
       t.integer :user_id
       t.integer :role_id
     end
-
     
     create_table :roles do |t|
       # implicit role_id binds to role_id of roles_users join table
@@ -21,11 +18,5 @@ class CreateJoinRefMany < ActiveRecord::Migration
       t.timestamps
     end    
   end
-  
-  def self.down  
-    drop_table :users
-    drop_table :roles
-    drop_table :users_roles
-  end
 end
 

data/spec/active_record/migrations/many/ref_many.rb

@@ -1,23 +1,22 @@
 class CreateRefMany < ActiveRecord::Migration
-  def self.up
-    # down
-
+  def change
     create_table :users do |t|
       # implicit user_id binds to user_id of roles_users join table
       t.string :name
       t.timestamps
     end
 
+    # join table
+#    create_table :roles_users, :id => false do |t|
+#      t.integer :user_id
+#      t.integer :role_id
+#    end
+
     create_table :roles do |t|
       # implicit role_id binds to role_id of roles_users join table
       t.string :name
       t.timestamps
     end    
   end
-  
-  def self.down  
-    drop_table :users
-    drop_table :roles
-  end
 end
 

data/spec/active_record/migrations/many/string_many.rb

@@ -1,16 +1,10 @@
 class CreateStringMany < ActiveRecord::Migration
-  def self.up
-    # down
-
+  def change
     create_table :users do |t|
       t.string :name
       t.string :troles
       t.timestamps
     end
   end
-  
-  def self.down  
-    drop_table :users
-  end
 end
 

data/spec/active_record/migrations/one/bit_one.rb

@@ -1,14 +1,10 @@
 class CreateBitOne < ActiveRecord::Migration
-  def self.up        
+  def change        
     create_table :users do |t|
       t.string :name
       t.boolean :trole
       t.timestamps
     end
   end
-  
-  def self.down
-    drop_table :users
-  end
 end
 

data/spec/active_record/migrations/one/ref_one.rb

@@ -1,5 +1,5 @@
 class CreateRefOne < ActiveRecord::Migration
-  def self.up
+  def change
     create_table :users do |t|
       t.string :name
       t.integer :role_id # a user can have ONE role
@@ -11,10 +11,5 @@ class CreateRefOne < ActiveRecord::Migration
       t.timestamps
     end
   end
-  
-  def self.down
-    drop_table :users
-    drop_table :roles
-  end  
 end
 

data/spec/active_record/migrations/one/string_one.rb

@@ -1,14 +1,10 @@
 class CreateStringOne < ActiveRecord::Migration
-  def self.up
+  def change
     create_table :users do |t|
       t.string :name
       t.string :trole
       t.timestamps
     end
   end
-  
-  def self.down
-    drop_table :users
-  end
 end
 

data/spec/active_record_helper.rb

@@ -21,12 +21,16 @@ ActiveRecord::Base.logger = Logger.new(STDERR)
 DatabaseCleaner.strategy = :truncation
 
 def migration_folder(name)
-  path = File.dirname(__FILE__) + "/migrations/#{name}"
+  File.dirname(__FILE__) + "/active_record/migrations/#{name}"
 end
 
-def migrate(name)
-  singularity = (name =~/_many/) ? :many : :one                  
-  ActiveRecord::Migrator.migrate migration_folder File.join(singularity, name)
+def migrate name = :ref_many
+  singularity = (name.to_s =~ /_many/) ? :many : :one                  
+  migration_file = migration_folder(File.join [singularity, name].map(&:to_s))
+  puts "mig file: #{migration_file}"
+  require migration_file
+
+  "Create#{name.to_s.camelize}".constantize.new.change
 end
 
 RSpec.configure do |config|

data/spec/factories.rb

@@ -1,3 +1,5 @@
+puts "Factories loaded"
+
 Factory.define :user do |u|
   u.name 'kris'
 end

data/spec/trole_groups/api/read_api_spec.rb

@@ -18,7 +18,7 @@ shared_examples_for "TroleGroup Read API" do
 
     # adding single roles and role groups together produces union of roles from all :)
     user.add_roles :editor    
-    user.role_list.should include(:editor, :blogger, :blog_editor, :admin, :blog_admin)
+    user.role_list.should include(:blogger, :blog_editor, :admin, :blog_admin)
   end
         
   specify { user.has_any_rolegroup?(:blog_admin, :admin).should be_true }