newgem 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,9 @@
+== 1.0.1 2008-10-28
+
+* Fix up readme + post-install notices based on 1.0.0 changes [thx Tomasz Muras]
+* Remove old rails cucumber generator cruft from env.rb
+* Clean up some feature/steps
+
 == 1.0.0 2008-10-21
 
 * Yay for 1.0.0 of New Gem Generator!

data/Manifest.txt

@@ -37,6 +37,7 @@ features/expected_outputs/newgem.out
 features/install_cucumber.feature
 features/install_website.feature
 features/newgem_cli.feature
+features/rubygem_tasks.feature
 features/steps/cli.rb
 features/steps/env.rb
 lib/newgem.rb

data/PostInstall.txt

@@ -3,20 +3,10 @@ USAGE: newgem project_name
 HELP/OPTIONS: newgem -h
 
 
-newgem uses config from your ~/.rubyforge/user-config.yml file
-You can add the following key/values to this file:
-  full_name  : Dr Nic Williams
-  email      : drnicwilliams@gmail.com
-  github_username: drnic
-
-To create the ~/.rubyforge/user-config.yml file run:
-  rubyforge setup (deletes your username and password, so run sparingly!)
-  edit ~/.rubyforge/user-config.yml
-  rubyforge config
-
-Whenever you create a new RubyForge.org project, re-run:
-  rubyforge config
+newgem can use an environment variable $RUBYFORGE_USERNAME
+for its default. So you can add the following to your .bash_profile:
 
+  export RUBYFORGE_USERNAME="nicwilliams"
 
 Did you know you have script/generate generators?
   application_generator, component_generator, executable,

data/README.rdoc

@@ -16,55 +16,49 @@ Go to the folder where you want to create your new gem folder structure, and run
 
   cd ~/ruby_projects
   $ newgem wizzo
-        create  
-        create  config
-        create  doc
-        create  lib
-        create  script
-        create  tasks
-        create  lib/wizzo
-        create  History.txt
-        create  Rakefile
-        create  README.rdoc
-        create  PostInstall.txt
-        create  lib/wizzo.rb
-        create  lib/wizzo/version.rb
-        create  config/hoe.rb
-        create  config/requirements.rb
-        create  tasks/deployment.rake
-        create  tasks/environment.rake
-        create  tasks/website.rake
-    dependency  install_test_unit
-        create    test
-        create    test/test_helper.rb
-        create    test/test_wizzo.rb
-    dependency  install_website
-        create    website/javascripts
-        create    website/stylesheets
-        exists    script
-        exists    tasks
-        create    website/index.txt
-        create    website/index.html
-        create    script/txt2html
-         force    tasks/website.rake
-    dependency    plain_theme
-        exists      website/javascripts
-        exists      website/stylesheets
-        create      website/template.html.erb
-        create      website/stylesheets/screen.css
-        create      website/javascripts/rounded_corners_lite.inc.js
-    dependency  install_rubigen_scripts
-        exists    script
-        create    script/generate
-        create    script/destroy
-        create  script/console
-        create  Manifest.txt
-        readme  readme
-  Important
-  =========
-
-  * Open config/hoe.rb
-  * Update missing details (gem description, dependent gems, etc.)
+          create  
+          create  doc
+          create  lib
+          create  script
+          create  tasks
+          create  lib/wizzo
+          create  History.txt
+          create  Rakefile
+          create  README.rdoc
+          create  PostInstall.txt
+          create  lib/wizzo.rb
+      dependency  install_test_unit
+          create    test
+          create    test/test_helper.rb
+          create    test/test_wizzo.rb
+      dependency  install_website
+          create    website/javascripts
+          create    website/stylesheets
+          create    config
+          exists    script
+          exists    tasks
+          create    website/index.txt
+          create    website/index.html
+          create    config/website.yml.sample
+          create    script/txt2html
+      dependency    plain_theme
+          exists      website/javascripts
+          exists      website/stylesheets
+          create      website/template.html.erb
+          create      website/stylesheets/screen.css
+          create      website/javascripts/rounded_corners_lite.inc.js
+      dependency  install_rubigen_scripts
+          exists    script
+          create    script/generate
+          create    script/destroy
+          create  script/console
+          create  Manifest.txt
+          readme  readme
+    Important
+    =========
+
+    * Open Rakefile
+    * Update missing details (gem description, dependent gems, etc.)
 
 You can generate test::unit or rspec test stubs via the -T, --test-with options (shoulda coming soon)
 

data/app_generators/newgem/templates/readme

@@ -1,5 +1,5 @@
 Important
 =========
 
-* Open config/hoe.rb
+* Open Rakefile
 * Update missing details (gem description, dependent gems, etc.)

data/features/expected_outputs/newgem.out

@@ -39,5 +39,5 @@
 Important
 =========
 
-* Open config/hoe.rb
+* Open Rakefile
 * Update missing details (gem description, dependent gems, etc.)

data/features/install_cucumber.feature

@@ -9,3 +9,9 @@ Feature: RubyGems have features to be described and tested
     When 'install_cucumber' generator is invoked with arguments ''
     Then folder 'features/steps' is created
     And file 'tasks/cucumber.rake' is created
+
+  Scenario: Installed Cucumber includes a 'rake features' task
+    Given an existing newgem scaffold [called 'my_project']
+    And 'install_cucumber' generator is invoked with arguments ''
+    When task 'rake features' is invoked
+    Then task 'rake features' is executed successfully

data/features/newgem_cli.feature

@@ -1,4 +1,4 @@
-Feature: Can run create RubyGem scaffolds
+Feature: Can run 'newgem' to create RubyGem scaffolds
 
   As a developer of RubyGems
   I want to create RubyGem scaffolds
@@ -10,11 +10,11 @@ Feature: Can run create RubyGem scaffolds
     When newgem is executed for project 'my_project' with no options
     Then file 'Rakefile' is created
     And does invoke generator 'install_test_unit'
+    And does invoke generator 'install_website'
+    And does invoke generator 'install_rubigen_scripts'
     And does not invoke generator 'install_rspec'
     And does not invoke generator 'install_shoulda'
     And does not invoke generator 'install_cucumber'
-    And does invoke generator 'install_website'
-    And does invoke generator 'install_rubigen_scripts'
     And file 'config/website.yml.sample' is created
     And yaml file 'config/website.yml.sample' contains {"host" => "unknown@rubyforge.org", "remote_dir" => "/var/www/gforge-projects/my_project"}
     And output same as contents of 'newgem.out'

data/features/rubygem_tasks.feature

@@ -0,0 +1,13 @@
+Feature: Generated RubyGems have various rake tasks to aide their development
+  In order to maintain and release generated RubyGems
+  As a RubyGem developer
+  I want rake tasks to perform routine maintenance and deployment tasks
+
+  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 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\)/

data/features/steps/cli.rb

@@ -1,12 +1,12 @@
 Given %r{^a safe folder} do
-  FileUtils.rm_rf   $tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  FileUtils.mkdir_p $tmp_root
+  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  FileUtils.mkdir_p @tmp_root
 end
 
 Given /^this project is active project folder/ do
-  FileUtils.rm_rf   $tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  FileUtils.mkdir_p $tmp_root
-  $active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  FileUtils.mkdir_p @tmp_root
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
 end
 
 Given /^env variable \$([\w_]+) set to '(.*)'/ do |env_var, value|
@@ -23,60 +23,59 @@ end
 
 Given %r{^an existing newgem scaffold \[called '(.*)'\]$} do |project_name|
   # TODO this is a combo of "a safe folder" and "newgem is executed ..." steps; refactor
-  FileUtils.rm_rf   $tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  FileUtils.mkdir_p $tmp_root
+  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  FileUtils.mkdir_p @tmp_root
   newgem = File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
-  FileUtils.chdir $tmp_root do
+  FileUtils.chdir @tmp_root do
     @stdout = "newgem.out"
     system "ruby #{newgem} #{project_name} > #{@stdout}"
     force_local_newgem_priority project_name
   end
-  $active_project_folder = File.join($tmp_root, project_name)
-  $project_name = project_name
+  @active_project_folder = File.join(@tmp_root, project_name)
+  @project_name = project_name
 end
 
 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
-  FileUtils.chdir $active_project_folder do
+  @remote_folder = File.expand_path(File.join(@tmp_root, 'website'))
+  FileUtils.rm_rf   @remote_folder
+  FileUtils.mkdir_p @remote_folder
+  FileUtils.chdir @active_project_folder do
     FileUtils.mkdir_p 'config'
-    # config_yml = { "host" => "localhost", "remote_dir" => $remote_folder }.to_yaml
-    config_yml = { "remote_dir" => $remote_folder }.to_yaml
+    config_yml = { "remote_dir" => @remote_folder }.to_yaml
     config_path = File.join('config', 'website.yml')
     File.open(config_path, "w") { |io| io << config_yml }
   end  
 end
 
 Given /^'(.*)' folder is deleted/ do |folder|
-  FileUtils.chdir $active_project_folder do
+  FileUtils.chdir @active_project_folder do
     FileUtils.rm_rf folder
   end
 end
 
 When %r{^newgem is executed for project '(.*)' with no options$} do |project_name|
   newgem = File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
-  $active_project_folder = File.expand_path(File.join($tmp_root, project_name))
-  $project_name = project_name
-  FileUtils.chdir $tmp_root do
+  FileUtils.chdir @tmp_root do
     @stdout = "newgem.out"
     system "ruby #{newgem} #{project_name} > #{@stdout}"
     force_local_newgem_priority project_name
   end
+  @active_project_folder = File.expand_path(File.join(@tmp_root, project_name))
+  @project_name = project_name
 end
 
 When %r{^newgem is executed for project '(.*)' with options '(.*)'$} do |project_name, arguments|
   newgem = File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
-  $project_name = project_name
-  FileUtils.chdir $tmp_root do
+  @project_name = project_name
+  FileUtils.chdir @tmp_root do
     @stdout = "newgem.out"
     system "ruby #{newgem} #{arguments} #{project_name} > #{@stdout}"
-    $active_project_folder = File.join($tmp_root, project_name)
+    @active_project_folder = File.join(@tmp_root, project_name)
   end
 end
 
 When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
-  FileUtils.chdir($active_project_folder) do
+  FileUtils.chdir(@active_project_folder) do
     if Object.const_defined?("APP_ROOT")
       APP_ROOT.replace(FileUtils.pwd)
     else 
@@ -87,52 +86,52 @@ When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, argu
 end
 
 When /^run executable '(.*)' with arguments '(.*)'$/ do |executable, arguments|
-  @stdout = File.expand_path(File.join($tmp_root, "executable.out"))
-  FileUtils.chdir($active_project_folder) do
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  FileUtils.chdir(@active_project_folder) do
     system "ruby #{executable} #{arguments} > #{@stdout}"
   end
 end
 
 When /^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
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  FileUtils.chdir(@active_project_folder) do
     system "ruby #{test_file} > #{@stdout}"
   end
 end
 
 When /^task 'rake (.*)' is invoked$/ do |task|
-  @stdout = File.expand_path(File.join($tmp_root, "tests.out"))
-  FileUtils.chdir($active_project_folder) do
-    system "rake #{task} > #{@stdout} 2> #{@stdout}"
+  @raketask_stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake #{task} > #{@raketask_stdout} 2> #{@raketask_stdout}"
   end
 end
 
 Then %r{^folder '(.*)' is created} do |folder|
-  FileUtils.chdir $active_project_folder do
+  FileUtils.chdir @active_project_folder do
     File.exists?(folder).should be_true
   end
 end
 
 Then %r{^remote folder '(.*)' is created} do |folder|
-  FileUtils.chdir $remote_folder do
+  FileUtils.chdir @remote_folder do
     File.exists?(folder).should be_true
   end
 end
 
 Then %r{^file '(.*)' (is|is not) created} do |file, is|
-  FileUtils.chdir $active_project_folder do
+  FileUtils.chdir @active_project_folder do
     File.exists?(file).should(is == 'is' ? be_true : be_false)
   end
 end
 
 Then %r{^remote file '(.*)' (is|is not) created} do |file, is|
-  FileUtils.chdir $remote_folder do
+  FileUtils.chdir @remote_folder do
     File.exists?(file).should(is == 'is' ? be_true : be_false)
   end
 end
 
 Then /^file matching '(.*)' is created$/ do |pattern|
-  FileUtils.chdir $active_project_folder do
+  FileUtils.chdir @active_project_folder do
     Dir[pattern].should_not be_empty
   end
 end
@@ -168,14 +167,14 @@ Then /^all (\d+) tests pass$/ do |expected_test_count|
 end
 
 Then /^yaml file '(.*)' contains (\{.*\})/ do |file, yaml|
-  FileUtils.chdir $active_project_folder do
+  FileUtils.chdir @active_project_folder do
     yaml = eval yaml
     YAML.load(File.read(file)).should == yaml
   end
 end
 
 Then /^gem spec key '(.*)' contains \/(.*)\/$/ do |key, regex|
-  FileUtils.chdir $active_project_folder do
+  FileUtils.chdir @active_project_folder do
     gem_file = Dir["pkg/*.gem"].first
     gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
     spec_value = gem_spec.send(key.to_sym)
@@ -184,10 +183,17 @@ Then /^gem spec key '(.*)' contains \/(.*)\/$/ do |key, regex|
 end
 
 Then /^Rakefile can display tasks successfully$/ do
-  @stdout = File.expand_path(File.join($tmp_root, "rakefile.out"))
-  FileUtils.chdir($active_project_folder) do
-    system "rake -T > #{@stdout} 2> #{@stdout}"
+  @rake_stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake -T > #{@rake_stdout} 2> #{@rake_stdout}"
   end
-  actual_output = File.read(@stdout)
+  actual_output = File.read(@rake_stdout)
   actual_output.should match(/^rake\s+\w+\s+#\s.*/)
 end
+
+Then /^task 'rake (.*)' is executed successfully$/ do |task|
+  @raketask_stdout.should_not be_nil
+  actual_output = File.read(@raketask_stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end

data/lib/newgem.rb

@@ -2,5 +2,5 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module Newgem
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/rubygems_generators/install_cucumber/templates/env.rb

@@ -1,16 +1,6 @@
 require File.dirname(__FILE__) + "/../../lib/<%= project_name %>"
 
 gem 'cucumber'
-
-
-# Following lines from original Rails cucumber generator. 
-# Not sure how to translate/reuse etc yet.
-# 
-# # Sets up the Rails environment for Cucumber
-# ENV["RAILS_ENV"] = "test"
-# require File.expand_path(File.dirname(__FILE__) + '/../../config/environment')
-# require 'cucumber/rails/world'
-# Cucumber::Rails.use_transactional_fixtures
-# 
-# # Comment out the next line if you're not using RSpec's matchers (should / should_not) in your steps.
-# require 'cucumber/rails/rspec'
+require 'cucumber'
+gem 'rspec'
+require 'spec'

data/website/index.html

@@ -39,7 +39,7 @@
     
       <div id="version"> <!--  class="clickable" onclick='document.location = "http://rubyforge.org/projects/newgem"; return true' -->
         <p>Get Version</p>
-        <a href="http://rubyforge.org/projects/newgem" class="numbers">1.0.0</a>
+        <a href="http://rubyforge.org/projects/newgem" class="numbers">1.0.1</a>
         <p>Featured in</p>
         <a  href="http://www.amazon.com/gp/redirect.html?ie=UTF8&location=http%3A%2F%2Fwww.amazon.com%2FBeginning-Ruby-Novice-Professional-Experts%2Fdp%2F1590597664%2F&tag=drnic-20&linkCode=ur2&camp=1789&creative=9325" class="book"><img src="images/beginning-ruby.jpg" /></a>
       </div>
@@ -72,7 +72,6 @@
 <pre>$ cd ~/ruby_projects
 $ newgem wizzo
       create  
-      create  config
       create  doc
       create  lib
       create  script
@@ -83,12 +82,6 @@ $ newgem wizzo
       create  README.rdoc
       create  PostInstall.txt
       create  lib/wizzo.rb
-      create  lib/wizzo/version.rb
-      create  config/hoe.rb
-      create  config/requirements.rb
-      create  tasks/deployment.rake
-      create  tasks/environment.rake
-      create  tasks/website.rake
   dependency  install_test_unit
       create    test
       create    test/test_helper.rb
@@ -96,12 +89,13 @@ $ newgem wizzo
   dependency  install_website
       create    website/javascripts
       create    website/stylesheets
+      create    config
       exists    script
       exists    tasks
       create    website/index.txt
       create    website/index.html
+      create    config/website.yml.sample
       create    script/txt2html
-       force    tasks/website.rake
   dependency    plain_theme
       exists      website/javascripts
       exists      website/stylesheets
@@ -118,7 +112,7 @@ $ newgem wizzo
 Important
 =========
 
-* Open config/hoe.rb
+* Open Rakefile
 * Update missing details (gem description, dependent gems, etc.)</pre>
 <p>You can generate test::unit or rspec test stubs via the <code>-T</code> or <code>--test-with</code> options. For example, <code>-T rspec</code> generates a <code>spec</code> folder with some test stubs.</p>
 <h3>Setup</h3>
@@ -230,7 +224,7 @@ rake install_gem</pre>
 <h2>Contact</h2>
 <p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a>.</p>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 26th October 2008<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 28th October 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -25,7 +25,6 @@ Go to the folder where you want to create your new gem folder structure, and run
 <pre>$ cd ~/ruby_projects
 $ newgem wizzo
       create  
-      create  config
       create  doc
       create  lib
       create  script
@@ -36,12 +35,6 @@ $ newgem wizzo
       create  README.rdoc
       create  PostInstall.txt
       create  lib/wizzo.rb
-      create  lib/wizzo/version.rb
-      create  config/hoe.rb
-      create  config/requirements.rb
-      create  tasks/deployment.rake
-      create  tasks/environment.rake
-      create  tasks/website.rake
   dependency  install_test_unit
       create    test
       create    test/test_helper.rb
@@ -49,12 +42,13 @@ $ newgem wizzo
   dependency  install_website
       create    website/javascripts
       create    website/stylesheets
+      create    config
       exists    script
       exists    tasks
       create    website/index.txt
       create    website/index.html
+      create    config/website.yml.sample
       create    script/txt2html
-       force    tasks/website.rake
   dependency    plain_theme
       exists      website/javascripts
       exists      website/stylesheets
@@ -71,7 +65,7 @@ $ newgem wizzo
 Important
 =========
 
-* Open config/hoe.rb
+* Open Rakefile
 * Update missing details (gem description, dependent gems, etc.)</pre>
 
 You can generate test::unit or rspec test stubs via the <code>-T</code> or <code>--test-with</code> options. For example, <code>-T rspec</code> generates a <code>spec</code> folder with some test stubs.

data/website/rubyforge.html

@@ -39,7 +39,7 @@
     
       <div id="version"> <!--  class="clickable" onclick='document.location = "http://rubyforge.org/projects/newgem"; return true' -->
         <p>Get Version</p>
-        <a href="http://rubyforge.org/projects/newgem" class="numbers">1.0.0</a>
+        <a href="http://rubyforge.org/projects/newgem" class="numbers">1.0.1</a>
         <p>Featured in</p>
         <a  href="http://www.amazon.com/gp/redirect.html?ie=UTF8&location=http%3A%2F%2Fwww.amazon.com%2FBeginning-Ruby-Novice-Professional-Experts%2Fdp%2F1590597664%2F&tag=drnic-20&linkCode=ur2&camp=1789&creative=9325" class="book"><img src="images/beginning-ruby.jpg" /></a>
       </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: newgem
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-26 00:00:00 +10:00
+date: 2008-10-28 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -135,6 +135,7 @@ files:
 - features/install_cucumber.feature
 - features/install_website.feature
 - features/newgem_cli.feature
+- features/rubygem_tasks.feature
 - features/steps/cli.rb
 - features/steps/env.rb
 - lib/newgem.rb