cream 0.8.5 → 0.8.6

data/Changelog.txt

@@ -1,3 +1,7 @@
+0.8.5 - Jan 4, 2011
+-----
+Major refactoring to extract common logic in generators in order to make the logic more transparent and more stable and consistent!
+
 0.8.4 - Jan 1, 2011
 -----
 Fixed argument error in #routes_configure! in devise:config generator

data/VERSION

@@ -1 +1 @@
-0.8.5
+0.8.6

data/cream.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cream}
-  s.version = "0.8.5"
+  s.version = "0.8.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2011-01-03}
+  s.date = %q{2011-01-04}
   s.description = %q{Provides assistance for setting up Session, Role and Permission systems for a Rails 3 app. Support for multiple ORMs}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -52,10 +52,19 @@ Gem::Specification.new do |s|
     "lib/generators/cancan/config/config_generator.rb",
     "lib/generators/cream/app/app_generator.rb",
     "lib/generators/cream/full_config/full_config_generator.rb",
+    "lib/generators/cream/helpers/all.rb",
+    "lib/generators/cream/helpers/args_helper.rb",
+    "lib/generators/cream/helpers/execute_helper.rb",
+    "lib/generators/cream/helpers/orm_helper.rb",
+    "lib/generators/cream/helpers/strategy_helper.rb",
     "lib/generators/cream/views/haml_util.rb",
     "lib/generators/cream/views/views_generator.rb",
     "lib/generators/cream_refactor.rb",
+    "lib/generators/devise/config/app_helper.rb",
     "lib/generators/devise/config/config_generator.rb",
+    "lib/generators/devise/config/gem_helper.rb",
+    "lib/generators/devise/users/helper.rb",
+    "lib/generators/devise/users/routes_helper.rb",
     "lib/generators/devise/users/users_generator.rb",
     "lib/generators/permits/config/config_generator.rb",
     "lib/generators/roles/config/config_generator.rb",

data/lib/generators/cream/full_config/full_config_generator.rb

@@ -4,6 +4,7 @@ require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
 require 'active_support'
+require 'generators/cream/helpers/all'
 
 module Cream
   module Generators
@@ -14,7 +15,10 @@ module Cream
       class_option  :strategy,      :type => :string,   :default => 'role_string',    :desc => "Role strategy to use"
 
       # Create Admin user
-      class_option :admin_user,     :type => :boolean,  :default => false,            :desc => "Create admin user"  
+      class_option :user_class,       :type => :string,   :default => 'User',           :desc => "User class"
+      class_option :admin_class,      :type => :string,   :default => nil,              :desc => "Admin user class"
+      class_option :role_class,       :type => :string,   :default => 'Role',           :desc => "Role class"
+      class_option :user_role_class,  :type => :string,   :default => 'UserRole',       :desc => "UserRole class"
 
       # Roles
       class_option :default_roles,  :type => :boolean,  :default => true,             :desc => "Create default roles :admin and :guest"
@@ -25,44 +29,38 @@ module Cream
 
       class_option :logfile,        :type => :string,   :default => nil,              :desc => "Logfile location"
 
-      class_option :configure,      :type => :array,    :default => [],               :desc => "Which generators to run"
+      class_option :configure,      :type => :array,    :default => [],               :desc => "Finetune which generators to run: app, permits, roles, devise, cancan"
       class_option :gems,           :type => :boolean,  :default => true,             :desc => "Add gems to gemfile?"       
       class_option :migrations,     :type => :boolean,  :default => false,            :desc => "Autorun database migrations?", :aliases => '-m'
 
-      def main_flow 
-        return nil if !validate_orm            
-        cream_initializer
-        # cream_gems if gems?
-        run_generators
-        run_migrations if run_migrations?      
+      def main 
+        execute_generator if validate_orm && validate_strategy
       end
 
-      # -----------------      
+      # -----------------
       protected
 
       include Rails3::Assist::BasicLogger
       extend Rails3::Assist::UseMacro
 
-      use_helpers :app, :special, :file
+      include Cream::GeneratorHelper
 
-      def validate_orm
-         if !valid_orms.include?(orm)
-           say "ORM #{orm} is not currently supported. Please use one of: #{valid_orms}", :red
-           false
-         end
-         true
-      end
-
-      def run_migrations?
-        options[:migrations]
-      end
+      use_helpers :app, :special, :file
 
