everyday-cli-utils 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6f77b4daf559934ff326ec9b64a61ce6b6b63db
-  data.tar.gz: 9deab7a7a548ce5fb5b5d6db8fefa8e6d9069739
+  metadata.gz: 7897a11ac454ad40fbac503cbee4929c032052f2
+  data.tar.gz: 65d659f085bef676655c2c4c208c67cb63b8d55d
 SHA512:
-  metadata.gz: 061802c721e417eb608f6c7ec56007a6b579a7d2b27053139ab5af544d29b7499ab7fafec5e825e145bec74460948d7ffecbfbd10380174d8d3d13b04d8f5658
-  data.tar.gz: 527bc79f4497ba7f1e92694ab7e14fae4f835f12e6eee8c523bd0fdd80b35a5a99caca83da5888c2fb6981c337c99d1164182665de552b83ee4ff145afac8d71
+  metadata.gz: 86d3c40d13be8545c2542fc76fb83179ead683b6d5524afb0c337c7c9d221a1b3bf021d7f09552aa665db831ba92c2b631c1028858072b6176e8e1198b0c3194
+  data.tar.gz: 3b574b15dc95951a68f5241c7cf6aec251c514656f068589f47dce4e8b37f8325477e4ed0a2490e88bb82f082ec387f1696ea1cb18e5b99bc08b32b428bb9282

data/README.md

@@ -345,6 +345,12 @@ As of version 0.6.0, there is a new way to use the option package.  See the belo
 class MyOptions
   extend EverydayCliUtil::OptionUtil
   
+  banner 'test app' # <-- version 1.0.0 and up
+  
+  defaults_option 'defaults.yaml', ['-d', '--set-defaults'] # <-- version 0.7.0 and up
+  
+  help_option ['-h', '--help'], desc: 'display this help' # <-- version 1.0.0 and up
+  
   option :opt1, ['-1', '--opt-1']
   option_with_param :opt2, ['-2', '--opt-2 PARAM']
 end
@@ -358,6 +364,10 @@ The two methods shown above are the same as the ones in `EverydayCliUtils::Optio
 
 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 = {})`.
 
+As of version 0.7.0, there is now built-in handling for setting and retrieving default options.  Use `EverydayCliUtils::OptionUtil.defaults_option`, which takes the file name (relative or absolute, it passes through `File.expand_path` before being used) as the first parameter and the list of option flag names as the second parameter.  It will automatically load the file if it exists, and if the user specifies one of the flags you pass to this method, after parsing the options, it will automatically store them in the place you specified.  Unless you specify the hash option `exit_on_save: false`, it will exit after it saves the options.
+
+As of version 1.0.0, there is now support for the help display in `OptionParser`.  You can now provide a `desc:` hash option to the option creating methods (even pre-made ones like `defaults_option` and `help_option`).  You can set the banner with the `EverydayCliUtils::OptionUtil.banner` method, which takes the banner string as its parameter.  You can get the help string with `EverydayCliUtils::OptionUtil.help` or `EverydayCliUtils::OptionUtil.to_s`, or you can handle it with `EverydayCliUtils::OptionUtil.help_option`, which takes an array of the names and an optional `desc:` hash option.  When the user specifies one of those options, the utility will automatically print out the help and exit (unless you specify the hash option `exit_on_print: false`).
+
 ## Contributing
 
 1. Fork it ( http://github.com/henderea/everyday-cli-utils/fork )

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

@@ -26,10 +26,11 @@ module EverydayCliUtils
     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)
+      @opts             ||= OptionParser.new
+      @options          ||= {}
+      @default_settings ||= {}
+      settings[:toggle] = @default_settings[:toggle] unless settings.has_key?(:toggle) || !@default_settings.has_key?(:toggle)
+      names << settings[:desc] if settings.has_key?(:desc)
       @options[opt_name] = false
       @opts.on(*names) {
         @options[opt_name] = !settings[:toggle] || !@options[opt_name]
@@ -38,30 +39,37 @@ module EverydayCliUtils
     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)
+      @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)
+      names[0] << ' PARAM' unless names.any? { |v| v.include?(' ') }
+      names << settings[:desc] if settings.has_key?(:desc)
       @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
+        settings[:append] ? @options[opt_name] << param : @options[opt_name] = param
         yield if block_given?
       }
     end
 
-    def defaults_option(file_path, names, exit_on_save = true)
+    def defaults_option(file_path, names, settings = {})
       @opts          ||= OptionParser.new
       @set_defaults  = false
       @defaults_file = File.expand_path(file_path)
-      @exit_on_save  = exit_on_save
+      @exit_on_save  = !settings.has_key?(:exit_on_save) || settings[:exit_on_save]
+      names << settings[:desc] if settings.has_key?(:desc)
       @opts.on(*names) { @set_defaults = true }
     end
 
+    def help_option(names, settings = {})
+      @opts          ||= OptionParser.new
+      @display_help  = false
+      @exit_on_print = !settings.has_key?(:exit_on_print) || settings[:exit_on_print]
+      names << settings[:desc] if settings.has_key?(:desc)
+      @opts.on(*names) { @display_help = true }
+    end
+
     def default_settings(settings = {})
       @default_settings = settings
     end
@@ -70,9 +78,29 @@ module EverydayCliUtils
       opts.each { |opt| @options[opt[0]] = opt[1] }
     end
 
+    def banner(banner)
+      @opts        ||= OptionParser.new
+      @opts.banner = banner
+    end
+
+    def help
+      @opts ||= OptionParser.new
+      @opts.help
+    end
+
+    def to_s
+      @opts ||= OptionParser.new
+      @opts.to_s
+    end
+
     def parse!(argv = ARGV)
+      @opts ||= OptionParser.new
       default_options YAML::load_file(@defaults_file) unless @defaults_file.nil? || !File.exist?(@defaults_file)
       @opts.parse!(argv)
+      if @display_help
+        puts help
+        exit 0 if @exit_on_print
+      end
       if @set_defaults
         IO.write(@defaults_file, @options.to_yaml)
         if @exit_on_save

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

@@ -1,3 +1,3 @@
 module EverydayCliUtils
-  VERSION = '0.7.0'
+  VERSION = '1.0.0'
 end

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

@@ -55,6 +55,22 @@ describe EverydayCliUtils::OptionUtil do
     opt.options.should eq expected
   end
 
+  it 'adds the parameter into a name if it is missing from all' do
+    expected = { opt1: 'hi' }
+    clean    = { opt1: nil }
+    opt      = Option1.new
+    opt.option_with_param :opt1, %w(-1 --opt-1)
+    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 }
@@ -153,4 +169,18 @@ describe EverydayCliUtils::OptionUtil do
     opt.parse!(%w(--opt-1 hi -1 bye))
     opt.options.should eq expected
   end
+
+  it 'supports setting a banner and description' do
+    opt = Option1.new
+    opt.banner 'option1'
+    opt.option :opt1, %w(-1 --opt-1), desc: 'option #1'
+    opt.option_with_param :opt2, %w(-2 --opt-2), desc: 'option #2 (takes parameter)'
+    opt.defaults_option 'defaults.yaml', %w(-0 --set-defaults), desc: 'set defaults'
+    expected = 'option1
+    -1, --opt-1                      option #1
+    -2, --opt-2 PARAM                option #2 (takes parameter)
+    -0, --set-defaults               set defaults
+'
+    opt.to_s.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.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Henderson