cream 0.7.0 → 0.7.2

data/Rakefile

@@ -8,7 +8,7 @@ begin
     gem.homepage = "http://github.com/kristianmandrup/devise-assistant"
     gem.authors = ["Kristian Mandrup"]
 
-    gem.add_development_dependency "rspec",             ">= 2.0.0.rc" 
+    gem.add_development_dependency "rspec",             ">= 2.0.0" 
     gem.add_development_dependency "generator-spec",    "~> 0.6.5" 
     gem.add_development_dependency "rspec-action_view", "~> 0.3.1"     
     gem.add_development_dependency "rails-app-spec",    "~> 0.2.14"
@@ -23,11 +23,11 @@ begin
     gem.add_dependency "cancan",            "~> 1.4.0" 
     gem.add_dependency "rails",             "~> 3.0.0"
 
-    gem.add_dependency "rails3_artifactor", "~> 0.2.5"
+    gem.add_dependency "rails3_artifactor", "~> 0.2.8"
     gem.add_dependency 'logging_assist',    "~> 0.1.3"
 
     gem.add_dependency "r3_plugin_toolbox", "~> 0.3.6" 
-    gem.add_dependency "sugar-high",        "~> 0.2.10"
+    gem.add_dependency "sugar-high",        "~> 0.2.11"
            
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
     

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.2

data/cream.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cream}
-  s.version = "0.7.0"
+  s.version = "0.7.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-10-16}
+  s.date = %q{2010-10-17}
   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 = [
@@ -38,7 +38,6 @@ Gem::Specification.new do |s|
      "features/role_strategy/clears_role_strategy.feature",
      "init.rb",
      "lib/cream.rb",
-     "lib/cream/configure.rb",
      "lib/cream/configure/after_init/role_config.rb",
      "lib/cream/configure/rails.rb",
      "lib/cream/controller/ability.rb",
@@ -48,21 +47,13 @@ Gem::Specification.new do |s|
      "lib/cream/namespaces.rb",
      "lib/cream/rails/config.rb",
      "lib/cream/role.rb",
+     "lib/cream/roles_config.rb",
      "lib/cream/view/host_area.rb",
      "lib/cream/view/role_area.rb",
      "lib/cream/view/user_action_menu.rb",
      "lib/generators/cancan/config/config_generator.rb",
      "lib/generators/cream/app/app_generator.rb",
-     "lib/generators/cream/config/DESIGN NOTES.markdown",
-     "lib/generators/cream/config/config_generator.rb",
-     "lib/generators/cream/config/modules/app_config.rb",
-     "lib/generators/cream/config/modules/cancan_config.rb",
-     "lib/generators/cream/config/modules/cream_config.rb",
-     "lib/generators/cream/config/modules/devise_config.rb",
-     "lib/generators/cream/config/modules/devise_users_config.rb",
-     "lib/generators/cream/config/modules/helper.rb",
-     "lib/generators/cream/config/modules/permits_config.rb",
-     "lib/generators/cream/config/modules/roles_config.rb",
+     "lib/generators/cream/full_config/full_config_generator.rb",
      "lib/generators/cream/views/haml_util.rb",
      "lib/generators/cream/views/views_generator.rb",
      "lib/generators/cream_refactor.rb",
@@ -84,14 +75,7 @@ Gem::Specification.new do |s|
      "spec/generator_spec_helper.rb",
      "spec/generators/cancan/config/cancan_config_generator_spec.rb",
      "spec/generators/cream/app/app_generator_spec.rb",
-     "spec/generators/cream/config/CONFIG_GENERATOR_SPEC.markdown",
-     "spec/generators/cream/config/devise/existing_devise_users.rb",
-     "spec/generators/cream/config/empty_app/default_args_spec.rb",
-     "spec/generators/cream/config/permits/existing_permits_spec.rb",
-     "spec/generators/cream/config/permits/no_permits_spec.rb",
-     "spec/generators/cream/config/roles/default_roles.rb",
-     "spec/generators/cream/config/roles/roles_spec.rb",
-     "spec/generators/cream/shared_examples.rb",
+     "spec/generators/cream/full_config/full_config_generator_spec.rb",
      "spec/generators/cream/views_generator_spec.rb",
      "spec/generators/devise/config/devise_config_generator_spec.rb",
      "spec/generators/devise/users/devise_users_generator_spec.rb",
@@ -125,13 +109,7 @@ Gem::Specification.new do |s|
      "spec/generator_spec_helper.rb",
      "spec/generators/cancan/config/cancan_config_generator_spec.rb",
      "spec/generators/cream/app/app_generator_spec.rb",
-     "spec/generators/cream/config/devise/existing_devise_users.rb",
-     "spec/generators/cream/config/empty_app/default_args_spec.rb",
-     "spec/generators/cream/config/permits/existing_permits_spec.rb",
-     "spec/generators/cream/config/permits/no_permits_spec.rb",
-     "spec/generators/cream/config/roles/default_roles.rb",
-     "spec/generators/cream/config/roles/roles_spec.rb",
-     "spec/generators/cream/shared_examples.rb",
+     "spec/generators/cream/full_config/full_config_generator_spec.rb",
      "spec/generators/cream/views_generator_spec.rb",
      "spec/generators/devise/config/devise_config_generator_spec.rb",
      "spec/generators/devise/users/devise_users_generator_spec.rb",
@@ -145,7 +123,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.0.0.rc"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
       s.add_development_dependency(%q<generator-spec>, ["~> 0.6.5"])
       s.add_development_dependency(%q<rspec-action_view>, ["~> 0.3.1"])
       s.add_development_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
@@ -156,12 +134,12 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<devise>, [">= 1.1.2"])
       s.add_runtime_dependency(%q<cancan>, ["~> 1.4.0"])
       s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
-      s.add_runtime_dependency(%q<rails3_artifactor>, ["~> 0.2.5"])
+      s.add_runtime_dependency(%q<rails3_artifactor>, ["~> 0.2.8"])
       s.add_runtime_dependency(%q<logging_assist>, ["~> 0.1.3"])
       s.add_runtime_dependency(%q<r3_plugin_toolbox>, ["~> 0.3.6"])
-      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.10"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.11"])
     else
-      s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
       s.add_dependency(%q<generator-spec>, ["~> 0.6.5"])
       s.add_dependency(%q<rspec-action_view>, ["~> 0.3.1"])
       s.add_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
@@ -172,13 +150,13 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<devise>, [">= 1.1.2"])
       s.add_dependency(%q<cancan>, ["~> 1.4.0"])
       s.add_dependency(%q<rails>, ["~> 3.0.0"])
-      s.add_dependency(%q<rails3_artifactor>, ["~> 0.2.5"])
+      s.add_dependency(%q<rails3_artifactor>, ["~> 0.2.8"])
       s.add_dependency(%q<logging_assist>, ["~> 0.1.3"])
       s.add_dependency(%q<r3_plugin_toolbox>, ["~> 0.3.6"])
-      s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.2.11"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
     s.add_dependency(%q<generator-spec>, ["~> 0.6.5"])
     s.add_dependency(%q<rspec-action_view>, ["~> 0.3.1"])
     s.add_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
@@ -189,10 +167,10 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<devise>, [">= 1.1.2"])
     s.add_dependency(%q<cancan>, ["~> 1.4.0"])
     s.add_dependency(%q<rails>, ["~> 3.0.0"])
-    s.add_dependency(%q<rails3_artifactor>, ["~> 0.2.5"])
+    s.add_dependency(%q<rails3_artifactor>, ["~> 0.2.8"])
     s.add_dependency(%q<logging_assist>, ["~> 0.1.3"])
     s.add_dependency(%q<r3_plugin_toolbox>, ["~> 0.3.6"])
-    s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.2.11"])
   end
 end
 

data/lib/cream.rb

@@ -14,10 +14,12 @@ require 'sugar-high/kind_of'
 require 'sugar-high/array'
 
 require 'cream/role'    
+
 require_all File.dirname(__FILE__) + '/cream/controller'
 require_all File.dirname(__FILE__) + '/cream/helper'
 require_all File.dirname(__FILE__) + '/cream/view'
 require_all File.dirname(__FILE__) + '/cream/rails'
 
-require 'cream/configure'    
+require 'cream/roles_config'
+
 

data/lib/cream/configure/after_init/role_config.rb

@@ -1,16 +1,18 @@
 module Cream::View
   module Role    
     # admin?,  guest? ...
-    Cream::Role.available.each do |role|
-      class_eval %{
-        def #{role}_area &block
-          area_for_roles(#{role}, &block)
-        end 
+    if defined? Cream::Role
+      Cream::Role.available.each do |role|
+        class_eval %{
+          def #{role}_area &block
+            area_for_roles(#{role}, &block)
+          end 
         
-        def for_#{role}(&block)
-          for_roles(#{role}, &block)          
-        end
-      }
+          def for_#{role}(&block)
+            for_roles(#{role}, &block)          
+          end
+        }
+      end
     end
   end
 end
@@ -18,12 +20,14 @@ end
 module Cream::Helper
   module Role    
     # admin?,  guest? ...
-    Cream::Role.available.each do |role|
-      class_eval %{
-        def #{role}?
-          has_role? :#{role}
-        end
-      }
+    if defined? Cream::Role    
+      Cream::Role.available.each do |role|
+        class_eval %{
+          def #{role}?
+            has_role? :#{role}
+          end
+        }
+      end
     end
   end
 end

data/lib/cream/configure/rails.rb

@@ -19,16 +19,8 @@ Rails3::Plugin::Extender.new do
   after :initialize do   
     require_all File.dirname(__FILE__) + '/after_init'
 
-    # Rails3.with_configuration do
-    #   autoload_paths += %W(#{Rails.root}/app/permits) 
-    #    load_paths += %W( #{RAILS_ROOT}/extras ) 
-    # end
-
-    ActiveSupport::Dependencies.load_paths << %W(#{Rails.root}/app/permits)
-
-    # set cream config object
-    # Rails3.with_configuration do
-    #   cream = Cream::Rails::Config.new :roles => Cream::Role.available
-    # end
-  end  
+    Rails3.with_configuration do
+      load_paths += %W(#{Rails.root}/app/permits)
+    end
+  end
 end

data/lib/cream/role.rb

@@ -6,10 +6,18 @@ module Cream
   module Role
     def self.available
       return Cream.available_roles if Cream.available_roles.present?
+      return Cream.roles if Cream.roles.present?
       if defined? ::Role
         ::Role.all.map(&:name).to_symbols
+      elsif defined? ::User
+        ::User.roles.to_symbols
       else
-        User.roles.to_symbols
+        raise %q{Available roles could not be determined. Please do either of the following:\n
+1) Create a Cream.setup block
+2) Set Cream.available_roles explicitly
+3) Create Role instances and ensure a call to Role.all returns them
+4) Set User.roles explicitly
+}          
       end
     end
   end

data/lib/cream/{configure.rb → roles_config.rb}

@@ -1,7 +1,3 @@
-require 'require_all'
-require 'cream/namespaces'
-require 'cream/configure/rails'
-
 module Cream
   mattr_accessor :roles
   @@roles = []

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

@@ -4,16 +4,17 @@ require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
 
-module CanCan
+module Cancan
   module Generators 
     class ConfigGenerator < Rails::Generators::Base        
       desc "Configure CanCan"
 
-      class_option :logfile, :type => :string,   :default => nil, :desc => "Logfile location" 
+      class_option :logfile, :type => :string,   :default => nil,   :desc => "Logfile location"
+      class_option :gems,    :type => :boolean,  :default => false, :desc => "Add gems to gemfile?"       
 
       def cancan_configure
       	logger.add_logfile :logfile => logfile if logfile        
-        cancan_gems 
+        cancan_gems if gems?
         cancan_exception_handling
       end
 
@@ -24,6 +25,10 @@ module CanCan
 
       use_helpers :controller, :app      
 
+      def gems?
+        options[:gems]        
+      end
+
       def logfile
         options[:logfile]
       end
@@ -31,6 +36,11 @@ module CanCan
       def cancan_gems
         gem 'cancan'  
         gem 'cancan-rest-links'
+        bundle_install 'cancan', 'cancan-permits'
+      end
+
+      def bundle_install *gems
+        run "bundle install #{gems.jon(' ')}"
       end
 
       # CanCan access denied exception handling

data/lib/generators/cream/app/app_generator.rb

@@ -4,19 +4,17 @@ require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
 
-module Roles
+module Cream
   module Generators 
-    class ConfigGenerator < Rails::Generators::Base
-      extend Rails3::Assist::UseMacro
-        
-      desc "Configure Permits"
+    class AppGenerator < ::Rails::Generators::Base
+      desc "Configure Cream App"
 
       # 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 :orm,     :type => :string,   :default => 'active_record',   :desc => "ORM to use"
+      class_option :logfile, :type => :string,   :default => nil,               :desc => "Logfile location" 
 
       def configure_application
+      	logger.add_logfile :logfile => logfile if logfile
         app_orm
         app_routes
         app_layout
@@ -24,39 +22,62 @@ module Roles
 
       protected
 
+      include Rails3::Assist::BasicLogger
+      extend Rails3::Assist::UseMacro
+      use_helpers :app, :special, :file, :view
+
+      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 app_orm
         return if orm == 'active_record'
-        File.replace_content_from config_file(:application),  :where => "require 'rails/all'" do 
+        File.replace_content_from application_file,  :where => "require 'rails/all'" do 
         %q{
 require "action_controller/railtie"
 require "action_mailer/railtie"
 require "active_resource/railtie"
 require "rails/test_unit/railtie"
 }
+        end
       end
        
       def app_routes
-        routes = read_from config_file(:routes)
+        routes = read_routes_file
         # 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"
+          File.insert_into routes_file, :after => 'do', :content => 'root :to => "welcome#index"'          
+          rgen "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}
+        layout_content = read_view :layouts => :application        
+        [:alert, :notice].each{|name| insert_flash_displayer name, layout_content}
       end
       
-      def insert_flash_displayer name
+      def insert_flash_displayer name, layout_content
         return if layout_content =~ /<%=\s+#{name}\s+%>/          
-        insert_into_view :application, :folder => 'layouts', :after => '<body>' do
-          '<p class="alert"><%= alert %></p>'
+        logger.debug "insert_flash_displayer: #{name}"
+        insert_into_view :layouts => :application, :after => '<body>' do
+          %Q{<p class="#{name}"><%= #{name} %></p>}
         end
       end      
     end

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

@@ -0,0 +1,154 @@
+require 'sugar-high/file'
+require 'sugar-high/module'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module Cream
+  module Generators
+    class FullConfigGenerator < ::Rails::Generators::Base
+      desc "Configures a Rails 3 app with Cream" 
+
+      # 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"
+
+      # 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 :configure,      :type => :array,    :default => [],               :desc => "Which generators to run"
+      class_option :gems,           :type => :boolean,  :default => true,             :desc => "Add gems to gemfile?"       
+
+      def main_flow             
+        cream_initializer
+        cream_gems if gems?
+        run_generators      
+      end
+
+      # -----------------      
+      protected
+
+      include Rails3::Assist::BasicLogger
+      extend Rails3::Assist::UseMacro
+
+      use_helpers :app, :special, :file
+
+      def logfile
+        options[:logfile]
+      end
+
+      def gems?
+        options[:gems]        
+      end
+
+      def run_generators
+        # after setting up all gems so other generators are available
+        # run those generators to do the heavy lifting!
+        run_app if configures.include? :app      
+        run_devise if configures.include? :devise
+        run_cancan if configures.include? :cancan 
+        run_roles if configures.include? :roles
+        run_permits if configures.include? :permits
+      end
+
+      def run_app
+        rgen "cream:app --orm #{orm}"
+      end
+
+      def run_devise
+        # rgen "devise:config --orm #{orm} --no-gems"
+        rgen "devise:config --orm #{orm} --no-gems"
+        rgen "devise:users --orm #{orm} #{admin_user_option} --no-gems"
+      end
+
+      def run_cancan
+        rgen "cancan:config --orm #{orm} --no-gems"
+      end
+
+      def run_roles
+        rgen "roles:config --orm #{orm} --roles #{roles.join(' ')} --strategy #{strategy} --no-gems"
+      end
+
+      def run_permits
+        rgen "permits:config --orm #{orm} --roles #{roles.join(' ')} --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
+        options[:orm]
+      end
+
+      def default_roles?
+        options[:default_roles]
+      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
+        gem 'cream'
+        # bundle_install
+      end      
+
+      def cream_initializer
+        create_initializer :cream do         
+  %Q{Cream.setup do |config|
+    config.roles = #{sym_roles.inspect} 
+  end}      
+        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
+