rails_assist 0.4.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+
+gem "require_all",       "~> 1.2.0"
+gem "sugar-high",        "~> 0.3.7"
+gem "activesupport",     ">= 3.0.4"
+# gem "migration_assist",  "~> 0.1.7"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,204 @@
+# Rails Assistant
+
+Includes various helpers to assist operating on a Rails 3 application.
+
+## Install
+
+<code>gem install rails_assist</code>
+
+## File Assistants
+
+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
+* observer
+* permit
+* view
+
+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
+
+* read_[special]_file
+* remove_[special]_file
+* append_to_[special]_file
+* replace_in_[special]_file :where => ... :with => ...
+* remove_from_[special]_file
+
+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 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>RailsAssist::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 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.
+
+### 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 :controller, :model, :view, :permit</code>
+
+Aliases: *use_helpers* and *use_helper*
+
+Available helpers:
+
+Artifacts
+* controller
+* model
+* view
+* helper
+* observer
+* mailer
+* migration
+* permit
+
+Misc.
+* file
+* files
+* directory
+
+### Using Assistants
+
+<pre>	
+class MyGenerator < Rails::Generators:NamedBase
+  extend RailsAssist::UseMacro
+
+  use_orm :active_record
+  use_helpers :file, :files, :controller, :observer, :migration
+  ...
+end
+</pre>
+
+### Assistant in RSpec
+
+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.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/README.rdoc

@@ -0,0 +1,19 @@
+= rails_assist
+
+Description goes here.
+
+== Contributing to rails_assist
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rails_assist"
+  gem.summary = %Q{File operation helpers for Rails 3 artifacts}
+  gem.description = %Q{Basic file operation helpers for working with Rails 3 artifacts}
+  gem.email = "kmandrup@gmail.com"
+  gem.homepage = "http://github.com/kristianmandrup/rails3-assist"
+  gem.authors = ["Kristian Mandrup"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_assist #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/rails_assist.rb

@@ -0,0 +1,43 @@
+# require 'thor'
+require 'require_all'
+require 'fileutils'
+require 'rake'
+require 'active_support/inflector'
+
+require 'sugar-high/alias'
+require 'sugar-high/file'
+require 'sugar-high/regexp'
+require 'sugar-high/array'
+
+require 'rails_assist/namespaces'
+
+module RailsAssist
+  def self.artifacts
+    [:observer, :controller, :helper, :mailer, :model, :migration, :permit]
+  end
+
+  def self.specials type=nil
+    case type
+    when :config
+      [:initializer, :locale]
+    when :public
+      [:stylesheet, :javascript]
+    else
+      raise ArgumentError, "Unknown specials type #{type}. Specify :config or :public" if type && type != :all
+      [:initializer, :locale] + [:stylesheet, :javascript]
+    end
+  end
+  
+  class << self
+    attr_accessor :debug_on
+  end
+end
+
+require 'rails_assist/app'
+require 'rails_assist/directory'
+require 'rails_assist/file'
+require 'rails_assist/files'
+require 'rails_assist/artifact'
+require 'rails_assist/macro'
+
+

data/lib/rails_assist/app.rb

@@ -0,0 +1,13 @@
+module RailsAssist    
+  module App    
+    def create_empty_tmp *dir_types
+      dir_types.flatten.each do |dir_type|
+        dir = RailsAssist::Directory.rails_dir_for(dir_type)
+        FileUtils.mkdir_p dir
+      end
+    end
+    
+    extend self                              
+  end  
+end
+

data/lib/rails_assist/artifact.rb

@@ -0,0 +1,34 @@
+module RailsAssist::Artifact
+  module Methods
+    def helper_list
+      RailsAssist.artifacts + [:view]
+    end
+
+    def app_artifacts
+      [:controller, :mailer, :helper, :view, :model, :permit, :license, :validator]
+    end
+  
+    def rails_artifacts
+      @rails_artifacts ||= begin
+        files_methods = RailsAssist::Artifact::Files.instance_methods        
+        files_symbols = files_methods.grep(/_files$/).map{|f| f.to_s.gsub(/^(.*)_files/, '\1').to_sym }
+
+        # dir_methods = RailsAssist::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/rails_assist/artifact/directory.rb

@@ -0,0 +1,66 @@
+module RailsAssist::Artifact
+  module Directory
+    module Methods
+      DIR = RailsAssist::Directory
+      APP_DIR = RailsAssist::Directory::App
+      
+      # :controller, :mailer, :helper, :view, :model, :permit
+      #
+      # controller_dir, mailer_dir ...
+      RailsAssist::Artifact.app_artifacts.each do |name|
+        class_eval %{
+          def #{name}_dirpath options={}
+            [APP_DIR.app_dirpath(options), '#{name.to_s.pluralize}'].file_join
+          end
+
+          def #{name}_dir options={}
+            #{name}_dirpath(options).dir
+          end
+        } 
+      end    
+        
+      # initializer_dir, locale_dir
+      # stylesheet_dir, javascript_dir    
+      {:config => RailsAssist.specials(:config), :public => RailsAssist.specials(:public)}.each_pair do |container, names|
+        names.each do |name|
+          class_eval %{      
+            def #{name}_dirpath options={}
+              RailsAssist::Directory.#{container}_dir_for(:#{name.to_s.pluralize}, options).path
+            end  
+
+            def #{name}_dir options={}
+              #{name}_dirpath(options).dir
+            end
+          }
+        end
+      end
+
+      [:stylesheet, :javascript].each do |name|
+        class_eval %{      
+          def #{name}_dirpath options={}
+            RailsAssist::Directory.public_dir_for(:#{name.to_s.pluralize}, options).path
+          end
+        }
+      end
+      
+      def migration_dirpath options={}
+        [DIR.db_dir(options), 'migrate'].file_join
+      end
+
+      def migration_dir options={}
+        migration_dirpath(options).dir
+      end
+      
+      def observer_dirpath options={}
+        model_dir(options).path
+      end
+
+      def observer_dir options={}
+        observer_dirpath(options).dir
+      end
+    end
+
+    extend Methods
+    include Methods
+  end
+end