newgem 0.11.0 → 0.13.0

data/tasks/deployment.rake

@@ -0,0 +1,27 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :generator_report, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{RUBYFORGE_USERNAME}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{RUBYFORGE_USERNAME}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:generator_report, :website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    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}"
+    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

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,19 @@
+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}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/test_application_generator_generator.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestApplicationGeneratorGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  
+  def test_generator_without_options
+    name = "mygen"
+    run_generator('application_generator', [name], sources)
+    
+    assert_directory_exists "app_generators"
+    assert_directory_exists "app_generators/#{name}"
+    assert_directory_exists "app_generators/#{name}/templates"
+    assert_generated_file   "app_generators/#{name}/USAGE"
+    assert_generated_class  "app_generators/#{name}/#{name}_generator" do |body|
+      assert_has_method "manifest"
+    end
+    assert_generated_test_for("#{name}_generator") do |body|
+      assert_has_method body, "setup"
+      assert_has_method body, "teardown"
+      assert_has_method body, "test_generator_without_options"
+      assert_has_method body, "sources"
+      assert_has_method body, "generator_path"
+    end
+
+    assert_directory_exists "bin"
+    assert_generated_file   "bin/#{name}"
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "rubygems_generators"
+  end
+end

data/test/test_executable_generator.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestExecutableGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+  
+  def setup
+    rubygems_setup
+  end
+  
+  def teardown
+    rubygems_teardown
+  end
+  
+  def test_generator_without_options
+    app_name = "myapp"
+    run_generator('executable', [app_name], sources)
+    assert_generated_file("bin/#{app_name}")
+  end
+
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "rubygems_generators"
+  end
+end

data/test/test_generate_component_generator.rb

@@ -0,0 +1,67 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestGenerateComponentGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    rubygems_setup
+  end
+  
+  def teardown
+    rubygems_teardown
+  end
+  
+  def test_generator_without_options
+    app_name = "myapp"
+    run_generator('component_generator', [app_name], sources)
+    assert_generated_file("generators/#{app_name}/#{app_name}_generator.rb")
+    assert_generated_file("generators/#{app_name}/USAGE")
+    assert_generated_file("test/test_#{app_name}_generator.rb")
+    assert_generated_file("test/test_generator_helper.rb")
+    assert_directory_exists("generators/#{app_name}/templates")
+    assert_generated_class("generators/#{app_name}/#{app_name}_generator") do |body|
+      # assert_has_method body, "initialize" # as_has_m cannot pickup initialize(...) only initialize
+      assert_has_method body, "manifest"
+    end
+    assert_generated_class("test/test_#{app_name}_generator") do |body|
+      assert_has_method body, "setup"
+      assert_has_method body, "teardown"
+      assert_has_method body, "test_generator_without_options"
+      assert_has_method body, "sources"
+      assert_has_method body, "generator_path"
+    end
+  end
+
+  def test_generator_with_generator_type
+    app_name = "myapp"
+    gen_type = "fooapp"
+    run_generator('component_generator', [app_name, gen_type], sources)
+    
+    assert_generated_file   "#{gen_type}_generators/#{app_name}/#{app_name}_generator.rb"
+    assert_generated_file   "#{gen_type}_generators/#{app_name}/USAGE"
+    assert_generated_file   "test/test_#{app_name}_generator.rb"
+    assert_generated_file   "test/test_generator_helper.rb"
+    assert_directory_exists "#{gen_type}_generators/#{app_name}/templates"
+    assert_generated_class  "#{gen_type}_generators/#{app_name}/#{app_name}_generator" do |body|
+      # assert_has_method body, "initialize" # as_has_m cannot pickup initialize(...) only initialize
+      assert_has_method body, "manifest"
+    end
+    assert_generated_class "test/test_#{app_name}_generator" do |body|
+      assert_has_method body, "setup"
+      assert_has_method body, "teardown"
+      assert_has_method body, "test_generator_without_options"
+      assert_has_method body, "sources"
+      assert_has_method body, "generator_path"
+    end
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"../#{generator_path}"))
+    ]
+  end
+  
+  def generator_path
+    "rubygems_generators"
+  end
+end

data/test/test_generator_helper.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+app_root = File.join(TMP_ROOT, "myproject")
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/test_install_jruby_generator.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestInstallJrubyGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    # see rubygems_setup
+  end
+  
+  def teardown
+    # see rubygems_teardown
+  end
+  
+  def test_generator_without_options
+    name = "myapp"
+    run_generator('install_jruby', [name], sources)
+    assert_generated_file("tasks/jruby.rake")
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "rubygems_generators"
+  end
+end

