rake-toolkit_program 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46046246fbbd6d17f58cfe8e32830ac6e5b7b6eacff79df2726c85a209ac0df4
+  data.tar.gz: 71bd8db67bee322ce2f48ec80617be151dfb117fcf814ba895c8bb4fb09c288a
+SHA512:
+  metadata.gz: 53dfb15e9db054b6923c2c7c87799a3e1aced3d7f427617aa5bd3e1a9c2f0fee2e33427d4b0119d7df632590047b4b9cd74e102e9a89d0397ebcf03f79f1934c
+  data.tar.gz: e58b2847c689f5d293b3de482447fcfd247b72472e5d220f35c9a1f158361d4b71cd97f6df1dcd6718be11e41ced1d6a40529b0a0a29c385a589c004da3506b0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+Contributing to rake-toolkit_program
+=================
+
+:+1::tada: First and foremost, thanks for taking the time and effort to contribute! :tada::+1:
+
+The following is a set of guidelines for contributing to this project.  These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Code Review
+
+All pull requests will be reviewed by one or more of the Senior Engineers at PayTrace. As of 2019-December-01, those users are:
+
+* dax-wilson
+* ehutchinson
+* quachj
+* rtweeks
+
+You don't need to pick a reviewer; if you submit a pull request, we'll see it and figure out who should review it.
+
+If your pull request involves large or sensitive changes, it will probably need to be reviewed by our Engineering leadership or in some rare cases our legal counsel.
+Obviously for such larger changes, there may be a delay in reviewing/merging if the appropriate PayTracers are unavailable, or if we need to complete merge some other related work first as a prerequisite. If you have any questions along the way, feel free to ask on the thread, and we'll be happy to help out.
+
+## Help us help you!
+
+We highly recommend [allowing edits from maintainers](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) (ie, us) to your branch. Since `rake-toolkit_program` is a living project, there's a chance other pull requests will have been merged in between when you submit a pull request and when we approve it. Allowing us to edit your branch means that we can rebase and fix any merge conflicts for you.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rake-toolkit_program.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

data/README.md

