cream 0.8.9.1 → 0.8.9.2

data/README.textile

@@ -76,7 +76,13 @@ Example idea:
 
 This way, any editor user created will always be given the :editor role on creation and he can later add the :publisher and/or :blog_editor roles, depending on whether Cream is set up as a single or multi role system. In the future, the framework might even allow some user types to have multiple roles and others to have only a single role (here indicated by the _roles_config :multi_ statement) ? What do you think?
 
-*Ideas and suggestions are most welcome!*
+*Ideas and suggestions are most welcome!* 
+
+h3. The path towards 1.0
+
+I will continue the 0.8.9.x line only with bug fixes and other minor fixes or additions.
+
+The 0.9 line will likely be a total redesign/refactoring using what I am learning from reading _Jose Valim's_ book *Crafting Rails Applications*. I will create a new project using _enginex_, complete with one or more dummy apllications and take it from there.
 
 h2. Cream edge, debugging and assisting developing the framework
 

data/VERSION

@@ -1 +1 @@
-0.8.9.1
+0.8.9.2

data/cream.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cream}
-  s.version = "0.8.9.1"
+  s.version = "0.8.9.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2011-01-15}
+  s.date = %q{2011-01-18}
   s.description = %q{An integrated Authentication, Authorization and Roles solution for your Rails 3 app with support for multiple ORMs}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -40,9 +40,10 @@ Gem::Specification.new do |s|
     "init.rb",
     "lib/cream.rb",
     "lib/cream/configure/after_init/role_config.rb",
+    "lib/cream/configure/engine.rb",
     "lib/cream/configure/rails.rb",
     "lib/cream/controller/ability.rb",
-    "lib/cream/controller/application_controller.rb",
+    "lib/cream/controller/user_control.rb",
     "lib/cream/helper/host.rb",
     "lib/cream/helper/role.rb",
     "lib/cream/namespaces.rb",

data/lib/cream/configure/engine.rb

@@ -0,0 +1,22 @@
+# Not yet used! Should use it?
+
+module Cream
+  # Include helpers in the given scope to AC and AV.
+  # "Borrowed" from devise
+  def self.include_helpers(scope)
+    ActiveSupport.on_load(:action_controller) do
+      include scope::Helpers
+      include scope::UrlHelpers
+    end
+
+    ActiveSupport.on_load(:action_view) do
+      include scope::UrlHelpers
+    end
+  end
+
+  class Engine < ::Rails::Engine
+    initializer "cream.helpers" do
+      Cream.include_helpers(Cream::Controllers)
+    end    
+  end
+end

data/lib/cream/configure/rails.rb

@@ -9,7 +9,7 @@ Rails3::Plugin::Extender.new do
   extend_rails :controller do
     extend_from_module Cream, :role
     extend_from_module Cream::Controller, :ability
-    extend_from_module Cream::Helper, :role, :host
+    extend_from_module Cream::Helper, :role, :host 
   end  
 
   # extend action_view with methods from some modules
@@ -20,10 +20,13 @@ Rails3::Plugin::Extender.new do
   
   after :initialize do    
     load File.dirname(__FILE__) + '/after_init/role_config.rb'
-    # 
-    # extend_rails :view do
-    #   extend_from_module Cream::View, :role
-    #   extend_from_module Cream::Helper, :role
-    # end
+
+    if defined? Cream::UserControl
+      # puts "Extending ApplicationController with UserControl"
+      ApplicationController.class_eval "include Cream::UserControl"
+    else
+      puts "Cream::UserControl not defined!"
+    end
   end
 end
+

data/lib/cream/controller/user_control.rb

@@ -0,0 +1,79 @@
+module Cream
+  module UserControl
+
+    def current_user   
+      # puts "current_user"
+      if !session[:user_id]
+        # puts "make guest"        
+        @guest ||= Guest.create(guest_options) 
+        # puts "guest: #{@guest}"
+        return @guest
+      end
+      if session[:user_id]  
+        begin
+          clazz = session[:user_class_name].constantize
+          @current_user ||= clazz.find session[:user_id] 
+          # puts "logged in user: #{@current_user}"
+          return @current_user
+        rescue Exception => e
+          puts "Error with current_user: user_class_name = '#{session[:user_class_name]}' error: #{e}"
+        end
+      end
+    end
+
+    def set_language language_code
+     current_user.language_code = language_code if current_user # for non-guest user
+     guest_options[:language_code] = language_code # for guest user
+    end    
+
+    def guest_options
+     session[:guest_options] ||= {}
+    end
+
+    def user_signed_in?
+      current_user && !current_user.has_role?(:guest)
+    end
+
+    def user_session
+      user_signed_in? ? super : session
+    end
+    
+    # Sign in an user that already was authenticated. This helper is useful for logging
+    # users in after sign up.
+    #
+    # Examples:
+    #
+    #   sign_in :user, @user                      # sign_in(scope, resource)
+    #   sign_in @user                             # sign_in(resource)
+    #   sign_in @user, :event => :authentication  # sign_in(resource, options)
+    #
+    def sign_in(resource_or_scope, *args)
+      options  = args.extract_options!
+      scope    = Devise::Mapping.find_scope!(resource_or_scope)
+      resource = args.last || resource_or_scope
+      expire_session_data_after_sign_in!
+      warden.set_user(resource, options.merge!(:scope => scope))
+      # set user id
+      session[:user_id] = resource.id
+      session[:user_class_name] = resource.class.name
+    end
+
+    # Sign out a given user or scope. This helper is useful for signing out an user
+    # after deleting accounts.
+    #
+    # Examples:
+    #
+    #   sign_out :user     # sign_out(scope)
+    #   sign_out @user     # sign_out(resource)
+    #
+    def sign_out(resource_or_scope)
+      scope = Devise::Mapping.find_scope!(resource_or_scope)
+      warden.user(scope) # Without loading user here, before_logout hook is not called
+      warden.raw_session.inspect # Without this inspect here. The session does not clear.
+      warden.logout(scope)
+      # user id
+      session[:user_id] = nil
+      @current_user = nil      
+    end        
+  end
+end

data/lib/cream/rails/config.rb

@@ -1,10 +1,11 @@
 module Cream
   module Rails
     class Config      
-      attr_accessor :roles
+      attr_accessor :roles, :user_types
       
       def initialize options = {}
         self.roles ||= options[:roles] 
+        self.user_types ||= options[:user_types] 
       end
     end
   end

data/lib/cream/role.rb

@@ -1,6 +1,16 @@
 module Cream
   class << self
-    attr_accessor :available_roles  
+    attr_accessor :available_roles
+    attr_accessor :available_user_types
+  end
+
+  module UserTypes
+    def self.available
+      return Cream.available_user_types if Cream.available_user_types.present?
+      return Cream.user_types if Cream.user_types.present?
+      puts "Cream has not been configured with any devise User Types"
+      []
+    end
   end
   
   module Role

data/lib/cream/roles_config.rb

@@ -1,6 +1,7 @@
 module Cream
-  mattr_accessor :roles
+  mattr_accessor :roles, :user_types
   @@roles = []
+  @@user_types = []
     
   def self.setup
     yield self

data/lib/cream/view/host_area.rb

@@ -4,9 +4,18 @@ module Cream::View
       yield block if localhost?
     end  
 
+    def not_for_localhost(&block)
+      yield block if !localhost?
+    end  
+
     def for_public(&block)
       # with_output_buffer(&block) if publichost?
       yield block if publichost?
     end  
+
+    def not_for_public(&block)
+      # with_output_buffer(&block) if publichost?
+      yield block if !publichost?
+    end  
   end
 end

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

@@ -75,14 +75,21 @@ require "rails/test_unit/railtie"
         remove_model :guest if has_model?(:guest)
         create_model :guest do
           %Q{ 
-  # modify this as needed for now!
-  # attr_accessor :login, :username, :email
-  # attr_accessor :password            
-  # 
-  # attr_accessible :login
+  # modify this as needed (for any forms using current_user)
+  # attr_accessor :login, :password 
+  # attr_accessor :username, :email
+  # attr_accessor :country, :country_code, :language, :language_code, :city
             
-  def self.create
-    Guest.new
+  def self.create options = {}    
+    Guest.new options.merge(session[:guest_options] || {})
+  end
+
+  def save
+    false
+  end 
+  
+  def save!
+    false
   end
 
   def is? role
@@ -104,12 +111,6 @@ require "rails/test_unit/railtie"
         end
         say "A Guest user model has been created. Users that have not signed in will get an instance of this class as the current_user."
       end
-
-      protected
-      
-      def guest_user?
-        options[:gust_user]
-      end      
     end
   end
 end

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

@@ -15,30 +15,33 @@ module Cream
       class_option  :strategy,      :type => :string,   :default => 'role_string',    :desc => "Role strategy to use"
 
       # Create Admin user
-      class_option :user_class,       :type => :string,   :default => 'User',           :desc => "User class"
-      class_option :admin_class,      :type => :string,   :default => nil,              :desc => "Admin user class"
-      class_option :role_class,       :type => :string,   :default => 'Role',           :desc => "Role class"
-      class_option :user_role_class,  :type => :string,   :default => 'UserRole',       :desc => "UserRole class"
+      class_option :user_class,       :type => :string,   :default => 'User',           :desc => "User class", :aliases => '-u'
+      class_option :role_class,       :type => :string,   :default => 'Role',           :desc => "Role class", :aliases => '-rc'
+      class_option :user_role_class,  :type => :string,   :default => 'UserRole',       :desc => "UserRole class", :aliases => '-urc'
+
+      class_option :guest_user,       :type => :boolean,  :default => true,             :desc => "Create guest user", :aliases => '-guest'
 
       # 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"
+      class_option :default_roles,  :type => :boolean,  :default => true,             :desc => "Create default roles :admin and :guest", :aliases => '-dr'
+      class_option :roles,          :type => :array,    :default => [],               :desc => "Roles to create", :aliases => '-r'
+
+      class_option :user_types,     :type => :array,    :default => ['Admin'],        :desc => "Devise Users to create that override the generic base User", :aliases => '-ut'
 
       # ORM to use
-      class_option :orm,            :type => :string,   :default => 'active_record',  :desc => "ORM to use"
+      class_option :orm,            :type => :string,   :default => 'active_record',  :desc => "ORM to use", :aliases => '-o'
 
-      class_option :locales,        :type => :array,    :default => ['all'],          :desc => "List of locales - 'all' means ALL locales"
-      class_option :logfile,        :type => :string,   :default => nil,              :desc => "Logfile location"
+      class_option :locales,        :type => :array,    :default => ['all'],          :desc => "List of locales - 'all' means ALL locales", :aliases => '-l'
+      class_option :logfile,        :type => :string,   :default => nil,              :desc => "Logfile location", :aliases => '-lf'
 
-      class_option :configure,      :type => :array,    :default => [],               :desc => "Finetune which generators to run: app, permits, roles, devise, cancan"
-      class_option :gems,           :type => :boolean,  :default => true,             :desc => "Add gems to gemfile?"       
-      class_option :migrations,     :type => :boolean,  :default => false,            :desc => "Autorun database migrations?", :aliases => '-m'
+      class_option :configure,      :type => :array,    :default => [],               :desc => "Finetune which generators to run: app, permits, roles, devise, cancan", :aliases => '-c'
+      class_option :gems,           :type => :boolean,  :default => true,             :desc => "Add gems to gemfile?", :aliases => '-g'
+      class_option :migrations,     :type => :boolean,  :default => false,            :desc => "Auto-run database migrations?", :aliases => '-m'
 
       # Devise customize
-      class_option :customize,   :type => :array,    :default => [],          :desc => "Which elements of devise to customize (customize generator)"      
+      class_option :customize,   :type => :array,    :default => [],          :desc => "Which elements of devise to customize (customize generator)", :aliases => '-cust'
       
-      class_option :user_name,   :type => :boolean,  :default => true,        :desc => "Add username as login option"
-      class_option :login_type,  :type => :string,   :default => 'generic',   :desc => "How to login: 'email', 'username', 'generic' (i.e 'username' or 'email')"
+      class_option :user_name,   :type => :boolean,  :default => true,        :desc => "Add username as login option", :aliases => '-un'
+      class_option :login_type,  :type => :string,   :default => 'generic',   :desc => "How to login: 'email', 'username', 'generic' (i.e 'username' or 'email')", :aliases => '-lt'
 
       def main 
         execute_generator if validate_orm && validate_strategy
@@ -88,12 +91,12 @@ module Cream
       end
 
       def run_app
-        rgen "cream:app --orm #{orm}"
+        rgen "cream:app --orm #{orm} #{guest_user_option}"
       end
 
       def run_devise
-        rgen "devise:config #{user_class} --orm #{orm} #{admin_user_option}"
-        rgen "devise:users --orm #{orm} --roles #{roles_list} #{admin_user_option} --no-gems"
+        rgen "devise:config #{user_class} --orm #{orm}" # --user-types #{user_types}
+        rgen "devise:users --orm #{orm} --roles #{roles_list} --user-types #{user_types_list} --no-gems"
 
         say("Devise credentials not customized since --customize option was not used to say so!", :green) if !customize_credentials?
 
@@ -113,9 +116,10 @@ module Cream
       end
       
       def cream_initializer
-        create_initializer :cream do         
+        create_initializer :cream do
   %Q{Cream.setup do |config|
   config.roles = #{sym_roles.inspect} 
+  config.user_types = #{user_types_code}
 end
 
 require 'cream/configure/rails'
@@ -123,6 +127,10 @@ require 'cream/configure/rails'
         end
       end
 
+      def guest_user_option
+        "--guest-user" if guest_user?
+      end
+
       def customize_credentials?
         customize.include? 'credentials'
       end

data/lib/generators/cream/helpers/args_helper.rb

@@ -50,6 +50,10 @@ module Cream
         options[:strategy]
       end        
 
+      def user_types
+        options[:user_types]
+      end        
+
       def admin_user?
         options[:admin_user]
       end
@@ -58,6 +62,18 @@ module Cream
         roles.map(&:to_sym)
       end
 
+      def guest_user?
+        options[:guest_user]
+      end
+
+      def user_types_code
+        user_types.map {|ut| "'#{ut}'"}.join(', ')
+      end
+
+      def user_types_list
+        user_types.map {|ut| "#{ut}"}.join(' ')
+      end
+
       def user_class
         options[:user_class] || 'User'
       end

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

@@ -19,7 +19,6 @@ module Devise
       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 => true,              :desc => "Add gems to gemfile?"
-      class_option :admin_user,   :type => :boolean,  :default => false,             :desc => "Setup for admin user"
 
       def configure_devise
       	logger.add_logfile :logfile => logfile if logfile	        

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

@@ -21,10 +21,12 @@ module Devise
       # ORM to use
       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 :default_roles,  :type => :boolean,  :default => true,             :desc => "Create default roles :admin and :guest"
+
+      class_option :user_types,     :type => :array,    :default => ['admin'],        :desc => "Devise Users to create that override the generic base User", :aliases => '-ut'
 
       class_option :logfile,        :type => :string,   :default => nil,              :desc => "Logfile location" 
-      class_option :gems,           :type => :boolean,  :default => false,            :desc => "Add gems to gemfile?"       
+      class_option :gems,           :type => :boolean,  :default => false,            :desc => "Add gems to gemfile?"
       
       def configure_devise_users      
       	logger.add_logfile :logfile => logfile if logfile
@@ -40,12 +42,9 @@ module Devise
         # # if User model is NOT configured with devise strategy
         insert_devise_strategy user_class, :defaults if !has_devise_user? user_class
       
-        # 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
+        user_types.flatten.each do |user_type|
+          create_user(user_type) if !has_model?(user_type.as_filename)
         end
         
         routes_configure!
@@ -68,7 +67,7 @@ module Devise
       def create_user name
         return if name.to_sym == :guest
 
-        logger.debug "create_user: #{name}"
+        logger.debug "create devise user: #{name}"
         create_user_model name
         # remove any current inheritance
         remove_inheritance name
@@ -104,16 +103,11 @@ module Devise
         create_devise_model user_class
       end
 
-      def devise_admin_user
-        # if app does NOT have a Admin model
-        create_user(admin_class) if !has_admin_model?
-      end
-
       private
 
       def customize_note
         %q{
-Customize controller action if needed to render individual registration form for each role
+Customize controller action if needed to render an individual registration form for each devise User type
 
 Example:
 

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 8
   - 9
-  - 1
-  version: 0.8.9.1
+  - 2
+  version: 0.8.9.2
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-15 00:00:00 +01:00
+date: 2011-01-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -501,9 +501,10 @@ files:
 - init.rb
 - lib/cream.rb
 - lib/cream/configure/after_init/role_config.rb
+- lib/cream/configure/engine.rb
 - lib/cream/configure/rails.rb
 - lib/cream/controller/ability.rb
-- lib/cream/controller/application_controller.rb
+- lib/cream/controller/user_control.rb
 - lib/cream/helper/host.rb
 - lib/cream/helper/role.rb
 - lib/cream/namespaces.rb

data/lib/cream/controller/application_controller.rb

@@ -1,22 +0,0 @@
-class ApplicationController < ActionController::Base
-
-  def current_user
-    if defined? Cream::Role
-      # Try to get instance of any of the available roles as the current user
-      Cream::Role.available.each do |role|
-        method = :"current_#{role}"
-        @cu ||= send method if respond_to?(method)
-      end
-    end    
-    return @cu if @cu
-    session[:guest] ||= Guest.create if defined?(Guest)
-  end
-
-  def user_signed_in?
-    current_user && !current_user.has_role?(:guest)
-  end
-
-  def user_session
-    user_signed_in? ? super : session
-  end    
-end