cream 0.8.6 → 0.8.7

data/lib/cream.rb

@@ -23,3 +23,4 @@ require_all File.dirname(__FILE__) + '/cream/rails'
 require 'cream/roles_config'
 
 
+

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

@@ -1,18 +1,24 @@
 module Cream::View
-  module Role    
-    # admin?,  guest? ...
-    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
-        }
+  module Role
+    def self.roles_available
+      begin
+        return Cream::Role.available if defined? Cream::Role
+      rescue
       end
+      [:guest, :admin]
+    end
+        
+    # admin?,  guest? ...
+    Cream::View::Role.roles_available.each do |role|
+      class_eval %{
+        def #{role}_area &block
+          area_for_role(:#{role}, &block)
+        end 
+      
+        def for_#{role}(&block)
+          for_role(:#{role}, &block)          
+        end
+      }
     end
   end
 end
@@ -20,14 +26,12 @@ end
 module Cream::Helper
   module Role    
     # admin?,  guest? ...
-    if defined? Cream::Role    
-      Cream::Role.available.each do |role|
-        class_eval %{
-          def #{role}?
-            has_role? :#{role}
-          end
-        }
-      end
+    Cream::View::Role.roles_available.each do |role|
+      class_eval %{
+        def #{role}?
+          has_role? :#{role}
+        end
+      }
     end
   end
 end

data/lib/cream/configure/rails.rb

@@ -1,6 +1,8 @@
 require 'active_support/railtie'
 require 'r3_plugin_toolbox'
 
+require_all File.dirname(__FILE__) + '/after_init'
+
 Rails3::Plugin::Extender.new do
   # extend action_controller with methods from some modules
 
@@ -16,11 +18,12 @@ Rails3::Plugin::Extender.new do
     extend_from_module Cream::Helper, :role
   end  
   
-  after :initialize do   
-    require_all File.dirname(__FILE__) + '/after_init'
-
-    # Rails3.with_configuration do
-    #   load_paths += %W(#{Rails.root}/app/permits)
+  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
   end
 end

data/lib/cream/controller/application_controller.rb

@@ -0,0 +1,22 @@
+class ApplicationController < ActionController::Base
+  def current_user
+    cu = super           
+    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    
+    # if all else fails, the user is likely not signed in so create a Guest user for now    
+    cu ||= 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

data/lib/cream/helper/role.rb

@@ -1,20 +1,38 @@
 module Cream::Helper
   module Role
+
+    # for_any_user :signed_in
+    # for_any_user :not_logged_in    
+    # for_any_user :not_logged_in => true
+    
+    def for_any_user options = nil, &block
+      yield if Labels.state_check Labels.extract(options), current_user
+    end
+
+    # not_for_any_user :signed_in
+    # not_for_any_user :logged_out
+    # not_for_any_user :logged_in => true
+
+    def not_for_any_user options = nil, &block
+      return if Labels.state_check Labels.extract(options), current_user
+      yield 
+    end
+    
     # does the user have ANY of the given roles?
     # Uses generic roles API    
-    def has_role?(*roles)
-      current_user.has_role? roles.flatten
+    def has_role? user_role
+      current_user && current_user.has_role?(user_role)
     end
 
     # does the user have ALL of the given roles?
     # Uses generic roles API
-    def has_roles?(*roles)
-      current_user.has_roles? roles.flatten
+    def has_roles? *roles
+      current_user && current_user.has_roles?(roles.flat_uniq)
     end
 
     # returns true if the current user owns the object
     # tries default 'owner' relations if none given as an argument
-    def owner?(obj, relation=nil)
+    def owner? obj, relation=nil
       if relation     
         return true if user_relation?(obj, relation)
       end                                
@@ -25,24 +43,97 @@ module Cream::Helper
     end    
 
     # execute block if user DOES have any of the given roles
-    def for_roles(*user_roles, &block) 
+    def for_roles *user_roles, &block
+      user_roles = user_roles.flatten
+      yield if has_roles?(user_roles) && block
+    end 
+
+    def for_any_role *user_roles, &block
       user_roles = user_roles.flatten
       yield if has_role?(user_roles) && block
     end 
-    alias_method :for_role, :for_roles
 
+    def for_role user_role, &block     
+      if is_negation_role?(user_role) 
+        not_for_role(user_role, &block)  
+        return
+      end
+      yield if has_role?(user_role) && block
+    end 
+    
     # execute block if user DOES NOT have any of the given roles
     def not_for_roles(*user_roles, &block)            
       user_roles = user_roles.flatten
-      yield if !has_role?(user_roles) && block
+      yield if !has_roles?(user_roles) && block
+    end        
+
+    def not_for_role(user_role, &block)
+      if is_negation_role?(user_role) 
+        for_role(user_role, &block)  
+        return
+      end
+      yield if !has_role?(user_role) && block
     end        
-    alias_method :not_for_role, :not_for_roles
 
-    protected
+    protected 
+    
+    def is_negation_role? user_role
+      !(:user_role.to_s =~ /^not_/).nil?
+    end
     
     def user_relation? obj, relation
       raise ArgumentError, "User method must be a Symbol or String" if !relation.kind_of_label?
-      current_user == obj.send(relation) if obj.respond_to? relation
+      current_user && is_owner?(current_user, obj, relation)
+    end
+    
+    def is_owner? user, obj, relation
+      user == obj.send(relation) if obj.respond_to? relation      
+    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    
 end

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

@@ -3,6 +3,7 @@ require 'sugar-high/module'
 require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
+require 'generators/cream/helpers/all'
 
 module Cream
   module Generators 
@@ -10,42 +11,31 @@ module Cream
       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" 
+      class_option :guest_user, :type => :boolean,  :default => true,              :desc => "Create guest user" 
+      
       def configure_application
       	logger.add_logfile :logfile => logfile if logfile
-        app_orm
+
+        app_orm unless active_record?
+
+        set_orm        
+
         app_routes
         app_layout
+                
+        create_guest_user if guest_user?
       end
 
       protected
 
+      include Cream::GeneratorHelper
       include Rails3::Assist::BasicLogger
       extend Rails3::Assist::UseMacro
-      use_helpers :app, :special, :file, :view
-
-      def logfile
-        options[:logfile]
-      end
+      use_helpers :app, :special, :file, :view, :model
 
-      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'
+      def app_orm        
         File.replace_content_from application_file,  :where => "require 'rails/all'" do 
         %q{
 require "action_controller/railtie"
@@ -61,8 +51,8 @@ require "rails/test_unit/railtie"
         # if no :welcome controller
         if !(routes =~ /root\s+:/)
           # create one with an 'index' view.
-          File.insert_into routes_file, :after => 'do', :content => 'root :to => "welcome#index"'          
           rgen "controller Welcome index"
+          File.insert_into routes_file, :after => 'do', :content => 'root :to => "welcome#index"'
         end
       end
       
@@ -79,6 +69,40 @@ require "rails/test_unit/railtie"
         insert_into_view :layouts => :application, :after => '<body>' do
           %Q{<p class="#{name}"><%= #{name} %></p>}
         end
+      end
+
+      def create_guest_user
+        remove_model :guest if has_model?(:guest)
+        create_model :guest do
+          %Q{
+  def self.create
+    Guest.new
+  end
+
+  def is? role
+    role == :guest
+  end
+
+  def has_role? role
+    is? role
+  end
+
+  def has_roles? *roles
+    false
+  end  
+
+  def has_any_role? *roles
+    roles.flat_uniq..to_symbols.include? :guest
+  end  
+}
+        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

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

@@ -27,12 +27,17 @@ module Cream
       # ORM to use
       class_option :orm,            :type => :string,   :default => 'active_record',  :desc => "ORM to use"
 
+      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 :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'
 
+      # Devise customize
+      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 
         execute_generator if validate_orm && validate_strategy
       end
@@ -49,6 +54,7 @@ module Cream
 
       def execute_generator
         cream_initializer
+        cream_locales if locales
         run_generators
         run_migrations if run_migrations?
       end
@@ -85,6 +91,7 @@ module Cream
       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:customize #{user_class} --orm #{orm} --login-type #{login_type} #{user_name_option}"
       end
 
       def run_cancan
@@ -92,7 +99,7 @@ module Cream
       end
 
       def run_roles
-        rgen "roles:config --orm #{orm} --roles #{roles_list} --strategy #{strategy}"
+        rgen "roles:config #{user_class} --orm #{orm} --roles #{roles_list} --strategy #{strategy}"
       end
 
       def run_permits
@@ -103,23 +110,51 @@ module Cream
         create_initializer :cream do         
   %Q{Cream.setup do |config|
   config.roles = #{sym_roles.inspect} 
-end}      
+end
+
+require 'cream/configure/rails'
+}      
         end
       end
 
-      def cream_locale
-        src = File.expand_path "config/locales/cream.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"
+      def login_type
+        options[:login_type]
+      end
+
+      def username?
+        options[:user_name]
+      end
+
+      def user_name_option
+        " --user-name " if username?
+      end
+
+      def locales
+        options[:locales]
+      end
+
+      def supported_locales
+        [:en, :da]
+      end
+
+      def locales_to_generate
+        supported_locales - locales
+      end
+
+      def cream_locales                               
+        return if locales_to_generate.empty?
+        logger.debug "Generate Cream locale files"
+        locales_to_generate.each do |locale|
+          src = File.expand_path "config/locales/cream.#{locale}.yml".path.up(5), __FILE__
+          copy_file src, "config/locales/cream.#{locale}.yml"
+        end
       end
       
       private
 
       def run_migrations?
         options[:migrations]
-      end
-      
+      end      
     end
   end
 end