miniparse 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da37b3c087a37bccf31e7bbd7d5e45004da9bddf
-  data.tar.gz: 252751025abef7a40242c19649b99c76f402442c
+  metadata.gz: fb31188afaf39cf89e8fdf5dfdc46b75dfe97017
+  data.tar.gz: 7544b57ab5bd3e29a7e4b9d8ecfbaec360bfe654
 SHA512:
-  metadata.gz: f13f8964d343a8c70515e99bfcc6d8c14531c9dcff8f03be7ad052cc019eaa00c7491b2491d869e89cf0b959e513c68a17f5857d928fc5e56de2aa7243ff89f1
-  data.tar.gz: 59e8323b94edab1f83633dd37641bdfc30dff30cc5df688c3171f09020adb60d4f0182a6eaca703cdbdab70b1e943abaae4d475f2aeb84adf47573f1a503c3e0
+  metadata.gz: d2c3f7f297e25205d8c8e227ba62192aa104b1f85df79439d178e0751b617b042f286ee04348fa46e00ba8b04c2a5276bfd536a19277c87fb7c9d2923c2b2de4
+  data.tar.gz: 85f6fe46c54f8026d96d4c4edb11289fe39bd7e2c0f13481d88a438c3f9fd4fdc8f00f1ddb279ac8c39848535d961280b82062eea5e72c77400d6356b605bc50

data/examples/ex02_options.rb

@@ -2,9 +2,13 @@ require 'miniparse'
 
 parser = Miniparse::Parser.new
 
-parser.add_option("--sort", "always sort the output", shortable: true)
-parser.add_option("--pill", "just a silly option", shortable: true)
+parser.add_option("--sort", "always sort the output", 
+    shortable: true)
 
+# a negatable option can be specified as '--option' or '--no-option'    
+parser.add_option("--pill", "just a silly option", 
+    shortable: true, negatable: true)
+    
 # if description is nil, then the option won't appear in the help description, only in the usage string
 parser.add_option("--debug", nil)
 

data/examples/ex08_app_simple.rb

@@ -0,0 +1,21 @@
+require "miniparse/app"
+
+# the help introduction can be omitted 
+App.configure_parser("my program help introduction\n") do |parser|
+  Miniparse.set_control(
+      autoshortable: true,
+      )
+  parser.add_option("--list", "list something")
+  parser.parse ARGV
+end
+
+# to see App.debug you have to specify the --debug option
+# for example: 'ruby ex08_app_simple.rb --debug' 
+App.debug App.options   # to stdout
+App.info App.options    # to stdout
+App.warn App.options    # to stderr
+App.error App.options   # to stderr (note: it doesn't exit)
+
+puts "parser object: #{App.parser}"
+
+puts 'Done.'

data/lib/miniparse/app.rb

@@ -8,6 +8,7 @@ module App
 
   @parser = nil
   @do_configure_parser = lambda { |parser| parser.parse ARGV }
+  @program_desc = nil
   
   def self.error(msg)
     $stderr.puts "error: #{msg}"  
@@ -29,21 +30,23 @@ module App
     parser.options  
   end
 
-  def self.configure_parser(&block)
+  def self.configure_parser(program_description = nil,&block)
     reset_parser
-    @do_configure_parser = block     
+    @program_desc = program_description
+    @do_configure_parser = block
+    nil    
   end
   
   # lazy parser creation  
   def self.parser
     return @parser   if @parser
-    @parser = Miniparse::Parser.new
+    @parser = Miniparse::Parser.new(@program_desc)
     parser.add_option("--debug", nil, negatable: false)
     @do_configure_parser.call(parser)
     parser
   end     
     
-  # unset the parser (but doesn't affect the configuration)
+  # re-initialize the parser (but doesn't affect the configuration)
   def self.reset_parser
     @parser = nil
   end

data/lib/miniparse/option_broker.rb

@@ -6,11 +6,11 @@ class OptionBroker
 
   attr_reader :parsed_values
 
-  def initialize(&block)
+  def initialize(&help_block)
     @parsed_values = {}
     @added_options = {}
-    if block
-      add_option(spec: "--help", negatable: false, &block) 
+    if help_block
+      add_option(spec: "--help", negatable: false, &help_block) 
     end
   end
 

data/lib/miniparse/parser.rb

@@ -19,15 +19,15 @@ class Parser
   def current_command; commander.current_command; end
 
   
-  def initialize(program_description = '')
+  def initialize(program_description = nil)
+    @commander = Commander.new
+    @program_desc = program_description     
     @global_broker = OptionBroker.new do
-      puts program_desc
-      puts help_usage
-      puts help_desc
+      print program_desc + "\n"    if program_desc
+      print help_usage + "\n"
+      print help_desc + "\n"
       exit ERR_HELP_REQ
     end
-    @commander = Commander.new
-    @program_desc = program_description     
   end
 
   # @param spec is the option specification, similar to the option invocation 

data/lib/miniparse/version.rb

@@ -2,7 +2,7 @@ module Miniparse
 
 
 
-VERSION = "0.3.0"
+VERSION = "0.3.1"
 
 
 

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 a 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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miniparse
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Juanma Rodriguez
@@ -90,6 +90,7 @@ files:
 - examples/ex05_block.rb
 - examples/ex06_task_app.rb
 - examples/ex07_controls.rb
+- examples/ex08_app_simple.rb
 - lib/miniparse.rb
 - lib/miniparse/app.rb
 - lib/miniparse/command.rb
@@ -123,7 +124,7 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Miniparse is a 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: