dry_option_parser 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55e9909f60289f5a51e7fe519b00705cec09d3c9
-  data.tar.gz: a98482c3ec3d8b9ae765aa24d7ec5e3a184d16e5
+  metadata.gz: 947212d35a4b437baf028d923388104dc03945d7
+  data.tar.gz: a0e1aa4210067af71b4b4067e54e2be348dcf6d9
 SHA512:
-  metadata.gz: d2928e49218cdf5fc93e4549277721b3c560fae5de5c5fb6b2c6b666eb2a5b3a5993ba9df1b105f7f0b57dca2ce2cd1e20c5bb9bd94411e0d6f8917091c7d547
-  data.tar.gz: e27b46d8352e87c0788cece7f2930ccf1598aec2b7e9f0b63913bb6bfb7fca153de462624f2c41262d841c89787fea300ae8ae4ddac34c5d8e5384c2ff49a887
+  metadata.gz: a911e925477bd53d7e5169ec30129ccc93c36a6dd73f94c90cc97e0c6cc309563090b9d408a0bf7e672cfde543eff736a676a84a22cd092364fc3c604821e440
+  data.tar.gz: 9a4b79384696608a57f0583bd59a94f3b08bdb7c5ed013ebc0bd6178a4cd9278aab34b7b2dae231dc37c8562ec6c3a1bbf7885a3bf405f5dba8643dedd76ded0

data/README.md

@@ -1,7 +1,8 @@
 DRY OPTION PARSER
 =================
 
-*Makes OptionParser less verbose.*
+*A Super-simple super-thin wrapper around OptionParser that makes it less verbose**
+
 
 Instead of
 
@@ -27,7 +28,7 @@ do
 require 'dry_option_parser'
 include DryOptionParser
 
-opt_parser = DryOptionParsers.new({}) do
+opt_parser = DryOptionParsers.new do
   self.banner = "Usage: example.rb [options]"
   assign(:verbose,"-v", "--[no-]verbose", "Run verbosely") 
 end.parse!
@@ -37,7 +38,7 @@ p ARGV
 ```
 
 Basically, a `DryOptionParser` manages an `OptionParser` instance to which it delegates all instance method calls. Additionally it manages its own `options` object accessible via `:options` accessor methods.
-(A total of 2 instance variables). Block arguments to new are `instance_eval`ed within the new `DryOptionParser` instance. `DryOptionParsers` also provides the `assign` private method, which simplifies option specs that simply do:
+(A total of 2 instance variables: @options and `SimpleDelegator`'s instance variable). Block arguments to new are `instance_eval`ed within the new `DryOptionParser` instance. `DryOptionParsers` also provides the `assign` private method, which simplifies option specs that simply do:
       
 ```ruby
 opts.on(...) do |value|
@@ -53,15 +54,5 @@ assign(:attribute,...)
 
 Otherwise, all `OptionParser` documentation applies.
 
-###One More Thing:
-By including `DryOptionParser` you also get the `cli_options` helper method which simplifies calling `DryOptionParser.new() {}`, allowing you to ultimately shorten the basic example to:
-
-```ruby
-opt_parser = cli_options do
-  self.banner = "Usage: example.rb [options]"
-  assign(:verbose,"-v", "--[no-]verbose", "Run verbosely") 
-end.parse!
-```
 ###The long example
-
 Check out the **examples** directory to see how much you can shorten the long **OptionParser** example from http://www.ruby-doc.org/stdlib-2.1.3/libdoc/optparse/rdoc/OptionParser.html by using **DryOptionParser**.

data/examples/dry_option_parser_example.rb

@@ -4,80 +4,80 @@
 require 'dry_option_parser'
 require 'ostruct'
 require 'optparse/time'
-include DryOptionParser
-
-options = OpenStruct.new
-options.library = []
-options.inplace = false
-options.encoding = "utf8"
-options.transfer_type = :auto
-options.verbose = false
-
-opt_parser = cli_options(options)  do
-  codes = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
-  code_aliases = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
-
-  self.banner = "Usage: example.rb [options]"
-
-  separator ""
-  separator "Specific options:"
-
-  # Mandatory argument.
-  on("-r", "--require LIBRARY",
-         "Require the LIBRARY before executing your script") do |lib|
-    options.library << lib
-  end
-
-  # Optional argument; multi-line description.
-  on("-i", "--inplace [EXTENSION]",
-     "Edit ARGV files in place",
-     "  (make backup if EXTENSION supplied)") do |ext|
-       options.inplace = true
-       options.extension = ext || ''
-       options.extension.sub!(/\A\.?(?=.)/, ".")  # Ensure extension begins with dot.
-     end
-
-     # Cast 'delay' argument to a Float.
-     assign("delay", "--delay N", Float, "Delay N seconds before executing")
-     # Cast 'time' argument to a Time object.
-     assign("time", "-t", "--time [TIME]", Time, "Begin execution at given time")
-
-     # Cast to octal integer.
-     assign("record_separator","-F", "--irs [OCTAL]", OptionParser::OctalInteger,
-            "Specify record separator (default \\0)")
-
-     # List of arguments.
-     assign("list","--list x,y,z", Array, "Example 'list' of arguments")
-
-     # Keyword completion.  We are specifying a specific set of arguments (codes
-     # and code_aliases - notice the latter is a Hash), and the user may provide
-     # the shortest unambiguous text.
-     code_list = (code_aliases.keys + codes).join(',')
-     assign("encoding","--code CODE", codes, code_aliases, "Select encoding",
-            "  (#{code_list})")
-
-     # Optional argument with keyword completion.
-     on("--type [TYPE]", [:text, :binary, :auto],
-        "Select transfer type (text, binary, auto)","transfer_type")
-
-     # Boolean switch.
-     on("-v", "--[no-]verbose", "Run verbosely", "verbose")
-
-     separator ""
-     separator "Common options:"
-
-     # No argument, shows at tail.  This will print an options summary.
-     # Try it and see!
-     on_tail("-h", "--help", "Show this message") do
-       puts self
-       exit
-     end
-
-     # Another typical switch to print the version.
-     on_tail("--version", "Show version") do
-       puts ::Version.join('.')
-       exit
-     end
+extend DryOptionParser
+
+
+#DryOptionsParsers
+opt_parser = DryOptionParser.new  do
+
+    self.options = OpenStruct.new
+    options.library = []
+    options.inplace = false
+    options.encoding = "utf8"
+    options.transfer_type = :auto
+    options.verbose = false
+    codes = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
+    code_aliases = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
+
+    self.banner = "Usage: example.rb [options]"
+
+    separator ""
+    separator "Specific options:"
+
+    # Mandatory argument.
+    on("-r", "--require LIBRARY",
+       "Require the LIBRARY before executing your script") do |lib|
+      options.library << lib
+    end
+
+    # Optional argument; multi-line description.
+    on("-i", "--inplace [EXTENSION]", "Edit ARGV files in place", "  (make backup if EXTENSION supplied)") do |ext|
+      options.inplace = true
+      options.extension = ext || ''
+      options.extension.sub!(/\A\.?(?=.)/, ".")  # Ensure extension begins with dot.
+    end
+
+    # Cast 'delay' argument to a Float.
+    assign("delay", "--delay N", Float, "Delay N seconds before executing")
+    # Cast 'time' argument to a Time object.
+    assign("time", "-t", "--time [TIME]", Time, "Begin execution at given time")
+
+    # Cast to octal integer.
+    assign("record_separator","-F", "--irs [OCTAL]", OptionParser::OctalInteger,
+           "Specify record separator (default \\0)")
+
+    # List of arguments.
+    assign("list","--list x,y,z", Array, "Example 'list' of arguments")
+
+    # Keyword completion.  We are specifying a specific set of arguments (codes
+    # and code_aliases - notice the latter is a Hash), and the user may provide
+    # the shortest unambiguous text.
+    code_list = (code_aliases.keys + codes).join(',')
+    assign("encoding","--code CODE", codes, code_aliases, "Select encoding",
+           "  (#{code_list})")
+
+    # Optional argument with keyword completion.
+    on("--type [TYPE]", [:text, :binary, :auto],
+       "Select transfer type (text, binary, auto)","transfer_type")
+
+    # Boolean switch.
+    on("-v", "--[no-]verbose", "Run verbosely", "verbose")
+
+    separator ""
+    separator "Common options:"
+
+    # No argument, shows at tail.  This will print an options summary.
+    # Try it and see!
+    on_tail("-h", "--help", "Show this message") do
+      puts self
+      exit
+    end
+
+    # Another typical switch to print the version.
+    on_tail("--version", "Show version") do
+      puts ::Version.join('.')
+      exit
+    end
 end
 
 opt_parser.parse!(ARGV)

data/lib/dry_option_parser.rb

@@ -9,22 +9,18 @@ require 'delegate'
 module DryOptionParser
   class DryOptionParser < SimpleDelegator
 
+    attr_accessor :options
+
     def initialize(options={},&blk)
       @options = options
       super(OptionParser.new)
-      instance_eval &blk
+      instance_eval(&blk)
     end
 
     def assign(*args)
       attribute = args.shift
-      on(*args) {|val| @options[attribute]=val}
+      on(*args) {|val| @options[attribute.to_sym]=val}
     end
 
-    attr_accessor :options
-    #
   end  # class OptparseExample
-
-  def cli_options(options={},&blk)
-    DryOptionParser.new(options,&blk)
-  end
 end

data/lib/dry_option_parser/version.rb

@@ -1,3 +1,3 @@
 module DryOptionParser
-  VERSION = "1.0.2"
+  VERSION = "2.0.0"
 end

data/spec/refactored_optionparser_spec.rb

@@ -4,113 +4,114 @@
 require 'dry_option_parser'
 require 'ostruct'
 require 'optparse/time'
-include DryOptionParser
-
-describe "DryOptionParser--the long OptionParser example" do
-  before do
-    @options = OpenStruct.new
-    @options.library = []
-    @options.inplace = false
-    @options.encoding = "utf8"
-    @options.transfer_type = :auto
-    @options.verbose = false
-  end
-
-  # Refactor the long optionparser example using DryOptionParser
-  subject do
-    @opt_parser = cli_options(@options) do
-      codes = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
-      code_aliases = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
-
-      self.banner = "Usage: example.rb [options]"
-
-      separator ""
-      separator "Specific options:"
 
-      # Mandatory argument.
-      on( "-r", "--require LIBRARY",
-         "Require the LIBRARY before executing your script") do |lib|
-        options.library << lib
+module DryOptionParser
+  describe "DryOptionParser--the long OptionParser example" do
+    before {
+      @options = OpenStruct.new
+      @options.library = []
+      @options.inplace = false
+      @options.encoding = "utf8"
+      @options.transfer_type = :auto
+      @options.verbose = false
+    }
+    
+    # Refactor the long optionparser example using DryOptionParser
+    subject do
+        opts = @options
+      @opt_parser = DryOptionParser.new do
+        self.options = opts
+        codes = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
+        code_aliases = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
+
+        self.banner = "Usage: example.rb [options]"
+
+        separator ""
+        separator "Specific options:"
+
+        # Mandatory argument.
+        on( "-r", "--require LIBRARY",
+           "Require the LIBRARY before executing your script") do |lib|
+          options.library << lib
+        end
+
+        # Optional argument; multi-line description.
+        on("-i", "--inplace [EXTENSION]", "Edit ARGV files in place",
+           "  (make backup if EXTENSION supplied)") do |ext|
+          options.inplace = true
+          options.extension = ext || ''
+          options.extension.sub!(/\A\.?(?=.)/, ".")  # Ensure extension begins with dot.
+        end
+
+        # Cast 'delay' argument to a Float.
+        assign("delay", "--delay N", Float, "Delay N seconds before executing")
+        # Cast 'time' argument to a Time object.
+        assign("time", "-t", "--time [TIME]", Time, "Begin execution at given time")
+
+        # Cast to octal integer.
+        assign("record_separator","-F", "--irs [OCTAL]", OptionParser::OctalInteger,
+               "Specify record separator (default \\0)")
+
+        # List of arguments.
+        assign("list","--list x,y,z", Array, "Example 'list' of arguments")
+
+        # Keyword completion.  We are specifying a specific set of arguments (codes
+        # and code_aliases - notice the latter is a Hash), and the user may provide
+        # the shortest unambiguous text.
+        code_list = (code_aliases.keys + codes).join(',')
+        assign("encoding","--code CODE", codes, code_aliases, "Select encoding",
+               "  (#{code_list})")
+
+        # Optional argument with keyword completion.
+        on("--type [TYPE]", [:text, :binary, :auto],
+           "Select transfer type (text, binary, auto)","transfer_type")
+
+        # Boolean switch.
+        on("-v", "--[no-]verbose", "Run verbosely", "verbose")
+
+        separator ""
+        separator "Common options:"
+
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        on_tail("-h", "--help", "Show this message") do
+          puts self
+          exit
+        end
+
+        # Another typical switch to print the version.
+        on_tail("--version", "Show version") do
+          puts ::Version.join('.')
+          exit
+        end
       end
