everyday-cli-utils 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 586fc1d3c19d2169300d7b36c6d595f9380e0479
-  data.tar.gz: 785d25b280556ea822a7cdd789fc4032f867ca42
+  metadata.gz: 0681993f800f4e74b8c294475c3ab23daeaed47b
+  data.tar.gz: 88e392ad10471b71a496797a2dc07feb887e4a52
 SHA512:
-  metadata.gz: c98b17a3477a80fec2e86837c4b08e5213e5c2c3ea4056cdd9403f0ce91ea9c0a6e278e3598bf08234e9244721d85ffdc58092d3d67eb681738acd8ebb485465
-  data.tar.gz: 2dacccdba641c43fdd1e0b2f9b9992848f611cc90a6a8306f6ac2807a2128e9f290a6d425be68b561f4ce8904f949ec67354dce4c43c05f4f9835f2d9acc8772
+  metadata.gz: 333e611ce51e61d7299da6f573d1a8f9ff83a30c9da2a98b3bb0e9f91c73e389687522a0e1b74d602dcab6f4b43dd262c04663612426b72e13c49e013beb8d4e
+  data.tar.gz: 64bc0c10b336847de4ea2b87377dd62c48d611a435e693aa563d5cd1c53380a7e792f5ca789b56a4359b4c1901259cbf200b435c0a594582e0c91947dcf9f477

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

@@ -96,10 +96,11 @@ module EverydayCliUtils
   end
 
   class OptionDef
-    attr_reader :value
+    attr_reader :value, :names
 
-    def initialize(type, settings = {}, &block)
+    def initialize(type, names, settings = {}, &block)
       @type     = type
+      @names    = names
       @settings = settings
       @block    = block
       @value    = OptionTypes.default_value(type, settings)
@@ -129,7 +130,7 @@ module EverydayCliUtils
     def self.register(opts, options, type, opt_name, names, settings = {}, default_settings = {}, &block)
       settings = settings.clone
       default_settings.each { |v| settings[v[0]] = v[1] unless settings.has_key?(v[0]) }
-      opt               = OptionDef.new(type, settings, &block)
+      opt               = OptionDef.new(type, names.clone, settings, &block)
       options[opt_name] = opt
       names             = OptionTypes.mod_names(type, names, settings)
       opts.on(*names) { |*args|
@@ -187,6 +188,52 @@ module EverydayCliUtils
     def parse!(argv = ARGV)
       @opts.parse!(argv)
     end
+
+    def show_defaults
+      script_defaults = composite
+      global_defaults = composite(:global)
+      local_defaults  = composite(:global, :local)
+      global_diff     = hash_diff(global_defaults, script_defaults)
+      local_diff      = hash_diff(local_defaults, global_defaults)
+      str             = "Script Defaults:\n#{options_to_str(script_defaults)}\n"
+      str << "Script + Global Defaults:\n#{options_to_str(global_diff)}\n" unless global_diff.empty?
+      str << "Script + Global + Local Defaults:\n#{options_to_str(local_diff)}\n" unless local_diff.empty?
+      str
+    end
+
+    def hash_diff(hash1, hash2)
+      new_hash = {}
+      hash1.keys.each { |k| new_hash[k] = hash1[k] unless hash2.has_key?(k) && hash1[k] == hash2[k] }
+      new_hash
+    end
+
+    def options_to_str(options)
+      str          = ''
+      max_name_len = @options.values.map { |v| v.names.join(', ').length }.max
+      options.each { |v|
+        opt       = @options[v[0]]
+        val       = v[1]
+        names_str = opt.names.join(', ')
+        str << "#{' ' * 4}#{names_str}#{' ' * ((max_name_len + 4) - names_str.length)}#{val_to_str(val)}\n"
+      }
+      str
+    end
+
+    def val_to_str(val)
+      if val.nil?
+        'nil'
+      elsif val.is_a?(TrueClass)
+        'true'
+      elsif val.is_a?(FalseClass)
+        'false'
+      elsif val.is_a?(Enumerable)
+        "[#{val.map { |v| val_to_str(v) }.join(', ')}]"
+      elsif val.is_a?(Numeric)
+        val.to_s
+      else
+        "'#{val.to_s}'"
+      end
+    end
   end
 
   module OptionUtil
@@ -218,8 +265,12 @@ module EverydayCliUtils
       @options.opts.on(*names) { @set_global_defaults = true }
     end
 
-    def show_defaults_option(layers, names, settings = {})
-
+    def show_defaults_option(names, settings = {})
+      @options               ||= OptionList.new
+      @show_defaults         = false
+      @exit_on_show_defaults = !settings.has_key?(:exit_on_show) || settings[:exit_on_show]
+      names << settings[:desc] if settings.has_key?(:desc)
+      @options.opts.on(*names) { @show_defaults = true }
     end
 
     def help_option(names, settings = {})
@@ -285,6 +336,10 @@ module EverydayCliUtils
         puts help
         exit 0 if @exit_on_print
       end
+      if @show_defaults
+        puts @options.show_defaults
+        exit 0 if @exit_on_show_defaults
+      end
       if @set_global_defaults
         IO.write(@global_defaults_file, @options.composite(:global, :arg).to_yaml)
         if @exit_on_global_save

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

@@ -1,3 +1,3 @@
 module EverydayCliUtils
-  VERSION = '1.5.2'
+  VERSION = '1.6.0'
 end

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

@@ -1,4 +1,5 @@
 require_relative '../../lib/everyday-cli-utils'
+require 'rspec'
 include EverydayCliUtils
 import :format
 

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

@@ -185,24 +185,83 @@ describe EverydayCliUtils::OptionUtil do
   end
 
   it 'supports layers' do
-    expected1 = { opt1: true }
-    expected2 = { opt1: false }
-    clean     = { opt1: false }
-    opt       = Option1.new
-    opt.default_settings toggle: true
+    global       = { opt1: false, opt2: [], opt3: 'hi', opt4: [5] }
+    global_arg   = { opt1: true, opt2: [], opt3: 'hi', opt4: [5] }
+    arg          = { opt1: false, opt2: [], opt3: nil, opt4: [] }
+    total        = { opt1: true, opt2: %w(hi bye), opt3: 'bye', opt4: [5, 4] }
+    global_local = { opt1: false, opt2: %w(hi bye), opt3: 'bye', opt4: [5, 4] }
+    local        = { opt1: true, opt2: %w(hi bye), opt3: 'bye', opt4: [4] }
+    local_arg        = { opt1: false, opt2: %w(hi bye), opt3: 'bye', opt4: [4] }
+    clean        = { opt1: false, opt2: [], opt3: nil, opt4: [] }
+    clean2       = { opt1: true, opt2: [], opt3: nil, opt4: [] }
+    opt          = Option1.new
+    opt.default_settings toggle: true, append: true
     opt.option :opt1, %w(-1 --opt-1)
+    opt.option_with_param :opt2, %w(-2 --big-opt-2)
+    opt.option_with_param :opt3, %w(-3 --bigger-opt-3), append: false
+    opt.option_with_param :opt4, %w(-4 --even-bigger-opt-4), type: Integer
     opt.options.should eq clean
-    opt.default_options opt1: false
-    opt.apply_options :global, opt1: true
-    opt.options.should eq expected1
-    opt.apply_options :local, opt1: false
-    opt.options.should eq expected1
+    opt.option_list.show_defaults.should eq <<SHOW
+Script Defaults:
+    -1, --opt-1                      false
+    -2 PARAM, --big-opt-2            []
+    -3 PARAM, --bigger-opt-3         nil
+    -4 PARAM, --even-bigger-opt-4    []
+
+SHOW
+    opt.default_options opt1: true
+    opt.options.should eq clean2
+    opt.option_list.show_defaults.should eq <<SHOW
+Script Defaults:
+    -1, --opt-1                      true
+    -2 PARAM, --big-opt-2            []
+    -3 PARAM, --bigger-opt-3         nil
+    -4 PARAM, --even-bigger-opt-4    []
+
+SHOW
+    opt.apply_options :global, opt1: true, opt3: 'hi', opt4: [5]
+    opt.options.should eq global
+    opt.option_list.show_defaults.should eq <<SHOW
+Script Defaults:
+    -1, --opt-1                      true
+    -2 PARAM, --big-opt-2            []
+    -3 PARAM, --bigger-opt-3         nil
+    -4 PARAM, --even-bigger-opt-4    []
+
+Script + Global Defaults:
+    -1, --opt-1                      false
+    -3 PARAM, --bigger-opt-3         'hi'
+    -4 PARAM, --even-bigger-opt-4    [5]
+
+SHOW
+    opt.apply_options :local, opt1: false, opt2: %w(hi bye), opt3: 'bye', opt4: [4]
+    opt.options.should eq global_local
+    opt.option_list.show_defaults.should eq <<SHOW
+Script Defaults:
+    -1, --opt-1                      true
+    -2 PARAM, --big-opt-2            []
+    -3 PARAM, --bigger-opt-3         nil
+    -4 PARAM, --even-bigger-opt-4    []
+
+Script + Global Defaults:
+    -1, --opt-1                      false
+    -3 PARAM, --bigger-opt-3         'hi'
+    -4 PARAM, --even-bigger-opt-4    [5]
+
+Script + Global + Local Defaults:
+    -2 PARAM, --big-opt-2            ['hi', 'bye']
+    -3 PARAM, --bigger-opt-3         'bye'
+    -4 PARAM, --even-bigger-opt-4    [5, 4]
+
+SHOW
     opt.apply_options :arg, opt1: true
-    opt.options.should eq expected2
-    opt.option_list.composite(:global, :arg).should eq expected2
-    opt.option_list.composite(:global).should eq expected1
-    opt.option_list.composite(:local, :arg).should eq expected1
-    opt.option_list.composite(:arg).should eq expected1
-    opt.option_list.composite(:global, :local, :arg).should eq expected2
+    opt.options.should eq total
+    opt.option_list.composite(:global, :arg).should eq global_arg
+    opt.option_list.composite(:global, :local).should eq global_local
+    opt.option_list.composite(:global).should eq global
+    opt.option_list.composite(:local).should eq local
+    opt.option_list.composite(:local, :arg).should eq local_arg
+    opt.option_list.composite(:arg).should eq arg
+    opt.option_list.composite(:global, :local, :arg).should eq total
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everyday-cli-utils
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Eric Henderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler