technicalpickles-shoulda_generator 0.1.2 → 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Josh Nichols
+
+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

@@ -1,81 +1,79 @@
-# shoulda generators
+# Shoulda generators
 
-One night at a Boston Ruby hackfest, I finally got sick of using the Rails default generators, and have to hack them to meet my needs and tastes. This includes:
+One night at a Boston Ruby hackfest, I finally got sick of using the Rails default generators, and then having to twiddle them to meet my needs and tastes. This includes using things like:
 
  * [shoulda](http://thoughtbot.com/projects/shoulda)
- * [factory_girl](http://github.com/thoughtbot/factory_girl)
+ * [factory\_girl](http://github.com/thoughtbot/factory_girl)
  * [haml](http://haml.hamptoncatlin.com/)
  * [blueprint](http://code.google.com/p/blueprintcss/)
 
+The next morning, I was struck awake at 5am with the inspiration to start implementing it. shoulda\_generator is the result of this effort.
 
-The next morning, I was struck awake at 5am with the inspiration to start implementing it.
-
-## what you get
+## What you get
 
 ### shoulda\_model
 
- * works the same as the 'model' generator
- * a new model
- * a migration for the model
- * a factory using [factory_girl](http://github.com/thoughtbot/factory_girl)
- * a [shoulda](http://thoughtbot.com/projects/shoulda) unit test with a few simple 'should's
+ * A new model
+ * A migration for the model
+  * Skip using --skip-migration
+ * A factory defined with [factory_girl](http://github.com/thoughtbot/factory_girl)
+  * Skip using --skip-factory
+ * A [shoulda](http://thoughtbot.com/projects/shoulda) unit test with a few simple 'should's
 
 #### Prereqs:
 
  * [shoulda](http://thoughtbot.com/projects/shoulda) installed as a plugin
- * [factory_girl](http://github.com/thoughtbot/factory_girl) gem installed
-
-In `test/test_helper.rb`, include this:
-
-    require 'factory_girl'
-    Dir[File.join(RAILS_ROOT, 'test', 'factories', '*')].each do |file|
-      require file
-    end
+ * [factory\_girl](http://github.com/thoughtbot/factory_girl) gem installed
+ * [factory\_girl\_on\_rails](http://github.com/technicalpickles/factory_girl_on_rails) installed as a plugin
 
-### shoulda\_haml\_scaffold
+### shoulda\_scaffold
 
- * everything included in shoulda_model
- * a controller (sans unnecessary comments)
- * templates built written in [haml](http://haml.hamptoncatlin.com/)
- * a layout written in [haml](http://haml.hamptoncatlin.com/) and styled with [blueprint](http://code.google.com/p/blueprintcss/)
- * a helper
- * a shoulda functional test which uses the factory_girl factory
+ * Everything included in shoulda_model
+ * A controller (sans unnecessary comments)
+ * Choice of [haml](http://haml.hamptoncatlin.com/) (default) or ERB 
+   * Specify which with the --templating option
+ * Simple layout styled with blueprint
+   * Skip using --skip-layout
+ * A helper
+ * A shoulda functional test using factory_girl factory, using should\_be\_restful or not
+   * Specify with --functional-test-style, accepts basic and should\_be\_restful
 
-Prereqs:
+#### Prereqs:
 
  * [shoulda](http://thoughtbot.com/projects/shoulda) installed as a plugin
- * [factory_girl](http://github.com/thoughtbot/factory_girl) gem installed
- * [haml](http://haml.hamptoncatlin.com/) gem installed on the system, and the project has been hamlified using  `haml --rails` on the project
- * the code snippet above for `test/test_helper.rb`
-
-## getting it
+ * [factory\_girl](http://github.com/thoughtbot/factory_girl) gem installed
+ * [factory\_girl\_on\_rails](http://github.com/technicalpickles/factory_girl_on_rails) installed as a plugin
+ * [haml](http://haml.hamptoncatlin.com/) gem installed on the system, and the project has been hamlified using  `haml --rails`
 
-You can install it as a plugin for the time being. I plan on having a gem soon enough.
+## Getting it
 
-With Rails 2.1, you can do:
+shoulda\_generator is available as a gem via [GitHub](http://github.com). If you haven't done so already, you need to setup GitHub as a gem source:
 
-    $ script/plugin install git://github.com/technicalpickles/shoulda-generators.git
+    $ gem sources -a http://gems.github.com
+    
+Now you can install it:
+    
+    $ sudo gem install technicalpickles-shoulda_generator
 
-... or better yet, use piston 1.9.x...
-
-    $ piston install git://github.com/technicalpickles/shoulda-generators.git vendor/plugins/shoulda-generators
-
-## using it
+## Example usage
 
 Usage is the same as the default Rails generators.
 
     $ script/generate shoulda_model post title:string body:text published:boolean 
-    $ script/generate shoulda_scaffold post title:string body:text published:boolean 
+    $ script/generate shoulda_scaffold post title:string body:text published:boolean
+
+
+## Configuring it
 
-## developing it
+You can override the default values for templating and functional\_test\_style by placing a .shoulda\_generator  file in your home directory.
 
-Make a checkout somewhere:
+Here's an example `.shoulda_generator`:
 
-    $ git clone git://github.com/technicalpickles/shoulda_generator.git
+    :templating: erb              # supported options: haml|erb
+    :functional_test_syle: basic  # supported options: should_be_restful|basic
 
-Add symlinks so that Rails will pickup the generators from your checkout:
+## Developing it
 
-    $ mkdir -p ~/.rails/generators
-    $ ln -s shoulda_generator/*_generator ~/.rails/generators
+Source is hosted on GitHub: [http://github.com/technicalpickles/shoulda_generator/tree/master](http://github.com/technicalpickles/shoulda_generator/tree/master)
 
-Send pull requests to me, and I'll take a look at them.
+You can do the usual fork/commit cycle until you have something ready to share. Send pull requests my way.

data/Rakefile

@@ -1,10 +1,26 @@
 require 'rake'
-require 'echoe'
+require 'rake/testtask'
 
-Echoe.new('shoulda_generator') do |p|
-  p.author = 'Josh Nichols'
-  p.email = 'josh@technicalpickles.com'
-  p.summary = 'Generators which create tests using shoulda'
-  p.url = 'http://github.com/technicalpickles/shoulda_generator'
-  p.version = '0.1.2'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "shoulda_generator"
+    s.summary = "Generators which create tests using shoulda"
+    s.email = "josh@technicalpickles.com"
+    s.homepage = "http://github.com/technicalpickles/shoulda_generator"
+    s.description = "Generators which create tests using shoulda"
+    s.authors = ["Josh Nichols"]
+    s.files =  FileList["[A-Z]*", "{generators,lib,test}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc 'Test by default'
+task :default => :test

data/TODO

@@ -0,0 +1,8 @@
+ * When installing, there's an warning:
+ 
+    Successfully installed shoulda_generator-0.2.0
+    1 gem installed
+    Installing ri documentation for shoulda_generator-0.2.0...
+    File not found: lib
+ 
+ * Support using resource_controller?

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+patch: 0
+major: 0
+minor: 2

data/test/fixtures/about_yml_plugins/bad_about_yml/about.yml

@@ -0,0 +1 @@
+# an empty YAML file - any content in here seems to get parsed as a string

data/test/fixtures/about_yml_plugins/bad_about_yml/init.rb

@@ -0,0 +1 @@
+# intentionally empty

data/test/fixtures/about_yml_plugins/plugin_without_about_yml/init.rb

@@ -0,0 +1 @@
+# intentionally empty

data/test/fixtures/eager/zoo.rb

@@ -0,0 +1,3 @@
+class Zoo
+  include ReptileHouse
+end

data/test/fixtures/eager/zoo/reptile_house.rb

@@ -0,0 +1,2 @@
+module Zoo::ReptileHouse
+end

data/test/fixtures/environment_with_constant.rb

@@ -0,0 +1 @@
+$initialize_test_set_from_env = 'success'

data/test/fixtures/lib/generators/working/working_generator.rb

@@ -0,0 +1,2 @@
+class WorkingGenerator < Rails::Generator::NamedBase
+end

data/test/fixtures/plugins/alternate/a/generators/a_generator/a_generator.rb

@@ -0,0 +1,4 @@
+class AGenerator < Rails::Generator::Base
+  def manifest
+  end
+end

data/test/fixtures/plugins/default/gemlike/init.rb

@@ -0,0 +1 @@
+raise 'This init.rb should not be evaluated because rails/init.rb exists'

data/test/fixtures/plugins/default/gemlike/lib/gemlike.rb

@@ -0,0 +1,2 @@
+module Gemlike
+end

data/test/fixtures/plugins/default/gemlike/rails/init.rb

@@ -0,0 +1,7 @@
+# I have access to my directory and the Rails config.
+raise 'directory expected but undefined in init.rb' unless defined? directory
+raise 'config expected but undefined in init.rb' unless defined? config
+
+# My lib/ dir must be in the load path.
+require 'gemlike'
+raise 'missing mixin from my lib/ dir' unless defined? Gemlike

data/test/fixtures/plugins/default/stubby/about.yml

@@ -0,0 +1,2 @@
+author: Plugin Author
+version: 1.0.0

data/test/fixtures/plugins/default/stubby/generators/stubby_generator/stubby_generator.rb

@@ -0,0 +1,4 @@
+class StubbyGenerator < Rails::Generator::Base
+  def manifest
+  end
+end

data/test/fixtures/plugins/default/stubby/init.rb

@@ -0,0 +1,7 @@
+# I have access to my directory and the Rails config.
+raise 'directory expected but undefined in init.rb' unless defined? directory
+raise 'config expected but undefined in init.rb' unless defined? config
+
+# My lib/ dir must be in the load path.
+require 'stubby_mixin'
+raise 'missing mixin from my lib/ dir' unless defined? StubbyMixin

data/test/fixtures/plugins/default/stubby/lib/stubby_mixin.rb

@@ -0,0 +1,2 @@
+module StubbyMixin
+end

data/test/rails_generators/shoulda_model_generator_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+
+class ShouldaModelGeneratorTest < GeneratorTestCase
+  context "running the default generator" do
+    setup do
+      run_generator('shoulda_model', %w(Product name:string supplier_id:integer created_at:timestamp))
+    end
+    
+    should_generate_model :product
+    should_generate_factory :product
+    should_generate_unit_test :product
+    should_generate_migration :create_products
+    
+    should "generate migration" do
+      assert_generated_migration :create_products do |t|
+        assert_generated_column t, :name, :string
+        assert_generated_column t, :supplier_id, :integer
+        assert_generated_column t, :created_at, :timestamp
+      end
+    end
+  end
+  
+  context "running the generator, when skipping factory and migration" do
+    setup do
+      run_generator('shoulda_model', %w(Product name:string supplier_id:integer created_at:timestamp --skip-factory))
+    end
+    
+    should_generate_model :product
+    should_not_generate_factory :product
+    should_generate_unit_test :product
+    should_generate_migration :create_products
+    
+    should "not generate migration" do
+      assert_skipped_migration :create_products
+    end
+  end
+  
+end

data/test/shoulda_macros/generator_macros.rb

@@ -0,0 +1,36 @@
+class Test::Unit::TestCase
+  class << self
+    def should_generate_model(model)
+      should "generate #{model} model" do
+        assert_generated_model_for(model) do |body|
+          yield body if block_given?
+        end
+      end
+    end
+
+    def should_generate_factory(model)
+      should "generate #{model} factory" do
+        assert_generated_factory_for(model)
+      end
+    end
+  
+    def should_generate_unit_test(model)
+      should "generate #{model} unit test" do
+        assert_generated_unit_test_for(model)
+      end
+    end
+  
+    def should_generate_migration(migration)
+      should "generate a #{migration} migration" do
+        assert_generated_migration migration
+      end
+    end
+    
+    def should_not_generate_factory(model)
+      should "not generate #{model} factory" do
+        deny_generated_factory_for(:product)
+      end
+    end
+
+  end
+end

data/test/stolen_from_railties.rb

@@ -0,0 +1,288 @@
+require 'test/unit'
+require 'fileutils'
+
+# Mock out what we need from AR::Base
+module ActiveRecord
+  class Base
+    class << self
+      attr_accessor :pluralize_table_names, :timestamped_migrations
+    end
+    self.pluralize_table_names = true
+    self.timestamped_migrations = true
+  end
+
+  module ConnectionAdapters
+    class Column
+      attr_reader :name, :default, :type, :limit, :null, :sql_type, :precision, :scale
+
+      def initialize(name, default, sql_type = nil)
+        @name = name
+        @default = default
+        @type = @sql_type = sql_type
+      end
+
+      def human_name
+        @name.humanize
+      end
+    end
+  end
+end
+
+# Mock up necessities from ActionView
+module ActionView
+  module Helpers
+    module ActionRecordHelper; end
+    class InstanceTag; end
+  end
+end
+
+# Set RAILS_ROOT appropriately fixture generation
+tmp_dir = "#{File.dirname(__FILE__)}/fixtures/tmp"
+
+if defined? RAILS_ROOT
+  RAILS_ROOT.replace tmp_dir
+else
+  RAILS_ROOT = tmp_dir
+end
+FileUtils.mkdir_p RAILS_ROOT
+
+# $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
+require 'initializer'
+
+# Mocks out the configuration
+module Rails
+  def self.configuration
+    Rails::Configuration.new
+  end
+end
+
+require 'rails_generator'
+
+class GeneratorTestCase < Test::Unit::TestCase
+  include FileUtils
+
+  def setup
+    ActiveRecord::Base.pluralize_table_names = true
+
+    mkdir_p "#{RAILS_ROOT}/app/views/layouts"
+    mkdir_p "#{RAILS_ROOT}/config"
+    mkdir_p "#{RAILS_ROOT}/db"
+    mkdir_p "#{RAILS_ROOT}/test/fixtures"
+    mkdir_p "#{RAILS_ROOT}/public/stylesheets"
+
+    File.open("#{RAILS_ROOT}/config/routes.rb", 'w') do |f|
+      f << "ActionController::Routing::Routes.draw do |map|\n\nend"
+    end
+  end
+
+  def teardown
+    rm_rf "#{RAILS_ROOT}/app"
+    rm_rf "#{RAILS_ROOT}/test"
+    rm_rf "#{RAILS_ROOT}/config"
+    rm_rf "#{RAILS_ROOT}/db"
+    rm_rf "#{RAILS_ROOT}/public"
+  end
+
+  def test_truth
+    # don't complain, test/unit
+  end
+
+  # Instantiates the Generator.
+  def build_generator(name, params)
+    Rails::Generator::Base.instance(name, params)
+  end
+
+  # Runs the +create+ command (like the command line does).
+  def run_generator(name, params)
+    silence_generator do
+      build_generator(name, params).command(:create).invoke!
+    end
+  end
+
+  # Silences the logger temporarily and returns the output as a String.
+  def silence_generator
+    logger_original = Rails::Generator::Base.logger
+    myout = StringIO.new
+    Rails::Generator::Base.logger = Rails::Generator::SimpleLogger.new(myout)
+    yield if block_given?
+    Rails::Generator::Base.logger = logger_original
+    myout.string
+  end
+
+  # Asserts that the given controller was generated.
+  # It takes a name or symbol without the <tt>_controller</tt> part and an optional super class.
+  # The contents of the class source file is passed to a block.
+  def assert_generated_controller_for(name, parent = "ApplicationController")
+    assert_generated_class "app/controllers/#{name.to_s.underscore}_controller", parent do |body|
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given model was generated.
+  # It takes a name or symbol and an optional super class.
+  # The contents of the class source file is passed to a block.
+  def assert_generated_model_for(name, parent = "ActiveRecord::Base")
+    assert_generated_class "app/models/#{name.to_s.underscore}", parent do |body|
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given helper was generated.
+  # It takes a name or symbol without the <tt>_helper</tt> part.
+  # The contents of the module source file is passed to a block.
+  def assert_generated_helper_for(name)
+    assert_generated_module "app/helpers/#{name.to_s.underscore}_helper" do |body|
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given functional test was generated.
+  # It takes a name or symbol without the <tt>_controller_test</tt> part and an optional super class.
+  # The contents of the class source file is passed to a block.
+  def assert_generated_functional_test_for(name, parent = "ActionController::TestCase")
+    assert_generated_class "test/functional/#{name.to_s.underscore}_controller_test",parent do |body|
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given unit test was generated.
+  # It takes a name or symbol without the <tt>_test</tt> part and an optional super class.
+  # The contents of the class source file is passed to a block.
+  def assert_generated_unit_test_for(name, parent = "ActiveSupport::TestCase")
+    assert_generated_class "test/unit/#{name.to_s.underscore}_test", parent do |body|
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given file was generated.
+  # The contents of the file is passed to a block.
+  def assert_generated_file(path)
+    assert_file_exists(path)
+    File.open("#{RAILS_ROOT}/#{path}") do |f|
+      yield f.read if block_given?
+    end
+  end
+
+  # asserts that the given file exists
+  def assert_file_exists(path)
+    assert File.exist?("#{RAILS_ROOT}/#{path}"),
+      "The file '#{RAILS_ROOT}/#{path}' should exist"
+  end
+
+  # Asserts that the given class source file was generated.
+  # It takes a path without the <tt>.rb</tt> part and an optional super class.
+  # The contents of the class source file is passed to a block.
+  def assert_generated_class(path, parent = nil)
+    # FIXME: Sucky way to detect namespaced classes
+    if path.split('/').size > 3
+      path =~ /\/?(\d+_)?(\w+)\/(\w+)$/
+      class_name = "#{$2.camelize}::#{$3.camelize}"
+    else
+      path =~ /\/?(\d+_)?(\w+)$/
+      class_name = $2.camelize
+    end
+
+    assert_generated_file("#{path}.rb") do |body|
+      assert_match /class #{class_name}#{parent.nil? ? '':" < #{parent}"}/, body, "the file '#{path}.rb' should be a class"
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given module source file was generated.
+  # It takes a path without the <tt>.rb</tt> part.
+  # The contents of the class source file is passed to a block.
+  def assert_generated_module(path)
+    # FIXME: Sucky way to detect namespaced modules
+    if path.split('/').size > 3
+      path =~ /\/?(\w+)\/(\w+)$/
+      module_name = "#{$1.camelize}::#{$2.camelize}"
+    else
+      path =~ /\/?(\w+)$/
+      module_name = $1.camelize
+    end
+
+    assert_generated_file("#{path}.rb") do |body|
+      assert_match /module #{module_name}/, body, "the file '#{path}.rb' should be a module"
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given CSS stylesheet file was generated.
+  # It takes a path without the <tt>.css</tt> part.
+  # The contents of the stylesheet source file is passed to a block.
+  def assert_generated_stylesheet(path)
+    assert_generated_file("public/stylesheets/#{path}.css") do |body|
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given YAML file was generated.
+  # It takes a path without the <tt>.yml</tt> part.
+  # The parsed YAML tree is passed to a block.
+  def assert_generated_yaml(path)
+    assert_generated_file("#{path}.yml") do |body|
+      yaml = YAML.load(body)
+      assert yaml, 'YAML data missing'
+      yield yaml if block_given?
+    end
+  end
+
+  # Asserts that the given fixtures YAML file was generated.
+  # It takes a fixture name without the <tt>.yml</tt> part.
+  # The parsed YAML tree is passed to a block.
+  def assert_generated_fixtures_for(name)
+    assert_generated_yaml "test/fixtures/#{name.to_s.underscore}" do |yaml|
+      yield yaml if block_given?
+    end
+  end
+
+  # Asserts that the given views were generated.
+  # It takes a controller name and a list of views (including extensions).
+  # The body of each view is passed to a block.
+  def assert_generated_views_for(name, *actions)
+    actions.each do |action|
+      assert_generated_file("app/views/#{name.to_s.underscore}/#{action}") do |body|
+        yield body if block_given?
+      end
+    end
+  end
+
+  def assert_generated_migration(name, parent = "ActiveRecord::Migration")
+    file = Dir.glob("#{RAILS_ROOT}/db/migrate/*_#{name.to_s.underscore}.rb").first
+    file = file.match(/db\/migrate\/[0-9]+_\w+/).to_s
+    assert_generated_class file, parent do |body|
+      assert_match /timestamps/, body, "should have timestamps defined"
+      yield body if block_given?
+    end
+  end
+
+  # Asserts that the given migration file was not generated.
+  # It takes the name of the migration as a parameter.
+  def assert_skipped_migration(name)
+    migration_file = "#{RAILS_ROOT}/db/migrate/001_#{name.to_s.underscore}.rb"
+    assert !File.exist?(migration_file), "should not create migration #{migration_file}"
+  end
+
+  # Asserts that the given resource was added to the routes.
+  def assert_added_route_for(name)
+    assert_generated_file("config/routes.rb") do |body|
+      assert_match /map.resources :#{name.to_s.underscore}/, body,
+        "should add route for :#{name.to_s.underscore}"
+    end
+  end
+
+  # Asserts that the given methods are defined in the body.
+  # This does assume standard rails code conventions with regards to the source code.
+  # The body of each individual method is passed to a block.
+  def assert_has_method(body, *methods)
+    methods.each do |name|
+      assert body =~ /^  def #{name}(\(.+\))?\n((\n|   .*\n)*)  end/, "should have method #{name}"
+      yield(name, $2) if block_given?
+    end
+  end
+
+  # Asserts that the given column is defined in the migration.
+  def assert_generated_column(body, name, type)
+    assert_match /t\.#{type.to_s} :#{name.to_s}/, body, "should have column #{name.to_s} defined"
+  end
+end