@@ -0,0 +1,211 @@
+# Rake::ToolkitProgram
+
+Create toolkit programs easily with `Rake` and `OptionParser` syntax.  Bash completions and usage help are baked in.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake-toolkit_program'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake-toolkit_program
+
+## Quickstart
+
+* Shebang it up (in a file named `awesome_tool.rb`)
+  ```ruby
+  #!/usr/bin/env ruby
+  ```
+* Require the library
+  ```ruby
+  require 'rake/toolkit_program'
+  ```
+* Make your life easier
+  ```ruby
+  Program = Rake::ToolkitProgram
+  ```
+* Define your command tasks
+  ```ruby
+  Program.command_tasks do
+    desc "Build it"
+    task 'build' do
+      # Ruby code here
+    end
+    
+    desc "Test it"
+    task 'test' => ['build'] do
+      # Rake syntax ↑↑↑↑↑↑↑ for dependencies
+      # Ruby code here
+    end
+  end
+  ```
+  You can use `Program.args` in your tasks to access the other arguments on the command line.  For argument parsing integrated into the help provided by the program, see the use of `Rake::Task(Rake::ToolkitProgram::TaskExt)#parse_args` below.
+* Wire the mainline
+  ```ruby
+  Program.run(on_error: :exit_program!) if $0 == __FILE__
+  ```
+* In the shell, prepare to run the program (UNIX/Linux systems only)
+  ```console
+  $ chmod +x awesome_tool.rb
+  $ ./awesome_tool.rb --install-completions
+  Completions installed in /home/rtweeks/.bashrc
+  Source /home/rtweeks/.bash-complete/awesome_tool.rb-completions for immediate availability.
+  $ source /home/rtweeks/.bash-complete/awesome_tool.rb-completions
+  ```
+* Ask for help
+  ```console
+  $ ./awesome_tool.rb help
+  
+  *** ./awesome_tool.rb Toolkit Program ***
+  
+      .
+      .
+      .
+  ```
+
+## Usage
+
+Let's look at a short sample toolkit program -- put this in `awesome.rb`:
+
+```ruby
+#!/usr/bin/env ruby
+require 'rake/toolkit_program'
+require 'ostruct'
+
+ToolkitProgram = Rake::ToolkitProgram
+ToolkitProgram.title = "My Awesome Toolkit of Awesome"
+
+ToolkitProgram.command_tasks do
+  desc <<-END_DESC.dedent
+    Fooing myself
+  
+    I'm not sure what I'm doing, but I'm definitely fooing!
+  END_DESC
+  task :foo do
+    a = ToolkitProgram.args
+    puts "I'm fooed#{' on a ' if a.implement}#{a.implement}"
+  end.parse_args(into: OpenStruct.new) do |parser, args|
+    parser.no_positional_args!
+    parser.on('-i', '--implement IMPLEMENT', 'An implement on which to be fooed') do |val|
+      args.implement = val
+    end
+  end
+end
+
+if __FILE__ == $0
+  ToolkitProgram.run(on_error: :exit_program!)
+end
+```
+
+Make sure to `chmod +x awesome.rb`!
+
+What does this support?
+
+    $ ./awesome.rb foo
+    I'm fooed
+    $ ./awesome.rb --help
+    
+    *** My Awesome Toolkit of Awesome ***
+
+    Usage: ./awesome.rb COMMAND [OPTION ...]
+
+    Avaliable options vary depending on the command given. For details
+    of a particular command, use:
+
+        ./awesome.rb help COMMAND
+
+    Commands:
+         foo   Fooing myself
+        help   Show a list of commands or details of one command
+
+    Use help COMMAND to get more help on a specific command.
+    
+    $ ./awesome.rb help foo
+    
+    *** My Awesome Toolkit of Awesome ***
+
+    Usage: ./awesome.rb foo [OPTION ...]
+
+    Fooing myself
+
+    I'm not sure what I'm doing, but I'm definitely fooing!
+
+    Options:
+        -i, --implement IMPLEMENT        An implement on which to be fooed
+    
+    $ ./awesome.rb --install-completions
+    Completions installed in /home/rtweeks/.bashrc
+    Source /home/rtweeks/.bash-complete/awesome.rb-completions for immediate availability.
+    $ source /home/rtweeks/.bash-complete/awesome.rb-completions
+    $ ./awesome.rb <tab><tab>
+    foo   help
+    $ ./awesome.rb f<tab>
+    ↳ ./awesome.rb foo
+    $ ./awesome.rb foo <tab>
+    ↳ ./awesome.rb foo --
+    $ ./awesome.rb foo --<tab><tab>
+    --help       --implement
+    $ ./awesome.rb foo --i<tab>
+    ↳ ./awesome.rb foo --implement
+    $ ./awesome.rb foo --implement <tab><tab>
+    --help      awesome.rb
+    $ ./awesome.rb foo --implement spoon
+    I'm fooed on a spoon
+
+### Defining Toolkit Commands
+
+Just define tasks in the block of `Rake::ToolkitProgram.command_tasks` with `task` (i.e. `Rake::DSL#task`).  If `desc` is used to provide a description, the task will become visible in help and completions.
+
+When a command task is initially defined, positional arguments to the command are available as an `Array` through `Rake::ToolkitProgram.args`.
+
+### Option Parsing
+
+This gem extends `Rake::Task` with a `#parse_args` method that creates a `Rake::ToolkitProgram::CommandOptionParser` (derived from the standard library's `OptionParser`) and an argument accumulator and `yield`s them to its block.
+* The arguments accumulated through the `Rake::ToolkitProgram::CommandOptionParser` are available to the task in `Rake::ToolkitProgram.args`, replacing the normal `Array` of positional arguments.
+* Use the `into:` keyword of `#parse_args` to provide a custom argument accumulator object for the associated command.  The default argument accumulator constructor can be defined with `Rake::ToolkitProgram.default_parsed_args`.  Without either of these, the default accumulator is a `Hash`.
+* Options defined using `OptionParser#on` (or any of the variants) will print in the help for the associated command.
+
+### Positional Arguments
+
+Accessing positional arguments given after the command name depends on whether or not `Rake::Task(Rake::ToolkitProgram::TaskExt)#parse_args` has been called on the command task.  If this method is not called, positional arguments will be an `Array` accessible through `Rake::ToolkitProgram.args`.
+
+When `Rake::Task(Rake::ToolkitProgram::TaskExt)#parse_args` is used:
+* `Rake::ToolkitProgram::CommandOptionParser#capture_positionals` can be used to define how positional arguments are accumulated.
+  * If the argument accumulator is a `Hash`, the default (without calling this method) is to assign the `Array` of positional arguments to the `nil` key of the `Hash`.
+  * For other types of accumulators, the positional arguments are only accessible if `Rake::ToolkitProgram::CommandOptionParser#capture_positionals` is used to define how they are captured.
+  * If a block is given to this method, the block of the method will receive the `Array` of positional arguments.  If it is passed an argument value, that value is used as the key under which to store the positional arguments if the argument accumulator is a `Hash`.
+* `Rake::ToolkitProgram::CommandOptionParser#expect_positional_cardinality` can be used to set a rule for the count of positional arguments.  This will affect the _usage_ presented in the help for the associated command.
+* `Rake::ToolkitProgram::CommandOptionParser#map_positional_args` may be used to transform (or otherwise process) positional arguments one at a time and in the context of options and/or arguments appearing earlier on the command line.
+
+### Convenience Methods
+
+* `Rake::Task(Rake::ToolkitProgram::TaskExt)#prohibit_args` is a quick way, for commands that accept no options or positional arguments, to declare this so the help and bash completions reflect this.  It is equivalent to using `#parse_args` and telling the parser `parser.expect_positional_cardinality(0)`.
+
+* `Rake::ToolkitProgram::CommandOptionParser#no_positional_args!` is a shortcut for calling `#expect_positional_cardinality(0)` on the same object.
+
+* `Rake::Task(Rake::ToolkitProgram::TaskExt)#invalid_args!` and `Rake::ToolkitProgram::CommandOptionParser#invalid_args!` are convenient ways to raise `Rake::ToolkitProgram::InvalidCommandLine` with a message.
+
+## OptionParser in Rubies Before and After v2.4
+
+The `OptionParser` class was extended in Ruby 2.4 to simplify capturing options into a `Hash` or other container implementing `#[]=` in a similar way.  This gem supports that, but it means that behavior varies somewhat between the pre-2.4 era and the 2.4+ era.  To have consistent behavior across that version change, the recommendation is to use a `Struct`, `OpenStruct`, or custom class to hold program options rather than `Hash`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To run the tests, use `rake`, `rake test`, or `rspec spec`.  Tests can only be run on systems that support `Kernel#fork`, as this is used to present a pristine and isolated environment for setting up the tool.  If run using Ruby 2.3 or earlier, some tests will be pending because functionality expects Ruby 2.4's `OptionParser`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PayTrace/rake-toolkit_program.  For further details on contributing, see [CONTRIBUTING.md](./CONTRIBUTING.md).
+