roles_generic 0.3.3 → 0.3.4

data/README.textile

@@ -0,0 +1,125 @@
+h1. Generic Roles
+
+*Generic Roles* is a generic Roles API implementation that specific ORM Roles implementations can implement.
+This way you can easily change ORM and still keep the same underlying API.
+
+A Rails 3 generator is included that can configure an existing User model with a generic Role strategy of choice.
+Each ORM Roles implementation should have a similar generator for that particular ORM. 
+
+h2. Roles ORM implementations
+
+The following ORM specific Roles implementations are currently available
+
+h3. Relational Database (SQL)
+
+* "Active Record":http://github.com/kristianmandrup/roles_active_record
+* "Data Mapper":http://github.com/kristianmandrup/roles_data_mapper
+
+h3. Mongo DB
+
+* "Mongoid":(http://github.com/kristianmandrup/roles_mongoid
+* "Mongo Mapper":http://github.com/kristianmandrup/roles_mongo_mapper
+
+h3. Couch DB
+
+* "Simply Stored":http://github.com/kristianmandrup/roles_simply_stored
+
+_Note:_ 
+
+The 'simply_stored' implementation is only partly complete (admin_flag strategy works).
+Feel free to roll your own implementation for your favorite ORM/Data store.
+
+h2. Install
+
+<code>gem install roles_generic</code>
+
+h2. Role strategy configuration
+
+The following demonstrates some examples of role strategy configuration.
+
+_Note_: The DSL has been optimized a bit lately (Dec. 25)
+
+h3. Strategy: admin_flag
+
+Example: Default model configuration:
+
+<pre>class User
+  include Roles::Generic 
+    
+  strategy :admin_flag
+  valid_roles_are :admin, :guest
+  ...
+end
+</pre>
+
+h3. Strategy: one_role
+
+Example: Customizing model names:
+
+<pre>class Bruger
+  include Roles::Generic 
+
+  strategy :one_role, :role_class => :rolle
+  valid_roles_are :admin, :guest
+  ...
+end
+</pre>
+
+Here the Role class is configured to be named 'Rolle' (Danish translation). 
+If no :role_class options is passed, the default role class 'Role' is used (if the Role class is defined).
+
+Note: The customizing of the Role class model is not yet complete. The generator and such still needs to be updated... Feel free to assist!
+
+h2. Roles generator
+
+A Rails 3 generator is included to update an existing User model with a roles strategy and a set of valid roles.
+The Generic Roles generator doesn't work for a persistent model. In that case use a dedicated implementation for the ORM (data store) used (see above).
+
+h3. Usage example
+
+<code>rails g roles_generic:roles --strategy admin_flag --roles guest admin</code>  
+
+h2. Role strategies
+
+The following role strategies are built-in:
+
+Inline roles (attribute in User model):
+
+* _admin_flag_ (Boolean flag - 'admin' or not)
+* _role_string_ (String)
+* _roles_string_ (comma separated String)
+* _role_strings_ (list of Strings)
+* _roles_mask_ (Integer mask)
+
+Separate Role model:
+
+* _one_role_ (single relation to a Role model instance)
+* _many_roles_ (multiple Role relationships)
+
+Embedded Role model (Document stores only):
+
+* _embed_one_role_
+* _embed_many_roles_  
+
+Currently the embedded strategies have only been implemented for Mongoid.
+
+h2. Role API
+
+The full Roles API is described in these Wiki pages:
+
+* "Roles-Read-API":https://github.com/kristianmandrup/roles_generic/wiki/Roles-Read-API
+* "Roles-Write-API":https://github.com/kristianmandrup/roles_generic/wiki/Roles-Write-API
+
+h2. Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -5,15 +5,15 @@ begin
     gem.summary = %Q{Generic role strategies sharing the same API}
     gem.description = %Q{Generic role strategies sharing the same API. Easy to insert in any model}
     gem.email = "kmandrup@gmail.com"
-    gem.homepage = "http://github.com/kristianmandrup/roles_for_mm"
+    gem.homepage = "http://github.com/kristianmandrup/roles_generic"
     gem.authors = ["Kristian Mandrup"]
-    gem.add_development_dependency "rspec",           ">= 2.0.0"
-    gem.add_development_dependency "generator-spec",  ">= 0.7"
+    gem.add_development_dependency "rspec",           ">= 2.0.1"
+    gem.add_development_dependency "generator-spec",  ">= 0.7.2"
 
     gem.add_dependency "require_all",       "~> 1.2.0"
-    gem.add_dependency "activesupport",     ">= 3.0"    
-    gem.add_dependency 'sugar-high',        "~> 0.3.0" 
-    gem.add_dependency 'rails3_artifactor', '~> 0.3.1'
+    gem.add_dependency "activesupport",     ">= 3.0.1"    
+    gem.add_dependency 'sugar-high',        "~> 0.3.1" 
+    gem.add_dependency 'rails3_artifactor', '~> 0.3.2'
     gem.add_dependency 'logging_assist',    '>= 0.1.6'
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/generators/roles_generic/roles/roles_generator.rb

@@ -40,7 +40,7 @@ module RolesGeneric
       end
 
       def role_class_statement
-        [:one_role, :many_roles].include?(strategy.to_sym) ? 'role_class :role' : ''
+        [:one_role, :many_roles, :embed_one_role, :embed_many_roles].include?(strategy.to_sym) ? 'role_class :role' : ''
       end
 
       def roles_statement

data/lib/roles_generic/base.rb

@@ -39,7 +39,7 @@ module Roles
 
       def type
         @type ||= case name
-        when :one_role, :many_roles
+        when :one_role, :many_roles, :embed_one_role, :embed_many_roles
           :complex
         else
           return :simple if name
@@ -48,9 +48,9 @@ module Roles
 
       def multiplicity
         @multiplicity ||= case name
-        when :many_roles, :role_strings, :roles_mask, :roles_string
+        when :many_roles, :role_strings, :roles_mask, :roles_string, :embed_many_roles
           :multi
-        when :one_role, :admin_flag, :role_string
+        when :one_role, :admin_flag, :role_string, :embed_one_role
           :single
         end      
       end

data/lib/roles_generic/generic/user.rb

@@ -12,9 +12,19 @@ module Roles::Generic
         class << self   
           attr_accessor(*::Roles::Generic::User::INHERITABLE_CLASS_ATTRIBUTES)
           
-          def apply_options options 
-            roles_attribute default_role_attribute if options == :default
-          end             
+          def apply_options options = {}
+            roles_attribute default_role_attribute if default_options? options
+          end
+          
+          private             
+          
+          def default_options? options
+            return true if options == :default                           
+            if options.kind_of? Hash
+              return true if options[:config] == :default || options == {} 
+            end
+            false
+          end
         end
       end
     end

data/lib/roles_generic/generic.rb

@@ -12,20 +12,61 @@ module Roles
       
       MAP = {
         :admin_flag   => "attr_accessor :admin_flag",
+
         :many_roles   => "attr_accessor :many_roles",
         :one_role     => "attr_accessor :one_role",
+
         :roles_mask   => "attr_accessor :roles_mask",
         :role_string  => "attr_accessor :role_string",
         :role_strings => "attr_accessor :role_strings",
-        :roles_string => "attr_accessor :roles_string"
+        :roles_string => "attr_accessor :roles_string",
+        
+        :embed_many_roles   => "attr_accessor :many_roles",
+        :embed_one_role     => "attr_accessor :one_role"        
       }
       
-      def strategy name, options=nil
-        if options == :default && MAP[name]
-          instance_eval MAP[name] 
+      def strategy name, options = {}
+        strategy_name = name.to_sym
+        raise ArgumentError, "Unknown role strategy #{strategy_name}" if !MAP.keys.include? strategy_name
+        use_roles_strategy strategy_name
+        
+        if default_options?(options) && MAP[strategy_name]
+          instance_eval MAP[strategy_name] 
+        end       
+
+        if strategies_with_role_class.include? strategy_name        
+          if !options.kind_of? Symbol
+            @role_class_name = get_role_class(options)
+          else
+            @role_class_name = default_role_class if strategies_with_role_class.include? strategy_name
+          end
         end
+        
         set_role_strategy name, options
       end    
+      
+      private
+
+      def default_options? options = {}
+        return true if options == :default                           
+        if options.kind_of? Hash
+          return true if options[:config] == :default || options == {} 
+        end
+        false
+      end
+
+      def default_role_class
+        return ::Role if defined? ::Role
+        raise Error, "Default Role class not defined"
+      end
+
+      def strategies_with_role_class
+        [:one_role, :embed_one_role, :many_roles,:embed_many_roles]
+      end 
+      
+      def get_role_class options
+        options[:role_class] ? options[:role_class].to_s.camelize.constantize : default_role_class
+      end
     end
   end
 end

data/lib/roles_generic/rspec/api/full.rb

@@ -1,5 +1,5 @@
 require "roles_generic/rspec/user_setup"                                           
-require "roles_generic/rspec/api/write_api"
+# require "roles_generic/rspec/api/write_api"
 require "roles_generic/rspec/api/read_api"
-require "roles_generic/rspec/api/user_class_api"
-require "roles_generic/rspec/api/completeness"
+# require "roles_generic/rspec/api/user_class_api"
+# require "roles_generic/rspec/api/completeness"

data/lib/roles_generic/rspec/api/read_api.rb

@@ -60,60 +60,60 @@ describe 'Roles Generic API : READ' do
     end
   end
   
-  describe '#roles_list' do
-    it "should be true that the first role of admin_user is the :admin role" do      
-      @admin_user.roles_list.should include(:admin)
-    end
-  
-    it "should be true that the first role of admin_user is the :user role" do            
-      case @normal_user.class.role_strategy.multiplicity
-      when :single
-        if @normal_user.class.role_strategy.name == :admin_flag
-          @normal_user.roles_list.should include(:guest)
-        else
-          @normal_user.roles_list.should include(:user)
-        end
-      when :multi
-        @normal_user.roles_list.should include(:user, :guest)
-      end
-    end
-  end  
-  
-  describe '#roles' do
-    it "should be true that the roles of admin_user is an array with the role :admin" do      
-      roles = @admin_user.roles
-      if roles.kind_of? Role
-        roles.name.to_sym.should == :admin
-      elsif roles.kind_of? Array
-        if @normal_user.class.role_strategy.type == :complex
-          # roles.first.name.to_sym.should == :admin
-          roles.first.to_sym.should == :admin
-        else
-          roles.first.to_sym.should == :admin          
-        end
-      else       
-        roles.to_sym.should == :admin
-      end
-    end
-  end 
-  
-  describe '#admin?' do    
-    it "should be true that admin_user is in the :admin role" do      
-      @admin_user.admin?.should be_true
-    end
-  
-    it "should NOT be true that the user is in the :admin role" do      
-      @guest_user.admin?.should be_false
-    end
-  end
-  
-  describe '#is?' do          
-    it "should be true that admin_user is in the :admin role" do      
-      @admin_user.is?(:admin).should be_true
-    end
-  
-    it "should NOT be true that the user is in the :admin role" do      
-      @guest_user.is?(:admin).should be_false
-    end
-  end  
+  # describe '#roles_list' do
+  #   it "should be true that the first role of admin_user is the :admin role" do      
+  #     @admin_user.roles_list.should include(:admin)
+  #   end
+  # 
+  #   it "should be true that the first role of admin_user is the :user role" do            
+  #     case @normal_user.class.role_strategy.multiplicity
+  #     when :single
+  #       if @normal_user.class.role_strategy.name == :admin_flag
+  #         @normal_user.roles_list.should include(:guest)
+  #       else
+  #         @normal_user.roles_list.should include(:user)
+  #       end
+  #     when :multi
+  #       @normal_user.roles_list.should include(:user, :guest)
+  #     end
+  #   end
+  # end  
+  # 
+  # describe '#roles' do
+  #   it "should be true that the roles of admin_user is an array with the role :admin" do      
+  #     roles = @admin_user.roles
+  #     if roles.kind_of? Role
+  #       roles.name.to_sym.should == :admin
+  #     elsif roles.kind_of? Array
+  #       if @normal_user.class.role_strategy.type == :complex
+  #         # roles.first.name.to_sym.should == :admin
+  #         roles.first.to_sym.should == :admin
+  #       else
+  #         roles.first.to_sym.should == :admin          
+  #       end
+  #     else       
+  #       roles.to_sym.should == :admin
+  #     end
+  #   end
+  # end 
+  # 
+  # describe '#admin?' do    
+  #   it "should be true that admin_user is in the :admin role" do      
+  #     @admin_user.admin?.should be_true
+  #   end
+  # 
+  #   it "should NOT be true that the user is in the :admin role" do      
+  #     @guest_user.admin?.should be_false
+  #   end
+  # end
+  # 
+  # describe '#is?' do          
+  #   it "should be true that admin_user is in the :admin role" do      
+  #     @admin_user.is?(:admin).should be_true
+  #   end
+  # 
+  #   it "should NOT be true that the user is in the :admin role" do      
+  #     @guest_user.is?(:admin).should be_false
+  #   end
+  # end  
 end

data/lib/roles_generic/strategy/multi/embed_many_roles.rb

@@ -0,0 +1,30 @@
+module RoleStrategy::Generic
+  module EmbedManyRoles
+    def self.default_role_attribute
+      :many_roles
+    end
+
+    module Implementation
+      include Roles::Generic::User::Implementation::Multi
+      
+      def new_roles *role_names   
+        role_class.find_roles(extract_roles role_names)        
+      end            
+
+      def present_roles roles_names
+        roles_names.to_a.map{|role| role.name.to_s.to_sym}        
+      end            
+      
+      def set_empty_roles
+        self.send("#{role_attribute}=", [])
+      end
+    end
+
+    extend Roles::Generic::User::Configuration
+    configure :type => :role_class
+    
+    def self.included(base)
+      base.extend Roles::Generic::Role::ClassMethods
+    end      
+  end
+end

data/lib/roles_generic/strategy/single/embed_one_role.rb

@@ -0,0 +1,38 @@
+module RoleStrategy::Generic
+  module EmbedOneRole
+    def self.default_role_attribute
+      :one_role
+    end
+
+    module Implementation      
+      include Roles::Generic::User::Implementation::Single
+      
+      protected
+
+      def new_role role
+        role_class.find_role(role)        
+      end  
+      
+      def new_roles *roles
+        new_role roles.flatten.first
+      end     
+      
+      def present_roles *roles
+        roles.map{|role| extract_role role}
+      end                 
+      
+      def set_empty_role
+        self.send("#{role_attribute}=", nil)
+      end
+    end
+
+    extend Roles::Generic::User::Configuration
+    configure :num => :single, :type => :role_class
+    
+    def self.included(base)
+      base.extend Roles::Generic::Role::ClassMethods
+    end      
+    
+    include Roles::Generic::User::Implementation::Single
+  end  
+end

data/lib/roles_generic/strategy.rb

@@ -3,7 +3,7 @@ require 'sugar-high/array'
 
 module Roles::Strategy
   class << self  
-    NON_INLINE_STRATEGIES = [:one_role, :many_roles]
+    NON_INLINE_STRATEGIES = [:one_role, :many_roles, :embed_one_role, :embed_many_roles]
 
     def role_dir
       File.dirname(__FILE__)
@@ -12,6 +12,10 @@ module Roles::Strategy
     def gem_name
       :roles_generic
     end    
+
+    def embedded? strategy
+      strategy.to_s.include? 'embed'
+    end
     
     def role_strategies cardinality
       pattern = role_dir + "/strategy/#{cardinality}/*.rb"
@@ -41,6 +45,7 @@ def use_roles_strategy strategy
   require "roles_generic/admin" if strategy =~ /admin/
 
   gem_name = Roles::Strategy.gem_name
-  require "#{gem_name}/role" if !Roles::Strategy.inline_strategy? strategy  
+  prefix = Roles::Strategy.embedded?(strategy) ? 'embedded_' : ''
+  require "#{gem_name}/#{prefix}role" if !Roles::Strategy.inline_strategy?(strategy)  
   require "#{gem_name}/strategy/#{cardinality}/#{strategy}"
 end

data/roles_generic.gemspec

@@ -1,107 +1,107 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{roles_generic}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-11-20}
+  s.date = %q{2010-12-26}
   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"
