cli-console 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15e1e212d7c3e98b863ebdce0699830ac93fb3ce
-  data.tar.gz: c1e19fbeadd0e6ddbb17bf199973c767807926a9
+  metadata.gz: ff85b32926069f72276b38416a049e475ed749f8
+  data.tar.gz: ad1350a5d8fd0dcd079bae9b3c3953c083d797b3
 SHA512:
-  metadata.gz: dd9384d1a876fc9f3a2956d15ef820282db199fff064b0324b901634d3a75cb3c4f284e27d4056277b678be1ab65dc48952593b8adeac952b5f6d151f9083c28
-  data.tar.gz: 0c791d344d834dc20f65b4bac27cbe77c79fb7c04172c5fafd2b27327c682f99fa6cdacb18f0896bdf4a4578a3fbc630c4cb8a00c3aecd1ffbf8ff35c6ae7b35
+  metadata.gz: f5067a9e8d9b11a595d1406e1f8c1e7c131e5c01102e8dfad2330e1402f7f921ecf4ecf1925b6ef036704a0a802e80baf4c82717f8232f04d7bdd53d09c68b88
+  data.tar.gz: 6e35101ccded3b310cdb9525deb6cc6b1277c52d7018161b7554b87d640cea377823ba280877dbc29f446d651d06f9132de965ec95f88e4c4e92d2c6ecc4e093

data/cli-console.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
     gem.add_development_dependency 'simplecov'
     gem.add_development_dependency 'yard'
     gem.add_development_dependency 'redcarpet'
+    gem.add_development_dependency 'highline', '>= 1.6.16'
 end

data/lib/cli-console.rb

@@ -55,7 +55,7 @@ module CLI
         # @param commandLongDescription [String] long description about command
         # @param commandUsage [String] usage information about command
         # @return [Array] command information
-        def addCommand(commandName, command, commandDescription='', commandLongDescription = nil, commandUsage = nil)
+        def addCommand(commandName, command, commandDescription = '', commandLongDescription = nil, commandUsage = nil)
             commandLongDescription = command.owner.get_description(command.name) if commandLongDescription == nil
             commandUsage = command.owner.get_usage(command.name) if commandUsage == nil
             @Commands[commandName] = [command, commandDescription, commandLongDescription, commandUsage]
@@ -67,7 +67,7 @@ module CLI
         # @param commandLongDescription [String] long description about command
         # @param commandUsage [String] usage information about command
         # @return [Array] command information
-        def addExitCommand(commandName, commandDescription='', commandLongDescription = nil, commandUsage = nil)
+        def addExitCommand(commandName, commandDescription = '', commandLongDescription = nil, commandUsage = nil)
             commandLongDescription = 'Exit...' unless commandLongDescription
             commandUsage = ['exit'] unless commandUsage
             @Commands[commandName] = [method(:end), commandDescription, commandLongDescription, commandUsage]
@@ -79,7 +79,7 @@ module CLI
         # @param commandLongDescription [String] long description about command
         # @param commandUsage [String] usage information about command
         # @return [Array] command information
-        def addHelpCommand(commandName, commandDescription='', commandLongDescription = nil, commandUsage = nil)
+        def addHelpCommand(commandName, commandDescription = '', commandLongDescription = nil, commandUsage = nil)
             commandLongDescription = 'Display Help for <command>' unless commandLongDescription
             commandUsage = ['help <command>'] unless commandUsage
             @Commands[commandName] = [method(:help), commandDescription, commandLongDescription, commandUsage]
@@ -92,7 +92,7 @@ module CLI
         # @param commandLongDescription [String] long description about alias
         # @param commandUsage [String] usage information about alias
         # @return [Array] alias information
-        def addAlias(aliasName, commandNameParms, commandDescription=nil, commandLongDescription = nil, commandUsage = nil)
+        def addAlias(aliasName, commandNameParms, commandDescription = nil, commandLongDescription = nil, commandUsage = nil)
             @Aliases[aliasName] = [commandNameParms, commandDescription, commandLongDescription, commandUsage]
         end
 
@@ -104,7 +104,7 @@ module CLI
                 h.whitespace = :strip_and_collapse
                 h.validate = nil
                 h.readline = @UseReadline
-                h.completion = @Commands.keys+@Aliases.keys
+                h.completion = @Commands.keys + @Aliases.keys
             end
             @LastCommand = '' if (not @LastCommand.to_s.empty? and @LastCommand[0] == '#')
             return @LastCommand
@@ -128,23 +128,39 @@ module CLI
             matches.each do |value|
                 text = value[0].to_s
                 text += ' - '+value[1][1].to_s unless value[1][1].to_s.empty?
-                @IO.indent(1, text )
+                @IO.indent(1, text)
             end
         end
 
+        # Parses commandString into Array of words
+        # @param commandString [String]
+        # @return [Array] command words
+        def self.parseCommandString(commandString)
+            commandWords = []
+            return commandWords unless commandString
+
+            pattern = %r{
+                (?<command> [^\s"']+ ){0}
+                (?<exceptDoubleQuotes> [^"\\]*(?:\\.[^"\\]*)* ){0}
+                (?<exceptSingleQuotes> [^'\\]*(?:\\.[^'\\]*)* ){0}
+                \g<command>|"\g<exceptDoubleQuotes>"|'\g<exceptSingleQuotes>'
+            }x
+
+            commandString.scan(pattern) do |m|
+                commandWords << m[0] unless m[0].nil?
+                commandWords << m[1].gsub('\"','"') unless m[1].nil?
+                commandWords << m[2].gsub('\\\'','\'') unless m[2].nil?
+            end
+            commandWords
+        end
+
         # Executes command with parameters
         # @param commandString [String]
         # @return command result or error number
         def processCommand(commandString)
             return 0 if commandString.to_s.empty?
