cmdlib 0.1.1

checksums.yaml

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

data/lib/cmdlib/command.rb

@@ -0,0 +1,21 @@
+module Cmdlib
+  # Class for create command object.
+  class Command
+
+    # Contain object with describe text.
+    attr_accessor :describe
+
+    # Numbers of required arguments.
+    attr_accessor :argnum
+
+    def initialize
+      @describe = Describe.new
+      @argnum = nil
+    end
+
+    def handler
+      puts "fatal error: do not set handler for '#{@describe.oname}' command."
+    end
+  end # class Command
+
+end # module Cmdlib

data/lib/cmdlib/describe.rb

@@ -0,0 +1,63 @@
+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
+	borderlen = 80 - str.length - 4
+	print '*' * (borderlen/2)
+	print '[ '
+	print str
+	print ' ]'
+	puts '*' * (borderlen/2)
+      else
+	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/handler.rb

@@ -0,0 +1,205 @@
+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

data/lib/cmdlib/option.rb

@@ -0,0 +1,36 @@
+module Cmdlib
+  # Class for create option object.
+  class Option
+
+    # Contain text with option short name (String).
+    attr_accessor :shortname
+
+    # Contain text with option long name (String).
+    attr_accessor :longname
+
+    # Contain text with describe option (String).
+    attr_accessor :brief
+
+    # Contain option value.
+    attr_accessor :value
+
+    # Contain parameter tag, the option can be have a parameter.
+    attr_accessor :param
+
+    # Set option shortname (sname) and longname (lname).
+    def initialize ( sname, lname, brief = '', param = false )
+      raise TypeError, 'Incorrectly types for option constructor.' unless
+	sname.instance_of? String and
+	lname.instance_of? String and
+	brief.instance_of? String
+
+      @shortname = sname
+      @longname  = lname
+      @brief = brief
+      @value = nil
+      @param = param
+    end
+    
+  end # class Option
+
+end # module Cmdlib

data/lib/cmdlib/version.rb

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

data/lib/cmdlib.rb

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

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: cmdlib
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Anton S. Gerasimov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- gera_box@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cmdlib.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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple constructor of CLI (Command Line Interface) handler.
+test_files: []
+has_rdoc: