cliqr 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b1c3a47c4045454a48b832cc443ea735fe538ae
-  data.tar.gz: 4b919b535387086386da176acc4a470b8cf597e6
+  metadata.gz: 21be1b361f2ce33096983d813f3a9185018e5ffd
+  data.tar.gz: f6abf3c9cdeddeb784d690b584505f23f350828f
 SHA512:
-  metadata.gz: 88d7eeb4ca572c3dfb8715611b2f3c5355ef9a5f5cee2c40497d485bc190c1869e57d8e4780f9507de91ad41fd15cebd44066bb28afd0ff68f6c081d67ecd1df
-  data.tar.gz: bf965708a3fbb48c021875fd87dfb51f417fe3f73c2e85d8053e5ec449942b0ffb62461ede244f2b48297880acc0aa7160bc1c0db23c510f128a3e61a969588b
+  metadata.gz: b0dfd50fbfeb23536cd14839f249cdc5f857a4562524c0935eb7788750e28c4cb1ec98c105384b77d2fa34ae8de8ec1e3752d39f45350acc9ac195a3d3f7a972
+  data.tar.gz: 7e43a504e6548df5a6525832498715fd96ef291669af4f0b3d5a252bb53a5ffd8d68bfcd35c5c278605345727368d623f48dec4487f9589656313bb5c7be03a8

data/CHANGELOG.md

@@ -1,65 +1,223 @@
+Here is a list of all releases with a description of what went in for
+that release along with features, improvements and bug fixes. Click on a
+item in this nested table for further details.
+
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
+**Table of Contents**
+
+- [0.1.0 / 2015-05-29](#010--2015-05-29)
+    - [Features](#features)
+        - [First pass at building ability to parse command line arguments](#first-pass-at-building-ability-to-parse-command-line-arguments)
+        - [Validations of command line arguments](#validations-of-command-line-arguments)
+    - [Minor improvements](#minor-improvements)
+        - [Organize the specs properly](#organize-the-specs-properly)
+        - [Add more description in README](#add-more-description-in-readme)
+    - [Bug-fixes](#bug-fixes)
+- [0.0.4 / 2015-05-11](#004--2015-05-11)
+    - [Features](#features)
+        - [Documentation coverage](#documentation-coverage)
+        - [Command options](#command-options)
+        - [Command router](#command-router)
+        - [Command usage building](#command-usage-building)
+    - [Minor improvements](#minor-improvements)
+        - [Improve README example](#improve-readme-example)
+        - [Improve README metrics](#improve-readme-metrics)
+    - [Bug fixes](#bug-fixes)
+        - [Minor style fix in rake tasks](#minor-style-fix-in-rake-tasks)
+        - [Make sure specs don't execute twice](#make-sure-specs-dont-execute-twice)
+- [0.0.3 / 2015-05-08](#003--2015-05-08)
+    - [Features](#features)
+        - [Test coverage 100%](#test-coverage-100)
+        - [Check code style](#check-code-style)
+    - [Minor improvements](#minor-improvements)
+        - [Detect document coverage](#detect-document-coverage)
+        - [Continue to improve README](#continue-to-improve-readme)
+- [0.0.2 / 2015-05-07](#002--2015-05-07)
+    - [Features](#features)
+        - [Ability to provide name for top level command](#ability-to-provide-name-for-top-level-command)
+        - [New `rake` tasks](#new-rake-tasks)
+        - [Add badges to README](#add-badges-to-readme)
+        - [Enable travis CI, coveralls and code climate](#enable-travis-ci-coveralls-and-code-climate)
+        - [Add usage example to README](#add-usage-example-to-readme)
+    - [Minor Improvements](#minor-improvements)
+        - [Separate DSL methods](#separate-dsl-methods)
+    - [Bug fixes](#bug-fixes)
+        - [fix rake default task](#fix-rake-default-task)
+- [0.0.1 / 2015-04-29](#001--2015-04-29)
+    - [Features](#features)
+        - [Ability to build and publish  a gem](#ability-to-build-and-publish--a-gem)
+        - [`Rake` as build system](#rake-as-build-system)
+        - [Incorporate `RSpec` for unit tests](#incorporate-rspec-for-unit-tests)
+
+<!-- markdown-toc end -->
+
+
+0.1.0 / 2015-05-29
+==================
+
+Finally! A minor release!
+
+A strong command line app needs a strong command line argument
+parser. This release makes that a reality by introducing a powerful
+generic command line argument parser with some validation capability as
+well.
+
+## Features
+
+### First pass at building ability to parse command line arguments
+
+`Cliqr` can now parse command line arguments and their values. It can work
+with both short names and long names for options.
+
+### Validations of command line arguments
+
+A basic set of validations have also been implemented:
+
+- The option must be defined in the command line config
+- Cannot use the same option twice
+
+## Minor improvements
+
+### Organize the specs properly
+
+Done by moving fixtures in separate location
+
+### Add more description in README
+
+Examples of new developments and remove stale text
+
+## Bug-fixes
+
+NONE
 
 0.0.4 / 2015-05-11
 ==================
 
-  * bring document coverage to 100%
-  * improve documentation
-  * fix minor style error in rake tasks
-  * don't execute specs twice
-  * add support for command options
-  * improve dsl framework by completely hiding dsl methods
-  * add method_missing to proxy all dsl methods
-  * add example for router in readme
-  * ignore document files
-  * add command router
-  * use a template to build usage
-  * move builder spec in its own folder
-  * add command usage section
-  *  change usage information builder
-  * show total downloads in readme
+Extend the capability of CLI app framework by adding some support for
+command options, routing command to a handler and improved usage
+information.
+
+## Features
+
+### Documentation coverage
+
+`Cliqr`'s document coverage will be mainted at 100%. This is enforced at
+build step.
+
+### Command options
+
+Add support for defining command's options in the configuration of
+command line interface.  This also prints the option in a descriptive
+manner in the command's usage.
+
+### Command router
+
+Add ability to define a command handler and route the invocation of a
+command to that handler.
+
+### Command usage building
+
+A `erb` template is used to build the usage information for a
+command. This makes it pretty easy to extend and manipulate the usage
+information.
+
+
+## Minor improvements
+
+### Improve README example
+
+Add information about option handling, command routing and usage
+building.
+
+### Improve README metrics
+
+Add total downloads badge for gem
+
+## Bug fixes
+
+### Minor style fix in rake tasks
+
+### Make sure specs don't execute twice
 
 0.0.3 / 2015-05-08
 ==================
 
-  * add simplecov to make sure test coverage stays at 100 percent
-  * don't allow failure on ruby 2.2
-  * bump required version to 1.9.3
-  * add inch ci badge
-  * don't include rubocop in gemfile for ruby version less than 1.9.3
-  * disable rubocop for ruby 1.9.2
-  * we don't support ruby 1.9.2 anymore
-  * adding build section to readme
-  * added rubocop for code style checking
+## Features
+
+### Test coverage 100%
+
+Used `simplecov` to assert test coverage ot 100%
+
+### Check code style
+
+Use `rubocop` to test code style. This also forced a bump in ruby
+version to 1.9.3 since older versions are not supported by `rubocop`.
+
+## Minor improvements
+
+### Detect document coverage
+
+Add inch CI badge for this.
+
+### Continue to improve README
+
+Add a build section
 
 0.0.2 / 2015-05-07
 ==================
 
-  * add rake cleanup task
-  * adding rdoc rake task
-  * adding yard for checking documentation coverage
-  * use shields.io badges
-  * fix readme toc
-  * add codeclimate and coveralls badges to readme
-  * add coveralls for code coverage reporting
-  * load source code after starting codeclimate reporter
-  * add codeclimate code coverage report
-  * adding example to readme
-  * add travis CI build badge
-  * add build matrix to travis CI settings
-  * set ruby gem name
-  * set ruby version
-  * list files to document
-  * fix rake default task
-  * bring down bundler version to 1.6 for travis CI
-  * adding missing comment in version.rb
-  * enabling Travis CI build
-  * add test to test for non-nil config
-  * separate dsl methods in config class
-  * ignore auto-generated documentation
-  * add ability to provide a name for top level command
-  * adding gem badge to readme
+Starting to develop a DSL for command line definition in this
+release. We will also be extending our usage of `rake`. The `README`
+file should also be kept up to date.
+
+## Features
+
+### Ability to provide name for top level command
+
+This is the beginning of a DSL for interface config definition
+
+### New `rake` tasks
+
+Add tasks like: `cleanup`, `rdoc` and `yard`
+
+### Add badges to README
+
+Add badges for build and code metrics.  Also use shields.io for badge
+urls
+
+### Enable travis CI, coveralls and code climate
+
+More metrics!!
+
+### Add usage example to README
+
+Since documentation is good
+
+## Minor Improvements
+
+### Separate DSL methods
+
+DSL methods should be kept separate from non-DSL methods
+
+## Bug fixes
+
+### fix rake default task
 
 0.0.1 / 2015-04-29
 ==================
 
-  * initial gem version with rspec
+This is the start of this gem. Don't expect much.
+
+## Features
+
+### Ability to build and publish  a gem
+
+A gem named `cliqr` is created
+
+### `Rake` as build system
+
+Rake is the choice of many for building and publishing artifacts
+
+### Incorporate `RSpec` for unit tests
+
+From this point on, we will use rspec for unit testing

data/README.md

@@ -47,8 +47,9 @@ require 'cliqr'
 
 # a custom command handler
 class MyCommandHandler < Cliqr.command
-  def execute
+  def execute(context)
     puts 'executing my awesome command'
+    puts "value for option 'test' is '#{context.option('test').value}'"
   end
 end
 
@@ -61,6 +62,8 @@ cli = Cliqr.interface do
     short 'a'
     description 'this is a option'
   end
+  
+  option 'test'
 end
 
 puts cli.usage
@@ -72,15 +75,12 @@ puts cli.usage
 #> Available options:
 #>
 #>     --an-option, -a  :  this is a option
+#>
+#>     --test
 
-cli.execute
+cli.execute %w(--test some-value)
 #> executing my awesome command
-```
-
-This should print
-
-```
-USAGE: my-command
+#> value for option 'test' is 'some-value'
 ```
 
 ## Installation

data/lib/cliqr.rb

@@ -4,7 +4,7 @@ require 'cliqr/version'
 require 'cliqr/error'
 
 require 'cliqr/cli/config'
-require 'cliqr/cli/builder'
+require 'cliqr/cli/interface'
 require 'cliqr/cli/command'
 
 # Top level namespace for the Cliqr gem
@@ -23,12 +23,12 @@ module Cliqr
     #     option
     #   end
     #
-    # @return [Cliqr::CLI]
+    # @return [Cliqr::CLI::Interface]
     #
     # @api public
     def interface(&block)
       config = CLI::Config.build(&block)
-      CLI::Builder.new(config).build
+      CLI::Interface.build(config)
     end
 
     # All cliqr commands should extend from this. Here is an example:

data/lib/cliqr/cli/argument_validator.rb

@@ -0,0 +1,19 @@
+# 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/command_context.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+
+module Cliqr
+  # Definition and builder for command context
+  module CLI
+    # Manages things like arguments and input/output for a command
+    #
+    # @api private
+    class CommandContext
+      # Command name
+      #
+      # @return [String]
+      attr_accessor :command
+
+      # Build a instance of command context based on the parsed set of arguments
+      #
+      # @param [Hash] parsed_args A hash of parsed command line arguments
+      #
+      # @return [Cliqr::CLI::CommandContext]
+      def self.build(parsed_args)
+        CommandContextBuilder.new(parsed_args).build
+      end
+
+      # Initialize the command context (called by the CommandContextBuilder)
+      #
+      # @return [Cliqr::CLI::CommandContext]
+      def initialize(command, options)
+        @command = command
+        # make option map from array
+        @options = Hash[*options.collect { |option| [option.name, option] }.flatten]
+      end
+
+      # List of parsed options
+      #
+      # @return [Array<Cliqr::CLI::CommandOption>]
+      def options
+        @options.values
+      end
+
+      # Get a option by name
+      #
+      # @param [String] name Name of the option
+      #
+      # @return [Cliqr::CLI::CommandOption] Instance of CommandOption for option
+      def option(name)
+        @options[name]
+      end
+
+      private :initialize
+    end
+
+    private
+
+    # Builder for creating a instance of CommandContext from parsed cli arguments
+    #
+    # @api private
+    class CommandContextBuilder
+      # Initialize builder for CommandContext
+      #
+      # @param [Hash] parsed_args Parsed and validated command line arguments
+      #
+      # @return [Cliqr::CLI::CommandContextBuilder]
+      def initialize(parsed_args)
+        @parsed_args = parsed_args
+      end
+
+      # Build a new instance of CommandContext
+      #
+      # @return [Cliqr::CLI::CommandContext] A newly created CommandContext instance
+      def build
+        CommandContext.new @parsed_args[:command],
+                           @parsed_args[:options].map { |args| CommandOption.new(args) }
+      end
+    end
+
+    # A holder class for a command line argument's name and value
+    #
+    # @api private
+    class CommandOption
+      # Name of a command line argument option
+      #
+      # @return [String]
+      attr_accessor :name
+
+      # Value for the command line argument's option
+      #
+      # @return [Object]
+      attr_accessor :value
+
+      # Create a new command line option instance
+      #
+      # @param [Hash] args Arguments for creating a command line option
+      #
+      # @return [Cliqr::CLI::CommandContext] A new CommandOption object
+      def initialize(args)
+        @name = args[:name]
+        @value = args[:value]
+      end
+    end
+  end
+end