+    "README.textile"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     ".rspec",
-     "LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "lib/generators/roles_generic/roles/roles_generator.rb",
-     "lib/roles_generic.rb",
-     "lib/roles_generic/admin.rb",
-     "lib/roles_generic/base.rb",
-     "lib/roles_generic/generic.rb",
-     "lib/roles_generic/generic/role.rb",
-     "lib/roles_generic/generic/role_util.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/generic/user/multi_impl.rb",
-     "lib/roles_generic/generic/user/single_impl.rb",
-     "lib/roles_generic/namespaces.rb",
-     "lib/roles_generic/role.rb",
-     "lib/roles_generic/rspec/api/completeness.rb",
-     "lib/roles_generic/rspec/api/full.rb",
-     "lib/roles_generic/rspec/api/read_api.rb",
-     "lib/roles_generic/rspec/api/simple_check.rb",
-     "lib/roles_generic/rspec/api/user_class_api.rb",
-     "lib/roles_generic/rspec/api/write_api.rb",
-     "lib/roles_generic/rspec/test_it.rb",
-     "lib/roles_generic/rspec/user_setup.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/roles_generic/generators/admin_flag_generator_spec.rb",
-     "spec/roles_generic/generators/many_roles_generator_spec.rb",
-     "spec/roles_generic/generators/one_role_generator_spec.rb",
-     "spec/roles_generic/generators/role_string_generator_spec.rb",
-     "spec/roles_generic/generators/role_strings_generator_spec.rb",
-     "spec/roles_generic/generators/roles_mask_generator_spec.rb",
-     "spec/roles_generic/generators/roles_string_generator_spec.rb",
-     "spec/roles_generic/strategy/multi/many_roles_spec.rb",
-     "spec/roles_generic/strategy/multi/role_strings_spec.rb",
-     "spec/roles_generic/strategy/multi/roles_mask_spec.rb",
-     "spec/roles_generic/strategy/multi/roles_string_spec.rb",
-     "spec/roles_generic/strategy/single/admin_flag_spec.rb",
-     "spec/roles_generic/strategy/single/one_role_spec.rb",
-     "spec/roles_generic/strategy/single/role_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"
+    ".rspec",
+    "LICENSE",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/roles_generic/roles/roles_generator.rb",
+    "lib/roles_generic.rb",
+    "lib/roles_generic/admin.rb",
+    "lib/roles_generic/base.rb",
+    "lib/roles_generic/generic.rb",
+    "lib/roles_generic/generic/role.rb",
+    "lib/roles_generic/generic/role_util.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/generic/user/multi_impl.rb",
+    "lib/roles_generic/generic/user/single_impl.rb",
+    "lib/roles_generic/namespaces.rb",
+    "lib/roles_generic/role.rb",
+    "lib/roles_generic/rspec/api/completeness.rb",
+    "lib/roles_generic/rspec/api/full.rb",
+    "lib/roles_generic/rspec/api/read_api.rb",
+    "lib/roles_generic/rspec/api/simple_check.rb",
+    "lib/roles_generic/rspec/api/user_class_api.rb",
+    "lib/roles_generic/rspec/api/write_api.rb",
+    "lib/roles_generic/rspec/test_it.rb",
+    "lib/roles_generic/rspec/user_setup.rb",
+    "lib/roles_generic/strategy.rb",
+    "lib/roles_generic/strategy/multi/embed_many_roles.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/embed_one_role.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/roles_generic/generators/admin_flag_generator_spec.rb",
+    "spec/roles_generic/generators/many_roles_generator_spec.rb",
+    "spec/roles_generic/generators/one_role_generator_spec.rb",
+    "spec/roles_generic/generators/role_string_generator_spec.rb",
+    "spec/roles_generic/generators/role_strings_generator_spec.rb",
+    "spec/roles_generic/generators/roles_mask_generator_spec.rb",
+    "spec/roles_generic/generators/roles_string_generator_spec.rb",
+    "spec/roles_generic/strategy/multi/many_roles_spec.rb",
+    "spec/roles_generic/strategy/multi/role_strings_spec.rb",
+    "spec/roles_generic/strategy/multi/roles_mask_spec.rb",
+    "spec/roles_generic/strategy/multi/roles_string_spec.rb",
+    "spec/roles_generic/strategy/single/admin_flag_spec.rb",
+    "spec/roles_generic/strategy/single/one_role_spec.rb",
+    "spec/roles_generic/strategy/single/role_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.homepage = %q{http://github.com/kristianmandrup/roles_generic}
   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/roles_generic/generators/admin_flag_generator_spec.rb",
-     "spec/roles_generic/generators/many_roles_generator_spec.rb",
-     "spec/roles_generic/generators/one_role_generator_spec.rb",
-     "spec/roles_generic/generators/role_string_generator_spec.rb",
-     "spec/roles_generic/generators/role_strings_generator_spec.rb",
-     "spec/roles_generic/generators/roles_mask_generator_spec.rb",
-     "spec/roles_generic/generators/roles_string_generator_spec.rb",
-     "spec/roles_generic/strategy/multi/many_roles_spec.rb",
-     "spec/roles_generic/strategy/multi/role_strings_spec.rb",
-     "spec/roles_generic/strategy/multi/roles_mask_spec.rb",
-     "spec/roles_generic/strategy/multi/roles_string_spec.rb",
-     "spec/roles_generic/strategy/single/admin_flag_spec.rb",
-     "spec/roles_generic/strategy/single/one_role_spec.rb",
-     "spec/roles_generic/strategy/single/role_string_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/roles_generic/generators/admin_flag_generator_spec.rb",
+    "spec/roles_generic/generators/many_roles_generator_spec.rb",
+    "spec/roles_generic/generators/one_role_generator_spec.rb",
+    "spec/roles_generic/generators/role_string_generator_spec.rb",
+    "spec/roles_generic/generators/role_strings_generator_spec.rb",
+    "spec/roles_generic/generators/roles_mask_generator_spec.rb",
+    "spec/roles_generic/generators/roles_string_generator_spec.rb",
+    "spec/roles_generic/strategy/multi/many_roles_spec.rb",
+    "spec/roles_generic/strategy/multi/role_strings_spec.rb",
+    "spec/roles_generic/strategy/multi/roles_mask_spec.rb",
+    "spec/roles_generic/strategy/multi/roles_string_spec.rb",
+    "spec/roles_generic/strategy/single/admin_flag_spec.rb",
+    "spec/roles_generic/strategy/single/one_role_spec.rb",
+    "spec/roles_generic/strategy/single/role_string_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -109,29 +109,29 @@ Gem::Specification.new do |s|
     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"])
