newgem 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,12 @@
+== 1.0.2 2008-10-30
+
+* Lighthouse Project created for tickets/suggestions: http://drnic.lighthouseapp.com/projects/18881-newgem
+* newgem no longer generates a website by default; use -w to create one; or -i website; or script/generate install_website
+* dev dependency on latest cucumber gem
+* no requirement for cucumber gem to be installed [fixes #1]
+* hoe is patched and cached within newgem so that README.* is supported [fixes #5]
+* rake-automated patching of hoe.rb from patches/hoe/*.patch
+
 == 1.0.1 2008-10-28
 
 * Fix up readme + post-install notices based on 1.0.0 changes [thx Tomasz Muras]

data/README.rdoc

@@ -79,6 +79,10 @@ The <code>newgem</code> application is distributed itself as a RubyGem and is av
 
 Alternately, download the gem and install manually.
 
+== TICKETS:
+
+Tickets or suggestions can be raised at http://drnic.lighthouseapp.com/projects/18881-newgem/overview
+
 == TUTORIALS:
 
 * Home page is a full tutorial - http://newgem.rubyforge.org

data/Rakefile

@@ -1,4 +1,4 @@
-%w[rubygems rake rake/clean fileutils hoe rubigen].each { |f| require f }
+%w[rubygems rake rake/clean fileutils rubigen cucumber].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/newgem'
 
 # Generate all the Rake tasks
@@ -14,7 +14,9 @@ $hoe = Hoe.new('newgem', Newgem::VERSION) do |p|
     ['RedCloth','>= 4.0.0'], # for website generation
     ['syntax','>= 1.0.0']
   ]
-  p.spec_extras['rdoc_options'] = ['--main', Dir['README*'].first] # hopefully fixed in future hoe > 1.8
+  p.extra_dev_deps = [
+    ['cucumber', ">= #{::Cucumber::VERSION::STRING}"]
+  ]
   p.clean_globs |= %w[**/.DS_Store tmp *.log]
   path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
   p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
@@ -23,3 +25,32 @@ end
 
 require 'newgem/tasks' # load /tasks/*.rake
 
+namespace :hoe do
+  desc "Applies patch files to the hoe.rb in latest hoe rubygem and stores in lib/hoe-patched.rb"
+  task :patch do
+    gem 'hoe'
+    hoe_lib = $LOAD_PATH.grep(/hoe.*\/lib/)
+    hoe_rb  = File.join(hoe_lib, 'hoe.rb')
+    FileUtils.cp hoe_rb, File.dirname(__FILE__) + "/lib/hoe.rb"
+    patches = Dir[File.dirname(__FILE__) + "/patches/hoe/*.patch"].sort
+    patches.each do |patch|
+      puts "Applying patch #{File.basename patch}"
+      sh %{ cat #{patch} | patch -p1 }
+    end
+    patched_hoe = File.dirname(__FILE__) + "/lib/hoe-patched.rb"
+    FileUtils.mv File.dirname(__FILE__) + "/lib/hoe.rb", patched_hoe
+
+    help_msg = <<-EOS.gsub(/^\s+/,'')
+    # Patched version of Hoe to allow any README.* file
+    # Pending acceptance of ticket with this feature
+    # File created by 'rake hoe:patch' in newgem
+    # from patch files in patches/hoe/*.patch
+    EOS
+
+    contents = File.read(patched_hoe)
+    File.open(patched_hoe, "w") do |f|
+      f << help_msg + "\n"
+      f << contents
+    end
+  end
+end

data/app_generators/newgem/newgem_generator.rb

@@ -11,7 +11,7 @@ class NewgemGenerator < RubiGen::Base
                     :author      => nil,
                     :import_path => nil,
                     :jruby       => nil,
-                    :disable_website => nil,
+                    :enable_website => nil,
                     :test_framework  => 'test_unit',
                     :version     => '0.0.1'
 
@@ -22,7 +22,7 @@ class NewgemGenerator < RubiGen::Base
   # extensions/option
   attr_reader :test_framework
   attr_reader :bin_names_list
-  attr_reader :disable_website
+  attr_reader :enable_website
   attr_reader :manifest
   attr_reader :is_jruby
 
@@ -64,7 +64,7 @@ class NewgemGenerator < RubiGen::Base
 
       # Website
       m.dependency "install_website", [gem_name],
-         :author => author, :email => email, :destination => destination_root, :collision => :force unless disable_website
+         :author => author, :email => email, :destination => destination_root, :collision => :force if enable_website
 
       # JRuby
       m.dependency "install_jruby", [gem_name], :destination => destination_root, :collision => :force if is_jruby
@@ -138,8 +138,9 @@ EOS
       opts.on("-V", "--set-version=YOUR_VERSION", String,
               "Version of the gem you are creating.",
               "Default: 0.0.1") { |x| options[:version] = x }
-      opts.on("-W", "--website-disable",
-              "Disables the generation of the website for your RubyGem.") { |x| options[:disable_website] = x }
+      opts.on("-w", "--enable-website",
+              "Enable the generation of the website for your RubyGem.",
+              "Same as '-i website'") { |x| options[:enable_website] = x }
       opts.on("--simple",
               "Creates a simple RubyGems scaffold.") { |x| }
     end
@@ -156,7 +157,7 @@ EOS
         @email  ||= rubyforge_config.email
       end
       @bin_names_list     = (options[:bin_name] || "").split(',')
-      @disable_website    = options[:disable_website]
+      @enable_website     = options[:enable_website]
       @test_framework     = options[:test_framework] || "test_unit"
       @is_jruby           = options[:jruby]
       @project_name       = options[:project] if options.include?(:project)

data/app_generators/newgem/templates/Rakefile

@@ -1,4 +1,4 @@
-%w[rubygems rake rake/clean fileutils hoe newgem rubigen].each { |f| require f }
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/<%= gem_name %>'
 
 # Generate all the Rake tasks
@@ -17,7 +17,6 @@ $hoe = Hoe.new('<%= gem_name %>', <%= module_name %>::VERSION) do |p|
   <% if is_jruby -%>
   p.spec_extras['platform'] = 'jruby' # JRuby gem created, e.g. <%= gem_name %>-X.Y.Z-jruby.gem
   <% end -%>
-  p.spec_extras['rdoc_options'] = ['--main', Dir['README*'].first] # hopefully fixed in future hoe > 1.8
   p.clean_globs |= %w[**/.DS_Store tmp *.log]
   path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
   p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')

data/features/executable_generator.feature

@@ -23,7 +23,7 @@ Feature: Generate an executable/CLI scaffold
     Given an existing newgem scaffold [called 'my_project']
     Given 'executable' generator is invoked with arguments 'my_app'
     When run executable 'bin/my_app' with arguments ''
-    Then output matches /lib\/my_app\/cli.rb/
+    Then output does match /lib\/my_app\/cli.rb/
   
   Scenario: Run unit tests after executable generator should all pass
     Given an existing newgem scaffold [called 'my_project']

data/features/expected_outputs/newgem.out

@@ -13,22 +13,6 @@
       create    test
       create    test/test_helper.rb
       create    test/test_my_project.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

data/features/newgem_cli.feature

@@ -10,13 +10,12 @@ Feature: Can run 'newgem' to 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_website'
     And does not invoke generator 'install_rspec'
     And does not invoke generator 'install_shoulda'
     And does not invoke generator 'install_cucumber'
-    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 file 'config/website.yml' is not created
     And output same as contents of 'newgem.out'
     And Rakefile can display tasks successfully
 
@@ -26,14 +25,6 @@ Feature: Can run 'newgem' to create RubyGem scaffolds
     When newgem is executed for project 'my-project' with no options
     Then Rakefile can display tasks successfully
   
-  Scenario: Run newgem without any arguments, with env $RUBYFORGE_USERNAME set
-    Given a safe folder
-    Given env variable $RUBYFORGE_USERNAME set to 'nicwilliams'
-    When newgem is executed for project 'my_project' with no options
-    Then file 'config/website.yml.sample' is created
-    And yaml file 'config/website.yml.sample' contains {"host" => "nicwilliams@rubyforge.org", "remote_dir" => "/var/www/gforge-projects/my_project"}
-    And Rakefile can display tasks successfully
-
   Scenario: Run newgem to include rspec
     Given a safe folder
     When newgem is executed for project 'my_rspec_project' with options '-T rspec'
@@ -43,11 +34,20 @@ Feature: Can run 'newgem' to create RubyGem scaffolds
     And does not invoke generator 'install_cucumber'
     And Rakefile can display tasks successfully
 
-  Scenario: Run newgem to disable website
+  Scenario: Run newgem to enable website
     Given a safe folder
-    When newgem is executed for project 'my_project' with options '-W'
-    Then does not invoke generator 'install_website'
-    And file 'config/website.yml' is not created
+    When newgem is executed for project 'my_project' with options '-w'
+    Then does invoke generator 'install_website'
+    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 Rakefile can display tasks successfully
+
+  Scenario: Run newgem to enable website, with env $RUBYFORGE_USERNAME set
+    Given a safe folder
+    Given env variable $RUBYFORGE_USERNAME set to 'nicwilliams'
+    When newgem is executed for project 'my_project' with options '-w'
+    Then file 'config/website.yml.sample' is created
+    And yaml file 'config/website.yml.sample' contains {"host" => "nicwilliams@rubyforge.org", "remote_dir" => "/var/www/gforge-projects/my_project"}
     And Rakefile can display tasks successfully
 
   Scenario: Run newgem to install misc generators on top of unit test framework

data/features/rubygem_tasks.feature

@@ -11,3 +11,9 @@ Feature: Generated RubyGems have various rake tasks to aide their development
     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\)/
+
+  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/
+  

data/features/steps/cli.rb

@@ -1,11 +1,11 @@
 Given %r{^a safe folder} do
   FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
   FileUtils.mkdir_p @tmp_root
+  @newgem_lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
 end
 
 Given /^this project is active project folder/ do
-  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  FileUtils.mkdir_p @tmp_root
+  Given "a safe folder"
   @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
 end
 
@@ -13,26 +13,28 @@ Given /^env variable \$([\w_]+) set to '(.*)'/ do |env_var, value|
   ENV[env_var] = value
 end
 
-def force_local_newgem_priority(project_name)
+def force_local_newgem_priority(project_name = @project_name)
   rakefile = File.read(File.join(project_name, 'Rakefile'))
   File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
-    f << "$:.unshift('#{File.expand_path(File.dirname(__FILE__) + '/../../lib')}')\n"
+    f << "$:.unshift('#{@newgem_lib_path}')\n"
     f << rakefile
   end
 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
+def setup_active_project_folder project_name
+  @active_project_folder = File.join(@tmp_root, project_name)
+  @project_name = project_name
+end
+
+Given %r{^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
   FileUtils.chdir @tmp_root do
     @stdout = "newgem.out"
     system "ruby #{newgem} #{project_name} > #{@stdout}"
-    force_local_newgem_priority project_name
+    force_local_newgem_priority
   end
-  @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
@@ -55,22 +57,21 @@ end
 
 When %r{^newgem is executed for project '(.*)' with no options$} do |project_name|
   newgem = File.expand_path(File.dirname(__FILE__) + "/../../bin/newgem")
+  setup_active_project_folder project_name
   FileUtils.chdir @tmp_root do
     @stdout = "newgem.out"
     system "ruby #{newgem} #{project_name} > #{@stdout}"
-    force_local_newgem_priority project_name
+    force_local_newgem_priority
   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
+  setup_active_project_folder 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)
+    force_local_newgem_priority
   end
 end
 
@@ -100,9 +101,9 @@ When /^run unit tests for test file '(.*)'$/ do |test_file|
 end
 
 When /^task 'rake (.*)' is invoked$/ do |task|
-  @raketask_stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
   FileUtils.chdir(@active_project_folder) do
-    system "rake #{task} > #{@raketask_stdout} 2> #{@raketask_stdout}"
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
   end
 end
 
@@ -155,9 +156,11 @@ Then /^help options '(.*)' and '(.*)' are displayed$/ do |opt1, opt2|
   actual_output.should match(/#{opt2}/)
 end
 
-Then /^output matches \/(.*)\/$/ do |regex|
+Then /^output (does|does not) match \/(.*)\/$/ do |does, regex|
   actual_output = File.read(@stdout)
-  actual_output.should match(/#{regex}/)
+  (does == 'does') ?
+    actual_output.should(match(/#{regex}/)) :
+    actual_output.should_not(match(/#{regex}/)) 
 end
 
 Then /^all (\d+) tests pass$/ do |expected_test_count|
@@ -192,8 +195,8 @@ Then /^Rakefile can display tasks successfully$/ do
 end
 
 Then /^task 'rake (.*)' is executed successfully$/ do |task|
-  @raketask_stdout.should_not be_nil
-  actual_output = File.read(@raketask_stdout)
+  @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

data/lib/newgem.rb

@@ -1,6 +1,8 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require "hoe-patched"
+
 module Newgem
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/tasks/cucumber.rake

@@ -1,6 +1,9 @@
-gem 'cucumber'
-require 'cucumber/rake/task'
+begin
+  gem 'cucumber'
+  require 'cucumber/rake/task'
 
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "--format pretty"
-end
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format pretty"
+  end
+rescue LoadError
+end

data/tasks/deployment.rake

@@ -1,6 +1,11 @@
 task :release do
-  puts "Remember to create tag your release; eg for Git:"
-  puts "  git tag REL-#{$hoe.version}"
+  puts <<-EOS.gsub(/^  /,'')
+  Remember to create tag your release; eg for Git:
+    git tag REL-#{$hoe.version}
+  
+  Announce your release on RubyForge News:
+    rake post_news
+  EOS
 end
 
 desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'

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.1</a>
+        <a href="http://rubyforge.org/projects/newgem" class="numbers">1.0.2</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>

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.1</a>
+        <a href="http://rubyforge.org/projects/newgem" class="numbers">1.0.2</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.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-28 00:00:00 +10:00
+date: 2008-10-30 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.9
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -252,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: newgem
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Quickly bundle any Ruby libraries into a RubyGem and share it with the world, your colleagues, or perhaps just with yourself amongst your projects