newgem 1.4.1 → 1.5.0

data/Rakefile

@@ -1,60 +1,28 @@
-require 'rubygems' unless ENV['NO_RUBYGEMS']
-%w[rake rake/clean fileutils rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/newgem'
+gem 'hoe', '>= 2.3.0'
+require 'hoe'
+%w[fileutils rubigen].each { |f| require f }
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+Hoe.plugin :newgem
+Hoe.plugin :website
+Hoe.plugin :cucumberfeatures
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('newgem', Newgem::VERSION) do |p|
-  p.developer('Dr Nic Williams', 'drnicwilliams@gmail.com')
-  p.changes              = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt'
-  p.extra_deps           = [
+$hoe = Hoe.spec 'newgem' do
+  developer 'Dr Nic Williams', 'drnicwilliams@gmail.com'
+  self.post_install_message = 'PostInstall.txt'
+  self.extra_deps           = [
     ['activesupport','>= 2.0.2'],
     ['rubigen',">= #{RubiGen::VERSION}"],
     ['hoe', ">= #{Hoe::VERSION}"],
-    ['RedCloth','>= 4.0.0'], # for website generation
+    ['RedCloth','= 4.1.1'], # for website generation
     ['syntax','>= 1.0.0']
   ]
-  p.extra_dev_deps = [
-    ['cucumber', ">= 0.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')
-  p.rsync_args = '-av --delete --ignore-errors'
+  extra_dev_deps << ['cucumber', ">= 0.3.11"]
 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
+require 'newgem/tasks'
 
 remove_task :default
 task :default => :features

data/app_generators/newgem/newgem_generator.rb

@@ -22,7 +22,7 @@ class NewgemGenerator < RubiGen::Base
   # extensions/option
   attr_reader :test_framework
   attr_reader :bin_names_list
-  attr_reader :enable_website
+  attr_reader :enable_website, :enable_cucumber
   attr_reader :manifest
   attr_reader :is_jruby
 
@@ -166,6 +166,7 @@ EOS
       @is_jruby           = options[:jruby]
       @project_name       = options[:project] if options.include?(:project)
       @install_generators = options[:install] || []
+      @enable_cucumber    = @install_generators.include?('cucumber')
     end
     
     # first attempt to merge config args (single string) and runtime args
@@ -183,9 +184,7 @@ EOS
   # Installation skeleton.  Intermediate directories are automatically
   # created so don't sweat their absence here.
   BASEDIRS = %w(
-    doc
     lib
     script
-    tasks
   )
 end

data/app_generators/newgem/templates/History.txt

@@ -1,4 +1,4 @@
-== <%= version_str %> <%= Date.today %>
+=== <%= version_str %> <%= Date.today %>
 
 * 1 major enhancement:
   * Initial release

data/app_generators/newgem/templates/Rakefile

@@ -1,31 +1,28 @@
-require 'rubygems' unless ENV['NO_RUBYGEMS']
-%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/<%= gem_name %>'
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/<%= gem_name %>'
+
+Hoe.plugin :newgem
+<%= enable_website ? '' : '# ' %>Hoe.plugin :website
+<%= enable_cucumber ? '' : '# ' %>Hoe.plugin :cucumber_features
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('<%= gem_name %>', <%= module_name %>::VERSION) do |p|
-  p.developer('<%= author %>', '<%= email %>')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = p.name # TODO this is default value
-  # p.extra_deps         = [
-  #   ['activesupport','>= 2.0.2'],
-  # ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  <% if is_jruby -%>
-  p.spec_extras['platform'] = 'jruby' # JRuby gem created, e.g. <%= gem_name %>-X.Y.Z-jruby.gem
-  <% end -%>
-  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')
-  p.rsync_args = '-av --delete --ignore-errors'
+$hoe = Hoe.spec '<%= gem_name %>' do
+  self.developer '<%= author %>', '<%= email %>'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+  <%- if is_jruby -%>
+  self.spec_extras['platform'] = 'jruby' # JRuby gem created, e.g. <%= gem_name %>-X.Y.Z-jruby.gem
+  <%- end -%>
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
+require 'newgem/tasks'
 Dir['tasks/**/*.rake'].each { |t| load t }
 
 # TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
 # task :default => [:spec, :features]

data/app_generators/newgem_simple/templates/Rakefile

@@ -4,24 +4,18 @@ require 'rubygems/specification'
 require 'date'
 require 'spec/rake/spectask'
 
-GEM = "<%= name %>"
-GEM_VERSION = "0.0.1"
-AUTHOR = "Your Name"
-EMAIL = "Your Email"
-HOMEPAGE = "http://example.com"
-SUMMARY = "A gem that provides..."
-
 spec = Gem::Specification.new do |s|
-  s.name = GEM
-  s.version = GEM_VERSION
+  s.name = "<%= name %>"
+  s.version = "0.0.1"
+  s.author = "Your Name"
+  s.email = "Your Email"
+  s.homepage = "http://example.com"
+  s.description = s.summary = "A gem that provides..."
+  
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
   s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
   s.summary = SUMMARY
-  s.description = s.summary
-  s.author = AUTHOR
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
   
   # Uncomment this to add a dependency
   # s.add_dependency "foo"

data/features/install_cucumber.feature

@@ -8,6 +8,7 @@ Feature: RubyGems have features to be described and tested
     Given default env variables setup for name and email
     And an existing newgem scaffold [called "my_project"]
     When I invoke "install_cucumber" generator with arguments ""
+    And I enable hoe plugin "cucumber_features"
     Then folder "features/step_definitions" is created
     Then folder "features/support" is created
     And file "features/development.feature" is created
@@ -21,14 +22,17 @@ Feature: RubyGems have features to be described and tested
     Given default env variables setup for name and email
     And an existing newgem scaffold [called "my_project"]
     When I invoke "install_cucumber" generator with arguments ""
+    And I enable hoe plugin "cucumber_features"
     Then gem file "features/step_definitions/common_steps.rb" and generated file "features/step_definitions/common_steps.rb" should be the same
     Then gem file "features/support/common.rb" and generated file "features/support/common.rb" should be the same
     Then gem file "features/support/matchers.rb" and generated file "features/support/matchers.rb" should be the same
     Then gem file "features/development.feature" and generated file "features/development.feature" should be the same
 
   Scenario: Installed Cucumber includes a "rake features" task
-    Given an existing newgem scaffold [called "my_project"]
+    Given default env variables setup for name and email
+    And an existing newgem scaffold [called "my_project"]
     And I invoke "install_cucumber" generator with arguments ""
+    And I enable hoe plugin "cucumber_features"
     And I invoke task "rake manifest"
     When I invoke task "rake features"
     Then task "rake features" is executed successfully

data/features/install_website.feature

@@ -5,7 +5,7 @@ Feature: RubyGems can have a website to promote and teach
   So that I can spend time on the tests and code, and not excessive time on maintenance processes
 
   Scenario: Deploy project website via local rsync
-    Given an existing newgem scaffold [called "my_project"]
+    Given an existing newgem scaffold using options "-w" [called "my_project"]
     And project website configuration for safe folder on local machine
     When I invoke "install_website" generator with arguments ""
     And I invoke task "rake website"

data/features/newgem_cli.feature

@@ -5,7 +5,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
   So that I can rapidly produce specs and code for encapsulated applications and libraries
 
   Scenario: Run newgem without any arguments
-    Given a safe folder
     Given env variable $RUBYFORGE_USERNAME set to ""
     When newgem is executed for project "my_project" with no options
     Then file "Rakefile" is created
@@ -19,10 +18,8 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     And I should see
       """
             create  
-            create  doc
             create  lib
             create  script
-            create  tasks
             create  lib/my_project
             create  History.txt
             create  Rakefile
@@ -51,13 +48,11 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     Then I should see all 1 tests pass
 
   Scenario: Run newgem with project name containing hypens
-    Given a safe folder
     Given env variable $RUBYFORGE_USERNAME set to ""
     When newgem is executed for project "my-project" with no options
     Then 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"
     Then does invoke generator "install_rspec"
     And does not invoke generator "install_test_unit"
@@ -68,7 +63,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     Then I should see all 1 examples pass
 
   Scenario: Run newgem to include shoulda
-    Given a safe folder
     When newgem is executed for project "my_shoulda_project" with options "-T shoulda"
     Then does invoke generator "install_shoulda"
     And does not invoke generator "install_test_unit"
@@ -79,7 +73,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     Then I should see all 1 tests pass
 
   Scenario: Run newgem to enable website
-    Given a safe folder
     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
@@ -87,7 +80,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     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
@@ -95,7 +87,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     And Rakefile can display tasks successfully
 
   Scenario: Run newgem to install misc generators on top of unit test framework
-    Given a safe folder
     When newgem is executed for project "my_project" with options "-i cucumber"
     Then does invoke generator "install_test_unit"
     And does invoke generator "install_cucumber"
@@ -103,7 +94,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     And Rakefile can display tasks successfully
 
   Scenario: Run newgem to pull in defaults from ~/.newgem.yml file and no argument options
-    Given a safe folder
     And ~/.newgem.yml contains {"default" => "-T rspec -i cucumber"}
     When newgem is executed for project "my_project" with options ""
     Then does invoke generator "install_rspec"
@@ -113,7 +103,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     And Rakefile can display tasks successfully
 
   Scenario: Run newgem to pull in defaults from ~/.newgem.yml file and merge with runtime args
-    Given a safe folder
     And ~/.newgem.yml contains {"default" => "-T rspec -i cucumber"}
     When newgem is executed for project "my_project" with options "-i website"
     Then does invoke generator "install_rspec"
@@ -123,7 +112,6 @@ Feature: Can run "newgem" to create RubyGem scaffolds
     And Rakefile can display tasks successfully
 
   Scenario: Run newgem and show current version number
-    Given a safe folder
     When newgem is executed only with options "--version"
     Then shows version number
   

data/features/step_definitions/cli_steps.rb

@@ -4,7 +4,6 @@ Given /^default env variables setup for name and email$/ do
 end
 
 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
   in_tmp_folder do
@@ -15,7 +14,6 @@ Given /^an existing newgem scaffold \[called "(.*)"\]/ do |project_name|
 end
 
 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
   in_tmp_folder do

data/features/step_definitions/common_steps.rb

@@ -1,13 +1,4 @@
-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 %Q{env variable $HOME set to "#{@home_path}"}
-end
-
 Given /^this project is active project folder/ do
-  Given "a safe folder"
   @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
 end
 

data/features/step_definitions/rubygems_steps.rb

@@ -1,3 +1,11 @@
+Given /^I enable hoe plugin "([^\"]*)"$/ do |plugin|
+  in_project_folder do
+    rakefile = File.read('Rakefile')
+    rakefile.gsub!(/^#\s*(Hoe.plugin :#{plugin})/, '\1')
+    File.open("Rakefile", "w") { |file| file << rakefile }
+  end
+end
+
 Then /^gemspec builds the RubyGem successfully$/ do
   @stdout = File.expand_path(File.join(@tmp_root, "rake.out"))
   in_project_folder do

data/features/support/env.rb

@@ -7,17 +7,13 @@ require 'pp'
 require 'fileutils'
 require 'rubygems' unless ENV['NO_RUBYGEMS']
 
-# 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'
+Before do
+  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  FileUtils.rm_rf   @tmp_root
+  FileUtils.mkdir_p @home_path
+  ENV['HOME'] = @home_path
+end
 
 # code from test/test_generator_helper.rb
 TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)

data/lib/hoe/cucumberfeatures.rb

@@ -0,0 +1,22 @@
+##
+# Cucumber plugin for hoe.
+#
+# === Tasks Provided:
+#
+# features::  Run cucumber feature
+
+module Hoe::Cucumberfeatures
+  
+  def define_cucumberfeatures_tasks
+    begin
+      gem 'cucumber'
+      require 'cucumber/rake/task'
+
+      Cucumber::Rake::Task.new(:features) do |t|
+        t.cucumber_opts = "--format progress"
+      end
+    rescue LoadError => e
+      p e
+    end
+  end
+end

data/lib/hoe/manifest.rb

@@ -0,0 +1,30 @@
+##
+# Manifest plugin for hoe.
+#
+# === Tasks Provided:
+#
+# manifest::  Recreate the Manifest.txt
+
+module Hoe::Manifest
+
+  ##
+  # Define tasks for plugin.
+  def define_manifest_tasks
+    desc 'Recreate Manifest.txt to include ALL files to be deployed'
+    task :manifest => :clean do
+      require 'find'
+      files = []
+      with_config do |config, _|
+        exclusions = config["exclude"]
+        abort "exclude entry missing from .hoerc. Aborting." if exclusions.nil?
+        Find.find '.' do |path|
+          next unless File.file? path
+          next if path =~ exclusions
+          files << path[2..-1]
+        end
+        files = files.sort.join "\n"
+        File.open 'Manifest.txt', 'w' do |fp| fp.puts files end
+      end
+    end
+  end
+end

data/lib/hoe/newgem.rb

@@ -0,0 +1,74 @@
+##
+# Gemspec plugin for hoe.
+#
+# === Tasks Provided:
+#
+# gemspec::  Generate the gemspec file
+# release
+
+Hoe.plugin :manifest
+
+module Hoe::Newgem
+  def initialize_newgem
+    require(File.dirname(__FILE__) + "/../newgem")
+    require 'newgem/tasks'
+
+    self.clean_globs |= %w[**/.DS_Store tmp *.log]
+    path = (self.rubyforge_name == self.name) ? self.rubyforge_name : "\#{self.rubyforge_name}/\#{self.name}"
+    self.remote_rdoc_dir = File.join(path.gsub(/^#{self.rubyforge_name}\/?/,''), 'rdoc')
+    self.rsync_args = '-av --delete --ignore-errors'
+    self.readme_file = "README.rdoc"
+  end
+  
+  # Define +gemspec+ task if not already defined
+  def define_newgem_tasks
+    unless self.extra_dev_deps.find { |dep| dep.first == 'newgem' }
+      require File.dirname(__FILE__) + '/../newgem'
+      self.extra_dev_deps ||= []
+      self.extra_dev_deps << ['newgem', ">= #{::Newgem::VERSION}"]
+    end
+    
+    return if Rake::Task.tasks.find { |t| t.name == 'gemspec' }
+    desc "Generate a #{name}.gemspec file"
+    task :gemspec do
+      File.open("#{name}.gemspec", "w") do |file|
+        file.puts spec.to_ruby
+      end
+    end
+    
+    task :release do
+      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
+
+    task :check_version do
+      unless ENV['VERSION']
+        puts 'Must pass a VERSION=x.y.z release version'
+        exit
+      end
+      unless ENV['VERSION'] == $hoe.version
+        puts "Please update your lib/#{$hoe.name}.rb to match the release version, currently #{$hoe.version}"
+        exit
+      end
+    end
+
+    desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+    task :install_gem_no_doc => [:clean, :package] do
+      sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+    end
+    
+    task :ruby_env do
+      $ruby_app = if RUBY_PLATFORM =~ /java/
+        "jruby"
+      else
+        "ruby"
+      end
+    end
+    
+  end
+end