tcollier-commando 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fb82072f6cdcc9e0520a32ade43924acd20dfff
-  data.tar.gz: d856cb9045676d0954ea1688f229dcbbb3c2772e
+  metadata.gz: b409b80542b9797e8624584c37b6850b16ae7834
+  data.tar.gz: 7379329a9a815040d178da7008625add71b56d97
 SHA512:
-  metadata.gz: 3f9309d4f4f84b37fd4036c64fc0463a35650bc79cdf104298018c982c8dfd5fb2439b86b20a005c2d96add8e852f0f7263f7f6bda5daf0474a158c6ed3a4005
-  data.tar.gz: 002b84ff2a1f5b49e51a4bc4992e1f36a20675d78f46ed51feab96472fdd7e1420fd1bb351dda594787e146b969f6d2d390e29c8bd3210e53e3d9991a9411fc8
+  metadata.gz: 876079a43c673ac8e7817ea08da0222ccda8cecca6e98cc4f5ac17655f17c2b000e0a57aa3e4add91f46890239a47c4be8eef90d2ae7111d484e1ccfae4a7bab
+  data.tar.gz: d1baa3112c277c030cb8d35fe80447aa7fe0d5bf3fe647288c597d541a44cbed9265ab24e3b907b44c7cda3d5eceee396260b8c057031f9671428ce550f2606e

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem

data/README.md

@@ -2,6 +2,11 @@
 
 A command line interface builder with Readline support
 
+## Versions
+
+* `0.1.0` - Initial release
+* `0.1.1` - Alphabetize commands printed via `help`
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,12 +39,24 @@ end
 
 ### Actions
 
-To support a new command, you must register it with the command the user will
-type (e.g. `help`), a class/module/instance that responds to `#perform(args, output:)`,
-where `args` is an `Array<String>` of the extra words the follow the command
-(e.g. if the user types `addfriend mary jane`, then the args are `['mary', 'jane']`)
-and `output` is the `IO` instance that any messages should be written to. By
-default `IO` is `$stdout`
+To support a new command, you must register it with
+
+* The command the user will type (e.g. `addfriend`).
+* A class/module/instance that fills the `Action` role.
+* A brief description of what the command does and what arguments it takes, if any.
+
+#### Action role
+
+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.
+
+#### Default actions
 
 A few default actions have been registered
 
@@ -47,6 +64,11 @@ A few default actions have been registered
 * history - Prints the history of commands entered so far
 * quit - Exits the program
 
+## Usage
+
+Once commando is configured, simply run `Commando.start` to enter the command
+line interface.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/commando. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/commando/action/help.rb

@@ -6,7 +6,8 @@ module Commando
     module Help
       def self.perform(args:, output: $stdout)
         output.puts "Valid commands are"
-        Commando.config.each_action do |command, description|
+        descriptions = Commando.config.descriptions
+        descriptions.sort_by { |cmd, _| cmd }.each do |command, description|
           output.puts "  * #{command} - #{description}"
         end
       end

data/lib/commando/config.rb

@@ -4,6 +4,7 @@ require_relative 'action/quit'
 
 module Commando
   ActionConfig = Struct.new(:action_class, :description)
+  private_constant :ActionConfig
 
   # Manage the configuration for the actions available to the CLI
   class Config
@@ -52,11 +53,10 @@ module Commando
       mapping[command]&.action_class
     end
 
-    # Iterate through each of the registered commands, yielding the command
-    # string and the description
-    def each_action(&block)
-      mapping.each do |command, action_config|
-        yield command, action_config.description
+    # @return [Hash<String, String>] a map of commands to their descriptions
+    def descriptions
+      mapping.map.with_object({}) do |(command, action_config), hash|
+        hash[command] = action_config.description
       end
     end
 

data/lib/commando/version.rb

@@ -1,3 +1,3 @@
 module Commando
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcollier-commando
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom Collier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler