commander-openflighthpc 1.0.0.pre.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc01ccac1ba2a5fd02f67bd37df18b99338c47ee5ec198a8290c04d49314a914
+  data.tar.gz: 721ce6a9a0664d524b5647fe6ecf0e905bdc30918c4711fa3c42e9abe8c8fc16
+SHA512:
+  metadata.gz: 21b6f4bacadc8d47584d780b2656227bca27ca0ad6ce70d3cee8948f6c4f2a899d2cb01798d2572e8470907ae8ee136bb09d88c6fbc63e5d11fd5f1d9cb4ae37
+  data.tar.gz: 782fe6b493abe05d551b77ea719d9c01b7e6712e23d40697465f817c0d069af367cb6cbd817295e70f29dd3cc90ca9e91f57a180949c8f72d95cd37cd98f42dc

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.ruby-version
+coverage/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,44 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 1.9
+
+# not Ruby 1.9.3 compatible
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Offense count: 5
+Encoding:
+  Enabled: false
+
+# Enforce trailing comma after last item of multiline hashes.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_fail
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/NumericLiteralPrefix:
+  EnforcedOctalStyle: zero_only
+
+Style/MethodMissing:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 150

data/.rubocop_todo.yml

@@ -0,0 +1,77 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-02-16 16:08:54 -0800 using RuboCop version 0.29.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Security/Eval:
+  Enabled: false
+
+# Offense count: 2
+Lint/HandleExceptions:
+  Enabled: false
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Enabled: false
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 89
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 242
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 36
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 18
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 12
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 1
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+# Offense count: 5
+Style/RescueModifier:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+before_install:
+  - gem update --system
+  - gem update bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - jruby-19mode

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 1.0.0 / Unreleased
+
+ * Reset version numbering for this fork.
+ * Forked for OpenFlightHPC from upstream version 4.4.4 w/ existing patches from [alces-software/commander](https://github.com/alces-software/commander).
+ * Refer to [commander-rb/commander:History.rdoc](https://github.com/commander-rb/commander/blob/master/History.rdoc) for older changes.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,51 @@
+The following license applies to changes made subsequent to the point
+this version was forked from the original upstream version available
+at <https://github.com/commander-rb/commander>.
+
+The MIT License (MIT)
+
+Copyright (c) 2017-present Alces Flight Ltd <licensing@alces-flight.com>
+
+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.
+
+The original license from the upstream version is included below:
+
+The MIT License (MIT)
+
+Copyright (c) 2008-2013 TJ Holowaychuk <tj@vision-media.ca>
+
+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/Manifest

@@ -0,0 +1,38 @@
+DEVELOPMENT
+History.rdoc
+Manifest
+README.rdoc
+Rakefile
+bin/commander
+commander.gemspec
+lib/commander.rb
+lib/commander/blank.rb
+lib/commander/command.rb
+lib/commander/core_ext.rb
+lib/commander/core_ext/array.rb
+lib/commander/core_ext/object.rb
+lib/commander/delegates.rb
+lib/commander/help_formatters.rb
+lib/commander/help_formatters/base.rb
+lib/commander/help_formatters/terminal.rb
+lib/commander/help_formatters/terminal/command_help.erb
+lib/commander/help_formatters/terminal/help.erb
+lib/commander/help_formatters/terminal_compact.rb
+lib/commander/help_formatters/terminal_compact/command_help.erb
+lib/commander/help_formatters/terminal_compact/help.erb
+lib/commander/import.rb
+lib/commander/platform.rb
+lib/commander/runner.rb
+lib/commander/user_interaction.rb
+lib/commander/version.rb
+spec/command_spec.rb
+spec/core_ext/array_spec.rb
+spec/core_ext/object_spec.rb
+spec/help_formatters/terminal_spec.rb
+spec/runner_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/ui_spec.rb
+tasks/dev_setup.rake
+tasks/docs.rake
+tasks/gemspec.rake

data/README.md

@@ -0,0 +1,492 @@
+# Note: This is a fork
+
+The version number was reset to 1.0.0 at the time of forking and
+roughly maps to v4.4.4 of the upstream project.
+
+You can find the original repo at
+[commander-rb/commander](https://github.com/commander-rb/commander).
+
+This fork adds a number of patches and modifications to the upstream
+project that support the OpenFlightHPC tools.
+
+To ship a new release, do the following:
+
+ * Increment the version number in `version.rb`
+ * Run `rake build`
+ * Run `rake release`
+
+Documentation from the upstream project follows.
+
+---
+
+# Commander
+
+The complete solution for Ruby command-line executables.
+Commander bridges the gap between other terminal related libraries
+you know and love (OptionParser, HighLine), while providing many new
+features, and an elegant API.
+
+## Features
+
+* Easier than baking cookies
+* Parses options using OptionParser
+* Auto-populates struct with options ( no more `{ |v| options[:recursive] = v }` )
+* Auto-generates help documentation via pluggable help formatters
+* Optional default command when none is present
+* Global / Command level options
+* Packaged with two help formatters (Terminal, TerminalCompact)
+* Imports the highline gem for interacting with the terminal
+* Adds additional user interaction functionality
+* Highly customizable progress bar with intuitive, simple usage
+* Multi-word command name support such as `drupal module install MOD`, rather than `drupal module_install MOD`
+* Sexy paging for long bodies of text
+* Support for MacOS text-to-speech
+* Command aliasing (very powerful, as both switches and arguments can be used)
+* Growl notification support for MacOS
+* Use the `commander` executable to initialize a commander driven program
+
+## Installation
+
+    $ gem install commander
+
+## Quick Start
+
+To generate a quick template for a commander app, run:
+
+    $ commander init yourfile.rb
+
+To generate a quick modular style template for a commander app, run:
+
+    $ commander init --modular yourfile.rb
+
+## Example
+
+For more option examples view the `Commander::Command#option` method. Also
+an important feature to note is that action may be a class to instantiate,
+as well as an object, specifying a method to call, so view the RDoc for more information.
+
+### Classic style
+
+```ruby
+require 'rubygems'
+require 'commander/import'
+
+# :name is optional, otherwise uses the basename of this executable
+program :name, 'Foo Bar'
+program :version, '1.0.0'
+program :description, 'Stupid command that prints foo or bar.'
+
+command :foo do |c|
+  c.syntax = 'foobar foo'
+  c.description = 'Displays foo'
+  c.action do |args, options|
+    say 'foo'
+  end
+end
+
+command :bar do |c|
+  c.syntax = 'foobar bar [options]'
+  c.description = 'Display bar with optional prefix and suffix'
+  c.option '--prefix STRING', String, 'Adds a prefix to bar'
+  c.option '--suffix STRING', String, 'Adds a suffix to bar'
+  c.action do |args, options|
+    options.default :prefix => '(', :suffix => ')'
+    say "#{options.prefix}bar#{options.suffix}"
+  end
+end
+```
+
+Example output:
+
+```
+$ foobar bar
+# => (bar)
+
+$ foobar bar --suffix '}' --prefix '{'
+# => {bar}
+```
+
+### Modular style
+
+**NOTE:** Make sure to use `require 'commander'` rather than `require 'commander/import'`, otherwise Commander methods will still be imported into the global namespace.
+
+```ruby
+require 'rubygems'
+require 'commander'
+
+class MyApplication
+  include Commander::Methods
+
+  def run
+    program :name, 'Foo Bar'
+    program :version, '1.0.0'
+    program :description, 'Stupid command that prints foo or bar.'
+
+    command :foo do |c|
+      c.syntax = 'foobar foo'
+      c.description = 'Displays foo'
+      c.action do |args, options|
+        say 'foo'
+      end
+    end
+
+    run!
+  end
+end
+
+MyApplication.new.run if $0 == __FILE__
+```
+
+### Block style
+
+```ruby
+require 'rubygems'
+require 'commander'
+
+Commander.configure do
+  program :name, 'Foo Bar'
+  program :version, '1.0.0'
+  program :description, 'Stupid command that prints foo or bar.'
+
+  # see classic style example for options
+end
+```
+
+## HighLine
+
+As mentioned above, the highline gem is imported into the global scope. Here
+are some quick examples for how to utilize highline in your commands:
+
+```ruby
+# Ask for password masked with '*' character
+ask("Password:  ") { |q| q.echo = "*" }
+
+# Ask for password
+ask("Password:  ") { |q| q.echo = false }
+
+# Ask if the user agrees (yes or no)
+agree("Do something?")
+
+# Asks on a single line (note the space after ':')
+ask("Name: ")
+
+# Asks with new line after "Description:"
+ask("Description:")
+
+# Calls Date#parse to parse the date string passed
+ask("Birthday? ", Date)
+
+# Ensures Integer is within the range specified
+ask("Age? ", Integer) { |q| q.in = 0..105 }
+
+# Asks for a list of strings, converts to array
+ask("Fav colors?", Array)
+```
+
+## HighLine & Interaction Additions
+
+In addition to highline's fantastic choice of methods, commander adds the
+following methods to simplify common tasks:
+
+```ruby
+# Ask for password
+password
+
+# Ask for password with specific message and mask character
+password "Enter your password please:", '-'
+
+# Ask for CLASS, which may be any valid class responding to #parse. Date, Time, Array, etc
+names = ask_for_array 'Names: '
+bday = ask_for_date 'Birthday?: '
+
+# Simple progress bar (Commander::UI::ProgressBar)
+uris = %w[
+  http://vision-media.ca
+  http://google.com
+  http://yahoo.com
+]
+progress uris do |uri|
+  res = open uri
+  # Do something with response
+end
+
+# 'Log' action to stdout
+log "create", "path/to/file.rb"
+
+# Enable paging of output after this point
+enable_paging
+
+# Ask editor for input (EDITOR environment variable or whichever is available: TextMate, vim, vi, emacs, nano, pico)
+ask_editor
+
+# Ask editor, supplying initial text
+ask_editor 'previous data to update'
+
+# Ask editor, preferring a specific editor
+ask_editor 'previous data', 'vim'
+
+# Choose from an array of elements
+choice = choose("Favorite language?", :ruby, :perl, :js)
+
+# Alter IO for the duration of the block
+io new_input, new_output do
+  new_input_contents = $stdin.read
+  puts new_input_contents # outputs to new_output stream
+end
+# $stdin / $stdout reset back to original streams
+
+# Speech synthesis
+speak 'What is your favorite food? '
+food = ask 'favorite food?: '
+speak "Wow, I like #{food} too. We have so much in common."
+speak "I like #{food} as well!", "Victoria", 190
+
+# Execute arbitrary applescript
+applescript 'foo'
+
+# Converse with speech recognition server
+case converse 'What is the best food?', :cookies => 'Cookies', :unknown => 'Nothing'
+when :cookies
+  speak 'o.m.g. you are awesome!'
+else
+  case converse 'That is lame, shall I convince you cookies are the best?', :yes => 'Ok', :no => 'No', :maybe => 'Maybe another time'
+  when :yes
+    speak 'Well you see, cookies are just fantastic, they melt in your mouth.'
+  else
+    speak 'Ok then, bye.'
+  end
+end
+```
+
+## Growl Notifications
+
+Commander provides methods for displaying Growl notifications. To use these
+methods you need to install http://github.com/tj/growl which utilizes
+the [growlnotify](http://growl.info/extras.php#growlnotify) executable. Note that
+growl is auto-imported by Commander when available, no need to require.
+
+```ruby
+# Display a generic Growl notification
+notify 'Something happened'
+
+# Display an 'info' status notification
+notify_info 'You have #{emails.length} new email(s)'
+
+# Display an 'ok' status notification
+notify_ok 'Gems updated'
+
+# Display a 'warning' status notification
+notify_warning '1 gem failed installation'
+
+# Display an 'error' status notification
+notify_error "Gem #{name} failed"
+```
+
+## Commander Goodies
+
+### Option Defaults
+
+The options struct passed to `#action` provides a `#default` method, allowing you
+to set defaults in a clean manner for options which have not been set.
+
+```ruby
+command :foo do |c|
+  c.option '--interval SECONDS', Integer, 'Interval in seconds'
+  c.option '--timeout SECONDS', Integer, 'Timeout in seconds'
+  c.action do |args, options|
+    options.default \
+      :interval => 2,
+      :timeout  => 60
+  end
+end
+```
+
+### Command Aliasing
+
+Aliases can be created using the `#alias_command` method like below:
+
+```ruby
+command :'install gem' do |c|
+  c.action { puts 'foo' }
+end
+alias_command :'gem install', :'install gem'
+```
+
+Or more complicated aliases can be made, passing any arguments
+as if it was invoked via the command line:
+
+```ruby
+command :'install gem' do |c|
+  c.syntax = 'install gem <name> [options]'
+  c.option '--dest DIR', String, 'Destination directory'
+  c.action { |args, options| puts "installing #{args.first} to #{options.dest}" }
+end
+alias_command :update, :'install gem', 'rubygems', '--dest', 'some_path'
+```
+
+```
+$ foo update
+# => installing rubygems to some_path
+```
+
+### Command Defaults
+
+Although working with a command executable framework provides many
+benefits over a single command implementation, sometimes you still
+want the ability to create a terse syntax for your command. With that
+in mind we may use `#default_command` to help with this. Considering
+our previous `:'install gem'` example:
+
+```ruby
+default_command :update
+```
+
+```
+$ foo
+# => installing rubygems to some_path
+```
+
+Keeping in mind that commander searches for the longest possible match
+when considering a command, so if you were to pass arguments to foo
+like below, expecting them to be passed to `:update`, this would be incorrect,
+and would end up calling `:'install gem'`, so be careful that the users do
+not need to use command names within the arguments.
+
+```
+$ foo install gem
+# => installing  to
+```
+
+### Long descriptions
+
+If you need to have a long command description, keep your short description under `summary`, and consider multi-line strings for `description`:
+
+```ruby
+  program :summary, 'Stupid command that prints foo or bar.'
+  program :description, %q(
+#{c.summary}
+
+More information about that stupid command that prints foo or bar.
+
+And more
+  )
+```
+
+### Additional Global Help
+
+Arbitrary help can be added using the following `#program` symbol:
+
+```ruby
+program :help, 'Author', 'TJ Holowaychuk <tj@vision-media.ca>'
+```
+
+Which will output the rest of the help doc, along with:
+
+    AUTHOR:
+
+      TJ Holowaychuk <tj@vision-media.ca>
+
+### Global Options
+
+Although most switches will be at the command level, several are available by
+default at the global level, such as `--version`, and `--help`. Using
+`#global_option` you can add additional global options:
+
+```ruby
+global_option('-c', '--config FILE', 'Load config data for your commands to use') { |file| ... }
+```
+
+This method accepts the same syntax as `Commander::Command#option` so check it out for documentation.
+
+All global options regardless of providing a block are accessable at the command level. This
+means that instead of the following:
+
+```ruby
+global_option('--verbose') { $verbose = true }
+...
+c.action do |args, options|
+  say 'foo' if $verbose
+...
+```
+
+You may:
+
+```ruby
+global_option '--verbose'
+...
+c.action do |args, options|
+  say 'foo' if options.verbose
+...
+```
+
+### Formatters
+
+Two core formatters are currently available, the default `Terminal` formatter
+as well as `TerminalCompact`. To utilize a different formatter simply use
+`:help_formatter` like below:
+
+```ruby
+program :help_formatter, Commander::HelpFormatter::TerminalCompact
+```
+
+Or utilize the help formatter aliases:
+
+```ruby
+program :help_formatter, :compact
+```
+
+This abstraction could be utilized to generate HTML documentation for your executable.
+
+### Tracing
+
+By default the `-t` and `--trace` global options are provided to allow users to get a backtrace to aid debugging.
+
+You can disable these options:
+
+```ruby
+never_trace!
+```
+
+Or make it always on:
+
+```ruby
+always_trace!
+```
+
+Include the `--trace` global option but turn off the error message prompt:
+
+```ruby
+silent_trace!
+```
+
+## Tips
+
+When adding a global or command option, `OptionParser` no longer implicitly adds a small
+switch unless explicitly stated.
+
+## ASCII Tables
+
+For feature rich ASCII tables for your terminal app check out the terminal-table gem at http://github.com/tj/terminal-table
+
+    +----------+-------+----+--------+-----------------------+
+    | Terminal | Table | Is | Wicked | Awesome               |
+    +----------+-------+----+--------+-----------------------+
+    |          |       |    |        | get it while its hot! |
+    +----------+-------+----+--------+-----------------------+
+
+## Running Specifications
+
+    $ rake spec
+
+OR
+
+    $ spec --color spec
+
+## Contrib
+
+Feel free to fork and request a pull, or submit a ticket
+http://github.com/commander-rb/commander/issues
+
+## License
+
+This project is available under the MIT license. See LICENSE for details.