slop 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fa9956c84ddd760c06fd3ace9d4e0b76a7fea5b
-  data.tar.gz: 38bc53ca3626ec471672ec15022392e6e32cb26d
+  metadata.gz: 95327fe15a3e8091259a7a045f9ede744256ae52
+  data.tar.gz: 6804548aa33795082ef1068a7c3021e3305258c5
 SHA512:
-  metadata.gz: b9acff23d30d56234cb7744f1eefb16328987d198a340ead9e7e793dab38e33e55b33c3250a302eea0b138abe9a2da848e044e963c23abf42387324fdbc5597e
-  data.tar.gz: d9c073d8f01c14d4c8f40cd0211eeb2f88863e82a1d8c97ab66c3ccf7f75a55cc519032f69d3589c2a6ef33951c87d304ad7e7b62b6da37cc4944a51731220ad
+  metadata.gz: c625631bde9b8289e1f50337de14139a762f12b873b2f94b7a1d406a3605202269dbef1ee19c8a3978379415afb902528ccc438f76fe3d563deb0a0f180f3413
+  data.tar.gz: b8de8a12ee0aca903b74950009d10c4f66b437430c9983eb2ba61ef2ac988ce686cff56428f1caf0f3c2098d076ad9a3d4da5d901ce9768a2df5aae7b8870af7

data/.travis.yml

@@ -1,11 +1,8 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.1
   - ruby-head
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
 notifications:
   email:
     on_success: change

data/CHANGES.md

@@ -1,3 +1,9 @@
+3.6.0 (2014-06-18)
+------------------
+
+* Add example of rest arguments usage in the readme file #139
+* Default values on options are printed in the help message #134
+
 3.5.0 (2014-03-12)
 ------------------
 

data/README.md

@@ -41,20 +41,16 @@ Configuration Options
 
 All of these options can be sent to `Slop.new` or `Slop.parse` in Hash form.
 
-* `strict` - Enable strict mode. When processing unknown options, Slop will
-  raise an `InvalidOptionError`. **default:** *false*.
-* `help` - Automatically add the `--help` option. **default:** *false*.
-* `banner` - Set the help banner text. **default:** *nil*.
-* `ignore_case` - When enabled, `-A` will look for the `-a` option if `-A`
-  does not exist. **default:** *false*.
-* `autocreate` - Autocreate options on the fly. **default:** *false*.
-* `arguments` - Force all options to expect arguments. **default:** *false*.
-* `optional_arguments` - Force all options to accept optional arguments.
-  **default:** *false*.
-* `multiple_switches` - When disabled, Slop will parse `-abc` as the option `a`
-   with the argument `bc` rather than 3 separate options. **default:** *true*.
-* `longest_flag` - The longest string flag, used to aid configuring help
-   text. **default:** *0*.
+| Option | Description | Default/Example |
+| ------ | ----------- | --------------- |
+| strict | Enable strict mode. Slop will raise an `InvalidOptionError` for unkown options. | `false` |
+| help   | Automatically add the `--help` option. | `false` |
+| banner | Set the help banner text. | `nil` |
+| ignore_case | When enabled, `-A` will look for the `-a` option if `-A` does not exist. | `false` |
+| autocreate | Autocreate options on the fly. | `false` |
+| arguments | Force all options to expect arguments. | `false` |
+| optional_arguments | Force all options to accept optional arguments. | `false` |
+| multiple_switches | When disabled, Slop will parse `-abc` as the option `a` with the argument `bc` rather than 3 separate options. | `true` |
 
 Lists
 -----
@@ -139,6 +135,30 @@ opts.to_hash(true) # Pass true to tell Slop to merge sub-command option values.
 # => { :v => nil, :add => { :v => true, :name => "Lee" } }
 ```
 
+Remaining arguments
+-------------------
+
+The *parse!*  method will remove any options and option arguments from the original Array:
+
+```ruby
+# restarguments.rb
+opts = Slop.parse! do
+  on :foo
+end
+```
+
+Example:
+
+```
+ruby restarguments.rb --foo bar
+```
+
+```
+opts.to_hash = { :foo => true }
+
+ARGV #=> ["bar"]
+```
+
 Woah woah, why you hating on OptionParser?
 ------------------------------------------
 

data/lib/slop.rb

@@ -4,7 +4,7 @@ require 'slop/commands'
 class Slop
   include Enumerable
 
-  VERSION = '3.5.0'
+  VERSION = '3.6.0'
 
   # The main Error class, all Exception classes inherit from this class.
   class Error < StandardError; end

data/lib/slop/option.rb

@@ -138,7 +138,12 @@ class Slop
         out << (' ' * (@slop.config[:longest_flag] + 8))
       end
 
-      "#{out}#{description}"
+      if config[:default]
+        default = config[:default]
+        "#{out}#{description} (default: #{default})"
+      else
+        "#{out}#{description}"
+      end
     end
     alias help to_s
 

data/slop.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'slop'
-  s.version     = '3.5.0'
+  s.version     = '3.6.0'
   s.summary     = 'Simple Lightweight Option Parsing'
   s.description = 'A simple DSL for gathering options and parsing the command line'
   s.author      = 'Lee Jarvis'

data/test/option_test.rb

@@ -130,6 +130,13 @@ class OptionTest < TestCase
     assert_equal "    -V,             Display the version", slop.fetch_option(:V).help
   end
 
+  test "printing options that have defaults" do
+    opts = Slop.new
+    opts.on :n, :name=, 'Your name', :default => 'Lee'
+
+    assert_equal "    -n, --name      Your name (default: Lee)", opts.fetch_option(:name).to_s
+  end
+
   test "overwriting the help text" do
     slop = Slop.new
     slop.on :foo, :help => '    -f, --foo  SOMETHING FOOEY'

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 5.0.0
 description: A simple DSL for gathering options and parsing the command line
@@ -44,8 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -69,17 +69,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Simple Lightweight Option Parsing