rails_templater 0.0.2 → 0.1.1

data/.gitignore

@@ -1 +1,2 @@
+Gemfile.lock
 pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--fail-fast

data/CHANGELOG

@@ -0,0 +1,17 @@
+0.1.1 (January 30, 2011)
+  rails-templater choices are now agnostic
+  Add ActiveRecord as an ORM option
+  Add TestUnit as a Testing Framework option
+  Add Prototype as a JavaScript Framework option
+  Remarkable RSpec matchers are optional and are dependent on the RSpec recipe
+  Haml is an optional choice for your View Templates
+  Sass is an optional choice for composing Stylesheets
+  Compass is now dependent on the Sass recipe
+  Compass has three options: core, blueprint semantic, and blueprint basic
+  Cucumber is an optional choice for Integration Testing
+  
+0.0.2 (January 23, 2011)
+  Add a custom generator for FactoryGirl which uses the new 2.0.0 syntax
+
+0.0.1 (January 13, 2011)
+  First version

data/README.textile

@@ -0,0 +1,58 @@
+h1. Rails Templater
+
+Rails Templater is a gem which generates new Ruby on Rails 3 applications the way you want them. Based on your choices, Rails Templater will create an application configured correctly. For example, if you select Mongoid for an ODM and RSpec for your testing framework, Rails Templater will generate all necessary hooks to handle dropping your collections from MongoDB. The project was inspired by ffmike's "BigOldRailsTemplate":http://github.com/ffmike/BigOldRailsTemplate Rails 2 template project.
+
+h2. Install
+
+  @gem install rails_templater@
+
+h2. Usage
+
+At the command prompt, create a new Rails application using the @templater@ command:
+
+  @templater myapp_name@
+
+h2. Generated Application
+
+Rails Templater provides you with the following choices during application generation:
+
+h3. Database
+
+* "Mongoid":http://mongoid.org/ as your Object Document Mapper for MongoDB
+* ActiveRecord as your Object Relational Mapper for Relational Databases
+
+h3. Testing
+
+* "RSpec":http://github.com/rspec/rspec
+**  "Remarkable":http://github.com/remarkable/remarkable for ActiveModel RSpec matchers (optional)
+* TestUnit
+
+h4. Fixture Replacement
+
+* "FactoryGirl":http://github.com/thoughtbot/factory_girl (Dependent on RSpec recipe)
+
+h4. Integration Testing
+
+* "Cucumber":http://github.com/aslakhellesoy/cucumber-rails (optional)
+
+h3. JavaScript
+
+* "jQuery":http://jquery.com/
+* "Prototype":http://www.prototypejs.org/
+
+h3. Template Engine
+
+* ERB
+* "Haml":http://haml-lang.com (optional)
+
+h3. Stylesheets 
+
+* "Sass":http://sass-lang.com for generating CSS (optional)
+**  "Compass":http://compass-style.org as your stylesheet authoring framework (optional)
+
+    
+h2. Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix in a branch.
+* Send me a pull request.

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end

data/TODO.textile

@@ -1,7 +1,7 @@
 h1. TODO
 
-* Write a generator for FactoryGirl which uses the 2.0.0 syntax
-* Clean up questions to users during template run
-* Make choices agnostic
-* Add a choice to load a local configuration YAML with defaults for template input
-* Update Mongoid to RC once stabalized
+* Add more options for Fixture Replacement
+* Add some RVM support?
+* Devise recipe
+* SimpleForm recipe
+* Shoulda RSpec matchers for ActiveRecord

data/lib/rails_templater.rb

@@ -1,10 +1,19 @@
+require 'active_support/core_ext/string'
+
 module RailsTemplater
   extend self
-  
+
+  class NotSupportedError < Exception; end
+
   autoload :Cli, 'rails_templater/cli'
-  
-  def template_path
-    File.join(File.dirname(__FILE__), 'template', 'templater.rb')
+  autoload :FixtureReplacement, 'rails_templater/fixture_replacement'
+  autoload :JavaScriptFramework, 'rails_templater/javascript_framework'
+  autoload :Orm, 'rails_templater/orm'
+  autoload :Templater, 'rails_templater/templater'
+  autoload :TestingFramework, 'rails_templater/testing_framework'
+
+  def template_runner
+    File.join(File.dirname(__FILE__), 'template_framework', 'template_runner.rb')
   end
-  
+
 end

data/lib/rails_templater/cli.rb

@@ -6,7 +6,7 @@ module RailsTemplater
     desc "Generates a new Rails application with templater'"
 
     def run_templater
-      system("rails new #{application_name} -JOT -m #{RailsTemplater::template_path}")
+      system("rails new #{application_name} -O -m #{RailsTemplater::template_runner}")
     end
 
   end

data/lib/rails_templater/fixture_replacement.rb

@@ -0,0 +1,23 @@
+module RailsTemplater
+  class FixtureReplacement
+    
+    DEFAULT = :factory_girl
+    SUPPORTED_TYPES = [:factory_girl]
+    
+    def type
+      @type || DEFAULT 
+    end
+    
+    def type=(value)
+      raise NotSupportedError unless SUPPORTED_TYPES.include?(value)
+      @type = value
+    end
+    
+    SUPPORTED_TYPES.each do |type|
+      define_method "#{type}?" do
+        self.type == type
+      end
+    end
+    
+  end
+end

data/lib/rails_templater/javascript_framework.rb

@@ -0,0 +1,23 @@
+module RailsTemplater
+  class JavaScriptFramework
+    
+    DEFAULT = :jquery
+    SUPPORTED_TYPES = [:jquery, :prototype]
+    
+    def type
+      @type || DEFAULT 
+    end
+    
+    def type=(value)
+      raise NotSupportedError unless SUPPORTED_TYPES.include?(value)
+      @type = value
+    end
+    
+    SUPPORTED_TYPES.each do |type|
+      define_method "#{type}?" do
+        self.type == type
+      end
+    end
+    
+  end
+end

data/lib/rails_templater/orm.rb

@@ -0,0 +1,23 @@
+module RailsTemplater
+  class Orm
+    
+    DEFAULT = :mongoid
+    SUPPORTED_TYPES = [:active_record, :mongoid]
+
+    def type
+      @type || DEFAULT
+    end
+    
+    def type=(value)
+      raise NotSupportedError unless SUPPORTED_TYPES.include?(value)
+      @type = value
+    end
+    
+    SUPPORTED_TYPES.each do |type|
+      define_method "#{type}?" do
+        self.type == type
+      end
+    end      
+    
+  end
+end

data/lib/rails_templater/templater.rb

@@ -0,0 +1,49 @@
+module RailsTemplater
+  class Templater
+
+    attr_reader :post_bundler_strategies
+
+    def initialize
+      @post_bundler_strategies = []
+      @template_framework_path = File.join(File.dirname(__FILE__), '..', 'template_framework')
+    end
+
+    def fixture_replacement
+      @fixture_replacement ||= FixtureReplacement.new
+    end
+
+    def orm
+      @orm ||= Orm.new
+    end
+    
+    def javascript_framework
+      @javascript_framework ||= JavaScriptFramework.new
+    end
+
+    def post_bundler(&block)
+      @post_bundler_strategies << block
+    end
+
+    def recipe(name)
+      File.expand_path("recipes/#{name}.rb", @template_framework_path)
+    end
+
+    ['snippet', 'template'].each do |type|
+
+      define_method "#{type}_path" do |group|
+        File.expand_path("#{type.pluralize}/#{group}", @template_framework_path)
+      end
+
+      define_method "load_#{type}" do |name, group|
+        group_path = send("#{type}_path".to_sym, group)
+        File.read  File.expand_path(name, group_path)
+      end
+
+    end
+    
+    def testing_framework
+      @testing_framework ||= TestingFramework.new
+    end
+    
+  end
+end

data/lib/rails_templater/testing_framework.rb

@@ -0,0 +1,23 @@
+module RailsTemplater
+  class TestingFramework
+    
+    DEFAULT = :rspec
+    SUPPORTED_TYPES = [:rspec, :test_unit]
+    
+    def type
+      @type || DEFAULT
+    end
+    
+    def type=(value)
+      raise NotSupportedError unless SUPPORTED_TYPES.include?(value)
+      @type ||= value
+    end
+    
+    SUPPORTED_TYPES.each do |type|
+      define_method "#{type}?" do
+        self.type == type
+      end
+    end
+    
+  end
+end

data/lib/rails_templater/version.rb

@@ -1,3 +1,3 @@
 module RailsTemplater
-  VERSION = "0.0.2"
+  VERSION = "0.1.1"
 end

data/lib/template_framework/core_ext.rb

@@ -0,0 +1,15 @@
+module Rails
+  module Generators
+    module Actions
+     
+      def templater
+        @templater ||= RailsTemplater::Templater.new
+      end
+     
+      def execute_post_bundler_strategies
+        templater.post_bundler_strategies.each {|strategy| strategy.call }
+      end
+     
+    end
+  end
+end

data/lib/template_framework/recipes/active_record.rb

@@ -0,0 +1,5 @@
+gem 'sqlite3-ruby', :require => 'sqlite3'
+
+gsub_file 'config/application.rb', '# require "active_record/railtie"', 'require "active_record/railtie"'
+create_file 'config/database.yml', templater.load_template('config/database.yml', 'active_record')
+run 'cp config/database.yml config/database.yml.example'

data/lib/template_framework/recipes/cucumber.rb

@@ -0,0 +1,37 @@
+if yes?("\n[Integration Testing] Would you like to add integration testing with Cucumber? [y|n]: ", Thor::Shell::Color::BLUE)
+
+  gem 'capybara', '0.4.0', :group => :test
+  gem 'cucumber-rails', :group => :test
+  gem 'launchy', :group => :test
+
+  cucumber_generate_command = "cucumber:install --capybara"
+  cucumber_generate_command << ' --skip-database' if templater.orm.mongoid?
+  cucumber_generate_command << ' --rspec' if templater.testing_framework.rspec?
+  cucumber_generate_command << ' --testunit' if templater.testing_framework.test_unit?
+
+  templater.post_bundler do
+    generate cucumber_generate_command
+
+    gsub_file 'features/support/env.rb',
+      "require 'cucumber/rails/capybara_javascript_emulation' # Lets you click links with onclick javascript handlers without using @culerity or @javascript", ''
+
+    inject_into_file "features/support/env.rb",
+      "\nCapybara.save_and_open_page_path = 'tmp/capybara/'",
+      :after => 'Capybara.default_selector = :css'
+
+    if templater.testing_framework.rspec? && templater.fixture_replacement.factory_girl?
+      inject_into_file "features/support/env.rb", templater.load_snippet("factory_girl", 'cucumber'), :after => 'ActionController::Base.allow_rescue = false'
+    end
+
+    # Mongoid truncation strategy
+    if templater.orm.mongoid?
+      create_file 'features/support/hooks.rb', templater.load_template('features/support/hooks.rb', 'mongoid')
+
+      # Compliment to factory_girl step definitions
+      if templater.fixture_replacement.factory_girl?
+        create_file 'features/step_definitions/mongoid_steps.rb', templater.load_template('features/step_definitions/mongoid_steps.rb', 'mongoid')
+      end
+    end
+
+  end
+end

data/lib/{template → template_framework}/recipes/default.rb

@@ -4,14 +4,11 @@ remove_file "public/index.html"
 remove_file "public/robots.txt"
 remove_file "public/images/rails.png"
 
+# Create project files
 create_file 'README'
 create_file 'log/.gitkeep'
 create_file 'tmp/.gitkeep'
 
-gsub_file 'config/application.rb', 'require "rails/test_unit/railtie"', '# require "rails/test_unit/railtie"'
-
 get "http://html5shiv.googlecode.com/svn/trunk/html5.js", "public/javascripts/html5.js"
 
-git :init
-
-append_file '.gitignore', load_template('gitignore','git')
+apply templater.recipe('git')

data/lib/template_framework/recipes/factory_girl.rb

@@ -0,0 +1,11 @@
+if templater.testing_framework.rspec?
+  say("\nReplacing Fixtures with FactoryGirl\n", Thor::Shell::Color::YELLOW)
+  gem 'factory_girl_rails', '1.1.beta1', :group => :test
+
+  templater.post_bundler do
+    inject_into_file 'spec/spec_helper.rb', "\nrequire 'factory_girl'", :after => "require 'rspec/rails'"
+    
+    environment templater.load_snippet('generator', 'factory_girl')
+    directory File.expand_path('./../../generators', __FILE__), 'lib/generators'    
+  end
+end

data/lib/template_framework/recipes/git.rb

@@ -0,0 +1,3 @@
+git :init
+
+append_file '.gitignore', templater.load_template('gitignore','git')

data/lib/template_framework/recipes/haml.rb

@@ -0,0 +1,7 @@
+if yes?("\n[Template Engine] Would you like use Haml for your view templates? [y|n]: ", Thor::Shell::Color::BLUE)
+  gem 'haml'
+  gem "haml-rails"
+
+  remove_file 'app/views/layouts/application.html.erb'
+  create_file 'app/views/layouts/application.html.haml', templater.load_template('app/views/layouts/application.html.haml','haml')
+end

data/lib/template_framework/recipes/javascript_framework.rb

@@ -0,0 +1,18 @@
+say "\nWhich JavaScript Framework would you like to use?\n", Thor::Shell::Color::BLUE
+
+javascript_framework_options = {
+  'Option' => 'JavaScript Framework',
+  '1' => 'jquery',
+  '2' => 'Prototype'
+}
+
+print_table javascript_framework_options.to_a, :ident => 4
+
+javascript_framework_selection = ask("\nOption: ", Thor::Shell::Color::BLUE)
+if javascript_framework_selection.present?
+  templater.javascript_framework.type =  javascript_framework_options[javascript_framework_selection].underscore.to_sym
+end
+
+$stdout << "\n\n"
+
+apply templater.recipe('jquery') if templater.javascript_framework.jquery?

data/lib/template_framework/recipes/jquery.rb

@@ -0,0 +1,10 @@
+say("\nReplacing Prototype with JQuery as your JavaScript Framework\n", Thor::Shell::Color::YELLOW )
+
+gem 'jquery-rails'
+
+remove_file 'public/javascripts/rails.js'
+gsub_file 'config/application.rb', /(config.action_view.javascript_expansions\[:defaults\] = %w\(\))/, '# \1'
+
+templater.post_bundler do
+  generate 'jquery:install'
+end