troles 0.5.1 → 0.5.2

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

@@ -41,8 +41,9 @@ module Troles::Common
         end
 
         def get_model_type class_name
-          return :user if class_name == subject_class
-          return :role if class_name == object_model
+          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
 
@@ -54,22 +55,40 @@ module Troles::Common
           from_type = get_model_type from
           to_type = get_model_type to
 
-          model_key = options[:key] ? options[:key] : send("#{from_type}_key")
+          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"
 
-          options = {:class_name => class_name}
-          options.merge!(options[:opts]) if options[:opts]
-          puts "#{from}.#{type} :#{model_key}, #{options.inspect}" if log_on?
-          from.send(type, model_key, options)
+          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
-          make_key object_class_name
+        def object_key options = {}
+          make_key "#{object_class_name}", options
         end
 
-        def make_key name
-          name.to_s.gsub(/::/, '__').underscore.pluralize      
+        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

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

@@ -6,16 +6,16 @@ module Troles::Common
           subject_class.to_s
         end
 
-        def subject_key
-          make_key subject_class_name
+        def subject_key options = {}
+          make_key subject_class_name, options
         end
 
         def join_class_name
-          join_model.to_s
+          role_join_model.to_s
         end
 
-        def join_key
-          make_key join_class_name
+        def join_key options = {}
+          make_key join_class_name, options
         end
 
         def object_class_name

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

@@ -1,12 +1,13 @@
 module Troles::Common
   class Config
-    module ValidRoles    
+    module ValidRoles
       def add_valid_roles *roles
         valid_roles =valid_roles & roles
       end
 
       def valid_roles= *roles
         vrs = roles.flatten.map{|r| r.to_s.alpha_numeric}.map(&:to_sym).uniq
+
         raise ArgumentError, "The #{strategy} strategy can only accept 2 valid roles" if (vrs.size > 2) && strategy == :bit_one
         raise ArgumentError, "The role names you want to be valid are not valid role names. Must be alphanumeric, was: #{roles.flatten}" if vrs.empty?
         @valid_roles ||= vrs
@@ -14,8 +15,8 @@ module Troles::Common
 
       def valid_roles
         raise "No valid roles defined" if !@valid_roles || @valid_roles.empty?
-        @valid_roles      
+        @valid_roles
       end
     end
   end
-end
+end

data/lib/troles/common/dependencies.rb

@@ -1,7 +1,7 @@
+require 'sweetloader'
 require 'sugar-high/kind_of'
 require 'sugar-high/string'
 require 'sugar-high/array'
-require 'sugar-high/class_ext'
 require 'active_support/inflector'
 require 'troles/meta'
 

data/lib/troles/common/storage.rb

@@ -29,6 +29,12 @@ module Troles::Common
     # @param [Object] the value to set on the role field of the role subject
     def set_ds_field value
       return if ds_field_value == value
+
+      if Troles::Common::Config.log_on?
+        puts "Troles::Common::Storage.set_ds_field:"
+        puts "#{rolegroup_subject}.#{ds_field_name} = #{value}"
+      end
+
       role_subject.send(:"#{ds_field_name}=", value)
       persist_role_changes!
     end
@@ -47,10 +53,16 @@ module Troles::Common
 
     # Attempts to persist the role field changes
     # @return [true, false, error] true if saved, false if no save! method, Error on some error
-    def persist_role_changes!  
-      return false if !role_subject.respond_to? :save!
-      role_subject.save!
-      role_subject.publish_change :roles
+    def persist_role_changes!           
+      puts "Troles::Common::Storage::BaseMany.persist_role_changes!" if Troles::Common::Config.log_on?
+      if !role_subject.respond_to? :save
+        puts "could not save since no #save method on subject: #{role_subject}" if Troles::Common::Config.log_on?
+        return false 
+      else      
+        puts "#{role_subject}.save" if Troles::Common::Config.log_on?         
+        role_subject.save
+        role_subject.publish_change :roles
+      end
     end 
 
     protected

data/lib/troles/common.rb

@@ -13,5 +13,5 @@ module Troles
     autoload :Marshaller,   'troles/common/marshaller'
     autoload :Storage,      'troles/common/storage'
     autoload :EventManager, 'troles/common/event_manager'
-  end  
-end
+  end
+end

data/lib/troles/config.rb

@@ -1,15 +1,15 @@
 module Troles
-  class Config < Troles::Common::Config    
+  class Config < Troles::Common::Config
     def initialize subject_class, options = {}
       super
     end
 
     def configure_models
       super
-    end       
-        
+    end
+
     def generic?
       super
     end
   end
-end
+end

data/lib/troles/storage/join_ref_many.rb

@@ -0,0 +1,13 @@
+# @author Kristian Mandrup
+# 
+# Many role storage for storing multiple Role references on the role subject
+#
+# @note all methods potentially operate directly on values in the data store
+#
+module Troles::Storage
+  class JoinRefMany < RefMany
+    def initialize role_subject
+      super
+    end
+  end
+end

data/lib/troles/storage.rb

@@ -4,10 +4,11 @@
 #
 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 :StringMany, 'troles/storage/string_many'    
+    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'    
   end
 end

data/lib/troles.rb

@@ -1,11 +1,6 @@
 require 'troles/common'
 require 'troles/macros'
 
-module Troles  
-  autoload :Config,         'troles/config'
-  autoload :Common,         'troles/common'
-  autoload :Api,            'troles/api'
-  autoload :Operations,     'troles/operations'
-  autoload :Strategy,       'troles/strategy'
-  autoload :Storage,        'troles/storage'
-end
+module Troles
+  autoload_modules :Config, :Common, :Api, :Operations, :Strategy, :Storage
+end

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

@@ -0,0 +1,31 @@
+class CreateCustomJoin < ActiveRecord::Migration
+  def self.up
+    # down
+
+    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_join, :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
+    drop_table :users_roles
+  end
+end
+

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

@@ -0,0 +1,31 @@
+class CreateJoinRefMany < ActiveRecord::Migration
+  def self.up
+    # down
+
+    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 :users_roles, :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
+    drop_table :users_roles
+  end
+end
+

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

@@ -8,13 +8,6 @@ class CreateRefMany < ActiveRecord::Migration
       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
@@ -25,7 +18,6 @@ class CreateRefMany < ActiveRecord::Migration
   def self.down  
     drop_table :users
     drop_table :roles
-    drop_table :users_roles
   end
 end
 

data/spec/active_record/models/custom_join.rb

@@ -0,0 +1,13 @@
+require "active_record/migrations/many/custom_join"
+
+class User < ActiveRecord::Base    
+  # has_and_belongs_to_many :troles, :class_name => 'Role'
+end
+
+class Role < ActiveRecord::Base    
+  # has_and_belongs_to_many :accounts, :class_name => 'User'
+end 
+
+class RolesUsersJoin < ActiveRecord::Base
+end
+

data/spec/active_record/models/join_ref_many.rb

@@ -0,0 +1,13 @@
+require "active_record/migrations/many/join_ref_many"
+
+class User < ActiveRecord::Base    
+  # has_and_belongs_to_many :troles, :class_name => 'Role'
+end
+
+class Role < ActiveRecord::Base    
+  # has_and_belongs_to_many :accounts, :class_name => 'User'
+end 
+
+class UsersRoles < ActiveRecord::Base
+end
+

data/spec/active_record/models/ref_many.rb

@@ -8,6 +8,4 @@ class Role < ActiveRecord::Base
   # has_and_belongs_to_many :accounts, :class_name => 'User'
 end 
 
-class MyUsersRoles < ActiveRecord::Base
-end
 

data/spec/active_record/strategies/many/custom_join_spec.rb

@@ -0,0 +1,46 @@
+require "active_record/strategy_helper"
+require 'active_record/models/custom_join'
+
+def migrate_up
+  CreateCustomJoin.up # run migration
+  Config.add_roles [:user, :admin, :editor, :blogger]
+end
+
+def migrate_down
+  CreateCustomJoin.down
+end      
+
+User.troles_strategy :ref_many do |c|
+  c.valid_roles = [:user, :admin, :blogger, :editor]
+  # c.auto_config[:relations] = false
+end.configure! :role_join_model => 'RolesUsersJoin'
+
+module UserSetup
+  def find_role name
+    Role.where(:name => name.to_sym).first
+  end
+
+  def create_no_roles_user
+    Factory.create :user, :name => 'no roles', :troles => []
+  end
+
+  def create_user
+    Factory.create :user, :name => 'normal', :troles => [ find_role(:user) ]
+  end
+
+  def create_admin_user
+    Factory.create :user, :name => 'admin', :troles => [ find_role(:admin) ]
+  end
+
+  def create_complex_user
+    Factory.create :user, :name => 'user and admin', :troles => [ find_role(:user), find_role(:admin) ]
+  end
+end
+
+
+require 'troles/common/api_spec' # Common API examples  
+
+describe 'Troles strategy Custom Join' do
+  it_should_behave_like "Common API"
+  # it_should_behave_like "Troles API"  
+end    

data/spec/active_record/strategies/many/join_ref_many_spec.rb

@@ -0,0 +1,46 @@
+require "active_record/strategy_helper"
+require 'active_record/models/join_ref_many'
+
+def migrate_up
+  CreateJoinRefMany.up # run migration
+  Config.add_roles [:user, :admin, :editor, :blogger]
+end
+
+def migrate_down
+  CreateJoinRefMany.down
+end      
+
+User.troles_strategy :join_ref_many do |c|
+  c.valid_roles = [:user, :admin, :blogger, :editor]
+  # c.auto_config[:relations] = false
+end.configure!
+
+module UserSetup
+  def find_role name
+    Role.where(:name => name.to_sym).first
+  end
+
+  def create_no_roles_user
+    Factory.create :user, :name => 'no roles', :troles => []
+  end
+
+  def create_user
+    Factory.create :user, :name => 'normal', :troles => [ find_role(:user) ]
+  end
+
+  def create_admin_user
+    Factory.create :user, :name => 'admin', :troles => [ find_role(:admin) ]
+  end
+
+  def create_complex_user
+    Factory.create :user, :name => 'user and admin', :troles => [ find_role(:user), find_role(:admin) ]
+  end
+end
+
+
+require 'troles/common/api_spec' # Common API examples  
+
+describe 'Troles strategy :ref_many_join' do
+  it_should_behave_like "Common API"
+  # it_should_behave_like "Troles API"  
+end    

data/spec/active_record/strategies/many/ref_many_spec.rb

@@ -12,8 +12,8 @@ end
 
 User.troles_strategy :ref_many do |c|
   c.valid_roles = [:user, :admin, :blogger, :editor]
-  c.auto_config[:relations] = false
-end.configure! :role_join_model => 'MyUsersRoles'
+  # c.auto_config[:relations] = false
+end.configure!
 
 module UserSetup
   def find_role name

data/spec/generic/models/base_user.rb

@@ -21,7 +21,8 @@ class BaseUser
     false
   end
   
-  def save!
+  def save
     true
   end
+  alias_method :save!, :save
 end

data/spec/trole/strategies/embed_one_spec.rb

@@ -1,4 +1,4 @@
-require 'strategy_helper'
+require 'trole/strategy_helper'
 
 User.troles_strategy :embed_one do |c|
   c.valid_roles = [:user, :admin, :editor, :blogger]

data/spec/trole/strategies/ref_one_spec.rb

@@ -1,4 +1,4 @@
-require 'strategy_helper'
+require 'trole/strategy_helper'
 
 User.troles_strategy :ref_one do |c|
   c.valid_roles = [:user, :admin, :editor, :blogger]

data/spec/trole/strategies/string_one_spec.rb

@@ -1,4 +1,4 @@
-require 'strategy_helper'
+require 'trole/strategy_helper'
 
 User.troles_strategy :string_one do |c|
   c.valid_roles = [:user, :admin, :editor, :blogger]

data/spec/troles/common/multi_roles_spec.rb

@@ -14,7 +14,7 @@ shared_examples_for "Common Write API for multiple roles" do
       user.has_role?(:admin).should be_true
       user.has_role?(:user).should be_false
       user.has_any_role?(:admin, :editor).should be_true
-      user.has_any_role?(:admin, :user).should be_false
+      user.has_any_role?(:user).should be_false
       user.has_all_roles?(:admin, :editor, :blogger).should be_true      
     end
 
@@ -23,7 +23,7 @@ shared_examples_for "Common Write API for multiple roles" do
       user.has_role?(:admin).should be_true
       user.has_role?(:user).should be_false
       user.has_any_role?(:admin, :editor).should be_true
-      user.has_any_role?(:admin, :user).should be_false
+      user.has_any_role?(:user).should be_false
       user.has_all_roles?(:admin, :editor, :blogger).should be_true      
     end
   end
@@ -48,19 +48,12 @@ shared_examples_for "Common Write API for multiple roles" do
       user.remove_roles :admin, :admin
       expect { user.role_list }.to change{user.role_list_value}      
       user.has_role?(:admin).should be_false
-      user.roles.list.should == [:editor, :blogger]
+      user.roles.list.should include(:editor, :blogger)
     end
   end
 
   describe '#static_role!' do
     pending 'TODO'
-
-    it "should set set roles to :user only" do
-      user.static_role!(:guest)
-      user.has_role?(:guest).should be_true
-      user.valid_roles.should include(:guest)
-      lambda { user.set_roles(:admin) }.should raise_error
-    end
   end  
 end
 
@@ -69,7 +62,8 @@ shared_examples_for "Common Operations API for multiple roles" do
     it "should clear all roles and invalidate roles cache" do
       user.set_roles :admin
       user.roles << [:admin, :editor, :blogger]
-      user.roles.list.should == [:admin, :editor, :blogger]
+      user.roles.list.should include(:admin, :editor, :blogger)
+
       user.roles.clear!
       expect { user.role_list }.to change{user.role_list_value }
       user.role_list.should be_empty      
@@ -81,7 +75,7 @@ shared_examples_for "Common Operations API for multiple roles" do
       user.set_roles :admin
       user.roles + [:admin, :editor, :blogger]
 
-      user.roles.list.should == [:admin, :editor, :blogger]
+      user.roles.list.should include(:admin, :editor, :blogger)
       user.has_role?(:admin).should be_true
       user.has_role?(:user).should be_false
 
@@ -139,4 +133,4 @@ shared_examples_for "Common Operations API for multiple roles" do
       lambda { user.set_roles(:admin) }.should raise_error
     end
   end    
-end
+end

data/spec/troles/strategies/bit_many_spec.rb

@@ -1,4 +1,4 @@
-require 'strategy_helper'
+require 'troles/strategy_helper'
 
 User.troles_strategy :bit_many do |c|
   c.valid_roles = [:user, :admin, :blogger, :editor]

data/spec/troles/strategies/embed_many_spec.rb

@@ -1,4 +1,4 @@
-require 'strategy_helper'
+require 'troles/strategy_helper'
 
 User.troles_strategy :embed_many do |c|
   c.valid_roles = [:user, :admin, :blogger, :editor]

data/spec/troles/strategies/ref_many_spec.rb

@@ -1,4 +1,4 @@
-require 'strategy_helper'
+require 'troles/strategy_helper'
 
 User.troles_strategy :ref_many do |c|
   c.valid_roles = [:user, :admin, :blogger, :editor]

data/spec/troles/strategies/string_many_spec.rb

@@ -1,4 +1,4 @@
-require 'strategy_helper'
+require 'troles/strategy_helper'
 
 User.troles_strategy :string_many do |c|
   c.valid_roles = [:user, :admin, :blogger, :editor]

data/spec/troles/strategy_helper.rb

@@ -1,3 +1,3 @@
 require 'trole_spec_helper'
-require 'troles_spec'      
+require 'troles_spec'
 require 'generic/models'