cream 0.8.5 → 0.8.6

data/lib/generators/devise/users/routes_helper.rb

@@ -0,0 +1,55 @@
+module DeviseUserGenerator
+  module RoutesHelper
+    def model_routes
+      arg = "#{user_class.pluralize.underscore}"
+      arg << ", :admins" if admin_user?
+      arg
+    end
+
+    def routes_configure!
+      insert_into_routes do
+        routes_for_roles
+      end
+    end
+
+    def routes_for_roles    
+      say customize_note, :green
+    
+      routes_customize_comment << roles_routes
+    end
+
+    def roles_except *names
+      roles.reject {|r| names.include? r.to_sym }
+    end
+
+    def roles_routes 
+      roles_except(:guest).map do |role|
+        next if read_routes_file =~ /devise_for :#{role.pluralize}/
+        %Q{
+  devise_for :#{role.pluralize}, :class_name => '#{role.classify}'
+  as :#{role} do
+    match "/#{role.pluralize}/sign_up" => "devise/registrations#new", :as => :#{role}_signup
+  end
+  }
+      end.join("\n")
+    end
+    
+
+    def routes_customize_comment
+      return "" if read_routes_file =~ /customize controller action/
+      %q{
+# customize controller action if needed to render individual registration form for each role    
+# Example:
+# match "/editors/sign_up" => "user_registrations#new_editor", :as => :editor_signup
+
+#  'user_registrations_controller.rb' with the action #new_editor
+# def new_editor
+#   build_resource({})
+# end
+# 
+# and the registration form in 'views/user_registrations/new_editor.html.erb'
+#
+}
+    end
+  end
+end

data/lib/generators/devise/users/users_generator.rb

@@ -3,6 +3,10 @@ require 'sugar-high/module'
 require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
+require 'generators/cream/helpers/all'
+
+# include helpers
+require_all File.dirname(__FILE__)
 
 module Devise
   module Generators 
@@ -10,23 +14,41 @@ module Devise
       desc "Configure Devise with Users"
 
       # Create Admin user
-      class_option :admin_user,   :type => :boolean,  :default => false,            :desc => "Create admin user"  
+      class_option :admin_class,    :type => :string,   :default => nil,              :desc => "Admin class"
+
+      class_option :user_class,     :type => :string,   :default => 'User',           :desc => "User class"
+
       # ORM to use
-      class_option :orm,          :type => :string,   :default => 'active_record',  :desc => "ORM to use"
-      class_option :logfile,      :type => :string,   :default => nil,              :desc => "Logfile location" 
-      class_option :gems,         :type => :boolean,  :default => false,            :desc => "Add gems to gemfile?"       
+      class_option :orm,            :type => :string,   :default => 'active_record',  :desc => "ORM to use"
+      class_option :roles,          :type => :array,    :default => [],               :desc => "Roles"
+      class_option :default_roles,  :type => :boolean,  :default => true,             :desc => "Create default roles :admin and :guest"      
+
+      class_option :logfile,        :type => :string,   :default => nil,              :desc => "Logfile location" 
+      class_option :gems,           :type => :boolean,  :default => false,            :desc => "Add gems to gemfile?"       
       
       def configure_devise_users      
       	logger.add_logfile :logfile => logfile if logfile
         logger.debug "Configure Devise Users"
 
+        self.class.use_orm orm.to_sym
+
         devise_gems if gems?
-        devise_default_user if !has_model? :user
+
+        # create user model with devise strategies if user model doesn't already exist  
+        devise_base_user if !has_user_model?
       
         # # if User model is NOT configured with devise strategy
-        insert_devise_strategy :user, :defaults if !has_devise_user? :user
+        insert_devise_strategy user_class, :defaults if !has_devise_user? user_class
       
-        devise_admin_user if admin_user?
+        # create Admin User model for with devise strategy if admin user should be present
+        devise_user admin_user if admin_user?
+
+        # create role specific user inheriting from base User for each role
+        roles.each do |role|
+          create_user(role) if !has_model? role
+        end
+        
+        routes_configure!
       end
 
       protected
@@ -34,122 +56,80 @@ module Devise
       extend Rails3::Assist::UseMacro
       include Rails3::Assist::BasicLogger  
 
-      use_helpers :model
+      include Cream::GeneratorHelper::Orm
+      include Cream::GeneratorHelper::Executor
+      include Cream::GeneratorHelper::Args 
+      
+      include DeviseUserGenerator::Helper
+      include DeviseUserGenerator::RoutesHelper
+
+      use_helpers :model, :app, :special, :file
+
+      # creates a new user model of a given name without devise strategies, instead inheriting from the base User
+      # Never create a Guest user model as this should always be a "fake" (suggestions!?) 
+      def create_user name
+        return if name.to_sym == :guest
+
+        logger.debug "create_user: #{name}"
+        create_user_model name
+        # remove any current inheritance
+        remove_inheritance name
+
+        # and make Admin model inherit from User model 
+        inherit_model name => user_class
+      end 
+    
+      def insert_devise_strategy model_name, *names
+        insert_into_model model_name do
+          "devise #{name_string names}"
+        end
+      end
 
-      def gems?
-        options[:gems]        
+      def name_string names
+        names = devise_strategies[:default] if names.first == :defaults
+        names = devise_strategies[:admin] if names.first == :admin
+
+        names.map{|n| ":#{n}"}.join(', ')
       end
 
-      def logfile
-        options[:logfile]
+      # Must be ORM specific!
+      def create_devise_model user = 'User'
+        rgen "#{user_generator} #{user}"
       end
 
       def devise_gems
         gem 'devise'
         bundle_install # 'devise'
       end
-
-      def bundle_install #*gems
-        run "bundle install" # #{gems.jon(' ')}"
-      end
     
-      def devise_default_user
-        create_devise_model :user
+      def devise_base_user
+        create_devise_model user_class
       end
 
       def devise_admin_user
         # if app does NOT have a Admin model
-        create_admin_user if !has_model? :admin
-      end
-
-      def create_admin_user
-        logger.debug 'create_admin_user'
-        create_user_model :admin
-        # remove any current inheritance
-        remove_inheritance :admin
-
-        # insert default devise Admin strategy
-        insert_devise_strategy :admin, :defaults if has_model? :admin
-
-        # and make Admin model inherit from User model 
-        inherit_model :user => :admin
-      end 
-
-      # Helpers
-
-      def admin_user?
-        options[:admin_user]
+        create_user(admin_class) if !has_admin_model?
       end
 
-      def user_generator 
-        active_record? ?  'devise' : "#{orm}:devise"
-      end
-
-      def active_record? 
-        orm == 'active_record'
-      end
+      private
 
-      # rails generate ...
-      def rgen command
-        execute "rails g #{command}"
-      end        
+      def customize_note
+        %q{
+  Customize controller action if needed to render individual registration form for each role
+  Example:
 
-      def execute command
-        logger.debug command
-        run command
-      end        
+  routes.rb
+    match "/editors/sign_up" => "user_registrations#new_editor", :as => :editor_signup
 
-      def orm
-        options[:orm]
-      end
-                      
-      def create_user_model user = :user
-        rgen "#{user_generator} #{user}"
-      end  
-
-      def devise_users?
-        has_devise_user?(:user) && has_devise_user?(:admin)
-      end
+  user_registrations_controller.rb
+    def new_editor
+      build_resource({})
+    end
 
-      def has_devise_user? user
-        return true if user == :admin && !admin_user?
-        begin
-          read_model(user) =~ /devise/
-        rescue Exception => e
-          logger.info "Exception for #has_devise_user? #{user}: #{e.message}"
-          false
-        end
+  Create the registration form for the editor user in 'views/user_registrations/new_editor.html.erb'  
+}
       end
       
-      # Must be ORM specific!
-      def create_devise_model user = :user
-        rgen "#{user_generator} #{user}"
-      end
-    
-      def remove_inheritance user
-        File.remove_content_from model_file_name(user), :where => /<\s*ActiveRecord::Base/
-      end  
-
-      def inherit_model hash                 
-        superclass    = hash.keys.first.to_s.camelize 
-        subclass  = hash.values.first
-        logger.debug "subclass: #{subclass}"
-        logger.debug "superclass: #{superclass}"
-        File.replace_content_from model_file_name(subclass), :where => /class Admin/, :with => "class Admin < #{superclass}"
-      end
-
-      def insert_devise_strategy model_name, *names
-        names = devise_default_strategies if names.first == :defaults        
-        namestr = names.map{|n| ":#{n}"}.join(', ')
-        insert_into_model model_name do
-          "devise #{namestr}"
-        end
-      end
-    
-      def devise_default_strategies
-        [:database_authenticatable, :confirmable, :recoverable, :rememberable, :trackable, :validatable]
-      end          
-
     end
   end
 end

data/lib/generators/permits/config/config_generator.rb

@@ -3,6 +3,7 @@ require 'sugar-high/module'
 require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
+require 'generators/cream/helpers/all'
 
 module Permits
   module Generators 
@@ -10,8 +11,10 @@ module Permits
       desc "Configure Permits"
 
       # ORM to use
-      class_option :orm,      :type => :string,   :default => 'active_record',    :desc => "ORM to use"
-      class_option :roles,    :type => :array,    :default => ['guest', 'admin'], :desc => "Roles for permits"
+      class_option :orm,            :type => :string,   :default => 'active_record',    :desc => "ORM to use"
+      class_option :roles,          :type => :array,    :desc => "Roles for permits"
+      class_option :default_roles,  :type => :boolean,  :default => true,  :desc => "Create default roles :admin and :guest"      
+
       class_option :logfile,  :type => :string,   :default => nil,                :desc => "Logfile location" 
       class_option :gems,     :type => :boolean,  :default => false,              :desc => "Add gems to gemfile?"       
 
@@ -29,48 +32,15 @@ module Permits
       protected        
       
       include Rails3::Assist::BasicLogger
-      extend Rails3::Assist::UseMacro
-      
-      use_helpers :app, :file, :special
-
-      def gems?
-        options[:gems]        
-      end
-
-      # rails generate ...
-      def rgen command
-        execute "rails g #{command}"
-      end        
-
-      def execute command
-        logger.debug command
-        run command
-      end        
-
-      def logfile
-        options[:logfile]
-      end
-
-      def roles
-        options[:roles]
-      end
-
-      def roles_list
-        roles.join(' ')
-      end
-
-      def orm
-        options[:orm]
-      end
 
+      include Cream::GeneratorHelper::Orm
+      include Cream::GeneratorHelper::Executor
+      include Cream::GeneratorHelper::Args
+      
       def permits_gems
         gem 'cancan-permits'
         bundle_install # 'cancan-permits'
       end
-
-      def bundle_install #*gems
-        run "bundle install" # #{gems.jon(' ')}"
-      end
     end
   end
 end

data/lib/generators/roles/config/config_generator.rb

@@ -3,6 +3,7 @@ require 'sugar-high/module'
 require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
+require 'generators/cream/helpers/all'
 
 module Roles
   module Generators 
@@ -15,17 +16,20 @@ module Roles
       class_option :roles,              :type => :array,    :default => ['guest', 'admin'], :desc => "Valid roles to use"
       class_option :logfile,            :type => :string,   :default => nil,                :desc => "Logfile location" 
       class_option :default_roles,      :type => :boolean,  :default => true,               :desc => "Create default roles :admin and :guest"
-      class_option :gems,               :type => :boolean,  :default => true,              :desc => "Add gems to gemfile?"       
+      class_option :gems,               :type => :boolean,  :default => true,               :desc => "Add gems to gemfile?"       
       
       def configure_roles
       	logger.add_logfile :logfile => logfile if logfile
 
         # make the artifactor model methods behave according to selected orm! - this is a macro
-      	self.class.use_orm :"#{orm}"
+        set_orm      	
 
         roles_gems if gems?
+
+        # run the orm specific Roles generator
         create_roles
-        use_roles_strategy
+
+        # setup User to use the roles registered with Cream
         set_valid_roles_cream                
       end      
 
@@ -33,73 +37,32 @@ module Roles
 
       include Rails3::Assist::BasicLogger
       extend Rails3::Assist::UseMacro
+
+      include Cream::GeneratorHelper::Orm
+      include Cream::GeneratorHelper::Executor
+      include Cream::GeneratorHelper::Args
       
       use_helpers :model, :file
 
-      def gems?
-        options[:gems]        
-      end
-
-      def logfile
-        options[:logfile]
-      end
-
-      # rails generate ...
-      def rgen command
-        execute "rails g #{command}"
-      end        
-
-      def execute command
-        logger.debug command
-        run command
-      end
-
-      def orm
-        options[:orm]
-      end
-
-      def strategy
-        options[:strategy]
-      end
-
-      def roles
-        options[:roles].join(' ')
-      end
-
-      def default_roles?
-        options[:default_roles]
-      end
-
-      def add_gem name
-        gem name if !has_gem? name
-      end
-
       def roles_gems
         gem_name = "roles_#{orm}"
         add_gem gem_name
         bundle_install #gem_name
       end 
 
-      def bundle_install #*gems
-        run "bundle install"  #{gems.join(' ')}
-      end
-
-      def roles_generator
-        "#{orm}:roles"
-      end
-
       def create_roles
-        rgen "#{roles_generator} User --strategy #{strategy} --roles #{roles} #{default_roles}"        
+        rgen "#{roles_generator} User --strategy #{strategy} --roles #{roles_list} #{default_roles_option}"        
       end
 
       def set_valid_roles_cream
-        user_exist?
+        user_exist_check
+
         if initializer_file? :cream
-          if read_model(:user) =~ /valid_roles_are/
-            replace_in_model :user, :where => /valid_roles_are\s+[(.*)]/, :with => 'valid_roles_are Cream.roles'
+          if read_model(user_class) =~ /valid_roles_are/
+            replace_in_model user_class, :where => /valid_roles_are\s+[(.*)]/, :with => cream_valid_roles_statement
           else            
-            insert_into_model :user do
-              "valid_roles_are Cream::Role.available"
+            insert_into_model user_class do
+              cream_valid_roles_statement
             end
           end
         else
@@ -107,19 +70,21 @@ module Roles
         end          
       end
 
-      def user_exist?
-        raise "User model missing. Please create a User model before running this generator" if !model_file?(:user)
+      private
+
+      def user_exist_check
+        raise "ERROR: User model missing. Please create a User model before running this generator" if !has_user_model?
+      end
+
+      def roles_generator
+        "#{orm}:roles"
       end
 
-      def use_roles_strategy
-        # user_exist?        
-        
-        # unless read_model(:user) =~ /use_roles_strategy/
-        #   inject_into_file model_file(:user), "use_roles_strategy :#{strategy}\n\n", :before => "class"
-        # end        
+      def cream_valid_roles_statement
+        "valid_roles_are Cream::Role.available"
       end
 
-      def default_roles
+      def default_roles_option
         default_roles? ? '--default-roles' : '--no-default-roles'
       end      
     end