optio 0.2.0

data/exe/optio

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "optio"
+
+p = Optio::Parser.new do |parser|
+  parser.switch :iko
+end
+
+puts p.parse.inspect

data/lib/optio.rb

@@ -0,0 +1,8 @@
+lib_dir = File.expand_path(File.join(__dir__, 'optio'))
+Dir.glob(File.join(lib_dir, '**', '*')).each do |f|
+  require f if File.file?(f)
+end
+
+module Optio
+  # Your code goes here...
+end

data/lib/optio/exceptions.rb

@@ -0,0 +1,6 @@
+module Optio
+  module Exceptions
+    class SwitchAlreadyExistsError
+    end
+  end
+end

data/lib/optio/parser.rb

@@ -0,0 +1,96 @@
+require 'optparse'
+
+module Optio
+  # A wrapper class for Ruby's {OptionParser}[https://ruby-doc.org/stdlib-2.4.1/libdoc/optparse/rdoc/OptionParser.html]
+  # Usage:
+  #
+  #   p = Optio::Parser.new do |parser|
+  #     parser.switch :verbose, short: 'v', desc: 'Verbose logging', type: TrueClass
+  #   end
+  #   p.parse! # or p.parse!(ARGV) or p.parse!(args_array)
+  #
+  # By default the arguments that are parsed are the ones in +ARGV+
+  #
+  # ==== TODO
+  # Implement support for sub commands;
+  #
+  #   Optio::Parser.new do |parser|
+  #     parser.subcommand :dance
+  #   end
+  class Parser
+    def initialize(&block)
+      @switches = {}
+      @subcommands = {}
+      @banner = nil
+      @parsed_params = {}
+      if block_given?
+        yield self
+      end
+    end
+
+    # Define a switch
+    #
+    # ==== Parameters:
+    # switch_name::
+    #   The name of the switch, i.e. the string that will represent the switch
+    #   :someswitch will be parsed as +--someswitch+
+    # opts::
+    #   Additional options for the switch;
+    #   * +:desc+ - The description that will be shown for the switch.
+    #   * +: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)
+    end
+
+    # TODO support sub commands
+    def subcommand(subcommand, opts)
+      store_parameter(subcommand, opts, @subcommands)
+      raise NotImplementedError, 'support for sub commands is not yet supported'
+    end
+
+    # Setup the banner for the option parser
+    #
+    # ==== Parameters:
+    # text::
+    #   Banner text
+    def banner(text)
+      @banner = text
+    end
+
+    def parse(args = ARGV)
+      parsed_params = {}
+      rb_parser(parsed_params).parse(args)
+      parsed_params
+    end
+
+    def parse!(args = ARGV)
+      parsed_params = {}
+      rb_parser(parsed_params).parse!(args)
+      parsed_params
+    end
+
+    private
+
+    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
+          end
+        end
+      end
+    end
+
+    def store_parameter(parameter, opts, mapping)
+      unless parameter.is_a?(Symbol) || parameter.is_a?(String)
+        raise ArgumentError, "parameter #{parameter} must be of types Atom or String"
+      end
+      parameter_sym = parameter.to_sym
+      if mapping.has_key?(parameter_sym)
+        raise Exceptions::SwitchAlreadyExistsError, "parameter #{parameter} already been defined"
+      end
+      mapping[parameter_sym] = opts
+    end
+  end
+end

data/lib/optio/version.rb

@@ -0,0 +1,3 @@
+module Optio
+  VERSION = File.read(File.join(__dir__, '..', '..', 'VERSION')).strip
+end

data/optio.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "optio/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "optio"
+  spec.version       = Optio::VERSION
+  spec.authors       = ["Amit Goldberg"]
+  spec.email         = ["amit.goldberg@gmail.com"]
+
+  spec.summary       = %q{}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/amitizle/optio"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: optio
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Amit Goldberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: ''
+email:
+- amit.goldberg@gmail.com
+executables:
+- optio
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- docs/Optio.html
+- docs/Optio/Exceptions.html
+- docs/Optio/Exceptions/SwitchAlreadyExistsError.html
+- docs/Optio/Parser.html
+- docs/README_md.html
+- docs/created.rid
+- docs/css/fonts.css
+- docs/css/rdoc.css
+- docs/fonts/Lato-Light.ttf
+- docs/fonts/Lato-LightItalic.ttf
+- docs/fonts/Lato-Regular.ttf
+- docs/fonts/Lato-RegularItalic.ttf
+- docs/fonts/SourceCodePro-Bold.ttf
+- docs/fonts/SourceCodePro-Regular.ttf
+- docs/images/add.png
+- docs/images/arrow_up.png
+- docs/images/brick.png
+- docs/images/brick_link.png
+- docs/images/bug.png
+- docs/images/bullet_black.png
+- docs/images/bullet_toggle_minus.png
+- docs/images/bullet_toggle_plus.png
+- docs/images/date.png
+- docs/images/delete.png
+- docs/images/find.png
+- docs/images/loadingAnimation.gif
+- docs/images/macFFBgHack.png
+- docs/images/package.png
+- docs/images/page_green.png
+- docs/images/page_white_text.png
+- docs/images/page_white_width.png
+- docs/images/plugin.png
+- docs/images/ruby.png
+- docs/images/tag_blue.png
+- docs/images/tag_green.png
+- docs/images/transparent.png
+- docs/images/wrench.png
+- docs/images/wrench_orange.png
+- docs/images/zoom.png
+- docs/index.html
+- docs/js/darkfish.js
+- docs/js/jquery.js
+- docs/js/navigation.js
+- docs/js/navigation.js.gz
+- docs/js/search.js
+- docs/js/search_index.js
+- docs/js/search_index.js.gz
+- docs/js/searcher.js
+- docs/js/searcher.js.gz
+- docs/table_of_contents.html
+- exe/optio
+- lib/optio.rb
+- lib/optio/exceptions.rb
+- lib/optio/parser.rb
+- lib/optio/version.rb
+- optio.gemspec
+homepage: https://github.com/amitizle/optio
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []