roles_data_mapper 0.3.0 → 0.3.1

data/Gemfile

@@ -1,11 +1,11 @@
 source :rubygems
 
-gem "activesupport",     ">= 3.0.1"
-gem "sugar-high",         "~> 0.3.0"
+gem "activesupport",      '>= 3.0.1'
+gem "sugar-high",         '~> 0.3.1'
 gem "require_all",        '~> 1.2.0' 
 gem "roles_generic",      '~> 0.3.2'  
-gem 'rails3_artifactor',  '>= 0.3.1'
-gem 'logging_assist',     '>= 0.1.6'
+gem 'rails3_artifactor',  '>= 0.3.2'
+gem 'logging_assist',     '>= 0.2.0'
 
 gem "dm-core",            "~> 1.0"
 gem "dm-types",           "~> 1.0"
@@ -17,5 +17,5 @@ group :test do
   gem "rspec",            ">= 2.0.1" 
   gem "yaml"
   gem "logger"
-  gem "generator_spec",   '>= 0.7.0'
+  gem "generator-spec",   '>= 0.7.0'
 end

data/README.markdown

@@ -33,10 +33,6 @@ The following role strategies are included by default. Add your own by adding ex
 * roles_mask
 * role_string
 
-### Update Oct 10.
-
-Bugfix: Added dependencies to Rakefile for role generator so they should work out-of-the-box after gem is installed ;)
-
 ## Usage examples
 
 Apply :admin_flag Role strategy to User model using default roles :admin and :guest (default)

data/Rakefile

@@ -7,7 +7,8 @@ begin
     gem.email = "kmandrup@gmail.com"
     gem.homepage = "http://github.com/kristianmandrup/roles_for_dm"
     gem.authors = ["Kristian Mandrup"]
-    gem.add_development_dependency "rspec", ">= 2.0.1"
+    gem.add_development_dependency "rspec",           ">= 2.0.1"
+    gem.add_development_dependency "generator-spec",  '>= 0.7.0'
 
     gem.add_dependency "dm-core",         "~> 1.0"
     gem.add_dependency "dm-types",        "~> 1.0"
@@ -20,7 +21,7 @@ begin
     gem.add_dependency "roles_generic",     '>= 0.3.2'
 
     gem.add_dependency 'rails3_artifactor', '>= 0.3.2'
-    gem.add_dependency 'logging_assist',    '>= 0.1.6'
+    gem.add_dependency 'logging_assist',    '>= 0.2.0'
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/generators/data_mapper/roles/core_ext.rb

@@ -0,0 +1,14 @@
+# TODO: 
+# model_file_name and similar methods in rails3_assist and rails3_artifaftor should be fixed to always call underscore on filenames
+
+class String
+  def as_filename
+    self.underscore  
+  end
+end
+
+class Symbol
+  def as_filename
+    self.to_s.underscore  
+  end
+end

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

@@ -1,44 +1,55 @@
 require 'rails3_artifactor'
 require 'logging_assist'
+require 'generators/data_mapper/roles/core_ext'
 
 module DataMapper 
   module Generators
-    class RolesGenerator < Rails::Generators::NamedBase      
-      desc "Add role strategy to a model" 
+    class RolesGenerator < Rails::Generators::Base      
+      desc "Add role strategy User model using Data Mapper" 
       
-      # argument name
+      argument     :user_class,       :type => :string,   :default => 'User',                         :desc => "User class name"
       
-      class_option :strategy, :type => :string, :aliases => "-s", :default => 'role_string', 
+      class_option :strategy,         :type => :string,   :aliases => "-s",   :default => 'role_string', 
                    :desc => "Role strategy to use (admin_flag, role_string, roles_string, role_strings, one_role, many_roles, roles_mask)"
 
 
-      class_option :logfile, :type => :string,   :default => nil,   :desc => "Logfile location"
-      class_option :roles, :type => :array, :default => [], :desc => "Valid roles"
+
+      class_option :roles,            :type => :array,    :aliases => "-r",   :default => [],         :desc => "Valid roles"
       
-      class_option :role_class,       :type => :string,   :aliases => "-rc", :default => 'Role', :desc => "Role class"
-      class_option :user_class,       :type => :string, :aliases => "-uc", :default => 'User', :desc => "User class"
-      class_option :user_role_class,  :type => :string, :aliases => "-urc", :default => 'UserRole', :desc => "User Role join class"
+      class_option :role_class,       :type => :string,   :aliases => "-rc",  :default => 'Role',     :desc => "Role class name"
+      class_option :user_role_class,  :type => :string,   :aliases => "-urc", :default => 'UserRole', :desc => "User-Role (join table) class name"
+
+      class_option :logfile,          :type => :string,   :aliases => "-l",   :default => nil,        :desc => "Logfile location"
+
+      source_root File.dirname(__FILE__) + '/templates'
 
       def apply_role_strategy
         logger.add_logfile :logfile => logfile if logfile
-        logger.debug "apply_role_strategy for : #{strategy} in model #{name}"
+        logger.debug "apply_role_strategy for : #{strategy} in model #{user_class}"
 
         if !valid_strategy?
-          say "Strategy '#{strategy}' is not valid, at least not for Data Mapper", :red
+          logger.error "Strategy '#{strategy}' is not valid, at least not for Data Mapper"
           return 
         end
 
-        if !has_model_file?(user_model_name)
-          say "User model #{user_model_name} not found", :red
+        if !has_model_file?(user_file)
+          say "User model in #{user_file} not found", :red
           return 
         end
        
-        begin
-          insert_into_model name, :after => 'include DataMapper::Resource'  do
+        if !is_data_mapper_model?(user_file)
+          logger.error "User model in #{user_file} is not a Data Mapper resource"
+          return 
+        end
+        
+        begin 
+          logger.debug "Trying to insert roles code into #{user_file}"     
+
+          insert_into_model user_file, :after => 'include DataMapper::Resource'  do
             insertion_text
           end
         rescue Exeption => e
-          logger.debug"Error: #{e.message}"
+          logger.error "Error: #{e.message}"
         end 
         
         copy_role_models if role_class_strategy?        
@@ -51,6 +62,22 @@ module DataMapper
 
       use_orm :data_mapper
 
+      def user_file
+        user_class.as_filename
+      end
+
+      def role_file
+        role_class.as_filename
+      end
+
+      def user_role_file
+        user_role_class.as_filename
+      end
+
+      def is_data_mapper_model? name
+        read_model(name) =~ /include DataMapper::Resource/
+      end
+
       def valid_strategy?
         valid_strategies.include? strategy.to_sym
       end
@@ -70,26 +97,22 @@ module DataMapper
       end
 
       def copy_one_role_model
-        logger.debug "copy_one_role_model: #{role_class.underscore}"
+        logger.debug "generating role model for one_role strategy: #{role_file}"
 
-        template 'one_role/role.rb', "app/models/#{role_class.underscore}.rb"
+        template 'one_role/role.rb', "app/models/#{role_file}.rb"
       end
 
       def copy_many_roles_models        
-        logger.debug "copy_many_roles_models: #{role_class.underscore} and #{user_role_class.underscore}"
+        logger.debug "generating role models for many_roles strategy: #{role_file} and #{user_role_file}"
 
-        template 'many_roles/role.rb', "app/models/#{role_class.underscore}.rb"        
-        template 'many_roles/user_role.rb', "app/models/#{user_role_class.underscore}.rb"
+        template 'many_roles/role.rb', "app/models/#{role_file}.rb"        
+        template 'many_roles/user_role.rb', "app/models/#{user_role_file}.rb"
       end
 
       def logfile
         options[:logfile]
       end
 
-      def user_model_name
-        name || 'User'
-      end
-
       def orm
         :data_mapper
       end
@@ -115,7 +138,7 @@ module DataMapper
       end
 
       def strategy_options
-        return ", :role_class => :#{role_class.to_s.underscore}" if role_class_strategy? && role_class.to_s != 'Role'
+        return ", :role_class => '#{role_class}'" if role_class_strategy? && role_class.to_s != 'Role'
         ''
       end
         
@@ -125,7 +148,7 @@ module DataMapper
       end
 
       def has_valid_roles_statement? 
-        !(read_model(user_model_name) =~ /valid_roles_are/).nil?
+        !(read_model(user_class) =~ /valid_roles_are/).nil?
       end
   
       def insertion_text
@@ -134,10 +157,6 @@ module DataMapper
   #{valid_roles_statement}}
       end
 
-      def user_class
-        options[:user_class].classify || 'User'
-      end
-
       def role_class
         options[:role_class].classify || 'Role'
       end

data/roles_data_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_data_mapper}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2011-01-01}
+  s.date = %q{2011-01-10}
   s.description = %q{Makes it easy to set a role strategy on your User model in DataMapper}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "README.markdown",
     "Rakefile",
     "VERSION",
+    "lib/generators/data_mapper/roles/core_ext.rb",
     "lib/generators/data_mapper/roles/roles_generator.rb",
     "lib/generators/data_mapper/roles/templates/many_roles/role.rb",
     "lib/generators/data_mapper/roles/templates/many_roles/user_role.rb",
@@ -79,17 +80,18 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
-      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.1"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_runtime_dependency(%q<roles_generic>, ["~> 0.3.2"])
-      s.add_runtime_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
-      s.add_runtime_dependency(%q<logging_assist>, [">= 0.1.6"])
+      s.add_runtime_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
+      s.add_runtime_dependency(%q<logging_assist>, [">= 0.2.0"])
       s.add_runtime_dependency(%q<dm-core>, ["~> 1.0"])
       s.add_runtime_dependency(%q<dm-types>, ["~> 1.0"])
       s.add_runtime_dependency(%q<dm-migrations>, ["~> 1.0"])
       s.add_runtime_dependency(%q<dm-validations>, ["~> 1.0"])
       s.add_runtime_dependency(%q<dm-sqlite-adapter>, ["~> 1.0"])
       s.add_development_dependency(%q<rspec>, [">= 2.0.1"])
+      s.add_development_dependency(%q<generator-spec>, [">= 0.7.0"])
       s.add_runtime_dependency(%q<dm-core>, ["~> 1.0"])
       s.add_runtime_dependency(%q<dm-types>, ["~> 1.0"])
       s.add_runtime_dependency(%q<dm-migrations>, ["~> 1.0"])
@@ -99,20 +101,21 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<sugar-high>, [">= 0.3.1"])
       s.add_runtime_dependency(%q<roles_generic>, [">= 0.3.2"])
       s.add_runtime_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
-      s.add_runtime_dependency(%q<logging_assist>, [">= 0.1.6"])
+      s.add_runtime_dependency(%q<logging_assist>, [">= 0.2.0"])
     else
       s.add_dependency(%q<activesupport>, [">= 3.0.1"])
-      s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_dependency(%q<roles_generic>, ["~> 0.3.2"])
-      s.add_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
-      s.add_dependency(%q<logging_assist>, [">= 0.1.6"])
+      s.add_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
+      s.add_dependency(%q<logging_assist>, [">= 0.2.0"])
       s.add_dependency(%q<dm-core>, ["~> 1.0"])
       s.add_dependency(%q<dm-types>, ["~> 1.0"])
       s.add_dependency(%q<dm-migrations>, ["~> 1.0"])
       s.add_dependency(%q<dm-validations>, ["~> 1.0"])
       s.add_dependency(%q<dm-sqlite-adapter>, ["~> 1.0"])
       s.add_dependency(%q<rspec>, [">= 2.0.1"])
+      s.add_dependency(%q<generator-spec>, [">= 0.7.0"])
       s.add_dependency(%q<dm-core>, ["~> 1.0"])
       s.add_dependency(%q<dm-types>, ["~> 1.0"])
       s.add_dependency(%q<dm-migrations>, ["~> 1.0"])
@@ -122,21 +125,22 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<sugar-high>, [">= 0.3.1"])
       s.add_dependency(%q<roles_generic>, [">= 0.3.2"])
       s.add_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
-      s.add_dependency(%q<logging_assist>, [">= 0.1.6"])
+      s.add_dependency(%q<logging_assist>, [">= 0.2.0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 3.0.1"])
-    s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
     s.add_dependency(%q<roles_generic>, ["~> 0.3.2"])
-    s.add_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
-    s.add_dependency(%q<logging_assist>, [">= 0.1.6"])
+    s.add_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
+    s.add_dependency(%q<logging_assist>, [">= 0.2.0"])
     s.add_dependency(%q<dm-core>, ["~> 1.0"])
     s.add_dependency(%q<dm-types>, ["~> 1.0"])
     s.add_dependency(%q<dm-migrations>, ["~> 1.0"])
     s.add_dependency(%q<dm-validations>, ["~> 1.0"])
     s.add_dependency(%q<dm-sqlite-adapter>, ["~> 1.0"])
     s.add_dependency(%q<rspec>, [">= 2.0.1"])
+    s.add_dependency(%q<generator-spec>, [">= 0.7.0"])
     s.add_dependency(%q<dm-core>, ["~> 1.0"])
     s.add_dependency(%q<dm-types>, ["~> 1.0"])
     s.add_dependency(%q<dm-migrations>, ["~> 1.0"])
@@ -146,7 +150,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<sugar-high>, [">= 0.3.1"])
     s.add_dependency(%q<roles_generic>, [">= 0.3.2"])
     s.add_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
-    s.add_dependency(%q<logging_assist>, [">= 0.1.6"])
+    s.add_dependency(%q<logging_assist>, [">= 0.2.0"])
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-01 00:00:00 +01:00
+date: 2011-01-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,8 +42,8 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 0
-        version: 0.3.0
+        - 1
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: *id002
@@ -87,8 +87,8 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 1
-        version: 0.3.1
+        - 2
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: *id005
@@ -101,9 +101,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 1
-        - 6
-        version: 0.1.6
+        - 2
+        - 0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: *id006
@@ -193,21 +193,22 @@ dependencies:
   prerelease: false
   version_requirements: *id012
 - !ruby/object:Gem::Dependency 
-  name: dm-core
+  name: generator-spec
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
         - 0
-        version: "1.0"
-  type: :runtime
+        - 7
+        - 0
+        version: 0.7.0
+  type: :development
   prerelease: false
   version_requirements: *id013
 - !ruby/object:Gem::Dependency 
-  name: dm-types
+  name: dm-core
   requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -221,7 +222,7 @@ dependencies:
   prerelease: false
   version_requirements: *id014
 - !ruby/object:Gem::Dependency 
-  name: dm-migrations
+  name: dm-types
   requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -235,7 +236,7 @@ dependencies:
   prerelease: false
   version_requirements: *id015
 - !ruby/object:Gem::Dependency 
-  name: dm-validations
+  name: dm-migrations
   requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -249,8 +250,22 @@ dependencies:
   prerelease: false
   version_requirements: *id016
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: dm-validations
   requirement: &id017 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id017
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id018 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -262,10 +277,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *id017
+  version_requirements: *id018
 - !ruby/object:Gem::Dependency 
   name: require_all
-  requirement: &id018 !ruby/object:Gem::Requirement 
+  requirement: &id019 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -277,10 +292,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *id018
+  version_requirements: *id019
 - !ruby/object:Gem::Dependency 
   name: sugar-high
-  requirement: &id019 !ruby/object:Gem::Requirement 
+  requirement: &id020 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -292,10 +307,10 @@ dependencies:
         version: 0.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *id019
+  version_requirements: *id020
 - !ruby/object:Gem::Dependency 
   name: roles_generic
-  requirement: &id020 !ruby/object:Gem::Requirement 
+  requirement: &id021 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -307,10 +322,10 @@ dependencies:
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *id020
+  version_requirements: *id021
 - !ruby/object:Gem::Dependency 
   name: rails3_artifactor
-  requirement: &id021 !ruby/object:Gem::Requirement 
+  requirement: &id022 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -322,22 +337,22 @@ dependencies:
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *id021
+  version_requirements: *id022
 - !ruby/object:Gem::Dependency 
   name: logging_assist
-  requirement: &id022 !ruby/object:Gem::Requirement 
+  requirement: &id023 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 1
-        - 6
-        version: 0.1.6
+        - 2
+        - 0
+        version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *id022
+  version_requirements: *id023
 description: Makes it easy to set a role strategy on your User model in DataMapper
 email: kmandrup@gmail.com
 executables: []
@@ -356,6 +371,7 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- lib/generators/data_mapper/roles/core_ext.rb
 - lib/generators/data_mapper/roles/roles_generator.rb
 - lib/generators/data_mapper/roles/templates/many_roles/role.rb
 - lib/generators/data_mapper/roles/templates/many_roles/user_role.rb