miniparse 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb31188afaf39cf89e8fdf5dfdc46b75dfe97017
-  data.tar.gz: 7544b57ab5bd3e29a7e4b9d8ecfbaec360bfe654
+  metadata.gz: 4542b4d6cc48edf83bbe51d1d40628635582be4b
+  data.tar.gz: e811d691eccf6f72f88e19e440ba51ff0293d933
 SHA512:
-  metadata.gz: d2c3f7f297e25205d8c8e227ba62192aa104b1f85df79439d178e0751b617b042f286ee04348fa46e00ba8b04c2a5276bfd536a19277c87fb7c9d2923c2b2de4
-  data.tar.gz: 85f6fe46c54f8026d96d4c4edb11289fe39bd7e2c0f13481d88a438c3f9fd4fdc8f00f1ddb279ac8c39848535d961280b82062eea5e72c77400d6356b605bc50
+  metadata.gz: 70582bc36e4956f8f61dee11a0401edc83c23ad4df9daf6ec2481fbcedb76a3db0fa2642d4521717606ceec675dfd3a95bc79543288913a8f52a24b141c1fba8
+  data.tar.gz: 99f7f80c4a86ed3cb4cbfe347b0e57a9316595cfd5739bbce381b58368d618c27c3c41fff7e5c3487753fbdc7c16701ce4adc3928b649b60e7bb5872a0eefc40

data/README.md

@@ -15,7 +15,7 @@ Let's try putting the following code in `myprogram.rb`
 
     require 'miniparse'
     
-    parser = Miniparse::Parser.new("my program does something wonderful")
+    parser = Miniparse::Parser.new
     parser.add_option "--debug", "activate debugging"
     parser.parse ARGV
     
@@ -41,7 +41,6 @@ or even get the auto generated help
     
     $ ruby yourprogram.rb --help
     
-    my program does something wonderful
     usage: ex01_readme.rb [--help] [--debug] <args>
 
     Options:

data/examples/ex01_simple.rb

@@ -2,7 +2,8 @@
     
 require 'miniparse'
 
-parser = Miniparse::Parser.new("my program does something wonderful")
+parser = Miniparse::Parser.new
+parser.add_program_description "my program help msg introduction\n"
 parser.add_option "--debug", "activate debugging"
 parser.parse ARGV
 

data/examples/ex08_app_simple.rb

@@ -1,10 +1,10 @@
 require "miniparse/app"
 
-# the help introduction can be omitted 
-App.configure_parser("my program help introduction\n") do |parser|
+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
 end
@@ -16,6 +16,7 @@ App.info App.options    # to stdout
 App.warn App.options    # to stderr
 App.error App.options   # to stderr (note: it doesn't exit)
 
+# you have direct access to the parser object
 puts "parser object: #{App.parser}"
 
 puts 'Done.'

data/lib/miniparse/app.rb

@@ -8,7 +8,6 @@ module App
 
   @parser = nil
   @do_configure_parser = lambda { |parser| parser.parse ARGV }
-  @program_desc = nil
   
   def self.error(msg)
     $stderr.puts "error: #{msg}"  
@@ -30,9 +29,8 @@ module App
     parser.options  
   end
 
-  def self.configure_parser(program_description = nil,&block)
+  def self.configure_parser(&block)
     reset_parser
-    @program_desc = program_description
     @do_configure_parser = block
     nil    
   end
@@ -40,7 +38,7 @@ module App
   # lazy parser creation  
   def self.parser
     return @parser   if @parser
-    @parser = Miniparse::Parser.new(@program_desc)
+    @parser = Miniparse::Parser.new
     parser.add_option("--debug", nil, negatable: false)
     @do_configure_parser.call(parser)
     parser

data/lib/miniparse/parser.rb

@@ -6,7 +6,8 @@ module Miniparse
 class Parser
 
   # @return after parsing (i.e. specified) rest of arguments 
-  attr_reader :args, :program_desc
+  attr_reader :args
+  
   # @return parsed (i.e. specified) global options
   def options; global_broker.parsed_values; end
   
@@ -19,9 +20,9 @@ class Parser
   def current_command; commander.current_command; end
 
   
-  def initialize(program_description = nil)
+  def initialize
     @commander = Commander.new
-    @program_desc = program_description     
+    @program_desc = nil     
     @global_broker = OptionBroker.new do
       print program_desc + "\n"    if program_desc
       print help_usage + "\n"
@@ -29,7 +30,13 @@ class Parser
       exit ERR_HELP_REQ
     end
   end
-
+  
+  
+  def add_program_description(desc)
+    @program_desc = desc
+  end
+  
+  
   # @param spec is the option specification, similar to the option invocation 
   # in the command line (ex. "--debug" or "--verbose LEVEL")
   #
@@ -108,7 +115,7 @@ class Parser
 
 protected
 
-  attr_reader :commander, :global_broker
+  attr_reader :commander, :global_broker, :program_desc
 
   def current_broker
     commander.current_broker || global_broker

data/lib/miniparse/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miniparse
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Juanma Rodriguez