cliqr 0.1.0 → 1.0.0

data/spec/executor/executor_spec.rb

@@ -8,6 +8,7 @@ require 'fixtures/test_command'
 require 'fixtures/always_error_command'
 require 'fixtures/option_reader_command'
 require 'fixtures/test_option_reader_command'
+require 'fixtures/test_option_checker_command'
 
 describe Cliqr::CLI::Executor do
   it 'returns code 0 for default command runner' do
@@ -79,7 +80,24 @@ some-value
       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"
+      expect(e.message).to eq "command 'my-command' failed\n\nCause: StandardError - I always throw an error\n"
     end
   end
+
+  it 'allows command to check if an option exists or not' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      description 'a command used to test cliqr'
+      handler TestOptionCheckerCommand
+
+      option 'test-option' do
+        type :boolean
+      end
+    end
+
+    result = cli.execute %w(--test-option), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+test-option is defined
+    EOS
+  end
 end

data/spec/fixtures/test_option_checker_command.rb

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

data/spec/parser/argument_parser_spec.rb

@@ -2,12 +2,13 @@
 
 require 'spec_helper'
 
-require 'cliqr/cli/parser/argument_parser'
+require 'cliqr/parser/argument_parser'
+require 'cliqr/parser/parsed_input'
 
 require 'fixtures/test_command'
 require 'fixtures/option_reader_command'
 
-describe Cliqr::CLI::Parser do
+describe Cliqr::Parser do
   TEST_CLI = Cliqr.interface do
     basename 'my-command'
     handler TestCommand
@@ -17,40 +18,35 @@ describe Cliqr::CLI::Parser do
     end
   end
   CONFIG = TEST_CLI.config
-  PARSER = Cliqr::CLI::Parser
+  PARSER = Cliqr::Parser
 
   it 'can parse no argument command' do
-    expect(PARSER.parse(CONFIG, [])).to eq(:command => 'my-command',
-                                           :options => [])
+    expect(PARSER.parse(CONFIG, [])).to eq(Cliqr::Parser::ParsedInput.new(: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)
+    parsed_input = Cliqr::Parser::ParsedInput.new(:command => 'my-command',
+                                                  :options => [
+                                                    {
+                                                        :name => 'test-option',
+                                                        :value => 'abcd'
+                                                    }
+                                                  ])
+    expect(PARSER.parse(CONFIG, %w(--test-option abcd))).to eq(parsed_input)
   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'
-          }
-        ]
-    }
+    parsed_input = Cliqr::Parser::ParsedInput.new(: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
@@ -58,20 +54,18 @@ describe Cliqr::CLI::Parser do
       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)
+    expect(Cliqr::Parser.parse(cli.config, %w(--test-option-1 abcd --test-option-2 xyz))).to eq(parsed_input)
   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)
+    parsed_input = Cliqr::Parser::ParsedInput.new(:command => 'my-command',
+                                                  :options => [
+                                                    {
+                                                        :name => 'test-option',
+                                                        :value => 'abcd'
+                                                    }
+                                                  ])
+    expect(PARSER.parse(CONFIG, %w(-t abcd))).to eq(parsed_input)
   end
 
   it 'cannot parse unknown options' do

data/spec/validation/argument_validation_spec.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+require 'cliqr/argument_validation/validator'
+
+require 'fixtures/test_command'
+require 'fixtures/test_option_reader_command'
+
+describe Cliqr::ArgumentValidation::Validator do
+  it 'can validate numerical arguments' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestOptionReaderCommand
+
+      option 'test-option' do
+        type :numeric
+      end
+    end
+
+    result = cli.execute %w(--test-option 123), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+123
+    EOS
+  end
+
+  it 'does not allow string for numeric option types' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestCommand
+
+      option 'age' do
+        type :numeric
+      end
+    end
+
+    expect do
+      cli.execute %w(--age abcd)
+    end.to raise_error(Cliqr::Error::IllegalArgumentError,
+                       "illegal argument error - only values of type 'numeric' allowed for option 'age'")
+  end
+
+  it 'can validate boolean option arguments' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestOptionReaderCommand
+
+      option 'test-option' do
+        type :boolean
+      end
+    end
+
+    result = cli.execute %w(--test-option), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+true
+    EOS
+  end
+
+  it 'can validate boolean option argumentswith short name' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestOptionReaderCommand
+
+      option 'test-option' do
+        short 't'
+        type :boolean
+      end
+    end
+
+    result = cli.execute %w(-t), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+true
+    EOS
+  end
+
+  it 'can validate boolean option arguments for false' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestOptionReaderCommand
+
+      option 'test-option' do
+        type :boolean
+      end
+    end
+
+    result = cli.execute %w(--no-test-option), output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+false
+    EOS
+  end
+
+  it 'does not allow string for boolean option types' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      handler TestCommand
+
+      option 'opt' do
+        type :boolean
+      end
+    end
+
+    expect do
+      cli.execute %w(--opt qwe)
+    end.to raise_error(Cliqr::Error::InvalidArgumentError,
+                       "invalid command argument \"qwe\"")
+  end
+
+  it 'allows numeric options to be optional' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      description 'this is an awesome command...try it out'
+      handler TestCommand
+
+      option 'count' do
+        type :numeric
+      end
+    end
+
+    result = cli.execute [], output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+test command executed
+    EOS
+  end
+
+  it 'allows boolean options to be optional' do
+    cli = Cliqr.interface do
+      basename 'my-command'
+      description 'this is an awesome command...try it out'
+      handler TestCommand
+
+      option 'single' do
+        type :boolean
+      end
+    end
+
+    result = cli.execute [], output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+test command executed
+    EOS
+  end
+end

