cream 0.7.0 → 0.7.2

data/lib/generators/cream/config/DESIGN NOTES.markdown

@@ -1,79 +0,0 @@
-# Config generator
-
-Each of the following should be a module in its own right!
-
-1. Create fresh Rails 3 app and set it up so that all the sub-systems work
-2. Develop the generator so that it can mutate a Rails 3 app that matches this example app
-
-## Code Design
-
-* Create a module for each sub-system to configure
-* Include modules depending on options
-* For each module call the config_[module_name] method, which is responsible for configuring that module! 
-
-## App config
-
-in config/application.rb
-
-If not using Active Record, substitute
-<pre>
-  require 'rails/all'
-</pre>
-  
-  
-With  
-<pre>
-  require "action_controller/railtie"
-  require "action_mailer/railtie"
-  require "active_resource/railtie"
-  require "rails/test_unit/railtie"  
-</pre>
-
-## Devise Configuration
-
-Gemfile
-gem 'devise' 
-gem ORM 'devise'
-
-if app does NOT have a User model
-  run devise generator to create User model
-else
-  if User model is NOT configured with devise strategy
-    insert default devise User strategy
-  end    
-end
-
-if --admin option set 
-  if app does NOT have a Admin model
-    run devise generator to create Admin model  
-    remove any current inheritance
-    and make Admin model inherit from User model 
-  else
-    insert default devise Admin strategy    
-  end
-end
-
-## Cream configuration
-
-copy locales and views (optional)
-
-## CanCan Configuration
-
-Gemfile:
-gem 'cancan'  
-gem 'cancan-rest-links' 
-
-CanCan access denied exception handling
-
-## Permits Configuration
-
-Gemfile:
-gem 'cancan-permits'
-
-Run permits generator to generate permit for each role
-
-## Roles Configuration
-
-gem ORM 'roles'
-
-run roles generator for ORM chosen 

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

@@ -1,86 +0,0 @@
-require 'sugar-high/file'
-require 'sugar-high/module'
-require 'cream'
-require 'rails3_artifactor'
-require 'logging_assist'
-
-module Cream
-  module Generators
-  end
-end
-
-require_all File.dirname(__FILE__) + '/modules'
-
-module Cream::Generators 
-  class ConfigGenerator < Rails::Generators::Base
-    extend Rails3::Assist::UseMacro
-        
-    desc "Configures Devise and Users" 
-
-    source_root File.dirname(__FILE__)
-
-    # Role Strategy
-    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"  
-
-    # Roles
-    class_option :default_roles,      :type => :boolean,  :default => true,             :desc => "Create default roles :admin and :guest"
-    class_option :roles,              :type => :array,    :default => [],               :desc => "Roles to create"
-
-    # Permits
-    class_option :permits,            :type => :boolean,  :default => true,             :desc => "Configure permits or not"
-
-    # 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 :app_config,         :type => :boolean,  :default => true,             :desc => "Make Rails app ready for Cream"
-    class_option :cream_config,       :type => :boolean,  :default => true,             :desc => "Configure app with Cream"
-    class_option :devise_config,      :type => :boolean,  :default => true,             :desc => "Configure app with Devise"
-    class_option :devise_user_config, :type => :boolean,  :default => true,             :desc => "Configure app with Devise Users"
-    class_option :cancan_config,      :type => :boolean,  :default => true,             :desc => "Configure app with CanCan"
-    class_option :permits_config,     :type => :boolean,  :default => true,             :desc => "Configure app with Permits"
-    class_option :roles_config,       :type => :boolean,  :default => true,             :desc => "Configure app with Roles"    
-
-    def main_flow 
-      configure_logger
-      configure_gems       
-
-      MODULES.each do |name|
-        method = "configure_#{name}"
-        send method if respond_to?(method) && options[:"#{name}_config"]
-      end
-    end
-
-    # -----------------      
-    protected
-
-    # configure which helper modules (from /modules subfolder) to include in this Generator!!!
-    
-    MODULES = [:app, :devise, :devise_users, :cancan, :roles, :permits, :cream]
-
-    includes Cream::Generators::Config, :helper, MODULES
-
-    include Rails3::Assist::BasicLogger
-
-    # using helpers from rails3_artifactor gem. 
-    # A macro from rails3_assist loads appropriate modules into the class and makes various Rails 3 "mutation helper" methods available
-    use_helpers :model, :controller, :permit, :application
-
-    def configure_logger
-      logger.add_logfile :logfile => logfile if logfile
-      logger.debug 'main flow'
-    end
-
-    def configure_gems
-      MODULES.each do |name|
-        method = "#{name}_gems"
-        send method if respond_to?(method) && options[:"#{name}_config"]
-      end
-      run "bundle install"
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-module Cream::Generators 
-  module Config
-    module CanCan
-      def configure_application
-        app_orm
-        app_routes
-        app_layout
-      end
-
-      def app_orm
-        return if orm == 'active_record'
-        File.replace_content_from config_file(:application),  :where => "require 'rails/all'" do 
-        %q{
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "active_resource/railtie"
-require "rails/test_unit/railtie"
-}
-      end
-       
-      def app_routes
-        routes = read_from config_file(:routes)
-        # if no :welcome controller
-        if !(routes =~ /root\s+:/)
-          # create one with an 'index' view.
-          insert_into config_file(:routes), :after => 'do', :content => 'root :to => "welcome#index"'          
-          execute "rails g controller Welcome index"
-        end
-      end
-      
-      # in 'app/views/layouts/application.html.erb'
-      # insert special flash msg displayers after opening <body> element
-      def app_layout
-        layout_content = read_view :application, :folder => 'layouts' #, :type => :erb
-
-        [:alert, :notice].each{|name| insert_flash_displayer name}
-      end
-      
-      def insert_flash_displayer name
-        return if layout_content =~ /<%=\s+#{name}\s+%>/          
-        insert_into_view :application, :folder => 'layouts', :after => '<body>' do
-          '<p class="alert"><%= alert %></p>'
-        end
-      end      
-    end
-  end
-end
-

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

@@ -1,27 +0,0 @@
-module Cream::Generators 
-  module Config
-    module CanCan  
-      def cancan_configure
-        cancan_gems 
-        cancan_exception_handling
-      end
-      
-      def cancan_gems
-        gem 'cancan'  
-        gem 'cancan-rest-links'
-      end
-
-      # CanCan access denied exception handling
-      def cancan_exception_handling
-        insert_into_controller :application, :after => "ActionController::Base\n" do
-          %{
-  rescue_from CanCan::AccessDenied do |exception|
-    flash[:error] = exception.message
-    redirect_to root_url
-  end
-  }
-        end
-      end      
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-module Cream::Generators 
-  module Config
-    module Cream 
-      def cream_configure
-        cream_gems
-        cream_initializer
-        cream_locale
-      end
-      
-      def cream_gems
-        gem_name = ORM_MAP[orm]      
-        gem gem_name if gem_name        
-        
-        gem 'cream'
-        run "bundle install"
-      end      
-
-      def cream_initializer
-        create_initializer_file :cream do 
-          %Q{
-Cream.setup do |config|
-  config.roles = #{roles.inspect} 
-end
-}
-      end
-      
-      def cream_locale
-        src = File.expand_path "config/locales/en.yml".path.up(2)
-        # src = "config/locales/en.yml"
-        logger.debug "configure_locale, copy from: #{src}"            
-        copy_file src, "config/locales/cream.en.yml"
-      end
-    end
-  end
-end
-

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

@@ -1,58 +0,0 @@
-module Cream::Generators 
-  module Config
-    module Devise        
-
-      def configure_devise        
-        initialize!
-        [Orm, Mailer, Protection].each{|m| m.configure!}
-      end
-
-      def initialize!
-        rgen 'devise_install'        
-      end
-
-      def 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
-      end
-      
-      module Protection
-        def self.configure!
-          ## Add Devise protection to Application controller:
-          insert_into_controller :application do
-            "before_filter :authenticate_user!"
-          end
-        end
-      end
-
-      module Orm
-        # inside 'config/initializers/devise.rb' change to:
-        # require 'devise/orm/mongo_mapper'
-        def self.configure!
-          File.replace_content_from initializer_file(:devise),  :where => /devise\/orm\/w+/, :content =>  'devise/orm/mongo_mapper'
-        end
-      end
-
-      module Mailer
-        def self.configure!
-          insert_application_config "action_mailer.default_url_options = { :host => 'localhost:3000' }"
-        end
-      end      
-    end
-  end
-end

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

@@ -1,109 +0,0 @@
-module Cream::Generators 
-  module Config
-    module DeviseUsers
-      attr_accessor :user_helper
-
-      def configure_devise_users
-        @user_helper = UserHelper.new user_generator
-        
-        devise_default_user if !has_model? :user
-        
-        # if User model is NOT configured with devise strategy
-        Strategy.insert_devise_strategy :user, :defaults if !has_devise_user? :user
-        
-        devise_admin_user if admin_user?
-      end
-      
-      def devise_default_user
-        user_helper.create_devise_model :user
-      end
-
-      def devise_admin_user
-        # if app does NOT have a Admin model
-        user_helper.create_admin_user if !has_model? :admin
-
-        # insert default devise Admin strategy
-        Strategy.insert_devise_strategy :admin, :defaults if has_model? :admin
-      end
-
-      def create_admin_user
-        logger.debug 'create_admin_user'
-        user_helper.create_user_model :admin
-        # remove any current inheritance
-        Inherit.remove_inheritance :admin
-        # and make Admin model inherit from User model 
-        Inherit.inherit_model :user => :admin
-      end 
-
-      # Helpers
-
-      class UserHelper
-        attr_accessor :user_generator
-        
-        def initialize user_gen
-          @user_generator = user_gen
-        end
-        
-        def create_user_model user = :user
-          rgen "#{user_generator} model #{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
-      end   
-      
-      module Inherit 
-        self << class        
-          extend Rails3::Assist::UseMacro        
-          use_helpers :model
-
-          def remove_inheritance user
-            File.remove_from model_file user, :content => /<\s*ActiveRecord::Base/
-          end  
-
-          def inherit_model hash                 
-            subclass    = hash.keys.first
-            superclass  = hash.values.first.to_s.camelize
-            File.replace_content_from model_file subclass, :where => /class Admin/, :with => "class Admin < #{superclass}"
-          end
-        end
-      end
-    
-      module Strategy
-        self << class
-          extend Rails3::Assist::UseMacro        
-          use_helpers :model
-
-          def insert_devise_strategy model_name, *names
-            names = devise_default_strategies if names.first == :defaults        
-            insert_into_model model_name do
-              "devise #{*names}"
-            end
-          end
-        
-          def devise_default_strategies
-            [:database_authenticatable, :confirmable, :recoverable, :rememberable, :trackable, :validatable]
-          end          
-        end      
-      end
-    end
-  end  
-end
-
-