methadone-rehab 1.9.2

data/templates/full/bin/executable.erb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+<% if add_library_to_load_path -%>
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+
+<% end -%>
+require 'optparse'
+require 'methadone'
+require '<%= require_file %>'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do # Add args you want: |like,so|
+    # your program code here
+    # You can access CLI options via
+    # the options Hash
+  end
+
+  # supplemental methods here
+
+  # Declare command-line interface here
+
+  # description "one line description of your app"
+  #
+  # Accept flags via:
+  # on("--flag VAL","Some flag")
+  # options[flag] will contain VAL
+  #
+  # Specify switches via:
+  # on("--[no-]switch","Some switch")
+  #
+  # Or, just call OptionParser methods on opts
+  #
+  # Require an argument
+  # arg :some_arg 
+  #
+  # # Make an argument optional
+  # arg :optional_arg, :optional
+
+  version <%= module_name %>::VERSION
+
+  use_log_level_option :toggle_debug_on_signal => 'USR1'
+
+  go!
+end

data/templates/full/features/executable.feature.erb

@@ -0,0 +1,13 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "<%= gemname %>"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+    And the banner should document that this app takes no arguments

data/templates/full/features/step_definitions/executable_steps.rb.erb

@@ -0,0 +1 @@
+# Put your step definitions here

data/templates/full/features/support/env.rb.erb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/templates/full/gplv2_LICENSE.txt.erb

@@ -0,0 +1,14 @@
+<%= render_license_partial('_license_head.txt.erb') %>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, see <http://www.gnu.org/licenses/>.

data/templates/full/gplv3_LICENSE.txt.erb

@@ -0,0 +1,15 @@
+<%= render_license_partial('_license_head.txt.erb') %>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

data/templates/full/mit_LICENSE.txt.erb

@@ -0,0 +1,7 @@
+<%= render_license_partial('_license_head.txt.erb') %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/templates/multicommand/bin/executable.erb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+<% if add_library_to_load_path -%>
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+
+<% end -%>
+require 'optparse'
+require 'methadone'
+require '<%= require_file %>'
+require '<%= gemname %>/commands'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+<% commands.each do |cmd| -%>
+  command "<%= cmd %>" => <%= module_name %>::Commands::<%= titlify(normalize_command(cmd)) %>
+<% end -%>
+
+  main do # Add args you want: |like,so|
+    # your program code here
+    # You can access CLI options via
+    # the options Hash
+  end
+
+  # supplemental methods here
+
+  # Declare command-line interface here
+
+  # description "one line description of your app"
+  #
+  # Accept flags via:
+  # on("--flag VAL","Some flag")
+  # options[flag] will contain VAL
+  #
+  # Specify switches via:
+  # on("--[no-]switch","Some switch")
+  #
+  # Or, just call OptionParser methods on opts
+  #
+  # Require an argument
+  # arg :some_arg 
+  #
+  # # Make an argument optional
+  # arg :optional_arg, :optional
+
+  version <%= module_name %>::VERSION
+
+  use_log_level_option
+
+  go!
+end

data/templates/multicommand/lib/command.rb.erb

@@ -0,0 +1,40 @@
+require 'optparse'
+require 'methadone'
+
+module <%= module_name %> 
+  module Commands
+    class <%= titlify(normalize_command(cmd)) %>
+      include Methadone::Main
+      include Methadone::CLILogging
+
+      main do # Add args you want: |like,so|
+        # your program code here
+        # You can access CLI options via
+        # the options Hash
+      end
+
+      # supplemental methods here
+
+      # Declare command-line interface here
+
+      # description "one line description of your app"
+      description "provides command '<%= cmd -%>'"
+      
+      # Accept flags via:
+      # on("--flag VAL","Some flag")
+      # options[flag] will contain VAL
+      #
+      # Specify switches via:
+      # on("--[no-]switch","Some switch")
+      #
+      # Or, just call OptionParser methods on opts
+      #
+      # Require an argument
+      # arg :some_arg 
+      #
+      # # Make an argument optional
+      # arg :optional_arg, :optional
+    end
+  end
+end
+

data/templates/multicommand/lib/commands.rb.erb

@@ -0,0 +1,7 @@
+Dir[File.dirname(__FILE__) + '/commands/*.rb'].each {|file| require file }
+
+module <%= module_name %>
+  module Commands
+  end
+end
+

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

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

data/templates/test_unit/test/tc_something.rb.erb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TestSomething < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/base_test.rb

@@ -0,0 +1,20 @@
+if RUBY_PLATFORM == 'java'
+  puts "Simplecov seems to cause JRuby to barf, so use another ruby if you want to check coverage"
+else
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/test"
+  end
+end
+
+require 'test/unit'
+require 'rspec/expectations'
+require 'clean_test/test_case'
+require 'ostruct'
+require 'pry'
+
+RSpec::Matchers.configuration.syntax = :should
+
+class BaseTest < Clean::Test::TestCase
+  include RSpec::Matchers
+end

data/test/command_for_tests.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+echo "standard output"
+if [ $# -gt 0 ]; then
+  echo "standard error" 1>&2
+fi
+exit $#

data/test/execution_strategy/test_base.rb

@@ -0,0 +1,24 @@
+require 'base_test'
+
+module ExecutionStrategy
+  class TestBase < BaseTest
+    include Methadone::ExecutionStrategy
+
+    [
+      [:run_command,["ls"]],
+      [:exception_meaning_command_not_found,[]],
+    ].each do |(method,args)|
+      test_that "#{method} isn't implemented" do
+        Given {
+          @strategy = Base.new
+        }
+        When {
+          @code = lambda { @strategy.send(method,*args) }
+        }
+        Then {
+          assert_raises(RuntimeError,&@code)
+        }
+      end
+    end
+  end
+end

data/test/execution_strategy/test_jvm.rb

@@ -0,0 +1,77 @@
+require 'base_test'
+require 'mocha/setup'
+
+# Defined by JRuby, but this test must pass on any Ruby
+class NativeException
+end
+
+module ExecutionStrategy
+  class TestJVM < BaseTest
+    include Methadone::ExecutionStrategy
+
+    test_that "run_command proxies to Open3.capture3" do
+      Given {
+        @process = mock('java.lang.Process')
+        @runtime = mock('java.lang.Runtime')
+        @command = "ls"
+        @stdout = any_string
+        @stderr = any_string
+        @exitstatus = any_int :min => 1, :max => 127
+      }
+      When the_test_runs
+      Then {
+        expects_lang = mock()
+        JVM.any_instance.expects(:java).returns(expects_lang)
+        expects_Runtime = mock()
+        expects_lang.expects(:lang).returns(expects_Runtime)
+        runtime_klass = mock()
+        expects_Runtime.expects(:Runtime).returns(runtime_klass)
+        runtime_klass.expects(:get_runtime).returns(@runtime)
+        @runtime.expects(:exec).with(@command).returns(@process)
+
+        stdin = mock()
+        @process.expects(:get_output_stream).returns(stdin)
+        stdin.expects(:close)
+
+        stdout_input_stream = mock('InputStream')
+        @process.expects(:get_input_stream).returns(stdout_input_stream)
+        stdout_input_stream.expects(:read).times(2).returns(
+          @stdout,
+          -1)
+
+        stderr_input_stream = mock('InputStream')
+        @process.expects(:get_error_stream).returns(stderr_input_stream)
+        stderr_input_stream.expects(:read).times(2).returns(
+          @stderr,
+          -1)
+
+        @process.expects(:wait_for).returns(@exitstatus)
+      }
+
+      Given new_jvm_strategy
+      When {
+        @results = @strategy.run_command(@command)
+      }
+      Then {
+        @results[0].should == @stdout
+        @results[1].should == @stderr
+        @results[2].exitstatus.should == @exitstatus
+      }
+    end
+
+    test_that "exception_meaning_command_not_found returns NativeException" do
+      Given new_jvm_strategy
+      When {
+        @klass = @strategy.exception_meaning_command_not_found
+      }
+      Then {
+        @klass.should == NativeException
+      }
+    end
+
+  private
+    def new_jvm_strategy
+      lambda { @strategy = JVM.new }
+    end
+  end
+end

data/test/execution_strategy/test_mri.rb

@@ -0,0 +1,32 @@
+require 'base_test'
+
+module ExecutionStrategy
+  class TestMRI < BaseTest
+    include Methadone::ExecutionStrategy
+
+    test_that "run_command isn't implemented" do
+      Given new_mri_strategy
+      When {
+        @code = lambda { @strategy.run_command("ls") }
+      }
+      Then {
+        assert_raises(RuntimeError,&@code)
+      }
+    end
+
+    test_that "exception_meaning_command_not_found returns Errno::ENOENT" do
+      Given new_mri_strategy
+      When {
+        @klass = @strategy.exception_meaning_command_not_found
+      }
+      Then {
+        @klass.should == Errno::ENOENT
+      }
+    end
+
+  private
+    def new_mri_strategy
+      lambda { @strategy = MRI.new }
+    end
+  end
+end

data/test/execution_strategy/test_open_3.rb

@@ -0,0 +1,70 @@
+require 'base_test'
+require 'mocha/setup'
+require 'open3'
+
+module ExecutionStrategy
+  class TestOpen_3 < BaseTest
+    include Methadone::ExecutionStrategy
+
+    test_that "run_command proxies to Open3.capture3" do
+      Given {
+        @command = any_string
+        @stdout = any_string
+        @stderr = any_string
+        @status = stub('Process::Status')
+      }
+      When the_test_runs
+      Then {
+        Open3.expects(:capture3).with(@command).returns([@stdout,@stderr,@status])
+      }
+
+      Given new_open_3_strategy
+      When {
+        @results = @strategy.run_command(@command)
+      }
+      Then {
+        @results[0].should == @stdout
+        @results[1].should == @stderr
+        @results[2].should be @status
+      }
+    end
+
+    test_that "run_command handles array arguments properly" do
+      Given {
+        @command = [any_string, any_string, any_string]
+        @stdout = any_string
+        @stderr = any_string
+        @status = stub('Process::Status')
+      }
+      When the_test_runs
+      Then {
+        Open3.expects(:capture3).with(*@command).returns([@stdout,@stderr,@status])
+      }
+
+      Given new_open_3_strategy
+      When {
+        @results = @strategy.run_command(@command)
+      }
+      Then {
+        @results[0].should == @stdout
+        @results[1].should == @stderr
+        @results[2].should be @status
+      }
+    end
+
+    test_that "exception_meaning_command_not_found returns Errno::ENOENT" do
+      Given new_open_3_strategy
+      When {
+        @klass = @strategy.exception_meaning_command_not_found
+      }
+      Then {
+        @klass.should == Errno::ENOENT
+      }
+    end
+
+  private
+    def new_open_3_strategy
+      lambda { @strategy = Open_3.new }
+    end
+  end
+end