mixlib-cli-1.7.0/0000755000004100000410000000000012741147770013612 5ustar www-datawww-datamixlib-cli-1.7.0/Rakefile0000644000004100000410000000142312741147770015257 0ustar www-datawww-datarequire "bundler" require "rubygems" require "rubygems/package_task" require "rdoc/task" require "rspec/core/rake_task" Bundler::GemHelper.install_tasks task :default => :spec desc "Run specs" RSpec::Core::RakeTask.new(:spec) do |spec| spec.pattern = "spec/**/*_spec.rb" end gem_spec = eval(File.read("mixlib-cli.gemspec")) RDoc::Task.new do |rdoc| rdoc.rdoc_dir = "rdoc" rdoc.title = "mixlib-cli #{gem_spec.version}" rdoc.rdoc_files.include("README*") rdoc.rdoc_files.include("lib/**/*.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. gem install chefstyle to do style checking." end mixlib-cli-1.7.0/Gemfile0000644000004100000410000000004712741147770015106 0ustar www-datawww-datasource "https://rubygems.org" gemspec mixlib-cli-1.7.0/mixlib-cli.gemspec0000644000004100000410000000171012741147770017207 0ustar www-datawww-data$:.unshift(File.dirname(__FILE__) + "/lib") require "mixlib/cli/version" Gem::Specification.new do |s| s.name = "mixlib-cli" s.version = Mixlib::CLI::VERSION s.platform = Gem::Platform::RUBY s.has_rdoc = true 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" # Uncomment this to add a dependency #s.add_dependency "mixlib-log" s.add_development_dependency "rake", "< 11.0" s.add_development_dependency "rspec", "~> 2.14" s.add_development_dependency "rdoc" s.add_development_dependency "chefstyle", "~> 0.3" 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 mixlib-cli-1.7.0/spec/0000755000004100000410000000000012741147770014544 5ustar www-datawww-datamixlib-cli-1.7.0/spec/spec_helper.rb0000644000004100000410000000052412741147770017363 0ustar www-datawww-data$TESTING = true $:.push File.join(File.dirname(__FILE__), "..", "lib") require "mixlib/cli" class TestCLI include Mixlib::CLI end RSpec.configure do |config| config.filter_run :focus => true config.run_all_when_everything_filtered = true config.treat_symbols_as_metadata_keys_with_true_values = true config.warnings = true end mixlib-cli-1.7.0/spec/mixlib/0000755000004100000410000000000012741147770016030 5ustar www-datawww-datamixlib-cli-1.7.0/spec/mixlib/cli_spec.rb0000644000004100000410000002646512741147770020153 0ustar www-datawww-data# # Author:: Adam Jacob () # Copyright:: Copyright (c) 2008 Opscode, 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 "should allow you to set a config option with a hash" do TestCLI.option(:config_file, :short => "-c CONFIG").should == { :short => "-c CONFIG" } end end describe "options" do it "should return the current options hash" do TestCLI.option(:config_file, :short => "-c CONFIG") TestCLI.options.should == { :config_file => { :short => "-c CONFIG" } } end end describe "options=" do it "should allow you to set the full options with a single hash" do TestCLI.options = { :config_file => { :short => "-c CONFIG" } } TestCLI.options.should == { :config_file => { :short => "-c CONFIG" } } end end describe "banner" do it "should have a default value" do TestCLI.banner.should =~ /^Usage: (.+) \(options\)$/ end it "should allow you to set the banner" do TestCLI.banner("Usage: foo") TestCLI.banner.should == "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 "should set the banner to the class defined banner" do @cli.banner.should == TestCLI.banner end it "should set the options to the class defined options, plus defaults" do TestCLI.option(:config_file, :short => "-l LOG") cli = TestCLI.new cli.options.should == { :config_file => { :short => "-l LOG", :on => :on, :boolean => false, :required => false, :proc => nil, :show_options => false, :exit => nil, :in => nil, }, } end it "should set the default config value for any options that include it" do TestCLI.option(:config_file, :short => "-l LOG", :default => :debug) @cli = TestCLI.new @cli.config[:config_file].should == :debug end end describe "opt_parser" do it "should set the banner in opt_parse" do @cli.opt_parser.banner.should == @cli.banner end it "should present the arguments in the banner" do TestCLI.option(:config_file, :short => "-l LOG") @cli = TestCLI.new @cli.opt_parser.to_s.should =~ /-l LOG/ end it "should honor :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 @cli.opt_parser.to_s.split("\n").last.should =~ /-h/ end it "should honor :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 @cli.opt_parser.to_s.split("\n")[1].should =~ /-h/ end it "should present 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") output_lines[1].should =~ /-a ALPHA/ output_lines[2].should =~ /-b BETA/ output_lines[3].should =~ /-z ZETA/ end end describe "parse_options" do it "should set 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" ]) @cli.config[:config_file].should == "foo.rb" end it "should set 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" ]) @cli.config[:number].should == 4 end it "should pass 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" ]) @cli.config[:number].should == %w{2 3} end it "should set 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" ]) @cli.config[:i_am_boolean].should == true end it "should set 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" ]) @cli.config[:i_am_boolean].should == false end it "should exit if a config option has :exit set" do TestCLI.option(:i_am_exit, :short => "-x", :boolean => true, :exit => 0) @cli = TestCLI.new lambda { @cli.parse_options(["-x"]) }.should raise_error(SystemExit) end it "should exit if a required option is missing" do TestCLI.option(:require_me, :short => "-r", :boolean => true, :required => true) @cli = TestCLI.new lambda { @cli.parse_options([]) }.should raise_error(SystemExit) end it "should exit if option is not included in the list" do TestCLI.option(:inclusion, :short => "-i val", :in => %w{one two}) @cli = TestCLI.new lambda { @cli.parse_options(["-i", "three"]) }.should raise_error(SystemExit) end it "should raise ArgumentError if options key :in is not an array" do TestCLI.option(:inclusion, :short => "-i val", :in => "foo") @cli = TestCLI.new lambda { @cli.parse_options(["-i", "three"]) }.should raise_error(ArgumentError) end it "should not exit if option is included in the list" do TestCLI.option(:inclusion, :short => "-i val", :in => %w{one two}) @cli = TestCLI.new @cli.parse_options(["-i", "one"]) @cli.config[:inclusion].should == "one" end it "should change description if :in key is specified" do TestCLI.option(:inclusion, :short => "-i val", :in => %w{one two}, :description => "desc") @cli = TestCLI.new @cli.parse_options(["-i", "one"]) @cli.options[:inclusion][:description].should == "desc (included in ['one', 'two'])" end it "should not 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"]) @cli.config[:require_me].should == true end it "should not 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"]) @cli.config[:require_me].should == false end it "should not 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", ""]) @cli.config[:require_me].should == "" end it "should preserve 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() ARGV.should == ["-c", "foo.rb"] ARGV.replace argv_old end it "should preserve and return any un-parsed elements" do TestCLI.option(:party, :short => "-p LOCATION") @cli = TestCLI.new @cli.parse_options([ "easy", "-p", "opscode", "hard" ]).should == %w{easy hard} @cli.cli_arguments.should == %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([]) @cli.default_config[:defaulter].should == "this is the default" @cli.config[:defaulter].should be_nil end it "sets parsed values on the `config` hash" do @cli.parse_options(%w{-D not-default}) @cli.default_config[:defaulter].should == "this is the default" @cli.config[:defaulter].should == "not-default" end end context "when subclassed" do before do TestCLI.options = { :arg1 => { :boolean => true } } end it "should retain previously defined options from parent" do class T1 < TestCLI option :arg2, :boolean => true end T1.options[:arg1].should be_a(Hash) T1.options[:arg2].should be_a(Hash) TestCLI.options[:arg2].should be_nil end it "should not be able to modify parent classes options" do class T2 < TestCLI option :arg2, :boolean => true end T2.options[:arg1][:boolean] = false T2.options[:arg1][:boolean].should be_false TestCLI.options[:arg1][:boolean].should be_true end it "should pass 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| T4.options["arg#{i + 1}".to_sym].should be_a(Hash) end end it "should also work with an option that's an array" do class T5 < TestCLI option :arg2, :default => [] end class T6 < T5 end T6.options[:arg2].should 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 mixlib-cli-1.7.0/lib/0000755000004100000410000000000012741147770014360 5ustar www-datawww-datamixlib-cli-1.7.0/lib/mixlib/0000755000004100000410000000000012741147770015644 5ustar www-datawww-datamixlib-cli-1.7.0/lib/mixlib/cli.rb0000644000004100000410000002632012741147770016743 0ustar www-datawww-data# # Author:: Adam Jacob () # Copyright:: Copyright (c) 2008 Opscode, 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 "optparse" module Mixlib # == Mixlib::CLI # Adds a DSL for defining command line options and methods for parsing those # options to the including class. # # Mixlib::CLI does some setup in #initialize, so the including class must # call `super()` if it defines a custom initializer. # # === DSL # When included, Mixlib::CLI also extends the including class with its # ClassMethods, which define the DSL. The primary methods of the DSL are # ClassMethods#option, which defines a command line option, and # ClassMethods#banner, which defines the "usage" banner. # # === Parsing # Command line options are parsed by calling the instance method # #parse_options. After calling this method, the attribute #config will # contain a hash of `:option_name => value` pairs. module CLI module InheritMethods def inherited(receiver) receiver.options = deep_dup(self.options) receiver.extend(Mixlib::CLI::InheritMethods) end # object:: Instance to clone # This method will return a "deep clone" of the provided # `object`. If the provided `object` is an enumerable type the # contents will be iterated and cloned as well. def deep_dup(object) cloned_object = object.respond_to?(:dup) ? object.dup : object if cloned_object.kind_of?(Enumerable) if cloned_object.kind_of?(Hash) new_hash = cloned_object.class.new cloned_object.each do |key, value| cloned_key = deep_dup(key) cloned_value = deep_dup(value) new_hash[cloned_key] = cloned_value end cloned_object.replace(new_hash) else cloned_object.map! do |shallow_instance| deep_dup(shallow_instance) end end end cloned_object rescue TypeError # Symbol will happily provide a `#dup` method even though # attempts to clone it will result in an exception (atoms!). # So if we run into an issue of TypeErrors, just return the # original object as we gave our "best effort" object end end module ClassMethods # When this setting is set to +true+, default values supplied to the # mixlib-cli DSL will be stored in a separate Hash def use_separate_default_options(true_or_false) @separate_default_options = true_or_false end def use_separate_defaults? @separate_default_options ||= false end # Add a command line option. # # === Parameters # name:: The name of the option to add # args:: A hash of arguments for the option, specifying how it should be parsed. # === Returns # true:: Always returns true. def option(name, args) @options ||= {} raise(ArgumentError, "Option name must be a symbol") unless name.kind_of?(Symbol) @options[name.to_sym] = args end # Get the hash of current options. # # === Returns # @options:: The current options hash. def options @options ||= {} @options end # Set the current options hash # # === Parameters # val:: The hash to set the options to # # === Returns # @options:: The current options hash. def options=(val) raise(ArgumentError, "Options must recieve a hash") unless val.kind_of?(Hash) @options = val end # Change the banner. Defaults to: # Usage: #{0} (options) # # === Parameters # bstring:: The string to set the banner to # # === Returns # @banner:: The current banner def banner(bstring = nil) if bstring @banner = bstring else @banner ||= "Usage: #{$0} (options)" @banner end end end # Gives the command line options definition as configured in the DSL. These # are used by #parse_options to generate the option parsing code. To get # the values supplied by the user, see #config. attr_accessor :options # A Hash containing the values supplied by command line options. # # The behavior and contents of this Hash vary depending on whether # ClassMethods#use_separate_default_options is enabled. # ==== use_separate_default_options *disabled* # After initialization, +config+ will contain any default values defined # via the mixlib-config DSL. When #parse_options is called, user-supplied # values (from ARGV) will be merged in. # ==== use_separate_default_options *enabled* # After initialization, this will be an empty hash. When #parse_options is # called, +config+ is populated *only* with user-supplied values. attr_accessor :config # If ClassMethods#use_separate_default_options is enabled, this will be a # Hash containing key value pairs of `:option_name => default_value` # (populated during object initialization). # # If use_separate_default_options is disabled, it will always be an empty # hash. attr_accessor :default_config # Any arguments which were not parsed and placed in "config"--the leftovers. attr_accessor :cli_arguments # Banner for the option parser. If the option parser is printed, e.g., by # `puts opt_parser`, this string will be used as the first line. attr_accessor :banner # Create a new Mixlib::CLI class. If you override this, make sure you call super! # # === Parameters # *args:: The array of arguments passed to the initializer # # === Returns # object:: Returns an instance of whatever you wanted :) def initialize(*args) @options = Hash.new @config = Hash.new @default_config = Hash.new @opt_parser = nil # Set the banner @banner = self.class.banner # Dupe the class options for this instance klass_options = self.class.options klass_options.keys.inject(@options) { |memo, key| memo[key] = klass_options[key].dup; memo } # If use_separate_defaults? is on, default values go in @default_config defaults_container = if self.class.use_separate_defaults? @default_config else @config end # Set the default configuration values for this instance @options.each do |config_key, config_opts| config_opts[:on] ||= :on config_opts[:boolean] ||= false config_opts[:required] ||= false config_opts[:proc] ||= nil config_opts[:show_options] ||= false config_opts[:exit] ||= nil config_opts[:in] ||= nil if config_opts.has_key?(:default) defaults_container[config_key] = config_opts[:default] end end super(*args) end # Parses an array, by default ARGV, for command line options (as configured at # the class level). # === Parameters # argv:: The array of arguments to parse; defaults to ARGV # # === Returns # argv:: Returns any un-parsed elements. def parse_options(argv = ARGV) argv = argv.dup opt_parser.parse!(argv) # Deal with any required values options.each do |opt_key, opt_value| if opt_value[:required] && !config.has_key?(opt_key) reqarg = opt_value[:short] || opt_value[:long] puts "You must supply #{reqarg}!" puts @opt_parser exit 2 end if opt_value[:in] unless opt_value[:in].kind_of?(Array) raise(ArgumentError, "Options config key :in must receive an Array") end if !opt_value[:in].include?(config[opt_key]) reqarg = opt_value[:short] || opt_value[:long] puts "#{reqarg}: #{config[opt_key]} is not included in the list ['#{opt_value[:in].join("', '")}'] " puts @opt_parser exit 2 end end end @cli_arguments = argv argv end # The option parser generated from the mixlib-cli DSL. +opt_parser+ can be # used to print a help message including the banner and any CLI options via # `puts opt_parser`. # === Returns # opt_parser:: The option parser object. def opt_parser @opt_parser ||= OptionParser.new do |opts| # Set the banner opts.banner = banner # Create new options options.sort { |a, b| a[0].to_s <=> b[0].to_s }.each do |opt_key, opt_val| opt_args = build_option_arguments(opt_val) opt_method = case opt_val[:on] when :on :on when :tail :on_tail when :head :on_head else raise ArgumentError, "You must pass :on, :tail, or :head to :on" end parse_block = Proc.new() do |c| config[opt_key] = if opt_val[:proc] if opt_val[:proc].arity == 2 # New hotness to allow for reducer-style procs. opt_val[:proc].call(c, config[opt_key]) else # Older single-argument proc. opt_val[:proc].call(c) end else # No proc. c end puts opts if opt_val[:show_options] exit opt_val[:exit] if opt_val[:exit] end full_opt = [ opt_method ] opt_args.inject(full_opt) { |memo, arg| memo << arg; memo } full_opt << parse_block opts.send(*full_opt) end end end def build_option_arguments(opt_setting) arguments = Array.new arguments << opt_setting[:short] if opt_setting.has_key?(:short) arguments << opt_setting[:long] if opt_setting.has_key?(:long) if opt_setting.has_key?(:description) description = opt_setting[:description] description << " (required)" if opt_setting[:required] description << " (included in ['#{opt_setting[:in].join("', '")}'])" if opt_setting[:in] arguments << description end arguments end def self.included(receiver) receiver.extend(Mixlib::CLI::ClassMethods) receiver.extend(Mixlib::CLI::InheritMethods) end end end mixlib-cli-1.7.0/lib/mixlib/cli/0000755000004100000410000000000012741147770016413 5ustar www-datawww-datamixlib-cli-1.7.0/lib/mixlib/cli/version.rb0000644000004100000410000000007312741147770020425 0ustar www-datawww-datamodule Mixlib module CLI VERSION = "1.7.0" end end mixlib-cli-1.7.0/NOTICE0000644000004100000410000000147012741147770014520 0ustar www-datawww-dataMixin::CLI NOTICE ================= Developed at Chef (http://www.chef.io). * Copyright 2009-2016, Chef Software, Inc. Mixin::CLI incorporates code from Chef. The Chef notice file follows: Chef NOTICE =========== Developed at Chef (http://www.chef.io). Contributors and Copyright holders: * Copyright 2008, Adam Jacob * Copyright 2008, Arjuna Christensen * Copyright 2008, Bryan McLellan * Copyright 2008, Ezra Zygmuntowicz * Copyright 2009, Sean Cribbs * Copyright 2009, Christopher Brown * Copyright 2009, Thom May Chef incorporates code modified from Open4 (http://www.codeforpeople.com/lib/ruby/open4/), which was written by Ara T. Howard. mixlib-cli-1.7.0/LICENSE0000644000004100000410000002514212741147770014623 0ustar www-datawww-data Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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. mixlib-cli-1.7.0/README.md0000644000004100000410000000671012741147770015075 0ustar www-datawww-data# 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 'rubygems' 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' ] ``` ## LICENSE: - Copyright:: Copyright (c) 2008-2016 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. ```