cream 0.8.6 → 0.8.7

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

@@ -0,0 +1,149 @@
+require 'generators/cream/helpers/all'
+
+module Devise
+  module Customizers
+    class UserName 
+      include Cream::GeneratorHelper        
+      extend Rails3::Assist::UseMacro
+      include Rails3::Assist::BasicLogger      
+      use_helpers :app, :special, :file, :model
+
+      attr_accessor :orm, :user_class, :login_attribute
+  
+      def initialize orm, user_class, login_attribute
+        @orm = orm
+        @user_class = user_class          
+        @login_attribute = login_attribute
+      end
+
+      def add_to_user_class
+        logger.debug 'add_to_user_class'
+        if active_record? && !has_migration_file?(:add_username_to_users)
+          logger.debug 'create migration: add_username_to_users'
+          %x[rails g migration add_username_to_users username:string]
+          %x[rake db:migrate]        
+        end
+
+        make_attribute_accessible                
+        
+        AuthenticationKeys.new(user_class, login_attribute).modify_initializer 
+
+        if login_attribute == 'login'
+          configure_generic_login
+          ::Devise::CustomizeMessage.locales_update
+        end
+      end
+
+      def make_attribute_accessible
+        return if user_class_content? 'attr_accessible :username'
+
+        ::File.insert_into model_file(user_class), :before_last => 'end' do
+          %q{
+  # accessor config
+  attr_accessible :username}
+        end
+      end
+
+      def add_virtual_login_accessor          
+        return if user_class_content? 'attr_accessor :login' 
+        
+        ::File.insert_into model_file(user_class), :before_last => 'end' do
+          %q{
+  attr_accessor :login}
+        end
+      end
+
+      def configure_generic_login
+        logger.debug 'configure generic login'
+        add_virtual_login_accessor        
+        override_user_auth        
+        modify_retrieve_password
+      end
+
+      def override_user_auth
+        if !is_default_devise_orm?
+          Devise::CustomizeMessage.find_record
+          return
+        end         
+
+        return if user_class_content? '# self.find_for_database_authentication'
+                
+        ::File.insert_into model_file(user_class), :before_last => 'end' do
+          ::Devise::QueryCustomizers::UserAuth.send orm
+        end
+      end
+
+      def modify_retrieve_password
+        if !is_default_devise_orm?
+          ::Devise::CustomizeMessage.retrieve_password
+          return
+        end
+        insert_reset_password_keys_stmt # in devise initializer
+
+        return if user_class_content? '# recover login'
+        
+        content = recover_login_header << ::Devise::Customizers::RecoverLogin.new(orm).retrieve_password
+
+        ::File.insert_into model_file(user_class), :before_last => 'end' do
+          content
+        end        
+      end
+      
+      def insert_reset_password_keys_stmt
+        return if devise_init_content? '# reset_password_keys = [ :login ]'        
+        ::File.insert_into initializer_file(:devise), 'config.reset_password_keys = [ :login ]', :after => 'Rails::Application'
+      end        
+
+      protected
+
+      def user_class_content? content
+        read_model(user_class) =~ content.to_regexp
+      end
+
+      def devise_init_content? content
+        read_initializer(:devise) =~ content.to_regexp
+      end
+
+      def recover_login_header
+        %q{
+  protected
+
+  # recover login
+}
+      end
+
+      class AuthenticationKeys
+        include Cream::GeneratorHelper
+        extend Rails3::Assist::UseMacro
+        include Rails3::Assist::BasicLogger
+        use_helpers :app, :special, :file
+
+        attr_accessor :login_attribute
+
+        def initialize user_class, login_attribute
+          @user_class = user_class          
+          @login_attribute = login_attribute
+        end
+
+        def modify_initializer
+          logger.debug 'modify devise initializer'
+          return if devise_init_content? keys_stmt_replacement(login_attribute)
+        
+          replace_initializer_content :devise,  :where => default_keys_stmt, :with => keys_stmt_replacement(login_attribute)
+        end
+
+        def devise_init_content? content
+          read_initializer(:devise) =~ content.to_regexp
+        end
+
+        def keys_stmt_replacement name
+          "config.authentication_keys = [ :#{name} ]"
+        end
+
+        def default_keys_stmt
+          /# config.authentication_keys = [\s*:email\s*]/
+        end
+      end
+    end
+  end
+end

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

@@ -56,9 +56,7 @@ module Devise
       extend Rails3::Assist::UseMacro
       include Rails3::Assist::BasicLogger  
 
-      include Cream::GeneratorHelper::Orm
-      include Cream::GeneratorHelper::Executor
-      include Cream::GeneratorHelper::Args 
+      include Cream::GeneratorHelper
       
       include DeviseUserGenerator::Helper
       include DeviseUserGenerator::RoutesHelper

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

@@ -33,9 +33,7 @@ module Permits
       
       include Rails3::Assist::BasicLogger
 
-      include Cream::GeneratorHelper::Orm
-      include Cream::GeneratorHelper::Executor
-      include Cream::GeneratorHelper::Args
+      include Cream::GeneratorHelper
       
       def permits_gems
         gem 'cancan-permits'

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

@@ -10,10 +10,16 @@ module Roles
     class ConfigGenerator < Rails::Generators::Base        
       desc "Configure Roles"
 
+      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 :strategy,           :type => :string,   :default => 'role_string',      :desc => "Roles strategy to use"
       class_option :roles,              :type => :array,    :default => ['guest', 'admin'], :desc => "Valid roles to use"
+
+      class_option :role_class,         :type => :string, :aliases => "-rc",  :default => 'Role',     :desc => "Role class name", :optional => true
+      class_option :user_role_class,    :type => :string, :aliases => "-urc", :default => 'UserRole', :desc => "User-Role (join table) class name", :optional => true
+
       class_option :logfile,            :type => :string,   :default => nil,                :desc => "Logfile location" 
       class_option :default_roles,      :type => :boolean,  :default => true,               :desc => "Create default roles :admin and :guest"
       class_option :gems,               :type => :boolean,  :default => true,               :desc => "Add gems to gemfile?"       
@@ -38,9 +44,7 @@ module Roles
       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 :model, :file
 
@@ -51,7 +55,7 @@ module Roles
       end 
 
       def create_roles
-        rgen "#{roles_generator} User --strategy #{strategy} --roles #{roles_list} #{default_roles_option}"        
+        rgen "#{roles_generator} #{user_class} --strategy #{strategy} --roles #{roles_list} #{default_roles_option} #{class_options}"        
       end
 
       def set_valid_roles_cream
@@ -72,6 +76,24 @@ module Roles
 
       private
 
+      def class_options
+        option_str = ""                            
+        if role_ref_strategy?
+          option_str << " --role-class #{role_class}" 
+          option_str << " --user-role-class #{user_role_class}" if relational_mapper?
+        end
+        option_str
+      end
+
+      def role_class
+        options[:role_class] || 'Role'
+      end
+
+      def user_role_class
+        options[:user_role_class] || 'UserRole'
+      end
+
+
       def user_exist_check
         raise "ERROR: User model missing. Please create a User model before running this generator" if !has_user_model?
       end

data/sandbox/any_user.rb

@@ -0,0 +1,98 @@
+class Stuff
+  def for_any_user options = nil, &block
+    yield if Labels.state_check Labels.extract(options), current_user
+  end
+
+  def not_for_any_user options = nil, &block
+    return if Labels.state_check Labels.extract(options), current_user
+    yield 
+  end
+
+  def is? role
+    role == :guest
+  end
+  
+  def current_user
+    Stuff.new
+  end   
+  
+  private
+
+  module Labels    
+    class << self
+      def extract options
+        case options
+        when Symbol
+          return :logged_in if logged_in_labels.include?(options)
+          return :logged_out if logged_out_labels.include?(options)
+        when Hash
+          return :logged_in if logged_in_labels.any? {|lab| options[lab] }
+          return :logged_out if logged_out_labels.any? {|lab| options[lab] }    
+        end    
+        raise ArgumentException, "Unknown option #{options}"
+      end
+
+      def state_check state, current_user
+        logged_in_check(state, current_user) || logged_out_check(state, current_user)
+      end
+
+      def logged_in_check state, current_user
+        state == :logged_in && is_not_guest?(current_user)
+      end
+
+      def logged_out_check state, current_user
+        state == :logged_out && is_guest?(current_user)
+      end
+      
+      def is_not_guest? current_user
+        !current_user || (current_user && !current_user.is?(:guest))
+      end
+
+      def is_guest? current_user
+        current_user && current_user.is?(:guest)
+      end
+
+      def logged_in_labels
+        [:logged_in, :signed_in, :not_logged_out, :not_signed_out]
+      end
+
+      def logged_out_labels
+        [:logged_out, :signed_out, :not_logged_in, :not_signed_in]
+      end  
+    end
+  end
+end  
+
+s = Stuff.new
+
+s.for_any_user :logged_in do
+  puts "log out - for_any_user :logged_in"
+end
+
+s.for_any_user :logged_out do
+  puts "log in - for_any_user :logged_out"
+end
+
+s.for_any_user :not_logged_in do
+  puts "log in - for_any_user :not_logged_in"
+end
+
+s.for_any_user :not_logged_out do
+  puts "log out - for_any_user :not_logged_out"
+end
+
+s.not_for_any_user :logged_in do
+  puts "log in - not_for_any_user :logged_in"
+end
+
+s.not_for_any_user :logged_out do
+  puts "log out - not_for_any_user :logged_out"
+end
+
+s.not_for_any_user :not_logged_in do
+  puts "log out - not_for_any_user :not_logged_in"
+end
+
+s.not_for_any_user :not_logged_out do
+  puts "log in - not_for_any_user :not_logged_out"
+end

data/sandbox/str_test.rb

