dummier 0.2.4 → 0.3.0

data/.travis.yml

@@ -1,6 +1,6 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
   - rbx
-  - rbx-2.0
   - ree

data/README.md

@@ -10,83 +10,104 @@ Dummier is simple; just run the binary from your gem's root directory and it wil
 
 To catch the hooks, just create appropriately named files in `test/dummy_hooks` inside your gem. See **Hooks** below for more info.
 
-
+------------------------------------------------------------------------------
 Installation
-------------
+------------------------------------------------------------------------------
 
 To install from RubyGems:
 
-    gem install dummier
+```bash
+gem install dummier
+```
+
 
 To install with bundler:
 
-    gem 'dummier', '>= 0.2.4'
+```ruby
+gem 'dummier', '>= 0.3.0'
+```
+
 
 To package for development in your gemspec:
-    
-    s.add_development_dependency('dummier', '>= 0.2.4')
+
+```ruby    
+s.add_development_dependency('dummier', '>= 0.3.0')
+```
     
     
+------------------------------------------------------------------------------
 Usage
------
+------------------------------------------------------------------------------
 
 After you've installed Dummier, just `cd` into the gem your developing and run the binary:
 
-    dummier
+```bash
+dummier
+```
     
 If you're in a gem that uses bundler, you may have to run the binary with `bundle exec`: 
 
-    bundle exec dummier
-    
+```bash
+bundle exec dummier
+```
 
+
+------------------------------------------------------------------------------
 Hooks
------
+------------------------------------------------------------------------------
     
-Dummier calls the following hooks along the way:
+Dummier calls the following hooks along the way, in this order:
 
-    before_delete
-    before_app_generator
-    after_app_generator
-    before_migrate
-    after_migrate
-    
-    
-Place appropriately named files ) in `test/dummy_hooks` and dummier will find and execute them automatically! 
+1. before_delete
+2. before_app_generator
+3. after_app_generator
+4. before_migrate
+5. after_migrate
 
-You can use [Rails::Generators::Actions](http://api.rubyonrails.org/classes/Rails/Generators/Actions.html) as well as [Thor::Actions](http://textmate.rubyforge.org/thor/Thor/Actions.html) in your hooks. Also, since hooks are just `eval`'d into the [Dummer::AppGenerator](http://rubydoc.info/gems/dummier/0.2.2/Dummier/AppGenerator), you have access to all of [those methods](http://rubydoc.info/gems/dummier/0.2.2/Dummier/AppGenerator) as well. 
+ 
+Place appropriately named files in `test/dummy_hooks` and dummier will find and execute them automatically! 
+
+You can use [Rails::Generators::Actions](http://api.rubyonrails.org/classes/Rails/Generators/Actions.html) as well as [Thor::Actions](http://textmate.rubyforge.org/thor/Thor/Actions.html) in your hooks. Also, since hooks are just `eval`'d into the [Dummer::AppGenerator](http://rubydoc.info/gems/dummier/0.3.0/Dummier/AppGenerator), you have access to all of [those methods](http://rubydoc.info/gems/dummier/0.3.0/Dummier/AppGenerator) as well. 
     
+If a hook throws an error, Dummier will raise a `Dummier::HookException` and exit immediately. 
+
     
 ### Simple Example
 
-Here's a `before_migrate.rb` hook that will install [Spree Commerce](https://github.com/spree/spree) by running some rake commands before migrating the `test/dummy` database.
+Here's a `before_migrate.rb` hook that will install [Spree Commerce](https://github.com/spree/spree) by running a generator before migrating the `test/dummy` database.
+
+```ruby
+# test/dummy_hooks/before_migrate.rb
+run "rails g spree:install"
+```
 
-    # test/dummy_hooks/before_migrate.rb
-    say_status "installing", "spree_core, spree_auth and spree_sample"
-    rake "spree_core:install spree_auth:install spree_sample:install"
-    
     
 ### More Complex Example
 
 Here's an example taken from [has_magick_title](https://github.com/citrus/has_magick_title):
 
-    # test/dummy_hooks/after_app_generator.rb
-    run "rails g scaffold post title:string"
-    
-    gsub_file "app/models/post.rb", "end", %(
-      has_magick_title
-      
-    end)
-    
-    gsub_file "config/routes.rb", "resources :posts", %(
-      resources :posts
-      root :to => "posts#index")
-    
-    gsub_file "app/views/posts/show.html.erb", "<%= @post.title %>", %(
-      <%= magick_title_for @post %>)
 
+```ruby
+# test/dummy_hooks/after_app_generator.rb
+run "rails g scaffold post title:string"
+
+gsub_file "app/models/post.rb", "end", %(
+  has_magick_title
+  
+end)
 
+gsub_file "config/routes.rb", "resources :posts", %(
+  resources :posts
+  root :to => "posts#index")
+
+gsub_file "app/views/posts/show.html.erb", "<%= @post.title %>", %(
+  <%= magick_title_for @post %>)
+```
+
+
+------------------------------------------------------------------------------
 Testing
--------
+------------------------------------------------------------------------------
 
 To get setup for testing, clone this repo, bundle up and run rake.
 
@@ -99,8 +120,13 @@ To get setup for testing, clone this repo, bundle up and run rake.
 Enjoy!
 
 
+------------------------------------------------------------------------------
 Change Log
-----------
+------------------------------------------------------------------------------
+
+**0.3.0 - 2012/1/26**
+
+* exit and raise a Dummier::HookException when a hook raises an exception
 
 
 **0.2.4 - 2011/9/7**
@@ -152,15 +178,17 @@ Change Log
 * it exists!
 
 
+------------------------------------------------------------------------------
 Contributors
-------------
+------------------------------------------------------------------------------
 
 - Spencer Steffen ([@citrus](https://github.com/citrus))
 - Fritz Thielemann ([@fritzek](https://github.com/fritzek))
 - [@holdensmagicalunicorn](https://github.com/holdensmagicalunicorn)
 
 
+------------------------------------------------------------------------------
 License
--------
+------------------------------------------------------------------------------
 
 Copyright (c) 2011 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.

data/bin/dummier

@@ -4,6 +4,6 @@ $:.unshift File.expand_path("../../lib", __FILE__)
 require 'dummier'
 
 dir = (ARGV.shift || `pwd`).strip
-puts "Getting dumb in #{dir.inspect}"
+puts "Running dummier from #{dir.inspect}"
 
 Dummier::AppGenerator.new(dir).run!

data/dummier.gemspec

@@ -3,6 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 require "dummier/version"
 
 Gem::Specification.new do |s|
+
   s.name        = "dummier"
   s.version     = Dummier::VERSION
   s.platform    = Gem::Platform::RUBY
@@ -21,7 +22,8 @@ Gem::Specification.new do |s|
   
   s.add_dependency('rails', '>= 3.0.0')
   
-  s.add_development_dependency('shoulda',        '>= 2.11.3')
-  s.add_development_dependency('sqlite3',        '>= 1.3.3')
-   
+  s.add_development_dependency('minitest',        '>= 2.0.0')
+  s.add_development_dependency('minitest_should', '>= 0.3.1')
+  s.add_development_dependency('sqlite3',         '>= 1.3.3')
+  
 end

data/lib/dummier.rb

@@ -1,7 +1,8 @@
 require 'dummier/app_generator'
+require 'dummier/version'
 
 module Dummier 
   
-  # just a generator!
-  
+  class HookException < Exception; end
+    
 end

data/lib/dummier/app_generator.rb

@@ -21,7 +21,7 @@ module Dummier
       @root_path = File.expand_path(root)
       @destination_stack = []
       @options = defaults.merge(options)
-      self.source_paths << File.join(root_path, "test", "dummy_hooks", "templates")      
+      self.source_paths << File.join(root_path, "test/dummy_hooks/templates")
       self.destination_root = File.join(test_path, name)
       raise "Invalid directory!" unless File.directory?(@root_path)
     end
@@ -80,7 +80,10 @@ module Dummier
         eval File.read(file) if File.exists?(file)
       rescue Exception => e
         say_status "failed", "#{hook_name} raised an exception", :red
+        say "*" * 60, :red
         say e.message.strip + "\n", :red
+        say e.backtrace.join("\n"), :red
+        raise ::Dummier::HookException, "Quitting, #{hook_name} raised an exception."        
       end
     end
     

data/lib/dummier/version.rb

@@ -1,3 +1,3 @@
 module Dummier
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/test/dummy_gem/test/erroneous_dummy_hooks/before_app_generator.rb

@@ -0,0 +1 @@
+HookTestHelper.register :before_app_generator

data/test/dummy_gem/test/erroneous_dummy_hooks/before_delete.rb

@@ -0,0 +1 @@
+raise Exception, "Before Delete"

data/test/support/test_case.rb

@@ -0,0 +1,17 @@
+class MiniTest::Should::TestCase
+
+  # Borrowed from thor .. thanks wycats! :)
+  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
+
+end

data/test/test_helper.rb

@@ -1,5 +1,8 @@
 require 'bundler/setup'
 Bundler.require(:default, :test)
-require 'shoulda'
+require 'minitest/autorun'
+require 'minitest/should'
 require 'fileutils'
-require File.expand_path('../support/hook_test_helper', __FILE__)
+
+require 'support/test_case'
+require 'support/hook_test_helper'

data/test/unit/app_generator_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class AppGeneratorTest < Test::Unit::TestCase
+class AppGeneratorTest < MiniTest::Should::TestCase
 
   def setup
     @root  = File.expand_path("../../dummy_gem", __FILE__)
@@ -34,35 +34,32 @@ class AppGeneratorTest < Test::Unit::TestCase
     context "when run" do
       
       setup do
-        @generator.run!    
+        capture(:stdout) { @generator.run! }
       end
       
-      should "create test/dummy" do
-        assert File.exists?(@dummy)
-      end
+      should "create test/dummy and apply proper templates" do
+        # should create test/dummy
+        assert File.exists?(@dummy), "test/dummy should exist at #{@dummy}"
     
-      should "remove unnecessary files" do        
+        # should remove unnecessary files       
         files = %w(public/index.html public/images/rails.png Gemfile README doc test vendor)
         files.each do |file|
-          assert !File.exists?(file)
+          assert !File.exists?(file), "#{file} should have been deleted"
         end   
-      end
             
-      should "apply application template" do
+        # should apply application template
         rb = read_file('config/application.rb')
         [ "require File.expand_path('../boot', __FILE__)", /require "dummy_gem"/, /module Dummy/ ].each do |regex|
-          assert_match regex, rb
+          assert_match regex, rb, "config/application should have had #{rb.inspect} applied."
         end
-      end
         
-      should "apply the boot template" do
+        # should apply the boot template
         rb = read_file('config/boot.rb')
         [ "gemfile = File.expand_path('../../../../Gemfile', __FILE__)", "ENV['BUNDLE_GEMFILE'] = gemfile", "$:.unshift File.expand_path('../../../../lib', __FILE__)" ].each do |regex|
-          assert_match regex, rb
+          assert_match regex, rb, "config/boot.rb should have had #{rb.inspect} applied."
         end
-      end
         
-      should "fire hooks in proper order" do
+        # should fire hooks in proper order
         assert_equal [ :before_delete, :before_app_generator, :after_app_generator, :before_migrate, :after_migrate ], HookTestHelper.hooks
       end
         
@@ -73,26 +70,56 @@ class AppGeneratorTest < Test::Unit::TestCase
       setup do
         @features = File.join(@root, "features")
         FileUtils.mkdir(@features)
-        @generator.run!
+        capture(:stdout) { @generator.run! }
       end
       
       teardown do
         FileUtils.rm_r(@features) if File.directory?(@features)
       end
       
-      should "apply cucumber database config" do
+      should "apply cucumber support" do
+        # should write database config
         yml = read_file('config/database.yml')
         [ "test: &test", "cucumber:", "  <<: *test" ].each do |regex|
-          assert_match regex, yml
+          assert_match regex, yml, "config/database.yml should have had #{yml.inspect} applied"
         end
-      end
       
-      should "apply cucumber environment" do
-        assert File.exists?(File.join(@dummy, "config/environments/cucumber.rb"))
+        # should apply cucumber environment
+        env = "config/environments/cucumber.rb"
+        assert File.exists?(File.join(@dummy, env)), "#{env.inspect} should have been created"
       end
       
     end
-
+  
+  end
+    
+  context "A doomed to fail app generator" do
+  
+    setup do
+      # create a failed destiny
+      @hooks = File.join(@root, "test/dummy_hooks")
+      @tmp   = File.join(@root, "test/tmp_dummy_hooks")
+      @err   = File.join(@root, "test/erroneous_dummy_hooks")
+      FileUtils.mv @hooks, @tmp
+      FileUtils.mv @err, @hooks
+      @generator = Dummier::AppGenerator.new(@root)
+    end
+    
+    teardown do
+      # revert to sanity
+      FileUtils.mv @hooks, @err
+      FileUtils.mv @tmp, @hooks
+    end
+    
+    should "error and exit if a hook throws an exception" do
+      # ensure exception is raised
+      assert_raises Dummier::HookException do
+        capture(:stdout) { @generator.run! }
+      end
+      # ensure the generator didn't make it any farther
+      assert HookTestHelper.hooks.empty?
+    end
+    
   end
   
 end

data/test/unit/dummier_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class DummierTest < Test::Unit::TestCase
+class DummierTest < MiniTest::Should::TestCase
 
   def setup
     @root = File.expand_path("../../../", __FILE__)

metadata

@@ -1,60 +1,69 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dummier
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  version: 0.2.4
 platform: ruby
-authors: 
+authors:
 - Spencer Steffen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70265410791360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70265410791360
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70265410787140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.11.3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70265410787140
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  requirement: &70265410778440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: *70265410778440
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70265410777740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.3.3
   type: :development
-  version_requirements: *id003
-description: Dummier is a rails generator for automating the creation of rails testing applications.
-email: 
+  prerelease: false
+  version_requirements: *70265410777740
+description: Dummier is a rails generator for automating the creation of rails testing
+  applications.
+email:
 - spencer@citrusme.com
-executables: 
+executables:
 - dummier
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -76,38 +85,44 @@ files:
 - test/dummy_gem/test/dummy_hooks/before_app_generator.rb
 - test/dummy_gem/test/dummy_hooks/before_delete.rb
 - test/dummy_gem/test/dummy_hooks/before_migrate.rb
+- test/dummy_gem/test/erroneous_dummy_hooks/before_app_generator.rb
+- test/dummy_gem/test/erroneous_dummy_hooks/before_delete.rb
 - test/support/hook_test_helper.rb
+- test/support/test_case.rb
 - test/test_helper.rb
 - test/unit/app_generator_test.rb
 - test/unit/dummier_test.rb
 homepage: https://github.com/citrus/dummier
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2889636280236080648
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2889636280236080648
 requirements: []
-
 rubyforge_project: dummier
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Dummier generates a minimal rails testing application.
-test_files: 
+test_files:
 - test/dummy_gem/Gemfile
 - test/dummy_gem/dummy_gem.gemspec
 - test/dummy_gem/lib/dummy_gem.rb
@@ -116,7 +131,10 @@ test_files:
 - test/dummy_gem/test/dummy_hooks/before_app_generator.rb
 - test/dummy_gem/test/dummy_hooks/before_delete.rb
 - test/dummy_gem/test/dummy_hooks/before_migrate.rb
+- test/dummy_gem/test/erroneous_dummy_hooks/before_app_generator.rb
+- test/dummy_gem/test/erroneous_dummy_hooks/before_delete.rb
 - test/support/hook_test_helper.rb
+- test/support/test_case.rb
 - test/test_helper.rb
 - test/unit/app_generator_test.rb
 - test/unit/dummier_test.rb