optplus 0.0.8 → 0.0.16

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDU0ODg5OTM1ZjZlNjQ3ZWM4NzA0NGNmYTRhOWY4NWYxYzI0NzJhZg==
-  data.tar.gz: !binary |-
-    NDMzYjM4Y2EyZmQ3MDU4N2RmNjA1MDQ0YTkyM2M4MjdiYTRkMTIxZg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NjRmMGU3Zjg3ZjJmOGI3MDE1MDJlODBlM2U5NWQ1NjA3ZjQyYzBmODg3OWM5
-    MzA5YTE1ODRlMDNmMTdmYmNjYjhjNmQzNmRmZmRhMDM3YmZkMzJhOWQ5MGFj
-    ZGM0Y2FkNmJjOTRlYjkwN2ZmOGE2MDY5MzkyYzMwZGUzZTY1YzA=
-  data.tar.gz: !binary |-
-    YWZkNDdlMzBmNzI5OTMwOTc4MGFlNDU5Njg4NGViNDE0Njk0ZDFhOTcwMmU3
-    NDQ4ZDI1NTFmMjQ3ODQzODQ5MmM2NzJlZmYyZTZmMjVmOGZlOWFlMTc5YTUz
-    MDUyYWFkYzI2MTI1MzUwOWQ0MzRiNGE4MzY0ZDZiOWM2ZmE5NWI=
+SHA1:
+  metadata.gz: 837e2be0083321ed2ac1f4c2f7bc55c1364d5c1d
+  data.tar.gz: e6f5c0104b89eefa6d90a7a4fe37087820e95a77
+SHA512:
+  metadata.gz: 90149013724f89a2d134c9092ee2714704113cf7a3edf0375f72fe7b77654ce103cd41ccef1443ddce4d20751ac6326144ad4337ea580deac499453d1cae47e0
+  data.tar.gz: 2d285f5e7484927b1ce73e87cef4b98b7f5f4d84dade24b4461938f7e69216f9593effaade57b7742c4383e9c53a33785c70d04ab1c5caa4c61da935b5c0226a

data/Bugs.rdoc

@@ -1,5 +1,5 @@
 == Outstanding Bugs and Change Requests for Optplus
 
-[30-Aug-2013]
+[06-Nov-2014]
 
-  * Need to implement the project!
+  * Fails in nest_parser if there is no help defined in main class.

data/History.txt

@@ -2,6 +2,38 @@
 # @title Change History
 
 == History
+[optplus-0.0.16 28-Nov-2014]
+
+  Add instance attribute to read options hash
+
+[optplus-0.0.15 12-Dec-2013]
+
+  Clean up spacing etc
+
+[optplus-0.0.14 12-Dec-2013]
+
+  Added in a sort of man facility with --man to print out all the help in one go
+
+[optplus-0.0.13 11-Dec-2013]
+
+  Set IO to output on $stderr - testing in RL to see if this is workable
+
+[optplus-0.0.12 25-Oct-2013]
+
+  Test for @@_help before assuming it exists in nested parser (140)
+
+[optplus-0.0.11 25-Oct-2013]
+
+  Add IO convenience methods for displyaing output and getting responses
+
+[optplus-0.0.10 24-Oct-2013]
+
+  Add empty help hash if no help defined when calling run!
+
+[optplus-0.0.9 24-Oct-2013]
+
+  Drop call to before_all in nested - should be called anyway by run!
+
 [optplus-0.0.8 13-Sep-2013]
 
   Release Candidate with nesting etc.

data/README.md

@@ -49,16 +49,17 @@ Here is a simple example:
       end
       
       describe :show, 'show all of the items that match the string given'
+      
+      help :show, "A more details description of the show action",
+        "that can again spread over multiple lines",
+        "and is displayed when the user types mycli show -h"
+        
       def show
         matches = next_argument_or_error('You must provide a string to match')
         
         # do the stuff
         
       end
-      help :show, "A more details description of the show action",
-        "that can again spread over multiple lines",
-        "and is displayed when the user types mycli show -h"
-        
     end
     
     Mycli.run! # don't forget!
@@ -104,11 +105,11 @@ Using Optplus involves the following:
   
 > **describe** -- links an action (as a symbol) to a one line description.
 
-> **action_ method** -- for the action itself, having the same name as the symbol above
-
 > **help** - links the action to multi-line help text that will be displayed when
   the --help option is used with the action
 
+> **action_ method** -- for the action itself, having the same name as the symbol above
+
 * And finally, if you need to tidy up afterwards you can define an after_actions
   method.
 
@@ -142,6 +143,10 @@ simply by calling helper methods:
 You can change the short-form switch by adding a different one:
 
     debug_option(opts, '-d') 
+    
+Finally, there is a "--man" switch that generates a help manual (a bit like man)
+by concatenating all of the help definitions into a single output. Particularly
+useful if you have a complex utility with nested actions (see below).
 
 ### Options helpers
 
@@ -168,6 +173,11 @@ For example:
     
 You can always define instance variables if you prefer.
 
+### IO
+
+Optplus uses a module of {Optplus::IO IO} helpers to provide coloured output and to ease asking
+simple questions. Note all of the outputs are to $stderr rather than $stdout.
+
 ### Handling Errors
 
 Optplus should take care of parsing errors and the like without you having to get involved.

data/lib/optplus.rb

@@ -97,6 +97,7 @@ module Optplus
       def run!
         
         @_parent ||= nil
+        @_help ||= Hash.new
         
         begin
           me = self.new
@@ -201,6 +202,7 @@ module Optplus
       @klass = self.class
       @klass._help ||= Hash.new
       @_help = false
+      @_man = false
       @options = Hash.new
       
       self.before_all if self.respond_to?(:before_all)
@@ -245,6 +247,11 @@ module Optplus
             @_help = true
           end
           
+          opts.on_tail('--man', 'output man-like help') do
+            @_help = true
+            @_man = true
+          end
+          
         end
   
         @_args = @_optparse.permute(ARGV)
@@ -262,6 +269,9 @@ module Optplus
     # provides convenient access to the name of the program
     attr_reader :program_name
     
+    # provides access to all the options set
+    attr_reader :options
+    
     # add optparse option for debug mode
     #
     # @param [Optparse] opts being the optparse instance
@@ -328,8 +338,11 @@ module Optplus
     
     
     # @!visibility private
-    def _get_help
-      puts @_optparse.help
+    def _get_help(indent=0)
+      prefix = " " * indent
+      @_optparse.help.split("/n").each do |line|
+        puts prefix + line
+      end
       puts ""
     end
     
@@ -374,6 +387,10 @@ module Optplus
     
     # @!visibility private
     def _help_me
+      if @_man then
+        self.man
+        return
+      end
       # is there an action on the line?
       if _args.length > 0 then
         # yes, but is it legit?
@@ -411,6 +428,38 @@ module Optplus
       
     end
     
+    # output all the help in one go!
+    def man
+      puts "Help Manual for #{@program_name}"
+      puts ""
+      _get_help
+      @klass._help.each_pair do |action, help|
+        puts "Action: #{action}"
+        puts ""
+        if help.kind_of?(Array) then
+          help.each do |hline|
+            puts "  " + hline
+          end
+        else
+
+          np = help.new(self)
+          np._get_help(2)
+          puts ""
+          
+          help._help.each_pair do |subaction, subhelp|
+            puts "  Subaction: #{subaction}"
+            puts ""
+            subhelp.each do |hline|
+              puts "    " + hline
+            end
+            puts ""
+          end
+        end
+        puts " "
+      end
+      puts ""
+    end #man
+    
   end
 
 end

data/lib/optplus/IO.rb

@@ -0,0 +1,69 @@
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+# 
+#
+require 'colored'
+
+module Optplus
+  
+  # bunch of convenience methods to output messages and get inputs for
+  # command-line scripts
+  module IO
+    
+    # lookup to map between symbols and responses
+    Answers = Hash.new(false).merge({:no=>'n', :yes=>'y', :skip=>'s', :diff=>'d', :list=>'l'})
+    
+    def say(txt)
+      $stderr.puts txt
+    end
+    
+    def say_ok(txt)
+      $stderr.puts txt.green
+    end
+    
+    def warn(txt)
+      $stderr.puts txt.yellow
+    end
+    
+    def alert(txt)
+      $stderr.puts txt.red.bold
+    end
+    
+    def ask(question, default=:no, answers=nil)
+      answers ||= Answers
+      default = answers.keys.first unless answers.has_key?(default)
+      def_key = answers[default]
+      answer_options = answers.values.collect {|k| k == def_key ? k.upcase : k}.join('')
+      loop do
+        $stderr.print "#{question}(#{answer_options})? "
+        response = $stdin.gets[0,1].downcase
+        if response == '?' then
+          answers.each_pair do |key, val|
+            $stderr.puts "#{key}"
+          end
+          next
+        end
+        if answers.has_value?(response) then
+          return answers.key(response)
+        else
+          return default
+        end
+      end
+      
+    end
+    
+    def continue?(question, default=false)
+      def_response = default ? :yes : :no
+      response = ask(question, def_response, {:yes=>'y', :no=>'n'})
+      return response == :yes
+    end
+    
+  end
+end

data/lib/optplus/nested.rb

@@ -77,7 +77,7 @@ module Optplus
       @klass = self.class
       @_parent = parent || @klass._parent
       self.before_all if self.respond_to?(:before_all)
-      self.before_actions if self.respond_to?(:before_actions)
+      #self.before_actions if self.respond_to?(:before_actions)
     end
     
     # @!visibility private
@@ -127,30 +127,38 @@ module Optplus
     end
     
     # @!visibility private
-    def _get_help
+    def _get_help(indent=0)
+      helps = []
+      prefix = " " * indent
+      
       prog_name = File.basename($0, File.extname($0))
-      puts "Usage: #{prog_name} #{self.class._banner}"
-      puts ""
+      helps << "Usage: #{prog_name} #{self.class._banner}"
+      helps << ""
       self.class._description.each do |line|
-        puts line
+        helps << line
       end
-      puts ""
+      helps << ""
       flags = 0
       self.class._descriptions.each_pair do |action, description|
-        flag = @klass._help.has_key?(action.to_sym) ? '(-h)' : ''
+        flag = @klass._help && @klass._help.has_key?(action.to_sym) ? '(-h)' : ''
         flags += 1 unless flag == ''
-        puts "  #{action} - #{description} #{flag}"
+        helps << "  #{action} - #{description} #{flag}"
       end
           
       if flags > 0 then
-        puts ""
-        puts "  (-h indicates actions with additional help)"
-        puts ""
+        helps << ""
+        helps << "  (-h indicates actions with additional help)"
+        helps << ""
       end
             
-      puts ""
-      puts "For full details of options etc:"
-      puts "  #{prog_name} -h"
+      helps << ""
+      helps << "For full details of options etc:"
+      helps << "  #{prog_name} -h"
+      
+      helps.each do |hline|
+        puts prefix + hline
+      end
+      
     end
 
     

data/lib/optplus/version.rb

@@ -1,13 +1,13 @@
 # Created by Jevoom
 #
-# 13-Sep-2013
-#   Release Candidate with nesting etc.
+# 28-Nov-2014
+#   Add instance attribute to read options hash
 
 module Optplus
-  # version set to 0.0.8
-  Version = '0.0.8'
-  # date set to 13-Sep-2013
-  Version_Date = '13-Sep-2013'
-  #ident string set to: optplus-0.0.8 13-Sep-2013
-  Ident = 'optplus-0.0.8 13-Sep-2013'
+  # version set to 0.0.16
+  Version = '0.0.16'
+  # date set to 28-Nov-2014
+  Version_Date = '28-Nov-2014'
+  #ident string set to: optplus-0.0.16 28-Nov-2014
+  Ident = 'optplus-0.0.16 28-Nov-2014'
 end

data/test/io.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+#
+#
+#
+# = Test IO
+#
+# == Optplus
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+#
+
+require 'optplus/IO'
+
+include Optplus::IO
+
+say "hello"
+
+say_ok "That's OK"
+
+warn "This is getting tricky"
+
+alert "Too late!"
+
+if ask("Overwrite?") == :yes then
+  warn "Overwriting"
+else
+  alert "You really should have"
+end
+
+if continue?("Do you want to continue?") then
+  say_ok "Continuing"
+else
+  warn "Not continuing"
+end
+
+if continue?("Do you want to stop?", true) then
+  say_ok "Stopped"
+else
+  warn "Not stopping"
+end
+
+colour = ask("What colour?", :red, {red:'r', green:'g', blue:'b'})
+
+say "You chose #{colour.to_s}"
+  

metadata

@@ -1,36 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: optplus
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.16
 platform: ruby
 authors:
 - Dr Robert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    Y29sb3JlZA==
+  name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Wraps Optparser into a class to enable thor-like scripting with a
-  few meta-methods
-
+description: |-
+  Wraps Optparser into a class to enable thor-like scripting with a few meta-methods
   and a built-in command or action dispatcher. Its much smaller than Thor and aimed
-
-  at saving time when scripting with Optparser.'
+  at saving time when scripting with Optparser.
 email: robert@osburn-sharp.ath.cx
 executables:
 - optplus
@@ -53,6 +50,7 @@ files:
 - lib/optplus/version.rb
 - lib/optplus/errors.rb
 - lib/optplus/nested.rb
+- lib/optplus/IO.rb
 - lib/optplus.rb
 - bin/optplus
 - bin/optplus-installer
@@ -61,7 +59,8 @@ files:
 - test/conf.d/optplus.rb
 - test/my_parser.rb
 - test/my_nested_parser.rb
-homepage: ''
+- test/io.rb
+homepage: https://github.com/osburn-sharp
 licenses:
 - Open Software Licence v3.0
 metadata: {}
@@ -72,17 +71,17 @@ 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.0.7
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A simple wrapper class to make optparser-based scripts easy to write.