data/test/test_install_rspec_generator.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestInstallRspecGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    rubygems_setup
+  end
+  
+  def teardown
+    rubygems_teardown
+  end
+  
+  def test_generator_without_options
+    name = File.basename(File.expand_path(APP_ROOT))
+    run_generator('install_rspec', [name], sources)
+    assert_directory_exists("spec")
+    assert_directory_exists("tasks")
+    assert_generated_file("spec/#{name}_spec.rb")
+    assert_generated_file("spec/spec_helper.rb")
+    assert_generated_file("tasks/rspec.rake")
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "rubygems_generators"
+  end
+end

data/test/test_install_website_generator.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestInstallWebsiteGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    rubygems_setup
+  end
+  
+  def teardown
+    rubygems_teardown
+  end
+  
+  def test_generator_without_options
+    name = "myapp"
+    run_generator(generator_name, ['.'], sources)
+    
+    %w[index.txt index.html template.rhtml stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
+      assert_generated_file("website/#{file}")
+    end
+    assert_generated_file("script/txt2html")
+    assert_generated_file("tasks/website.rake")
+  end
+  
+  def test_generator_in_subfolder
+    name = "myapp"
+    subfolder = "subfolder"
+    run_generator(generator_name, ['.'], sources, {:destination => "#{APP_ROOT}/#{subfolder}"})
+    
+    %w[index.txt index.html stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
+      assert_generated_file("#{subfolder}/website/#{file}")
+    end
+    assert_generated_file("#{subfolder}/script/txt2html")
+  end
+  
+  private
+  def sources
+    [ RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path)),
+      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "newgem_theme_generators"))
+    ]
+  end
+  
+  def generator_path
+    "newgem_generators"
+  end
+  
+  def generator_name
+    'install_website'
+  end
+end

data/test/test_newgem_generator.rb

@@ -0,0 +1,120 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestNewgemGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+  
+  attr_reader :gem_name
+  def setup
+    bare_setup
+    @gem_name = File.basename(File.expand_path(APP_ROOT))
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  def test_newgem
+    run_generator('newgem', [APP_ROOT], sources)
+
+    assert_directory_exists "config"
+    assert_directory_exists "lib"
+    assert_directory_exists "log"
+    assert_directory_exists "tasks"
+    assert_directory_exists "test"
+    
+    %w[Rakefile README.txt History.txt License.txt Manifest.txt].each do |file|
+      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}")
+    end
+    
+    %w[generate destroy].each do |file|
+      assert_generated_file("script/#{file}")
+    end
+    
+    assert_generated_module("lib/#{gem_name}")
+    
+    %w[deployment environment website].each do |file|
+      assert_generated_file("tasks/#{file}.rake")
+    end
+    
+    assert_manifest_complete
+  end
+
+  def test_newgem_with_website
+    run_generator('newgem', [APP_ROOT], sources, {:website => true})
+    
+    %w[txt2html].each do |file|
+      assert_generated_file("script/#{file}")
+    end
+    
+    %w[index.txt index.html template.rhtml stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
+      assert_generated_file("website/#{file}")
+    end
+    
+    assert_manifest_complete
+  end
+
+  def test_newgem_with_executable
+    @executables = ["some_executable", "another"]
+    run_generator('newgem', [APP_ROOT], sources, {:bin_name => @executables.join(',')})
+    
+    @executables.each do |exec|
+      assert_generated_file("bin/#{exec}")      
+    end
+    
+    assert_manifest_complete
+  end
+  
+  def test_newgem_with_rspec
+    run_generator('newgem', [APP_ROOT], sources, {:test_framework => "rspec"})
+
+    assert_directory_exists("spec")
+    assert_directory_exists("tasks")
+    assert_generated_file("spec/#{gem_name}_spec.rb")
+    assert_generated_file("spec/spec_helper.rb")
+    assert_generated_file("tasks/rspec.rake")
+    
+    assert_manifest_complete
+  end
+  
+  def test_newgem_with_jruby
+    run_generator('newgem', [APP_ROOT], sources, {:jruby => true})
+
+    assert_directory_exists("tasks")
+    assert_generated_file("tasks/jruby.rake")
+    
+    assert_manifest_complete
+  end
+  
+  private
+  def sources
+    [ RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path)),
+      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "newgem_generators")),
+      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "newgem_theme_generators")),
+      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "rubygems_generators"))
+    ]
+  end
+  
+  def generator_path
+    "app_generators"
+  end
+  
+  def assert_manifest_complete
+    files = app_root_files.sort
+    files.reject! { |file| File.directory?(file) }
+    files.map! { |path| path.sub("#{APP_ROOT}/","") }
+    files.reject! { |file| /^#{APP_ROOT}/ =~ file }
+    manifest_files = File.open("#{APP_ROOT}/Manifest.txt","r") { |f| f.readlines.map { |line| line.strip } }
+    assert_equal(files, manifest_files)
+  end
+end