-            commandWords = []
-            commandString.scan(/([^\s"']+)|"([^"]*)"|'([^']*)'/) do |m|
-                commandWords << m[0] unless m[0].nil?
-                commandWords << m[1] unless m[1].nil?
-                commandWords << m[2] unless m[2].nil?
-            end
+            commandWords = Console::parseCommandString(commandString)
             command = commandWords.shift.downcase
-
             if (not @Commands.key?(command) and not @Aliases.key?(command))
                 matches = commandMatch(command)
                 if matches.length == 1
@@ -195,13 +211,13 @@ module CLI
                         end
                     end
                     command = getCommand( formatString % currentValues )
-                    @IO.indent_level+=1
+                    @IO.indent_level += 1
                     result = processCommand(command)
-                    @IO.indent_level-=1
+                    @IO.indent_level -= 1
                     return 0 if result == @ExitCode
                 rescue Exception => e
                     showException(e)
-                @IO.indent_level=indent_level
+                @IO.indent_level = indent_level
                 end
             end
             -1
@@ -209,7 +225,7 @@ module CLI
 
         # Displays seperator line
         def printSeperator
-            @IO.say(@Seperator*@SepCount)
+            @IO.say(@Seperator * @SepCount)
         end
 
         # Displays help about command
@@ -219,7 +235,7 @@ module CLI
                 printSeperator
                 if not @Commands[command][3].to_a.empty?
                     @IO.indent do |io|
-                        @Commands[command][3].each { |c| io.say c}
+                        @Commands[command][3].each { |c| io.say c }
                         io.newline
                     end
                 end
@@ -235,13 +251,13 @@ module CLI
 
         # Shows message to inform how to get more information about command
         # @param helpCommand [String] command for which display message
-        def command_usage(helpCommand='help')
+        def command_usage(helpCommand = 'help')
             @IO.say("You can type \"#{helpCommand} <command>\" for more info")
         end
 
         # Shows help information about command
         # @param params [Array] command for which show help
-        def help(params=[])
+        def help(params = [])
             if not params.to_a.empty?
                 command = params[0].downcase
                 if (not @Commands.key?(command) and not @Aliases.key?(command))
@@ -295,7 +311,7 @@ module CLI
 
         # @param params [Array] unused
         # @return [Fixnum]
-        def end(params=[])
+        def end(params = [])
             @ExitCode
         end
     end

data/lib/cli-console/version.rb

@@ -1,6 +1,6 @@
 module CLI
     class Console
         # Version for gem
-        VERSION = '0.1.3'
+        VERSION = '0.1.4'
     end
 end

data/spec/cli-console_spec.rb

@@ -30,6 +30,39 @@ describe CLI::Console do
         console.addAlias('quit','exit')
     end
 
+    describe '.parseCommandString' do
+        it 'should parse correctly simple command' do
+            CLI::Console::parseCommandString('command param1 param2').should eq(['command', 'param1', 'param2'])
+        end
+
+        it 'should parse command with double quotes' do
+            CLI::Console::parseCommandString('command "param1 extra" param2').should eq(['command', 'param1 extra', 'param2'])
+            CLI::Console::parseCommandString('command "param1" "param2 extra"').should eq(['command', 'param1', 'param2 extra'])
+        end
+
+        it 'should parse command with single quotes' do
+            CLI::Console::parseCommandString('command \'param1 extra\' param2').should eq(['command', 'param1 extra', 'param2'])
+            CLI::Console::parseCommandString('command \'param1\' \'param2 extra\'').should eq(['command', 'param1', 'param2 extra'])
+        end
+
+        it 'should parse command with mixed quotes' do
+            CLI::Console::parseCommandString('command "param1 \'extra double\'" param2').should eq(['command', 'param1 \'extra double\'', 'param2'])
+            CLI::Console::parseCommandString('command "param1" "param2 \'double extra\'"').should eq(['command', 'param1', 'param2 \'double extra\''])
+            CLI::Console::parseCommandString('command \'param1 "extra double"\' param2').should eq(['command', 'param1 "extra double"', 'param2'])
+            CLI::Console::parseCommandString('command \'param1\' \'param2 "double extra"\'').should eq(['command', 'param1', 'param2 "double extra"'])
+        end
+
+        it 'should parse command with escaped quotes' do
+            CLI::Console::parseCommandString('command "param with \" quote"').should eq(['command', 'param with " quote'])
+            CLI::Console::parseCommandString('command \'param with \\\' quote\'').should eq(['command', 'param with \' quote'])
+        end
+
+        it 'should parse command with escaped quotes in quotes' do
+            CLI::Console::parseCommandString('command "param1 \'extra \"double double\"\'" param2').should eq(['command', 'param1 \'extra "double double"\'', 'param2'])
+        end
+
+    end
+
     describe '#initialize' do
         it 'should return cli-console instance' do
             console.should be_kind_of(CLI::Console)
@@ -72,17 +105,40 @@ describe CLI::Console do
     end
 
     describe '#processCommand' do
-        it 'should execute succesfully' do
+        before do
             init
-            console.processCommand('tr')
-            console.processCommand('try more')
-            console.processCommand('q')
-            console.processCommand('quit')
-            console.processCommand('help')
-            console.processCommand('help tr')
-            console.processCommand('help try')
-            console.processCommand('help not')
-            console.processCommand('help e')
+        end
+
+        it 'should return zero' do
+            console.processCommand('').should eq(0)
+        end
+
+        it 'should be ambiguous command' do
+            console.processCommand('tr').should eq(-3)
+        end
+
+        it 'should throw exception' do
+            console.processCommand('try more').should eq(-1)
+        end
+
+        it 'should quit' do
+            console.processCommand('q').should eq(console.ExitCode)
+            console.processCommand('quit').should eq(console.ExitCode)
+        end
+
+        it 'should show help' do
+            console.processCommand('help').should be_nil
+            console.processCommand('help try').should be_nil
+            console.processCommand('help e').should be_nil
+        end
+
+        it 'should show help for method and alias' do
+            console.processCommand('help tr').should be_kind_of(Array)
+        end
+
+        it 'should execute succesfully' do
+            console.processCommand('help not').should be_nil
+
         end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-console
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Dāvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.16
 description: Basic library for making interactive command-line applications much easier
 email:
 - davispuh@gmail.com
@@ -113,3 +127,4 @@ summary: Create CLI applications easily
 test_files:
 - spec/cli-console_spec.rb
 - spec/spec_helper.rb
+has_rdoc: