tcollier-commando 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5325137899697d0e9166e6cbe578ac16be28753e
-  data.tar.gz: b27473af548a18cc382444b85d20574a7b1a1e58
+  metadata.gz: 616c0c39dc6ef5e239dd4b357b735cab2c1361a5
+  data.tar.gz: 38905d35b013e6c7905429d3d6cf999f8f2cfe82
 SHA512:
-  metadata.gz: 2068d9b73e94d36a392f7be87bcef00df62bc6d18a089ea319ac565ab06f3b7ab40b5508767457af5cd00c4c43da15605cc03764fdfc02f5e1ef3e6836bf07f1
-  data.tar.gz: e87b4c3b616b2342cb016bc5837489dbc54727c1be30b054a401442099e8bac64ae18825a35058ef11db6914b80c1e846e3ffcb1a20f1f48c13e3f9c0900e917
+  metadata.gz: 65e223e84795fa85613a8928ff1243a2f614d70a87b47f2b6062584b2c98eceb440938358c486843045a5127f7480897ab7ba990043e27b2997559c1d86835d0
+  data.tar.gz: b19ca353543f8e878320e963d75574735d0bf5723f7fa1bf5c759124a6ab0ddc6c7028a542518c1e5a8bb83710bea3ef5a03b07a048c700213f8af149ba42c75

data/README.md

@@ -1,6 +1,8 @@
 # Commando
 
-A command line interface builder with Readline support
+Boxers? Briefs? Commando!
+
+_A command line interface builder with Readline support_
 
 ## Versions
 
@@ -9,13 +11,14 @@ A command line interface builder with Readline support
 * `0.1.2` - Remove empty lines from history
 * `0.2.0` - Persist history across CLI sessions
 * `0.2.1` - Fix bug when history file doesn't exist
+* `1.0.0` - Use `ArgumentError` instead of custom error for bad args
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'commando'
+gem 'tcollier-commando'
 ```
 
 And then execute:
@@ -24,7 +27,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install commando
+    $ gem install tcollier-commando
 
 ## Configuration
 
@@ -57,14 +60,14 @@ To support a new command, you must register it with
 
 #### Action role
 
-The `Action role` responds to `perform(args, output:)`, where
+The `Action` role responds to `perform(args, output:)`, where
 
 * `args` [`Array<String>`] - the list of the extra words that follow the command
 (e.g. if the user types `addfriend mary jane`, then the args are `['mary', 'jane']`).
 * `output` [`IO`] - the IO instance that any messages should be written to.
 
 If the arguments are not formatted correctly (e.g. the user missed an argument),
-then method should raise a `Commando::ValidationError` with a descriptive message.
+then method should raise an `ArgumentError` with a descriptive message.
 
 #### Default actions
 

data/lib/commando/interpreter.rb

@@ -1,16 +1,17 @@
 module Commando
   # Interpret a single command from the user.
   class Interpreter
-    # @param input [String] the entire command line string.
     # @param output [IO] the stream any actions should write messages to.
-    def initialize(input:, output: $stdout)
-      @args = input.split(' ')
-      @command = @args.shift
+    def initialize(output: $stdout)
       @output = output
     end
 
     # Performs the action (if valid) for the given input command line
-    def interpret
+    #
+    # @param line [String] the entire command line string.
+    def interpret(line)
+      args = line.split(' ')
+      command = args.shift
       action = Commando.config.lookup(command)
 
       if action.nil?
@@ -22,7 +23,7 @@ module Commando
 
     private
 
-    attr_reader :command, :args, :output
+    attr_reader :output
   end
 
   private_constant :Interpreter

data/lib/commando/version.rb

@@ -1,3 +1,3 @@
 module Commando
-  VERSION = '0.2.1'
+  VERSION = '1.0.0'
 end

data/lib/commando.rb

@@ -2,7 +2,6 @@ require_relative 'commando/config'
 require_relative 'commando/interpreter'
 require_relative 'commando/io_handler'
 require_relative 'commando/quit_exception'
-require_relative 'commando/validation_error'
 require_relative 'commando/version'
 
 # Entry point for the Command Line Interface (CLI).
@@ -26,16 +25,16 @@ module Commando
     output.puts config.greeting
 
     io = IOHandler.new(output: output)
+    interpreter = Interpreter.new(output: output)
 
     loop do
       begin
         if line = io.readline
           # When the user enters a non-empty string, pass the line to the
           # interpreter and handle the command.
-          interpreter = Interpreter.new(input: line, output: output)
-          interpreter.interpret
+          interpreter.interpret(line)
         end
-      rescue ValidationError => error
+      rescue ArgumentError => error
         output.puts "Error: #{error}"
       rescue QuitException
         break

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcollier-commando
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Collier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,7 +78,6 @@ files:
 - lib/commando/interpreter.rb
 - lib/commando/io_handler.rb
 - lib/commando/quit_exception.rb
-- lib/commando/validation_error.rb
 - lib/commando/version.rb
 homepage: https://github.com/tcollier/commando
 licenses:

data/lib/commando/validation_error.rb

@@ -1,4 +0,0 @@
-module Commando
-  class ValidationError < StandardError
-  end
-end