methadone 0.4.1 → 0.5.1

data/bin/methadone

@@ -32,9 +32,13 @@ main do |app_name|
 
   license = options[:license]
   if license
-    copy_file "#{options[:license]}_LICENSE.txt", :as => "LICENSE.txt"
+    if license == 'NONE'
+      license = nil
+    else
+      copy_file "#{options[:license]}_LICENSE.txt", :as => "LICENSE.txt"
+    end
   else
-    warn "your app has no license"
+    warn "warning: your app has no license"
   end
 
 
@@ -61,7 +65,7 @@ description "Kick the bash habit by bootstrapping your Ruby command-line apps"
 on("--force","Overwrite files if they exist")
 on("--[no-]readme","[Do not ]produce a README file")
 
-licenses = %w(mit apache custom)
+licenses = %w(mit apache custom NONE)
 on("-l LICENSE","--license",licenses,"Specify the license for your project (#{licenses.join('|')})")
 
 arg :app_name, :required

data/features/license.feature

@@ -28,5 +28,10 @@ Feature: Users should get the license included
 
   Scenario: No license specified
     When I successfully run `methadone tmp/newgem`
-    Then the stderr should contain "your app has no license"
+    Then the stderr should contain "warning: your app has no license"
+    And the README should not reference a license
+
+  Scenario: No license specified explicitly
+    When I successfully run `methadone -l NONE tmp/newgem`
+    Then the stderr should not contain "warning: your app has no license"
     And the README should not reference a license

data/lib/methadone/cli_logging.rb

@@ -30,14 +30,21 @@ module Methadone
     end
 
     # Change the global logger that includers will use.  Useful if you
-    # don't want the default configured logger.
+    # don't want the default configured logger.  Note that the +change_logger+
+    # version is preferred because Ruby will often parse <tt>logger = Logger.new</tt> as
+    # the declaration of, and assignment to, of a local variable.  You'd need to
+    # do <tt>self.logger=Logger.new</tt> to be sure.  This method
+    # is a bit easier.
     #
     # +new_logger+:: the new logger.  May not be nil and should be a logger of some kind
-    def logger=(new_logger)
+    def change_logger(new_logger)
       raise ArgumentError,"Logger may not be nil" if new_logger.nil?
       @@logger = new_logger
     end
 
+    alias logger= change_logger
+
+
     # pass-through to <tt>logger.debug(progname,&block)</tt>
     def debug(progname = nil, &block); logger.debug(progname,&block); end
     # pass-through to <tt>logger.info(progname,&block)</tt>

data/lib/methadone/main.rb

@@ -195,7 +195,23 @@ module Methadone
     end
 
     # Returns a Hash that you can use to store or retrieve options
-    # parsed from the command line
+    # parsed from the command line.  When you put values in here, if you do so
+    # *before* you've declared your command-line interface via #on, the value
+    # will be used in the docstring to indicate it is the default.
+    #
+    # Example
+    #
+    #     main do
+    #       puts options[:foo] # put the value of --foo that the user provided
+    #     end
+    #
+    #     options[:foo] = "bar" # set "bar" as the default value for --foo, which
+    #                           # will cause us to include "(default: bar)" in the
+    #                           # docstring
+    #
+    #     on("--foo FOO","Sets the foo")
+    #     go!
+    #
     def options
       @options
     end
@@ -291,6 +307,7 @@ module Methadone
     # for how that works.
     def on(*args,&block)
       @accept_options = true
+      args = add_default_value_to_docstring(*args)
       if block
         @option_parser.on(*args,&block)
       else
@@ -345,6 +362,22 @@ module Methadone
 
     private
 
+    def add_default_value_to_docstring(*args)
+      default_value = nil
+      option_names_from(args).each do |option|
+        default_value = (@options[option.to_s] || @options[option.to_sym]) if default_value.nil?
+      end
+      if default_value.nil?
+        args
+      else
+        args + ["(default: #{default_value})"]
+      end
+    end
+
+    def option_names_from(args)
+      args.select { |_| _ =~ /^\-/ }.map { |_| _.gsub(/^\-+/,'').gsub(/\s.*$/,'') }
+    end
+
     def set_banner
       unless @user_specified_banner
         new_banner="Usage: #{::File.basename($0)}"

data/lib/methadone/version.rb

@@ -1,3 +1,3 @@
 module Methadone
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end

data/methadone.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("cucumber","~> 1.1.1")
   s.add_development_dependency("aruba")
   s.add_development_dependency("simplecov", "~> 0.5")
-  s.add_development_dependency("test_unit-given", ">= 0.1.1")
+  s.add_development_dependency("clean_test", "~> 0.10")
 end

data/test/base_test.rb

@@ -4,24 +4,7 @@ SimpleCov.start do
 end
 require 'test/unit'
 require 'rspec/expectations'
-require 'test/unit/given'
+require 'clean_test/test_case'
 