+    end
+    #End of refactored long example
 
-      # Optional argument; multi-line description.
-      on("-i", "--inplace [EXTENSION]",
-         "Edit ARGV files in place",
-         "  (make backup if EXTENSION supplied)") do |ext|
-           options.inplace = true
-           options.extension = ext || ''
-           options.extension.sub!(/\A\.?(?=.)/, ".")  # Ensure extension begins with dot.
-         end
-
-         # Cast 'delay' argument to a Float.
-         assign("delay", "--delay N", Float, "Delay N seconds before executing")
-         # Cast 'time' argument to a Time object.
-         assign("time", "-t", "--time [TIME]", Time, "Begin execution at given time")
-
-         # Cast to octal integer.
-         assign("record_separator","-F", "--irs [OCTAL]", OptionParser::OctalInteger,
-                "Specify record separator (default \\0)")
-
-         # List of arguments.
-         assign("list","--list x,y,z", Array, "Example 'list' of arguments")
-
-         # Keyword completion.  We are specifying a specific set of arguments (codes
-         # and code_aliases - notice the latter is a Hash), and the user may provide
-         # the shortest unambiguous text.
-         code_list = (code_aliases.keys + codes).join(',')
-         assign("encoding","--code CODE", codes, code_aliases, "Select encoding",
-                "  (#{code_list})")
-
-         # Optional argument with keyword completion.
-         on("--type [TYPE]", [:text, :binary, :auto],
-            "Select transfer type (text, binary, auto)","transfer_type")
-
-         # Boolean switch.
-         on("-v", "--[no-]verbose", "Run verbosely", "verbose")
-
-         separator ""
-         separator "Common options:"
-
-         # No argument, shows at tail.  This will print an options summary.
-         # Try it and see!
-         on_tail("-h", "--help", "Show this message") do
-           puts self
-           exit
-         end
-
-         # Another typical switch to print the version.
-         on_tail("--version", "Show version") do
-           puts ::Version.join('.')
-           exit
-         end
+    #Some tests
+    it "should successfully evaluate the full example" do
+      should_not be_nil
     end
-  end
-  #End of refactored long example
 
-  #Some tests
-  it "should successfully evaluate the full example" do
-    should_not be_nil
-  end
+    context "parsing with various args" do
+      it "should return default options if no args given" do
+        subject.parse!([])
+        expect(subject.options.each_pair.all? {|k,v| @options[k]==v}).to be_truthy
+      end
 
-  context "parsing with various args" do
-    it "should return default options if no args given" do
-      subject.parse!([])
-      expect(subject.options.each_pair.all? {|k,v| @options[k]==v}).to be_truthy
+      it "-r something should add library" do
+        subject.parse!(%w[-r foo])
+        library = subject.options[:library]
+        expect(library).to be_an(Array)
+        expect(subject.options[:library]).to include("foo")
+      end
+      it "--delay 7 should assign a delay of 7.0" do
+        subject.parse!(%w[--delay 7])
+        expect(subject.options[:delay]).to eq(7.0)
+      end
     end
 
-    it "-r something should add library" do
-      subject.parse!(%w[-r foo])
-      library = subject.options[:library]
-      expect(library).to be_an(Array)
-      expect(subject.options[:library]).to include("foo")
-    end
-    it "--delay 7 should assign a delay of 7.0" do
-      subject.parse!(%w[--delay 7])
-      expect(subject.options[:delay]).to eq(7.0)
-    end
   end
-
-
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry_option_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Petr Skocik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Save keystrokes with OptionParser while using more or less the same API.