optparse-plus 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a6f4cc35a11290f599df1ac89b367308b7de55d367f99d882287093ecdeeefc
+  data.tar.gz: 96d1296f77e31242ee8f3bde8cc2b952cf57cb778fc920ba698963942394630e
+SHA512:
+  metadata.gz: 4583ffcc8828e30bd8c633946a41ead8511b4bef0b74451328c3b4dbedcc4fdd6a380ba5d5419acf6d1a0a6ea750eb68f113c876d9035d63474004c691847839
+  data.tar.gz: 4cb6b962216b09ddb41f77817b2f3b9e5c086ad6b49378252ec23e1697bbe48f04b87d0213b087931dc3b2a09b1cc929a7d7f289dc7c8ef3a1a5163946e8f27d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+html
+.*.sw?
+tmp
+results.html
+coverage
+*.rbc
+.DS_Store
+T_KICK_THE_BASH_HABIT_WITH_RUBY_AND_METHADONE.itmsp
+bin/cukedoc
+methadone.wiki
+tut
+.idea
+Session.vim

data/.ruby-gemset

@@ -0,0 +1 @@
+methadone

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,7 @@
+notifications:
+  email:
+    on_success: always
+script: 'bundle exec rake'
+rvm:
+  - 2.4.3
+  - 2.5.1

data/CHANGES.md

@@ -0,0 +1,66 @@
+# Changelog
+
+## v.1.3.0 - May 11, 2013
+
+* Enhance `version` to allow for a compact form, e.g. ``version MyAPP::VERSION, :compact => true`` so that doing `--version` only shows the
+  app name and version, not the entire help screen.  See [64].
+* Allow using DSL methods before the call to `main`, even though you really shouldn't.  See [65]
+
+[64]: https://github.com/davetron5000/methadone/issues/64
+[65]: https://github.com/davetron5000/methadone/issues/65
+
+## v.1.2.6 - Mar 10, 2013
+
+* Need `rspec` as a real dev dependency since it's not part of Aruba any longer.  See [61].
+
+[61]: https://github.com/davetron5000/methadone/issues/61
+
+## v.1.2.5 - Feb 24, 2013
+
+* Compatibility Bundler 1.3 - Bundler 1.3 bootstraps files differently than 1.2, and methadone's generated binfile ends up requiring a non-existent file.  This verison works with both 1.2 and 1.3 of bundler by parsing its output to figure out which file to include.
+
+## v.1.2.4 - Dec 26, 2012
+
+* Fix for my fix on apps with dashes in their name (see [59], thanks to [@terryfinn]
+
+[@terryfinn]: https://github.com/terryfinn
+[59]: https://github.com/davetron5000/methadone/pull/59
+
+## v.1.2.3 - Dec 8, 2012
+
+* Can create an app with a dash in its name (See [55])
+* Help switches, `-h`, and `--help` are documented in help output (See [51])
+* Improve cucumber step requiring docs and fix bug where said docs had to start with a three-letter words (See [37])
+
+[37]: http://github.com/davetron5000/methadone/issues/37
+[51]: http://github.com/davetron5000/methadone/issues/51
+[55]: http://github.com/davetron5000/methadone/issues/55
+
+## v1.2.2 - Oct 21, 2012
+
+* Generated Rakefile has better formatted code (See [57])
+* Error output preface now says "stderr is" instead of "error output", which is less confusing (See [53])
+* Less scary stdout/stderr prefixing from SH, courtesy @yoni
+
+[57]: http://github.com/davetron5000/methadone/issues/57
+[53]: http://github.com/davetron5000/methadone/issues/53
+
+## v1.2.1 - Jun 10, 2012, 3:41 PM
+
+* Slightly loosen what passes for a one-line description of the app, courtesy @jredville
+
+## v1.2.0 - May 21, 2012, 11:05 PM
+
+* Better handling of `open4` dependency when you don't install it and you don't use it.
+* Quoted spaced strings in config files and env var weren't working.  Now they are.
+* Use the current version in generated gemspec
+* Non-string arguments (such as Regexps for validation and classes for type conversion) were not working.  Now they are.
+* `sh` can now be used more safely by passing an array to avoid tokenization (thanks @gchpaco!)
+
+## v1.1.0 - April 21, 2012, 6:00 PM
+
+* Can bootstrap apps using RSpec instead of Test::Unit (thanks @msgehard)
+
+## v1.0.0 - April 1, 2012, 10:31
+
+* Initial official release

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://www.rubygems.org'
+
+gem 'open4', :platform => :ruby_18
+gem 'test-unit'
+gemspec

data/LICENSE.txt

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

@@ -0,0 +1,173 @@
+= optparse-plus - Wrapper around OptionParse to Make CLIs a bit Easier
+
+Author::  Dave Copeland (mailto:davetron5000 at g mail dot com)
+Copyright:: Copyright (c) 2011 by Dave Copeland
+License:: Distributes under the Apache License, see LICENSE.txt in the source distro
+
+A smattering of tools to make your command-line apps easily awesome; Ideally makes it almost as easy as bash to get a command line app up and running.
+
+The goal of this project is to make it as easy as possible to write awesome and powerful command-line applications.
+
+Toward that end, this gem provides:
+
+* A command-line app to bootstrap a new command-line app.
+* A lightweight DSL to create your command-line interface, that loses none of <tt>OptionParser</tt>'s power.
+* A simplified means of running external commands that has better error handling and diagnostics.
+* Simplified zero-config logging that is a better-than-<tt>puts</tt> <tt>puts</tt>.
+* Support for integration-testing your CLI using Test::Unit
+
+== Platforms
+
+This library only supports the latest versions of Ruby. JRuby support has been too difficult to keep up with, though the library should work for JRuby.
+
+See the {Travis config file}[./.travis.yml] for specifics.
+
+== Bootstrapping a new CLI App
+
+The +optparse_plus+ command-line app will bootstrap a new command-line app, setting up a proper gem structure, unit tests, and integration tests.
+
+It assumes you are using a standard Ruby development environment, which includes:
+
+* Some sort of Ruby version manager to allow you to manage Ruby as yourself and not as root/system
+* Bundler
+* Git
+
+_(Note that apps *powered* by this gem have no particular runtime dependencies as classes this gem provides depend only on the standard library)_
+
+
+    $ optparse_plus --help
+    Usage: optparse_plus [options] app_name
+
+    Kick the bash habit by bootstrapping your Ruby command-line apps
+
+    v2.0.0
+
+    Options:
+        -h, --help                       Show command line help
+            --force                      Overwrite files if they exist
+            --[no-]readme                [Do not ]produce a README file
+            --rspec                      Generate RSpec unit tests instead of Test::Unit
+        -l, --license LICENSE            Specify the license for your project
+                                         (mit|apache|gplv2|gplv3|custom|NONE)
+            --log-level LEVEL            Set the logging level
+                                         (debug|info|warn|error|fatal)
+                                         (Default: info)
+            --version                    Show help/version info
+
+    Arguments:
+
+        app_name
+            Name of your app, which is used for the gem name and executable name
+
+
+
+
+
+    Usage: optparse_plus [options] app_name
+            --force                      Overwrite files if they exist
+    $ optparse_plus myapp -l mit
+    $ cd myapp
+    $ bundle install
+    ...
+    $ bundle exec rake
+    Started
+    .
+    Finished in 0.000499 seconds.
+    -----------------------------------------------------------------------------------------
+    1 tests, 1 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications
+    100% passed
+    -----------------------------------------------------------------------------------------
+    2004.01 tests/s, 2004.01 assertions/s
+    Started
+    .
+    Finished in 0.298281 seconds.
+    -----------------------------------------------------------------------------------------
+    1 tests, 8 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications
+    100% passed
+    -----------------------------------------------------------------------------------------
+    3.35 tests/s, 26.82 assertions/s
+
+    $ cat test/integration/test_cli.rb
+    require "optparse_plus/test/base_integration_test"
+
+    class TestSomething < OptparsePlus::BaseIntegrationTest
+      def test_truth
+        stdout,stderr,results = run_app("myapp","--help")
+        assert_banner(stdout, "myapp", takes_options: true, takes_arguments: false)
+        assert_option(stdout,"-h", "--help")
+        assert_option(stdout,"--version")
+        assert_oneline_summary(stdout)
+      end
+    end
+
+
+Basically, this sets you up with all the boilerplate that you *should* be using to write a command-line app.  Specifically, you get:
+
+* Gemified project (based on <tt>bundle gem</tt>)
+* An executable using OptparsePlus::Main to outline your new app
+* <tt>Test::Unit</tt> test task set up and an empty unit test.
+* <tt>Test::Unit</tt> integration tests with some of optparse-plus's assertions to let you drive your CLI's development
+* The outline of a README
+* An optional license included
+
+== DSL for your <tt>bin</tt> file
+
+A canonical <tt>OptionParser</tt>-driven app has a few problems with it structurally that optparse-plus can solve:
+
+* Backwards organization - main logic is at the bottom of the file, not the top
+* Verbose to use +opts.on+ just to set a value in a +Hash+
+* No exception handling - you have to explicitly call <tt>exit</tt> and/or let exceptions' stack traces leak through.
+
+optparse-plus provides OptparsePlus::Main to help make a clean and easy-to-maintain <tt>bin</tt> file.  See the  {rdoc}[http://davetron5000.github.com/optparse-plus/rdoc/classes/OptparsePlus/Main.html] for an example, and see {my blog}[http://www.naildrivin5.com/blog/2011/12/19/methadone-the-awesome-cli-library.html] on the derivation of this module.
+
+== Wrapper for running external commands with good logging
+
+While backtick and <tt>%x[]</tt> are nice for compact, bash-like scripting, they have some failings:
+
+* You have to check the return value via <tt>$?</tt>
+* You have no access to the standard error
+* You really want to log: the command, the output, and the error so that for cron-like tasks, you can sort out what happened
+
+Enter OptparsePlus::SH 
+
+    sh "cp foo.txt /tmp"
+    # => logs command at DEBUG level
+    #    if the command exited zero:
+    #        logs the standard output at DEBUG
+    #        logs the standard error at WARN
+    #    if the command exited nonzero:
+    #        logs the standard output at INFO
+    #        logs the standard error at WARN
+    #        returns the exit code for your examination
+    #
+    #        there's a LOT MORE
+
+See the {rdoc}[http://davetron5000.github.com/optparse-plus/rdoc/classes/OptparsePlus/SH.html] for more detailed examples and usage.
+
+This isn't a replacement for Open3 or ChildProcess, but a way to easily "do the right thing" for most cases.
+
+== Zero-Config Logging
+
+Chances are, your code is littered with <tt>STDERR.puts</tt> on a good day, and nothing on a bad day.  You probably also have a bunch of debug <tt>puts</tt> calls that you have commented out.  Logging is extremely helpful in understanding how your app is behaving (or how it behaved in the past).  Logging can be a pain to set up, and can also make it hard to give the user at the command-prompt a good experience.
+
+OptparsePlus::CLILogger is designed to handle this.  It's a proper subclass of Ruby's built-in <tt>Logger</tt> with a few enhancements:
+
+* Messages don't get formatting if they are destined for a TTY (e.g. the user sitting at her terminal)
+* Errors and warnings go to the standard error.
+* Debug and info messages go to the standard output.
+* When these are redirected to a file, the log messages are properly date/time stamped as you'd expect
+* You can mix-in OptparsePlus::CLILogging to get access to a global logger instances without resorting to an explicit global variable
+
+See {CLILogger's rdoc}[http://davetron5000.github.com/optparse-plus/rdoc/classes/OptparsePlus/CLILogger.html] and then {CLILogging's}[http://davetron5000.github.com/optparse-plus/rdoc/classes/OptparsePlus/CLILogging.html] for more.
+
+Currently, there are classes that assist in directing output logger-style to the right place; basically ensuring that errors go to +STDERR+ and everything else goes to +STDOUT+.  All of this is, of course, configurable
+
+== Integration Tests
+
+optparse-plus provides some basic features for executing your CLI and asserting things about it.  OptparsePlus::Test::IntegrationTestAssertions documents these.
+
+== Contributing
+
+* Feel free to file an issue, even if you don't have time to submit a patch
+* Please try to include a test for any patch you submit.  If you don't include a test, I'll have to write one, and it'll take longer to get your code in.
+* This is not intended to support “command-suite” style CLIs.  See {GLI}[http://naildrivin5.com/gli] if that's what you want.