roles_generic 0.1.1 → 0.2.0

data/lib/roles_generic/{roles_string.rb → strategy/multi/roles_string.rb}

@@ -1,6 +1,4 @@
-require_all File.dirname(__FILE__) +'/roles_string'
-
-module RoleModels::Generic
+module RoleStrategy::Generic
   module RolesString    
     def self.default_role_attribute
       :roles_string
@@ -20,7 +18,7 @@ module RoleModels::Generic
       alias_method :roles_list, :roles
     end
     
-    extend RoleModels::Generic::Base::Configuration
+    extend Roles::Generic::User::Configuration
     configure            
   end
 end

data/lib/roles_generic/{admin_flag.rb → strategy/single/admin_flag.rb}

@@ -1,4 +1,4 @@
-module RoleModels::Generic
+module RoleStrategy::Generic
   module AdminFlag    
     def self.default_role_attribute
       :admin_flag
@@ -20,7 +20,7 @@ module RoleModels::Generic
 
     end # Implementation
     
-    extend RoleModels::Generic::Base::Configuration
+    extend extend Roles::Generic::User::Configuration
     configure :num => :single
   end   
 end

data/lib/roles_generic/{one_role.rb → strategy/single/one_role.rb}

@@ -1,7 +1,6 @@
-require 'roles_generic/role/class_methods'
 require 'set'
 
-module RoleModels::Generic
+module RoleStrategy::Generic
   module OneRole
     def self.default_role_attribute
       :one_role
@@ -30,11 +29,11 @@ module RoleModels::Generic
       end      
     end
 
-    extend RoleModels::Generic::Base::Configuration
+    extend Roles::Generic::User::Configuration
     configure :num => :single, :type => :role_class
     
     def self.included(base)
-      base.extend RoleModels::Generic::Base::RoleClass::ClassMethods
+      base.extend Roles::Generic::Role::ClassMethods
     end      
   end  
 end

data/lib/roles_generic/{role_string.rb → strategy/single/role_string.rb}

@@ -1,6 +1,6 @@
 require 'set'
 
-module RoleModels::Generic
+module RoleStrategy::Generic
   module RoleString    
     def self.default_role_attribute
       :role_string
@@ -23,7 +23,7 @@ module RoleModels::Generic
       alias_method :roles_list, :roles
     end
 
-    extend RoleModels::Generic::Base::Configuration
+    extend Roles::Generic::User::Configuration
     configure :num => :single
   end
 end

data/lib/roles_generic/strategy.rb

@@ -0,0 +1,26 @@
+require 'sugar-high/file'
+require 'sugar-high/array'
+
+module Roles::Strategy
+  def self.role_strategies cardinality
+    pattern = File.dirname(__FILE__) + "/strategy/#{cardinality}/*.rb"
+    Dir.glob(pattern).file_names(:rb).to_symbols
+  end
+
+  def self.has_strategy? cardinality, strategy
+    role_strategies(cardinality).include?(strategy)
+  end
+  
+  def self.cardinality strategy
+    [:single, :multi].each do |cardinality|             
+      return cardinality if has_strategy?(cardinality, strategy)
+    end
+    raise ArgumentError, "Strategy #{strategy}  is not registered as either a single or multi cardinality role strategy"
+  end
+end           
+
+def use_roles_strategy strategy
+  cardinality = Roles::Strategy.cardinality(strategy)
+  require "roles_generic/strategy/#{cardinality}/#{strategy}"
+end
+

data/lib/roles_generic.rb

@@ -1,2 +1,9 @@
+require 'require_all'
+require 'active_support/inflector'
+require 'sugar-high/not'
+
+require 'roles_generic/namespaces'
 require 'roles_generic/base'
-require 'roles_generic/generic'
+require 'roles_generic/generic'
+require 'roles_generic/strategy'
+

data/roles_generic.gemspec

@@ -0,0 +1,124 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{roles_generic}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-09-04}
+  s.description = %q{Generic role strategies sharing the same API. Easy to insert in any model}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/roles_model/roles/roles_generator.rb",
+     "lib/roles_generic.rb",
+     "lib/roles_generic/base.rb",
+     "lib/roles_generic/generic.rb",
+     "lib/roles_generic/generic/role.rb",
+     "lib/roles_generic/generic/user.rb",
+     "lib/roles_generic/generic/user/class_methods.rb",
+     "lib/roles_generic/generic/user/configuration.rb",
+     "lib/roles_generic/generic/user/implementation.rb",
+     "lib/roles_generic/namespaces.rb",
+     "lib/roles_generic/strategy.rb",
+     "lib/roles_generic/strategy/multi/many_roles.rb",
+     "lib/roles_generic/strategy/multi/role_strings.rb",
+     "lib/roles_generic/strategy/multi/roles_mask.rb",
+     "lib/roles_generic/strategy/multi/roles_string.rb",
+     "lib/roles_generic/strategy/single/admin_flag.rb",
+     "lib/roles_generic/strategy/single/one_role.rb",
+     "lib/roles_generic/strategy/single/role_string.rb",
+     "roles_generic.gemspec",
+     "spec/generator_spec_helper.rb",
+     "spec/generators/admin_flag_generator_spec.rb",
+     "spec/generators/many_roles_generator_spec.rb",
+     "spec/generators/one_role_generator_spec.rb",
+     "spec/generators/role_string_generator_spec.rb",
+     "spec/generators/role_strings_generator_spec.rb",
+     "spec/generators/roles_mask_generator_spec.rb",
+     "spec/generators/roles_string_generator_spec.rb",
+     "spec/model/role.rb",
+     "spec/roles_generic/admin_flag_spec.rb",
+     "spec/roles_generic/many_roles_spec.rb",
+     "spec/roles_generic/one_role_spec.rb",
+     "spec/roles_generic/role_string_spec.rb",
+     "spec/roles_generic/role_strings_spec.rb",
+     "spec/roles_generic/roles_mask_spec.rb",
+     "spec/roles_generic/roles_string_spec.rb",
+     "spec/spec_helper.rb",
+     "wiki/strategies/admin_flag.textile",
+     "wiki/strategies/many_roles.textile",
+     "wiki/strategies/one_role.textile",
+     "wiki/strategies/role_string.textile",
+     "wiki/strategies/role_strings.textile",
+     "wiki/strategies/roles_mask.textile",
+     "wiki/strategies/roles_string.textile"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/roles_for_mm}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Generic role strategies sharing the same API}
+  s.test_files = [
+    "spec/generator_spec_helper.rb",
+     "spec/generators/admin_flag_generator_spec.rb",
+     "spec/generators/many_roles_generator_spec.rb",
+     "spec/generators/one_role_generator_spec.rb",
+     "spec/generators/role_string_generator_spec.rb",
+     "spec/generators/role_strings_generator_spec.rb",
+     "spec/generators/roles_mask_generator_spec.rb",
+     "spec/generators/roles_string_generator_spec.rb",
+     "spec/model/role.rb",
+     "spec/roles_generic/admin_flag_spec.rb",
+     "spec/roles_generic/many_roles_spec.rb",
+     "spec/roles_generic/one_role_spec.rb",
+     "spec/roles_generic/role_string_spec.rb",
+     "spec/roles_generic/role_strings_spec.rb",
+     "spec/roles_generic/roles_mask_spec.rb",
+     "spec/roles_generic/roles_string_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
+      s.add_development_dependency(%q<generator-spec>, ["~> 0.5.1"])
+      s.add_runtime_dependency(%q<require_all>, ["~> 1.1.0"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.2"])
+      s.add_runtime_dependency(%q<rails3_artifactor>, ["~> 0.1.1"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
+      s.add_dependency(%q<generator-spec>, ["~> 0.5.1"])
+      s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.2.2"])
+      s.add_dependency(%q<rails3_artifactor>, ["~> 0.1.1"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
+    s.add_dependency(%q<generator-spec>, ["~> 0.5.1"])
+    s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.2.2"])
+    s.add_dependency(%q<rails3_artifactor>, ["~> 0.1.1"])
+  end
+end
+

data/spec/generators/admin_flag_generator_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require 'generator_spec_helper'
 require_generator :roles_model => :roles
 
 describe 'role strategy generator: admin_flag' do
@@ -30,7 +30,7 @@ describe 'role strategy generator: admin_flag' do
         puts "arguments: #{arguments}"
         g.run_generator arguments.args
         g.should generate_model :user do |clazz|
-          clazz.should include_module 'RoleModels::Generic'
+          clazz.should include_module 'Roles::Generic'
           puts "clazz: #{clazz}"        
           clazz.should have_call :roles, :args => ':admin, :user'
           clazz.should have_call :role_strategy, :args => ":#{strategy}"        

data/spec/generators/many_roles_generator_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require 'generator_spec_helper'
 require_generator :roles_model => :roles
 
 describe 'helper_generator' do

data/spec/generators/one_role_generator_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require 'generator_spec_helper'
 require_generator :roles_model => :roles
 
 describe 'helper_generator' do

data/spec/generators/role_string_generator_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require 'generator_spec_helper'
 require_generator :roles_model => :roles
 
 describe 'helper_generator' do

data/spec/generators/role_strings_generator_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require 'generator_spec_helper'
 require_generator :roles_model => :roles
 
 describe 'helper_generator' do

data/spec/generators/roles_mask_generator_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require 'generator_spec_helper'
 require_generator :roles_model => :roles
 
 describe 'helper_generator' do

data/spec/generators/roles_string_generator_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../generator_spec_helper')
+require 'generator_spec_helper'
 require_generator :roles_model => :roles
 
 describe 'helper_generator' do

data/spec/roles_generic/admin_flag_spec.rb

@@ -1,8 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'roles_generic/admin_flag'
+require 'spec_helper'
+use_roles_strategy :admin_flag
 
 class User
-  include RoleModels::Generic 
+  include Roles::Generic 
 
   attr_accessor :name, :admin_flag 
   

data/spec/roles_generic/many_roles_spec.rb

@@ -1,9 +1,10 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'roles_generic/many_roles'
+require 'spec_helper'
+use_roles_strategy :many_roles
+
 require 'model/role'
 
 class User
-  include RoleModels::Generic 
+  include Roles::Generic 
   role_strategy :many_roles, :default
 
   role_class :role   

data/spec/roles_generic/one_role_spec.rb

@@ -1,9 +1,10 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'roles_generic/one_role'
+require 'spec_helper'
+use_roles_strategy :one_role
+
 require 'model/role'
 
 class User
-  include RoleModels::Generic 
+  include Roles::Generic 
   role_strategy :one_role, :default
 
   role_class :role   

data/spec/roles_generic/role_string_spec.rb

@@ -1,8 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'roles_generic/role_string'
+require 'spec_helper'
+use_roles_strategy :role_string
 
 class User
-  include RoleModels::Generic 
+  include Roles::Generic 
 
   attr_accessor :name, :role_string
    

data/spec/roles_generic/role_strings_spec.rb

@@ -1,8 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'roles_generic/role_strings'
+require 'spec_helper'
+use_roles_strategy :role_strings
 
 class User
-  include RoleModels::Generic 
+  include Roles::Generic 
    
   attr_accessor :name, :role_strings
    

data/spec/roles_generic/roles_mask_spec.rb

@@ -1,8 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'roles_generic/roles_mask'
+require 'spec_helper'
+use_roles_strategy :roles_mask
 
 class User
-  include RoleModels::Generic 
+  include Roles::Generic 
 
   attr_accessor :name, :roles_mask
    

data/spec/roles_generic/roles_string_spec.rb

@@ -1,8 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'roles_generic/roles_string'
+require 'spec_helper'
+use_roles_strategy :roles_string
 
 class User
-  include RoleModels::Generic 
+  include Roles::Generic 
    
   attr_accessor :name, :roles_string
    

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'rspec/autorun'
 require 'roles_generic'
                  
 RSpec.configure do |config|
-  
+  config.mock_with :mocha
 end
 
 

data/wiki/strategies/admin_flag.textile

@@ -0,0 +1,20 @@
+h2. Example : admin_flag
+
+Creates and uses a binary field 'admin_flag', which when true signals that this user is an administrator and otherwise a normal user.
+
+<pre>
+  class User
+    include RoleModels::Generic 
+
+    attr_accessor :name, :admin_flag 
+
+    role_strategy :admin_flag, :default
+
+    roles :admin, :user
+
+    def initialize name, *new_roles
+      self.name = name
+      self.roles = new_roles
+    end 
+  end
+</pre>

data/wiki/strategies/many_roles.textile

@@ -0,0 +1,48 @@
+h2. Example : many_roles
+
+Creates and uses a single relation to a Role model for each user
+
+<pre>
+  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     
+  
+  class User
+    include RoleModels::Generic 
+    role_strategy :many_roles, :default
+
+    role_class :role   
+
+    attr_accessor :name, :many_roles
+
+    roles :admin, :user 
+
+    def initialize name, *new_roles
+      self.name = name
+      self.roles = new_roles
+    end 
+  end  
+</pre>

data/wiki/strategies/one_role.textile

@@ -0,0 +1,40 @@
+h2. Example : one_role
+
+Creates and uses a single relation to a Role model for each user
+
+<pre>
+  class Role
+    attr_accessor :name
+
+    def self.find_role role_name    
+      roles.to_a.select{|r| r.name == role_name}.first
+    end  
+
+    class << self
+      attr_accessor :roles
+    end    
+
+    def initialize name
+      @name = name
+      self.class.roles ||= Set.new
+      self.class.roles << self
+    end
+
+  end
+
+  class User
+    include RoleModels::Generic 
+    role_strategy :one_role, :default
+
+    role_class :role   
+
+    attr_accessor :name, :one_role
+
+    roles :admin, :user 
+
+    def initialize name, *new_roles
+      self.name = name
+      self.roles = new_roles
+    end 
+  end
+</pre>

data/wiki/strategies/role_string.textile

@@ -0,0 +1,20 @@
+h2. Example : role_string
+
+Creates and uses a single role name, a string
+
+<pre>
+  class User
+    include RoleModels::Generic 
+
+    attr_accessor :name, :role_string
+
+    role_strategy :role_string, :default
+
+    roles :admin, :user
+
+    def initialize name, *new_roles
+      self.name = name
+      self.roles = new_roles
+    end 
+  end
+</pre>

data/wiki/strategies/role_strings.textile

@@ -0,0 +1,20 @@
+h2. Example : role_strings
+
+Creates and uses an Set of role names as strings
+
+<pre>
+  class User
+    include RoleModels::Generic 
+
+    attr_accessor :name, :role_strings
+
+    role_strategy :role_strings, :default
+
+    roles :admin, :user
+
+    def initialize name, *new_roles
+      self.name = name
+      self.roles = new_roles
+    end 
+  end  
+</pre>

data/wiki/strategies/roles_mask.textile

@@ -0,0 +1,20 @@
+h2. Example : roles_mask
+
+Creates and uses an Integer field where each on bit signifies a role
+
+<pre>
+  class User
+    include RoleModels::Generic 
+
+    attr_accessor :name, :roles_mask
+
+    role_strategy :roles_mask, :default
+
+    roles :admin, :user
+
+    def initialize name, *new_roles
+      self.name = name
+      self.roles = new_roles
+    end 
+  end
+</pre>

data/wiki/strategies/roles_string.textile

@@ -0,0 +1,20 @@
+h2. Example : roles_string
+
+Creates and uses single comma separated String of role names
+
+<pre>
+  class User
+    include RoleModels::Generic 
+
+    attr_accessor :name, :roles_string
+
+    role_strategy :roles_string, :default
+
+    roles :admin, :user
+
+    def initialize name, *new_roles
+      self.name = name
+      self.roles = new_roles
+    end 
+  end
+</pre>