cmdline_arg_parser 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d3d346c457fa1fe1d4043c7a90f7ac97a96d785
-  data.tar.gz: 957371cea616ca30cb503eaa1f133c2390f58876
+  metadata.gz: 974f92a6832ab5e261f1d07ce4200498b722f794
+  data.tar.gz: 6bf37cab4da9025a898c250f5265194881354c37
 SHA512:
-  metadata.gz: 9adaf0a06b11c270248852c0d0539e1a73d8f90e30669df446e00744c657036af8beb27d01c2aaab75629ae32f590f56ec33f1c71a0427e629a5a0a7a81c3756
-  data.tar.gz: 834352bbc193faa1932cfa6c73cf28ff415695603d6a4fd7f1f5c992a20cf7e0909de9d70b2a79b979eac00875a838792cf100a0fbf1269f900cab2416336c26
+  metadata.gz: 3e0bb11a936208f25732fa19ee0c45778553af7b03c8e134f88fe1f286d36c42ab3bc1af9e43e8b3383bf9cc8365dd7159664108e20360f1cf4a030668808a00
+  data.tar.gz: 329e1baeb2fa05bc28c706da4f5c0e72c52847847959c2f81a7995991f829801a28ac6e547d5dd6bc107949d867d0d912117efb9af241693731086092c61cfa2

data/README.markdown

@@ -4,6 +4,8 @@ A small library for parsing command-line arguments in Ruby.
 
 Designed to be used with command-line tools like `git` which have a set of subcommands that each have different options and switches.
 
+[On rubygems.org](https://rubygems.org/gems/cmdline_arg_parser)
+
 ## Sample
 
 ```ruby
@@ -14,7 +16,8 @@ class ParserFromDsl
   extend CmdlineArgParser::Dsl
 
   subcommand "merge" do
-    option "branch", short_key: "b"
+    option "branches", multiple: true, short_key: "b"
+    option "into", default: "master"
     option("from-step") { |value| value.to_i }
     switch "dry-run"
   end
@@ -23,13 +26,13 @@ class ParserFromDsl
 end
 
 # Have some ARGV
-ARGV = ["merge", "--dry-run", "--from-step", "10", "-b", "release-branch"]
+ARGV = ["merge", "--dry-run", "--from-step", "10", "-b", "release-branch", "other-branch"]
 
 args = ParserFromDsl.parse(ARGV)
 
 # Accessing the parsed data
 args.subcommand # => "merge"
-args.options # => { "branch" => "release-branch", "from-step" => 10 }
+args.options # => { "into" => "master", "branches" => ["release-branch", "other-branch"], "from-step" => 10 }
 args.switches # => Set.new(["dry-run"])
 ```
 
@@ -41,7 +44,8 @@ parser = CmdlineArgParser::Parser.new(
     CmdlineArgParser::Parser::Subcommand.new(
       "merge",
       options: [
-        CmdlineArgParser::Parser::Option.new("branch", short_key: "b"),
+        CmdlineArgParser::Parser::Option.new("branches", multiple: true, short_key: "b"),
+        CmdlineArgParser::Parser::Option.new("into", default: "master"),
         CmdlineArgParser::Parser::Option.new("from-step") { |value| value.to_i },
       ],
       switches: [
@@ -53,6 +57,26 @@ parser = CmdlineArgParser::Parser.new(
 )
 ```
 
+### Readme generation
+
+TODO
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "cmdline_arg_parser"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cmdline_arg_parser
+
 ## Built by
 
 [@davidpdrsn](https://twitter.com/davidpdrsn)

data/lib/cmdline_arg_parser/dsl.rb

@@ -36,8 +36,14 @@ module CmdlineArgParser
 
       attr_reader :options, :switches
 
-      def option(name, short_key: nil, &block)
-        @options << Parser::Option.new(name, short_key: short_key, &block)
+      def option(name, default: nil, multiple: false, short_key: nil, &block)
+        @options << Parser::Option.new(
+          name,
+          multiple: multiple,
+          short_key: short_key,
+          default: default,
+          &block
+        )
       end
 
       def switch(name, short_key: nil)

data/lib/cmdline_arg_parser/readme_builder.rb

@@ -37,24 +37,29 @@ $ #{@specifics.script_name} #{subcommand.command}
               lines << "-#{option.short_key} #{option_label}"
             end
 
-            option_description = @specifics.option_description(
-              subcommand: subcommand.command,
-              option_key: option.long_key,
+            lines << indent(
+              @specifics.option_description_for(
+                subcommand: subcommand.command,
+                option_key: option.long_key,
+              ) + "\n",
+              2
             )
-            lines << indent("#{option_description}\n", 2)
 
             lines.join("\n")
           end
 
           switch_descriptions = subcommand.switches.map do |switch|
-            lines = []
+            lines = [""]
             lines << "--#{switch.long_key}"
             if switch.short_key
               lines << "-#{short_key.long_key}"
             end
-            lines << @specifics.switch_label(
-              subcommand: subcommand.command,
-              switch_key: switch.long_key,
+            lines << indent(
+              @specifics.switch_label_for(
+                subcommand: subcommand.command,
+                switch_key: switch.long_key,
+              ),
+              2
             )
             lines.join("\n")
           end
@@ -63,11 +68,11 @@ $ #{@specifics.script_name} #{subcommand.command}
           subcommand_description += indent(switch_descriptions.join("\n"), 4)
         end
 
-        indent(subcommand_description, 2)
+        indent(subcommand_description, 2) + "\n"
       end
       output += subcommand_descriptions.join("\n")
 
-      output.chomp
+      output.chomp.gsub("\n\n\n", "\n\n")
     end
 
     private

data/lib/cmdline_arg_parser/version.rb

@@ -1,3 +1,3 @@
 module CmdlineArgParser
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/cmdline_arg_parser.rb

@@ -50,9 +50,15 @@ module CmdlineArgParser
     end
 
     class Option
-      def initialize(long_key, short_key: nil, &block)
+      def initialize(long_key, default: nil, multiple: false, short_key: nil, &block)
+        if short_key && short_key.length != 1
+          raise ArgumentError, "`short_key` can only be one character, was #{short_key.inspect}"
+        end
+
         @long_key = long_key
         @short_key = short_key
+        @multiple = multiple
+        @default = default
         @block = block
       end
 
@@ -62,21 +68,49 @@ module CmdlineArgParser
         index_of_key = argv.find_index do |word|
           word == "--#{@long_key}" || word == "-#{@short_key}"
         end
-        index_of_value = index_of_key + 1
 
-        value = argv[index_of_value]
-        if @block
-          value = @block.call(value)
+        if index_of_key.nil?
+          if @default.nil?
+            msg = "Missing argument --#{@long_key}"
+            if @short_key
+              msg += " or -#{@short_key}"
+            end
+            raise ParseError, msg
+          else
+            out.set_option(@long_key, @default)
+            return
+          end
         end
-        out.set_option(@long_key, value)
 
-        argv.delete_at(index_of_key)
-        argv.delete_at(index_of_value - 1)
+        index_of_value = index_of_key + 1
+
+        if @multiple
+          argv.delete_at(index_of_key)
+          values = argv.take_while { |value| !(value =~ /^-/) }
+          values.length.times { argv.delete_at(0) }
+
+          if @block
+            values = values.map { |value| @block.call(value) }
+          end
+          out.set_option(@long_key, values)
+        else
+          value = argv[index_of_value]
+          if @block
+            value = @block.call(value)
+          end
+          out.set_option(@long_key, value)
+          argv.delete_at(index_of_key)
+          argv.delete_at(index_of_value - 1)
+        end
       end
     end
 
     class Switch
       def initialize(long_key, short_key: nil)
+        if short_key && short_key.length != 1
+          raise ArgumentError, "`short_key` can only be one character"
+        end
+
         @long_key = long_key
         @short_key = short_key
       end
@@ -90,9 +124,8 @@ module CmdlineArgParser
 
         if index_of_key
           out.set_switch(@long_key)
+          argv.delete_at(index_of_key)
         end
-
-        argv.delete_at(index_of_key)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmdline_arg_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Pedersen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,7 +63,6 @@ files:
 - ".travis.yml"
 - Gemfile
 - README.markdown
-- README.md
 - Rakefile
 - bin/console
 - bin/setup

data/README.md

@@ -1,37 +0,0 @@
-# CmdlineArgParser
-
-[On rubygems.org](https://rubygems.org/gems/cmdline_arg_parser)
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cmdline_arg_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'cmdline_arg_parser'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install cmdline_arg_parser
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/davidpdrsn/cmdline_arg_parser.