rails3_assist 0.2.4 → 0.2.5

data/README.markdown

@@ -2,6 +2,13 @@
 
 Includes various helpers to assist operating on a Rails 3 application, including various Rails 3 artifacts, such as migrations etc.
 
+## Development status
+
+TODO specs: artifact
+
+* files
+* directory
+
 ## Rails Artifacts
 
 Rails assist also includes various artifact libraries to help operate on different Rails 3 artifacts. 
@@ -24,6 +31,7 @@ Rails 3 artifacts that have a CRUD assistant:
 * model (insert bug!)
 * observer
 * view
+* permit (NEW - used with cancan)
 
 ## Model
 
@@ -60,10 +68,9 @@ Example:
 
 Aliases: *use_helpers* and *use_helper*
 
-## Known issues
+## TODO
 
-* View generation fails when action arg supplied :( To be fixed ASAP
- - rails3_assist/artifact/view.rb:7:in `[]' can't convert Symbol into Integer
+Refactor: split it up into smaller gems and modules to be loaded individually as the need arises.
 
 ## Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/rails3_assist/app.rb

@@ -1,47 +1,13 @@
-module Rails::Assist  
-  def self.helper_list
-    self.artifacts + [:view]
-  end
-
-  module ArtifactPath
-    def artifact_path name, type, options={}
-      dir = send :"#{type}_dir", options[:root_path] 
-      File.join(dir, "#{name}#{type_postfix type}.rb")
-    end
-
-    def type_postfix type
-      "_#{type}" if ![:model].include?(type)
-    end
-  end
-  
-  module App
-    include ArtifactPath
-    
+module Rails3::Assist    
+  module App    
     def create_empty_tmp *dir_types
       dir_types.flatten.each do |dir_type|
-        dir = rails_dir_for(dir_type)
+        dir = Rails3::Assist::Directory.rails_dir_for(dir_type)
         FileUtils.mkdir_p dir
       end
-    end                              
-  end 
-  
+    end
+    
+    extend self                              
+  end  
 end
 
-# first load all base modules that the app helper will build upon
-require 'rails3_assist/base'
-
-# then load the app 'modules'
-require_all File.dirname(__FILE__) + '/app'
-
-# into App
-module Rails::Assist::App  
-  include RailsFiles       
-  include RailsDirs
-
-  # put all FileName modules into App
-  Rails::Assist.helper_list.each do |name|
-    class_eval %{
-      include Rails::Assist::#{name.to_s.camelize}::FileName
-    } 
-  end
-end                

data/lib/rails3_assist/artifact/directory.rb

@@ -0,0 +1,42 @@
+module Rails3::Assist::Artifact
+  module Directory
+    module Methods
+      DIR = Rails3::Assist::Directory
+      APP_DIR = Rails3::Assist::Directory::App
+      
+      # :controller, :mailer, :helper, :view, :model, :permit
+      #
+      # controller_dir, mailer_dir ...
+      Rails3::Assist::Artifact.app_artifacts.each do |name|
+        class_eval %{
+          def #{name}_dir options={}
+            File.join(APP_DIR.app_dir(options), '#{name.to_s.pluralize}')
+          end
+        } 
+      end    
+        
+      # initializer_dir, locale_dir
+      # stylesheet_dir, javascript_dir    
+      {:config => [:initializer, :locale], :public => [:stylesheet, :javascript]}.each_pair do |container, names|
+        names.each do |name|
+          class_eval %{      
+            def #{name}_dir options={}
+              Rails3::Assist::Directory.#{container}_dir_for :#{name.to_s.pluralize}, options
+            end  
+          }
+        end
+      end
+      
+      def migration_dir options={}
+        File.join(DIR.db_dir(options), 'migrations')
+      end
+      
+      def observer_dir options={}
+        model_dir options
+      end
+    end
+
+    extend Methods
+    include Methods
+  end
+end

data/lib/rails3_assist/artifact/files.rb

@@ -0,0 +1,63 @@
+require 'sugar-high/regexp'
+
+module Rails3::Assist::Artifact
+  module Files  
+    module Methods  
+      [:model].each do |name|
+        class_eval %{
+          def #{name}_files expr=nil
+            files = Rails3::Assist::Files.rails_app_files(:#{name.to_s.pluralize}).grep_it expr
+            yield files if block_given?
+            files
+          end          
+        }
+      end
+
+      # artifact files using xxx_[artifact].rb convention, i.e postfixing with type of artifact
+      [:mailer, :observer, :permit, :controller, :helper].each do |name|
+        class_eval %{
+          def #{name}_files expr=nil
+            files = Rails3::Assist::Files.rails_app_files(:#{name.to_s.pluralize}, :pattern => '**/*_#{name}.rb').grep_it expr
+            yield files if block_given?
+            files
+          end  
+        }
+      end   
+
+      def view_files *args 
+        expr, model_name = Helper.get_view_args args
+        ext = last_option(args)[:template_language] || 'erb'
+        pattern = model_name ? "#{model_name.to_s.pluralize}/*.#{ext}*" : "**/*.#{ext}*"
+        files = Rails3::Assist::Files.rails_app_files(:views, :pattern => pattern).grep_it expr
+        yield files if block_given?
+        files          
+      end
+
+
+      [:erb, :haml].each do |name|
+        class_eval %{
+          def #{name}_view_files *args 
+            view_files args, :template_language => :#{name}
+          end
+        }
+      end
+    end
+    extend Methods
+    include Methods
+
+    module Helper    
+      def self.get_view_args args 
+        args = args.flatten
+        first_arg = args.first      
+        case first_arg
+        when Regexp
+          expr = first_arg
+        when String, Symbol
+          _model = first_arg
+        end
+        expr = args[1] if args.size > 1 && args[1].kind_of?(Regexp)
+        [expr, _model]
+      end        
+    end
+  end
+end

data/lib/rails3_assist/artifact/path.rb

@@ -0,0 +1,16 @@
+module Rails3::Assist::Artifact
+  module Path
+    include Rails3::Assist::Artifact::Directory    
+    
+    def artifact_path name, type, options={}
+      dir = send :"#{type}_dir", options
+      File.join(dir, "#{name}#{type_postfix type}.rb")
+    end
+
+    protected
+
+    def type_postfix type
+      "_#{type}" if ![:model].include?(type)
+    end
+  end
+end

data/lib/rails3_assist/artifact.rb

@@ -0,0 +1,34 @@
+module Rails3::Assist::Artifact
+  module Methods
+    def helper_list
+      Rails3::Assist.artifacts + [:view]
+    end
+
+    def app_artifacts
+      [:controller, :mailer, :helper, :view, :model, :permit]
+    end
+  
+    def rails_artifacts
+      @rails_artifacts ||= begin
+        files_methods = Rails3::Assist::Artifact::Files.instance_methods        
+        files_symbols = files_methods.grep(/_files$/).map{|f| f.to_s.gsub(/^(.*)_files/, '\1').to_sym }
+
+        # dir_methods = Rails3::Assist::Artifact::Directory.instance_methods        
+        # dir_symbols = dir_methods.map{|dir| dir.to_s.gsub(/^(.*)_dir/, '\1').to_sym }
+        dir_symbols = []
+      
+        (files_symbols + dir_symbols).uniq
+      end      
+    end
+
+    def valid_artifact? type
+      rails_artifacts.include?(type)
+    end 
+  end 
+  
+  extend Methods
+  include Methods  
+end  
+
+
+require_all File.dirname(__FILE__) + '/artifact'

data/lib/rails3_assist/directory/app.rb

@@ -0,0 +1,17 @@
+module Rails3::Assist::Directory
+  module App  
+    module Methods
+      def app_directories
+        Rails3::Assist::Artifact::app_artifacts.map {|a| a.to_s.pluralize.to_sym}
+      end
+
+      def app_dir options={}
+        rails_root_dir = Rails3::Assist::Directory::Root.root_dir(options)
+        File.join(rails_root_dir, 'app')
+      end
+    end
+    
+    include Methods
+    extend Methods
+  end
+end

data/lib/rails3_assist/directory/container.rb

@@ -0,0 +1,24 @@
+module Rails3::Assist::Directory      
+  module Container  
+
+    # return list of symbols for all kinds of supported Rails 3 containers 
+    # (those that have a [container]_dir method)
+    
+    module Methods    
+      def rails_containers
+        app_methods       = Rails3::Assist::Directory.instance_methods
+        artifact_methods  = Rails3::Assist::Artifact::Directory.instance_methods
+        all_methods = app_methods + artifact_methods
+    
+        all_methods.grep(/_dir$/).map{|dir| dir.to_s.gsub(/^(.*)_dir/, '\1').to_sym }
+      end
+
+      def valid_container? type
+        rails_containers.include?(type)
+      end
+    end
+    
+    include Methods
+    extend Methods
+  end
+end

data/lib/rails3_assist/directory/root.rb

@@ -0,0 +1,20 @@
+module Rails3::Assist::Directory
+  module Root
+    module Methods
+      def root_directories
+        [:app, :config, :db, :public, :lib, :log, :doc, :test, :spec]      
+      end
+
+      def root_dir options={}
+        raise ArgumentError, "options argument to root_dir must be a hash, was: #{options.inspect}" if options && !options.kind_of?(Hash)
+        dir = options[:root_path] if options 
+        dir ||= Rails3::Assist::Directory.rails_root || Rails.root
+        raise "You must set the Rails app root dir: Rails::Assist::App.root_dir = '/my/root/dir'" if !dir
+        dir
+      end
+    end    
+    
+    include Methods
+    extend Methods
+  end
+end

data/lib/rails3_assist/directory.rb

@@ -0,0 +1,55 @@
+require_all File.dirname(__FILE__) + '/directory'
+require 'rails3_assist/artifact'
+
+module Rails3::Assist
+  module Directory      
+    class << self
+      attr_accessor :rails_root
+    end    
+
+    include Root
+    include App
+    include Container    
+        
+    # dir_for helpers
+    # -------------------
+
+    module Methods   
+      DIR = Rails3::Assist::Artifact::Directory      
+      
+      # :app, :config, :db, :public, :lib, :log, :doc, :test, :spec
+      #
+      # app_dir, config_dir ...
+      Rails3::Assist::Directory::Root.root_directories.each do |name|
+        class_eval %{
+          def #{name}_dir options={}
+            ::File.join(Rails3::Assist::Directory::Root.root_dir(options), '#{name}')
+          end        
+        } 
+      end      
+      
+      def rails_dir_for type, options={}
+        raise ArgumentError, '#rails_dir_for takes a dir type argument' if !type
+        dir_method = "#{type}_dir"
+        return send(dir_method, options) if respond_to?(dir_method)
+        DIR.send(dir_method, options) if DIR.respond_to?(dir_method)
+      end
+
+      def app_dir_for type, options={}
+        ::File.join(app_dir(options), type.to_s.pluralize)
+      end      
+
+      def config_dir_for type, options={}
+        ::File.join(config_dir(options), type.to_s.pluralize)
+      end      
+
+      def public_dir_for type, options={}
+        ::File.join(public_dir(options), type.to_s.pluralize)
+      end                
+    end
+    
+    include Methods
+    extend Methods
+    
+  end # Directories   
+end

data/lib/rails3_assist/file/application.rb

@@ -0,0 +1,14 @@
+require 'sugar-high/file'
+
+module Rails3::Assist::File
+  module Application
+    module Methods
+      def insert_application_config statement=nil, &block
+        statement = block ? yield : "config.#{statement}"        
+        File.insert_into application_file, statement, :after => 'Rails::Application', &block
+      end  
+    end
+    include Methods
+    extend Methods
+  end
+end

data/lib/rails3_assist/file/environment.rb

@@ -0,0 +1,15 @@
+module Rails3::Assist::File
+  module Environment
+    def insert_before_application_init content=nil, &block
+      insert_application_init :before, content, &block
+    end
+
+    def insert_after_application_init content=nil, &block
+      insert_application_init :after, content, &block
+    end
+
+    def insert_application_init place, statement=nil, &block
+      File.insert_into environment_file, statement, place => /\w+::Application.initialize!/
+    end    
+  end
+end

data/lib/rails3_assist/file/special.rb

@@ -0,0 +1,48 @@
+require_all File.dirname(__FILE__)
+
+module Rails3::Assist::File
+  module Special          
+    module Methods
+      # application_file, environment_file
+      [:application, :environment].each do |name|
+        class_eval %{
+          def #{name}_file
+            File.join(Rails3::Assist::Directory.config_dir, '#{name}.rb')
+          end         
+        }
+      end  
+
+      def seed_file
+        File.join(Rails3::Assist::Directory.db_dir, 'seeds.rb')
+      end
+    
+      # read_application_file
+      # append_to_application_file
+      [:application, :environment, :seed].each do |name|
+        class_eval %{      
+          def read_#{name}_file     
+            fname = #{name}_file
+            File.read(fname) if File.file?(fname)
+          end
+
+          def remove_#{name}_file
+            File.delete #{name}_file
+          end
+
+          def append_to_#{name}_file content=nil, &block
+            File.append(#{name}_file, content, &block)
+          end
+        }
+      end    
+    end
+    
+    include Methods
+    extend Methods
+    
+    include Rails3::Assist::File::Application
+    include Rails3::Assist::File::Environment    
+
+    extend Rails3::Assist::File::Application
+    extend Rails3::Assist::File::Environment    
+  end
+end

data/lib/rails3_assist/file.rb

@@ -0,0 +1,38 @@
+module Rails3::Assist
+  module File
+    module Methods
+      {:initializer => '.rb', :db => '.rb', :migration => '.rb', :locale => '.yml', :javascript => 'js', :stylesheet => 'css'}.each_pair do |name, ext|
+        plural_name = name.to_s.pluralize
+
+        class_eval %{      
+          def #{name}_file name
+            name = (name =~ /.rb$/) ? name : name + '#{ext}'
+            ::File.join(Rails3::Assist::Artifact::Directory.#{name}_dir, name)
+          end  
+
+          def create_#{name} name, &block
+            ::File.overwrite #{name}_file(name) do
+              yield
+            end
+          end
+
+          def remove_all_#{plural_name}
+            #{name}_files.each{|f| ::File.delete_file! f}
+          end
+
+          def remove_#{plural_name} *names
+            return remove_all_#{plural_name} if names.empty? 
+            names.each do |name|
+              ::File.delete #{name}_file(name)
+            end
+          end
+          alias_method :remove_#{name}, :remove_#{plural_name} 
+        }
+      end
+    end
+    
+    include Methods
+    extend Methods
+  end
+end   
+

data/lib/rails3_assist/files.rb

@@ -0,0 +1,83 @@
+require 'rake'
+require 'rails3_assist/directory'
+require 'sugar-high/regexp'
+
+require_all File.dirname(__FILE__) + '/file'
+
+module Rails3::Assist
+  module Files         
+    # we depend on the Directories module doing some of the hard work!
+    module Methods
+      RYBY_FILES = '**/*.rb'
+      
+      def rails_app_files type = :app, options = {}
+        dir = Rails3::Assist::Artifact::Directory.send "#{type.to_s.singularize}_dir"
+        expr = options[:expr]
+        file_pattern = options[:pattern] || RYBY_FILES
+        pattern = "#{dir}/#{file_pattern}"
+        FileList[pattern].to_a.grep_it expr
+      end
+    
+      def all_files expr=nil
+        pattern = "#{Rails3::Assist::Directory::Root.root_dir}/**/*.*"
+        FileList[pattern].to_a.grep_it expr 
+      end  
+
+      def app_files expr=nil
+        rails_app_files(:app).grep_it expr
+      end  
+
+      # files_from :model, :controller, :matching => /user/
+      def files_from *types, &block
+        expr = last_option(types)[:matching]
+        the_files = types.inject([])  do |files, type|
+          method = :"#{type}_files"               
+          files_found = send(method, expr) if respond_to?(method)
+          files_found = Rails3::Assist::Artifact::Files.send(method, expr) if Rails3::Assist::Artifact::Files.respond_to?(method)
+          files + files_found
+        end.compact
+        yield the_files if block
+        the_files        
+      end
+
+      def with_files_from type, expr=nil, &block
+        method = "#{type}_files"
+        send method, expr, &block if respond_to?(method)
+      end
+
+
+      [:initializer, :db, :migration].each do |name|
+        class_eval %{
+          def #{name}_files expr=nil
+            files = rails_app_files :#{name}, :expr => expr
+            yield files if block_given?
+            files
+          end  
+        }
+      end
+
+      {:locale => :yml, :javascript => :js}.each_pair do |name, ext|
+        class_eval %{
+          def #{name}_files expr=nil
+            files = rails_app_files(:#{name}, :pattern => '**/*.#{ext}', :expr => expr)
+            yield files if block_given?
+            files
+          end
+        }
+      end
+
+      [:css, :sass].each do |ext|
+        class_eval %{
+          def #{ext}_files expr=nil
+            files = rails_app_files :stylesheets, :pattern => '**/*.#{ext}', :expr => expr
+            yield files if block_given?
+            files
+          end
+        }
+      end
+    end    
+    
+    include Methods
+    extend Methods
+  end # Files    
+end # App                  

data/lib/rails3_assist/namespaces.rb

@@ -0,0 +1,11 @@
+require 'sugar-high/module'
+
+module Rails3
+  module Assist
+    modules :app, :directory, :files, :file
+    modules :artifact do
+      nested_modules :directory, :files, :path
+    end
+  end
+end
+    

data/lib/rails3_assist/rspec/configure.rb

@@ -0,0 +1,2 @@
+require 'require_all'
+require_all File.dirname(__FILE__) + '/matchers'

data/lib/rails3_assist/rspec/matchers/have_app_config.rb

@@ -0,0 +1,49 @@
+# open application_file
+# see if there is the config.[statement] = [expr]
+
+module RSpec::Rails::ContentMatchers
+  class HaveAppConfig
+
+    use_rails_file_helpers :special # TODO !!!
+    
+    attr_reader :left_side, :right_side, :operator
+
+    def initialize statement_hash
+      @left_side, @right_side = *statement.first
+      @operator = statement.last[:op] || '='
+    end
+
+    # TODO: relative to root_path ?
+    def matches?(root_path=nil)      
+      content = read_application_file
+      return nil if content.empty?
+      
+      ls, rs, op = escape_all(left_side, right_side, operator)
+      (content =~ /config.#{ls}\s*#{op}\s*#{rs}/)
+    end
+
+    def escape_all *texts
+      texts.map{|t| Regexp.escape(t) }
+    end
+
+    def msg
+      "there to be the Application config statement '#{left_side} #{operator} #{right_side}' in config/application.rb"
+    end
+  
+    def failure_message
+      "Expected #{msg}" 
+    end 
+    
+    def negative_failure_message
+      super
+      "Did not expect #{msg}" 
+    end
+  end
+                    
+  # config.autoload_paths += %W(#{Rails.root}/lib)
+  # have_app_config :autoload_paths => '%W(#{Rails.root}/lib)', :op => '+='
+  def have_app_config statement_hash
+    HaveAppConfig.new statement_hash
+  end
+  
+end

data/lib/rails3_assist.rb

@@ -1,21 +1,30 @@
 require 'thor'
 require 'require_all'
+require 'fileutils'
+require 'rake'
 require 'active_support/inflector'
 
-module Rails
-  module Assist
-    def self.artifacts
-      [:observer, :controller, :helper, :mailer, :model, :migration]
-    end  
-    
-    class << self
-      attr_accessor :debug_on
-    end    
+require 'sugar-high/alias'
+require 'sugar-high/file'
+require 'sugar-high/regexp'
+
+require 'rails3_assist/namespaces'
+
+module Rails3::Assist
+  def self.artifacts
+    [:observer, :controller, :helper, :mailer, :model, :migration, :permit]
+  end
+  
+  class << self
+    attr_accessor :debug_on
   end
 end
 
-require 'rails3_assist/extensions/core_ext'
 require 'rails3_assist/rspec/macro'
+
 require 'rails3_assist/app'
-require_all File.dirname(__FILE__) + '/rails3_assist/artifact'
+require 'rails3_assist/directory'
+require 'rails3_assist/file'
+require 'rails3_assist/files'
+require 'rails3_assist/artifact'