rails3_assist 0.2.5 → 0.2.7

data/README.markdown

@@ -1,77 +1,194 @@
 # Rails3 Assistant
 
-Includes various helpers to assist operating on a Rails 3 application, including various Rails 3 artifacts, such as migrations etc.
+Includes various helpers to assist operating on a Rails 3 application.
 
-## Development status
+## Install
 
-TODO specs: artifact
+<code>gem install rails3_assist</code>
 
-* files
-* directory
-
-## Rails Artifacts
-
-Rails assist also includes various artifact libraries to help operate on different Rails 3 artifacts. 
-These assist libraries mainly contain some common CRUD (Create, Read, Update, Delete) operations. 
-The same API is shared in all the artifact assist libraries.
-The following is a list of the main API, including an alias for each method. 
-
-* create_[x] - new_[x])
-* insert_into_[x] - update_[x]
-* read_model - [x]_content
-* remove_[x] - delete_[x]
-* remove_[x]s - delete_[x]s
+## File Assistants
 
-Rails 3 artifacts that have a CRUD assistant:
+There are file assistants for the following Rails 3 artifacts:
+* locale
+* javascript
+* stylesheet
+* controller
+* helper
+* view
+* model
+* mailer
+* observer
+* permit
+* view
 
+* [name]_file
+* [name]_files
+* create_[name]_file
+* remove_[name]_file
+* remove_all__[name]s
+* remove_[name]s
+
+Example usage:
+
+<pre>
+remove_locales 'blip.en', 'blip.dk'	
+remove_all_stylesheets
+create_stylesheet 'my_styles.css' do
+ %{
+  .mystyle {font: bold;}	
+}
+end
+remove_stylesheet 'my_styles.css'	
+	
+locale_files
+locale_files 'permit.dk'
+locale_files /permit/ do |files|
+  # ...
+end
+
+view_files :person 
+erb_view_files(:user).file_names.should include 'show.html.erb'
+haml_view_files(:user)
+</pre>
+
+## Directory Assistants
+
+There are dir helpers for the following 
+
+* app
+* config
+* db
+* public
+* lib
+* log
+* doc
+* test
+* spec
+
+* locale
+* initializer
+* javascript
+* stylesheet
 * controller
 * helper
+* view
+* model
 * mailer
-* migration (pending!)
-* model (insert bug!)
 * observer
+* permit
 * view
-* permit (NEW - used with cancan)
 
-## Model
+Example usage:
+
+<pre>
+	config_dir
+	observer_dir_
+	db_dir :root_path => MY_RAILS_ROOT
+	rails_dir_for :migrations
+	db_dir_for :migrations	
+	config_dir_for :initializers, :root_path => MY_RAILS_ROOT
+	app_dir_for :models
+</pre>
+
+## Special Rails mutators
+
+* insert_application_config
+* insert_before_application_init
+* insert_after_application_init
+
+Special file helpers:
+
+* application_file
+* environment_file
+* seed_file
 
-* create_model (new_model)
-* insert_into_model (update_model)
+* read_[special]_file
+* remove_[special]_file
+* append_to_[special]_file
+* replace_in_[special]_file :where => ... :with => ...
+* remove_from_[special]_file
 
-Create and insert for *model* operate according to the ORM currently used.
-The ORM used is specified by calling <code>use_orm :[orm]</code> fx <code>use_orm :active_record</code>
+Example
+
+<pre>
+remove_from_application_file /config.root = (\w+?)/ 
+append_to_seed_file do
+  %{
+  Person.new :name => 'Mike'
+}
+end
+</pre>
 
 ### Usage
 
-Set the root if not already set, then use the special assist/use methods to draw in the modules with all the goodies!
+Set the root if not already set, then use the special assist methods to include the modules with all the goodies!
+See the *Assistants* section below for more info on how to do this.
 
 ### Rails root
 
-You have to set the class variable <code>Rails::Assist::App.rails_root_dir</code> to the location of your Rails root directory if you are using this gem outside of Rails,
-Fx for testing purposes or something. It will default to use <code>Rails.root</code> if this class variable is not set to override it.
+You have to set the class variable <code>Rails::Assist::Directory.rails_root</code> to the location of your Rails root directory if you are using this gem outside of Rails, fx for testing purposes or something. 
+
+Note: If this variable is not set, it will assume it is used in a Rails app and therefore assume the root is  <code>Rails.root</code>.
 
-In the specs I use the *rails_root_dir* class variable to avoid having to set a Rails app specific variable, which I deemed unnecessary for most of the tests.
+In the specs of this projct, I use the *rails_root* class variable to avoid having to set a Rails app specific variable, which I deemed unnecessary for most of the tests.
 
-### Artifact assistants
+### Assistants
 
 Generators are often designed to create Rails 3 artifacts or update existing artifacts. It's often useful to include one or more Rails 3 artifact assistants along
 with a generator assistant (see above). 
 
 This combination greatly facilitates your work in developing the generator, as much of the heavy lifting will be done for you in the assistants.
+
 To use a specific assistant/helper, simply call:
 
 *assist_with [list of assistant symbols]*
 
 Example:
 
-<code>assist_with :app, :controller, :model, :view</code>
+<code>assist_with :controller, :model, :view, :permit</code>
 
 Aliases: *use_helpers* and *use_helper*
 
-## TODO
+Available helpers:
+
+Artifacts
+* controller
+* model
+* view
+* helper
+* observer
+* mailer
+* migration
+* permit
+
+Misc.
+* file
+* files
+* directory
+
+### Using Assistants
+
+<pre>	
+class MyGenerator < Rails::Generators:NamedBase
+  extend Rails3::Assist::UseMacro
+
+  use_orm :active_record
+  use_helpers :file, :files, :controller, :observer, :migration
+  ...
+end
+</pre>
+
+### Assistant in RSpec
 
-Refactor: split it up into smaller gems and modules to be loaded individually as the need arises.
+The assistants are preconfigured to be available within RSpec constructs. 
 
+<pre>	
+describe 'My Controller' do
+  use_helpers :directory, :files, :helper, :mailer
+  ...
+end
+</pre>
+	
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.7

data/lib/rails3_assist/directory.rb

@@ -5,11 +5,20 @@ module Rails3::Assist
   module Directory      
     class << self
       attr_accessor :rails_root
+      
+      def method_missing(sym, *args, &block)
+        Rails3::Assist::Artifact::Directory.send sym
+      end
     end    
 
     include Root
+    extend Root
+
     include App
+    extend App
+
     include Container    
+    extend Container
         
     # dir_for helpers
     # -------------------

data/lib/rails3_assist/file/special.rb

@@ -32,6 +32,14 @@ module Rails3::Assist::File
           def append_to_#{name}_file content=nil, &block
             File.append(#{name}_file, content, &block)
           end
+
+          def replace_in_#{name}_file options = {}, &block
+            File.replace_content_from(#{name}_file, options, &block)
+          end
+
+          def remove_from_#{name}_file content=nil, &block
+            File.remove_from(#{name}_file, content, &block)
+          end
         }
       end    
     end

data/lib/rails3_assist/files.rb

@@ -11,7 +11,7 @@ module Rails3::Assist
       RYBY_FILES = '**/*.rb'
       
       def rails_app_files type = :app, options = {}
-        dir = Rails3::Assist::Artifact::Directory.send "#{type.to_s.singularize}_dir"
+        dir = Rails3::Assist::Directory.send "#{type.to_s.singularize}_dir"
         expr = options[:expr]
         file_pattern = options[:pattern] || RYBY_FILES
         pattern = "#{dir}/#{file_pattern}"

data/lib/rails3_assist/rspec/configure.rb

@@ -1,2 +1,9 @@
 require 'require_all'
-require_all File.dirname(__FILE__) + '/matchers'
+
+module RSpec
+  module RailsApp
+    modules :content_matchers
+  end
+end
+
+# require_all File.dirname(__FILE__) + '/matchers'

data/lib/rails3_assist.rb

@@ -20,11 +20,11 @@ module Rails3::Assist
   end
 end
 
-require 'rails3_assist/rspec/macro'
-
 require 'rails3_assist/app'
 require 'rails3_assist/directory'
 require 'rails3_assist/file'
 require 'rails3_assist/files'
 require 'rails3_assist/artifact'
 
+require 'rails3_assist/rspec/configure'
+

data/rails3_assist.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails3_assist}
-  s.version = "0.2.5"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -41,8 +41,6 @@ Gem::Specification.new do |s|
      "lib/rails3_assist/files.rb",
      "lib/rails3_assist/namespaces.rb",
      "lib/rails3_assist/rspec/configure.rb",
-     "lib/rails3_assist/rspec/matchers/have_app_config.rb",
-     "lib/rails3_assist/rspec/matchers/have_special_file.rb",
      "rails3_assist.gemspec",
      "rails_generator.log",
      "spec/fixtures.rb",

data/spec/rails3_assist/artifact/files_spec.rb

@@ -3,11 +3,12 @@ require 'spec_helper'
 CLASS = Rails3::Assist::Artifact::Files
 
 class ArtDir
-  include CLASS
+  extend Rails3::Assist::UseMacro
+  use_helper :files  
 end
 
 describe Rails3::Assist::Artifact::Files do
-  # use_helper :directories
+  use_helper :directory
 
   before do
     Rails3::Assist::Directory.rails_root = fixtures_dir

data/spec/rails3_assist/directory_spec.rb

@@ -3,7 +3,8 @@ require 'spec_helper'
 CLASS = Rails3::Assist::Directory
 
 class RailsDir
-  include CLASS
+  extend Rails3::Assist::UseMacro
+  use_helper :directory
 end
 
 describe Rails3::Assist::Directory do

data/spec/rails3_assist/file_spec.rb

@@ -16,7 +16,7 @@ describe Rails3::Assist::File do
 
   describe '#initializer_file' do
     it "should return the initializer file 'mime_type' " do
-      CLASS.initializer_file('mime_type').should match /mime_type/
+      AppDir.new.initializer_file('mime_type').should match /mime_type/
     end
   end    
 

data/spec/rails3_assist/files_spec.rb

@@ -3,7 +3,8 @@ require 'spec_helper'
 CLASS = Rails3::Assist::Files
 
 class AppDir
-  include CLASS
+  extend Rails3::Assist::UseMacro
+  use_helper :files
 end
 
 describe Rails3::Assist::Files do
@@ -15,7 +16,7 @@ describe Rails3::Assist::Files do
 
   describe '#rails_app_files' do
     it "should return all :app files using default pattern" do
-      CLASS.rails_app_files(:model)
+      AppDir.new.rails_app_files(:model)
     end
   end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -113,8 +113,6 @@ files:
 - lib/rails3_assist/files.rb
 - lib/rails3_assist/namespaces.rb
 - lib/rails3_assist/rspec/configure.rb
-- lib/rails3_assist/rspec/matchers/have_app_config.rb
-- lib/rails3_assist/rspec/matchers/have_special_file.rb
 - rails3_assist.gemspec
 - rails_generator.log
 - spec/fixtures.rb

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

@@ -1,49 +0,0 @@
-# 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