everyday-cli-utils 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e52596df8f25d3ba81101dfbccbc62f9c309ec5d
-  data.tar.gz: 7a15ffae5b9f397630a0194bc039f83699a5d451
+  metadata.gz: 60052f772a0756a80b71446915644a962d1749fc
+  data.tar.gz: 7f44acf9585a64c409615ae159e222fb6ad3ab47
 SHA512:
-  metadata.gz: b72147d548a12f520d1e92601b905b5fb9e84e48e6c32c2e7d92de176a9f8118cd754b73a1c7fec680c6e612383f79247af0b22db5da4be85226eb0560f5061a
-  data.tar.gz: 13b000a6534469398170a20526a2d7325cbd822da5e8ff8cb253897984f410267991c728b2605385d5c4b2053e2d8e9a9ef512d802ea4556d498c660f52440aa
+  metadata.gz: c685c69bc215ace083e665b6d5e75b9fc84daa64cbf2cafdd4a1ef33a509cf7204a9969d5d41ad1ae06dd3d90218fd3553c8e54682c6ad0c487d0e10467e0d28
+  data.tar.gz: 6b18808f2e00a4955d1f444af8e48bcbc2062a8b5e5971893f29746a808e37a23c1414e50b99b4b019d94d6584008ed5fccaa6a4d0afcf26db2f5868d29611b1

data/README.md

@@ -336,6 +336,27 @@ Add a parameterized option to the `OptionParser`.  It will set the specified opt
 * `settings`: additional optional options
     * `type: <data type>`: specify a type (such as `Integer` or `Float`) for the option parser to try to parse the parameter to (default is `String` (no parsing))
     * `append: true|false`: true to append the parameter to a list (for parameterized options that can occur multiple times), false or omitted to just set it to the parameter
+    
+### EverydayCliUtils::OptionUtil
+
+As of version 0.6.0, there is a new way to use the option package.  See the below example:
+
+```ruby
+class MyOptions
+  extend EverydayCliUtil::OptionUtil
+  
+  option :opt1, ['-1', '--opt-1']
+  option_with_param :opt2, ['-2', '--opt-2 PARAM']
+end
+
+MyOptions.parse!
+
+opts = MyOptions.options
+```
+
+The two methods shown above are the same as the ones in `EverydayCliUtils::Option`, but renamed to be shorter, and with the `opt_name` and `names` parameters switched around.  Also, the options hash and `OptionParser` instance are handled internally, so you don't have to pass those in.  There are read-only accessors for both of them.
+
+Besides the different look, there are also improvements.  `EverydayCliUtils::OptionUtil.default_settings(settings = {})` is a new method that you can use to set the default values of the settings that you can pass to `option` and `option_with_param`.  Also, since this utility manages the options hash for you, in order to provide you with a way to override the defaults (`false` for boolean options, `nil` for non-appending parameter options, and `[]` for appending parameter options (don't change this)) by using `EverydayCliUtils::OptionUtil.default_options(options = {})`.
 
 ## Contributing
 

data/lib/everyday-cli-utils/option.rb

@@ -18,4 +18,49 @@ module EverydayCliUtils
       }
     end
   end
+
+  module OptionUtil
+    attr_reader :options, :opts
+
+    def option(opt_name, names, settings = {})
+      @opts              ||= OptionParser.new
+      @options           ||= {}
+      @default_settings  ||= {}
+      settings[:toggle]  = @default_settings[:toggle] unless settings.has_key?(:toggle) || !@default_settings.has_key?(:toggle)
+      @options[opt_name] = false
+      @opts.on(*names) {
+        @options[opt_name] = !settings[:toggle] || !@options[opt_name]
+        yield if block_given?
+      }
+    end
+
+    def option_with_param(opt_name, names, settings = {})
+      @opts              ||= OptionParser.new
+      @options           ||= {}
+      @default_settings  ||= {}
+      settings[:append]  = @default_settings[:append] unless settings.has_key?(:append) || !@default_settings.has_key?(:append)
+      settings[:type]    = @default_settings[:type] unless settings.has_key?(:type) || !@default_settings.has_key?(:type)
+      @options[opt_name] = settings[:append] ? [] : nil
+      @opts.on(*names, settings[:type] || String) { |param|
+        if settings[:append]
+          @options[opt_name] << param
+        else
+          @options[opt_name] = param
+        end
+        yield if block_given?
+      }
+    end
+
+    def default_settings(settings = {})
+      @default_settings = settings
+    end
+
+    def default_options(opts = {})
+      opts.each { |opt| @options[opt[0]] = opt[1] }
+    end
+
+    def parse!(argv = ARGV)
+      @opts.parse!(argv)
+    end
+  end
 end

data/lib/everyday-cli-utils/version.rb

@@ -1,3 +1,3 @@
 module EverydayCliUtils
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/spec/everyday-cli-utils/option_spec.rb

@@ -0,0 +1,156 @@
+require_relative '../../lib/everyday-cli-utils'
+include EverydayCliUtils
+import :option
+
+class Option1
+  include EverydayCliUtils::OptionUtil
+end
+
+describe EverydayCliUtils::OptionUtil do
+  it 'supports adding boolean options' do
+    expected = { opt1: true }
+    clean    = { opt1: false }
+    opt      = Option1.new
+    opt.option :opt1, %w(-1 --opt-1)
+    opt.options.should eq clean
+    opt.default_options opt1: false
+    opt.options.should eq clean
+    opt.parse!(['-1'])
+    opt.options.should eq expected
+    opt.default_options opt1: false
+    opt.options.should eq clean
+    opt.parse!(['--opt-1'])
+    opt.options.should eq expected
+  end
+
+  it 'supports adding boolean toggle options' do
+    expected = { opt1: false }
+    clean    = { opt1: true }
+    opt      = Option1.new
+    opt.option :opt1, %w(-1 --opt-1), toggle: true
+    opt.options.should eq expected
+    opt.default_options opt1: true
+    opt.options.should eq clean
+    opt.parse!(['-1'])
+    opt.options.should eq expected
+    opt.default_options opt1: true
+    opt.options.should eq clean
+    opt.parse!(['--opt-1'])
+    opt.options.should eq expected
+  end
+
+  it 'supports adding an option with a parameter' do
+    expected = { opt1: 'hi' }
+    clean    = { opt1: nil }
+    opt      = Option1.new
+    opt.option_with_param :opt1, ['-1', '--opt-1 PARAM']
+    opt.options.should eq clean
+    opt.default_options opt1: nil
+    opt.options.should eq clean
+    opt.parse!(%w(-1 hi))
+    opt.options.should eq expected
+    opt.default_options opt1: nil
+    opt.options.should eq clean
+    opt.parse!(%w(--opt-1 hi))
+    opt.options.should eq expected
+  end
+
+  it 'supports adding an option with a parameter and type' do
+    expected = { opt1: 1 }
+    clean    = { opt1: nil }
+    opt      = Option1.new
+    opt.option_with_param :opt1, ['-1', '--opt-1 PARAM'], type: Integer
+    opt.options.should eq clean
+    opt.default_options opt1: nil
+    opt.options.should eq clean
+    opt.parse!(%w(-1 1))
+    opt.options.should eq expected
+    opt.default_options opt1: nil
+    opt.options.should eq clean
+    opt.parse!(%w(--opt-1 1))
+    opt.options.should eq expected
+  end
+
+  it 'supports adding an option with a parameter that store multiple instances' do
+    expected = { opt1: %w(hi bye) }
+    clean    = { opt1: [] }
+    opt      = Option1.new
+    opt.option_with_param :opt1, ['-1', '--opt-1 PARAM'], append: true
+    opt.options.should eq clean
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(-1 hi -1 bye))
+    opt.options.should eq expected
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(--opt-1 hi --opt-1 bye))
+    opt.options.should eq expected
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(-1 hi --opt-1 bye))
+    opt.options.should eq expected
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(--opt-1 hi -1 bye))
+    opt.options.should eq expected
+  end
+
+  it 'supports setting the default for the toggle setting' do
+    expected = { opt1: false }
+    clean    = { opt1: true }
+    opt      = Option1.new
+    opt.default_settings toggle: true
+    opt.option :opt1, %w(-1 --opt-1)
+    opt.options.should eq expected
+    opt.default_options opt1: true
+    opt.options.should eq clean
+    opt.parse!(['-1'])
+    opt.options.should eq expected
+    opt.default_options opt1: true
+    opt.options.should eq clean
+    opt.parse!(['--opt-1'])
+    opt.options.should eq expected
+  end
+
+  it 'supports setting the default for the type setting' do
+    expected = { opt1: 1 }
+    clean    = { opt1: nil }
+    opt      = Option1.new
+    opt.default_settings type: Integer
+    opt.option_with_param :opt1, ['-1', '--opt-1 PARAM']
+    opt.options.should eq clean
+    opt.default_options opt1: nil
+    opt.options.should eq clean
+    opt.parse!(%w(-1 1))
+    opt.options.should eq expected
+    opt.default_options opt1: nil
+    opt.options.should eq clean
+    opt.parse!(%w(--opt-1 1))
+    opt.options.should eq expected
+  end
+
+  it 'supports adding an option with a parameter that store multiple instances' do
+    expected = { opt1: %w(hi bye) }
+    clean    = { opt1: [] }
+    opt      = Option1.new
+    opt.default_settings append: true
+    opt.option_with_param :opt1, ['-1', '--opt-1 PARAM']
+    opt.options.should eq clean
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(-1 hi -1 bye))
+    opt.options.should eq expected
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(--opt-1 hi --opt-1 bye))
+    opt.options.should eq expected
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(-1 hi --opt-1 bye))
+    opt.options.should eq expected
+    opt.default_options opt1: []
+    opt.options.should eq clean
+    opt.parse!(%w(--opt-1 hi -1 bye))
+    opt.options.should eq expected
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: everyday-cli-utils
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Eric Henderson
@@ -132,6 +132,7 @@ files:
 - spec/everyday-cli-utils/format_spec.rb
 - spec/everyday-cli-utils/kmeans_spec.rb
 - spec/everyday-cli-utils/maputil_spec.rb
+- spec/everyday-cli-utils/option_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/henderea/everyday-cli-utils
 licenses:
@@ -161,5 +162,6 @@ test_files:
 - spec/everyday-cli-utils/format_spec.rb
 - spec/everyday-cli-utils/kmeans_spec.rb
 - spec/everyday-cli-utils/maputil_spec.rb
+- spec/everyday-cli-utils/option_spec.rb
 - spec/spec_helper.rb
 has_rdoc: