parseopt 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 344951947cddbdaf40959c6d42b7319f668d431d34d19f0c9e7c94f253aa957a
-  data.tar.gz: 6e3fc5489a126736cb1b03d2a1cee80e3478178e048948200d0132d5afd1a995
+  metadata.gz: 6b4e4cca586e2ff40e257ebcc12528f9227f983f12243370ee09169aa03686cb
+  data.tar.gz: d058140b9cc13b30de2edafce3d5ac57c806f4be6458a6ec4eef1f337b21676c
 SHA512:
-  metadata.gz: e2e4884941cb8c03e132941287ca014b2df78d2eaa47f52819e9966fbbaf2155deef19c16d386d2d6763dbfa5722e11e6234097ff7227fe99ec486605cb7e24f
-  data.tar.gz: e841a204bd15ec89c612bd9a99a9bacbc798c859a39919409a5a395b45b5423603247a0744b15b99197360c5734d7cd60536e5c58294f3267acbacfb9e07e83a
+  metadata.gz: ae40e7ba95a36edc00b5cd0a11031a10bc859c263fd781fc0e4a290da422ea9d610e15aefd173ee786cb6b43adf8609a65dbd7b9a9324dffa8fddaea8612661f
+  data.tar.gz: eeabc5a66a1ad9607a7fadf4681fed615895032fd74fa6610038a4dbe70b309744b1008ac9e46f6f5661625bf42e5ec40c2f04667f93ae32fc129521ed57940f

data/README.md

@@ -0,0 +1,39 @@
+A very simple option parser.
+
+```ruby
+require 'parseopt'
+
+opts = ParseOpt.new('my command')
+
+# only short
+opts.on('b') do |v|
+ $bool = v
+end
+
+# short and long
+opts.on('s', 'string') do |v|
+ $string = v
+end
+
+# short, long, and help
+opts.on('n', 'number', 'Number') do |v|
+ $number = v.to_i
+end
+
+opts.parse
+```
+
+Running with `--help` gives:
+
+```
+usage: my command
+    -b
+    -s, --string
+    -n, --number          Number
+```
+
+## Installation
+
+Simply install the gem:
+
+    gem install parseopt

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end

data/lib/parseopt.rb

@@ -1,6 +1,4 @@
 class ParseOpt
-  attr_writer :usage
-
   class Option
     attr_reader :short, :long, :help
 
@@ -15,17 +13,38 @@ class ParseOpt
       @block.call(v) || true
     end
   end
+  private_constant :Option
 
-  def initialize
+  # Creates a new instance.
+  #
+  # Yields itself if called with a block.
+  #
+  # @param [String] usage usage banner.
+  #
+  # @yieldparam [ParseOpt] self Option parser object
+  def initialize(usage = nil)
     @list = {}
+    @usage = usage
+    yield self if block_given?
   end
 
+  # Creates an option.
+  #
+  # The block is called with the value when the option is found.
+  #
+  # @example Simple boolean
+  #   opts.on('b') { $bool = true }
+  # @example Simple string with value
+  #   opts.on('s', 'string') { |value| $string = value }
+  #
+  # @yieldparam value value parsed
   def on(short, long = nil, help = nil, &block)
     opt = Option.new(short, long, help, &block)
     @list[short] = opt if short
     @list[long] = opt if long
   end
 
+  # Parses all the command line arguments
   def parse(args = ARGV)
     if args.member?('-h') or args.member?('--help')
       usage
@@ -50,6 +69,12 @@ class ParseOpt
     end
   end
 
+  # Sets the usage banner
+  def usage=(value)
+    @usage = value
+  end
+
+  # Generates the usage output (similar to `--help`)
   def usage
     puts 'usage: %s' % @usage
     @list.values.uniq.each do |opt|

data/test/test_optparse.rb

@@ -58,6 +58,14 @@ class ParseOptTest < Test::Unit::TestCase
     assert(!bool)
   end
 
+  def test_init
+    bool = false
+    ParseOpt.new('test script') do |opts|
+      opts.on('b', 'bool') { |v| bool = v }
+    end.parse(%w[-b])
+    assert(bool)
+  end
+
   def test_usage
     expected = <<~EOF
     usage: 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parseopt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Felipe Contreras
@@ -10,12 +10,14 @@ bindir: bin
 cert_chain: []
 date: 2021-05-26 00:00:00.000000000 Z
 dependencies: []
-description: A very simple option parser
+description:
 email: felipe.contreras@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
 - lib/parseopt.rb
 - test/test_optparse.rb
 homepage: https://rubygems.org/gems/parseopt
@@ -40,6 +42,6 @@ requirements: []
 rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
-summary: Option parser
+summary: A very simple option parser.
 test_files:
 - test/test_optparse.rb