roles_generic 0.1.1

data/lib/roles_generic/generic.rb

@@ -0,0 +1,77 @@
+require 'require_all'
+require 'active_support/inflector'
+require_all File.dirname(__FILE__) + '/extensions'
+
+module RoleModels
+  module Base
+    attr_accessor :orm_name
+
+    def valid_roles
+      strategy_class.valid_roles
+    end
+
+    def roles(*roles)
+      strategy_class.valid_roles = Array[*roles].flatten.map { |r| r.to_sym }
+    end
+    
+    def role_strategy strategy, options=nil
+      include_strategy orm_name, strategy, options
+    end  
+         
+    def include_strategy orm, strategy, options=nil 
+      begin     
+        constant = "RoleModels::#{orm_name.to_s.camelize}::#{strategy.to_s.camelize}".constantize
+
+        strategy_class_method = %Q{
+          def strategy_class
+            #{constant} 
+          end
+        }
+        
+        class_eval do
+          eval strategy_class_method
+        end
+
+        instance_eval do        
+          eval strategy_class_method
+          include constant
+        end        
+      rescue
+        raise "No Role strategy module for ORM #{orm} found for strategy #{strategy}"
+      end
+      constant.apply_options(options) if constant.respond_to? :apply_options
+    end    
+  end
+end
+
+module RoleModels
+  module Generic  
+    def self.included(base) 
+      base.extend RoleModels::Base       
+      base.orm_name = :generic    
+    end
+  end
+end
+
+require_all File.dirname(__FILE__) +'/generic'
+
+module RoleModels::Generic
+  module Base
+    INHERITABLE_CLASS_ATTRIBUTES = [:roles_attribute_name, :valid_roles]
+
+    include Implementation
+
+    def self.included(base) # :nodoc:
+      base.extend ClassMethods
+      base.class_eval do       
+        class << self   
+          attr_accessor(*::RoleModels::Generic::Base::INHERITABLE_CLASS_ATTRIBUTES)
+          
+          def apply_options options 
+            roles_attribute default_role_attribute if options == :default
+          end             
+        end
+      end
+    end
+  end
+end

data/lib/roles_generic/many_roles.rb

@@ -0,0 +1,39 @@
+require 'roles_generic/role/class_methods'
+require 'set'
+
+module RoleModels::Generic
+  module ManyRoles
+    def self.default_role_attribute
+      :many_roles
+    end
+
+    module Implementation
+      # assign roles
+      def roles=(*roles)  
+        raise "Role class #{role_class} does not have a #find_role(role) method" if !role_class.respond_to? :find_role
+
+        role_relations = role_class.find_roles(*roles)
+
+        role_relations.each do |role_relation|        
+          self.send("#{strategy_class.roles_attribute_name}=", role_relation) if role_relation.kind_of?(role_class)
+        end      
+      end
+
+      # query assigned roles
+      def roles
+        self.send(strategy_class.roles_attribute_name)
+      end
+
+      def roles_list     
+        [roles].flatten.map{|r| r.name }.compact
+      end
+    end
+
+    extend RoleModels::Generic::Base::Configuration
+    configure :type => :role_class
+    
+    def self.included(base)
+      base.extend RoleModels::Generic::Base::RoleClass::ClassMethods
+    end      
+  end
+end

data/lib/roles_generic/one_role.rb

@@ -0,0 +1,40 @@
+require 'roles_generic/role/class_methods'
+require 'set'
+
+module RoleModels::Generic
+  module OneRole
+    def self.default_role_attribute
+      :one_role
+    end
+
+    module Implementation
+      # assign roles
+      def roles=(*roles)      
+        raise "Role class #{role_class} does not have a #find_role(role) method" if !role_class.respond_to? :find_role
+
+        first_role = roles.flatten.first
+        role_relation = role_class.find_role(first_role)
+        if role_relation && role_relation.kind_of?(role_class)
+          self.send("#{strategy_class.roles_attribute_name}=", role_relation)
+        end        
+      end
+      
+      # query assigned roles
+      def roles
+        role = self.send(strategy_class.roles_attribute_name).name.to_sym
+        [role]
+      end
+      
+      def roles_list
+        self.roles.to_a
+      end      
+    end
+
+    extend RoleModels::Generic::Base::Configuration
+    configure :num => :single, :type => :role_class
+    
+    def self.included(base)
+      base.extend RoleModels::Generic::Base::RoleClass::ClassMethods
+    end      
+  end  
+end

data/lib/roles_generic/role/class_methods.rb

@@ -0,0 +1,20 @@
+module RoleModels::Generic::Base
+  module RoleClass
+    module InstanceMethods
+      def role_class
+        self.class.role_class_name
+      end      
+    end
+  
+    module ClassMethods 
+      def role_class_name
+        @role_class_name          
+      end
+
+      def role_class class_constant
+        const = class_constant.to_s.camelize
+        @role_class_name = "#{const}".constantize
+      end
+    end    
+  end
+end

data/lib/roles_generic/role_string.rb

@@ -0,0 +1,29 @@
+require 'set'
+
+module RoleModels::Generic
+  module RoleString    
+    def self.default_role_attribute
+      :role_string
+    end
+    
+    module Implementation             
+      # assign roles
+      def roles=(*roles)
+        first_role = roles.flatten.first.to_s                                    
+        if valid_role? first_role
+          self.send("#{strategy_class.roles_attribute_name}=", first_role) 
+        end
+      end
+
+      # query assigned roles
+      def roles
+        role = self.send(strategy_class.roles_attribute_name)
+        [role.to_sym]
+      end
+      alias_method :roles_list, :roles
+    end
+
+    extend RoleModels::Generic::Base::Configuration
+    configure :num => :single
+  end
+end

data/lib/roles_generic/role_strings.rb

@@ -0,0 +1,23 @@
+module RoleModels::Generic
+  module RoleStrings    
+    def self.default_role_attribute
+      :role_strings
+    end    
+    
+    module Implementation
+      # assign roles
+      def roles=(*roles)
+        new_roles = roles.flatten.map{|r| r.to_s if valid_role?(r)}.compact
+        self.send("#{strategy_class.roles_attribute_name}=", Set.new(new_roles)) if new_roles && new_roles.not.empty?
+      end
+
+      # query assigned roles
+      def roles
+        self.send(strategy_class.roles_attribute_name).map{|r| r.to_sym}
+      end
+    end
+
+    extend RoleModels::Generic::Base::Configuration
+    configure            
+  end
+end

data/lib/roles_generic/roles_mask.rb

@@ -0,0 +1,48 @@
+require 'set'
+
+module RoleModels::Generic
+  module RolesMask
+    def self.default_role_attribute
+      :roles_mask
+    end
+
+    module Implementation 
+      class Roles < ::Set # :nodoc:
+        attr_reader :model_instance
+
+        def initialize(sender, *roles)
+          super(*roles)
+          @model_instance = sender
+        end
+
+        def <<(role)
+          model_instance.roles = super.to_a
+          self
+        end
+      end
+
+      # assign roles
+      def roles=(*roles)
+        self.send("#{strategy_class.roles_attribute_name}=", (roles.flatten.map { |r| r.to_sym } & strategy_class.valid_roles).map { |r| calc_index(r) }.inject { |sum, bitvalue| sum + bitvalue })
+      end
+
+      # query assigned roles
+      def roles
+        strategy_class::Roles.new(self, strategy_class.valid_roles.reject { |r| ((self.send(strategy_class.roles_attribute_name) || 0) & calc_index(r)).zero? })
+      end
+
+      def roles_list
+        roles.to_a
+      end        
+
+      protected
+
+      def calc_index(r)
+        2**strategy_class.valid_roles.index(r)
+      end
+    end    
+    
+    extend RoleModels::Generic::Base::Configuration
+    configure            
+  end
+end

data/lib/roles_generic/roles_string.rb

@@ -0,0 +1,26 @@
+require_all File.dirname(__FILE__) +'/roles_string'
+
+module RoleModels::Generic
+  module RolesString    
+    def self.default_role_attribute
+      :roles_string
+    end
+
+    module Implementation     
+      # assign roles
+      def roles=(*roles)
+        roles_str = roles.flatten.map{|r| r.to_s if valid_role?(r)}.compact.uniq.join(',')
+        self.send("#{strategy_class.roles_attribute_name}=", roles_str) if roles_str && roles_str.not.empty?
+      end
+
+      # query assigned roles
+      def roles
+        self.send(strategy_class.roles_attribute_name).split(',').uniq.map{|r| r.to_sym}
+      end
+      alias_method :roles_list, :roles
+    end
+    
+    extend RoleModels::Generic::Base::Configuration
+    configure            
+  end
+end

data/lib/roles_generic.rb

@@ -0,0 +1,2 @@
+require 'roles_generic/base'
+require 'roles_generic/generic'

data/spec/generator_spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'rspec/autorun'     
+require 'generator_spec'
+require 'roles_generic'
+
+RSpec::Generator.configure do |config|
+  config.debug = false
+  config.remove_temp_dir = true
+  config.default_rails_root(__FILE__) 
+  config.lib = File.dirname(__FILE__) + '/../lib'
+  config.logger = :stdout  
+end

data/spec/generators/admin_flag_generator_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require_generator :roles_model => :roles
+
+describe 'role strategy generator: admin_flag' do
+  let(:strategy) { :admin_flag }
+
+  describe 'ORM: none' do
+    let(:orm)    { :none }
+  
+    use_orm :none
+    helpers :model  
+    
+    before :each do              
+      setup_generator 'roles_generator' do
+        tests RolesModel::Generators::RolesGenerator
+      end    
+      remove_model 'user'    
+    end
+
+    after :each do
+      remove_model 'user'
+    end
+        
+    it "should configure 'admin_flag' strategy" do            
+      create_model :user do
+        '# content'
+      end
+      with_generator do |g|   
+        arguments = "User --strategy #{strategy} --roles admin user --orm #{orm}"
+        puts "arguments: #{arguments}"
+        g.run_generator arguments.args
+        g.should generate_model :user do |clazz|
+          clazz.should include_module 'RoleModels::Generic'
+          puts "clazz: #{clazz}"        
+          clazz.should have_call :roles, :args => ':admin, :user'
+          clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+        end
+      end
+    end
+  end
+
+  describe 'ORM: active_record' do 
+    let(:orm)    { :active_record }
+        
+    use_orm :active_record
+    helpers :model  
+    
+    before :each do              
+      setup_generator 'roles_generator' do
+        tests RolesModel::Generators::RolesGenerator
+      end    
+      remove_model 'user'    
+    end
+
+    after :each do
+      # remove_model 'user'
+    end
+        
+    it "should configure 'admin_flag' strategy" do            
+      create_model :user do
+        '# content'
+      end
+      with_generator do |g|   
+        arguments = "User --strategy #{strategy} --roles admin user --orm #{orm}"
+        puts "arguments: #{arguments}"
+        g.run_generator arguments.args
+        g.should generate_model :user do |clazz|
+          clazz.should include_module 'RoleModels::Generic'
+          puts "clazz: #{clazz}"        
+          clazz.should have_call :roles, :args => ':admin, :user'
+          clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+        end
+      end
+    end
+  end
+end
+

data/spec/generators/many_roles_generator_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require_generator :roles_model => :roles
+
+describe 'helper_generator' do
+  let(:strategy) { 'many_roles' }
+  
+  use_orm :active_record
+  helpers :model  
+    
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests RolesModel::Generators::RolesGenerator
+    end    
+    remove_model 'user'    
+  end
+
+  after :each do
+    remove_model 'user'
+  end
+        
+  it "should configure 'many_roles' strategy" do
+    create_model :user do
+      '# content'
+    end
+    with_generator do |g|   
+      arguments = "User --strategy #{strategy} --roles admin user --orm active_record"
+      puts "arguments: #{arguments}"
+      g.run_generator arguments.args
+      g.should generate_model :user do |clazz|
+        clazz.should include_module 'RoleModels::Generic'
+        clazz.should have_call :roles, :args => ':admin, :user'
+        clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+      end
+    end
+  end
+end
+
+
+

data/spec/generators/one_role_generator_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require_generator :roles_model => :roles
+
+describe 'helper_generator' do
+  let(:strategy) { 'one_role' }
+  
+  use_orm :active_record
+  helpers :model  
+    
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests RolesModel::Generators::RolesGenerator
+    end    
+    remove_model 'user'    
+  end
+
+  after :each do
+    remove_model 'user'
+  end
+        
+  it "should configure 'one_role' strategy" do
+    create_model :user do
+      '# content'
+    end
+    with_generator do |g|   
+      arguments = "User --strategy #{strategy} --roles admin user --orm active_record"
+      puts "arguments: #{arguments}"
+      g.run_generator arguments.args
+      g.should generate_model :user do |clazz|
+        clazz.should include_module 'RoleModels::Generic'
+        clazz.should have_call :roles, :args => ':admin, :user'
+        clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+      end
+    end
+  end
+end
+
+
+

data/spec/generators/role_string_generator_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require_generator :roles_model => :roles
+
+describe 'helper_generator' do
+  let(:strategy) { 'role_string' }
+  
+  use_orm :active_record
+  helpers :model  
+    
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests RolesModel::Generators::RolesGenerator
+    end    
+    remove_model 'user'    
+  end
+
+  after :each do
+    remove_model 'user'
+  end
+        
+  it "should configure 'role_string' strategy" do            
+    create_model :user do
+      '# content'
+    end
+    with_generator do |g|   
+      arguments = "User --strategy #{strategy} --roles admin user --orm active_record"
+      puts "arguments: #{arguments}"
+      g.run_generator arguments.args
+      g.should generate_model :user do |clazz|
+        clazz.should include_module 'RoleModels::Generic'
+        clazz.should have_call :roles, :args => ':admin, :user'
+        clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+      end
+    end
+  end
+end
+
+
+

data/spec/generators/role_strings_generator_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require_generator :roles_model => :roles
+
+describe 'helper_generator' do
+  let(:strategy) { 'role_strings' }
+  
+  use_orm :active_record
+  helpers :model  
+    
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests RolesModel::Generators::RolesGenerator
+    end    
+    remove_model 'user'    
+  end
+
+  after :each do
+    remove_model 'user'
+  end
+        
+  it "should configure 'role_strings' strategy" do            
+    create_model :user do
+      '# content'
+    end
+    with_generator do |g|   
+      arguments = "User --strategy #{strategy} --roles admin user --orm active_record"
+      puts "arguments: #{arguments}"
+      g.run_generator arguments.args
+      g.should generate_model :user do |clazz|
+        clazz.should include_module 'RoleModels::Generic'
+        clazz.should have_call :roles, :args => ':admin, :user'
+        clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+      end
+    end
+  end
+end
+
+
+

data/spec/generators/roles_mask_generator_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require_generator :roles_model => :roles
+
+describe 'helper_generator' do
+  let(:strategy) { 'roles_mask' }
+  
+  use_orm :active_record
+  helpers :model  
+    
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests RolesModel::Generators::RolesGenerator
+    end    
+    remove_model 'user'    
+  end
+
+  after :each do
+    remove_model 'user'
+  end
+        
+  it "should configure 'roles_mask' strategy" do            
+    create_model :user do
+      '# content'
+    end
+    with_generator do |g|   
+      arguments = "User --strategy #{strategy} --roles admin user --orm active_record"
+      puts "arguments: #{arguments}"
+      g.run_generator arguments.args
+      g.should generate_model :user do |clazz|
+        clazz.should include_module 'RoleModels::Generic'
+        clazz.should have_call :roles, :args => ':admin, :user'
+        clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+      end
+    end
+  end
+end
+
+
+

data/spec/generators/roles_string_generator_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require_generator :roles_model => :roles
+
+describe 'helper_generator' do
+  let(:strategy) { 'roles_string' }
+  
+  use_orm :active_record
+  helpers :model  
+    
+  before :each do              
+    setup_generator 'roles_generator' do
+      tests RolesModel::Generators::RolesGenerator
+    end    
+    remove_model 'user'    
+  end
+
+  after :each do
+    remove_model 'user'
+  end
+        
+  it "should configure 'roles_string' strategy" do            
+    create_model :user do
+      '# content'
+    end
+    with_generator do |g|   
+      arguments = "User --strategy #{strategy} --roles admin user --orm active_record"
+      puts "arguments: #{arguments}"
+      g.run_generator arguments.args
+      g.should generate_model :user do |clazz|
+        clazz.should include_module 'RoleModels::Generic'
+        clazz.should have_call :roles, :args => ':admin, :user'
+        clazz.should have_call :role_strategy, :args => ":#{strategy}"        
+      end
+    end
+  end
+end
+
+
+

data/spec/model/role.rb

@@ -0,0 +1,26 @@
+class Role
+  attr_accessor :name
+  
+  def self.find_role role_name    
+    roles.to_a.select{|r| r.name == role_name}.first
+  end  
+
+  def self.find_roles *role_names
+    result = Set.new
+    role_names.flatten.each do |role_name| 
+      found_role = find_role(role_name)
+      result << found_role if found_role
+    end
+    result
+  end
+
+  class << self
+    attr_accessor :roles
+  end    
+  
+  def initialize name
+    @name = name
+    self.class.roles ||= Set.new
+    self.class.roles << self
+  end  
+end