methadone 1.9.5 → 2.0.0

data/lib/methadone/version.rb

@@ -1,3 +1,3 @@
 module Methadone #:nodoc:
-  VERSION = "1.9.5" #:nodoc:
+  VERSION = "2.0.0"
 end

data/methadone.gemspec

@@ -20,12 +20,10 @@ Gem::Specification.new do |s|
   s.add_dependency("bundler")
   s.add_development_dependency("rake")
   s.add_development_dependency("rdoc","~> 5.0")
-  s.add_development_dependency("cucumber")
-  s.add_development_dependency("aruba", "0.5.1")
   s.add_development_dependency("simplecov", "~> 0.5")
   s.add_development_dependency("clean_test")
-  s.add_development_dependency("mocha", "0.13.2")
+  s.add_development_dependency("mocha")
   s.add_development_dependency("sdoc", "1.0.0.rc1")
-  s.add_development_dependency("rspec", "~> 3")
-  s.add_development_dependency("i18n", "= 0.6.1")
+  s.add_development_dependency("rspec") # needed for testing the generated tests
+  s.add_development_dependency("i18n")
 end

data/templates/full/Rakefile.erb

@@ -35,8 +35,6 @@ end
 <% else %>
 require 'rake/testtask'
 <% end %>
-require 'cucumber'
-require 'cucumber/rake/task'
 gem 'rdoc' # we need the installed RDoc gem, not the system one
 require 'rdoc/task'
 
@@ -50,25 +48,24 @@ RSpec::Core::RakeTask.new do |t|
 end
 <% else %>
 Rake::TestTask.new do |t|
-  t.pattern = 'test/tc_*.rb'
+  t.pattern = 'test/unit/test_*.rb'
 end
-<% end %>
 
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
-  t.fork = false
+Rake::TestTask.new("test:integration") do |t|
+  t.pattern = 'test/integration/test_*.rb'
 end
+<% end %>
 
 Rake::RDocTask.new do |rd|
   <% if using_readme %>
   rd.main = "README.rdoc"
-  <% end %>
   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  <% else %>
+  rd.rdoc_files.include("lib/**/*.rb","bin/**/*")
+  <% end %>
 end
 <% if rspec %>
-task :default => [:spec,:features]
+task :default => [:spec]
 <% else %>
-task :default => [:test,:features]
+task :default => [:test,"test:integration"]
 <% end %>

data/templates/full/bin/executable.erb

@@ -39,5 +39,7 @@ class App
 
   use_log_level_option :toggle_debug_on_signal => 'USR1'
 
+  description "My awesome command line app!"
+
   go!
 end

data/templates/rspec/spec/something_spec.rb.erb

@@ -1,4 +1,4 @@
-describe "TestSomething" do
+RSpec.describe "TestSomething" do
   it "should be true" do
     expect(true).to eq(true)
   end

data/templates/test_unit/test/integration/test_cli.rb.erb

@@ -0,0 +1,11 @@
+require "methadone/test/base_integration_test"
+
+class TestSomething < Methadone::BaseIntegrationTest
+  def test_truth
+    stdout,stderr,results = run_app("<%= gemname %>","--help")
+    assert_banner(stdout, "<%= gemname %>", takes_options: true, takes_arguments: false)
+    assert_option(stdout,"-h", "--help")
+    assert_option(stdout,"--version")
+    assert_oneline_summary(stdout)
+  end
+end

data/test/integration/base_integration_test.rb

@@ -0,0 +1,60 @@
+require "methadone/test/base_integration_test"
+require "clean_test/test_case"
+
+class BaseIntegrationTest < Methadone::BaseIntegrationTest
+  include Clean::Test::GivenWhenThen
+  include Clean::Test::TestThat
+  include Clean::Test::Any
+  def setup
+    root = (Pathname(__FILE__).dirname / ".." / "..").expand_path
+    ENV["PATH"] = (root / "bin").to_s + File::PATH_SEPARATOR + ENV["PATH"]
+    ENV["RUBYLIB"] = (root / "lib").to_s + File::PATH_SEPARATOR + ENV["RUBYLIB"]
+    @pwd = pwd
+    @tmdir = Dir.mktmpdir
+    chdir @tmdir
+  end
+
+  def teardown
+    chdir @pwd
+    rm_rf @tmdir
+  end
+
+private
+
+  def methadone(args, allow_failure: false)
+    command = "methadone #{args}"
+    stdout, stderr, status = Open3.capture3(command)
+    if !status.success? && !allow_failure
+      raise "'#{command}' failed: #{status.inspect}\n\nSTDOUT:\n\n#{stdout}\n\nSTDERR:\n\n#{stderr}\nEND"
+    end
+    [ stdout, stderr, status ]
+  end
+
+  def run_app(gemname,args="")
+    run_in_gem(gemname, "bin/#{gemname}", args)
+  end
+
+  # Runs rake inside the app for an integration test, returning stdout and stderr as strings
+  def rake(gemname,args="")
+    run_in_gem(gemname, "rake", args)
+  end
+
+  # Runs an arbitrary command inside the gem, returning stdout and stderr as strings.
+  def run_in_gem(gemname, command, args)
+    stdout = nil
+    stderr = nil
+    original_rubylib = ENV["RUBYLIB"]
+    chdir gemname do
+      ENV["RUBYLIB"] = "lib" + File::PATH_SEPARATOR + original_rubylib
+      stdout, stderr, result = Open3.capture3("#{command} #{args}")
+      unless result.success?
+        raise "#{stdout}\n#{stderr}"
+      end
+    end
+    [ stdout, stderr ]
+  ensure
+    ENV["RUBYLIB"] = original_rubylib
+  end
+
+
+end

data/test/integration/test_bootstrap.rb

@@ -0,0 +1,150 @@
+require_relative "base_integration_test"
+
+include FileUtils
+
+class TestBootstrap < BaseIntegrationTest
+  test_that "bootstrapping a new app generates basic boilerplate" do
+    When { methadone "newgem" }
+    Then {
+      [
+        "bin/newgem",
+        "lib/newgem.rb",
+        "lib/newgem/version.rb",
+        "newgem.gemspec",
+        "README.rdoc",
+        "Rakefile",
+      ].each do |file|
+        assert File.exist?("newgem/#{file}"), "Expected newgem/#{file} to exist"
+      end
+    }
+    And {
+      assert_all_files_staged_in_git
+    }
+    When { @stdout, _ = run_app("newgem", "--help") }
+    Then {
+      assert_banner(@stdout, "newgem", takes_options: true, takes_arguments: false)
+      assert_standard_options(@stdout)
+    }
+    When { @stdout, _ = rake("newgem", "-T") }
+    Then {
+      assert_supports_basic_rake_tasks(@stdout)
+    }
+    When { @stdout, _ = rake("newgem", "") }
+    Then {
+      assert_match(/1 tests, 1 assertions, 0 failures, 0 errors/,@stdout)
+      assert_match(/1 tests, 8 assertions, 0 failures, 0 errors/,@stdout) # integration test
+    }
+    And {
+      gemspec = File.read("newgem/newgem.gemspec")
+      refute_match(/TODO/,gemspec)
+      refute_match(/FIXME/,gemspec)
+    }
+  end
+
+  test_that "bootstrapping a new app with a dash in its name works" do
+    When { methadone "new-gem" }
+    Then {
+      [
+        "bin/new-gem",
+        "lib/new/gem.rb",
+        "lib/new/gem/version.rb",
+        "new-gem.gemspec",
+        "README.rdoc",
+        "Rakefile",
+      ].each do |file|
+        assert File.exist?("new-gem/#{file}"), "Expected new-gem/#{file} to exist: #{`ls -ltR new-gem`}}"
+      end
+    }
+    When { @stdout, _ = run_app("new-gem", "--help") }
+    Then {
+      assert_banner(@stdout, "new-gem", takes_options: true, takes_arguments: false)
+      assert_standard_options(@stdout)
+    }
+    When { @stdout, _ = rake("new-gem", "-T") }
+    Then {
+      assert_supports_basic_rake_tasks(@stdout)
+    }
+    When { @stdout, _ = rake("new-gem", "") }
+    Then {
+      assert_match(/1 tests, 1 assertions, 0 failures, 0 errors/,@stdout)
+      assert_match(/1 tests, 8 assertions, 0 failures, 0 errors/,@stdout) # integration test
+    }
+    And {
+      gemspec = File.read("new-gem/new-gem.gemspec")
+      refute_match(/TODO/,gemspec)
+      refute_match(/FIXME/,gemspec)
+    }
+  end
+
+  test_that "won't overwrite an existing dir" do
+    Given { methadone "newgem" }
+    And {
+      File.open("newgem/new_file.txt","w") do |file|
+        file.puts "Creating a file to verify it doesn't get blown away"
+      end
+    }
+    When { @stdout, @stderr, @status = methadone "newgem", allow_failure: true }
+    Then {
+      assert File.exist?("newgem/new_file.txt")
+    }
+    And {
+      refute @status.success?
+    }
+    And {
+      assert_match(/#{Regexp.escape("error: newgem exists, use --force to override")}/,@stderr)
+    }
+  end
+
+  test_that "will overwrite an existing dir with --force" do
+    Given { methadone "newgem" }
+    And {
+      File.open("newgem/new_file.txt","w") do |file|
+        file.puts "Creating a file to verify it doesn't get blown away"
+      end
+    }
+    When { @stdout, @stderr, @status = methadone "newgem --force", allow_failure: true }
+    Then {
+      refute File.exist?("newgem/new_file.txt")
+    }
+    And {
+      assert @status.success?
+    }
+  end
+
+  test_that "must supply a gem name" do
+    When { _, @stderr, @status = methadone "", allow_failure: true }
+    Then {
+      refute @status.success?
+    }
+    And {
+      assert_match(/\'app_name\' is required/,@stderr)
+    }
+  end
+
+  def assert_standard_options(stdout)
+    assert_option(stdout,"--version")
+    assert_option(stdout,"--help")
+    assert_option(stdout,"--log-level")
+  end
+
+  def assert_supports_basic_rake_tasks(stdout)
+    [
+      :clean,
+      :clobber,
+      :clobber_rdoc,
+      :rdoc,
+      :release,
+      :rerdoc,
+      :test,
+      :install,
+      :build,
+    ].each do |rake_task|
+      assert_match(/rake #{rake_task}/,stdout)
+    end
+  end
+
+  def assert_all_files_staged_in_git
+    stdout, _, __ = run_in_gem("newgem", "git", "ls-files --others --deleted")
+    assert_match(/\A\Z/, stdout)
+  end
+end

data/test/integration/test_cli.rb

@@ -0,0 +1,21 @@
+require_relative "base_integration_test"
+
+include FileUtils
+
+class TestCli < BaseIntegrationTest
+  test_that "methadone CLI is properly documented" do
+    When { @stdout, _, __ = methadone "--help" }
+    Then {
+      assert_banner(@stdout, "methadone", takes_options: true, takes_arguments: { app_name: :required })
+    }
+    And {
+      assert_option(@stdout, "--force")
+      assert_option(@stdout, "--[no-]readme")
+      assert_option(@stdout, "-l", "--license")
+      assert_option(@stdout, "--log-level")
+    }
+    And {
+      assert_oneline_summary(@stdout)
+    }
+  end
+end

data/test/integration/test_license.rb

@@ -0,0 +1,56 @@
+require_relative "base_integration_test"
+
+include FileUtils
+
+class TestLicense < BaseIntegrationTest
+  test_that "omitting a license generates a warning" do
+    When { _, @stderr, __ = methadone "newgem" }
+    Then {
+      assert_match(/warning: your app has no license/,@stderr)
+    }
+  end
+
+  test_that "explicitly omitting a license does not generate a warning" do
+    When { _, @stderr, __ = methadone "newgem -l NONE" }
+    Then {
+      refute_match(/warning: your app has no license/,@stderr)
+    }
+  end
+
+  [
+    "apache",
+    "mit",
+    "gplv2",
+    "gplv3",
+  ].each do |license|
+    test_that "the #{license} license can be included" do
+      When { methadone "newgem -l #{license}" }
+      Then {
+        assert File.exist?("newgem/LICENSE.txt")
+      }
+      And {
+        assert_file("newgem/newgem.gemspec", contains: /#{license.upcase}/)
+      }
+    end
+  end
+
+  test_that "a custom license can be included" do
+    When { methadone "newgem -l custom" }
+    Then {
+      assert File.exist?("newgem/LICENSE.txt")
+    }
+    And {
+      assert_equal "", File.read("newgem/LICENSE.txt").strip
+    }
+  end
+
+  test_that "a non-custom non-supported license causes an error" do
+    When { _, @stderr, @result = methadone "newgem -l foobar", allow_failure: true }
+    Then {
+      refute @result.success?
+    }
+    And {
+      assert_match(/invalid argument: -l foobar/,@stderr)
+    }
+  end
+end

data/test/integration/test_readme.rb

@@ -0,0 +1,53 @@
+require_relative "base_integration_test"
+class TestReadme < BaseIntegrationTest
+  test_that "a reasonable README is created" do
+    When {
+      methadone "newgem --readme"
+    }
+    Then {
+      assert File.exist?("newgem/README.rdoc")
+    }
+    And {
+      readmes = Dir["newgem/README*"].to_a
+      assert_equal 1, readmes.size,"Found more than one README: #{readmes.inspect}"
+    }
+    And {
+      rakefile_contents = File.read("newgem/Rakefile")
+      assert_match(/README.rdoc/,rakefile_contents)
+      assert_match(/rd.main = ["']README.rdoc["']/,rakefile_contents)
+    }
+    And {
+      assert_file("newgem/README.rdoc",
+                  contains: [
+                    /newgem/,
+                    /Author::  YOUR NAME \(YOUR EMAIL\)/,
+                    /\* \{Source on Github\}\[LINK TO GITHUB\]/,
+                    /RDoc\[LINK TO RDOC.INFO\]/,
+                    /^== Install/,
+                    /^== Examples/,
+                    /^== Contributing/,
+      ])
+    }
+  end
+
+  test_that "a readme is created by default" do
+    When {
+      methadone "newgem"
+    }
+    Then {
+      assert File.exist?("newgem/README.rdoc")
+    }
+  end
+
+  test_that "we can omit a README" do
+    When {
+      methadone "--no-readme newgem"
+    }
+    Then {
+      refute File.exist?("newgem/README.rdoc")
+    }
+    And {
+      refute_match(/README/,File.read("newgem/Rakefile"))
+    }
+  end
+end

data/test/integration/test_rspec.rb

@@ -0,0 +1,28 @@
+require_relative "base_integration_test"
+
+include FileUtils
+
+class TestRSpec < BaseIntegrationTest
+  test_that "we can generate an app using RSpec instead of Test::Unit" do
+    When { methadone "--rspec newgem" }
+    Then {
+      refute Dir.exist?("newgem/test")
+      assert Dir.exist?("newgem/spec")
+      assert File.exist?("newgem/spec/something_spec.rb")
+    }
+    And {
+      assert_file("newgem/newgem.gemspec", contains: /add_development_dependency\(["']rspec["']/)
+    }
+    And {
+      stdout,_ = rake("newgem", "-T")
+      assert_match(/rake spec/,stdout)
+      refute_match(/rake testa/,stdout)
+    }
+    When {
+      @stdout, _ = rake("newgem","spec")
+    }
+    Then {
+      assert_match(/1 example,.*0 failures/,@stdout)
+    }
+  end
+end