pargser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3dffd531e9a47357559aa2315aaf5f3151b52e9
+  data.tar.gz: 5c9236c175de9fcb1af91409cd53c77720f0fcfe
+SHA512:
+  metadata.gz: fa192889e980aef25e0691b026879ac977d69d25ad1b843d37a04876338ce372fcfda7abaa1e0ef9c6c6e9a3981beb88c51865910b49f486b0f60294f040bfd4
+  data.tar.gz: a75e25d2a6d8d370cbaae90e107b4cb512bda23dd2cbe03af0097484975553c473d5540b41ce18bb4ccf802830f0cfaabab985bfc069a89f49a4f08a5dd55667

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pargser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 sergeych
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Pargser
+
+The ruby way to write CLI tools without headache of parsing command line options. Let you not to
+spend time on it and focus on functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pargser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pargser
+
+## Usage
+
+Very straightforward
+
+    p = Pargser.new.key('-f', '--fantastic') {
+      @fantastic = true
+    }
+    .key('--omit-me', doc: 'the description is optional') {
+      @omit = true
+    }
+    .key('--this-is', '-t', needs_value: true, doc: 'you should specify it!') { |value|
+      # Note that this key has no default, e.g. required
+      @this_is = value
+    }
+    .key('--pargser', '-p', default: 'rules!') { |value|
+      # There is a default so it is ok to omit it in CL
+      @pargser = value
+    }
+
+    # Parse, and return non-key arguments as array in order of appearance
+    command_line = %w|-f --this-is just_fine foo bar|
+    p.parse(command_line).should == ['foo', 'bar']
+
+    # or you can use it with blocks if you prefer to:
+    args = []
+    p.parse(command_line) { |file|
+      args << file
+    }
+    args.should == ['foo', 'bar']
+
+    # values now are set as requested:
+    @fantastic.should be_truthy
+    @omit.should be_falsey
+    @this_is.should == 'just_fine'
+    @pargser.should == 'rules!'
+
+    # It can easily generate also specifications:
+
+    expected_docs = <<END
+	-f,--fantastic
+	--omit-me
+		the description is optional
+	--this-is,-t value (optional)
+		you should specify it!
+	--pargser,-p value (default: rules!)
+    END
+
+    p.keys_doc.should == expected_docs
+
+For details please consult documentation:
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pargser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/pargser.rb

@@ -0,0 +1,151 @@
+require "pargser"
+
+# The Ruby-Style (e,g, nice and laconic) command line parser that easily supports:
+#
+# --keys
+#    optional keys with any number of aliases aliases
+# -name value
+#    key that wants value (next agrument), optionally with default value
+# --
+#    no more keys past double dash
+#
+# and regular (all other) arguments.
+#
+# Also supports automatic documentation generation
+#
+class Pargser
+
+  VERSION = "0.1.0"
+
+  # The pargser errors, e.g. wrong usage or command line does not fit specified
+  # keys ocnstraints.
+  class Error < ArgumentError;
+  end
+
+  # Create parser instance with a list of arguments. Otherwise, arguments can
+  # be passed to #parse call.
+  #
+  # @param [Array] args arguments
+  def initialize args=[]
+    @args     = args
+    @keys     = {}
+    @required = Set.new
+    @docs     = []
+  end
+
+  # Register key handler.
+  # When #parse handler blocks will be called in order of appearance in
+  # arguments array
+  #
+  #
+  # @param [String] name key name
+  #
+  # @param [Array(String)] aliases for the key
+  #
+  # @param [Boolean] :needs_value if set then the parser wants a value argument after the
+  #   key which will be passed to block as an argument. if default param is not set and
+  #   the key will not be detected, Pargser::Error will be raised
+  #
+  # @param [String] :default value. if set, needs_value parameter can be omitted - the handler
+  #   block will be passed either with this value or with one specified in args.
+  #
+  # @param [String] :doc optional documentation string that will be used in #keys_doc
+  #
+  # @yield block if the key is found with optional value argument
+  #
+  def key name, *aliases, needs_value: false, doc: nil, ** kwargs, &block
+    k = name.to_s
+
+    default_set = false
+    default = nil
+    if kwargs.include?(:default)
+      default = kwargs[:default]
+      needs_value = true
+      default_set = true
+    end
+
+    @keys.include?(k) and raise Error, "Duplicate key registration #{k}"
+    data = @keys[k] = OpenStruct.new required:    false,
+                                     needs_value: needs_value,
+                                     block:       block,
+                                     doc:         doc,
+                                     key:         k,
+                                     aliases:     aliases,
+                                     default:     default,
+                                     default_set: default_set
+    @docs << data
+    aliases.each { |a| @keys[a.to_s] = data }
+    @required.add(data) if needs_value
+    self
+  end
+
+  # Process command line and call key handlers in the order of
+  # appearance. Then call handlers that keys which need values
+  # and were not called and have defaults, or raise error.
+  #
+  # The rest of arguments (non-keys) are either yielded or returned
+  # as an array.
+  #
+  # You can optionally set other arguments than specified in constructor
+  #
+  # @param [Array] args to parse. If specified, arguments passed to constructor
+  #                will be ignored and lost
+  # @return [Array] non-keys arguments (keys afer '--' or other arguments)
+  # @yield [String] non keys argumenrs (same as returned)
+  def parse args=nil
+    @args = args.clone if args
+    no_more_keys = false
+    rest         = []
+    required_keys = @required.clone
+
+    while !@args.empty?
+      a = @args.shift
+      case
+        when no_more_keys
+          rest << a
+        when (data = @keys[a])
+          required_keys.delete data
+          if data.needs_value
+            value = @args.shift or raise "Value needed for key #{a}"
+            data.block.call value
+          else
+            data.block.call
+          end
+        when a == '--'
+          no_more_keys = true
+        when a[0] == '-'
+          raise Error, "Unknown key #{a}"
+        else
+          rest << a
+      end
+    end
+    required_keys.each { |data|
+      raise Error, "Required key is missing: #{data.key}" if !data.default_set
+      data.block.call data.default
+    }
+    block_given? and rest.each { |a| yield a }
+    rest
+  end
+
+  # Generate keys documentation multiline text
+  def keys_doc
+    res = []
+    @docs.each { |d|
+      keys = [d.key] + d.aliases
+      str = "\t#{keys.join(',')}"
+      if d.needs_value
+        str += " value"
+        if d.default
+          str += " (default: #{d.default})" if d.default
+        else
+          str += ' (optional)'
+        end
+      end
+      res << str
+      d.doc and d.doc.split("\n").each { |l| res << "\t\t#{l}" }
+    }
+    res.join("\n")+"\n"
+  end
+
+end
+

data/pargser.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pargser'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pargser"
+  spec.version       = Pargser::VERSION
+  spec.authors       = ["sergeych"]
+  spec.email         = ["sergeych"]
+  spec.summary       = %q{Very Ruby-style command line parser}
+  spec.description   = %q{Allows to write CLI in ruby without headache of arguments parsing and
+usage writing}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rspec", '~> 3.1'
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/pargser_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+require 'pargser'
+require 'ostruct'
+
+describe 'pargser' do
+  
+  it 'should parse keys' do
+    parser = Pargser.new "-a -b -v value! other data".split
+    parser.key('-a', doc: 'flag to perform a action') {
+      @a_called = true
+    }
+        .key('-c', '-b') {
+      @b_called = true
+    }
+        .key('--some', default: 'test') { |v|
+      @defvalue = v
+    }
+        .key('-v', needs_value: true) { |v|
+      @v = v
+    }
+    expect(-> { parser.key('-a') }).to raise_error(Pargser::Error)
+    
+    passed = []
+    rest   = parser.parse { |a| passed << a }
+    rest.should == passed
+    rest.should == ['other', 'data']
+    
+    @a_called.should be_truthy
+    @b_called.should be_truthy
+    @v.should == 'value!'
+    @defvalue.should == 'test'
+    
+    doc = "\t-a\n\t\tflag to perform a action\n\t-c,-b\n\t--some value (default: test)\n\t-v value (optional)\n"
+    parser.keys_doc.should == doc
+  end
+  
+  it 'should detect required keys' do
+    parser = Pargser.new ['hello']
+    parser.key('-c', needs_value: true) {}
+    expect(-> { parser.parse }).to raise_error(Pargser::Error, 'Required key is missing: -c')
+  end
+  
+  it 'should detect strange keys' do
+    parser = Pargser.new '-l hello'.split
+    expect(-> { parser.parse }).to raise_error(Pargser::Error, 'Unknown key -l')
+  end
+  
+  it 'should pass data that looks like keys' do
+    res = Pargser.new('-- -a --b'.split).parse
+    res.should == ['-a', '--b']
+  end
+  
+  it 'should provide empty defaults' do
+    parser = Pargser.new('hello'.split)
+    @t == 'wrong'
+    parser.key('-t', default: nil) { |val|
+      @t = val
+    }
+    parser.key('-q', default: false) { |val|
+      @q = val
+    }
+    parser.parse.should == ['hello']
+    @t.should == nil
+    @q.should == false
+  end
+
+  it 'should run usage example' do
+
+    p = Pargser.new.key('-f', '--fantastic') {
+      @fantastic = true
+    }
+    .key('--omit-me', doc: 'the description is optional') {
+      @omit = true
+    }
+    .key('--this-is', '-t', needs_value: true, doc: 'you should specify it!') { |value|
+      # Note that this key has no default, e.g. required
+      @this_is = value
+    }
+    .key('--pargser', '-p', default: 'rules!') { |value|
+      # There is a default so it is ok to omit it in CL
+      @pargser = value
+    }
+
+    # Parse, and return non-key arguments as array in order of appearance
+    command_line = %w|-f --this-is just_fine foo bar|
+    p.parse(command_line).should == ['foo', 'bar']
+
+    # or you can use it with blocks if you prefer to:
+    args = []
+    p.parse(command_line) { |file|
+      args << file
+    }
+    args.should == ['foo', 'bar']
+
+    # values now are set as requested:
+    @fantastic.should be_truthy
+    @omit.should be_falsey
+    @this_is.should == 'just_fine'
+    @pargser.should == 'rules!'
+
+    # It can easily generate also specifications:
+
+    expected_docs = <<END
+	-f,--fantastic
+	--omit-me
+		the description is optional
+	--this-is,-t value (optional)
+		you should specify it!
+	--pargser,-p value (default: rules!)
+END
+
+    p.keys_doc.should == expected_docs
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax                                               = [:should, :expect]
+
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: pargser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sergeych
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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'
+description: |-
+  Allows to write CLI in ruby without headache of arguments parsing and
+  usage writing
+email:
+- sergeych
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pargser.rb
+- pargser.gemspec
+- spec/pargser_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Very Ruby-style command line parser
+test_files:
+- spec/pargser_spec.rb
+- spec/spec_helper.rb