cliqr 1.1.0 → 1.2.0

data/spec/validation/error_spec.rb

@@ -13,7 +13,7 @@ Cause: NoMethodError - undefined method `non_existent' for {}:Hash
       begin
         {}.non_existent
       rescue StandardError => e
-        raise Cliqr::Error::CommandRuntimeException.new('something went wrong', e)
+        raise Cliqr::Error::CommandRuntimeError.new('something went wrong', e)
       end
     rescue Cliqr::Error::CliqrError => e
       expect(e.to_s).to eq(expected_error_message)

data/tasks/rdoc.rake

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+begin
+  require 'rdoc/task'
+
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = '.doc/rdoc'
+    rdoc.title = "cliqr #{Cliqr::VERSION}"
+    rdoc.main = 'README.md'
+    rdoc.rdoc_files.include('README.md', 'LICENSE.txt', 'CHANGELOG.md', 'lib/**/*.rb')
+  end
+  CLEAN.include('.doc')
+  CLEAN.include('doc')
+rescue LoadError
+  # do nothing
+end

data/tasks/rubucop.rake

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+begin
+  require 'rubocop/rake_task'
+
+  desc 'Run RuboCop on the lib directory'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+    # abort rake on failure
+    task.fail_on_error = true
+  end
+rescue
+  # do nothing
+end

data/tasks/yard.rake

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+begin
+  require 'yardstick/rake/measurement'
+  require 'yardstick/rake/verify'
+
+  # yardstick_measure task
+  Yardstick::Rake::Measurement.new do |measurement|
+    measurement.output = '.metrics/yard-report.txt'
+  end
+  CLEAN.include('.metrics')
+  CLEAN.include('.yardoc')
+
+  # verify_measurements task
+  Yardstick::Rake::Verify.new do |verify|
+    verify.threshold = 100
+    verify.require_exact_threshold = false
+  end
+rescue LoadError
+  # do nothing
+end

data/templates/usage.erb

@@ -0,0 +1,39 @@
+<%= command %><% unless description.nil? || description.empty? %> -- <%= description %><% end %>
+
+USAGE:
+    <%= command %><%=
+    ' [actions]' if actions? %><%=
+    ' [options]' if options? %><%=
+    ' [arguments]' if arguments? %><%
+
+if options? %>
+
+Available options:
+<%
+   options.each { |option|
+%>
+    --<%=
+         '[no-]' if option.boolean?
+       %><%=
+         option.name
+       %><%=
+            ", -#{option.short}" if option.short?
+          %><%=
+            if option.details?
+              "  : #{" <#{option.type}>" if option.type?}#{" #{option.description}" if option.description?}#{" (default => #{option.default.inspect})" if option.default?}"
+            end
+          %><%
+   }
+end
+
+if actions? %>
+
+Available actions:
+<%= "[ Type \"#{command} help [action-name]\" to get more information about that action ]\n" if help? %><%
+   actions.each { |action|
+%>
+    <%= action.name %><%= " -- #{action.description}" if action.description? %>
+<%
+   }
+%>
+<% end %>

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: cliqr
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Anshul Verma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 description: |2
@@ -54,10 +54,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/README.md
+- examples/hbase
+- examples/my-command
+- examples/numbers
+- examples/vagrant
 - lib/cliqr.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/argument_operator.rb
+- lib/cliqr/cli/argument_operator_context.rb
 - lib/cliqr/cli/command.rb
 - lib/cliqr/cli/command_context.rb
 - lib/cliqr/cli/command_runner_factory.rb
@@ -65,11 +72,14 @@ files:
 - lib/cliqr/cli/executor.rb
 - lib/cliqr/cli/interface.rb
 - lib/cliqr/cli/router.rb
+- lib/cliqr/cli/shell_command.rb
+- lib/cliqr/cli/usage_builder.rb
 - lib/cliqr/config_validation/validation_set.rb
 - lib/cliqr/config_validation/validator_factory.rb
 - lib/cliqr/config_validation/verifiable.rb
 - lib/cliqr/dsl.rb
 - lib/cliqr/error.rb
+- lib/cliqr/parser/action_token.rb
 - lib/cliqr/parser/argument_parser.rb
 - lib/cliqr/parser/argument_token.rb
 - lib/cliqr/parser/argument_tree_walker.rb
@@ -80,25 +90,41 @@ files:
 - lib/cliqr/parser/single_valued_option_token.rb
 - lib/cliqr/parser/token.rb
 - lib/cliqr/parser/token_factory.rb
+- lib/cliqr/util.rb
 - lib/cliqr/validation_errors.rb
 - lib/cliqr/version.rb
+- spec/argument_parser_spec_helper.rb
+- spec/config/action_config_validator_spec.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/dsl/usage_spec.rb
+- spec/executor/action_executor_spec.rb
 - spec/executor/command_runner_spec.rb
 - spec/executor/executor_spec.rb
+- spec/executor/help_executor_spec.rb
+- spec/executor/shell_executor_spec.rb
+- spec/fixtures/action_reader_command.rb
 - spec/fixtures/always_error_command.rb
 - spec/fixtures/argument_reader_command.rb
+- spec/fixtures/csv_argument_operator.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/fixtures/test_option_type_checker_command.rb
+- spec/parser/action_argument_parser_spec.rb
 - spec/parser/argument_parser_spec.rb
 - spec/spec_helper.rb
-- spec/validation/argument_validation_spec.rb
+- spec/validation/action_argument_validator_spec.rb
+- spec/validation/command_argument_validation_spec.rb
 - spec/validation/error_spec.rb
 - spec/validation/validation_spec.rb
+- tasks/rdoc.rake
+- tasks/rubucop.rake
+- tasks/yard.rake
+- templates/usage.erb
 homepage: https://github.com/anshulverma/cliqr
 licenses:
 - MIT
@@ -109,36 +135,47 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A framework and DSL for defining CLI interface
 test_files:
+- spec/argument_parser_spec_helper.rb
+- spec/config/action_config_validator_spec.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/dsl/usage_spec.rb
+- spec/executor/action_executor_spec.rb
 - spec/executor/command_runner_spec.rb
 - spec/executor/executor_spec.rb
+- spec/executor/help_executor_spec.rb
+- spec/executor/shell_executor_spec.rb
+- spec/fixtures/action_reader_command.rb
 - spec/fixtures/always_error_command.rb
 - spec/fixtures/argument_reader_command.rb
+- spec/fixtures/csv_argument_operator.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/fixtures/test_option_type_checker_command.rb
+- spec/parser/action_argument_parser_spec.rb
 - spec/parser/argument_parser_spec.rb
 - spec/spec_helper.rb
-- spec/validation/argument_validation_spec.rb
+- spec/validation/action_argument_validator_spec.rb
+- spec/validation/command_argument_validation_spec.rb
 - spec/validation/error_spec.rb
 - spec/validation/validation_spec.rb
 has_rdoc: