newgem 1.3.0 → 1.4.0

data/features/rubygem_tasks.feature

@@ -3,25 +3,33 @@ Feature: Generated RubyGems have various rake tasks to aide their development
   As a RubyGem developer
   I want rake tasks to perform routine maintenance and deployment tasks
 
+  Scenario: Generate a gemspec that can build the RubyGem
+    Given default env variables setup for name and email
+    And an existing newgem scaffold [called "my_project"]
+    And "pkg" folder is deleted
+    When I invoke task "rake gemspec"
+    Then file "my_project.gemspec" is created
+    And gemspec builds the RubyGem successfully
+    Then I should see
+      """
+      Successfully built RubyGem
+      """
+
   Scenario: Generate RubyGem
-    Given an existing newgem scaffold [called 'my_project']
-    And 'pkg' folder is deleted
-    When task 'rake gem' is invoked
-    Then folder 'pkg' is created
-    And file with name matching 'pkg/my_project-0.0.1.gem' is created
-    And gem spec key 'rdoc_options' contains /--mainREADME.rdoc/
-    And gem spec key 'dependencies' contains /newgem \(>= [\d.]+, development\)/
+    Given default env variables setup for name and email
+    And an existing newgem scaffold [called "my_project"]
+    And "pkg" folder is deleted
+    When I invoke task "rake gem"
+    Then folder "pkg" is created
+    And file with name matching "pkg/my_project-0.0.1.gem" is created
+    And gem spec key "rdoc_options" contains /--mainREADME.rdoc/
+    And gem spec key "dependencies" contains /newgem \(>= [\d.]+, development\)/
 
   Scenario: Hoe does not bitch about README.txt being missing
-    Given an existing newgem scaffold [called 'my_project'] that has 'README.rdoc' not 'README.txt'
-    When task 'rake -T' is invoked
-    Then output does not match /README.txt is missing/
+    Given an existing newgem scaffold [called "my_project"] that has "README.rdoc" not "README.txt"
+    When I invoke task "rake -T"
+    Then I should not see
+      """
+      README.txt is missing
+      """
   
-  Scenario: Generate a gemspec that can build the RubyGem
-    Given an existing newgem scaffold [called 'my_project']
-    And 'pkg' folder is deleted
-    When task 'rake gemspec' is invoked
-    Then file 'my_project.gemspec' is created
-    And gemspec builds the RubyGem successfully
-    And output does match /Successfully built RubyGem/
-  

data/features/step_definitions/cli_steps.rb

@@ -1,8 +1,9 @@
-def in_tmp_folder(&block)
-  FileUtils.chdir(@tmp_root, &block)
+Given /^default env variables setup for name and email$/ do
+  Given 'env variable $NAME set to "Dr Nic"'
+  Given 'env variable $EMAIL set to "drnicwilliams@gmail.com"'
 end
 
-Given %r{^an existing newgem scaffold \[called '(.*)'\]} do |project_name|
+Given /^an existing newgem scaffold \[called "(.*)"\]/ do |project_name|
   Given "a safe folder"
   newgem = File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
   setup_active_project_folder project_name
@@ -13,7 +14,7 @@ Given %r{^an existing newgem scaffold \[called '(.*)'\]} do |project_name|
   end
 end
 
-Given %r{^an existing newgem scaffold using options '(.*)' \[called '(.*)'\]} do |arguments, project_name|
+Given /^an existing newgem scaffold using options "(.*)" \[called "(.*)"\]/ do |arguments, project_name|
   Given "a safe folder"
   newgem = File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
   setup_active_project_folder project_name
@@ -24,7 +25,7 @@ Given %r{^an existing newgem scaffold using options '(.*)' \[called '(.*)'\]} do
   end
 end
 
-Given %r{^project website configuration for safe folder on local machine$} do
+Given /^project website configuration for safe folder on local machine$/ do
   @remote_folder = File.expand_path(File.join(@tmp_root, 'website'))
   FileUtils.rm_rf   @remote_folder
   FileUtils.mkdir_p @remote_folder
@@ -36,7 +37,7 @@ Given %r{^project website configuration for safe folder on local machine$} do
   end  
 end
 
-Given %r{^~\/([^\s]+) contains (\{.*\})$} do |file, config|
+Given /^~\/([^\s]+) contains (\{.*\})$/ do |file, config|
   in_home_folder do
     File.open(file, 'w') do |f|
       yaml = eval(config)
@@ -45,11 +46,7 @@ Given %r{^~\/([^\s]+) contains (\{.*\})$} do |file, config|
   end
 end
 
-def newgem_cmd
-  File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
-end
-
-When %r{^newgem is executed for project '(.*)' with no options$} do |project_name|
+When /^newgem is executed for project "(.*)" with no options$/ do |project_name|
   @newgem_cmd = newgem_cmd
   setup_active_project_folder project_name
   in_tmp_folder do
@@ -59,7 +56,7 @@ When %r{^newgem is executed for project '(.*)' with no options$} do |project_nam
   end
 end
 
-When %r{^newgem is executed for project '(.*)' with options '(.*)'$} do |project_name, arguments|
+When /^newgem is executed for project "(.*)" with options "(.*)"$/ do |project_name, arguments|
   @newgem_cmd = newgem_cmd
   setup_active_project_folder project_name
   in_tmp_folder do
@@ -69,7 +66,7 @@ When %r{^newgem is executed for project '(.*)' with options '(.*)'$} do |project
   end
 end
 
-When /^newgem is executed only with options '(.*)'$/ do |arguments|
+When /^newgem is executed only with options "(.*)"$/ do |arguments|
   @newgem_cmd = newgem_cmd
   in_tmp_folder do
     @stdout = File.expand_path("newgem.out")
@@ -78,20 +75,28 @@ When /^newgem is executed only with options '(.*)'$/ do |arguments|
 end
 
 
-When /^run unit tests for test file '(.*)'$/ do |test_file|
+When /^I run unit tests for test file "(.*)"$/ do |test_file|
   @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
-  FileUtils.chdir(@active_project_folder) do
+  in_project_folder do
     system "ruby #{test_file} > #{@stdout}"
   end
 end
 
-Then %r{^remote folder '(.*)' is created} do |folder|
+When /^I enable rspec autorun$/ do
+  in_project_folder do
+    File.open("spec/spec_helper.rb", "a") do |f|
+      f << "require 'spec/autorun'"
+    end
+  end
+end
+
+Then /^remote folder "(.*)" is created/ do |folder|
   FileUtils.chdir @remote_folder do
     File.exists?(folder).should be_true
   end
 end
 
-Then %r{^remote file '(.*)' (is|is not) created} do |file, is|
+Then /^remote file "(.*)" (is|is not) created/ do |file, is|
   FileUtils.chdir @remote_folder do
     File.exists?(file).should(is == 'is' ? be_true : be_false)
   end

data/features/step_definitions/common_steps.rb

@@ -1,51 +1,27 @@
-def in_project_folder(&block)
-  project_folder = @active_project_folder || @tmp_root
-  FileUtils.chdir(project_folder, &block)
-end
-
-def in_home_folder(&block)
-  FileUtils.chdir(@home_path, &block)
-end
-
-Given %r{^a safe folder} do
+Given /^a safe folder/ do
   FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
   FileUtils.mkdir_p @tmp_root
   FileUtils.mkdir_p @home_path = File.expand_path(File.join(@tmp_root, "home"))
   @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
-  Given "env variable $HOME set to '#{@home_path}'"
+  Given %Q{env variable $HOME set to "#{@home_path}"}
 end
 
-Given %r{^this project is active project folder} do
+Given /^this project is active project folder/ do
   Given "a safe folder"
   @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
 end
 
-Given %r{^env variable \$([\w_]+) set to '(.*)'} do |env_var, value|
+Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
   ENV[env_var] = value
 end
 
-def force_local_lib_override(project_name = @project_name)
-  rakefile = File.read(File.join(project_name, 'Rakefile'))
-  File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
-    f << "$:.unshift('#{@lib_path}')\n"
-    f << rakefile
-  end
-end
-
-def setup_active_project_folder project_name
-  @active_project_folder = File.join(@tmp_root, project_name)
-  @project_name = project_name
-end
-
-Given %r{'(.*)' folder is deleted} do |folder|
-  in_project_folder do
-    FileUtils.rm_rf folder
-  end
+Given /"(.*)" folder is deleted/ do |folder|
+  in_project_folder { FileUtils.rm_rf folder }
 end
 
-When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
+When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
   @stdout = StringIO.new
-  FileUtils.chdir(@active_project_folder) do
+  in_project_folder do
     if Object.const_defined?("APP_ROOT")
       APP_ROOT.replace(FileUtils.pwd)
     else 
@@ -59,21 +35,21 @@ When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, argu
   end
 end
 
-When %r{run executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
   @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
   in_project_folder do
     system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
   end
 end
 
-When %r{run project executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
   @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
   in_project_folder do
     system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
   end
 end
 
-When %r{run local executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
   @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
   executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
   in_project_folder do
@@ -81,32 +57,41 @@ When %r{run local executable '(.*)' with arguments '(.*)'} do |executable, argum
   end
 end
 
-When %r{^task 'rake (.*)' is invoked$} do |task|
+When /^I invoke task "rake (.*)"/ do |task|
   @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
-  FileUtils.chdir(@active_project_folder) do
+  in_project_folder do
     system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
   end
 end
 
-Then %r{^folder '(.*)' (is|is not) created} do |folder, is|
+Then /^folder "(.*)" (is|is not) created/ do |folder, is|
   in_project_folder do
     File.exists?(folder).should(is == 'is' ? be_true : be_false)
   end
 end
 
-Then %r{^file '(.*)' (is|is not) created} do |file, is|
+Then /^file "(.*)" (is|is not) created/ do |file, is|
   in_project_folder do
     File.exists?(file).should(is == 'is' ? be_true : be_false)
   end
 end
 
-Then %r{^file with name matching '(.*)' is created} do |pattern|
+Then /^file with name matching "(.*)" is created/ do |pattern|
   in_project_folder do
     Dir[pattern].should_not be_empty
   end
 end
 
-Then %r{gem file '(.*)' and generated file '(.*)' should be the same} do |gem_file, project_file|
+Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
   File.exists?(gem_file).should be_true
   File.exists?(project_file).should be_true
   gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
@@ -114,77 +99,70 @@ Then %r{gem file '(.*)' and generated file '(.*)' should be the same} do |gem_fi
   project_file_contents.should == gem_file_contents
 end
 
-Then %r{^output same as contents of '(.*)'$} do |file|
-  expected_output = File.read(File.join(File.dirname(__FILE__) + "/../expected_outputs", file))
-  actual_output = File.read(@stdout)
-  actual_output.should == expected_output
-end
-
-Then %r{^(does|does not) invoke generator '(.*)'$} do |does_invoke, generator|
+Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
   actual_output = File.read(@stdout)
   does_invoke == "does" ?
     actual_output.should(match(/dependency\s+#{generator}/)) :
     actual_output.should_not(match(/dependency\s+#{generator}/))
 end
 
-Then %r{help options '(.*)' and '(.*)' are displayed} do |opt1, opt2|
+Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
   actual_output = File.read(@stdout)
   actual_output.should match(/#{opt1}/)
   actual_output.should match(/#{opt2}/)
 end
 
-Then %r{^output (does|does not) match \/(.*)\/} do |does, regex|
+Then /^I should see$/ do |text|
   actual_output = File.read(@stdout)
-  (does == 'does') ?
-    actual_output.should(match(/#{regex}/)) :
-    actual_output.should_not(match(/#{regex}/)) 
+  actual_output.should contain(text)
 end
 
-Then %r{^contents of file '(.*)' (does|does not) match \/(.*)\/} do |file, does, regex|
-  in_project_folder do
-    actual_output = File.read(file)
-    (does == 'does') ?
-      actual_output.should(match(/#{regex}/)) :
-      actual_output.should_not(match(/#{regex}/))
-  end
+Then /^I should not see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should_not contain(text)
 end
 
-Then %r{^all (\d+) tests pass} do |expected_test_count|
+Then /^I should see exactly$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should == text
+end
+
+Then /^I should see all (\d+) tests pass/ do |expected_test_count|
   expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
   actual_output = File.read(@stdout)
   actual_output.should match(expected)
 end
 
-Then %r{^all (\d+) examples pass} do |expected_test_count|
+Then /^I should see all (\d+) examples pass/ do |expected_test_count|
   expected = %r{^#{expected_test_count} examples?, 0 failures}
   actual_output = File.read(@stdout)
   actual_output.should match(expected)
 end
 
-Then %r{^yaml file '(.*)' contains (\{.*\})} do |file, yaml|
+Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
   in_project_folder do
     yaml = eval yaml
     YAML.load(File.read(file)).should == yaml
   end
 end
 
-Then %r{^Rakefile can display tasks successfully} do
+Then /^Rakefile can display tasks successfully/ do
   @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
-  FileUtils.chdir(@active_project_folder) do
+  in_project_folder do
     system "rake -T > #{@stdout} 2> #{@stdout}"
   end
   actual_output = File.read(@stdout)
   actual_output.should match(/^rake\s+\w+\s+#\s.*/)
 end
 
-Then %r{^task 'rake (.*)' is executed successfully} do |task|
+Then /^task "rake (.*)" is executed successfully/ do |task|
   @stdout.should_not be_nil
   actual_output = File.read(@stdout)
   actual_output.should_not match(/^Don't know how to build task '#{task}'/)
   actual_output.should_not match(/Error/i)
 end
 
-Then %r{^gem spec key '(.*)' contains \/(.*)\/} do |key, regex|
+Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
   in_project_folder do
     gem_file = Dir["pkg/*.gem"].first
     gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)

data/features/step_definitions/rubygems_steps.rb

@@ -1,6 +1,6 @@
 Then /^gemspec builds the RubyGem successfully$/ do
   @stdout = File.expand_path(File.join(@tmp_root, "rake.out"))
-  FileUtils.chdir(@active_project_folder) do
+  in_project_folder do
     system "gem build #{@project_name}.gemspec > #{@stdout}"
     gemspec = Dir['**/*.gem'].first
     gemspec.should_not be_nil

data/features/support/cli.rb

@@ -0,0 +1,8 @@
+module CliHelpers
+  def newgem_cmd
+    File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
+  end
+end
+
+World(CliHelpers)
+

data/features/support/common.rb

@@ -0,0 +1,29 @@
+module CommonHelpers
+  def in_tmp_folder(&block)
+    FileUtils.chdir(@tmp_root, &block)
+  end
+
+  def in_project_folder(&block)
+    project_folder = @active_project_folder || @tmp_root
+    FileUtils.chdir(project_folder, &block)
+  end
+
+  def in_home_folder(&block)
+    FileUtils.chdir(@home_path, &block)
+  end
+
+  def force_local_lib_override(project_name = @project_name)
+    rakefile = File.read(File.join(project_name, 'Rakefile'))
+    File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+      f << "$:.unshift('#{@lib_path}')\n"
+      f << rakefile
+    end
+  end
+
+  def setup_active_project_folder project_name
+    @active_project_folder = File.join(@tmp_root, project_name)
+    @project_name = project_name
+  end
+end
+
+World(CommonHelpers)

data/features/support/env.rb

@@ -5,7 +5,7 @@ require 'spec'
 
 require 'pp'
 require 'fileutils'
-require 'rubygems'
+require 'rubygems' unless ENV['NO_RUBYGEMS']
 
 # Following lines from original Rails cucumber generator. 
 # Not sure how to translate/reuse etc yet.
@@ -22,12 +22,7 @@ require 'rubygems'
 # code from test/test_generator_helper.rb
 TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
 
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
+require 'rubigen'
 require 'rubigen/helpers/generator_test_helper'
 include RubiGen::GeneratorTestHelper