-      s.add_development_dependency(%q<generator-spec>, [">= 0.7"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.1"])
+      s.add_development_dependency(%q<generator-spec>, [">= 0.7.2"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
-      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.0"])
-      s.add_runtime_dependency(%q<rails3_artifactor>, ["~> 0.3.1"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.1"])
+      s.add_runtime_dependency(%q<rails3_artifactor>, ["~> 0.3.2"])
       s.add_runtime_dependency(%q<logging_assist>, [">= 0.1.6"])
     else
-      s.add_dependency(%q<rspec>, [">= 2.0.0"])
-      s.add_dependency(%q<generator-spec>, [">= 0.7"])
+      s.add_dependency(%q<rspec>, [">= 2.0.1"])
+      s.add_dependency(%q<generator-spec>, [">= 0.7.2"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_dependency(%q<activesupport>, [">= 3.0"])
-      s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
-      s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.1"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
+      s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.2"])
       s.add_dependency(%q<logging_assist>, [">= 0.1.6"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 2.0.0"])
-    s.add_dependency(%q<generator-spec>, [">= 0.7"])
+    s.add_dependency(%q<rspec>, [">= 2.0.1"])
+    s.add_dependency(%q<generator-spec>, [">= 0.7.2"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-    s.add_dependency(%q<activesupport>, [">= 3.0"])
-    s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
-    s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.1"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
+    s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.2"])
     s.add_dependency(%q<logging_assist>, [">= 0.1.6"])
   end
 end

data/spec/roles_generic/strategy/multi/many_roles_spec.rb

@@ -1,13 +1,11 @@
 require 'spec_helper'
-use_roles_strategy :many_roles
 
 class User
   include Roles::Generic 
-  strategy :many_roles, :default
 
-  role_class :role       
   attr_accessor :name
 
+  strategy :many_roles
   valid_roles_are :admin, :user, :guest 
   
   def initialize name, *new_roles

data/spec/roles_generic/strategy/multi/role_strings_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
-use_roles_strategy :role_strings
-
 class User
   include Roles::Generic 
    
   attr_accessor :name
    
-  strategy :role_strings, :default
+  strategy :role_strings
   valid_roles_are :admin, :user, :guest
   
   def initialize name, *new_roles

data/spec/roles_generic/strategy/multi/roles_mask_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
-use_roles_strategy :roles_mask
-
 class User
   include Roles::Generic 
 
   attr_accessor :name
    
-  strategy :roles_mask, :default
+  strategy :roles_mask
   valid_roles_are :admin, :user, :guest
   
   def initialize name, *new_roles

data/spec/roles_generic/strategy/multi/roles_string_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
-use_roles_strategy :roles_string
-
 class User
   include Roles::Generic
    
   attr_accessor :name
    
-  strategy :roles_string, :default
+  strategy :roles_string
   valid_roles_are :admin, :user, :guest
   
   def initialize name, *new_roles

data/spec/roles_generic/strategy/single/admin_flag_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
-use_roles_strategy :admin_flag
-
 class User
   include Roles::Generic 
 
   attr_accessor :name 
   
-  strategy :admin_flag, :default  
+  strategy :admin_flag
   valid_roles_are :admin, :user, :guest
   
   def initialize name, *new_roles

data/spec/roles_generic/strategy/single/one_role_spec.rb

@@ -1,13 +1,10 @@
 require 'spec_helper'
-use_roles_strategy :one_role
-
 class User
   include Roles::Generic 
-  strategy :one_role, :default
 
-  role_class :role
   attr_accessor :name
 
+  strategy :one_role
   valid_roles_are :admin, :user, :guest 
   
   def initialize name, *new_roles

data/spec/roles_generic/strategy/single/role_string_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
-use_roles_strategy :role_string
-
 class User
   include Roles::Generic 
 
   attr_accessor :name
    
-  strategy :role_string, :default
+  strategy :role_string
   valid_roles_are :admin, :user, :guest 
   
   def initialize name, *new_roles

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-20 00:00:00 +01:00
+date: 2010-12-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,8 @@ dependencies:
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        - 1
+        version: 2.0.1
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,8 @@ dependencies:
         segments: 
         - 0
         - 7
-        version: "0.7"
+        - 2
+        version: 0.7.2
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -72,7 +73,8 @@ dependencies:
         segments: 
         - 3
         - 0
-        version: "3.0"
+        - 1
+        version: 3.0.1
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -86,8 +88,8 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 0
-        version: 0.3.0
+        - 1
+        version: 0.3.1
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -101,8 +103,8 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 1
-        version: 0.3.1
+        - 2
+        version: 0.3.2
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
@@ -128,13 +130,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.markdown
+- README.textile
 files: 
 - .document
-- .gitignore
 - .rspec
 - LICENSE
-- README.markdown
+- README.textile
 - Rakefile
 - VERSION
 - lib/generators/roles_generic/roles/roles_generator.rb
@@ -161,11 +162,13 @@ files:
 - lib/roles_generic/rspec/test_it.rb
 - lib/roles_generic/rspec/user_setup.rb
 - lib/roles_generic/strategy.rb
+- lib/roles_generic/strategy/multi/embed_many_roles.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/embed_one_role.rb
 - lib/roles_generic/strategy/single/one_role.rb
 - lib/roles_generic/strategy/single/role_string.rb
 - roles_generic.gemspec
@@ -193,12 +196,12 @@ files:
 - wiki/strategies/roles_mask.textile
 - wiki/strategies/roles_string.textile
 has_rdoc: true
-homepage: http://github.com/kristianmandrup/roles_for_mm
+homepage: http://github.com/kristianmandrup/roles_generic
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/README.markdown

@@ -1,178 +0,0 @@
-# Generic Roles
-
-Generic Roles is a common (generic) Roles API and implementation that specific Roles implementations for various ORMs can implement.
-This library also comes with a Rails 3 generator that can configure an existing user model with a Role strategy of choice.
-A similar generator should always be created for specific ORM implementations 
-
-I have developed the following *roles* gems for popular Object Mappers that all support the same Roles Generic API.
-
-Relational Database (SQL)
-* Active Record   - [roles_active_record](http://github.com/kristianmandrup/roles_active_record)
-* Data Mapper     - [roles_data_mapper](http://github.com/kristianmandrup/roles_data_mapper)
-
-Mongo DB
-* Mongoid         - [roles_mongoid](http://github.com/kristianmandrup/roles_mongoid)
-* Mongo Mapper    - [roles_mongo_mapper](http://github.com/kristianmandrup/roles_mongo_mapper)  
-
-Couch DB
-* Simply Stored   - [roles_simply_stored](http://github.com/kristianmandrup/roles_simply_stored)
-
-Note: Feel free to roll your own ORM extension for your favorite Object Mapper!
-
-## Install
-
-<code>gem install roles_generic</code>
-
-## Roles generator
-
-A Rails 3 generator is included to update an existing model with a roles strategy and a set of valid roles
-
-### Usage example
-
-<code>rails g roles_generic:roles --strategy admin_flag --roles guest admin</code>  
-
-This generator is currently (Oct. 10) experimental. Feel free to provide patches or bug reports ;)
-
-## Usage
-
-The library comes with the following role models built-in:
-
-Inline roles (in User model):
-* admin_flag (Boolean flag - 'admin' or not)
-* role_string (String)
-* roles_string (Comma separated String - note: no role name must have a comma in its name!)
-* role_strings (Set of Strings)
-* roles_mask (Integer mask)
-
-Using separate Role model:
-* one_role (relation to a Role model instance)
-* many_roles(Set of Role relationships)
-
-Note: The following examples use RSpec to demonstrate usage scenarios.
-
-Examples of configuring for the other strategies can be found on the wiki pages.
-
-## 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 Roles::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>
-
-## Example: Using an Object Mapper
-
-Data Mapper with persistent attributes :name and :admin_flag
-
-<pre>
-  class User
-    include Roles::Generic 
-    include DataMapper::Resource
-
-    property :name, Boolean
-    property :admin_flag, Boolean
-
-    role_strategy :admin_flag, :default
-
-    roles :admin, :user
-
-    def initialize name, *new_roles
-      self.name = name
-      self.roles = new_roles
-    end 
-  end
-</pre>
-
-_Note:_ I recommend using s specific ORM roles gem such as *roles_data_mapper* instead. But this approach might be a good starting point for developing a *roles* gem for an ORM that is not supported ;)
-
-## Role API
-
-### Instance methods
-
-Has ALL of the given roles been assigned?
-* has_roles?(*roles) - alias: is?
-
-Has ANY (at least ONE) of the given roles been assigned?
-* has_role? *roles - alias: has?
-
-Is this a valid role? (can the role be found in list of valid roles?)
-* valid_role? role
-
-Is this user the admin user (and user has no other roles)
-* admin? - short for - is?(:admin)
-
-### Class methods
-
-* roles - list of valid roles
-* roles_attribute - get the attribute where the role is stored on the user
-* roles_attribute= - set the role(s) attribute
-       
-## Usage of API
-
-<pre>
-  before :each do
-    @admin_user = User.new 'Admin user', :admin
-    @guest = User.new 'Guest', :guest
-  end
-
-  it "user 'Admin user' should have role :admin" do
-
-    @admin_user.role.should   == :admin
-    @admin_user.roles.should  == [:admin]      
-    @admin_user.admin?.should be_true
-
-    @admin_user.has_role?   (:user).should be_false
-
-    @admin_user.has_role?   (:admin).should be_true
-    @admin_user.is?         (:admin).should be_true
-    @admin_user.has_roles?  (:admin).should be_true
-    @admin_user.has?        (:admin).should be_true      
-
-  end
-
-  it "user Guest should have role :guest" do
-    @guest.roles.should == [:guest]
-    @guest.admin?.should be_false
-
-    @guest.has_role?  (:guest).should be_true    
-    @guest.has_role?  (:admin).should be_false
-    @guest.is?        (:admin).should be_false
-
-    @guest.has_roles? (:guest).should be_true
-    @guest.has?       (:admin).should be_false
-  end
-
-  it "should set role of Guest user from :guest to :admin using roles=" do
-    @guest.roles        = :admin      
-    @guest.role.should == :admin           
-
-    @guest.has_role?(:admin).should be_true      
-  end
-</pre>  
-
-## Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-## Copyright
-
-Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.