optplus 0.0.8

data/lib/optplus/errors.rb

@@ -0,0 +1,31 @@
+#
+# 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
+# 
+#
+
+# This file groups together all the errors for optplus.
+# Preceed each class with a description of the error
+
+module Optplus
+
+  # A general class for all errors created by this project. All specific exceptions
+  # should be children of this class
+  class OptplusError < RuntimeError; end
+  
+  # add specific errors as required
+  
+  # description
+  class ParseError < OptplusError; end
+  
+  # force an exit 
+  # @note Should only be used by the exit_on_error method
+  class ExitOnError < OptplusError; end
+
+end

data/lib/optplus/nested.rb

@@ -0,0 +1,159 @@
+#
+#
+# = Next Parser
+#
+# == SubTitle
+#
+# 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'
+
+module Optplus
+  
+  # define a nested parser to add sub-actions to an action
+  #
+  # Useful if you want to group actions together. For example,
+  # if you have a command that does things for services (for example)
+  # and other things for servers (for example) then you can define
+  # a nested parser for each and then define actions 'services' and 'servers'
+  # that use these parsers:
+  #
+  #    my_command servers list --all
+  #    my_command services list --all
+  #
+  # Optplus does not allow option switches to be specific to any one action -
+  # its an everything and everywhere approach.
+  #
+  # Note that NestedParser inherits everything from Parser and could therefore 
+  # nest another parser within itself, ad infinitum. You could also define
+  # methods such as #options which would be a waste because they would never 
+  # be called.
+  #
+  class NestedParser < Optplus::Parser
+    
+    class << self
+      
+      # @!visibility private
+      def run!(parent)
+        # set class attribute so that the instance
+        # can determine its parent class
+        @_parent = parent
+        super()
+      end
+      
+      # @!visibility private
+      attr_reader :_parent
+      
+      #@!visibility private
+      # def _help_me
+      #   prog_name = File.basename($0, File.extname($0))
+      #   puts "Usage: #{prog_name} #{self._banner}"
+      #   puts ""
+      #   self._description.each do |line|
+      #     puts line
+      #   end
+      #   puts ""
+      #   self._descriptions.each_pair do |action, description|
+      #     puts "  #{action} - #{description}"
+      #   end
+      #   puts ""
+      #   puts "For full details of options etc:"
+      #   puts "  #{prog_name} -h"
+      # end
+      
+    end # class << self
+    
+    # @!visibility private
+    def initialize(parent=nil)
+      @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)
+    end
+    
+    # @!visibility private
+    def _parent
+      @_parent
+    end
+    
+    # @!visibility private
+    def _args
+      _parent._args
+    end
+    
+    # return the next argument, if there is one or nil otherwise
+    # @see Optplus::Parser#next_argument
+    def next_argument
+      _parent.next_argument
+    end
+    
+    # return the next argument or the given default
+    # @see Optplus::Parser#next_argument
+    def next_argument_or(default)
+      _parent.next_argument_or(default)
+    end
+    
+    #  return the next argument or raise exception with the given message
+    # @see Optplus::Parser#next_argument
+    def next_argument_or_error(message)
+      _parent.next_argument_or_error(message)
+    end
+    
+    # return all of the remaining args, or an empty array
+    # @see Optplus::Parser#next_argument
+    def all_arguments
+      _parent.all_arguments
+    end
+    
+    # get the value of the option
+    # @see Optplus::Parser#next_argument
+    def get_option(key)
+      _parent.get_option(key)
+    end
+    
+    #  check if the option has been set
+    # @see Optplus::Parser#next_argument
+    def option?(key)
+      _parent.option?(key)
+    end
+    
+    # @!visibility private
+    def _get_help
+      prog_name = File.basename($0, File.extname($0))
+      puts "Usage: #{prog_name} #{self.class._banner}"
+      puts ""
+      self.class._description.each do |line|
+        puts line
+      end
+      puts ""
+      flags = 0
+      self.class._descriptions.each_pair do |action, description|
+        flag = @klass._help.has_key?(action.to_sym) ? '(-h)' : ''
+        flags += 1 unless flag == ''
+        puts "  #{action} - #{description} #{flag}"
+      end
+          
+      if flags > 0 then
+        puts ""
+        puts "  (-h indicates actions with additional help)"
+        puts ""
+      end
+            
+      puts ""
+      puts "For full details of options etc:"
+      puts "  #{prog_name} -h"
+    end
+
+    
+  end
+  
+end

data/lib/optplus/version.rb

@@ -0,0 +1,13 @@
+# Created by Jevoom
+#
+# 13-Sep-2013
+#   Release Candidate with nesting etc.
+
+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'
+end

data/spec/optplus_spec.rb

@@ -0,0 +1,41 @@
+#
+# 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 File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'optplus/config'
+require 'optplus/errors'
+require 'jellog'
+
+conf_file = File.expand_path(File.dirname(__FILE__) + '/../test/conf.d/optplus.rb')
+
+describe Optplus do
+
+  before(:all) do
+    @params = Optplus::Config.new(conf_file)
+    Jellog::Logger.disable_syslog
+  end
+
+  before(:each) do
+    @optplus = Optplus::Service.new("Testkey", @params)
+  end
+
+  after(:each) do
+    @optplus.stop_callback("Testkey")
+  end
+
+
+  it "should do what you want" do
+    pending "Need to do something here"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.delete('/usr/local/lib')
+require 'optplus'
+require 'rspec'
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = :doc
+  
+end

data/test/conf.d/optplus.rb

@@ -0,0 +1 @@
+Error: could not load lib/optplus/config.rb

data/test/my_nested_parser.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+#
+# 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'
+require 'optplus/nested'
+
+
+class MyParser < Optplus::Parser
+  
+  usage "[options] action"
+    
+  description "A simple test",
+    "that tells you little"
+    
+  def before_all
+    set_option :env, :dev
+  end
+
+
+  # define the options for this command
+  def options(opts)
+    opts.on('-a', '--all', 'show me everything') do
+      set_option :all
+    end
+    opts.on('-A', '--altogether', 'show me everything, really') do
+      set_option :altogether
+    end
+    opts.on('-e', '--environment TYPE', [:dev, :dec, :test, :prod], 'specify the environment') do |env|
+      set_option :env, env
+    end
+    opts.on('-s', '--sob [String]', String, 'sob when telling truth') do |cry|
+      set_option :sob, cry
+    end
+    
+    debug_option(opts)
+  end
+  
+  # define things that need to be done before any actions
+  def before_actions
+    @secrets = ['The answer to the universe is 42',
+      'The mystery man is Blake',
+      'The beginning of the Universe is the wrong question'
+    ]
+  end
+  
+  def after_actions
+    puts "Tidying and Cleaning..."
+    sleep 1.0
+    puts "All done"
+  end
+  
+  describe :show, "Show me what you know"
+  def show
+    unless get_option :all
+      puts "I know nothing"
+    else
+      puts "OK I will tell you everything"
+      puts get_option :sob if option? :sob
+      puts "You're in: #{get_option :env}"
+      @secrets.each do |secret|
+        puts secret
+      end
+      puts get_option :sob if option? :sob
+    end
+  end
+  help :show, "You can use this to find out what I know",
+    "If you persist with options I may tell you more"
+  
+  describe :about, "Tell me about something"
+  def about
+    subject = all_arguments.join(' ')
+    if subject then
+      puts "I know nothing about #{subject}"
+    else
+      puts "Sorry, what do you want to know about?"
+    end
+  end
+  
+  describe :sheep, "All about sheep"
+  def sheep
+    puts "Baaaa"
+  end
+  
+  class Question < Optplus::NestedParser
+    
+    usage "question aspect"
+    
+    description "ask a question about a particular aspect"
+    
+    describe :work, "Ask about work-related things"
+    def work
+      puts "I am unemployed"
+    end
+    
+    describe :home, "Ask about home related things"
+    def home
+      topic = next_argument_or('Cooking')
+      puts "I don't do #{topic} at home"
+    end
+    help :home, "suggest something I might do at home, such as ",
+      "cleaning or painting"
+    
+    describe :errors, "Ask me about errors"
+    def errors
+      if get_option :altogether
+        exit_on_error("Error: I know nothing about errors")
+      end
+      exit_on_error
+    end
+    
+  end
+  
+  nest_parser :question, Question, "Interrogate in more detail"
+  
+end
+
+
+
+MyParser.run!

data/test/my_parser.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+#
+# 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'
+
+
+class MyParser < Optplus::Parser
+  
+  usage "[options] action"
+    
+  description "A simple test",
+    "that tells you little"
+    
+  def before_all
+    set_option :env, :dev
+  end
+
+
+  # define the options for this command
+  def options(opts)
+    opts.on('-a', '--all', 'show me everything') do
+      set_option :all
+    end
+    opts.on('-A', '--altogether', 'show me everything, really') do
+      set_option :altogether
+    end
+    opts.on('-e', '--environment TYPE', [:dev, :dec, :test, :prod], 'specify the environment') do |env|
+      set_option :env, env
+    end
+    opts.on('-s', '--sob [String]', String, 'sob when telling truth') do |cry|
+      set_option :sob, cry
+    end
+    
+    debug_option(opts)
+  end
+  
+  # define things that need to be done before any actions
+  def before_actions
+    @secrets = ['The answer to the universe is 42',
+      'The mystery man is Blake',
+      'The beginning of the Universe is the wrong question'
+    ]
+  end
+  
+  describe :show, "Show me what you know"
+  def show
+    unless get_option :all
+      puts "I know nothing"
+    else
+      puts "OK I will tell you everything"
+      puts get_option :sob if option? :sob
+      puts "You're in: #{get_option :env}"
+      @secrets.each do |secret|
+        puts secret
+      end
+      puts get_option :sob if option? :sob
+    end
+  end
+  help :show, "You can use this to find out what I know",
+    "If you persist with options I may tell you more"
+  
+  describe :about, "Tell me about something"
+  def about
+    subject = all_arguments.join(' ')
+    if subject then
+      puts "I know nothing about #{subject}"
+    else
+      puts "Sorry, what do you want to know about?"
+    end
+  end
+  
+  describe :sheep, "All about sheep"
+  def sheep
+    puts "Baaaa"
+  end
+  
+end
+
+MyParser.run!