newgem 0.29.0 → 1.0.0

data/features/steps/cli.rb

@@ -1,40 +1,82 @@
-Given %r{^a safe folder$} do
-  $tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  FileUtils.rm_rf   $tmp_root
+Given %r{^a safe folder} do
+  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__) + "/../..")
+end
+
+Given /^env variable \$([\w_]+) set to '(.*)'/ do |env_var, value|
+  ENV[env_var] = value
+end
+
+def force_local_newgem_priority(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 << 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
-  $tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  FileUtils.rm_rf   $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
-    newgem_stdout = "newgem.out"
-    system "ruby #{newgem} #{project_name} > #{newgem_stdout}"
+    @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
+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
+    FileUtils.mkdir_p 'config'
+    # config_yml = { "host" => "localhost", "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.rm_rf folder
   end
-  @project_name = project_name
 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
-    @newgem_stdout = "newgem.out"
-    system "ruby #{newgem} #{project_name} > #{@newgem_stdout}"
+    @stdout = "newgem.out"
+    system "ruby #{newgem} #{project_name} > #{@stdout}"
+    force_local_newgem_priority project_name
   end
 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
-    @newgem_stdout = "newgem.out"
-    system "ruby #{newgem} #{arguments} #{project_name} > #{@newgem_stdout}"
+    @stdout = "newgem.out"
+    system "ruby #{newgem} #{arguments} #{project_name} > #{@stdout}"
+    $active_project_folder = File.join($tmp_root, project_name)
   end
 end
 
 When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
-  FileUtils.chdir(File.join($tmp_root, @project_name)) do
+  FileUtils.chdir($active_project_folder) do
     if Object.const_defined?("APP_ROOT")
       APP_ROOT.replace(FileUtils.pwd)
     else 
@@ -45,60 +87,107 @@ When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, argu
 end
 
 When /^run executable '(.*)' with arguments '(.*)'$/ do |executable, arguments|
-  FileUtils.chdir($tmp_root) do
-    @stdout = "#{File.basename(executable)}.out"
+  @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|
-  @test_stdout = File.expand_path(File.join($tmp_root, "tests.out"))
-  FileUtils.chdir(File.join($tmp_root, @project_name)) do
-    system "ruby #{test_file} > #{@test_stdout}"
+  @stdout = File.expand_path(File.join($tmp_root, "tests.out"))
+  FileUtils.chdir($active_project_folder) do
+    system "ruby #{test_file} > #{@stdout}"
   end
 end
 
-Then %r{^folder '(.*)' is created$} do |folder|
-  FileUtils.chdir $tmp_root do
+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}"
+  end
+end
+
+Then %r{^folder '(.*)' is created} do |folder|
+  FileUtils.chdir $active_project_folder do
     File.exists?(folder).should be_true
   end
 end
 
-Then %r{^file '(.*)' is created$} do |file|
-  FileUtils.chdir $tmp_root do
-    File.exists?(file).should be_true
+Then %r{^remote folder '(.*)' is created} do |folder|
+  FileUtils.chdir $remote_folder do
+    File.exists?(folder).should be_true
   end
 end
 
-Then %r{^output matches '(.*)'$} do |file|
-  expected_output = File.read(File.join(File.dirname(__FILE__) + "/../expected_outputs", file))
-  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@newgem_stdout}")
-  actual_output.should == expected_output
+Then %r{^file '(.*)' (is|is not) created} do |file, is|
+  FileUtils.chdir $active_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
 end
 
