cream 0.6.4 → 0.7.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/Gemfile

@@ -4,12 +4,12 @@ source 'http://gems.github.com/'
 group :default do
   gem "devise-links",      "~> 0.1.4"    
   gem "cancan-rest-links", "~> 0.1.3" 
-  gem "cancan-permits",    "~> 0.1.3" 
+  gem "cancan-permits",    "~> 0.2.3" 
 
   gem "require_all",       "~> 1.2.0"    
 
   gem "devise",            ">= 1.1.2"    
-  gem "cancan",            "~> 1.3.4" 
+  gem "cancan",            "~> 1.4.0" 
   gem "rails",             "~> 3.0.0"
 
   gem "rails3_artifactor", "~> 0.2.5"
@@ -19,7 +19,8 @@ group :default do
   gem "sugar-high",        "~> 0.2.10"      
 end
 
-group :test do
+group :test do    
+  gem 'ffaker',            '~> 0.4.0',    :git => 'http://github.com/kematzy/ffaker.git'
   gem "rspec",             ">= 2.0.0.rc" 
   gem "generator-spec",    "~> 0.6.5" 
   gem "rspec-action_view", "~> 0.3.1"     

data/README.markdown

@@ -128,17 +128,24 @@ Currently CanCan is supported as the permission system. I have added the concept
 
 Check out [Cancan permits](http://github.com/kristianmandrup/cancan-permits) for more info for how to use Permits.
 
-_Note_: In the future I will add the ability for a given role to have multiple Permits in a PermitSet, so that Permits are stand-alone and not linked to a given role, which
-allows permits to be reused for multiple roles. Stay tuned or join in the effort!
+Cream has ben updated to support my latest version of *Cancan permits*, which now support all the ORMs which cream aims to support and which Roles Generic supports.
+The various players are starting to play together nice! 
 
 ## Generators
 
 The following generators are currently available 
 
-* config - Configure Rails 3 application with devise Session strategies, a Role strategy, valid roles, and Permits
-* views  - Generate partials to display menu items for Session actions such as logout, login etc. 
+* cream:config    - Configure Rails 3 application with Cream
+* cream:users     - Configure Rails 3 application with Cream
+* cream:views     - Generate partials for menu items
 
-The *config* generator should automatically setup up your project with Devise, a Roles strategy of choice a Permission system of choice and all using an ORM of your choice! 
+* permits:config  - Configures app with CanCan Permits
+* cancan:config   - Configures app with CanCan
+* roles:config    - Configures app with Roles
+
+All the above generators now have specs to show how to use them. 
+Note: They have still not been tested in all scenarios with all ORMs, role strategies etc.
+I am sure there are still some issues... so please help uncover these!
 
 Cream will support these ORMs:
 
@@ -147,18 +154,11 @@ Cream will support these ORMs:
 * Mongo Mapper
 * Mongoid 
 
-Status 17 sept, 2010: 
-The latest *generator-spec* and other supporting generator utils I've created (such as rails3_artifactor) should facilitate finishing this generator...
-
-The goal is to make the generator:
-* Configure the Rails 3 app with appropriate gems for the sub-systems 
-* Run various other generators 
-
-The result should be a full (or nearly full) integration of all the sub-systems mentioned for a given Rails 3 app with the ORM of choice.
+### Config Generator ###
 
-See [Cream rails 3 app](http://github.com/kristianmandrup/cream-rails3-app) to get an idea of the end goal.
+*Deprecated*
 
-### Config Generator ###
+In the future this should be a master generator which calls the other generators in turn.
 
 <code>rails g cream::config --strategy ROLE_STRATEGY [--init-devise] [--admin_user] [--orm] [--roles]</code>
 

data/Rakefile

@@ -16,11 +16,11 @@ begin
     gem.add_dependency "require_all",       "~> 1.2.0"
     
     gem.add_dependency "devise-links",      "~> 0.1.4"
-    gem.add_dependency "cancan-rest-links", "~> 0.1.3" 
-    gem.add_dependency "cancan-permits",    "~> 0.1.3" 
+    gem.add_dependency "cancan-rest-links", "~> 0.1.4" 
+    gem.add_dependency "cancan-permits",    "~> 0.2.4" 
 
     gem.add_dependency "devise",            ">= 1.1.2"
-    gem.add_dependency "cancan",            "~> 1.3.4" 
+    gem.add_dependency "cancan",            "~> 1.4.0" 
     gem.add_dependency "rails",             "~> 3.0.0"
 
     gem.add_dependency "rails3_artifactor", "~> 0.2.5"

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.7.0

data/cream.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cream}
-  s.version = "0.6.4"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-10-07}
+  s.date = %q{2010-10-16}
   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 = [
@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
      "README.markdown"
   ]
   s.files = [
-    ".document",
+    ".bundle/config",
+     ".document",
      ".gitignore",
      ".rspec",
      "Changelog.txt",
@@ -50,6 +51,8 @@ Gem::Specification.new do |s|
      "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",
@@ -63,6 +66,10 @@ Gem::Specification.new do |s|
      "lib/generators/cream/views/haml_util.rb",
      "lib/generators/cream/views/views_generator.rb",
      "lib/generators/cream_refactor.rb",
+     "lib/generators/devise/config/config_generator.rb",
+     "lib/generators/devise/users/users_generator.rb",
+     "lib/generators/permits/config/config_generator.rb",
+     "lib/generators/roles/config/config_generator.rb",
      "log/development.log",
      "sandbox/test.rb",
      "spec/configure_helper.rb",
@@ -75,6 +82,8 @@ Gem::Specification.new do |s|
      "spec/cream/view/host_area_spec.rb",
      "spec/cream/view/role_area_spec.rb",
      "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",
@@ -84,6 +93,10 @@ Gem::Specification.new do |s|
      "spec/generators/cream/config/roles/roles_spec.rb",
      "spec/generators/cream/shared_examples.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",
+     "spec/generators/permits/config/permits_config_generator_spec.rb",
+     "spec/generators/roles/config/roles_config_generator_spec.rb",
      "spec/spec_helper.rb",
      "wiki/CONFIG_GENERATOR.txt",
      "wiki/DESIGN.txt",
@@ -110,6 +123,8 @@ Gem::Specification.new do |s|
      "spec/cream/view/host_area_spec.rb",
      "spec/cream/view/role_area_spec.rb",
      "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",
@@ -118,6 +133,10 @@ Gem::Specification.new do |s|
      "spec/generators/cream/config/roles/roles_spec.rb",
      "spec/generators/cream/shared_examples.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",
+     "spec/generators/permits/config/permits_config_generator_spec.rb",
+     "spec/generators/roles/config/roles_config_generator_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -132,10 +151,10 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_runtime_dependency(%q<devise-links>, ["~> 0.1.4"])
-      s.add_runtime_dependency(%q<cancan-rest-links>, ["~> 0.1.3"])
-      s.add_runtime_dependency(%q<cancan-permits>, ["~> 0.1.3"])
+      s.add_runtime_dependency(%q<cancan-rest-links>, ["~> 0.1.4"])
+      s.add_runtime_dependency(%q<cancan-permits>, ["~> 0.2.4"])
       s.add_runtime_dependency(%q<devise>, [">= 1.1.2"])
-      s.add_runtime_dependency(%q<cancan>, ["~> 1.3.4"])
+      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<logging_assist>, ["~> 0.1.3"])
@@ -148,10 +167,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_dependency(%q<devise-links>, ["~> 0.1.4"])
-      s.add_dependency(%q<cancan-rest-links>, ["~> 0.1.3"])
-      s.add_dependency(%q<cancan-permits>, ["~> 0.1.3"])
+      s.add_dependency(%q<cancan-rest-links>, ["~> 0.1.4"])
+      s.add_dependency(%q<cancan-permits>, ["~> 0.2.4"])
       s.add_dependency(%q<devise>, [">= 1.1.2"])
-      s.add_dependency(%q<cancan>, ["~> 1.3.4"])
+      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<logging_assist>, ["~> 0.1.3"])
@@ -165,10 +184,10 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
     s.add_dependency(%q<devise-links>, ["~> 0.1.4"])
-    s.add_dependency(%q<cancan-rest-links>, ["~> 0.1.3"])
-    s.add_dependency(%q<cancan-permits>, ["~> 0.1.3"])
+    s.add_dependency(%q<cancan-rest-links>, ["~> 0.1.4"])
+    s.add_dependency(%q<cancan-permits>, ["~> 0.2.4"])
     s.add_dependency(%q<devise>, [">= 1.1.2"])
-    s.add_dependency(%q<cancan>, ["~> 1.3.4"])
+    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<logging_assist>, ["~> 0.1.3"])

data/lib/cream/configure/rails.rb

@@ -19,9 +19,12 @@ 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)
-    end
+    # 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

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

@@ -0,0 +1,57 @@
+require 'sugar-high/file'
+require 'sugar-high/module'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module CanCan
+  module Generators 
+    class ConfigGenerator < Rails::Generators::Base        
+      desc "Configure CanCan"
+
+      class_option :logfile, :type => :string,   :default => nil, :desc => "Logfile location" 
+
+      def cancan_configure
+      	logger.add_logfile :logfile => logfile if logfile        
+        cancan_gems 
+        cancan_exception_handling
+      end
+
+  	  protected
+
+      include Rails3::Assist::BasicLogger
+      extend Rails3::Assist::UseMacro
+
+      use_helpers :controller, :app      
+
+      def logfile
+        options[:logfile]
+      end
+
+      def cancan_gems
+        gem 'cancan'  
+        gem 'cancan-rest-links'
+      end
+
+      # CanCan access denied exception handling
+      def cancan_exception_handling
+        logger.debug "Rescue exists? #{rescue_exists?}"
+        return if rescue_exists?        
+  
+        logger.debug "Insert rescue into application controller"
+        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
+       
+      def rescue_exists? 
+        File.read(controller_file :application) =~ /rescue_from CanCan::AccessDenied/
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+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
+      extend Rails3::Assist::UseMacro
+        
+      desc "Configure Permits"
+
+      # 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_application
+        app_orm
+        app_routes
+        app_layout
+      end
+
+      protected
+
+      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/config_generator.rb

@@ -1,5 +1,5 @@
 require 'sugar-high/file'
-require 'sugar-high/modules'
+require 'sugar-high/module'
 require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
@@ -71,7 +71,7 @@ module Cream::Generators
     use_helpers :model, :controller, :permit, :application
 
     def configure_logger
-      logger.add_logfile :logfile => logfile
+      logger.add_logfile :logfile => logfile if logfile
       logger.debug 'main flow'
     end
 

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

@@ -23,7 +23,7 @@ require "rails/test_unit/railtie"
         # 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"'          
+          insert_into config_file(:routes), :after => 'do', :content => 'root :to => "welcome#index"'          
           execute "rails g controller Welcome index"
         end
       end

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

@@ -2,7 +2,7 @@ module Cream::Generators
   module Config
     module CanCan  
       def cancan_configure
-        configure_cancan_gems 
+        cancan_gems 
         cancan_exception_handling
       end
       

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

@@ -49,7 +49,7 @@ module Cream::Generators
         end  
 
         def devise_users?
-          has_user?(:user) && has_user?(:admin)
+          has_devise_user?(:user) && has_devise_user?(:admin)
         end
 
         def has_devise_user? user
@@ -57,7 +57,7 @@ module Cream::Generators
           begin
             read_model(user) =~ /devise/
           rescue Exception => e
-            logger.info "Exception for has_user? #{user}: #{e.message}"
+            logger.info "Exception for #has_devise_user? #{user}: #{e.message}"
             false
           end
         end
@@ -68,18 +68,23 @@ module Cream::Generators
         end
       end   
       
-      module Inherit
-        def self.remove_inheritance user
-          File.remove_from model_file user, :content => /<\s*ActiveRecord::Base/
-        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 self.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}"
+          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        
@@ -91,8 +96,8 @@ module Cream::Generators
               "devise #{*names}"
             end
           end
-          
-          def self.devise_default_strategies
+        
+          def devise_default_strategies
             [:database_authenticatable, :confirmable, :recoverable, :rememberable, :trackable, :validatable]
           end          
         end