cream 0.6.4 → 0.7.0

data/lib/generators/cream/config/modules/helper.rb

@@ -64,7 +64,7 @@ module Cream::Generators
       end
 
       def admin_user?
-        options[:admin]
+        options[:admin_user]
       end
 
       def here

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

@@ -0,0 +1,105 @@
+require 'sugar-high/file'
+require 'sugar-high/module'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module Devise
+  module Generators 
+    class ConfigGenerator < Rails::Generators::Base        
+      desc "Configure Devise"
+
+      # 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" 
+
+      def configure_devise
+      	logger.add_logfile :logfile => logfile if logfile	        
+        devise_gems
+		    devise_install
+        [:orm, :mailer, :protection].each{|m| send(:"#{m}_configure!", orm) }
+      end
+
+      protected
+
+      include Rails3::Assist::BasicLogger
+      extend Rails3::Assist::UseMacro
+
+      use_helpers :controller, :app, :special, :file
+
+      def logfile
+        options[:logfile]
+      end
+
+      def orm
+        options[:orm]
+      end
+
+      # rails generate ...
+      def rgen command
+        execute "rails g #{command}"
+      end        
+
+      def execute command
+        logger.debug command
+        run command
+      end        
+    
+      def devise_install
+        logger.debug "initializer_file? #{initializer_file?(:devise)}"
+        return if initializer_file?(:devise) 
+        rgen 'devise:install'
+      end        
+
+      def bundle_install
+        run "bundle install"
+      end
+
+      def devise_gems 
+        logger.debug 'devise_gems'
+        gem 'devise'
+
+        # Devise ORM integration
+        case orm.to_sym
+        when :mongoid
+          say "Please configure Devise for Mongoid as similar to Rails 3 example app: http://github.com/fortuity/rails3-mongoid-devise"
+        when :mongo_mapper
+          gem 'mm-devise'
+        when :data_mapper
+          gem 'dm-devise'
+        when :couch_db
+          gem 'devise_couch'
+          say "Please note that Couch DB does not currently have a Roles implementation. Feel free to provide one."
+          say "Look at Roles DataMapper (roles_data_mapper) for an example ;)"
+        else
+          say "Orm #{orm} is not currently supported by Cream. You are most welcome to provide a Cream adapter for that ORM ;)"
+        end
+        # bundle_install
+      end 
+
+      def protection_configure! orm
+        logger.debug "config protection"            
+        ## Add Devise protection to Application controller:
+        insert_into_controller :application do
+          "before_filter :authenticate_user!"
+        end
+      end
+
+      # inside 'config/initializers/devise.rb' change to:
+      # require 'devise/orm/mongo_mapper'
+      def orm_configure! orm
+        return if orm == :active_record 
+        logger.debug "config orm: #{orm}"
+        found = File.read(initializer_file(:devise)) =~/devise\/orm\/w+/
+        logger.debug "found?: #{found}"
+        
+        File.replace_content_from initializer_file(:devise),  :where => /devise\/orm\/\w+/, :with =>  "devise/orm/#{orm}"
+      end
+        
+      def mailer_configure! orm
+        logger.debug "config mailer"            
+        insert_application_config "action_mailer.default_url_options = { :host => 'localhost:3000' }"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+require 'sugar-high/file'
+require 'sugar-high/module'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module Devise
+  module Generators 
+    class UsersGenerator < Rails::Generators::Base        
+      desc "Configure Devise with Users"
+
+      # Create Admin user
+      class_option :admin_user,         :type => :boolean,  :default => false,            :desc => "Create admin user"  
+      # 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" 
+
+      def configure_devise_users      
+      	logger.add_logfile :logfile => logfile if logfile
+        logger.debug "Configure Devise Users"
+
+        devise_gems
+        devise_default_user if !has_model? :user
+      
+        # # if User model is NOT configured with devise strategy
+        insert_devise_strategy :user, :defaults if !has_devise_user? :user
+      
+        devise_admin_user if admin_user?
+      end
+
+      protected
+
+      extend Rails3::Assist::UseMacro
+      include Rails3::Assist::BasicLogger  
+
+      use_helpers :model
+
+      def logfile
+        options[:logfile]
+      end
+
+      def devise_gems
+        gem 'devise'
+        # bundle_install
+      end
+
+      def bundle_install
+        run "bundle install"
+      end
+    
+      def devise_default_user
+        create_devise_model :user
+      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]
+      end
+
+      def user_generator 
+        active_record? ?  'devise' : "#{orm}:devise"
+      end
+
+      def active_record? 
+        orm == 'active_record'
+      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 create_user_model user = :user
+        rgen "#{user_generator} #{user}"
+      end  
+
+      def devise_users?
+        has_devise_user?(:user) && has_devise_user?(:admin)
+      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
+      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

@@ -0,0 +1,68 @@
+require 'sugar-high/file'
+require 'sugar-high/module'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module Permits
+  module Generators 
+    class ConfigGenerator < Rails::Generators::Base        
+      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 :logfile,  :type => :string,   :default => nil,                :desc => "Logfile location" 
+
+      def configure_permits
+      	logger.add_logfile :logfile => logfile if logfile
+        logger.debug "Configure Permits"
+
+		    permits_gems
+		    permits_initializer
+
+        # Run permits generator to generate permit for each role
+        rgen "permits --roles #{roles}"
+      end           
+
+      protected        
+      
+      include Rails3::Assist::BasicLogger
+      extend Rails3::Assist::UseMacro
+      
+      use_helpers :app, :file, :special
+
+      # 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 orm
+        options[:orm]
+      end
+
+      def permits_gems
+        gem 'cancan-permits'        
+      end 
+
+      def permits_initializer
+        create_initializer :permits do 
+          "Permits::Ability.orm = :#{options[:orm]}"
+        end
+      end 
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+require 'sugar-high/file'
+require 'sugar-high/module'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module Roles
+  module Generators 
+    class ConfigGenerator < Rails::Generators::Base        
+      desc "Configure Roles"
+
+      # ORM to use
+      class_option :orm,                :type => :string,   :default => 'active_record',    :desc => "ORM to use"
+      class_option :strategy,           :type => :string,   :default => 'role_string',      :desc => "Roles strategy to use"
+      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"
+
+      def configure_roles
+      	logger.add_logfile :logfile => logfile if logfile
+        roles_gems
+        create_roles
+        set_valid_roles_cream
+        use_roles_strategy        
+      end      
+
+      protected
+
+      include Rails3::Assist::BasicLogger
+      extend Rails3::Assist::UseMacro
+      
+      use_helpers :model, :file
+
+      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 roles_gems
+        gem "roles_#{orm}"
+        # bundle_install
+      end 
+
+      def bundle_install
+        run "bundle install"
+      end
+
+      def roles_generator
+        "#{orm}:roles"
+      end
+
+      def create_roles
+        rgen "#{roles_generator} --strategy #{strategy} --roles #{roles} #{default_roles}"        
+      end
+
+      def set_valid_roles_cream
+        user_exist?
+        if initializer_file? :cream
+          if read_model(:user) =~ /valid_roles_are/
+            replace_in_model_file :user, :where => /valid_roles_are\s+[(.*)]/, :with => 'valid_roles_are Cream.roles'
+          else
+            insert_into_model :user do
+              "valid_roles_are Cream.roles"
+            end
+          end
+        else
+          say "Missing initializer file for cream. Please run Cream config generator to create this initializer"
+        end          
+      end
+
+      def user_exist?
+        raise "User model missing. Please create a User model before running this generator" if !model_file?(:user)
+      end
+
+      def use_roles_strategy
+        user_exist?        
+        
+        unless read_model(:user) =~ /use_roles_strategy/
+          inject_into_file model_file(:user), "use_roles_strategy :admin_flag\n\n", :before => "class"
+        end        
+      end
+
+      def default_roles
+        default_roles? ? '--default-roles' : '--no-default-roles'
+      end      
+    end
+  end
+end

data/spec/cream/configure/cream_setup_spec.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+
 Cream.setup do |config|
   # ==> Mailer Configuration
   # Configure the e-mail address which will be shown in DeviseMailer.