-Then %r{^invokes generator '(.*)'$} do |generator|
-  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@newgem_stdout}")
-  actual_output.should match(/dependency\s+#{generator}/)
+Then %r{^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
 end
 
-Then %r{^does not invoke generator '(.*)'$} do |generator|
-  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@newgem_stdout}")
-  actual_output.should_not match(/dependency\s+#{generator}/)
+Then /^file matching '(.*)' is created$/ do |pattern|
+  FileUtils.chdir $active_project_folder do
+    Dir[pattern].should_not be_empty
+  end
 end
 
-Then /^help options '(.*)' and '(.*)' are displayed$/ do |opt1, opt2|
+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(File.dirname(__FILE__) + "/../../tmp/#{@stdout}")
+  actual_output.should == expected_output
+end
+
+Then %r{^(does|does not) invoke generator '(.*)'$} do |does_invoke, generator|
+  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}")
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+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 /^output matches \/(.*)\/$/ do |regex|
-  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}")
+  actual_output = File.read(@stdout)
   actual_output.should match(/#{regex}/)
 end
 
 Then /^all (\d+) tests pass$/ do |expected_test_count|
   expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
-  actual_output = File.read(@test_stdout)
+  actual_output = File.read(@stdout)
   actual_output.should match(expected)
 end
+
+Then /^yaml file '(.*)' contains (\{.*\})/ do |file, yaml|
+  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
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+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}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end

data/features/steps/env.rb

@@ -1,9 +1,11 @@
 require File.dirname(__FILE__) + "/../../lib/newgem"
 
 require 'cucumber'
+require 'spec'
 
-require "fileutils"
-require "spec"
+require 'pp'
+require 'fileutils'
+require 'rubygems'
 
 # Following lines from original Rails cucumber generator. 
 # Not sure how to translate/reuse etc yet.

data/lib/newgem/support/tasks.rb

@@ -0,0 +1,10 @@
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+def remove_task(task_name)
+  Rake.application.remove_task(task_name)
+end
+

data/lib/newgem/tasks.rb

@@ -1 +1,2 @@
+require File.dirname(__FILE__) + '/support/tasks'
 Dir[File.join(File.dirname(__FILE__), %w[.. .. tasks], '**/*.rake')].each { |rake| load rake }

data/lib/newgem.rb

@@ -1,6 +1,6 @@
-$:.unshift File.dirname(__FILE__)
-
-module Newgem #:nodoc:
-end
-
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+module Newgem
+  VERSION = '1.0.0'
+end

data/newgem_generators/install_website/install_website_generator.rb

@@ -11,39 +11,42 @@ class InstallWebsiteGenerator < RubiGen::Base
                   :theme   => 'plain_theme'
 
   attr_reader :gem_name, :module_name
-  attr_reader :author, :email, :theme
+  attr_reader :author, :email, :theme, :rubyforge_username
 
   def initialize(runtime_args, runtime_options = {})
     super
-    @destination_root = File.expand_path(destination_root)
-    @gem_name = base_name
-
-    @module_name  = @gem_name.camelcase
+    @destination_root   = File.expand_path(destination_root)
+    @gem_name           = base_name
+    @module_name        = @gem_name.camelcase
+    @rubyforge_username = ENV['RUBYFORGE_USERNAME'].nil? || ENV['RUBYFORGE_USERNAME'].empty? ? 'unknown' : ENV['RUBYFORGE_USERNAME']
     extract_options
   end
 
   def manifest
-    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
     windows            = (RUBY_PLATFORM =~ /dos|win32|cygwin/i) || (RUBY_PLATFORM =~ /(:?mswin|mingw)/)
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
 
     record do |m|
       # Ensure appropriate folder(s) exists
       m.directory 'website/javascripts'
       m.directory 'website/stylesheets'
+      m.directory 'config'
       m.directory 'script'
       m.directory 'tasks'
 
       # Website
       m.template_copy_each %w( index.txt index.html ), "website"
 
+      m.template "config/website.yml.sample.erb", "config/website.yml.sample"
+
+      # m.file_copy_each %w[ website.rake ], "tasks"
+
       %w( txt2html ).each do |file|
         m.template "script/#{file}",        "script/#{file}", script_options
         m.template "script/win_script.cmd", "script/#{file}.cmd",
           :assigns => { :filename => file } if windows
       end
 
-      m.file_copy_each %w[ website.rake ], "tasks"
-
       m.dependency theme, [], :destination => destination_root
     end
   end
@@ -90,4 +93,4 @@ EOS
       end
     end
 
-end
+end

data/newgem_generators/install_website/templates/config/website.yml.sample.erb

@@ -0,0 +1,2 @@
+host: <%= rubyforge_username %>@rubyforge.org
+remote_dir: /var/www/gforge-projects/<%= gem_name %>

data/newgem_generators/install_website/templates/script/txt2html

@@ -1,27 +1,16 @@
 #!/usr/bin/env ruby
 
-GEM_NAME = '<%= gem_name %>' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = '<%= gem_name %>'
-
-require 'rubygems'
-begin
-  require 'newgem'
-  require 'rubyforge'
-rescue LoadError
-  puts "\n\nGenerating the website requires the newgem RubyGem"
-  puts "Install: gem install newgem\n\n"
-  exit(1)
-end
+load File.dirname(__FILE__) + "/../Rakefile"
+require 'rubyforge'
 require 'redcloth'
 require 'syntax/convertors/html'
 require 'erb'
-require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
 
-version  = <%= module_name %>::VERSION::STRING
-download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+download = "http://rubyforge.org/projects/#{$hoe.rubyforge_name}"
+version  = $hoe.version
 
 def rubyforge_project_id
-  RubyForge.new.configure.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+  RubyForge.new.configure.autoconfig["group_ids"][$hoe.rubyforge_name]
 end
 
 class Fixnum

data/newgem_generators/install_website/templates/tasks/website.rake

@@ -1,3 +1,21 @@
+require 'yaml'
+
+def website_config
+  unless @website_config
+    begin
+      @website_config = YAML.load(File.read("config/website.yml"))
+    rescue
+      puts <<-EOS
+To upload your website to a host, you need to configure
+config/website.yml. See config/website.yml.sample for 
+an example.
+EOS
+      exit
+    end
+  end
+  @website_config
+end
+
 desc 'Generate website files'
 task :website_generate => :ruby_env do
   (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
@@ -7,10 +25,22 @@ end
 
 desc 'Upload website files to rubyforge'
 task :website_upload do
-  host = "#{rubyforge_username}@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/#{PATH}/"
-  local_dir = 'website'
-  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+  local_dir  = 'website'
+  host       = website_config["host"]
+  host       = host ? "#{host}:" : ""
+  remote_dir = website_config["remote_dir"]
+  sh %{rsync -aCv #{local_dir}/ #{host}#{remote_dir}}
+end
+
+remove_task :publish_docs # recreate hoe's rubyforge specific version
+
+desc 'Publish RDoc to RubyForge.'
+task :publish_docs => [:clean, :docs] do
+  local_dir  = 'doc'
+  host       = website_config["host"]
+  host       = host ? "#{host}:" : ""
+  remote_dir = File.join(website_config["remote_dir"], "doc")
+  sh %{rsync -aCv #{local_dir}/ #{host}#{remote_dir}}
 end
 
 desc 'Generate and upload website files'

data/rubygems_generators/executable/templates/test/test_cli.rb.erb

@@ -3,6 +3,6 @@ require '<%= bin_name %>/cli'
 
 class Test<%= module_name %>Cli < Test::Unit::TestCase
   def test_execute
-    # <%= module_name %>::CLI.execute
+    <%= module_name %>::CLI.execute
   end
 end

data/script/txt2html

@@ -1,27 +1,16 @@
 #!/usr/bin/env ruby
 
-GEM_NAME = 'newgem' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'newgem'
-
-require 'rubygems'
-begin
-  require 'newgem'
-  require 'rubyforge'
-rescue LoadError
-  puts "\n\nGenerating the website requires the newgem RubyGem"
-  puts "Install: gem install newgem\n\n"
-  exit(1)
-end
+load File.dirname(__FILE__) + "/../Rakefile"
+require 'rubyforge'
 require 'redcloth'
 require 'syntax/convertors/html'
 require 'erb'
-require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
 
-version  = Newgem::VERSION::STRING
-download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+download = "http://rubyforge.org/projects/#{$hoe.rubyforge_name}"
+version  = $hoe.version
 
 def rubyforge_project_id
-  RubyForge.new.configure.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+  RubyForge.new.configure.autoconfig["group_ids"][$hoe.rubyforge_name]
 end
 
 class Fixnum

data/tasks/deployment.rake

@@ -1,7 +1,6 @@
-desc 'Release the website and new gem version'
-task :deploy => [:check_version, :generator_report, :website, :release] do
-  puts "Remember to create Git tag:"
-  puts "  git tag REL-#{VERS}"
+task :release do
+  puts "Remember to create tag your release; eg for Git:"
+  puts "  git tag REL-#{$hoe.version}"
 end
 
 desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
@@ -12,8 +11,8 @@ task :check_version do
     puts 'Must pass a VERSION=x.y.z release version'
     exit
   end
-  unless ENV['VERSION'] == VERS
-    puts "Please update your version.rb to match the release version, currently #{VERS}"
+  unless ENV['VERSION'] == $hoe.version
+    puts "Please update your version.rb to match the release version, currently #{$hoe.version}"
     exit
   end
 end

data/tasks/website.rake

@@ -1,18 +1,46 @@
+require 'yaml'
+
+def website_config
+  unless @website_config
+    begin
+      @website_config = YAML.load(File.read("config/website.yml"))
+    rescue
+      puts <<-EOS
+To upload your website to a host, you need to configure
+config/website.yml. See config/website.yml.sample for 
+an example.
+EOS
+      exit
+    end
+  end
+  @website_config
+end
+
 desc 'Generate website files'
 task :website_generate => :ruby_env do
   (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
     sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
   end
-  sh %{ #{RUBY_APP} script/txt2js website/version.txt > website/version.js }
-  sh %{ #{RUBY_APP} script/txt2js website/version-raw.txt > website/version-raw.js }
 end
 
 desc 'Upload website files to rubyforge'
 task :website_upload do
-  host = "#{rubyforge_username}@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
-  local_dir = 'website'
-  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+  local_dir  = 'website'
+  host       = website_config["host"]
+  host       = host ? "#{host}:" : ""
+  remote_dir = website_config["remote_dir"]
+  sh %{rsync -aCv #{local_dir}/ #{host}#{remote_dir}}
+end
+
+remove_task :publish_docs # recreate hoe's rubyforge specific version
+
+desc 'Publish RDoc to RubyForge.'
+task :publish_docs => [:clean, :docs] do
+  local_dir  = 'doc'
+  host       = website_config["host"]
+  host       = host ? "#{host}:" : ""
+  remote_dir = File.join(website_config["remote_dir"], "rdoc")
+  sh %{rsync -aCv #{local_dir}/ #{host}#{remote_dir}}
 end
 
 desc 'Generate and upload website files'

data/test/test_install_website_generator.rb

@@ -18,6 +18,7 @@ class TestInstallWebsiteGenerator < Test::Unit::TestCase
     %w[index.txt index.html template.html.erb stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
       assert_generated_file("website/#{file}")
     end
+    assert_generated_file("config/website.yml.sample")
     assert_generated_file("script/txt2html")
     assert_generated_file("tasks/website.rake")
   end

data/test/test_newgem_generator.rb

@@ -16,7 +16,6 @@ class TestNewgemGenerator < Test::Unit::TestCase
   def test_newgem
     run_generator('newgem', [APP_ROOT], sources)
 
-    assert_directory_exists "config"
     assert_directory_exists "lib"
     assert_directory_exists "tasks"
     assert_directory_exists "test"
@@ -25,12 +24,7 @@ class TestNewgemGenerator < Test::Unit::TestCase
       assert_generated_file(file)
     end
 
-    %w[hoe.rb requirements.rb].each do |file|
-      assert_generated_file("config/#{file}")
-    end
-
     assert_generated_file("lib/#{gem_name}.rb")
-    assert_generated_file("lib/#{gem_name}/version.rb")
 
     ["test_helper.rb", "test_#{gem_name}.rb"].each do |file|
       assert_generated_file("test/#{file}")
@@ -42,10 +36,6 @@ class TestNewgemGenerator < Test::Unit::TestCase
 
     assert_generated_module("lib/#{gem_name}")
 
-    %w[deployment environment website].each do |file|
-      assert_generated_file("tasks/#{file}.rake")
-    end
-
     assert_manifest_complete
   end