optio 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c821cc770e1e3748a1e1d9e2c296415fbc32d22
-  data.tar.gz: 46799e0daacbf210a995adc4fa1a14cd7d33bbcd
+  metadata.gz: ab15e38b8250f34d485d2d561565cc0073293e1c
+  data.tar.gz: 4548155ad36f70ff96c2865736414a96d13a5221
 SHA512:
-  metadata.gz: 39408c3c69ab03a324693ff17fe3375c49acaf9cdb53477a28d7cbe301602a7af2297e381ffbfb4911fc70439959f4102dab21b58ed19bb210b5f62ecd16e8df
-  data.tar.gz: f8ad86453a62dca500e2ee8aca62be913674fd8c7884d7ba59dc10ec25e7e1d1df1fa539661f70eef75db7b8e94a700660a8b399155bb7889262ef33ac2daf2c
+  metadata.gz: c19b466a2d5c34f4ba42111784ad4b2f65d0cc18c03b238e7171c7d95e79233e57b98b4a1241fb139d0c2a9a22e96300362ac539e8c27381940151a3adccf332
+  data.tar.gz: 9afefd10c6c4e6c13f4887799fba6b021d58bc19a52de479905a119b876355231fee261b73b0b53438798e037ca071234f6382a827f0e6a744c1f9d7f9b27ba7

data/README.md

@@ -2,7 +2,6 @@
 
 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/optio`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Write usage instructions here
 
 ## Development
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/optio/exceptions.rb

@@ -1,6 +1,13 @@
 module Optio
   module Exceptions
-    class SwitchAlreadyExistsError
+    # Raised when the same switched is registered more
+    # than once
+    class SwitchAlreadyExistsError < RuntimeError
+    end
+
+    # Raised when trying to register more than one
+    # switch with the same short switch name
+    class ShortSwitchAlreadyExistsError < RuntimeError
     end
   end
 end

data/lib/optio/parser.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'optio/switch'
 
 module Optio
   # A wrapper class for Ruby's {OptionParser}[https://ruby-doc.org/stdlib-2.4.1/libdoc/optparse/rdoc/OptionParser.html]
@@ -17,6 +18,8 @@ module Optio
   #   Optio::Parser.new do |parser|
   #     parser.subcommand :dance
   #   end
+  #
+  # TODO expose the option to auto assign short switch
   class Parser
     def initialize(&block)
       @switches = {}
@@ -40,7 +43,8 @@ module Optio
     #   * +:type+ - Expected argument type, {see OptionParser for details}[https://ruby-doc.org/stdlib-2.4.1/libdoc/optparse/rdoc/OptionParser.html#class-OptionParser-label-Type+Coercion]
     #   * +:short:+ - The short switch, i,e +-h+ for +--help+
     def switch(switch_name, opts = {})
-      store_parameter(switch_name, opts, @switches)
+      switch_obj = Switch.new(switch_name, opts)
+      store_parameter(switch_name, switch_obj, @switches)
     end
 
     # TODO support sub commands
@@ -74,9 +78,10 @@ module Optio
 
     def rb_parser(parsed_params)
       OptionParser.new do |rb_parser|
-        @switches.each do |switch, opts|
-          rb_parser.on("#{switch.to_s.chars.first} IKO", "--#{switch} IKO", opts[:type], opts[:desc]) do |param|
-            parsed_params[switch] = param
+        @switches.each do |switch_name, switch_obj|
+          rb_parser.banner = @banner if @banner
+          rb_parser.on(*(switch_obj.rb_parser_args)) do |param|
+            parsed_params[switch_name] = param
           end
         end
       end

data/lib/optio/short_switch_registry.rb

@@ -0,0 +1,41 @@
+require 'optio/exceptions'
+
+module Optio
+  class ShortSwitchRegistry
+    attr_reader :registered
+    attr_reader :pool
+
+    def initialize
+      @registered = {}
+      @pool = ('a'..'z').to_a
+    end
+
+    def register(switch_name, short_name)
+      if !@pool.include?(short_name)
+        raise Exceptions::ShortSwitchAlreadyExistsError,
+          "#{short_name} already registered with #{switch_name}"
+      end
+      @pool.delete(short_name)
+      @registered[switch_name] = short_name
+    end
+
+    def get(switch_name)
+      switch_list = switch_name.to_s.chars.to_a.uniq
+      chosen_switch = switch_list.find do |short_switch|
+        @pool.include?(short_switch)
+      end
+      if !chosen_switch
+        chosen_switch = random_short_switch
+      end
+      @pool.delete(chosen_switch)
+      @registered[switch_name] = chosen_switch
+      chosen_switch
+    end
+
+    private
+
+    def random_short_switch
+      @pool.shuffle.first
+    end
+  end
+end

data/lib/optio/switch.rb

@@ -0,0 +1,23 @@
+
+module Optio
+  class Switch
+    # TODO mandatory switch
+    def initialize(name, opts)
+      @name = name
+      @opts = opts
+    end
+
+    def rb_parser_args
+      args = ["--#{@name} #{@name.upcase}"]
+      if @opts[:short]
+        args.unshift("-#{@opts[:short]} #{@name.upcase}")
+      end
+      [:type, :desc].each do |key|
+        if @opts[key]
+          args << @opts[key]
+        end
+      end
+      args
+    end
+  end
+end

data/optio.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Amit Goldberg"]
   spec.email         = ["amit.goldberg@gmail.com"]
 
-  spec.summary       = %q{}
-  spec.description   = %q{}
-  spec.homepage      = "https://github.com/amitizle/optio"
+  spec.summary       = %q{A wrapper for Ruby's OptionParser library}
+  spec.description   = File.read('README.md')
+  spec.homepage      = "https://rubygems.org/gems/optio"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Amit Goldberg
@@ -52,7 +52,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: ''
+description: |
+  # Optio
+
+  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/optio`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'optio'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install optio
+
+  ## Usage
+
+  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/[USERNAME]/optio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+  ## License
+
+  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+  ## Code of Conduct
+
+  Everyone interacting in the Optio project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/optio/blob/master/CODE_OF_CONDUCT.md).
 email:
 - amit.goldberg@gmail.com
 executables:
@@ -124,9 +166,11 @@ files:
 - lib/optio.rb
 - lib/optio/exceptions.rb
 - lib/optio/parser.rb
+- lib/optio/short_switch_registry.rb
+- lib/optio/switch.rb
 - lib/optio/version.rb
 - optio.gemspec
-homepage: https://github.com/amitizle/optio
+homepage: https://rubygems.org/gems/optio
 licenses:
 - MIT
 metadata: {}
@@ -149,5 +193,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: ''
+summary: A wrapper for Ruby's OptionParser library
 test_files: []