methadone 1.0.0.rc3 → 1.0.0.rc4

data/bin/methadone

@@ -48,7 +48,7 @@ main do |app_name|
     "  #{gem_variable}.add_development_dependency('rdoc')",
     "  #{gem_variable}.add_development_dependency('aruba')",
     "  #{gem_variable}.add_development_dependency('rake','~> 0.9.2')",
-    "  #{gem_variable}.add_dependency('methadone', '~>1.0.0.rc3')",
+    "  #{gem_variable}.add_dependency('methadone', '~>1.0.0.rc4')",
   ], :before => /^end\s*$/
 end
 
@@ -69,6 +69,7 @@ arg :app_name, :required, "Name of your app, which is used for the gem name and
 version Methadone::VERSION
 
 defaults_from_env_var 'METHODONE_OPTS'
+defaults_from_config_file '.methadone.rc'
 
 go!
 

data/lib/methadone/main.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'yaml'
 
 begin
   Module.const_get('BasicObject')
@@ -117,8 +118,32 @@ module Methadone
     # options for your app.  Omit this to disable the feature.
     def defaults_from_env_var(env_var)
       @env_var = env_var
-      opts.separator ''
-      opts.separator "Default values can be placed in the #{env_var} environment variable"
+    end
+
+    # Set the name of the file, in the user's home directory, where defaults can be configured.
+    # The format of this file can be either a simple string of options, like what goes
+    # in the environment variable (see #defaults_from_env_var), or YAML, in which case
+    # it should be a hash where keys are the option names, and values their defaults.
+    #
+    # filename:: name of the file, relative to the user's home directory
+    def defaults_from_config_file(filename,options={})
+      @rc_file = File.join(ENV['HOME'],filename)
+    end
+
+    def add_defaults_to_docs
+      if @env_var && @rc_file
+        opts.separator ''
+        opts.separator 'Default values can be placed in:'
+        opts.separator ''
+        opts.separator "    #{@env_var} environment variable, as a String of options"
+        opts.separator "    #{@rc_file} with contents either a String of options or a YAML-encoded Hash"
+      elsif @env_var
+        opts.separator ''
+        opts.separator "Default values can be placed in the #{@env_var} environment variable"
+      elsif @rc_file
+        opts.separator ''
+        opts.separator "Default values can be placed in #{@rc_file}"
+      end
     end
 
     # Start your command-line app, exiting appropriately when
@@ -135,6 +160,8 @@ module Methadone
     # 64 and a message about that missing argument.
     #
     def go!
+      add_defaults_to_docs
+      set_defaults_from_rc_file
       normalize_defaults
       opts.post_setup
       if @env_var
@@ -255,6 +282,26 @@ module Methadone
 
     private
 
+    def set_defaults_from_rc_file
+      if @rc_file && File.exists?(@rc_file)
+        File.open(@rc_file) do |file| 
+          parsed = YAML::load(file)
+          if parsed.kind_of? String
+            String(parsed).split(/\s+/).each do |arg|
+              ::ARGV.unshift(arg)
+            end
+          elsif parsed.kind_of? Hash
+            parsed.each do |option,value|
+              options[option] = value
+            end
+          else
+            raise OptionParser::ParseError,
+              "rc file #{@rc_file} is not parseable, should be a string or YAML-encoded Hash"
+          end
+        end
+      end
+    end
+
     # Normalized all defaults to both string and symbol forms, so
     # the user can access them via either means just as they would for
     # non-defaulted options

data/lib/methadone/version.rb

@@ -1,3 +1,3 @@
 module Methadone
-  VERSION = "1.0.0.rc3"
+  VERSION = "1.0.0.rc4"
 end

data/test/test_main.rb

@@ -1,6 +1,7 @@
 require 'base_test'
 require 'methadone'
 require 'stringio'
+require 'fileutils'
 
 class TestMain < BaseTest
   include Methadone::Main
@@ -12,6 +13,12 @@ class TestMain < BaseTest
     $stdout = StringIO.new
     @logged = StringIO.new
     @custom_logger = Logger.new(@logged)
+
+    @original_home = ENV['HOME']
+    fake_home = '/tmp/fake-home'
+    FileUtils.rm_rf(fake_home)
+    FileUtils.mkdir(fake_home)
+    ENV['HOME'] = fake_home
   end
 
   # Override the built-in logger so we can capture it
@@ -24,6 +31,7 @@ class TestMain < BaseTest
     ENV.delete('DEBUG')
     ENV.delete('APP_OPTS')
     $stdout = @old_stdout
+    ENV['HOME'] = @original_home
   end
 
   test_that "my main block gets called by run and has access to CLILogging" do
@@ -503,7 +511,8 @@ class TestMain < BaseTest
 
   test_that "when getting defaults from an environment variable, show it in the help output" do
     Given app_to_use_environment
-    When {
+    When run_go_safely
+    And {
       @help_string = opts.to_s
     }
     Then {
@@ -547,8 +556,104 @@ class TestMain < BaseTest
     }
   end
 
+  test_that "we can get defaults from a config file if it's specified" do
+    Given app_to_use_rc_file
+    And {
+      @flag_value = any_string
+      rc_file = File.join(ENV['HOME'],'.my_app.rc')
+      File.open(rc_file,'w') do |file|
+        file.puts ({
+          'switch' => true,
+          'flag' => @flag_value,
+        }.to_yaml)
+      end
+    }
+    When {
+      @code = lambda { go! }
+    }
+    Then {
+      assert_exits(0,&@code)
+      @switch.should == true
+      @flag.should == @flag_value
+    }
+
+  end
+
+  test_that "we can specify an rc file even if it doesn't exist" do
+    Given app_to_use_rc_file
+    And {
+      @flag_value = any_string
+      rc_file = File.join(ENV['HOME'],'.my_app.rc')
+      raise "Something's wrong, expection rc file not to exist" if File.exists?(rc_file)
+    }
+    When {
+      @code = lambda { go! }
+    }
+    Then {
+      assert_exits(0,&@code)
+      @switch.should == nil
+      @flag.should == nil
+    }
+  end
+
+  test_that "we can use a different format for the rc file" do
+    Given app_to_use_rc_file
+    And {
+      @flag_value = any_string
+      rc_file = File.join(ENV['HOME'],'.my_app.rc')
+      File.open(rc_file,'w') do |file|
+        file.puts "--switch --flag=#{@flag_value}"
+      end
+    }
+    When {
+      @code = lambda { go! }
+    }
+    Then {
+      assert_exits(0,&@code)
+      @switch.should == true
+      @flag.should == @flag_value
+    }
+
+  end
+
+  test_that "with an ill-formed rc file, we get a reasonable error message" do
+    Given app_to_use_rc_file
+    And {
+      @flag_value = any_string
+      rc_file = File.join(ENV['HOME'],'.my_app.rc')
+      File.open(rc_file,'w') do |file|
+        file.puts OpenStruct.new(:foo => :bar).to_yaml
+      end
+    }
+    When {
+      @code = lambda { go! }
+    }
+    Then {
+      assert_exits(64,&@code)
+    }
+
+  end
+
 private
 
+  def app_to_use_rc_file
+    lambda {
+      @switch = nil
+      @flag = nil
+      @args = nil
+      main do |*args|
+        @switch = options[:switch]
+        @flag = options[:flag]
+        @args = args
+      end
+
+      defaults_from_config_file '.my_app.rc'
+
+      on('--switch','Some Switch')
+      on('--flag FOO','Some Flag')
+    }
+  end
+
   def main_that_exits(exit_status)
     proc { main { exit_status } }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: methadone
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000Z
+date: 2012-02-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70353456288360 !ruby/object:Gem::Requirement
+  requirement: &70117187014260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70353456288360
+  version_requirements: *70117187014260
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &70353456287680 !ruby/object:Gem::Requirement
+  requirement: &70117187013540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70353456287680
+  version_requirements: *70117187013540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70353456287180 !ruby/object:Gem::Requirement
+  requirement: &70117187012900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70353456287180
+  version_requirements: *70117187012900
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70353456286640 !ruby/object:Gem::Requirement
+  requirement: &70117187012080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.9'
   type: :development
   prerelease: false
-  version_requirements: *70353456286640
+  version_requirements: *70117187012080
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70353456285980 !ruby/object:Gem::Requirement
+  requirement: &70117187011340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *70353456285980
+  version_requirements: *70117187011340
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70353456285520 !ruby/object:Gem::Requirement
+  requirement: &70117187010760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70353456285520
+  version_requirements: *70117187010760
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70353456284800 !ruby/object:Gem::Requirement
+  requirement: &70117187010060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70353456284800
+  version_requirements: *70117187010060
 - !ruby/object:Gem::Dependency
   name: clean_test
-  requirement: &70353456284200 !ruby/object:Gem::Requirement
+  requirement: &70117187009160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '0.10'
   type: :development
   prerelease: false
-  version_requirements: *70353456284200
+  version_requirements: *70117187009160
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70353456283600 !ruby/object:Gem::Requirement
+  requirement: &70117187008340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70353456283600
+  version_requirements: *70117187008340
 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,