@@ -0,0 +1,50 @@
+# HAS BEEN MOVED TO SUGAR-HIGH :)
+
+s = %q{
+class Abc
+  def begin
+
+  end
+end}
+
+class String
+  def insert_before_last str, marker = 'end'
+    res = []
+    found = false
+    marker = case marker
+    when Symbol, String
+      marker.to_s
+    when Hash
+      marker[:marker].to_s
+    else
+      raise ArgumentException, "last argument is the marker and must be a String, Symbol or even Hash with a :marker option pointing to the marker (String or Symbol)"
+    end      
+    
+    marker = Regexp.escape(marker.reverse)
+    nl = Regexp.escape("\n")
+    # puts self
+    # puts "marker: #{marker}"
+    # puts "nl: #{nl}"    
+    # puts "str: #{str}"    
+    
+    self.reverse.each_line do |x|
+      x.gsub! /#{nl}/, ''  
+      if !found && x =~ /#{marker}/
+        replace = "#{str}\n" << x.reverse
+        res << replace
+        found = true
+      else
+        res << x.reverse
+      end
+    end    
+    res.reverse
+  end
+end
+
+# puts s.insert_before_last '  # hello'
+# puts s.insert_before_last '  # hello', :marker => 'end'
+puts s.insert_before_last '  # hello', :marker => :end
+
+# s = s.strip.gsub(/(end$)/z, "#last\n\\1")
+# 
+# puts s

data/spec/cream/configure/rails_role_spec.rb

@@ -29,7 +29,7 @@ describe "Rails extension" do
       after_init :controller do
         :controller.should be_extended_with Cream, :role
         :controller.should be_extended_with Cream::Controller, :ability
-        :controller.should be_extended_with Cream::Helper, :role, :host
+        :controller.should be_extended_with Cream::Helper, :role, :host        
       end            
       
       init_app_railties :minimal, :view

data/spec/cream/helper/role_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'cream/helper/role'
+require 'cream/configure/rails'
 
 describe Cream::Helper::Role do
   
@@ -8,27 +9,27 @@ describe Cream::Helper::Role do
   context 'method auto-generated when Rails initialize based on registered roles' do
     describe '#guest_area' do              
 
-      # it "should execute an Admin guarded block for :admin" do        
-      #   view_engine do |e, view|
-      #     view.stubs(:has_role?).with([:admin]).returns true
-      # 
-      #     res = e.run_template do 
-      #       %{<%= for_admin { 'hello' } %>}
-      #     end        
-      #     res.should match /hello/
-      #   end
-      # end
-      #   
-      # it "should not execute an Admin guarded block for user not :admin" do        
-      #   view_engine do |e, view|
-      #     view.stubs(:has_role?).with([:admin]).returns false
-      # 
-      #     res = e.run_template do 
-      #       %{<%= for_admin { 'hello' } %>}
-      #     end        
-      #     res.should be_empty
-      #   end
-      # end
+      it "should execute an Admin guarded block for :admin" do        
+        view_engine do |e, view|
+          view.stubs(:has_role?).with([:admin]).returns true
+      
+          res = e.run_template do 
+            %{<%= for_admin { 'hello' } %>}
+          end        
+          res.should match /hello/
+        end
+      end
+        
+      it "should not execute an Admin guarded block for user not :admin" do        
+        view_engine do |e, view|
+          view.stubs(:has_role?).with([:admin]).returns false
+      
+          res = e.run_template do 
+            %{<%= for_admin { 'hello' } %>}
+          end        
+          res.should be_empty
+        end
+      end
     end # desc
   end # context
 
@@ -56,6 +57,31 @@ describe Cream::Helper::Role do
         end
       end
     end # desc  
+
+    describe '#for_role' do                    
+      it "display an :admin only block" do        
+        view_engine do |e, view|
+          view.stubs(:has_role?).with([:admin]).returns true
+
+          res = e.run_template do 
+            %{<%= for_role(:admin) { 'hello' } %>}
+          end
+          res.should match /hello/
+        end
+      end
+      
+      it "should not display a :guest only block" do
+        view_engine do |e, view|
+          view.stubs(:has_role?).with([:guest]).returns false
+
+          res = e.run_template do 
+            %{<%= for_role(:guest) { 'hello' } %>}
+          end        
+          res.should be_empty
+        end
+      end
+    end # desc  
+
   
     describe '#not_for_roles' do              
       it "should not display a block not for :admin" do        
@@ -80,6 +106,30 @@ describe Cream::Helper::Role do
         end
       end
     end # desc
+    
+    describe '#not_for_role' do              
+      it "should not display a block not for :admin" do        
+        view_engine do |e, view|
+          view.stubs(:has_role?).with([:admin]).returns true
+
+          res = e.run_template do 
+            %{<%= not_for_role(:admin) { 'hello' } %>}
+          end        
+          res.should be_empty
+        end
+      end
+    
+      it "should display a div block not for :guest" do        
+        view_engine do |e, view|
+          view.stubs(:has_role?).with([:guest]).returns false
+
+          res = e.run_template do 
+            %{<%= not_for_role(:guest) { 'hello' } %>}
+          end        
+          res.should match /hello/
+        end
+      end
+    end # desc    
   end
   
   describe '#has_role?' do