cream 0.5.6

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

@@ -0,0 +1,23 @@
+module Cream::Generators 
+  module Config
+    module Cream
+      def cream_gems
+        gem_name = ORM_MAP[orm]      
+        gem gem_name if gem_name        
+        
+        gem 'devise'
+        gem 'cancan'          
+        gem 'cream'
+        run "bundle install"
+      end      
+      
+      def configure_locale
+        src = File.expand_path "config/locales/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"
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,108 @@
+module Cream::Generators 
+  module Config
+    module Devise        
+
+      def configure_devise
+        if !has_model? :user
+          # run devise generator to create User model
+          create_devise_model :user
+        end                           
+        
+        # if User model is NOT configured with devise strategy
+        if !has_devise_strategy? :user
+            insert_devise_strategy :user, :defaults
+          end    
+        end
+        
+        configure_admin_user if configure_admin_user?
+      end
+
+      def configure_admin_user        
+        # if app does NOT have a Admin model
+        if !has_model? :admin
+          create_admin_user
+        end
+        if has_model? :admin
+          # insert default devise Admin strategy    
+          insert_devise_strategy :user, :defaults            
+        end
+      end
+
+      def devise_gems
+        gem 'devise'
+
+        # Devise ORM integration
+        case orm.to_sym
+        when :mongoid
+          say "Please configure Devise for Mongoid as similar to Rails 3 example app: http://github.com/fortuity/rails3-mongoid-devise"
+        when :mongo_mapper
+          gem 'mm-devise'
+        when :data_mapper
+          gem 'dm-devise'
+        when :couch_db
+          gem 'devise_couch'
+          say "Please note that Couch DB does not currently have a Roles implementation. Feel free to provide one."
+          say "Look at Roles DataMapper (roles_data_mapper) for an example ;)"
+        end
+      end
+
+      def init_devise
+        execute 'devise_install'
+      end      
+      
+      def devise_users?
+        has_user?(:user) && has_user?(:admin)
+      end
+
+      def handle_devise_users
+        return notify_create_users if !init_devise?
+        create_users 
+      end
+
+      def notify_create_users
+        logger.debug 'notify_create_users'
+        say "You must first run devise generators:"
+        say "rails g devise User"
+        say "rails g devise Admin" if admin_user?      
+      end
+
+      def create_admin_user
+        logger.debug 'create_admin_user'      
+        create_model :admin          
+        # remove any current inheritance
+        remove_inheritance :admin            
+        # and make Admin model inherit from User model 
+        inherit_model :user => :admin
+      end 
+
+      def remove_inheritance user
+        File.remove_from model_file user, :content => /<\s*ActiveRecord::Base/
+      end  
+
+      def inherit_model hash                 
+        subclass    = hash.keys.first
+        superclass  = hash.values.first.to_s.camelize
+        File.replace_content_from model_file subclass, :where => /class Admin/, :with => "class Admin < #{superclass}"
+      end
+      
+      # Must be ORM specific!
+      def create_devise_model user
+        execute "rails g devise #{user}"
+      end
+
+      def create_user user
+        execute "rails g model #{user}"
+      end  
+      
+      def has_user? user
+        return true if user == :admin && !admin_user?
+        begin
+          read_model(user) =~ /devise/
+        rescue Exception => e
+          logger.info "Exception for has_user? #{user}: #{e.message}"
+          false
+        end
+      end          
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Cream::Generators 
+  module Config
+    module Helpers
+
+      ORM_MAP = {
+        :data_mapper  => 'dm-devise',
+        :mongo_mapper => 'mm-devise',
+        :mongoid      => 'rails3-mongoid-devise'                
+      }
+
+      def execute command
+        logger.debug command
+        run command
+      end        
+
+      def strategy
+        options[:strategy]      
+      end
+
+      def logfile
+        options[:logfile]      
+      end
+
+      def default_roles
+        options[:default_roles] ? '--default-roles' : '--no-default-roles'
+      end
+
+      def roles
+        options[:roles].join(' ')
+      end
+
+      def orm
+        options[:orm]
+      end
+
+      def roles_config?
+        options[:roles_config]
+      end
+
+      def permission_config?
+        options[:permission_config]
+      end
+
+      def admin_user?
+        options[:admin]
+      end
+
+      def here
+        File.dirname(__FILE__)
+      end
+
+      def root_dir
+        File.dirname(__FILE__).up(4)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Cream::Generators 
+  module Config
+    module Permits      
+      def permits_gems
+        gem 'cancan-permits'        
+      end 
+      
+      def configure_permits
+        logger.debug "Configure Permits"
+        # Run permits generator to generate permit for each role
+        execute "rails g permits --roles #{roles}"
+      end           
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Cream::Generators 
+  module Config
+    module Roles
+      def configure_roles_gems
+        gem "roles_#{orm}"
+      end
+
+      def configure_roles
+        command = "rails g #{orm}:roles --strategy #{strategy} --roles #{roles} #{default_roles}"
+        logger.debug command
+        run command
+      end      
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Cream
+  module Generators
+    module HamlUtil
+      def verify_haml_existence
+        begin
+          require 'haml'
+        rescue LoadError
+          say "HAML is not installed, or it is not specified in your Gemfile."
+          exit
+        end
+      end
+
+      def verify_haml_version
+        unless Haml.version[:major] == 2 and Haml.version[:minor] >= 3 or Haml.version[:major] >= 3
+          say "To generate HAML templates, you need to install HAML 2.3 or above."
+          exit
+        end
+      end
+
+      def create_and_copy_haml_views
+        verify_haml_existence
+        verify_haml_version
+  
+        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, "")
+            source_path   = (haml_root + relative_path).sub(/erb$/, "haml")
+
+            if File.directory?(path)
+              FileUtils.mkdir_p(source_path)
+            else
+              `html2haml -r #{path} #{source_path}`
+            end
+          end
+
+          directory haml_root, "app/views/#{scope || 'devise'}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'generators/cream/string_ext'
+require 'generators/views/haml_util'
+
+module Cream
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      desc "Copies all AuthAssist 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"
+  
+      def self.source_root
+        @_devise_source_root ||= File.expand_path("app/views".up(4), __FILE__)
+      end
+
+      def copy_views
+        if options[:haml]
+          create_and_copy_haml_views
+        else
+          copy_erb_views
+        end
+      end
+  
+      protected
+
+      def copy_erb_views
+        directory "cream", "app/views/#{scope || 'devise'}"        
+      end
+  
+      include Cream::Generators::HamlUtil
+    end
+  end
+end

data/lib/generators/cream_refactor.rb

@@ -0,0 +1,82 @@
+module Cream
+  module MigrationHelper
+    module CodeRefactor 
+
+      # erase      
+      def clear_relations(model_name)       
+        model_name = model_name.to_s
+        erase_in(model_name, has_roles_through_assignments)
+        erase_in(model_name, has_roles)  
+        erase_in(model_name, has_role_assignments)
+      end
+
+      def erase_in(model_name, txt)      
+        model_name = model_name.to_s   
+        file = File.new(model_file(model_name))
+        return if !(file.read =~ /#{txt}/)         
+        gsub_file model_file(model_name), /#{Regexp.escape(txt + "\n")}/, ''
+      end
+
+
+      # insert
+      def write_model_file(model_name, content)    
+        model_name = model_name.to_s
+        File.open(model_file(model_name), 'w+') do |f| 
+          f.write(content) 
+        end
+      end
+
+      def insert_relation(model_name, relation)
+        model_name = model_name.to_s
+        file = File.new(model_file(model_name))
+        return if (file.read =~ /#{relation}/) 
+        gsub_file model_file(model_name), /class #{model.camelize} < ActiveRecord::Base/ do |match|
+          match << "\n  #{relation}"
+        end
+      end      
+        
+      def remove_relation(model_name, relation)
+        erase_in(model_name.to_s, relation)  
+      end
+      
+      def belongs_to_user
+        'belongs_to :user'
+      end
+
+      def belongs_to_role
+        'belongs_to :role'
+      end
+      
+      # refactor code
+      def has_role_assignments 
+        'has_many :role_assignments'
+      end
+
+      def has_roles_through_assignments 
+        'has_many :roles, :through => :role_assignments'
+      end
+
+      def has_roles 
+        'has_many :roles'
+      end
+        
+      def role_file_content
+        %Q{
+  class Role < ActiveRecord::Base
+  #{has_role_assignments}
+  #{has_roles_through_assignments}
+  end          
+        }    
+      end       
+    
+      def role_assignment_file_content
+        %Q{
+  class RoleAssignment < ActiveRecord::Base
+#{belongs_to_user}
+#{belongs_to_role}
+  end          
+        }
+      end
+    end 
+  end
+end

data/sandbox/test.rb

@@ -0,0 +1,40 @@
+module RolePermit
+
+  class Base 
+    attr_accessor :ability
+       
+    def initialize(ability)
+      @ability = ability
+    end
+
+    def permit?(user) 
+      puts "Base Permit"
+    end
+  end
+  
+  class Admin < Base
+    def initialize(ability)
+      super
+    end
+
+    def permit?(user)    
+      super
+      puts "Admin"
+    end  
+  end
+
+  class Guest < Base
+    def initialize(ability)
+      super
+    end
+
+    def permit?(user) 
+      super
+      puts "User"
+    end  
+  end
+end  
+
+
+RolePermit::Admin.new(0).permit? 0
+RolePermit::Guest.new(0).permit? 0

data/spec/cream/configure/rails_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'r3_plugin_toolbox'
+
+require 'active_support'
+require 'action_controller'
+require 'action_view'
+require 'active_support/railtie'
+
+module Minimal
+  class Application < Rails::Application
+    config.active_support.deprecation = :log
+  end
+end
+
+class Role  
+  attr_accessor :name
+  
+  def initialize name
+    self.name = name
+  end
+  
+  def self.all
+    [Role.new('admin'), Role.new('guest')]
+  end
+end
+
+require 'cream/role'
+require 'cream/configure'
+
+Rails.application = Minimal::Application
+
+Minimal::Application.initialize!
+
+describe "Rails extension" do
+  describe 'View extension' do
+    it "should extend Action View with Roles helper instance_methods and specific role methods" do
+      extend Rails3::Plugin::Extender::Macro
+  
+      after_init :view do |view|
+        view.should be_extended_with Cream::View, :roles, :area, :user_action_menu
+        [:admin, :guest].each do |role|
+          view.should respond_to? :"for_#{role}"
+          view.should respond_to? :"#{role}_area"
+          view.should respond_to? :"#{role}?"
+        end
+      end
+
+      Minimal::Application.initialize!
+    end    
+  end
+end