zabcon 0.0.350 → 0.0.356

data/libs/command_tree.rb

@@ -70,7 +70,8 @@ class ZabconExecuteCommand < ZabconExecuteBase
     @proc=cmd_obj.command_obj.method(:execute)
     @command_obj=cmd_obj.command_obj
     begin
-      arg_result=@command_obj.call_arg_processor(cmd_obj.parameters)
+      arg_result=@command_obj.call_tokenizer(cmd_obj.parameters)
+      arg_result=@command_obj.call_arg_processor(arg_result)
     #TODO Fix showing help messages
     #rescue ParameterError => e
     #  e.help_func=cmd_obj.command_obj.help_method
@@ -80,6 +81,7 @@ class ZabconExecuteCommand < ZabconExecuteBase
     @show_params=arg_result.show_params
     @printing=cmd_obj.command_obj.print?
     @command_name=cmd_obj.command_obj.command_name
+
 #    @help=cmd_obj.help
 #    @options=options
 
@@ -115,47 +117,11 @@ class ZabconExecuteContainer
   attr_reader :show_params, :results, :options
 
   def initialize(tokens)
-#    @initial_string=usr_str
     @initial_tokens=tokens
     @commands=[]
     @printing=true
     commandlist=CommandList.instance
 
-#    tokens=ExpressionTokenizer.new(usr_str)
-
-    #split_str=usr_str.split2(:split_char=>'=|\s', :include_split=>true)
-    #
-    #unravel=false  #remove any extra space before the first =
-    #split_str2=split_str.map {|item|
-    #  if unravel
-    #    item
-    #  elsif item=="="
-    #    unravel=true
-    #    item
-    #  elsif item.empty?
-    #    nil
-    #  elsif item.scan(/\s/).empty?
-    #    item
-    #  else
-    #    nil
-    #  end
-    #}.delete_if {|i| i.nil?}
-    #
-    #if !split_str2[1].nil? && split_str2[1]=='='
-    #  split_str=split_str2  #use the trimmed version
-    #  var_name=split_str[0].strip
-    #  raise ParseError.new("Variable names cannot contain spaces or invalid characters \"#{var_name}\"",:retry=>true) if !var_name.scan(/[^\w]/).empty?
-    #
-    #  debug(5,:var=>var_name,:msg=>"Creating Variable assignment")
-    #  add(ZabconExecuteVariable.new(var_name))
-    #
-    #  usr_str=split_str[2..split_str.length-1].join.strip
-    #  debug(5,:var=>usr_str,:msg=>"Continuging to parse with")
-    #end
-    #
-    #debug(6,:var=>split_str,:msg=>"Split Str")
-    #debug(6,:var=>split_str2,:msg=>"Split Str2")
-    #debug(6,:var=>usr_str,:msg=>"User Str")
     pos=tokens.walk(0)
     if (positions=tokens.assignment?(pos,:return_pos=>true))
       var_name = tokens[positions[0]].value
@@ -164,11 +130,18 @@ class ZabconExecuteContainer
       tokens=tokens.drop(positions[2]+1)
     end
 
-    cmd_str=tokens.map{|i| i.value}.join
+    cmd_str=tokens.map{|i|
+      if i.kind==:variable
+        name=/^\$(.*)/.match(i.value)[1]
+        GlobalVars.instance[name] || env[name]
+      else
+        i.value
+      end
+      }.join
+
     debug(5,:msg=>"Command String",:var=>cmd_str)
     cmd=commandlist.find_and_parse(cmd_str)
     add(ZabconExecuteCommand.new(cmd))
-
   end
 
   def print?
@@ -253,6 +226,11 @@ class Command
     end
   end
 
+  #Command Error
+  #Raised whenever there is a problem with a command configuration
+  class CommandError < ZError
+  end
+
   class NonFatalError < Exception
   end
 
@@ -286,11 +264,29 @@ class Command
     #current parameters list for validity.
     @argument_processor=nil
     @tokenizer=ExpressionTokenizerHash
+    @tokenizer_method=nil
 
     @help_tag=nil
     @depreciated=nil
   end
 
+  def deprecate_function(new_func)
+    #probe the stack to find the deprecated function name
+    caller[0]=~/`(.*?)'/
+    function=$1
+
+    #probe the stack again to find the command definition
+    caller[1]=~/(.*):(\d+).*/
+    path=$1
+    line_num=$2
+
+    warn("Command definition Warning")
+    warn("  \"#{function}\" is depreciated and may be removed in future versions")
+    warn("  use \"#{new_func}\".  Command: \"#{command_name}\", line number #{line_num}")
+    warn("  Path: #{path}")
+    warn("  Fixing the command definition will remove this warning.")
+  end
+
   def command_name
     @path.join(" ")
   end
@@ -350,11 +346,18 @@ class Command
     @depreciated=str
   end
 
-  def arg_processor(&block)
-    @argument_processor=block
+  def arg_processor(method=nil,&block)
+    raise CommandError.new("arg_processor cannot be passed a method and a block") if !method.nil? && !block.nil?
+
+    if !method.nil?
+      @argument_processor=method
+    else
+      @argument_processor=block
+    end
   end
 
   def set_arg_processor(method)
+    deprecate_function("arg_processor")
     @argument_processor=method
   end
 
@@ -363,9 +366,28 @@ class Command
   end
 
   def set_tokenizer(tokenizer)
+    deprecate_function("tokenizer")
     @tokenizer=tokenizer
   end
 
+  def tokenizer(tokenizer=nil,&tokenizer_method)
+    #Check to see that tokenizer is a descendant of Tokenizer
+    #Returns False or nil if for negative results
+    if !tokenizer.nil? && (tokenizer <= Tokenizer)
+      @tokenizer=tokenizer
+    else
+      p tokenizer
+      raise CommandError.new("Tokenizer must be a descendant of the Tokenizer Class")
+    end
+
+    if tokenizer_method
+      if tokenizer_method.arity!=1
+        CommandError.new("Tokenizer blocks require an arity of one")
+      end
+      @tokenizer_method=tokenizer_method
+    end
+  end
+
   #--
   #TODO Complete type casting section and add error checking
   #++
@@ -416,13 +438,19 @@ class Command
     end
   end
 
-  def call_arg_processor(parameters)
+  def call_tokenizer(parameters)
     debug(6,:msg=>"parameters",:var=>"\"#{parameters.to_s}\"")
     debug(7,:msg=>"Using tokenizer", :var=>@tokenizer.to_s)
-    tokenized_parameters=@tokenizer.new(parameters).parse
+    tokenized_parameters=@tokenizer.new(parameters)
+    tokenized_parameters=@tokenizer_method.call(tokenized_parameters) if @tokenizer_method
     debug(7,:msg=>"Tokenized Parameters",:var=>tokenized_parameters)
-    check_parameters(tokenized_parameters)
-    @arguments=Arguments.new(tokenized_parameters, @flags)
+    tokenized_parameters.parse
+  end
+
+  def call_arg_processor(parameters)
+    debug(6,:msg=>"parameters",:var=>"\"#{parameters.to_s}\"")
+    check_parameters(parameters)
+    @arguments=Arguments.new(parameters, @flags)
     debug(6,:var=>@arguments)
     @arguments
   end

data/libs/lexer.rb

@@ -32,6 +32,26 @@ require 'libs/zabcon_exceptions'
 #require 'zbxapi/exceptions'
 #require "zbxapi/zdebug"
 
+class InvalidCharacterSuper <ZabconError
+  attr_accessor :invalid_char, :invalid_str, :position
+
+  def initialize(message=nil, params={})
+    super(message,params)
+    @message=message || "Invalid Character"
+    @position=params[:position] || nil
+    @invalid_char=params[:invalid_char] || nil
+    @invalid_str=params[:invalid_str] || raise(RuntimeError.new(":invalid_str required",:retry=>false))
+  end
+
+  def show_message
+    preamble="#{@message}  \"#{@invalid_char}\" : "
+    pointer="^".rjust(@position+preamble.length+1)
+    puts preamble+@invalid_str
+    puts pointer
+  end
+end
+
+
 #This is a wrapper class for creating a generalized lexer.
 class Lexr
 
@@ -92,7 +112,7 @@ class Lexr
       @res = rule.match(unprocessed_text)
 		  next unless @res
 
-      raise Lexr::UnmatchableTextError.new(rule.raises, @position) if @res and rule.raises?
+      raise Lexr::UnmatchableTextError.new(rule.raises, :position=>@position,:invalid_str=>@text) if @res and rule.raises?
 
 		  @position += @res.characters_matched
 		  return self.next if rule.ignore?
@@ -103,7 +123,7 @@ class Lexr
       @position += @res.characters_matched
       return @current = @res.token
     end
-		raise Lexr::UnmatchableTextError.new(unprocessed_text[0..0], @position)
+		raise Lexr::UnmatchableTextError.new(unprocessed_text[0..0], :position=>@position,:invalid_str=>@text)
 	end
 
 	def end?
@@ -121,10 +141,11 @@ class Lexr
 	end
 
 	class Token
-		attr_reader :value, :kind
+		attr_reader :value, :kind, :opts
 
-		def initialize(value, kind = nil)
-			@value, @kind = value, kind
+		def initialize(value, kind = nil, opts={})
+#			@opts, @value, @kind = value, kind, opts
+      @value, @kind, @opts = value, kind, opts
 		end
 
 		def self.method_missing(sym, *args)
@@ -249,16 +270,24 @@ class Lexr
 
 	end
 
-	class UnmatchableTextError < StandardError
-		attr_reader :character, :position
+	class UnmatchableTextError < InvalidCharacterSuper
 
-		def initialize(character, position)
-			@character, @position = character, position
+		def initialize(message=nil, params={})
+      params[:retry]||=true
+      params[:invalid_char]=params[:invalid_str][params[:position]]
+      super(message,params)
 		end
 
 		def message
-			"Unexpected character '#{character}' at position #{position + 1}"
-		end
+			"#{@message} '#{@invalid_char}' at position #{position + 1}"
+    end
+
+    def show_message
+      preamble="#{@message}  : "
+      pointer="^".rjust(@position+preamble.length+1)
+      puts preamble+@invalid_str
+      puts pointer
+    end
 
 		def inspect
 			message
@@ -291,6 +320,7 @@ end
 
 ExpressionLexer = Lexr.setup {
   matches /\\/ => :escape
+#  matches /\\\"/ =>
   matches /\$[\w]+/ => :variable
   matches /"([^"\\]*(\\.[^"\\]*)*)"/ => :quote
   matches /"([^'\\]*(\\.[^'\\]*)*)"/ => :quote
@@ -302,6 +332,7 @@ ExpressionLexer = Lexr.setup {
   matches "]" => :r_square, :decrement=>:square
   matches "," => :comma
   matches /\s+/ => :whitespace
+  matches /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/ => :ipv4
   matches /[-+]?\d*\.\d+/ => :number, :convert_with => lambda { |v| Float(v) }
   matches /[-+]?\d+/ => :number, :convert_with => lambda { |v| Integer(v) }
   matches "=" => :equals
@@ -316,6 +347,7 @@ CommandLexer = Lexr.setup {
   matches /"([^"\\]*(\\.[^"\\]*)*)"/ => :quote
   matches /"([^'\\]*(\\.[^'\\]*)*)"/ => :quote
   matches /\s+/ => :whitespace
+  matches /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/ => :ipv4
   matches /[-+]?\d*\.\d+/ => :number, :convert_with => lambda { |v| Float(v) }
   matches /[-+]?\d+/ => :number, :convert_with => lambda { |v| Integer(v) }
   matches "=" => :equals
@@ -345,23 +377,7 @@ class Tokenizer < Array
     end
   end
 
-  class InvalidCharacter <ZabconError
-    attr_accessor :invalid_char, :invalid_str, :position
-
-    def initialize(message=nil, params={})
-      super(message,params)
-      @message=message || "Invalid Character"
-      @position=params[:position] || nil
-      @invalid_char=params[:invalid_char] || nil
-      @invalid_str=params[:invalid_str] || raise(RuntimeError.new(":invalid_str required",:retry=>false))
-    end
-
-    def show_message
-      preamble="#{@message}  \"#{@invalid_char}\" : "
-      pointer="^".rjust(@position+preamble.length+1)
-      puts preamble+@invalid_str
-      puts pointer
-    end
+  class InvalidCharacter <InvalidCharacterSuper
   end
 
   attr_accessor :parsed
@@ -380,12 +396,40 @@ class Tokenizer < Array
     debug(8,:msg=>"Tokens",:var=>self)
     debug(8,:msg=>"Tokens(Length)",:var=>length)
     @available_tokens=args[:lexer].available_tokens
+    @class_options||=[]
+
+    if @class_options.include?(:remove_whitespace)
+      delete_if do |i|
+        i.kind==:whitespace
+      end
+    end
+
   end
 
   def parse(args={})
     raise BaseClassError.new
   end
 
+  #Creates a factory to dynamicly generate a new descendant object with
+  #the options passed in, which are available via the variable @class_options
+  #*options : array of symbols
+  def self.options(*options)
+    if options.nil?
+      self
+    else
+      class_name=self.to_s+"_"+options.map {|i| i.to_s}.join
+      str =<<-EOF
+        class #{class_name} < self
+          def initialize(str,args={})
+            @class_options=#{options.inspect}
+            super(str,args)
+          end
+        end
+      EOF
+      eval(str)
+      eval(class_name)
+    end
+  end
 end
 
 class BasicExpressionTokenizer < Tokenizer

data/libs/revision.rb

@@ -1 +1 @@
-REVISION=350
+REVISION=356

data/libs/zabcon_commands.rb

@@ -49,7 +49,7 @@ ZabconCommand.add_command "help" do
   end
 #  set_flag :array_params
   set_help_tag :help
-  set_tokenizer SimpleTokenizer
+  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "help commands" do
@@ -71,7 +71,12 @@ ZabconCommand.add_command "login" do
   end
   set_help_tag :help
 #  set_flag :array_params
-  set_tokenizer SimpleTokenizer
+  tokenizer(SimpleTokenizer.options(:remove_whitespace))
+  #arg_processor do |arg|
+  #  puts "arg_processor method"
+  #  p arg
+  #  arg
+  #end
 end
 
 ZabconCommand.add_command "logout" do
@@ -124,7 +129,7 @@ ZabconCommand.add_command "set debug" do
   depreciated "set env debug=N"
 #  set_flag :array_params
   set_help_tag :set_debug
-  set_tokenizer SimpleTokenizer
+  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "set lines" do
@@ -134,7 +139,7 @@ ZabconCommand.add_command "set lines" do
   depreciated "set env lines=N"
 #  set_flag :array_params
   set_help_tag :set_lines
-  set_tokenizer SimpleTokenizer
+  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "set pause" do
@@ -155,7 +160,7 @@ ZabconCommand.add_command "set pause" do
   end
 #  set_flag :array_params
   set_help_tag :set_pause
-  set_tokenizer SimpleTokenizer
+  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "show var" do
@@ -180,7 +185,7 @@ ZabconCommand.add_command "show var" do
   end
   set_help_tag :show_var
 #  set_flag :array_params
-  set_tokenizer SimpleTokenizer
+  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "show env" do
@@ -205,7 +210,7 @@ ZabconCommand.add_command "show env" do
   end
   set_help_tag :show_env
 #  set_flag :array_params
-  set_tokenizer SimpleTokenizer
+  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "set var" do
@@ -235,7 +240,7 @@ ZabconCommand.add_command "unset var" do
   end
 #  set_flag :array_params
   set_help_tag :unset_var
-  set_tokenizer SimpleTokenizer
+  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "show revisions" do
@@ -280,8 +285,8 @@ ZabconCommand.add_command "raw api" do
   set_flag :print_output
   set_help_tag :raw_api
   result_type :raw_api
-  set_tokenizer CommandTokenizer
-#  set_tokenizer SimpleTokenizer
+  tokenizer CommandTokenizer
+#  tokenizer SimpleTokenizer
 end
 
 ZabconCommand.add_command "raw json" do
@@ -310,7 +315,7 @@ ZabconCommand.add_command "raw json" do
   set_flag :print_output
   set_help_tag :raw_api
   result_type :raw_api
-  set_tokenizer SimpleTokenizerString
+  tokenizer SimpleTokenizerString
 end
 
 ###############################################################################

data/libs/zabcon_core.rb

@@ -184,6 +184,7 @@ class ZabconCore
     }
   end
 
+
   def start
     debug(5,:msg=>"Entering main zabcon start routine")
     puts "Welcome to Zabcon.  Build Number: #{REVISION}"  if env["echo"]
@@ -194,10 +195,10 @@ class ZabconCore
         while line=@input.get_line()
           #tokens=ExpressionTokenizer.new(line)
           tokens=CommandTokenizer.new(line)
-#          line=line.strip_comments
-          tokens.delete_if {|item| item.kind==:comment}
-          next if line.nil?
-          next if line.strip.length==0  # don't bother parsing an empty line'
+
+          tokens.delete_if {|item| item.kind==:comment }
+          next if tokens.nil? || tokens.first.kind==:end ||
+              (tokens.first.kind==:whitespace && tokens[1].kind==:end)
           debug(6, :var=>line, :msg=>"Input from user")
 
           commands=ZabconExecuteContainer.new(tokens)

data/revision_information

@@ -1,4 +1,9 @@
 **** 11/23/11 nelsonab
+* Minor input parser modifications.  Will not barf on inputs like the following:
+  >      #comment
+* Code cleanup (removed old comments etc)
+
+**** 11/23/11 nelsonab 0.0.350
 * Added revision file and command to display revision information
   "show revision"
 * Added support for multiple custom command files.
@@ -6,4 +11,15 @@
   Sample can be found here:
    http://trac.red-tux.net/browser/trunk/ruby/zabcon/zabcon.conf.default
 * Fixed Raw JSON support
-  variable substitution currently not working.
+  variable substitution currently not working.
+
+**** 12/09/11 nelsonab
+* Bumped zbxapi version dependency to 0.1.352
+
+*** 12/18/11 nelsonab
+* Fixed login command
+* Added factory method "options" to Tokenizer class
+* Added deprecate_function to Command class
+  Will show a warning message with new function name to use along with
+  command file path and line numbers/command name
+* Fixed Ruby version check for 1.9.x

data/zabcon.rb

@@ -42,7 +42,7 @@ DEPENDENCIES={
   "parseconfig"=>true,
   "json"=>true,
   "highline"=>true,
-  "zbxapi"=>Gem::Version.new("0.1.294")
+  "zbxapi"=>Gem::Version.new("0.1.352")
 }
 
 
@@ -58,6 +58,8 @@ for i in 0..items-1 do
     puts
     exit(1)
   end
+  #If this step is higher than the required version break out of loop
+  break if ruby_rev[i].to_i>required_rev[i].to_i
 end
 
 
@@ -70,11 +72,14 @@ DEPENDENCIES.each_key {|dep|
     depsok=false
     break
   end
-  gem=gem[0]
-  if DEPENDENCIES[dep].class==Gem::Version && gem.version<DEPENDENCIES[dep]
-    puts "#{dep} needs to be at least version #{DEPENDENCIES[dep]}, found #{gem.version}"
-    depsok=false
-  end
+  gem.sort!{ |a,b| a.version <=> b.version }
+  depsok=depsok && !gem.map { |g|
+    if DEPENDENCIES[dep].class==Gem::Version && g.version<DEPENDENCIES[dep]
+      "#{dep} needs to be at least version #{DEPENDENCIES[dep]}, found #{g.version}"
+    else
+
+    end
+  }.delete_if {|i| i==false}.empty?
 }
 if !depsok
   puts

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zabcon
 version: !ruby/object:Gem::Version 
-  hash: 675
+  hash: 727
   prerelease: false
   segments: 
   - 0
   - 0
-  - 350
-  version: 0.0.350
+  - 356
+  version: 0.0.356
 platform: ruby
 authors: 
 - A. Nelson
@@ -15,7 +15,7 @@ autorequire:
 bindir: .
 cert_chain: []
 
-date: 2011-11-23 00:00:00 -05:00
+date: 2011-12-18 00:00:00 -05:00
 default_executable: zabcon
 dependencies: 
 - !ruby/object:Gem::Dependency