cmdlib 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aecf89b44a2d47b9e8132bf782e82be0deda784
-  data.tar.gz: 0c8751d793463751009fbcc73cce8e96ffdee92c
+  metadata.gz: b170999269670668c26d833c36d2158df2cdf373
+  data.tar.gz: 60b3ffb61f88cbf422833981e91edf923e292283
 SHA512:
-  metadata.gz: 78eefd3639d1f23b07abf9e5de8c02fff310b57a9e4fc641fc21f47af180cb7ac2357c970d08cdf31c6bab6a885ba03aeb158e6221f7269230a96d9248712ca2
-  data.tar.gz: d771b0f907d233857eae8890dd69ef54ddeeac9b93068cd9cb057d5d5612e7deb901f5da86f637490e930c58dd8d635e3bb12159c45c3995f0464d7807631561
+  metadata.gz: f436c4bde1fbc0827656abc8711c25d77de4aed20c56cccb162b34ef1a3f14bdf041fa8f39c6f8898294760e586ef4bef390a1f289103a7e526d3438aa24bc64
+  data.tar.gz: d9755efdb11c202488ef87d9741d3bbc89de00160806b4e1f3c6936a03ddb253af94bf25d0a7dc7440b6238a1dae5a5d7ff3c24e62613d959c0a8bba4e7b500e

data/lib/cmdlib.rb

@@ -1,8 +1,8 @@
 require "cmdlib/version"
+require "cmdlib/option.rb"
 require "cmdlib/command.rb"
+require "cmdlib/application.rb"
 require "cmdlib/describe.rb"
-require "cmdlib/option.rb"
-require "cmdlib/handler.rb"
 
 module Cmdlib
   # Your code goes here...

data/lib/cmdlib/application.rb

@@ -0,0 +1,369 @@
+module Cmdlib
+  # Class edscribe CLI application (TOP class).
+  class App
+    OPTION_PREFIX_SHORT = '-'
+    OPTION_PREFIX_LONG  = '--'
+
+    # This array contain information to use application.
+    attr_accessor :name, :about, :usage
+    
+    # Version string (will be display to -v or --version).
+    attr_accessor :version, :options, :commands
+    
+    def initialize ( appname )
+      @name  = appname
+      @about = []
+      @usage = []
+      @commands = []
+      @options = {}
+      @default = nil
+      @version = '0.1.1'
+      
+      addopt Option.new( 'V', 'version', 'Display application version.' )
+    end
+
+    
+    # Add CLICommand object to CLIHandler.
+    def addcmd ( cmd )
+      raise TypeError, 'Incorrectly types for command object.' unless
+	cmd.is_a? Cmdlib::Command
+
+      @commands << cmd
+    end
+
+    
+    # Add CLICommand object to CLIHandler.
+    def addopt ( opt )
+      raise TypeError, 'Incorrectly types for option object.' unless
+	opt.instance_of? Cmdlib::Option
+
+      @options[opt.longname.to_sym] = opt
+    end
+    
+    
+    # Default command for run without arguments.
+    def default ( cmd )
+      raise TypeError, 'Incorrectly types for command object.' unless
+	cmd.is_a? Cmdlib::Command
+	
+      @default = cmd
+    end
+    
+    
+    # Display commands info
+    def display_commands( cmdlist )
+      maxlen = 0
+      cmdlist.each do |cmd|
+	maxlen = cmd.name.length if cmd.name.length > maxlen
+      end
+      cmdlist.each do |cmd|
+	print '  ' + cmd.name
+	print "#{' ' * (maxlen - cmd.name.length)}  # "
+	puts cmd.brief
+      end
+    end
+    
+    
+    # Display options info
+    def display_options( optlist )
+      maxlen = 0
+      listout = []
+      optlist.each_value do |opt|
+	optnames = ''
+	if opt.shortname.length == 0
+          optnames += '  ' 
+	else
+	  optnames += OPTION_PREFIX_SHORT + opt.shortname
+	end
+	optnames += ','
+	optnames += OPTION_PREFIX_LONG + opt.longname if opt.longname.length != 0
+	optnames += '=[...]' if opt.param == true
+	listout << { :n => optnames, :b => opt.brief }
+	maxlen = optnames.length if optnames.length > maxlen
+      end
+      listout.each do |opt|
+	print '  ' + opt[:n]
+	print "#{' ' * (maxlen - opt[:n].length)}  # "
+	puts opt[:b]
+      end
+    end
+ 
+    
+    # Main method to run application.
+    def run
+      option_parser @options
+      
+      # Check on include version request.
+      if @options[:version].value then
+	puts "#{@name}, version #{@version}"
+	exit
+      end
+
+      # Check on include help request.
+      if ARGV[0] == 'help' or ARGV[0] == '--help' or ARGV[0] == '-h' then
+	# Help arguments apsent, well then display information about application.
+	if ARGV.size == 1 then
+	  puts
+	  puts "*** #{@name} ***".center(80)
+	  # Display about info.
+	  if @about.size > 0 then
+	    puts '** ABOUT:'
+	    @about.each do |line|
+	      puts "  #{line}"
+	    end
+	  end
+	  # Display usage info.
+	  if @usage.size > 0 then
+	    puts
+	    puts '** USAGE:'
+	    @usage.each do |line|
+	      puts "  #{line}"
+	    end
+	  end
+	  # Display options info.
+	  puts
+	  puts '** OPTIONS:'
+	  display_options @options
+	  # Display commands info
+	  if @commands.size > 0 then
+	    @commands.each do |c| c.init end
+	    puts
+	    puts '** COMMANDS:'
+	    display_commands @commands
+	    puts
+	    puts "For details, type: help [COMMAND]"
+	  end
+	  puts
+	# Help arguments exist, find command in application command list.
+	else
+	  ARGV.delete_at( 0 )
+	  cmd = command_select
+	  if ARGV.size != 0 then
+	    puts "fatal error: unknown command '#{ARGV[0]}'"
+	    exit
+	  end
+	  # Display describe information on command.
+	  puts
+	  puts Cmdlib::Describe.outtitle( cmd.name )
+	  puts "  #{cmd.brief}"
+	  if cmd.details.size > 0 then
+	    puts
+	    puts '** DETAILS:'
+	    cmd.details.each do |e|
+	      puts "  #{e}"
+	    end
+	  end
+	  if cmd.example.size > 0 then
+	    puts
+	    puts '** EXAMPLE:'
+	    cmd.example.each do |e|
+	      puts "  #{e}"
+	    end
+	  end
+	  # Display options info.
+	  if cmd.options.size > 0 then
+	    puts
+	    puts '** OPTIONS:'	  
+	    display_options cmd.options
+	  end
+	  # Display commands info.
+	  if cmd.subcmd.size > 0 then
+	    cmd.subcmd.each do |c| c.init end
+	    puts
+	    puts '** SUBCOMMANDS:'
+	    display_commands cmd.subcmd
+	    puts
+	    puts "For details, type: help #{cmd.name} [SUBCOMMAND]"
+	  end
+	  puts
+	end
+	exit
+      end
+      
+      # Handling default command (if exist her).
+      if @default != nil then
+	option_excess
+	if ARGV.size < @default.argnum then
+	  puts "fatal error: to few arguments for programm, use <help>."
+	else
+	  @default.handler( @options, ARGV )
+	end
+	exit
+      end
+      
+      # Handling commands.
+      cmd = command_select
+      if cmd == nil then
+	puts "fatal error: unknown command or command miss, use <help>."
+	exit
+      end
+      if ARGV.size < cmd.argnum then
+	puts "fatal error: to few arguments for command, use: <help> <command name>."
+	exit
+      end
+      # Scaning options fir this command
+      option_parser cmd.options
+      option_excess
+      #cmd.init
+      cmd.handler( @options, ARGV )
+      exit
+    end
+    
+    
+    # Search command in command list.
+    # Return command object if search success,
+    # else return nil.
+    # cmdlist -- array with command objects.
+    # cmd -- string with command name from ARGV.
+    def command_search( cmdlist, cmd )
+      cmdlist.each do |c|
+	c.init
+	return c if c.name == cmd
+      end
+      return nil
+    end
+    
+    
+    # Select and return command object in application.
+    def command_select
+      command = command_search( @commands, ARGV[0] )
+      if command != nil then
+        # remove command name from ARGV and search next.
+        ARGV.delete_at( 0 )
+        ARGV.each do |arg|
+	  cmd = command_search( command.subcmd, arg )
+	  break if cmd == nil
+	  ARGV.delete_at( 0 )
+	  command = cmd
+        end
+      end
+      return command
+    end
+    
+    
+    # Check input arguments on equal option syntax.
+    # if success return option { :n => <argument name>, :t => <option type> },
+    # else return '' in all fields.
+    def getopt ( opt )
+      result = { :n => '', :t => '', }
+      if opt.length > OPTION_PREFIX_LONG.length then
+        if opt[0, OPTION_PREFIX_LONG.length] == OPTION_PREFIX_LONG then
+          result[:n] = opt[OPTION_PREFIX_LONG.length, opt.length]
+          result[:t] = OPTION_PREFIX_LONG
+          return result
+        end
+      end
+      if opt.length > OPTION_PREFIX_SHORT.length then
+        if opt[0, OPTION_PREFIX_SHORT.length] == OPTION_PREFIX_SHORT then
+          result[:n] = opt[OPTION_PREFIX_SHORT.length, opt.length]
+          result[:t] = OPTION_PREFIX_SHORT
+          return result 
+        end
+      end
+      return result
+    end
+
+
+    # Check ARGV to exess options.
+    def option_excess
+      ARGV.each do |opt|
+	o = getopt( opt )
+	if o[:n] != '' then
+	  puts "fatal error: unknown option '#{o[:t]}#{o[:n]}'"
+	  exit
+	end
+      end
+    end
+    
+    
+    # Compare parsing option (form by getopt) with application option.
+    # Return true if options is equal, else return false.
+    # opt_form -- object formed by getopt.
+    # opt_app  -- application option object.
+    def option_compare ( opt_form, opt_app )
+      case opt_form[:t]
+      when OPTION_PREFIX_SHORT
+        return true if opt_form[:n][0, opt_app.shortname.length] == opt_app.shortname
+      when OPTION_PREFIX_LONG
+	return true if opt_form[:n].split('=')[0] == opt_app.longname
+      end
+      return false
+    end
+    
+    
+    # Search option in application options.
+    # Return option key-name if option found, else return nil.
+    # option  -- object formed by getopt.
+    # options -- options object list.
+    def option_search( option, options )
+      # Search in global options list
+      options.each_value do |opt|
+        return opt.longname.to_sym if option_compare( option, opt )
+      end
+      return nil
+    end
+    
+    
+    # Set application option object.
+    # opt_form -- object formed by getopt.
+    # opt_app  -- application option object.
+    # Return delete name in ARGV or ''.
+    def option_set ( opt_form, opt_app )
+      if opt_app.param then
+	# option parameter buit-in option name by '='
+	if opt_form[:n].include? '=' then
+	  opt_app.value = opt_form[:n].split('=')[-1]
+	  return ''
+	end
+	# option parameter buit-in option name
+	if opt_form[:t] == OPTION_PREFIX_SHORT and
+	   opt_form[:n].length > opt_app.shortname.length then
+	  opt_app.value = opt_form[:n][opt_app.shortname.length, opt_form[:n].length - opt_app.shortname.length]
+	  return ''
+	end
+	# option parameter present in next ARGV.
+	if opt_form[:i].next >= ARGV.size then
+          puts "fatal error: unable to find argument for option '#{opt_form[:n]}'."
+          exit
+	end
+	# if next argument is a option.
+	arg = ARGV[opt_form[:i].next]
+        if getopt( arg )[:n] != '' then
+          puts "fatal error: miss argument for option '#{opt_form[:t]}#{opt_form[:n]}'."
+          exit
+        end
+	opt_app.value = arg
+	return arg
+      else
+	opt_app.value = true
+      end
+      return ''
+    end
+    
+    
+    # Parsing options in command line.
+    def option_parser( optlist )
+      return if optlist.size == 0
+      deletelist = []
+      # search option in argument list.
+      ARGV.each_with_index do |opt,i|
+	o = getopt( opt )
+	if o[:n] != '' and o[:n] != 'h' and o[:n] != 'help'
+	  o[:i] = i
+	  # Search in application list
+	  result = option_search( o, optlist )
+	  if result != nil then
+	    deletelist << opt
+	    result = option_set( o, optlist[result] )
+	    deletelist << result if result != ''
+	  end
+	end
+      end
+      # delete option from ARGV.
+      deletelist.each do |n|
+	ARGV.delete( n )
+      end
+    end
+    
+  end # class App
+end # module Cmdlib

data/lib/cmdlib/command.rb

@@ -3,19 +3,44 @@ module Cmdlib
   class Command
 
     # Contain object with describe text.
-    attr_accessor :describe
+    attr_accessor :name, :brief, :details, :example
 
-    # Numbers of required arguments.
+    # List with options for command and subcommand.
+    attr_accessor :options, :subcmd
+    
+    # Mandatory argument numbers for command.
     attr_accessor :argnum
 
     def initialize
-      @describe = Describe.new
-      @argnum = nil
+      @name  = ''
+      @brief = ''
+      @details = []
+      @example = []
+      @options = {}
+      @subcmd  = []
+      @argnum  = 0
     end
 
-    def handler
-      puts "fatal error: do not set handler for '#{@describe.oname}' command."
+    def init
     end
-  end # class Command
+    
+    def handler( global_options, args )
+      puts "error: handler do not set for this command."
+    end
+    
+    def addopt ( opt )
+      raise TypeError, 'Incorrectly types for option object.' unless
+	opt.instance_of? Cmdlib::Option
+	
+      @options[opt.longname.to_sym] = opt
+    end
+    
+    def addcmd ( cmd )
+      raise TypeError, 'Incorrectly types for command object.' unless
+	cmd.is_a? Cmdlib::Command
 
+      @subcmd << cmd
+    end
+
+  end # class Command
 end # module Cmdlib

data/lib/cmdlib/describe.rb

@@ -1,31 +1,6 @@
 module Cmdlib
-  # Create class with describe information
-  # of any objects.
   class Describe
 
-    # This string have should text with object name.
-    attr_accessor :oname
-
-    # This string have should text with brief information.
-    attr_accessor :brief
-
-    # This array string have should text with details information.
-    attr_accessor :details
-
-    # This array string have should text with examples information.
-    attr_accessor :example
-
-    # This array string have should text with tags information.
-    attr_accessor :options
-
-    def initialize
-      @oname = ''
-      @brief = ''
-      @details = []
-      @example = []
-      @options = []
-    end
-
     # Display title in follow format: *** [title] ***.
     def self.outtitle ( str )
       if( str.length < (80-4) ) then
@@ -39,25 +14,6 @@ module Cmdlib
 	puts str
       end
     end
-
-    # Display all information about object.
-    def display
-      puts
-      Describe.outtitle( @oname )
-      puts
-      puts ' ' + @brief
-      puts
-      puts '** DESCRIBE:'
-      @details.each do |line|
-	puts ' ' + line
-      end
-      puts
-      puts '** EXAMPLE:'
-      @example.each do |line|
-	puts ' ' + line
-      end
-      puts
-    end
+    
   end # class Describe
-
 end # module Cmdlib

data/lib/cmdlib/option.rb

@@ -22,7 +22,8 @@ module Cmdlib
       raise TypeError, 'Incorrectly types for option constructor.' unless
 	sname.instance_of? String and
 	lname.instance_of? String and
-	brief.instance_of? String
+	brief.instance_of? String and
+	sname.length == 1 and lname.length > 1
 
       @shortname = sname
       @longname  = lname

data/lib/cmdlib/version.rb

@@ -1,3 +1,3 @@
 module Cmdlib
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmdlib
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Anton S. Gerasimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-21 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,9 +46,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/cmdlib.rb
+- lib/cmdlib/application.rb
 - lib/cmdlib/command.rb
 - lib/cmdlib/describe.rb
-- lib/cmdlib/handler.rb
 - lib/cmdlib/option.rb
 - lib/cmdlib/version.rb
 homepage: https://github.com/gera-gas/cmdlib
@@ -71,9 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Simple constructor of CLI (Command Line Interface) handler.
 test_files: []
-has_rdoc: 

data/lib/cmdlib/handler.rb

@@ -1,205 +0,0 @@
-module Cmdlib
-  # Class with methods for handled commands
-  # from CLI application.
-  class Handler
-    OPTION_PREFIX_SHORT = '-'
-    OPTION_PREFIX_LONG  = '--'
-
-    # This array contain information to use application.
-    attr_accessor :usage
-
-    def initialize
-      @usage = []
-      @cmdlist = []
-      @optlist = []
-    end
-
-    # Add CLICommand object to CLIHandler.
-    def addcmd ( cmd )
-      raise TypeError, 'Incorrectly types for command object.' unless
-	cmd.respond_to? :describe and
-	cmd.respond_to? :handler and
-	cmd.describe.instance_of? Describe
-
-      @cmdlist << cmd
-    end
-
-    # Add CLICommand object to CLIHandler.
-    def addopt ( opt )
-      raise TypeError, 'Incorrectly types for option object.' unless
-	opt.respond_to? :brief and
-	opt.respond_to? :shortname and
-	opt.respond_to? :longname and
-	opt.respond_to? :value and
-	opt.respond_to? :param and
-	opt.brief.instance_of? String
-
-      @optlist << opt
-    end
-
-    # Main handler method, execute command handler.
-    def run
-      # parsing options.
-      optparser
-
-      # handled position arguments.
-      if ARGV.size > 0 then
-	if ARGV[0] == 'help' or ARGV[0] == '--help' or ARGV[0] == '-h' then
-	  # display help specificly command.
-	  if ARGV.size == 2 then
-	    @cmdlist.each do |e|
-	      if ARGV[1] == e.describe.oname then
-		e.describe.display
-		exit
-	      end
-	    end
-	    puts "fatal error: unknown command with name - #{ARGV[1]}"
-	  # display usage help.
-	  else
-	    puts
-	    # dislpay usage information.
-	    @usage.each do |e|
-	      puts e
-	    end
-	    if @cmdlist.size > 0 then
-	      puts
-	      puts '** COMMANDS:'
-	      maxlen = 0
-	      # dislpay command list.
-	      @cmdlist.each do |e|
-		maxlen = e.describe.oname.length if e.describe.oname.length > maxlen
-	      end
-	      @cmdlist.each do |e|
-		print '  ' + e.describe.oname
-		print "#{' ' * (maxlen - e.describe.oname.length)}  -- "
-		puts e.describe.brief
-	      end
-	      puts
-	      puts '  For details type: help <command>'
-	    end
-            puts
-	    # display options list.
-	    if @optlist.size > 0 then
-	      puts '** OPTIONS:'
-	      maxlen = 0
-	      # make shortname to string with option names.
-	      listout = []
-	      @optlist.each do |e|
-		optnames = ''
-		if e.shortname.length == 0
-		  optnames += '  ' 
-		else
-		  optnames += OPTION_PREFIX_SHORT + e.shortname
-		end
-		optnames += ','
-		if e.longname.length != 0
-		  optnames += OPTION_PREFIX_LONG + e.longname
-		end
-		listout << optnames
-		maxlen = optnames.length if optnames.length > maxlen
-	      end
-	      # make longname to string with option names.
-	      @optlist.each_with_index do |e,i|
-		print '  ' + listout[i]
-		print "#{' ' * (maxlen - listout[i].length)}  -- "
-		puts e.brief
-	      end
-              puts
-	    end
-	  end
-	else
-	  # handling input command.
-	  @cmdlist.each do |e|
-	    if ARGV[0] == e.describe.oname then
-              # check arguments numbers.
-              if e.argnum != nil then
-                if (ARGV.size - 1) != e.argnum then
-	          puts 'fatal error: wrong arguments for program.'
-                  exit
-                end
-              end
-              # run handler of command.
-	      e.handler
-	      exit
-	    end
-	  end
-	  puts "fatal error: unknown command with name - #{ARGV[0]}"
-	end
-	# exit, after handled all arguments.
-	exit
-      end
-    end
-
-    # Check input arguments on equal option syntax.
-    # Return option name if success, else return ''.
-    def getopt ( opt )
-      if opt.length > OPTION_PREFIX_LONG.length then
-	return opt[OPTION_PREFIX_LONG.length, opt.length] if opt[0, OPTION_PREFIX_LONG.length] == OPTION_PREFIX_LONG
-      end
-      if opt.length > OPTION_PREFIX_SHORT.length then
-	return opt[OPTION_PREFIX_SHORT.length, opt.length] if opt[0, OPTION_PREFIX_SHORT.length] == OPTION_PREFIX_SHORT
-      end
-      return ''
-    end
-
-    # parse command line on the option exist.
-    def optparser
-      options = []
-      # search option in option list. 
-      ARGV.each_with_index do |opt,i|
-	r = getopt( opt )
-	options << i if r != '' and r != 'h' and r != 'help'
-      end
-      # handling each option in list.
-      options.each do |oi|
-	# find option in CLIHandler list.
-	@optlist.each do |opt|
-	  argval = getopt( ARGV[oi] )
-	  # if option has a parameter.
-	  if opt.param then
-	    # if option-value set in next argument.
-	    if argval == opt.longname or
-	       argval == opt.shortname then
-	      # argument is not set.
-	      if oi.next >= ARGV.size then
-                puts "fatal error: unable to find argument for option '#{ARGV[oi]}'."
-                exit
-	      end
-              # if next argument option.
-              if getopt( ARGV[oi.next] ) != '' then
-                puts "fatal error: miss argument for option '#{ARGV[oi]}'."
-                exit
-              end
-              opt.value = ARGV[oi.next]
-	      options << oi.next
-	      next
-	    end
-	    # if option-value built-in option.
-	    oname = opt.shortname
-	    oname = opt.longname if ARGV[oi][0, OPTION_PREFIX_LONG.length] == OPTION_PREFIX_LONG
-	    if argval[0, oname.length] == oname then
-	      opt.value = argval[oname.length, argval.length - oname.length]
-              # delete assign symbols.
-              opt.value = opt.value[1, opt.value.length - 1] if opt.value[0] == '='
-	    end
-	  # single (toggle) option.
-	  else
-	    if argval == opt.longname or
-	       argval == opt.shortname then
-	      opt.value = true
-	    end
-	  end
-	end
-      end
-      # delete option from ARGV.
-      onamelist = []
-      options.each do |oi|
-	onamelist << ARGV[oi]
-      end
-      onamelist.each do |oname|
-	ARGV.delete( oname )
-      end
-    end
-  end # class Handler
-
-end # module Cmdlib