-class BaseTest < Test::Unit::Given::TestCase
-  # Copied from Rails; makes a test method using a string
-  def self.test(name, &block)
-    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
-    defined = instance_method(test_name) rescue false
-    raise "#{test_name} is already defined in #{self}" if defined
-    if block_given?
-      define_method(test_name, &block)
-    else
-      define_method(test_name) do
-        raise "No implementation provided for #{name}"
-      end
-    end
-  end
-
-  def test_nothing
-    # Seems 1.8 wants to have a test here?
-  end
+class BaseTest < Clean::Test::TestCase
 end

data/test/test_cli_logging.rb

@@ -45,14 +45,33 @@ class TestCLILogging < BaseTest
     }
   end
 
-  test_that "we can change the global logger" do
+  test_that "we can change the global logger via self." do
     Given {
       @first = MyClassThatLogsToStdout.new
       @second = MyOtherClassThatLogsToStdout.new
       @logger_id = @second.logger_id
     }
     When {
-      @second.change_logger
+      @second.instance_eval do
+        self.logger=(Methadone::CLILogger.new)
+      end
+    }
+    Then {
+      @logger_id.should_not == @second.logger_id
+      @first.logger_id.should == @second.logger_id
+    }
+  end
+
+  test_that "we can change the global logger change_logger()" do
+    Given {
+      @first = MyClassThatLogsToStdout.new
+      @second = MyOtherClassThatLogsToStdout.new
+      @logger_id = @second.logger_id
+    }
+    When {
+      @second.instance_eval do
+        change_logger(Logger.new(STDERR))
+      end
     }
     Then {
       @logger_id.should_not == @second.logger_id
@@ -65,7 +84,11 @@ class TestCLILogging < BaseTest
       @other_class = MyOtherClassThatLogsToStdout.new
     }
     Then {
-      lambda { MyOtherClassThatLogsToStdout.new.change_to_nil_logger }.should raise_error(ArgumentError)
+      lambda { 
+        MyOtherClassThatLogsToStdout.new.instance_eval do
+          self.logger=(nil)
+        end
+      }.should raise_error(ArgumentError)
     }
   end
 
@@ -108,14 +131,6 @@ class TestCLILogging < BaseTest
       fatal("fatal")
     end
 
-    def change_logger
-      self.logger=Methadone::CLILogger.new
-    end
-
-    def change_to_nil_logger
-      self.logger = nil
-    end
-
     def logger_id; logger.object_id; end
   end
 end

data/test/test_main.rb

@@ -468,6 +468,35 @@ class TestMain < BaseTest
     }
   end
 
+  test_that "default values for options are put into the docstring" do
+    Given {
+      main {}
+      options[:foo] = "bar"
+      on("--foo ARG","Indicate the type of foo")
+    }
+    When {
+      @help_string = opts.to_s
+    }
+    When {
+      @help_string.should match /\(default: bar\)/
+    }
+
+  end
+
+  test_that "default values for options with several names are put into the docstring" do
+    Given {
+      main {}
+      options[:foo] = "bar"
+      on("-f ARG","--foo","Indicate the type of foo")
+    }
+    When {
+      @help_string = opts.to_s
+    }
+    When {
+      @help_string.should match /\(default: bar\)/
+    }
+  end
+
   private
 
   def main_shouldve_been_called

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: methadone
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-11 00:00:00.000000000Z
+date: 2012-01-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70174171756980 !ruby/object:Gem::Requirement
+  requirement: &70157645151840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70174171756980
+  version_requirements: *70157645151840
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &70174171756480 !ruby/object:Gem::Requirement
+  requirement: &70157645151280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70174171756480
+  version_requirements: *70157645151280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70174171756060 !ruby/object:Gem::Requirement
+  requirement: &70157645150780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174171756060
+  version_requirements: *70157645150780
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70174171755460 !ruby/object:Gem::Requirement
+  requirement: &70157645150160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.9'
   type: :development
   prerelease: false
-  version_requirements: *70174171755460
+  version_requirements: *70157645150160
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70174171748260 !ruby/object:Gem::Requirement
+  requirement: &70157645149420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *70174171748260
+  version_requirements: *70157645149420
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70174171747880 !ruby/object:Gem::Requirement
+  requirement: &70157645143000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174171747880
+  version_requirements: *70157645143000
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70174171747340 !ruby/object:Gem::Requirement
+  requirement: &70157645142460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,18 +87,18 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70174171747340
+  version_requirements: *70157645142460
 - !ruby/object:Gem::Dependency
-  name: test_unit-given
-  requirement: &70174171746840 !ruby/object:Gem::Requirement
+  name: clean_test
+  requirement: &70157645141960 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.10'
   type: :development
   prerelease: false
-  version_requirements: *70174171746840
+  version_requirements: *70157645141960
 description: Methadone provides a lot of small but useful features for developing
   a command-line app, including an opinionated bootstrapping process, some helpful
   cucumber steps, and some classes to bridge logging and output into a simple, unified,