miniparse 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd0805b6bb2f315ae9df2c2ccea6c314f8cc7d69
-  data.tar.gz: 925c5bbe738870df5cceba609983d82a32ab8500
+  metadata.gz: d3d0c195e0ed48896bc0b7c358241d361dbcce6b
+  data.tar.gz: ff9d43c21dfd7c8eb4a6016a265deeb458b84790
 SHA512:
-  metadata.gz: 40a6e76211a8a40bdd394878fd91efd47026a517516ac75c602ccba55cf04065a7804279207500d6d84626bcb172ce1fe7dc7f8a008a5f8566b1e95daa1bb3fe
-  data.tar.gz: 6cba205c6f3ec89acf6e71f96c98d03fde95fad7e81d20edd64ead076ff079da3711f98d5b47484c80d9295a21134a0a459146f68233cc76638530a099645141
+  metadata.gz: e58e69168f86d2b1dcdb55386bbd15ef3587070645b198dce4d8c743ee9efcad76b550d22711687a27741221f7b7fc4d2f0d7d2491ab8a5041c365340cca07fb
+  data.tar.gz: e19e5e218b9d8c36a3d48abb98ac9c25628942e6c528a874322180b89515db76b382ecfb2c7af1e8979525e55e99d382449db175d5192bece07fea079eeb4d39

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+
+# Miniparse Change Log
+All MAJOR.MINOR changes to Miniparse will be documented in this file.
+This project uses an aproximation to [Semantic Versioning](http://semver.org/), 
+see [miniparse FAQ](https://github.com/jmrod4/miniparse/blob/master/FAQ.md) for details.
+ 
+## [v0.4.0] - 2016-03-23
+
+### Public interface
+to gain in clarity
+- Parser#command_name replaces Parser#command
+- Parser#current_command_name replaces Parser#current_command
+
+new feature
+- added Parser#add_program_description(...)
+
+### Improved
+- greatly improved source yard documentation (used by rubygems site) and used @private to guard the non-public interface
+- improved examples
+- modified app_simple example so that set_control is outside configure block and has a global effect
+
+### Fixed
+- added gemspec requeriment to Ruby 2.0 or later
+- fixed examples
+
+## [v0.3.0] - 2016-03-16
+first public gem release

data/FAQ.md

@@ -5,7 +5,7 @@
 
 ### What's the meaning of _x.y.z_ in your version numbers?
 
-We use a [Semantic Versioning](http://semver.org/) like scheme of MAJOR.MINOR.PATCH:
+For version 1.0.0 and following we use a [Semantic Versioning](http://semver.org/) like scheme of MAJOR.MINOR.PATCH:
 
 The MAJOR version numbers will only change when backwards incompatible changes are made to the public interface.
 
@@ -13,7 +13,9 @@ The MINOR version number will change when adding new functionality or some exten
 
 The PATCH number will change when fixing bugs or implementing internal or minor improvements. No changes will be made to the public interface.
 
-Additionally a `b` will be added for beta (i.e. pre-release) versions.
+Additionally a `b` will be added for beta or a `pre` for pre-release versions.
+
+NOTE: Until 1.0 version is released the library is considered in an _unstable_ state and any changes to the public interface will change only the MINOR version number.
 
 ---
 
@@ -23,7 +25,7 @@ At the moment the complete public interface is restricted to the class Parser, t
 
 You can find the complete specification in the public methods and constants on these files:
 
-  * [miniparse.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/constants.rb)
+  * [miniparse/constants.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/constants.rb)
  
   * [miniparse/parser.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/parser.rb)
 

data/LICENSE.txt

@@ -1,5 +1,6 @@
 The MIT License (MIT)
 
+Miniparse Ruby Library
 Copyright (c) 2016 Juanma Rodriguez
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.md

@@ -1,9 +1,10 @@
 
-# Miniparse
+# miniparse [![Gem version](https://img.shields.io/gem/v/miniparse.svg)](https://rubygems.org/gems/miniparse)
 
-**Miniparse is an easy to use yet flexible and powerful ruby library for parsing command-line options.**
+**Miniparse is an easy to use yet flexible and powerful Ruby library for parsing command-line options.**
 
-The main objetive of this implementation is to get minimun boiler plate but keep ease of use and a self documenting specification. 
+
+The main objective of this implementation is to get minimun boiler plate but keep ease of use and a self documenting specification. 
 
 Additionally the library is quite flexible and allows a lot of customization but always with sane defaults so **you don't need to learn nothing to start using it**.
 
@@ -11,23 +12,17 @@ Additionally the library is quite flexible and allows a lot of customization but
 
 Please find below a short but meaningful example, then you can **[get more examples](https://github.com/jmrod4/miniparse/tree/master/examples)** at [Github miniparse repository](https://github.com/jmrod4/miniparse).
 
-You can find also a nice autogenerated documentation from the current gem at  http://www.rubydoc.info/gems/miniparse/
-
-And finally, for the source files for the complete public interface you can see the class Parser in:
+You can also find a nice autogenerated documentation from the current gem at  http://www.rubydoc.info/gems/miniparse/
 
-  * [miniparse/parser.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/parser.rb)
+And finally, the source files for the complete public interface are:
 
-The control class methods in:
+  * the class Parser at [miniparse/parser.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/parser.rb)
 
-  * [miniparse/control.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/control.rb)
-  
-And the constants in: 
+  * the control class methods at [miniparse/control.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/control.rb)
   
-  * [miniparse.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/constants.rb)
+  * the constants in [miniparse/constants.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/constants.rb)
   
-If you use the optional App module you can find the source here:
-
-  * [miniparse/app.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/app.rb)		
+  * and if you use the optional App module you can find the source in [miniparse/app.rb](https://github.com/jmrod4/miniparse/blob/master/lib/miniparse/app.rb)		
 
 ## Simple Example
 
@@ -68,15 +63,15 @@ or even get the auto generated help
 	   
 ## Installation
 
-You can install it as an standard ruby gem with
+You can install it as an standard Ruby gem with
 
     $ gem install miniparse
     
-then to use you can require it adding the following to the top of your ruby source file
+then to use you can require it adding the following to the top of your Ruby source file
 
     require 'miniparse'
 	
-## F.A.Q.
+## FAQ
 
 There is a FAQ available at https://github.com/jmrod4/miniparse/blob/master/FAQ.md
     
@@ -94,6 +89,8 @@ After checking out the repo you can:
 
 ## License
 
-This library has Copyright 2016 Juanma Rodriguez and it's available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Copryright 2016 Juanma Rodriguez
+
+This library is copyrighted software and it can be used and distributed as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 You can find the source code at https://github.com/jmrod4/miniparse.

data/badge_fun.md

@@ -0,0 +1,68 @@
+
+# miniparse   [![GitHub issues](https://img.shields.io/github/issues/jmrod4/miniparse.svg)](https://github.com/jmrod4/miniparse/issues) [![GitHub tag](https://img.shields.io/github/tag/jmrod4/miniparse.svg)](https://github.com/jmrod4/miniparse) [![Gem version](https://img.shields.io/gem/v/miniparse.svg)](https://rubygems.org/gems/miniparse)
+
+**Miniparse is an easy to use yet flexible and powerful Ruby library for parsing command-line options.**
+
+# miniparse
+
+**Miniparse is an easy to use yet flexible and powerful Ruby library for parsing command-line options.**
+
+[![GitHub issues](https://img.shields.io/github/issues/jmrod4/miniparse.svg)](https://github.com/jmrod4/miniparse/issues) [![GitHub tag](https://img.shields.io/github/tag/jmrod4/miniparse.svg)](https://github.com/jmrod4/miniparse) [![Gem version](https://img.shields.io/gem/v/miniparse.svg)](https://rubygems.org/gems/miniparse)
+
+
+# Miniparse Badges
+
+Some of the available badges for this project, just to have a bit of graphic fun
+
+## a selection with links
+
+
+## fury.io
+
+### GitHub
+
+[![GitHub version](https://badge.fury.io/gh/jmrod4%2Fminiparse.svg)](https://badge.fury.io/gh/jmrod4%2Fminiparse) 
+
+### Gem
+
+[![Gem Version](https://badge.fury.io/rb/miniparse.svg)](https://badge.fury.io/rb/miniparse)
+
+## shields.io
+
+### GitHub
+
+[![GitHub release](https://img.shields.io/github/release/jmrod4/miniparse.svg)]()
+
+[![GitHub tag](https://img.shields.io/github/tag/jmrod4/miniparse.svg)]()
+
+[![Github All Releases](https://img.shields.io/github/downloads/jmrod4/miniparse/total.svg)]()
+
+[![Code Climate](https://img.shields.io/codeclimate/github/jmrod4/miniparse.svg)]()
+
+[![Code Climate](https://img.shields.io/codeclimate/coverage/github/jmrod4/miniparse.svg)]()
+
+[![GitHub issues](https://img.shields.io/github/issues/jmrod4/miniparse.svg)]()
+
+[![GitHub issues](https://img.shields.io/github/issues-raw/jmrod4/miniparse.svg)]()
+
+[![GitHub license](https://img.shields.io/github/license/jmrod4/miniparse.svg)]()
+
+### Gem
+
+[![Gem version](https://img.shields.io/gem/v/miniparse.svg)]()
+
+[![Gem downloads](https://img.shields.io/gem/dt/miniparse.svg)]()
+
+[![Gem downloads latest](https://img.shields.io/gem/dtv/miniparse.svg)]()
+
+[![Gems rank](https://img.shields.io/gem/rt/miniparse.svg)]()
+
+[![Gems rank daily](https://img.shields.io/gem/rd/jmrod4.svg)]()
+
+#### User
+
+[![Gems](https://img.shields.io/gem/u/jmrod4.svg)]()
+
+### Custom
+
+[![custom](https://img.shields.io/badge/coolness-high-blue.svg)]()

data/examples/ex01_simple.rb

@@ -18,6 +18,6 @@ end
 puts "args     #{parser.args.inspect}"
 puts "options  #{parser.options.inspect}"
 # for commands
-puts "parsed command  #{parser.command.inspect}"
+puts "parsed command  #{parser.command_name.inspect}"
 puts "command args    #{parser.command_args.inspect}"
 puts "command options #{parser.command_options.inspect}"

data/examples/ex02_options.rb

@@ -26,6 +26,6 @@ parser.parse(ARGV)
 puts "args     #{parser.args.inspect}"
 puts "options  #{parser.options.inspect}"
 # for commands
-puts "parsed command  #{parser.command.inspect}"
+puts "parsed command  #{parser.command_name.inspect}"
 puts "command args    #{parser.command_args.inspect}"
 puts "command options #{parser.command_options.inspect}"

data/examples/ex03_commands.rb

@@ -19,6 +19,6 @@ parser.parse(ARGV)
 puts "args     #{parser.args.inspect}"
 puts "options  #{parser.options.inspect}"
 # for commands
-puts "parsed command  #{parser.command.inspect}"
+puts "parsed command  #{parser.command_name.inspect}"
 puts "command args    #{parser.command_args.inspect}"
 puts "command options #{parser.command_options.inspect}"

data/examples/ex04_mixed.rb

@@ -32,6 +32,6 @@ parser.parse(ARGV)
 puts "args     #{parser.args.inspect}"
 puts "options  #{parser.options.inspect}"
 # for commands
-puts "parsed command  #{parser.command.inspect}"
+puts "parsed command  #{parser.command_name.inspect}"
 puts "command args    #{parser.command_args.inspect}"
 puts "command options #{parser.command_options.inspect}"

data/examples/ex05_block.rb

@@ -26,6 +26,6 @@ parser.parse(ARGV)
 puts "args     #{parser.args.inspect}"
 puts "options  #{parser.options.inspect}"
 # for commands
-puts "parsed command  #{parser.command.inspect}"
+puts "parsed command  #{parser.command_name.inspect}"
 puts "command args    #{parser.command_args.inspect}"
 puts "command options #{parser.command_options.inspect}"

data/examples/ex06_task_app.rb

@@ -28,7 +28,7 @@ parser.parse ARGV
 puts "args     #{parser.args.inspect}"
 puts "options  #{parser.options.inspect}"
 # for commands
-puts "parsed command  #{parser.command.inspect}"
+puts "parsed command  #{parser.command_name.inspect}"
 puts "command args    #{parser.command_args.inspect}"
 puts "command options #{parser.command_options.inspect}"
 

data/examples/ex07_controls.rb

@@ -2,7 +2,7 @@
     
 require 'miniparse'
 
-# following is just a copy of the controls defined in control.rb
+# following is just a copy of the controls defined in constants.rb
 # you don't need to specify all, only the ones you want to change (maybe none)
 
 Miniparse.set_control( {
@@ -58,6 +58,6 @@ end
 puts "args     #{parser.args.inspect}"
 puts "options  #{parser.options.inspect}"
 # for commands
-puts "parsed command  #{parser.command.inspect}"
+puts "parsed command  #{parser.command_name.inspect}"
 puts "command args    #{parser.command_args.inspect}"
 puts "command options #{parser.command_options.inspect}"

data/examples/ex08_app_simple.rb

@@ -1,9 +1,10 @@
 require "miniparse/app"
 
+Miniparse.set_control(
+    autoshortable: true,
+    )
+
 App.configure_parser do |parser|
-  Miniparse.set_control(
-      autoshortable: true,
-      )
   parser.add_program_description "my program help introduction\n"
   parser.add_option("--list", "list something")
   parser.parse ARGV

data/lib/miniparse/command.rb

@@ -84,11 +84,12 @@ end
 
 
 
+
+# @private  
 # TODO FEATURE consider doing unambiguous matches for shortened options
 # TODO FEATURE consider the option default value setting the type
-# @private  
 class Option < Command
-  
+
   attr_reader :value, :shortable
 
   def check(arg)

data/lib/miniparse/parser.rb

@@ -92,11 +92,9 @@ class Parser
     try_argument do
       global_argv, cmd_name, cmd_argv = commander.split_argv(argv)
       @args = global_broker.parse_argv(global_argv)
-      if cmd_name
-        commander.parse_argv(cmd_name, cmd_argv)
-      end
-      if Miniparse.control(:raise_global_args) && (! args.empty?)
-        # FIXME review this logic later
+      
+      commander.parse_argv(cmd_name, cmd_argv)    if cmd_name
+      if Miniparse.control(:raise_global_args) && !args.empty?
         error = current_command_name  ?  "unrecognized command"  :  "extra arguments"
         raise ArgumentError, "#{error} '#{args[0]}'"
       end
@@ -106,7 +104,6 @@ class Parser
 
   # @return [string] a help message with the short descriptions
   def help_desc
-    #FIXME
     text = ""
     if (global = global_broker.help_desc).size > 0
       text += "\nOptions:\n"
@@ -118,7 +115,6 @@ class Parser
 
   # @return [string] a usage message
   def help_usage
-    #FIXME
     if Miniparse.control(:detailed_usage)
       right_text = @global_broker.help_usage
     elsif current_command_name
@@ -126,10 +122,12 @@ class Parser
     else
       right_text = "[options]"
     end
+
     if current_command_name
       right_text += " <command> [command_options]"
     end
     right_text += " <args>"
+
     Miniparse.help_usage_format(right_text)
   end
 
@@ -141,19 +139,16 @@ protected
     commander.current_broker || global_broker
   end
 
-  def try_argument
-    #FIXME
-    begin
-      yield
-    rescue ArgumentError => except
-      raise    unless Miniparse.control(:rescue_argument_error)
-      prg = File.basename($PROGRAM_NAME)
-      $stderr.puts "#{prg}: error: #{except.message}"
-      $stderr.puts
-      $stderr.puts help_usage
-      # (#{except.backtrace[-1]})")
-      exit ERR_ARGUMENT
-    end
+  def try_argument(&block)
+    block.call
+  rescue ArgumentError => except
+    raise    unless Miniparse.control(:rescue_argument_error)
+    prg = File.basename($PROGRAM_NAME)
+    $stderr.puts "#{prg}: error: #{except.message}"
+    $stderr.puts
+    $stderr.puts help_usage
+    # (#{except.backtrace[-1]})")
+    exit ERR_ARGUMENT
   end
     
 end

data/lib/miniparse/version.rb

@@ -1,8 +1,8 @@
 module Miniparse
 
 
-# semantic versioning MAJOR.MINOR.PATCH [b]eta
-VERSION = "0.3.3"
+# semantic versioning MAJOR.MINOR.PATCH [pre]release
+VERSION = "0.4.0"
 
 
 

data/miniparse.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Juanma Rodriguez"]
   spec.email         = ["jmrod4@gmail.com"]
 
-  spec.summary       = %q{Miniparse is an easy to use yet flexible and powerful ruby library for parsing command-line options.}
+  spec.summary       = %q{miniparse is an easy to use yet flexible and powerful Ruby library for parsing command-line options.}
 #  spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/jmrod4/miniparse"
   spec.license       = "MIT"
@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  
+  spec.required_ruby_version = "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miniparse
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Juanma Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-20 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,11 +77,13 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - FAQ.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- badge_fun.md
 - bin/console
 - bin/setup
 - examples/ex01_simple.rb
@@ -114,9 +116,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -127,7 +129,7 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Miniparse is an easy to use yet flexible and powerful ruby library for parsing
+summary: miniparse is an easy to use yet flexible and powerful Ruby library for parsing
   command-line options.
 test_files: []
 has_rdoc: