generator_spec 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+pkg/*
+spec/tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    generator_spec (0.0.1)
+      rails (~> 3.0)
+      rspec-rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.5.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  generator_spec!

data/README.md

@@ -0,0 +1,26 @@
+# Generator Spec
+
+Allows testing of Rails generators inside RSpec using standard Rails::Generators::TestCase assertion methods.
+
+# Usage
+
+Add 'generator_spec' to Gemfile and use just like you would test generators in test unit:
+
+    # spec/lib/generators/test/test_generator_spec.rb
+    
+    require "generator_spec/generator_example_group"
+    
+    describe TestGenerator do
+      include GeneratorSpec::GeneratorExampleGroup
+
+      destination File.expand_path("../../tmp", __FILE__)
+
+      before(:all) do
+        prepare_destination
+        run_generator
+      end
+
+      it "creates a test initializer" do
+        assert_file "config/initializers/test.rb", "# Initializer"
+      end
+    end

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/generator_spec.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "generator_spec/version"
+
+Gem::Specification.new do |s|
+  s.name        = "generator_spec"
+  s.version     = GeneratorSpec::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Steve Hodgkiss"]
+  s.email       = ["steve@hodgkiss.me.uk"]
+  s.homepage    = "https://github.com/stevehodgkiss/generator_spec"
+  s.summary     = %q{Test Rails generators with RSpec}
+  s.description = %q{Test Rails generators with RSpec}
+
+  s.rubyforge_project = "generator_spec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency "rails", "~> 3.0"
+  s.add_dependency "rspec-rails"
+end

data/lib/generator_spec/generator_example_group.rb

@@ -0,0 +1,252 @@
+require "rspec/rails"
+require "rails/generators/test_case"
+require "fileutils"
+
+# Adapted from Rails::Generators::TestCase
+# https://github.com/rails/rails/blob/master/railties/lib/rails/generators/test_case.rb
+
+module GeneratorSpec
+  module GeneratorExampleGroup
+    extend ActiveSupport::Concern
+    include RSpec::Rails::RailsExampleGroup
+    include FileUtils
+  
+    included do
+      class_attribute :destination_root, :current_path, :generator_class, :default_arguments
+      delegate :destination_root, :current_path, :generator_class, :default_arguments, :to => :'self.class'
+    
+      self.current_path = ::File.expand_path(Dir.pwd)
+      self.default_arguments = []
+    
+      setup :destination_root_is_set?, :ensure_current_path
+      teardown :ensure_current_path
+    
+      tests subject.call.class
+    end
+  
+    module ClassMethods
+      # Sets which generator should be tested:
+      #
+      #   tests AppGenerator
+      #
+      def tests(klass)
+        self.generator_class = klass
+      end
+
+      # Sets default arguments on generator invocation. This can be overwritten when
+      # invoking it.
+      #
+      #   arguments %w(app_name --skip-active-record)
+      #
+      def arguments(array)
+        self.default_arguments = array
+      end
+
+      # Sets the destination of generator files:
+      #
+      #   destination File.expand_path("../tmp", File.dirname(__FILE__))
+      #
+      def destination(path)
+        self.destination_root = path
+      end
+    end
+  
+    module InstanceMethods
+      # Captures the given stream and returns it:
+      #
+      #   stream = capture(:stdout){ puts "Cool" }
+      #   stream # => "Cool\n"
+      #
+      def capture(stream)
+        begin
+          stream = stream.to_s
+          eval "$#{stream} = StringIO.new"
+          yield
+          result = eval("$#{stream}").string
+        ensure
+          eval("$#{stream} = #{stream.upcase}")
+        end
+
+        result
+      end
+      alias :silence :capture
+
+      # Asserts a given file exists. You need to supply an absolute path or a path relative
+      # to the configured destination:
+      #
+      #   assert_file "config/environment.rb"
+      #
+      # You can also give extra arguments. If the argument is a regexp, it will check if the
+      # regular expression matches the given file content. If it's a string, it compares the
+      # file with the given string:
+      #
+      #   assert_file "config/environment.rb", /initialize/
+      #
+      # Finally, when a block is given, it yields the file content:
+      #
+      #   assert_file "app/controller/products_controller.rb" do |controller|
+      #     assert_instance_method :index, content do |index|
+      #       assert_match /Product\.all/, index
+      #     end
+      #   end
+      #
+      def assert_file(relative, *contents)
+        absolute = File.expand_path(relative, destination_root)
+        assert File.exists?(absolute), "Expected file #{relative.inspect} to exist, but does not"
+
+        read = File.read(absolute) if block_given? || !contents.empty?
+        yield read if block_given?
+
+        contents.each do |content|
+          case content
+            when String
+              assert_equal content, read
+            when Regexp
+              assert_match content, read
+          end
+        end
+      end
+      alias :assert_directory :assert_file
+
+      # Asserts a given file does not exist. You need to supply an absolute path or a
+      # path relative to the configured destination:
+      #
+      #   assert_no_file "config/random.rb"
+      #
+      def assert_no_file(relative)
+        absolute = File.expand_path(relative, destination_root)
+        assert !File.exists?(absolute), "Expected file #{relative.inspect} to not exist, but does"
+      end
+      alias :assert_no_directory :assert_no_file
+
+      # Asserts a given file does not exist. You need to supply an absolute path or a
+      # path relative to the configured destination:
+      #
+      #   assert_migration "db/migrate/create_products.rb"
+      #
+      # This method manipulates the given path and tries to find any migration which
+      # matches the migration name. For example, the call above is converted to:
+      #
+      #   assert_file "db/migrate/003_create_products.rb"
+      #
+      # Consequently, assert_migration accepts the same arguments has assert_file.
+      #
+      def assert_migration(relative, *contents, &block)
+        file_name = migration_file_name(relative)
+        assert file_name, "Expected migration #{relative} to exist, but was not found"
+        assert_file file_name, *contents, &block
+      end
+
+      # Asserts a given migration does not exist. You need to supply an absolute path or a
+      # path relative to the configured destination:
+      #
+      #   assert_no_file "config/random.rb"
+      #
+      def assert_no_migration(relative)
+        file_name = migration_file_name(relative)
+        assert_nil file_name, "Expected migration #{relative} to not exist, but found #{file_name}"
+      end
+
+      # Asserts the given class method exists in the given content. This method does not detect
+      # class methods inside (class << self), only class methods which starts with "self.".
+      # When a block is given, it yields the content of the method.
+      #
+      #   assert_migration "db/migrate/create_products.rb" do |migration|
+      #     assert_class_method :up, migration do |up|
+      #       assert_match /create_table/, up
+      #     end
+      #   end
+      #
+      def assert_class_method(method, content, &block)
+        assert_instance_method "self.#{method}", content, &block
+      end
+
+      # Asserts the given method exists in the given content. When a block is given,
+      # it yields the content of the method.
+      #
+      #   assert_file "app/controller/products_controller.rb" do |controller|
+      #     assert_instance_method :index, content do |index|
+      #       assert_match /Product\.all/, index
+      #     end
+      #   end
+      #
+      def assert_instance_method(method, content)
+        assert content =~ /def #{method}(\(.+\))?(.*?)\n  end/m, "Expected to have method #{method}"
+        yield $2.strip if block_given?
+      end
+      alias :assert_method :assert_instance_method
+
+      # Asserts the given attribute type gets translated to a field type
+      # properly:
+      #
+      #   assert_field_type :date, :date_select
+      #
+      def assert_field_type(attribute_type, field_type)
+        assert_equal(field_type, create_generated_attribute(attribute_type).field_type)
+      end
+
+      # Asserts the given attribute type gets a proper default value:
+      #
+      #   assert_field_type :string, "MyString"
+      #
+      def assert_field_default_value(attribute_type, value)
+        assert_equal(value, create_generated_attribute(attribute_type).default)
+      end
+
+      # Runs the generator configured for this class. The first argument is an array like
+      # command line arguments:
+      #
+      #   class AppGeneratorTest < Rails::Generators::TestCase
+      #     tests AppGenerator
+      #     destination File.expand_path("../tmp", File.dirname(__FILE__))
+      #     teardown :cleanup_destination_root
+      #
+      #     test "database.yml is not created when skipping Active Record" do
+      #       run_generator %w(myapp --skip-active-record)
+      #       assert_no_file "config/database.yml"
+      #     end
+      #   end
+      #
+      # You can provide a configuration hash as second argument. This method returns the output
+      # printed by the generator.
+      def run_generator(args=self.default_arguments, config={})
+        capture(:stdout) { self.generator_class.start(args, config.reverse_merge(:destination_root => destination_root)) }
+      end
+
+      # Instantiate the generator.
+      def generator(args=self.default_arguments, options={}, config={})
+        @generator ||= self.generator_class.new(args, options, config.reverse_merge(:destination_root => destination_root))
+      end
+
+      # Create a Rails::Generators::GeneratedAttribute by supplying the
+      # attribute type and, optionally, the attribute name:
+      #
+      #   create_generated_attribute(:string, 'name')
+      #
+      def create_generated_attribute(attribute_type, name = 'test')
+        Rails::Generators::GeneratedAttribute.new(name, attribute_type.to_s)
+      end
+
+      protected
+
+        def destination_root_is_set? #:nodoc:
+          raise "You need to configure your Rails::Generators::TestCase destination root." unless destination_root
+        end
+
+        def ensure_current_path #:nodoc:
+          cd current_path
+        end
+
+        def prepare_destination
+          rm_rf(destination_root)
+          mkdir_p(destination_root)
+        end
+
+        def migration_file_name(relative) #:nodoc:
+          absolute = File.expand_path(relative, destination_root)
+          dirname, file_name = File.dirname(absolute), File.basename(absolute).sub(/\.rb$/, '')
+          Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first
+        end
+    end
+  end
+end

data/lib/generator_spec/version.rb

@@ -0,0 +1,3 @@
+module GeneratorSpec
+  VERSION = "0.0.1"
+end

data/spec/generator_spec/generator_example_group_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe TestGenerator, "using normal assert methods" do
+  include GeneratorSpec::GeneratorExampleGroup
+
+  destination File.expand_path("../../tmp", __FILE__)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "creates a test initializer" do
+    assert_file "config/initializers/test.rb", "# Initializer"
+  end
+
+  it "creates a migration" do
+    assert_migration "db/migrate/create_tests.rb"
+  end
+
+  it "removes files" do
+    assert_no_file ".gitignore"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'rails/all'
+require 'rspec/rails'
+require 'generator_spec/generator_example_group'
+
+Dir[Pathname.new(File.expand_path("../", __FILE__)).join("support/*/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/test_generator/templates/initializer.rb

@@ -0,0 +1 @@
+# Initializer

data/spec/support/test_generator/templates/migration.rb

@@ -0,0 +1,3 @@
+class TestMigration < ActiveRecord::Migration
+  
+end

data/spec/support/test_generator/test_generator.rb

@@ -0,0 +1,11 @@
+class TestGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def copy_initializer
+    template "initializer.rb", "config/initializers/test.rb"
+  end
+  
+  def create_migration
+    template "migration.rb", "db/migrate/123_create_tests.rb"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: generator_spec
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Steve Hodgkiss
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Test Rails generators with RSpec
+email: 
+- steve@hodgkiss.me.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- generator_spec.gemspec
+- lib/generator_spec.rb
+- lib/generator_spec/generator_example_group.rb
+- lib/generator_spec/version.rb
+- spec/generator_spec/generator_example_group_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_generator/templates/initializer.rb
+- spec/support/test_generator/templates/migration.rb
+- spec/support/test_generator/test_generator.rb
+has_rdoc: true
+homepage: https://github.com/stevehodgkiss/generator_spec
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: generator_spec
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Test Rails generators with RSpec
+test_files: 
+- spec/generator_spec/generator_example_group_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_generator/templates/initializer.rb
+- spec/support/test_generator/templates/migration.rb
+- spec/support/test_generator/test_generator.rb