pedrozath-mercenary 0.3.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abfc352cd1288064314d2d38a2a8fb159167944af3ed6321b1ac582e11381f9f
+  data.tar.gz: 17d7e7f5ed239b55dc7ed7f58364aa109e0f9747514465fb9d920101c86bbd69
+SHA512:
+  metadata.gz: 574871d15def1f7ac1a920b0f19bf6b6d20c97f3da6387f080ea01fef30f505d842f273ad2c287eade19d1633e962ff6b8f07ef311718ce244b824ce2aaf9efb
+  data.tar.gz: d6d092702829952e1a0989b617b1edc37122d319cbb151cfc85977325cd6e11bb9a16d7ff1f5d510a91853c69834cd447428d446db2aa3bda1217657564c2411

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,174 @@
+---
+AllCops:
+  TargetRubyVersion: 2.0
+  Exclude:
+    - vendor/**/*
+Layout/AlignArray:
+  Enabled: false
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+Layout/AlignParameters:
+  Enabled: false
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EndOfLine:
+  EnforcedStyle: native
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent
+Layout/IndentationWidth:
+  Severity: error
+Layout/IndentArray:
+  EnforcedStyle: consistent
+Layout/IndentHash:
+  EnforcedStyle: consistent
+Layout/IndentHeredoc:
+  Enabled: false
+  Exclude:
+      - spec/**/*
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Layout/SpaceAroundOperators:
+  Enabled: true
+Layout/SpaceInsideBrackets:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Exclude:
+    - lib/mercenary/command.rb
+    - lib/mercenary/option.rb
+    - lib/mercenary/presenter.rb
+Lint/DuplicateMethods:
+  Exclude:
+    - lib/mercenary/command.rb
+Lint/EndAlignment:
+  Severity: error
+Lint/HandleExceptions:
+  Exclude:
+    - lib/mercenary/option.rb
+Lint/RescueWithoutErrorClass:
+  Enabled: false
+  Exclude:
+    - lib/mercenary/program.rb
+Lint/UselessAssignment:
+  Exclude:
+    - lib/mercenary/presenter.rb
+Lint/UnreachableCode:
+  Severity: error
+Lint/UselessAccessModifier:
+  Enabled: false
+Lint/Void:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 21
+  Exclude:
+    - lib/mercenary/program.rb
+Metrics/BlockLength:
+  Exclude:
+    - examples/**/*
+    - spec/**/*
+Metrics/ClassLength:
+  Max: 300
+Metrics/CyclomaticComplexity:
+  Max: 9
+Metrics/LineLength:
+  Exclude:
+    - lib/mercenary/command.rb
+    - lib/mercenary/presenter.rb
+    - lib/mercenary/program.rb
+    - examples/**/*
+    - spec/**/*
+    - mercenary.gemspec
+  Max: 90
+  Severity: warning
+Metrics/MethodLength:
+  Exclude:
+    - lib/mercenary/program.rb
+  CountComments: false
+  Max: 20
+  Severity: error
+Metrics/ModuleLength:
+  Max: 240
+Metrics/ParameterLists:
+  Max: 4
+Metrics/PerceivedComplexity:
+  Max: 8
+Naming/FileName:
+  Enabled: false
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+Naming/PredicateName:
+  Exclude:
+    - lib/mercenary/command.rb
+Style/Alias:
+  Enabled: false
+Style/AndOr:
+  Severity: error
+Style/Attr:
+  Enabled: false
+Style/BracesAroundHashParameters:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - lib/mercenary/command.rb
+  Enabled: true
+  EnforcedStyle: always
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/Encoding:
+  EnforcedStyle: when_needed
+Style/GuardClause:
+  Enabled: false
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+  Severity: error
+Style/IfUnlessModifier:
+  Enabled: false
+Style/InverseMethods:
+  Enabled: false
+Style/MethodMissing:
+  Exclude:
+    - lib/mercenary/presenter.rb
+Style/ModuleFunction:
+  Enabled: false
+Style/MultilineTernaryOperator:
+  Severity: error
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%q": "{}"
+    "%Q": "{}"
+    "%r": "!!"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/RedundantReturn:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+Style/RescueModifier:
+  Enabled: false
+Style/SignalException:
+  EnforcedStyle: only_raise
+Style/SingleLineMethods:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  Enabled: false
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/UnneededCapitalW:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+sudo: false
+cache: bundler
+before_script: bundle update
+script: script/cibuild
+notifications:
+  email:
+    recipients:
+      - mercenary@jekyllrb.com
+    on_success: change
+    on_failure: change

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mercenary.gemspec
+gemspec

data/History.markdown

@@ -0,0 +1,115 @@
+## HEAD
+
+### Development Fixes
+
+  * Adopt Jekyll's rubocop config for consistency (#51)
+
+## 0.3.6 / 2016-04-07
+
+### Bug Fixes
+
+  * Presenter: Options should include those from parent command (#42)
+
+## 0.3.5 / 2014-11-12
+
+### Bug Fixes
+
+  * Capture `OptionsParser::InvalidOption` and show a nice error message (#38)
+  * Absolute paths for requires and autoloads (#39)
+
+### Development Fixes
+
+  * Bump to RSpec 3 (#40)
+
+## 0.3.4 / 2014-07-11
+
+### Bug Fixes
+
+  * Use option object as key in the command's `@map` hash (#35)
+
+## 0.3.3 / 2014-05-07
+
+### Bug Fixes
+
+  * The `--version` flag should not exit with code 1, but instead code 0. (#33)
+
+## 0.3.2 / 2014-03-18
+
+### Bug Fixes
+
+  * Remove duplicate commands from help output; show aliases w/command names (#29)
+
+## 0.3.1 / 2014-02-21
+
+### Minor Enhancements
+
+  * Add `-t/--trace` to list of options in help message (#19)
+
+### Bug Fixes
+
+  * `Mercenary::Option` now accepts return values in the form of Class constants (#22)
+
+## 0.3.0 / 2014-02-20
+
+### Major Enhancements
+
+  * Officially drop 1.8.7 support (#14)
+  * Allow Commands to set their own versions (#17)
+  * Show subcommands, options and usage in help and attach to all commands (#18)
+  * Add `-t, --trace` to allow full exception backtrace to print, otherwise print just the error message (#19)
+
+### Minor Enhancements
+
+  * Logging state is maintained throughout process (#12)
+  * Tidy up Command#logger output (#21)
+
+### Development Fixes
+
+  * Added specs for `Program` (#13)
+
+## 0.2.1 / 2013-12-25
+
+### Bug Fixes
+
+  * Added missing comma to fix '-v' and '--version' options (#9)
+
+## 0.2.0 / 2013-11-30
+
+### Major Enhancements
+
+  * Add `Command#default_command` to specify a default command if none is given by the user at runtime (#7)
+
+### Minor Enhancements
+
+  * Add `Command#execute` to execute the actions of a command (#6)
+
+### Development Fixes
+
+  * Add standard GitHub bootstrap and cibuild scripts to `script/` (#2)
+
+## 0.1.0 / 2013-11-08
+
+### Major Enhancements
+
+  * It works!
+
+### Minor Enhancements
+
+  * Add a logger to `Command`
+  * Add `--version` switch to all programs
+
+### Bug Fixes
+
+  * Fix `Command#syntax` and `Command#description`'s handing of setting vs getting
+  * Fix load path problem in `lib/mercenary.rb`
+
+### Development Fixes
+
+  * Add TomDoc to everything
+  * Add a couple starter specs
+  * Add TravisCI badge
+  * Add Travis configuration
+
+## 0.0.1 / 2013-11-06
+
+  * Birthday!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-present Parker Moore and the mercenary contributors
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,249 @@
+# Mercenary
+
+Lightweight and flexible library for writing command-line apps in Ruby.
+
+[![Build Status](https://secure.travis-ci.org/jekyll/mercenary.png)](https://travis-ci.org/jekyll/mercenary)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mercenary'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mercenary
+
+**Note: Mercenary may not work with Ruby < 1.9.3.**
+
+## Usage
+
+Creating programs and commands with Mercenary is easy:
+
+```ruby
+Mercenary.program(:jekyll) do |p|
+  p.version Jekyll::VERSION
+  p.description 'Jekyll is a blog-aware, static site generator in Ruby'
+  p.syntax "jekyll <subcommand> [options]"
+
+  p.command(:new) do |c|
+    c.syntax "new PATH" # do not include the program name or super commands
+    c.description "Creates a new Jekyll site scaffold in PATH"
+    c.option 'blank', '--blank', 'Initialize the new site without any content.'
+
+    c.action do |args, options|
+      Jekyll::Commands::New.process(args, blank: options['blank'])
+    end
+  end
+
+  p.command(:build) do |c|
+    c.syntax "build [options]"
+    c.description "Builds your Jekyll site"
+
+    c.option 'safe', '--safe', 'Run in safe mode'
+    c.option 'source', '--source DIR', 'From where to collect the source files'
+    c.option 'destination', '--dest DIR', 'To where the compiled files should be written'
+
+    c.action do |_, options|
+      Jekyll::Commands::Build.process(options)
+    end
+  end
+
+  # Bring in command bundled in external gem
+  begin
+    require "jekyll-import"
+    JekyllImport.init_with_program(p)
+  rescue LoadError
+  end
+
+  p.default_command(:build)
+end
+```
+
+All commands have the following default options:
+
+- `-h/--help` - show a help message
+- `-v/--version` - show the program version
+- `-t/--trace` - show the full backtrace when an error occurs
+
+## API
+
+### `Mercenary`
+
+#### `.program`
+
+Creates and executes a program. Accepts two arguments:
+
+- `name` - program name as a Symbol
+- `block` - the specification for the program, passed the program instance as an
+  argument.
+
+Example is above, under the heading [Usage](#usage).
+
+### `Program`
+
+`Program` is a subclass of `Command`, so it has all of the methods documented
+below as well as those for `Command`.
+
+#### `#config`
+
+Fetches the program configuration hash.
+
+### `Command`
+
+#### `#new`
+
+Create a new command. Accepts one argument:
+
+- `name` - the name of your command, as a symbol
+
+#### `#version`
+
+Sets or gets the version of the command. Accepts an optional argument:
+
+- `version` - (optional) the version to set for the command. If present, this
+  becomes the new version for the command and persists.
+
+#### `#syntax`
+
+Sets or gets the syntax of the command. Built on parent syntaxes if a parent
+exists. Accepts one optional argument:
+
+- `syntax` - (optional) the syntax to set for the command. Will inherit from the
+  parent commands or program. Usually in the form of
+  `"command_name <SUBCOMMAND> [OPTIONS]"`
+
+When a parent command exists, say `supercommand`, with syntax set as
+`supercommand <SUBCOMMAND> [OPTIONS]`, the syntax of the command in question
+will be `supercommand command_name <SUBCOMMAND> [OPTIONS]` with both
+`<SUBCOMMAND>` and `[OPTIONS]` stripped out. Any text between `<` and `>` or
+between `[` and `]` will be stripped from parent command syntaxes. The purpose
+of this chaining is to reduce redundancy.
+
+#### `#description`
+
+Sets or gets the description of the command. Accepts one optional argument:
+
+- `desc` - (optional) the description to set for the command. If
+  provided, will override any previous description set for the command.
+
+#### `#default_command`
+
+Sets or gets the default subcommand of the command to execute in the event no
+subcommand is passed during execution. Accepts one optional argument:
+
+- `command_name` - (optional) the `Symbol` name of the subcommand to be
+  executed. Raises an `ArgumentError` if the subcommand doesn't exist.
+  Overwrites previously-set default commands.
+
+#### `#option`
+
+Adds a new option to the command. Accepts many arguments:
+
+- `config_key` - the configuration key that the value of this option maps to.
+- `*options` - all the options, globbed, to be passed to `OptionParser`, namely the
+  switches and the option description. Usually in the format
+  `"-s", "--switch", "Sets the 'switch' flag"`.
+
+Valid option calls:
+
+```ruby
+cmd.option 'config_key', '-c', 'Sets the "config" flag'
+cmd.option 'config_key', '--config', 'Sets the "config" flag'
+cmd.option 'config_key', '-c', '--config', 'Sets the "config" flag.'
+cmd.option 'config_key', '-c FILE', '--config FILE', 'The config file.'
+cmd.option 'config_key', '-c FILE1[,FILE2[,FILE3...]]', '--config FILE1[,FILE2[,FILE3...]]', Array, 'The config files.'
+```
+
+Notice that you can specify either a short switch, a long switch, or both. If
+you want to accept an argument, you have to specify it in the switch strings.
+The class of the argument defaults to `String`, but you can optionally set a
+different class to create, e.g. `Array`, if you are expecting a particular class
+in your code from this option's value. The description is also optional, but
+it's highly recommended to include a description.
+
+#### `#alias`
+
+Specifies an alias for this command such that the alias may be used in place of
+the command during execution. Accepts one argument:
+
+- `cmd_name` - the alias name for this command as a `Symbol`
+
+Example:
+
+```ruby
+cmd.alias(:my_alias)
+# Now `cmd` is now also executable via "my_alias"
+```
+
+#### `#action`
+
+Specifies a block to be executed in the event the command is specified at
+runtime. The block is given two arguments:
+
+- `args` - the non-switch arguments given from the command-line
+- `options` - the options hash built via the switches passed
+
+**Note that actions are additive**, meaning any new call to `#action` will
+result in another action to be executed at runtime. Actions will be executed in
+the order they are specified in.
+
+Example:
+
+```ruby
+cmd.action do |args, options|
+  # do something!
+end
+```
+
+#### `#logger`
+
+Access the logger for this command. Useful for outputting information to STDOUT.
+Accepts one optional argument:
+
+- `level` - (optional) the severity threshold at which to begin logging. Uses
+  Ruby's built-in
+  [`Logger`](http://www.ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html)
+  levels.
+
+Log level defaults to `Logger::INFO`.
+
+Examples:
+
+```ruby
+cmd.logger(Logger::DEBUG)
+cmd.logger.debug "My debug message."
+cmd.logger.info "My informative message."
+cmd.logger.warn "ACHTUNG!!"
+cmd.logger.error "Something terrible has happened."
+cmd.logger.fatal "I can't continue doing what I'm doing."
+```
+
+#### `#command`
+
+Creates a new subcommand for the current command. Accepts two arguments:
+
+- `cmd_name` - the command name, as a Symbol
+- `block` -  the specification of the subcommand in a block
+
+Example:
+
+```ruby
+my_command.command(:my_subcommand) do |subcmd|
+  subcmd.description 'My subcommand'
+  subcmd.syntax 'my_subcommand [OPTIONS]'
+  # ...
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/examples/help_dialogue.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(__dir__, "..", "lib")
+
+require "mercenary"
+
+# This example sets the logging mode of mercenary to
+# debug. Logging messages from "p.logger.debug" will
+# be output to STDOUT.
+
+Mercenary.program(:help_dialogue) do |p|
+  p.version "2.0.1"
+  p.description "An example of the help dialogue in Mercenary"
+  p.syntax "help_dialogue <subcommand>"
+
+  p.command(:some_subcommand) do |c|
+    c.version "1.4.2"
+    c.syntax "some_subcommand <subcommand> [options]"
+    c.description "Some subcommand to do something"
+    c.option "an_option", "-o", "--option", "Some option"
+    c.alias(:blah)
+
+    c.command(:yet_another_sub) do |f|
+      f.syntax "yet_another_sub [options]"
+      f.description "Do amazing things"
+      f.option "blah", "-b", "--blah", "Trigger blah flag"
+      f.option "heh", "-H ARG", "--heh ARG", "Give a heh"
+
+      f.action do |args, options|
+        print "Args: "
+        p args
+        print "Opts: "
+        p options
+      end
+    end
+  end
+
+  p.command(:another_subcommand) do |c|
+    c.syntax "another_subcommand <subcommand> [options]"
+    c.description "Another subcommand to do something different."
+    c.option "an_option", "-O", "--option", "Some option"
+    c.option "another_options", "--pluginzzz", "Set where the plugins should be found from"
+  end
+end

data/examples/logging.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(__dir__, "..", "lib")
+
+require "mercenary"
+
+# This example sets the logging mode of mercenary to
+# debug. Logging messages from "p.logger.debug" will
+# be output to STDOUT.
+
+Mercenary.program(:logger_output) do |p|
+  p.version "5.2.6"
+  p.description "An example of turning on logging for Mercenary."
+  p.syntax "logger_output"
+
+  p.logger.info "The default log level is INFO. So this will output."
+  p.logger.debug "Since DEBUG is below INFO, this will not output."
+
+  p.logger(Logger::DEBUG)
+  p.logger.debug "Logger level now set to DEBUG. So everything will output."
+
+  p.logger.debug    "Example of DEBUG level message."
+  p.logger.info     "Example of INFO level message."
+  p.logger.warn     "Example of WARN level message."
+  p.logger.error    "Example of ERROR level message."
+  p.logger.fatal    "Example of FATAL level message."
+  p.logger.unknown  "Example of UNKNOWN level message."
+
+  p.action do |_args, _options|
+    p.logger(Logger::INFO)
+    p.logger.debug "Logger level back to INFO. This line will not output."
+    p.logger.info "This INFO message will output."
+  end
+end