-      def logfile
-        options[:logfile]
+      def execute_generator
+        cream_initializer
+        run_generators
+        run_migrations if run_migrations?
       end
 
-      def gems?
-        options[:gems]        
+      # use this to define which part of the app this generator should configure (which sub-generators to run!)
+      def configures
+        return default_configures if options[:configure].empty? 
+        options[:configure].map{|c| c.to_sym}
+      end      
+      
+      def default_configures
+        [:app, :permits, :roles, :devise, :cancan]
       end
 
       def run_generators
@@ -85,9 +83,8 @@ module Cream
       end
 
       def run_devise
-        # rgen "devise:config --orm #{orm} --no-gems"
-        rgen "devise:config --orm #{orm} #{admin_user_option}"
-        rgen "devise:users --orm #{orm} #{admin_user_option} --no-gems"
+        rgen "devise:config #{user_class} --orm #{orm} #{admin_user_option}"
+        rgen "devise:users --orm #{orm} --roles #{roles_list} #{admin_user_option} --no-gems"
       end
 
       def run_cancan
@@ -101,90 +98,7 @@ module Cream
       def run_permits
         rgen "permits:config --orm #{orm} --roles #{roles_list} --no-gems"
       end
-
-      def admin_user_option
-        admin_user? ? '--admin-user' : ''
-      end
-
-      def strategy
-        options[:strategy]
-      end        
-
-      def admin_user?
-        options[:admin_user]
-      end
-
-      def orm
-        @orm ||= get_orm options[:orm].to_s.underscore.to_sym
-      end
-
-      def valid_orms
-        active_record + data_mapper + mongo_mapper + [:couch_db, :mongoid]
-      end
-
-      def active_record
-        [:ar, :active_record]
-      end
-
-      def mongo_mapper
-        [:mm, :mongo_mapper]
-      end
-
-      def data_mapper
-        [:dm, :data_mapper]
-      end
-
-      def get_orm orm_name
-        return :active_record if active_record.include? orm_name
-        return :mongo_mapper if mongo_mapper.include? orm_name
-        return :data_mapper if data_mapper.include? orm_name
-        return :couch_db if orm_name == :couch_db
-        return :mongoid if orm_name == :mongoid
-      end
-
-      def default_roles?
-        options[:default_roles]
-      end
-
-      def roles_list
-        roles.join(' ')
-      end
-
-      def roles         
-        defaults = default_roles? ? ['guest', 'admin'] : [] 
-        options[:roles] + defaults
-      end
-
-      def sym_roles
-        roles.map(&:to_sym)
-      end
-
-      # rails generate ...
-      def rgen command
-        execute "rails g #{command}"
-      end        
-
-      def execute command
-        logger.debug command
-        run command
-      end
-
-      def bundle_install
-        run "bundle install"
-      end
-
-      def configures
-        return [:app, :permits, :roles, :devise, :cancan] if options[:configure].empty? 
-        options[:configure].map{|c| c.to_sym}
-      end
-
-
-      # def cream_gems
-      #   if !has_gem? :cream
-      #     gem 'cream' 
-      #   end
-      # end      
-
+      
       def cream_initializer
         create_initializer :cream do         
   %Q{Cream.setup do |config|
@@ -199,6 +113,13 @@ end}
         logger.debug "configure_locale, copy from: #{src}"            
         copy_file src, "config/locales/cream.en.yml"
       end
+      
+      private
+
+      def run_migrations?
+        options[:migrations]
+      end
+      
     end
   end
 end

data/lib/generators/cream/helpers/all.rb

@@ -0,0 +1,14 @@
+require_all File.dirname(__FILE__)
+
+module Cream
+  module GeneratorHelper
+    def self.included(base)
+      base.class_eval do
+        include Orm
+        include Executor
+        include Args
+        include Strategy
+      end
+    end
+  end
+end

data/lib/generators/cream/helpers/args_helper.rb

@@ -0,0 +1,78 @@
+module Cream
+  module GeneratorHelper
+    module Args 
+      def logfile
+        options[:logfile]
+      end
+
+      def default_roles?
+        options[:default_roles]
+      end
+
+      def roles         
+        defaults = default_roles? ? ['guest', 'admin'] : [] 
+        (options[:roles] + defaults).flat_uniq
+      end
+      
+      def has_user_model?
+        model_file?(user_class)
+      end
+
+      def set_orm
+        self.class.use_orm :"#{orm}"
+      end
+
+      def admin_user_option
+        admin_user? ? "--admin-user #{admin_user}" : ''
+      end
+
+      def roles_list
+        roles.join(' ')
+      end
+
+      def gems?
+        options[:gems]        
+      end
+
+      def document_store?
+        [:mongoid, :mongo_mapper, :couch_db].include? orm
+      end
+
+      def active_record? 
+        active_record.include? orm
+      end
+
+      def mongoid? 
+        orm == :mongoid
+      end
+      
+      def strategy
+        options[:strategy]
+      end        
+
+      def admin_user?
+        options[:admin_user]
+      end
+      
+      def sym_roles
+        roles.map(&:to_sym)
+      end
+
+      def user_class
+        options[:user_class] || 'User'
+      end
+
+      def admin_class
+        options[:admin_class] || 'Admin'
+      end
+
+      def role_class
+        options[:role_class] || 'Role'
+      end
+
+      def user_role_class
+        options[:user_role_class] || 'UserRole'
+      end                        
+    end
+  end
+end

data/lib/generators/cream/helpers/execute_helper.rb

@@ -0,0 +1,23 @@
+module Cream
+  module GeneratorHelper
+    module Executor
+      def add_gem name
+        gem name if !has_gem? name
+      end      
+       
+      # rails generate ...
+      def rgen command
+        execute "rails g #{command}"
+      end        
+
+      def execute command
+        logger.debug command
+        run command
+      end
+
+      def bundle_install
+        run "bundle install"
+      end
+    end
+  end
+end

data/lib/generators/cream/helpers/orm_helper.rb

@@ -0,0 +1,60 @@
+module Cream
+  module GeneratorHelper
+    module Orm 
+      def validate_orm
+         if !valid_orms.include?(orm)
+           say "ERROR: ORM #{orm} is not currently supported. Please use one of: #{valid_orms_list}", :red
+           return false
+         end
+         true
+      end
+      
+      def orm
+        @orm ||= get_orm options[:orm].to_s.underscore.to_sym
+      end
+
+      def valid_orms_list
+        valid_orms.map(&:to_s).join(', ')
+      end
+
+      def valid_orms
+        active_record + data_mapper + mongo_mapper + [:couch_db, :mongoid]
+      end
+
+      def active_record
+        [:ar, :active_record]
+      end
+
+      def is_active_record? name 
+        active_record.include? name
+      end
+
+      def mongo_mapper
+        [:mm, :mongo_mapper]
+      end
+
+      def is_mongo_mapper? name 
+        mongo_mapper.include? name
+      end
+
+      def data_mapper
+        [:dm, :data_mapper]
+      end
+
+      def is_data_mapper? name 
+        data_mapper.include? name
+      end
+
+      def get_orm name
+        return :active_record if is_active_record? name 
+        return :mongo_mapper if is_mongo_mapper? name
+        return :data_mapper if is_data_mapper? name
+
+        return :couch_db  if orm_name == :couch_db
+        return :mongoid   if orm_name == :mongoid
+        
+        raise ArgumentError, "ERROR: Cream does not currently support the orm: #{name}"
+      end
+    end
+  end
+end

data/lib/generators/cream/helpers/strategy_helper.rb

@@ -0,0 +1,31 @@
+module Cream
+  module GeneratorHelper
+    module Strategy 
+      def validate_strategy
+         if !valid_strategies.include?(strategy.to_sym)
+           say "ERROR: Strategy '#{strategy}' is not currently supported by Cream. Please use one of: #{valid_strategies_list}", :red
+           return false
+         end
+         true
+      end
+
+      def valid_strategies_list
+        valid_strategies.map(&:to_s).join(', ')
+      end
+
+      def valid_strategies
+        @strategies ||= basic_strategies
+        @strategies << document_store_strategies if document_store?
+        @strategies
+      end
+      
+      def basic_strategies
+        [:admin_flag, :role_string, :one_role, :many_roles, :roles_mask, :roles_string]
+      end
+      
+      def document_store_strategies 
+        [:embed_one_role, :embed_many_roles, :role_strings]
+      end
+    end
+  end
+end