cream 0.8.6 → 0.8.7

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

@@ -8,6 +8,7 @@ module Cream
         include Executor
         include Args
         include Strategy
+        include Gemfile
       end
     end
   end

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

@@ -1,10 +1,6 @@
 module Cream
   module GeneratorHelper
     module Executor
-      def add_gem name
-        gem name if !has_gem? name
-      end      
-       
       # rails generate ...
       def rgen command
         execute "rails g #{command}"

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

@@ -0,0 +1,28 @@
+module Cream
+  module GeneratorHelper
+    module Gemfile 
+      def add_gem_version name, version
+        if !has_gem? name
+          logger.debug "Adding gem: #{name}, #{version}"
+          gem name, :version => version
+        else
+          logger.debug "gem: #{name}, #{version} already in Gemfile"
+        end        
+      end
+
+      def add_gem name, version = nil
+        if version
+          add_gem_version name, version 
+          return 
+        end
+
+        if !has_gem? name
+          logger.debug "Adding gem: #{name}"
+          gem name
+        else
+          logger.debug "gem: #{name} already in Gemfile"          
+        end
+      end
+    end
+  end
+end

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

@@ -45,13 +45,17 @@ module Cream
         data_mapper.include? name
       end
 
+      def is_default_devise_orm?
+        [:active_record, :mongoid].include? orm
+      end
+
       def get_orm name
         return :active_record if is_active_record? name 
         return :mongo_mapper if is_mongo_mapper? name
         return :data_mapper if is_data_mapper? name
 
-        return :couch_db  if orm_name == :couch_db
-        return :mongoid   if orm_name == :mongoid
+        return :couch_db  if name == :couch_db
+        return :mongoid   if name == :mongoid
         
         raise ArgumentError, "ERROR: Cream does not currently support the orm: #{name}"
       end

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

@@ -18,6 +18,34 @@ module Cream
         @strategies << document_store_strategies if document_store?
         @strategies
       end
+
+      def role_ref_strategy?
+        role_ref_strategies.include? strategy
+      end
+
+      def embed_strategy?
+        role_embed_strategies.include? strategy
+      end
+
+      def document_store_strategy?
+        document_store_strategies.include? strategy
+      end
+
+      def inline_strategy?
+        document_store_strategies.include? strategy
+      end
+
+      def role_ref_strategies
+        [:one_role, :many_roles]
+      end
+
+      def role_embed_strategies
+        [:embed_one_role, :embed_many_roles]
+      end
+
+      def inline_strategies
+        valid_strategies - role_ref_strategies - role_embed_strategies
+      end
       
       def basic_strategies
         [:admin_flag, :role_string, :one_role, :many_roles, :roles_mask, :roles_string]

data/lib/generators/cream/views/haml_util.rb

@@ -24,11 +24,10 @@ module Cream
         require 'tmpdir'
         html_root = "#{self.class.source_root}/cream"
 
-        Dir.mktmpdir("cream-haml.") do |haml_root|
-          Dir["#{html_root}/**/*"].each do |path|
-            relative_path = path.sub(html_root, "")
+        Dir.mktmpdir("cream-haml.") do |haml_root|           
+          Dir["#{html_root}/**/*"].each do |path|  
+            relative_path = path.sub(html_root, "")            
             source_path   = (haml_root + relative_path).sub(/erb$/, "haml")
-
             if File.directory?(path)
               FileUtils.mkdir_p(source_path)
             else

data/lib/generators/cream/views/views_generator.rb

@@ -1,19 +1,19 @@
 require 'sugar-high/path'
-require 'generators/views/haml_util'
+require 'generators/cream/views/haml_util'
 
 module Cream
   module Generators
-    class ViewsGenerator < Rails::Generators::Base
+    class ViewsGenerator < ::Rails::Generators::Base
       desc "Copies all Cream views to your application."
-  
-      argument :scope, :required => false, :default => nil, :desc => "The scope to copy views to"
-  
-      class_option :haml, :type => :boolean, :default => "erb", :desc => "Use HAML"
-  
+      
+      argument      :scope, :required => false, :default => nil, :desc => "The scope to copy views to"
+      
+      class_option  :haml, :type => :boolean, :default => "erb", :desc => "Use HAML"
+      
       def self.source_root
-        @_devise_source_root ||= File.expand_path("app/views".up(4), __FILE__)
+        @_devise_source_root ||= File.expand_path("app/views".path.up(5), __FILE__)
       end
-
+          
       def copy_views
         if options[:haml]
           create_and_copy_haml_views
@@ -21,13 +21,13 @@ module Cream
           copy_erb_views
         end
       end
-  
+      
       protected
-
+    
       def copy_erb_views
-        directory "cream", "app/views/#{scope || 'devise'}"        
+        directory "cream", "app/views/#{scope || 'cream'}"        
       end
-  
+      
       include Cream::Generators::HamlUtil
     end
   end

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

@@ -29,7 +29,7 @@ module DeviseConfigGenerator
         return
       end
       
-      File.replace_content_from devise_initializer,  :where => orm_statement, :with => orm_replacement
+      replace_initializer_content :devise,  :where => orm_statement, :with => orm_replacement
     end
       
     def mailer_configure!

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

@@ -35,9 +35,7 @@ module Devise
       include Rails3::Assist::BasicLogger
       extend Rails3::Assist::UseMacro
 
-      include Cream::GeneratorHelper::Orm
-      include Cream::GeneratorHelper::Executor
-      include Cream::GeneratorHelper::Args
+      include Cream::GeneratorHelper
 
       use_helpers :controller, :app, :special, :file
 

data/lib/generators/devise/config/{gem_helper.rb → gem_config_helper.rb}

@@ -36,28 +36,5 @@ module DeviseConfigGenerator
       add_gem 'devise_couch'
       say "WARNING: Couch DB does not currently have a complete Roles implementation (admin_flag only). Please help implement the Roles strategy adapter.", :yellow
     end
-
-    def add_gem_version name, version
-      if !has_gem_version?(name, version)
-        logger.debug "Adding gem: #{name}, #{version}"
-        gem name, :version => version
-      else
-        logger.debug "gem: #{name}, #{version} already in Gemfile"
-      end        
-    end
-
-    def add_gem name, version = nil
-      if version
-        add_gem_version name, version 
-        return 
-      end
-  
-      if !has_gem? name
-        logger.debug "Adding gem: #{name}"
-        gem name
-      else
-        logger.debug "gem: #{name} already in Gemfile"          
-      end
-    end
   end
 end

data/lib/generators/devise/customize/customize_generator.rb

@@ -0,0 +1,49 @@
+require 'sugar-high/file'
+require 'sugar-high/module'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+require 'generators/cream/helpers/all'
+
+require_all File.dirname(__FILE__) # + '/helpers'
+
+module Devise
+  module Generators 
+    class CustomizeGenerator < ::Rails::Generators::Base
+      desc "Customize Devise"
+
+      argument :user_class,  :type => :string,   :default => 'User',      :desc => "User class name"
+
+      # 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 :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')"
+      
+      def main_flow
+      	logger.add_logfile :logfile => logfile if logfile
+      	logger.debug 'customizing devise...'
+
+        Devise::Customizers::UserName.new(orm, user_class, login_attribute).add_to_user_class if add_user_name?    
+      end
+
+      protected
+
+      include Cream::GeneratorHelper
+      include Rails3::Assist::BasicLogger
+            
+      def login_attribute
+        att = options[:login_attribute] || 'generic'
+        return 'login' if att.to_sym == :generic
+        return att if [:username, :email].include? att.to_sym
+        raise ArgumentError, "Unknown login attribute strategy #{att}"
+      end
+      
+      def add_user_name?
+        options[:user_name] && is_default_devise_orm?
+      end
+    end
+  end
+end
+      

data/lib/generators/devise/customize/customize_messages.rb

@@ -0,0 +1,52 @@
+require "colorize"
+
+module Devise
+  module CustomizeMessage    
+    class << self
+      def say msg, options = nil
+        options = case options
+        when Symbol
+          {:color => options}
+        when Hash
+          option          
+        end
+        puts msg.colorize(options) if options
+        puts msg if !options          
+      end
+      
+      def retrieve_password        
+          say %q{Currently Cream only supports a username/password retrieval strategy for :active_record and :mongoid
+Please help add a strategy for your ORM of choice by adding a FindRecord.#[orm] method to the Cream 'app_generator.rb' file. Thanks!
+See: https://github.com/plataformatec/devise/wiki/How-To:-Allow-users-to-sign_in-using-their-username-or-email-address for how to do it!}, :yellow
+      end
+      
+      def find_record  
+            say %Q{Currently Cream only supports generic login strategy for :active_record and :mongoid.
+  Please help add a strategy for your ORM of choice by adding a FindRecord#[name of your orm] method to the Cream 'app_generator.rb' file.
+
+  How: Add a self#[orm]_find_record method in your User class, make it work, then submit it as a patch to Cream. It should be very simple :)
+
+  The example for mongoid:
+    ...
+    module FindRecord
+      def self.mongoid 
+        #{FindRecord.mongoid}
+      end
+    end
+
+  See: https://github.com/plataformatec/devise/wiki/How-To:-Allow-users-to-sign_in-using-their-username-or-email-address for how to do it!}, :yellow  
+      end
+      
+      def locales_update
+        say %q{
+Modify config/locales/en.yml to contain something like:
+
+activemodel:
+  attributes:
+    user:
+      login: "Username or email"
+  }, :green
+      end
+    end
+  end
+end

data/lib/generators/devise/customize/helpers/query_customizers.rb

@@ -0,0 +1,43 @@
+module Devise
+  module QueryCustomizers
+    module FindRecord
+      class << self
+        def active_record
+          %q{where(attributes).where(["username = :value OR email = :value", { :value => login }]).first}
+        end
+
+        def mongoid
+          %q{where("function() {return this.username == '#{login}' || this.email == '#{login}'}").first}
+        end  
+
+        def mongo_mapper
+          %q{where("function() {return this.username == '#{login}' || this.email == '#{login}'}").first}
+        end  
+      end
+    end 
+    
+    module UserAuth
+      class << self
+        def active_record
+          %q{
+  # protected
+
+  def self.find_for_database_authentication(conditions)
+    login = conditions.delete(:login)
+    where(conditions).where(["username = :value OR email = :value", { :value => login }]).first
+  end
+}
+        end
+
+        def mongoid
+        %q{
+  def self.find_for_database_authentication(conditions)
+    login = conditions.delete(:login)
+    self.any_of({ :username => value }, { :email => login }).first
+  end
+}
+        end
+      end
+    end    
+  end
+end

data/lib/generators/devise/customize/helpers/recover_login.rb

@@ -0,0 +1,80 @@
+require 'generators/cream/helpers/all'
+
+module Devise
+  module Customizers
+    class RecoverLogin
+      include Cream::GeneratorHelper        
+      extend Rails3::Assist::UseMacro
+      use_helpers :app, :special, :file, :model
+      # include Devise::UserCustomization      
+
+      attr_accessor :orm
+  
+      def initialize orm
+        @orm = orm
+      end
+            
+      def retrieve_password
+        reset_password_instructions << find_recoverable_code
+      end
+    
+      # should not be ORM dependent
+      def reset_password_instructions
+        %q{
+  # Attempt to find a user by it's email. If a record is found, send new
+  # password instructions to it. If not user is found, returns a new user
+  # with an email not found error.
+  def self.send_reset_password_instructions(attributes={})
+    recoverable = find_recoverable_or_initialize_with_errors(reset_password_keys, attributes, :not_found)
+    recoverable.send_reset_password_instructions if recoverable.persisted?
+    recoverable
+  end
+  }
+      end
+
+      def find_recoverable_code
+        %Q{
+  def self.find_recoverable_or_initialize_with_errors(required_attributes, attributes, error=:invalid)
+    case_insensitive_keys.each { |k| attributes[k].try(:downcase!) }
+
+    attributes = attributes.slice(*required_attributes)
+    attributes.delete_if { |key, value| value.blank? }
+
+    if attributes.size == required_attributes.size
+     if attributes.has_key?(:login)
+        login = attributes.delete(:login)
+        record = find_record(login)
+     else  
+       record = where(attributes).first
+     end  
+    end  
+    user_record_not_found(required_attributes) unless record
+    record
+  end
+
+  #{user_record_not_found}
+
+  def self.find_record login
+    #{Devise::QueryCustomizers::FindRecord.send orm}
+  end
+  }
+      end
+
+      def user_record_not_found
+        %q{
+  # handle when the user record is not found
+  # adds error messages to the record
+  def self.user_record_not_found(required_attributes)
+    record = new
+
+    required_attributes.each do |key|
+    value = attributes[key]
+    record.send("#{key}=", value)
+    record.errors.add(key, value.present? ? error : :blank)
+    end  
+  end  
+  }
+      end
+    end
+  end
+end