data/spec/validation/error_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Cliqr::Error do
+  it 'makes use of to_s to print the error message' do
+    expected_error_message = <<-EOS
+something went wrong
+
+Cause: NoMethodError - undefined method `non_existent' for {}:Hash
+    EOS
+    begin
+      begin
+        {}.non_existent
+      rescue StandardError => e
+        raise Cliqr::Error::CommandRuntimeException.new('something went wrong', e)
+      end
+    rescue Cliqr::Error::CliqrError => e
+      expect(e.to_s).to eq(expected_error_message)
+    end
+  end
+end

data/spec/validation/validation_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Cliqr::Validation do
+  it 'does not know how to validate unknown types' do
+    expect do
+      Cliqr::Validation::ValidatorFactory.get(:bla, {}).validate(nil, nil, nil)
+    end.to raise_error(Cliqr::Error::UnknownValidatorType, "unknown validation type: 'bla'")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliqr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Anshul Verma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -55,35 +55,47 @@ files:
 - README.md
 - Rakefile
 - lib/cliqr.rb
-- lib/cliqr/cli/argument_validator.rb
+- lib/cliqr/argument_validation/argument_type_validator.rb
+- lib/cliqr/argument_validation/option_validator.rb
+- lib/cliqr/argument_validation/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/dsl.rb
 - lib/cliqr/error.rb
+- lib/cliqr/parser/argument_parser.rb
+- lib/cliqr/parser/argument_tree_walker.rb
+- lib/cliqr/parser/boolean_option_token.rb
+- lib/cliqr/parser/parsed_input.rb
+- lib/cliqr/parser/parsed_input_builder.rb
+- lib/cliqr/parser/single_valued_option_token.rb
+- lib/cliqr/parser/token.rb
+- lib/cliqr/parser/token_factory.rb
+- lib/cliqr/validation/validation_set.rb
+- lib/cliqr/validation/validator_factory.rb
+- lib/cliqr/validation/verifiable.rb
+- lib/cliqr/validation_errors.rb
 - lib/cliqr/version.rb
 - spec/config/config_finalize_spec.rb
 - spec/config/config_validator_spec.rb
+- spec/config/option_config_validator_spec.rb
 - spec/dsl/interface_spec.rb
 - spec/executor/command_runner_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_checker_command.rb
 - spec/fixtures/test_option_reader_command.rb
 - spec/parser/argument_parser_spec.rb
 - spec/spec_helper.rb
+- spec/validation/argument_validation_spec.rb
+- spec/validation/error_spec.rb
+- spec/validation/validation_spec.rb
 homepage: https://github.com/anshulverma/cliqr
 licenses:
 - MIT
@@ -111,13 +123,18 @@ summary: A framework and DSL for defining CLI interface
 test_files:
 - spec/config/config_finalize_spec.rb
 - spec/config/config_validator_spec.rb
+- spec/config/option_config_validator_spec.rb
 - spec/dsl/interface_spec.rb
 - spec/executor/command_runner_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_checker_command.rb
 - spec/fixtures/test_option_reader_command.rb
 - spec/parser/argument_parser_spec.rb
 - spec/spec_helper.rb
+- spec/validation/argument_validation_spec.rb
+- spec/validation/error_spec.rb
+- spec/validation/validation_spec.rb
 has_rdoc: 

data/lib/cliqr/cli/argument_validator.rb

@@ -1,19 +0,0 @@
-# encoding: utf-8
-
-module Cliqr
-  module CLI
-    # Utiity class to validate input to a command
-    #
-    # @api private
-    class ArgumentValidator
-      # Validate parsed command line arguments
-      #
-      # @param [Hash] args Parsed argument hash
-      #
-      # @return [Hash] Validated argument hash
-      def validate(args)
-        args
-      end
-    end
-  end
-end

data/lib/cliqr/cli/config_validator.rb

@@ -1,104 +0,0 @@
-# encoding: utf-8
-
-require 'cliqr/error'
-
-module Cliqr
-  module CLI
-    # Validator for the command line interface configuration
-    #
-    # @api private
-    class ConfigValidator
-      # 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, 'a valid config should be defined' if config.nil?
-        fail Cliqr::Error::BasenameNotDefined, 'basename not defined' if config.basename.empty?
-
-        fail Cliqr::Error::HandlerNotDefined,
-             "handler not defined for command \"#{config.basename}\"" if config.handler.nil?
-
-        fail Cliqr::Error::InvalidCommandHandler,
-             "handler for command \"#{config.basename}\" should extend from [Cliqr::CLI::Command]" \
-             unless config.handler < Command
-
-        check_options(config)
-
-        config
-      end
-
-      # Check if config's options list is not nil
-      #
-      # @param [Cliqr::CLI::Config] config Configuration settings for the command line interface
-      #
-      # @return [Cliqr::CLI::Config] Validated config
-      def self.check_options(config)
-        fail Cliqr::Error::OptionsNotDefinedException,
-             "option array is nil for command \"#{config.basename}\"" if config.options.nil?
-
-        config
-      end
-    end
-
-    # Validator for validating option configuration in a CLI interface config
-    #
-    # @api private
-    class OptionConfigValidator
-      # Validate a command line interface's config for an option
-      #
-      # @param [Cliqr::CLI::OptionConfig] config Config for this particular option
-      # @param [Cliqr::CLI::Config] parent_config Config of the parent config instance
-      #
-      # @return [Cliqr::CLI::OptionConfig] Validated OptionConfig instance
-      def self.validate(config, parent_config)
-        validate_option_name(config, parent_config)
-
-        fail Cliqr::Error::InvalidOptionDefinition,
-             "option \"#{config.name}\" has empty short name" \
-              if !config.short.nil? && config.short.empty?
-
-        validate_short_option(config, parent_config) if config.short?
-
-        config
-      end
-
-      # Validates name for an option
-      #
-      # @param [Cliqr::CLI::OptionConfig] config Config for this particular option
-      # @param [Cliqr::CLI::Config] parent_config Config of the parent config instance
-      #
-      # @return [Cliqr::CLI::OptionConfig] Validated OptionConfig instance
-      def self.validate_option_name(config, parent_config)
-        fail Cliqr::Error::DuplicateOptions,
-             "multiple options with long name \"#{config.name}\"" \
-             if parent_config.option?(config.name)
-
-        fail Cliqr::Error::InvalidOptionDefinition,
-             "option number #{parent_config.options.length + 1} does not have a name field" \
-              unless config.name?
-
-        config
-      end
-
-      # Validates short name for an option
-      #
-      # @param [Cliqr::CLI::OptionConfig] config Config for this particular option
-      # @param [Cliqr::CLI::Config] parent_config Config of the parent config instance
-      #
-      # @return [Cliqr::CLI::OptionConfig] Validated OptionConfig instance
-      def self.validate_short_option(config, parent_config)
-        fail Cliqr::Error::DuplicateOptions,
-             "multiple options with short name \"#{config.short}\"" \
-              if parent_config.option?(config.short)
-
-        fail Cliqr::Error::InvalidOptionDefinition,
-             "short option name can not have more than one characters in \"#{config.name}\"" \
-             if /^[a-z0-9A-Z]$/.match(config.short).nil?
-
-        config
-      end
-    end
-  end
-end