cliqr 0.0.4 → 0.1.0

data/spec/executor/command_runner_spec.rb

@@ -2,6 +2,8 @@
 
 require 'spec_helper'
 
+require 'cliqr/cli/command_runner_factory'
+
 describe Cliqr::CLI::CommandRunnerFactory do
   it 'returns standard runner for default output' do
     runner = Cliqr::CLI::CommandRunnerFactory.get(output: :default)
@@ -18,8 +20,4 @@ describe Cliqr::CLI::CommandRunnerFactory do
       raise_error(be_kind_of(Cliqr::Error::UnknownCommandRunnerException))
     )
   end
-
-  it 'returns code 0 for default command runner' do
-    expect(Cliqr.command.new.execute).to eq(0)
-  end
 end

data/spec/executor/executor_spec.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+require 'cliqr/error'
+
+require 'fixtures/test_command'
+require 'fixtures/always_error_command'
+require 'fixtures/option_reader_command'
+require 'fixtures/test_option_reader_command'
+
+describe Cliqr::CLI::Executor do
+  it 'returns code 0 for default command runner' do
+    expect(Cliqr.command.new.execute).to eq(0)
+  end
+
+  it 'routes base command with no arguments' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestCommand
+    end
+    result = cli.execute [], output: :buffer
+    expect(result[:stdout]).to eq "test command executed\n"
+  end
+
+  it 'handles error appropriately' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler AlwaysErrorCommand
+    end
+    expect { cli.execute [] }.to raise_error(Cliqr::Error::CommandRuntimeException)
+  end
+
+  it 'routes a command with option values' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestCommand
+
+      option 'test-option'
+    end
+    result = cli.execute %w(--test-option some-value), output: :buffer
+    expect(result[:stdout]).to eq "test command executed\n"
+  end
+
+  it 'lets a command get all option values' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler OptionReaderCommand
+
+      option 'test-option'
+    end
+    result = cli.execute %w(--test-option some-value), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+my-command
+
+[option] test-option => some-value
+    EOS
+  end
+
+  it 'lets a command get single option value' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestOptionReaderCommand
+
+      option 'test-option'
+    end
+    result = cli.execute %w(--test-option some-value), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+some-value
+    EOS
+  end
+
+  it 'handles executor error cause properly' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler AlwaysErrorCommand
+    end
+    begin
+      cli.execute
+    rescue Cliqr::Error::CliqrError => e
+      expect(e.backtrace[0]).to end_with "cliqr/spec/fixtures/always_error_command.rb:6:in `execute'"
+      expect(e.message).to eq "command 'my-command' failed\n\nCause: StandardError - I always throw an error"
+    end
+  end
+end

data/spec/{executor/fixtures → fixtures}/always_error_command.rb

@@ -2,7 +2,7 @@
 
 # A command that always throws an error
 class AlwaysErrorCommand < Cliqr.command
-  def execute
+  def execute(_context)
     fail StandardError, 'I always throw an error'
   end
 end

data/spec/fixtures/option_reader_command.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+# A command that echoes the options back
+class OptionReaderCommand < Cliqr.command
+  def execute(context)
+    puts "#{context.command}\n\n"
+    context.options.each do |option|
+      puts "[option] #{option.name} => #{option.value}"
+    end
+  end
+end

data/spec/{executor/fixtures → fixtures}/test_command.rb

@@ -2,7 +2,7 @@
 
 # Test command for the router_spec
 class TestCommand < Cliqr.command
-  def execute
+  def execute(_context)
     puts 'test command executed'
   end
 end

data/spec/fixtures/test_option_reader_command.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+# A command that echoes the value for option named 'test-option'
+class TestOptionReaderCommand < Cliqr.command
+  def execute(context)
+    puts context.option('test-option').value
+  end
+end

data/spec/parser/argument_parser_spec.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+require 'cliqr/cli/parser/argument_parser'
+
+require 'fixtures/test_command'
+require 'fixtures/option_reader_command'
+
+describe Cliqr::CLI::Parser do
+  TEST_CLI = Cliqr.interface do
+    basename 'my-command'
+    handler TestCommand
+
+    option 'test-option' do
+      short 't'
+    end
+  end
+  CONFIG = TEST_CLI.config
+  PARSER = Cliqr::CLI::Parser
+
+  it 'can parse no argument command' do
+    expect(PARSER.parse(CONFIG, [])).to eq(:command => 'my-command',
+                                           :options => [])
+  end
+
+  it 'can parse command with option using long name' do
+    expected_arguments = {
+        :command => 'my-command',
+        :options => [
+          {
+              :name => 'test-option',
+              :value => 'abcd'
+          }
+        ]
+    }
+    expect(PARSER.parse(CONFIG, %w(--test-option abcd))).to eq(expected_arguments)
+  end
+
+  it 'can parse multiple options' do
+    expected_arguments = {
+        :command => 'my-command',
+        :options => [
+          {
+              :name => 'test-option-1',
+              :value => 'abcd'
+          },
+          {
+              :name => 'test-option-2',
+              :value => 'xyz'
+          }
+        ]
+    }
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestCommand
+
+      option 'test-option-1'
+      option 'test-option-2'
+    end
+    expect(Cliqr::CLI::Parser.parse(cli.config, %w(--test-option-1 abcd --test-option-2 xyz))).to eq(expected_arguments)
+  end
+
+  it 'can parse command with option using short name' do
+    expected_arguments = {
+        :command => 'my-command',
+        :options => [
+          {
+              :name => 'test-option',
+              :value => 'abcd'
+          }
+        ]
+    }
+    expect(PARSER.parse(CONFIG, %w(-t abcd))).to eq(expected_arguments)
+  end
+
+  it 'cannot parse unknown options' do
+    expect { PARSER.parse(CONFIG, %w(--unknown-option abcd)) }.to(
+      raise_error(Cliqr::Error::UnknownCommandOption, 'unknown option "--unknown-option"'))
+    expect { PARSER.parse(CONFIG, %w(-u abcd)) }.to(
+      raise_error(Cliqr::Error::UnknownCommandOption, 'unknown option "-u"'))
+  end
+
+  it 'cannot parse invalid options' do
+    expect { PARSER.parse(CONFIG, %w(--1)) }.to(
+      raise_error(Cliqr::Error::InvalidArgumentError, 'invalid command argument "--1"'))
+    expect { PARSER.parse(CONFIG, %w(-$)) }.to(
+      raise_error(Cliqr::Error::InvalidArgumentError, 'invalid command argument "-$"'))
+  end
+
+  it 'cannot parse option without value if required' do
+    expect { PARSER.parse(CONFIG, %w(--test-option)) }.to(
+      raise_error(Cliqr::Error::OptionValueMissing, 'a value must be defined for option "--test-option"'))
+  end
+
+  it 'cannot parse option if it has multiple values' do
+    expect { PARSER.parse(CONFIG, %w(--test-option val1 --test-option val2)) }.to(
+      raise_error(Cliqr::Error::MultipleOptionValues, 'multiple values for option "--test-option"'))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliqr
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Anshul Verma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -55,13 +55,21 @@ files:
 - README.md
 - Rakefile
 - lib/cliqr.rb
-- lib/cliqr/cli/builder.rb
+- lib/cliqr/cli/argument_validator.rb
 - lib/cliqr/cli/command.rb
+- lib/cliqr/cli/command_context.rb
 - lib/cliqr/cli/command_runner_factory.rb
 - lib/cliqr/cli/config.rb
+- lib/cliqr/cli/config_validator.rb
+- lib/cliqr/cli/executor.rb
 - lib/cliqr/cli/interface.rb
+- lib/cliqr/cli/parser/argument_parser.rb
+- lib/cliqr/cli/parser/argument_tree_walker.rb
+- lib/cliqr/cli/parser/option_token.rb
+- lib/cliqr/cli/parser/parsed_argument_builder.rb
+- lib/cliqr/cli/parser/token.rb
+- lib/cliqr/cli/parser/token_factory.rb
 - lib/cliqr/cli/router.rb
-- lib/cliqr/cli/validator.rb
 - lib/cliqr/dsl.rb
 - lib/cliqr/error.rb
 - lib/cliqr/version.rb
@@ -69,9 +77,12 @@ files:
 - spec/config/config_validator_spec.rb
 - spec/dsl/interface_spec.rb
 - spec/executor/command_runner_spec.rb
-- spec/executor/fixtures/always_error_command.rb
-- spec/executor/fixtures/test_command.rb
-- spec/executor/router_spec.rb
+- spec/executor/executor_spec.rb
+- spec/fixtures/always_error_command.rb
+- spec/fixtures/option_reader_command.rb
+- spec/fixtures/test_command.rb
+- spec/fixtures/test_option_reader_command.rb
+- spec/parser/argument_parser_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/anshulverma/cliqr
 licenses:
@@ -102,8 +113,11 @@ test_files:
 - spec/config/config_validator_spec.rb
 - spec/dsl/interface_spec.rb
 - spec/executor/command_runner_spec.rb
-- spec/executor/fixtures/always_error_command.rb
-- spec/executor/fixtures/test_command.rb
-- spec/executor/router_spec.rb
+- spec/executor/executor_spec.rb
+- spec/fixtures/always_error_command.rb
+- spec/fixtures/option_reader_command.rb
+- spec/fixtures/test_command.rb
+- spec/fixtures/test_option_reader_command.rb
+- spec/parser/argument_parser_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/cliqr/cli/builder.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-
-require 'cliqr/cli/validator'
-require 'cliqr/cli/interface'
-
-module Cliqr
-  module CLI
-    # Builds usage information from [CLI::Config]
-    #
-    # @api private
-    class Builder
-      # Start building a command line interface
-      #
-      # @param [Cliqr::CLI::Config] config the configuration options for the
-      # interface (validated using CLI::Validator)
-      #
-      # @return [Cliqr::CLI::Builder]
-      def initialize(config)
-        @config = config
-      end
-
-      # Validate and build a cli interface based on the configuration options
-      #
-      # @return [Cliqr::CLI::Interface]
-      def build
-        CLI::Validator.validate @config
-        Interface.new(@config)
-      end
-    end
-  end
-end

data/lib/cliqr/cli/validator.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-
-require 'cliqr/error'
-
-module Cliqr
-  module CLI
-    # Validator for the command line interface configuration
-    #
-    # @api private
-    class Validator
-      # Validates the config to make sure all the options are correctly set
-      #
-      # @param [Cliqr::CLI::Config] config Settings for building command line interface
-      #
-      # @return [Cliqr::CLI::Config] Validated config object
-      def self.validate(config)
-        fail Cliqr::Error::ConfigNotFound, 'config is nil' if config.nil?
-        fail Cliqr::Error::BasenameNotDefined, 'basename is not defined' if config.basename.empty?
-
-        fail Cliqr::Error::HandlerNotDefined, 'command handler not defined' if config.handler.nil?
-        fail Cliqr::Error::InvalidCommandHandler,
-             'command handler must extend from Cliqr::CLI::Command' unless config.handler < Command
-
-        fail Cliqr::Error::OptionsNotDefinedException,
-             'options cannot be nil' if config.options.nil?
-
-        config
-      end
-    end
-  end
-end

data/spec/executor/router_spec.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-require 'executor/fixtures/test_command'
-require 'executor/fixtures/always_error_command'
-
-describe Cliqr::CLI::Router do
-  it 'routes base command with no arguments' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      handler TestCommand
-    end
-    result = cli.execute output: :buffer
-    expect(result[:stdout]).to eq "test command executed\n"
-  end
-
-  it 'handles error appropriately' do
-    cli = Cliqr.interface do
-      basename 'my-command'
-      handler AlwaysErrorCommand
-    end
-    expect { cli.execute }.to raise_error(Cliqr::Error::CommandRuntimeException)
-  end
-end