cream 0.5.6

data/features/FEATURE_NOTES.txt

@@ -0,0 +1,6 @@
+# Notes and Status
+
+Currently these features are a work in progress. 
+I am first building up a skeleton structure for the features and then plan to gradually implement them as described in the DESIGN.txt document :)
+
+You are most welcome to help in the effort!

data/init.rb

@@ -0,0 +1 @@
+require 'cream'

data/lib/cream.rb

@@ -0,0 +1,21 @@
+require 'active_support/inflector'
+require 'require_all'
+
+require 'rails'
+# require 'devise'
+require 'devise-links'
+
+require 'cancan'
+require 'cancan-rest-links'
+require 'cancan-permits'
+
+require 'cream/namespaces'    
+
+require 'sugar-high/alias'
+require 'sugar-high/kind_of'
+require 'sugar-high/array'
+
+require_all File.dirname(__FILE__) + '/cream/controller'
+require_all File.dirname(__FILE__) + '/cream/helper'
+require_all File.dirname(__FILE__) + '/cream/view'
+

data/lib/cream/configure.rb

@@ -0,0 +1,3 @@
+require 'require_all'
+require 'cream/namespaces'
+require_all File.dirname(__FILE__) + '/configure'

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

@@ -0,0 +1,29 @@
+module Cream::View
+  module Role    
+    # admin?,  guest? ...
+    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
+      }
+    end
+  end
+end
+
+module Cream::Helper
+  module Role    
+    # admin?,  guest? ...
+    AuthAssistant::Role.available.each do |role|
+      class_eval %{
+        def #{role}?
+          has_role? :#{role}
+        end
+      }
+    end
+  end
+end

data/lib/cream/configure/rails.rb

@@ -0,0 +1,23 @@
+require 'active_support/railtie'
+require 'r3_plugin_toolbox'
+
+Rails3::Plugin::Extender.new do
+  # extend action_controller with methods from some modules
+  # extend_rails(:controller) do
+  #   extend_from_module Cream, :role
+  #   extend_from_module Cream::Controller, :ability
+  #   extend_from_module Cream::Helper, :role, :local_host, :auth_label
+  #   extend_from_module Cream::Link, :session, :registration, :rest, :session          
+  # end  
+
+  # extend action_view with methods from some modules
+  extend_rails :view do
+    extend_from_module Cream::View, :role, :user_action_menu
+    extend_from_module Cream::Helper, :role
+  end  
+  
+  after :initialize do   
+    puts "Rails app initialized"
+    require_all File.dirname(__FILE__) + '/after_init'
+  end
+end

data/lib/cream/controller/ability.rb

@@ -0,0 +1,7 @@
+module Cream::Controller
+  module Ability
+    def current_ability
+      @current_ability ||= Ability.new(current_user, request)
+    end
+  end
+end

data/lib/cream/helper/authlabels.rb

@@ -0,0 +1,21 @@
+module Cream::Helper
+  module AuthLabel          
+    def auth_labels
+      @auth_labels ||= translate_labels
+    end
+
+    def translate_labels
+      ns_actions = 'cream.actions'
+      labels = {}
+      %w{new edit delete show sign_in sign_out sign_up edit_registration}.each do |action|     
+        labels[action.to_sym] = t "#{ns_actions}.#{action}"
+      end 
+      labels[:confirm] = t 'cream.confirm'
+      labels           
+    end 
+    
+    def self.included(base)
+      base.helper_method :auth_labels
+    end         
+  end
+end

data/lib/cream/helper/host.rb

@@ -0,0 +1,11 @@
+module Cream::Helper
+  module Host
+    def localhost?
+       ['localhost', '127.0.0.1'].include?(request.host)
+    end           
+
+    def publichost?
+       !localhost?
+    end           
+  end
+end

data/lib/cream/helper/role.rb

@@ -0,0 +1,48 @@
+module Cream::Helper
+  module Role
+    # does the user have ANY of the given roles?
+    # Uses generic roles API    
+    def has_role?(*roles)
+      current_user.has_role? roles.flatten
+    end
+
+    # does the user have ALL of the given roles?
+    # Uses generic roles API
+    def has_roles?(*roles)
+      current_user.has_roles? roles.flatten
+    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)
+      if relation     
+        return true if user_relation?(obj, relation)
+      end                                
+      [:user, :owner, :author].each do |relation|        
+        return true if user_relation?(obj, relation)
+      end
+      false
+    end    
+
+    # execute block if user DOES have any of the given roles
+    def for_roles(*user_roles, &block) 
+      user_roles = user_roles.flatten
+      yield if has_role?(user_roles) && block
+    end 
+    alias_method :for_role, :for_roles
+
+    # 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
+    end        
+    alias_method :not_for_role, :not_for_roles
+
+    protected
+    
+    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
+    end
+  end    
+end

data/lib/cream/namespaces.rb

@@ -0,0 +1,5 @@
+require 'sugar-high/module'
+
+module Cream
+  modules :view, :controller, :model, :link, :helper
+end

data/lib/cream/role.rb

@@ -0,0 +1,7 @@
+module AuthAssistant
+  module Role
+    def self.available
+      ::Role.all.map(&:name).to_symbols
+    end
+  end
+end

data/lib/cream/view/host_area.rb

@@ -0,0 +1,12 @@
+module Cream::View
+  module Host
+    def for_localhost(&block)
+      yield block if localhost?
+    end  
+
+    def for_public(&block)
+      # with_output_buffer(&block) if publichost?
+      yield block if publichost?
+    end  
+  end
+end

data/lib/cream/view/role_area.rb

@@ -0,0 +1,38 @@
+require 'sugar-high/arguments'
+
+module Cream::View
+  module Role
+    # for users WITH the given roles create a div area
+    # with optional class given in options hash and render block
+    # within this div  
+    def area_for_roles(*user_roles, &block)
+      options = last_option(user_roles)
+
+      return area(&block) if user_roles.empty?
+      
+      not_for_roles(user_roles, &block) if user_roles.first == false
+      
+      for_roles user_roles do
+        area(options, &block)
+      end
+    end   
+    alias_method :area_for_role, :area_for_roles
+
+    # for users WITHOUT the given roles create a div area
+    # with optional class given in options hash and render block
+    # within this div  
+    def area_not_for_roles(*user_roles, &block)
+      options = last_option(user_roles)
+      not_for_roles user_roles do             
+        clazz = options[:class] || 'special'
+        area(clazz, &block)
+      end
+    end  
+    alias_method :area_not_for_role, :area_not_for_roles
+    
+    def area(options=nil, &block)
+      content = yield #with_output_buffer(&block)
+      content_tag :div, content, options
+    end    
+  end
+end

data/lib/cream/view/user_action_menu.rb

@@ -0,0 +1,21 @@
+module Cream::View
+  module UserActionMenu       
+
+    MENU_ITEMS = {
+      :sign_out => :logout, 
+      :sign_in => :login, 
+      :sign_up => :register,
+      :edit_registration => [:edit_user, :edit_account]
+    }
+
+    MENU_ITEMS.keys.each do |name|
+      class_eval %{
+        def #{name}_menu_item tag = 'li'
+          content_tag tag, #{name}_link
+        end          
+      }      
+    end
+  
+    multi_alias :menu_item, MENU_ITEMS
+  end  
+end

data/lib/generators/cream/config/DESIGN NOTES.markdown

@@ -0,0 +1,61 @@
+# Config generator
+
+Each of the following should be a module in its own right!
+
+1. Create fresh Rails 3 app and set it up so that all the sub-systems work
+2. Develop the generator so that it can mutate a Rails 3 app that matches this example app
+
+## Code Design
+
+* Create a module for each sub-system to configure
+* Include modules depending on options
+* For each module call the config_[module_name] method, which is responsible for configuring that module! 
+
+## Devise Configuration
+
+Gemfile
+gem 'devise' 
+gem ORM 'devise'
+
+if app does NOT have a User model
+  run devise generator to create User model
+else
+  if User model is NOT configured with devise strategy
+    insert default devise User strategy
+  end    
+end
+
+if --admin option set 
+  if app does NOT have a Admin model
+    run devise generator to create Admin model  
+    remove any current inheritance
+    and make Admin model inherit from User model 
+  else
+    insert default devise Admin strategy    
+  end
+end
+
+## Cream configuration
+
+copy locales and views (optional)
+
+## CanCan Configuration
+
+Gemfile:
+gem 'cancan'  
+gem 'cancan-rest-links' 
+
+CanCan access denied exception handling
+
+## Permits Configuration
+
+Gemfile:
+gem 'cancan-permits'
+
+Run permits generator to generate permit for each role
+
+## Roles Configuration
+
+gem ORM 'roles'
+
+run roles generator for ORM chosen 

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

@@ -0,0 +1,72 @@
+require 'sugar-high/file'
+require 'sugar-high/modules'
+require 'cream'
+require 'rails3_artifactor'
+require 'logging_assist'
+
+module Cream
+  module Generators
+  end
+end
+
+require_all File.dirname(__FILE__) + '/modules'
+
+module Cream::Generators 
+  class ConfigGenerator < Rails::Generators::Base
+    extend Rails3::Assist::UseMacro
+        
+    desc "Configures Devise and Users" 
+
+    source_root File.dirname(__FILE__)
+
+    # Role Strategy
+    class_option  :strategy,          :type => :string,   :default => 'role_string',    :desc => "Role strategy to use", 
+
+    # Create Admin user
+    class_option :admin_user,         :type => :boolean,  :default => false,            :desc => "Create admin user",  
+
+    # 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"
+
+    # Permits
+    class_option :permits,            :type => :boolean,  :default => true,             :desc => "Configure permits or not"
+
+    # 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 main_flow 
+      configure_logger
+      configure_gems       
+
+      MODULES.each do |name|
+        send :"configure_#{name}"
+      end
+    end
+
+    # -----------------      
+    protected
+
+    MODULES = [:devise] #, :cancan, :roles, :permits, :cream]
+
+    includes Cream::Generators::Config, :helper, MODULES #, :cancan, :roles, :permits, :cream
+
+    include Rails3::Assist::BasicLogger
+
+    use_helpers :model, :controller, :permit
+
+    def configure_logger
+      logger.add_logfile :logfile => logfile
+      logger.debug 'main flow'
+    end
+
+    def configure_gems
+      MODULES.each do |name|
+        send :"#{name}_gems"
+      end
+      run "bundle install"
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Cream::Generators 
+  module Config
+    module CanCan
+      def configure_devise_gems
+        gem 'cancan'  
+        gem 'cancan-rest-links'
+      end
+
+      # CanCan access denied exception handling
+      def configure_exception_handling         
+        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      
+    end
+  end
+end