optsparser_generator 2.4 → 2.5

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7b9817528059edf3373f4697b764105904e33cdd
4
- data.tar.gz: f8b5a26314a7a8e3d0b45b27838e750edee8daf0
3
+ metadata.gz: fb4b09c837450ff62848f1c610ab5723877ed7ba
4
+ data.tar.gz: a9dc43fcb9bfa833de8976245c6e22d84c83a1c9
5
5
  SHA512:
6
- metadata.gz: 3aa92fac691a8acf4920cda7046891e3771edeba30b4bdb9bf50f7692cc73395bfea868e046bc2a1f6bf84edf7819b43219c025bcd6ff09755db2e9f56ce0304
7
- data.tar.gz: 0ff7d8a589dd2350195da3f0eb3a3e881db5ffe78dda73c5670ff695de92de3f7d5811cea0caf30a75bd829fb804ff94e6e13a6c97b6b2543200c64291204000
6
+ metadata.gz: 984af5b634471572f6ed4b1dc1e6653425bf79a630e08f8a3bf248b7eec0a471a3346a7b60654075fdf6a787193481a9d45bec856546e913088d3978a3486499
7
+ data.tar.gz: f6e433e827776db711cfa8db98680c12f0028ba86bc53567c8634320fe38ff4d3aac6098064f5e910a430d287ba3fb916e743f83d35d819719302aa595319e7e
data/README.md CHANGED
@@ -1,4 +1,7 @@
1
1
  # OptionParser Generator
2
+ [![Inline docs](http://inch-ci.org/github/madblobfish/optionparser-generator.svg?branch=master)](http://inch-ci.org/github/madblobfish/optionparser-generator)
3
+ [![Build Status](https://travis-ci.org/madblobfish/optionparser-generator.svg?branch=master)](https://travis-ci.org/madblobfish/optionparser-generator)
4
+
2
5
  Small gem which generates an OptionParser object from an OpenStruct.
3
6
 
4
7
  # Installation
@@ -3,15 +3,17 @@ require 'optparse'
3
3
 
4
4
  # Small lib for generating an OptionParser from an OpenStruct
5
5
  module OptionParserGenerator
6
- # raised when not given an OpenStruct
6
+ # Raised when not given an OpenStruct
7
7
  class WrongArgumentType < ArgumentError
8
8
  end
9
- # raised when there are two boolean entries in the OpenStruct
9
+ # Raised when there are two boolean entries in the OpenStruct
10
10
  # one named no_xyz and one xyz
11
+ #
11
12
  # only raised when the option :ignore_collisions is not given
12
13
  class OptionCollision < ArgumentError
13
14
  end
14
15
 
16
+ # Does some sanity checks and prepares the OpenStruct
15
17
  # @todo preprocess data here instead of doing it adhoc
16
18
  # @todo raise more exceptions
17
19
  # @api private
@@ -22,7 +24,7 @@ module OptionParserGenerator
22
24
  ostruct.dup.freeze # not needed but makes development easier
23
25
  end
24
26
 
25
- # does the magic
27
+ # Does the magic
26
28
  #
27
29
  # @todo write documentation :(
28
30
  # @todo split this up
@@ -82,7 +84,7 @@ module OptionParserGenerator
82
84
  optparser
83
85
  end
84
86
 
85
- ## patch for OptionParser redefines parse and parse!
87
+ # patch for OptionParser redefines parse and parse!
86
88
  # @api private
87
89
  module OptParsePatch
88
90
  # @return [OpenStruct]
@@ -100,10 +102,14 @@ module OptionParserGenerator
100
102
  end
101
103
  end
102
104
  end
105
+ # Object alias
106
+ # @see OptionParserGenerator
107
+ OptParseGen = OptionParserGenerator
103
108
 
104
109
  # rubocop:disable Style/MethodName
105
110
 
106
- # global shorthand
111
+ # Global shorthand
112
+ #
107
113
  # alias to OptionParserGenerator[arg, opt]
108
114
  # @return [OptionParser]
109
115
  # @see OptionParserGenerator
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: optsparser_generator
3
3
  version: !ruby/object:Gem::Version
4
- version: '2.4'
4
+ version: '2.5'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marvin Zerulla