slop 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63095938a88e1994b174a29d9c1bcca25fa84562
-  data.tar.gz: 4df7ece6ed84e45245081a7b6617372cd386385e
+  metadata.gz: 66456d3c9b1836976bf1db77744397d30ed6eddd
+  data.tar.gz: 615f7a217ab9668b2eab4234230f67b7bad76ffc
 SHA512:
-  metadata.gz: abd18392e43a5413199e6b7ab482afdb4c5782c5eeb65c298d916279df060df614b7875e3ad836a803064d5aa0c04c093eb682753397ddb6b65bfa26550be9d6
-  data.tar.gz: 0f03c20ff5e6d240d57586a133cc531a6a68ac2fcf4f4aea4ac931726cdf7420f92ea736fadec0f0c715e91c395ccc1ca73f3e683da42b89f5544f5afe3d02eb
+  metadata.gz: 5976dae0692f77d98ef26995737385da682592ddd4631209543f1604130c607f6f584a787a036595d668914245b17cc0141050e8fe36843f288bda93f5bcd74a
+  data.tar.gz: a5ed147ed93952f3d3d3e38abd8ece30bb6131e43d085281c91c0c12bd4490473fc0f3169e6f82cc6b8a1aa494d1d77188eeba63ec622794614f586bcf1fccbe

data/.travis.yml

@@ -7,7 +7,7 @@ rvm:
   - 2.2
   - 2.3.4
   - 2.4.1
-  - jruby-9.1.8.0
+  - jruby-9.1.13.0
   - jruby-head
   - ruby-head
 notifications:

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+v4.6.0 (2017-10-06)
+-------------------
+
+Features
+  * Add support for required options. #218 (William Woodruff)
+
 v4.5.0 (2017-05-22)
 -------------------
 

data/README.md

@@ -20,6 +20,7 @@ Usage
 opts = Slop.parse do |o|
   o.string '-h', '--host', 'a hostname'
   o.integer '--port', 'custom port', default: 80
+  o.string '-l', '--login', required: true
   o.bool '-v', '--verbose', 'enable verbose mode'
   o.bool '-q', '--quiet', 'suppress output (quiet mode)'
   o.bool '-c', '--check-ssl-certificate', 'check SSL certificate for host'
@@ -39,6 +40,12 @@ opts.check_ssl_certificate? #=> true
 opts.to_hash  #=> { host: "192.168.0.1", port: 80, verbose: true, quiet: false, check_ssl_certificate: true }
 ```
 
+Note that the block we've added to the `--version` flag will be executed
+during parse time. Therefore these blocks should be reserved
+for immediately reacting to the presence of a flag. If you want to
+access other options or mutate values, check out the "Custom option types"
+section below and implement the `#finish` method.
+
 Option types
 ------------
 
@@ -191,6 +198,7 @@ Slop will raise errors for the following:
 
 * An option used without an argument when it expects one: `Slop::MissingArgument`
 * An option used that Slop doesn't know about: `Slop::UnknownOption`
+* An option marked as `required` when not provided: `Slop::MissingRequiredOption`
 
 These errors inherit from `Slop::Error`, so you can rescue them all.
 Alternatively you can suppress these errors with the `suppress_errors` config

data/lib/slop.rb

@@ -6,7 +6,7 @@ require 'slop/types'
 require 'slop/error'
 
 module Slop
-  VERSION = '4.5.0'
+  VERSION = '4.6.0'
 
   # Parse an array of options (defaults to ARGV). Accepts an
   # optional hash of configuration options and block.

data/lib/slop/error.rb

@@ -32,4 +32,9 @@ module Slop
       @flag = flag
     end
   end
+
+  # Raised when a required option is *not* parsed.
+  # Suppress with the `suppress_errors` config option.
+  class MissingRequiredOption < Error
+  end
 end

data/lib/slop/option.rb

@@ -4,6 +4,7 @@ module Slop
       help: true,
       tail: false,
       underscore_flags: true,
+      required: false,
     }
 
     # An Array of flags this option matches.
@@ -101,6 +102,11 @@ module Slop
       config[:suppress_errors]
     end
 
+    # Returns true if an exception should be raised when this option isn't supplied.
+    def required?
+      config[:required]
+    end
+
     # Returns all flags joined by a comma. Used by the help string.
     def flag
       flags.join(", ")

data/lib/slop/parser.rb

@@ -80,6 +80,15 @@ module Slop
 
       @arguments += ignored_args
 
+      if !suppress_errors?
+        unused_options.each do |o|
+          if o.config[:required]
+            pretty_flags = o.flags.map { |f| "`#{f}'" }.join(", ")
+            raise MissingRequiredOption, "missing required option #{pretty_flags}"
+          end
+        end
+      end
+
       Result.new(self).tap do |result|
         used_options.each { |o| o.finish(result) }
       end
@@ -148,6 +157,7 @@ module Slop
     def partition(strings)
       if strings.include?("--")
         partition_idx = strings.index("--")
+        return [[], strings[1..-1]] if partition_idx.zero?
         [strings[0..partition_idx-1], strings[partition_idx+1..-1]]
       else
         [strings, []]

data/test/error_test.rb

@@ -21,6 +21,12 @@ describe Slop::MissingArgument do
     opts.string "-n", "--name"
     opts.parse %w(--name)
   end
+
+  it "does not raise if '--' appears as the first argument" do
+    opts = Slop::Options.new
+    opts.string "-n", "--name"
+    opts.parse %w(-- --name)
+  end
 end
 
 describe Slop::UnknownOption do
@@ -43,3 +49,17 @@ describe Slop::UnknownOption do
     opts.parse %w(--foo)
   end
 end
+
+describe Slop::MissingRequiredOption do
+  it "raises when a required option is missing" do
+    opts = Slop::Options.new
+    opts.string "-n", "--name", required: true
+    assert_raises(Slop::MissingRequiredOption) { opts.parse [] }
+  end
+
+  it "does not raise when errors are suppressed" do
+    opts = Slop::Options.new(suppress_errors: true)
+    opts.string "-n", "--name", required: true
+    opts.parse []
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Simple Lightweight Option Parsing