mixlib-cli 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaf15af5ae6bced46dfe59d89fa37cd935573375fad4982bd1661815c1bdb9a6
-  data.tar.gz: c8ef97ee9a2236e29c3bcd7a6cafaf8564bfa5526972d582b7f4f5dc84305a83
+  metadata.gz: 8556d57649acdcf0a9517490a377b3d708f7b758eae75df36c999c1c239f4164
+  data.tar.gz: b41e11347024e232fef22d684ec5c075e0f0686d70ffe99804e369ef67027324
 SHA512:
-  metadata.gz: d5d534599c887330bff589b7909b8f89199baa33f557363742b29ffe93a5b3d6bb036efa179ef1b3a4dbfb2391115e8152115bfe48619a1ac037dc4d69532dd8
-  data.tar.gz: d17c1d596c0aec0fdf3e53b7e8f7d7380a34872a8f16ae0cd680725b712ec22b0e77607b45dfa98b9948464c5e793e34a1db43c31d6c13c8b4311bd8d3da1054
+  metadata.gz: d1ab2c63cf759d9f1576f8e9445d0e6155ca12a14ea9151b9105451bcb97bc87ad315b11956aa47fb56359b63301adde102a7d795d31aceacd5957cea08b2bbd
+  data.tar.gz: 15cf78f55c55a547597741030de5f61f3b774878c6c09afe0cb0657a0a54b87e9ba4f47d4a1eb4a02719be3465b5f3b61f45baca83ab336330a9189fa8e2a4ca

data/lib/mixlib/cli/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   module CLI
-    VERSION = "2.0.0".freeze
+    VERSION = "2.0.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-cli
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Chef Software, Inc.
@@ -14,22 +14,13 @@ description: A simple mixin for CLI interfaces, including option parsing
 email: info@chef.io
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE
-- NOTICE
+extra_rdoc_files: []
 files:
-- Gemfile
 - LICENSE
 - NOTICE
-- README.md
-- Rakefile
 - lib/mixlib/cli.rb
 - lib/mixlib/cli/version.rb
-- mixlib-cli.gemspec
-- spec/mixlib/cli_spec.rb
-- spec/spec_helper.rb
-homepage: https://www.chef.io
+homepage: https://www.github.com/mixlib-cli
 licenses:
 - Apache-2.0
 metadata: {}

data/Gemfile

@@ -1,28 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-group :docs do
-  gem "yard"
-  gem "redcarpet"
-  gem "github-markup"
-end
-
-group :test do
-  gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
-  gem "rspec", "~> 3.0"
-  gem "rake"
-end
-
-group :development do
-  gem "pry"
-  gem "pry-byebug"
-  gem "pry-stack_explorer"
-  gem "rb-readline"
-end
-
-instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
-
-# If you want to load debugging tools into the bundle exec sandbox,
-# add these additional dependencies into Gemfile.local
-eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/README.md

@@ -1,120 +0,0 @@
-# Mixlib::CLI
-
-[![Build Status Master](https://travis-ci.org/chef/mixlib-cli.svg?branch=master)](https://travis-ci.org/chef/mixlib-cli) [![Gem Version](https://badge.fury.io/rb/mixlib-cli.svg)](https://badge.fury.io/rb/mixlib-cli)
-
-Mixlib::CLI provides a class-based command line option parsing object, like the one used in Chef, Ohai and Relish. To use in your project:
-
-```ruby
-require "mixlib/cli"
-
-class MyCLI
-  include Mixlib::CLI
-
-  option :config_file,
-    short: "-c CONFIG",
-    long: "--config CONFIG",
-    default: "config.rb",
-    description: "The configuration file to use"
-
-  option :log_level,
-    short: "-l LEVEL",
-    long: "--log_level LEVEL",
-    description: "Set the log level (debug, info, warn, error, fatal)",
-    required: true,
-    in: [:debug, :info, :warn, :error, :fatal],
-    proc: Proc.new { |l| l.to_sym }
-
-  option :help,
-    short: "-h",
-    long: "--help",
-    description: "Show this message",
-    on: :tail,
-    boolean: true,
-    show_options: true,
-    exit: 0
-
-end
-
-# ARGV = [ '-c', 'foo.rb', '-l', 'debug' ]
-cli = MyCLI.new
-cli.parse_options
-cli.config[:config_file] # 'foo.rb'
-cli.config[:log_level]   # :debug
-```
-
-If you are using this in conjunction with Mixlib::Config, you can do something like this (building on the above definition):
-
-```ruby
-class MyConfig
-  extend(Mixlib::Config)
-
-  log_level   :info
-  config_file "default.rb"
-end
-
-class MyCLI
-  def run(argv = ARGV)
-    parse_options(argv)
-    MyConfig.merge!(config)
-  end
-end
-
-c = MyCLI.new
-# ARGV = [ '-l', 'debug' ]
-c.run
-MyConfig[:log_level] # :debug
-```
-
-Available arguments to 'option':
-
-- `:short`: The short option, just like from optparse. Example: "-l LEVEL"
-- `:long`: The long option, just like from optparse. Example: "--level LEVEL"
-- `:description`: The description for this item, just like from optparse.
-- `:default`: A default value for this option
-- `:required`: Prints a message informing the user of the missing requirement, and exits. Default is false.
-- `:on`: Set to :tail to appear at the end, or `:head`: to appear at the top.
-- `:boolean:`: If this option takes no arguments, set this to true.
-- `:show_options`: If you want the option list printed when this option is called, set this to true.
-- `:exit`: Exit your program with the exit code when this option is specified. Example: 0
-- `:proc`: If set, the configuration value will be set to the return value of this proc.
-- `:in`: An array containing the list of accepted values
-
-If you need access to the leftover options that aren't captured in the config, you can get at them through +cli_arguments+ (referring to the above definition of MyCLI).
-
-```ruby
-# ARGV = [ '-c', 'foo.rb', '-l', 'debug', 'file1', 'file2', 'file3' ]
-cli = MyCLI.new
-cli.parse_options
-cli.cli_arguments # [ 'file1', 'file2', 'file3' ]
-```
-
-## Documentation
-
-All documentation is written using YARD. You can generate a by running:
-
-```
-rake docs
-```
-
-## Contributing
-
-For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md)
-
-## License & Copyright
-
-- Copyright:: Copyright (c) 2008-2018 Chef Software, Inc.
-- License:: Apache License, Version 2.0
-
-```text
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-```

data/Rakefile

@@ -1,36 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-task default: [:style, :spec]
-
-Bundler::GemHelper.install_tasks
-
-desc "Run specs"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
-end
-
-begin
-  require "chefstyle"
-  require "rubocop/rake_task"
-  RuboCop::RakeTask.new(:style) do |task|
-    task.options += ["--display-cop-names", "--no-color"]
-  end
-rescue LoadError
-  puts "chefstyle/rubocop is not available. bundle install first to make sure all dependencies are installed."
-end
-
-begin
-  require "yard"
-  YARD::Rake::YardocTask.new(:docs)
-rescue LoadError
-  puts "yard is not available. bundle install first to make sure all dependencies are installed."
-end
-
-task :console do
-  require "irb"
-  require "irb/completion"
-  require "mixlib/cli"
-  ARGV.clear
-  IRB.start
-end

data/mixlib-cli.gemspec

@@ -1,19 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + "/lib")
-require "mixlib/cli/version"
-
-Gem::Specification.new do |s|
-  s.name = "mixlib-cli"
-  s.version = Mixlib::CLI::VERSION
-  s.extra_rdoc_files = ["README.md", "LICENSE", "NOTICE"]
-  s.summary = "A simple mixin for CLI interfaces, including option parsing"
-  s.description = s.summary
-  s.author = "Chef Software, Inc."
-  s.email = "info@chef.io"
-  s.homepage = "https://www.chef.io"
-  s.license = "Apache-2.0"
-  s.required_ruby_version = ">= 2.5"
-
-  s.require_path = "lib"
-  s.files = %w{LICENSE README.md Gemfile Rakefile NOTICE} + Dir.glob("*.gemspec") +
-    Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
-end

data/spec/mixlib/cli_spec.rb

@@ -1,365 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
-
-describe Mixlib::CLI do
-  after(:each) do
-    TestCLI.options = {}
-    TestCLI.banner("Usage: #{$0} (options)")
-  end
-
-  describe "class method" do
-    describe "option" do
-      it "allows you to set a config option with a hash" do
-        expect(TestCLI.option(:config_file, short: "-c CONFIG")).to eql({ short: "-c CONFIG" })
-      end
-    end
-
-    describe "options" do
-      it "returns the current options hash" do
-        TestCLI.option(:config_file, short: "-c CONFIG")
-        expect(TestCLI.options).to eql({ config_file: { short: "-c CONFIG" } })
-      end
-    end
-
-    describe "options=" do
-      it "allows you to set the full options with a single hash" do
-        TestCLI.options = { config_file: { short: "-c CONFIG" } }
-        expect(TestCLI.options).to eql({ config_file: { short: "-c CONFIG" } })
-      end
-    end
-
-    describe "banner" do
-      it "has a default value" do
-        expect(TestCLI.banner).to match(/^Usage: (.+) \(options\)$/)
-      end
-
-      it "allows you to set the banner" do
-        TestCLI.banner("Usage: foo")
-        expect(TestCLI.banner).to eql("Usage: foo")
-      end
-    end
-  end
-
-  context "when configured with default single-config-hash behavior" do
-
-    before(:each) do
-      @cli = TestCLI.new
-    end
-
-    describe "initialize" do
-      it "sets the banner to the class defined banner" do
-        expect(@cli.banner).to eql(TestCLI.banner)
-      end
-
-      it "sets the options to the class defined options, plus defaults" do
-        TestCLI.option(:config_file, short: "-l LOG")
-        cli = TestCLI.new
-        expect(cli.options).to eql({
-          config_file: {
-            short: "-l LOG",
-            on: :on,
-            boolean: false,
-            required: false,
-            proc: nil,
-            show_options: false,
-            exit: nil,
-            in: nil,
-          },
-        })
-      end
-
-      it "sets the default config value for any options that include it" do
-        TestCLI.option(:config_file, short: "-l LOG", default: :debug)
-        @cli = TestCLI.new
-        expect(@cli.config[:config_file]).to eql(:debug)
-      end
-    end
-
-    describe "opt_parser" do
-
-      it "sets the banner in opt_parse" do
-        expect(@cli.opt_parser.banner).to eql(@cli.banner)
-      end
-
-      it "presents the arguments in the banner" do
-        TestCLI.option(:config_file, short: "-l LOG")
-        @cli = TestCLI.new
-        expect(@cli.opt_parser.to_s).to match(/-l LOG/)
-      end
-
-      it "honors :on => :tail options in the banner" do
-        TestCLI.option(:config_file, short: "-l LOG")
-        TestCLI.option(:help, short: "-h", boolean: true, on: :tail)
-        @cli = TestCLI.new
-        expect(@cli.opt_parser.to_s.split("\n").last).to match(/-h/)
-      end
-
-      it "honors :on => :head options in the banner" do
-        TestCLI.option(:config_file, short: "-l LOG")
-        TestCLI.option(:help, short: "-h", boolean: true, on: :head)
-        @cli = TestCLI.new
-        expect(@cli.opt_parser.to_s.split("\n")[1]).to match(/-h/)
-      end
-
-      it "presents the arguments in alphabetical order in the banner" do
-        TestCLI.option(:alpha, short: "-a ALPHA")
-        TestCLI.option(:beta, short: "-b BETA")
-        TestCLI.option(:zeta, short: "-z ZETA")
-        @cli = TestCLI.new
-        output_lines = @cli.opt_parser.to_s.split("\n")
-        expect(output_lines[1]).to match(/-a ALPHA/)
-        expect(output_lines[2]).to match(/-b BETA/)
-        expect(output_lines[3]).to match(/-z ZETA/)
-      end
-
-    end
-
-    describe "parse_options" do
-      it "sets the corresponding config value for non-boolean arguments" do
-        TestCLI.option(:config_file, short: "-c CONFIG")
-        @cli = TestCLI.new
-        @cli.parse_options([ "-c", "foo.rb" ])
-        expect(@cli.config[:config_file]).to eql("foo.rb")
-      end
-
-      it "sets the corresponding config value according to a supplied proc" do
-        TestCLI.option(:number,
-          short: "-n NUMBER",
-          proc: Proc.new { |config| config.to_i + 2 }
-        )
-        @cli = TestCLI.new
-        @cli.parse_options([ "-n", "2" ])
-        expect(@cli.config[:number]).to eql(4)
-      end
-
-      it "passes the existing value to two-argument procs" do
-        TestCLI.option(:number,
-          short: "-n NUMBER",
-          proc: Proc.new { |value, existing| existing ||= []; existing << value; existing }
-        )
-        @cli = TestCLI.new
-        @cli.parse_options([ "-n", "2", "-n", "3" ])
-        expect(@cli.config[:number]).to eql(%w{2 3})
-      end
-
-      it "sets the corresponding config value to true for boolean arguments" do
-        TestCLI.option(:i_am_boolean, short: "-i", boolean: true)
-        @cli = TestCLI.new
-        @cli.parse_options([ "-i" ])
-        expect(@cli.config[:i_am_boolean]).to be true
-      end
-
-      it "sets the corresponding config value to false when a boolean is prefixed with --no" do
-        TestCLI.option(:i_am_boolean, long: "--[no-]bool", boolean: true)
-        @cli = TestCLI.new
-        @cli.parse_options([ "--no-bool" ])
-        expect(@cli.config[:i_am_boolean]).to be false
-      end
-
-      it "exits if a config option has :exit set" do
-        TestCLI.option(:i_am_exit, short: "-x", boolean: true, exit: 0)
-        @cli = TestCLI.new
-        expect(lambda { @cli.parse_options(["-x"]) }).to raise_error(SystemExit)
-      end
-
-      it "exits if a required option is missing" do
-        TestCLI.option(:require_me, short: "-r", boolean: true, required: true)
-        @cli = TestCLI.new
-        expect(lambda { @cli.parse_options([]) }).to raise_error(SystemExit)
-      end
-
-      it "exits if option is not included in the list and required" do
-        TestCLI.option(:inclusion, short: "-i val", in: %w{one two}, required: true)
-        @cli = TestCLI.new
-        expect(lambda { @cli.parse_options(["-i", "three"]) }).to raise_error(SystemExit)
-      end
-
-      it "exits if option is not included in the list and not required" do
-        TestCLI.option(:inclusion, short: "-i val", in: %w{one two}, required: false)
-        @cli = TestCLI.new
-        expect(lambda { @cli.parse_options(["-i", "three"]) }).to raise_error(SystemExit)
-      end
-
-      it "doesn't exit if option is nil and not required" do
-        TestCLI.option(:inclusion, short: "-i val", in: %w{one two}, required: false)
-        @cli = TestCLI.new
-        expect do
-          expect(@cli.parse_options([])).to eql []
-        end.to_not raise_error
-      end
-
-      it "exit if option is nil and required" do
-        TestCLI.option(:inclusion, short: "-i val", in: %w{one two}, required: true)
-        @cli = TestCLI.new
-        expect(lambda { @cli.parse_options([]) }).to raise_error(SystemExit)
-      end
-
-      it "raises ArgumentError if options key :in is not an array" do
-        TestCLI.option(:inclusion, short: "-i val", in: "foo", required: true)
-        @cli = TestCLI.new
-        expect(lambda { @cli.parse_options(["-i", "three"]) }).to raise_error(ArgumentError)
-      end
-
-      it "doesn't exit if option is included in the list" do
-        TestCLI.option(:inclusion, short: "-i val", in: %w{one two}, required: true)
-        @cli = TestCLI.new
-        @cli.parse_options(["-i", "one"])
-        expect(@cli.config[:inclusion]).to eql("one")
-      end
-
-      it "changes description if :in key is specified" do
-        TestCLI.option(:inclusion, short: "-i val", in: %w{one two}, description: "desc", required: false)
-        @cli = TestCLI.new
-        @cli.parse_options(["-i", "one"])
-        expect(@cli.options[:inclusion][:description]).to eql("desc (included in ['one', 'two'])")
-      end
-
-      it "doesn't exit if a required option is specified" do
-        TestCLI.option(:require_me, short: "-r", boolean: true, required: true)
-        @cli = TestCLI.new
-        @cli.parse_options(["-r"])
-        expect(@cli.config[:require_me]).to be true
-      end
-
-      it "doesn't exit if a required boolean option is specified and false" do
-        TestCLI.option(:require_me, long: "--[no-]req", boolean: true, required: true)
-        @cli = TestCLI.new
-        @cli.parse_options(["--no-req"])
-        expect(@cli.config[:require_me]).to be false
-      end
-
-      it "doesn't exit if a required option is specified and empty" do
-        TestCLI.option(:require_me, short: "-r VALUE", required: true)
-        @cli = TestCLI.new
-        @cli.parse_options(["-r", ""])
-        expect(@cli.config[:require_me]).to eql("")
-      end
-
-      it "preserves all of the commandline arguments, ARGV" do
-        TestCLI.option(:config_file, short: "-c CONFIG")
-        @cli = TestCLI.new
-        argv_old = ARGV.dup
-        ARGV.replace ["-c", "foo.rb"]
-        @cli.parse_options()
-        expect(ARGV).to eql(["-c", "foo.rb"])
-        ARGV.replace argv_old
-      end
-
-      it "preserves and return any un-parsed elements" do
-        TestCLI.option(:party, short: "-p LOCATION")
-        @cli = TestCLI.new
-        expect(@cli.parse_options([ "easy", "-p", "opscode", "hard" ])).to eql(%w{easy hard})
-        expect(@cli.cli_arguments).to eql(%w{easy hard})
-      end
-    end
-  end
-
-  context "when configured to separate default options" do
-    before do
-      TestCLI.use_separate_default_options true
-      TestCLI.option(:defaulter, short: "-D SOMETHING", default: "this is the default")
-      @cli = TestCLI.new
-    end
-
-    it "sets default values on the `default` hash" do
-      @cli.parse_options([])
-      expect(@cli.default_config[:defaulter]).to eql("this is the default")
-      expect(@cli.config[:defaulter]).to be_nil
-    end
-
-    it "sets parsed values on the `config` hash" do
-      @cli.parse_options(%w{-D not-default})
-      expect(@cli.default_config[:defaulter]).to eql("this is the default")
-      expect(@cli.config[:defaulter]).to eql("not-default")
-    end
-
-  end
-
-  context "when subclassed" do
-    before do
-      TestCLI.options = { arg1: { boolean: true } }
-    end
-
-    it "retains previously defined options from parent" do
-      class T1 < TestCLI
-        option :arg2, boolean: true
-      end
-      expect(T1.options[:arg1]).to be_a(Hash)
-      expect(T1.options[:arg2]).to be_a(Hash)
-      expect(TestCLI.options[:arg2]).to be_nil
-    end
-
-    it "isn't able to modify parent classes options" do
-      class T2 < TestCLI
-        option :arg2, boolean: true
-      end
-      T2.options[:arg1][:boolean] = false
-      expect(T2.options[:arg1][:boolean]).to be false
-      expect(TestCLI.options[:arg1][:boolean]).to be true
-    end
-
-    it "passes its options onto child" do
-      class T3 < TestCLI
-        option :arg2, boolean: true
-      end
-      class T4 < T3
-        option :arg3, boolean: true
-      end
-      3.times do |i|
-        expect(T4.options["arg#{i + 1}".to_sym]).to be_a(Hash)
-      end
-    end
-
-    it "also works with an option that's an array" do
-      class T5 < TestCLI
-        option :arg2, default: []
-      end
-
-      class T6 < T5
-      end
-
-      expect(T6.options[:arg2]).to be_a(Hash)
-    end
-
-  end
-
-end
-
-#  option :config_file,
-#    :short => "-c CONFIG",
-#    :long  => "--config CONFIG",
-#    :default => 'config.rb',
-#    :description => "The configuration file to use"
-#
-#  option :log_level,
-#    :short => "-l LEVEL",
-#    :long  => "--log_level LEVEL",
-#    :description => "Set the log level (debug, info, warn, error, fatal)",
-#    :required => true,
-#    :proc => nil
-#
-#  option :help,
-#    :short => "-h",
-#    :long => "--help",
-#    :description => "Show this message",
-#    :on => :tail,
-#    :boolean => true,
-#    :show_options => true,
-#    :exit => 0

data/spec/spec_helper.rb

@@ -1,26 +0,0 @@
-$TESTING = true
-$:.push File.join(File.dirname(__FILE__), "..", "lib")
-
-require "mixlib/cli"
-
-class TestCLI
-  include Mixlib::CLI
-end
-
-RSpec.configure do |config|
-  # Use documentation format
-  config.formatter = "doc"
-
-  # Use color in STDOUT
-  config.color = true
-
-  # Use color not only in STDOUT but also in pagers and files
-  config.tty = true
-
-  # run the examples in random order
-  config.order = :rand
-
-  config.filter_run focus: true
-  config.run_all_when_everything_filtered = true
-  config.warnings = true
-end