tcollier-commando 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 616c0c39dc6ef5e239dd4b357b735cab2c1361a5
-  data.tar.gz: 38905d35b013e6c7905429d3d6cf999f8f2cfe82
+  metadata.gz: 2e2eaeec6ef8a2aa6c50de698bcf97980cecd945
+  data.tar.gz: dfcde5d0c18bbc6c350fcf1fab47a15afb057c84
 SHA512:
-  metadata.gz: 65e223e84795fa85613a8928ff1243a2f614d70a87b47f2b6062584b2c98eceb440938358c486843045a5127f7480897ab7ba990043e27b2997559c1d86835d0
-  data.tar.gz: b19ca353543f8e878320e963d75574735d0bf5723f7fa1bf5c759124a6ab0ddc6c7028a542518c1e5a8bb83710bea3ef5a03b07a048c700213f8af149ba42c75
+  metadata.gz: 912391da0d11a7d95b3331bfe9d3cdd8b1a0b728d770fb9946f5a7e3940b36e36a1f976a7e0f73d72645922852cf71374af9b4139b126f47af5b576649b71925
+  data.tar.gz: 730b35864936e0960ececea58c3dce1c2fd3f6239d9b95cd65942eed3d6fd295f72dc080451ea6a5b28c4d153b37005a0dc4f450557b2e37f417a19f6fab0f0f

data/README.md

@@ -12,6 +12,7 @@ _A command line interface builder with Readline support_
 * `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
+* `2.0.0` - Remove global config
 
 ## Installation
 
@@ -32,10 +33,11 @@ Or install it yourself as:
 ## Configuration
 
 You can configure the start up greeting, the command line prompt, and the set
-of available commands to use.
+of available commands to use. To do so, start Commando with the block syntax as
+follows
 
 ```ruby
-Commando.configure do |config|
+Commando.start do |config|
   # The greeting to print when the CLI is started
   config.greeting = 'Welcome to my CLI. Type "help" for a list of commands'
 
@@ -46,7 +48,8 @@ Commando.configure do |config|
   config.history_file = '/tmp/.commando_history'
 
   # Register multiple commands
-  config.register 'addfriend', MyApp::AddFriend, 'Adds a friend to your network'
+  config.register 'addfriend', MyApp::AddFriend.new, 'Adds a friend to your network'
+  config.register 'listfriends', MyApp::ListFriends.new, 'List all friends in your network'
 end
 ```
 
@@ -60,11 +63,10 @@ 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:)`, 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 an `ArgumentError` with a descriptive message.
@@ -73,14 +75,10 @@ then method should raise an `ArgumentError` with a descriptive message.
 
 A few default actions have been registered
 
-* help - Prints a help message, including a list of commands
-* history - Prints the history of commands entered so far
-* quit - Exits the program
+* `help` - Prints a help message, including a list of commands
+* `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
 

data/bin/commando

@@ -2,4 +2,6 @@
 
 require_relative '../lib/commando'
 
-Commando.start
+Commando.start do |config|
+  config.prompt = 'changed> '
+end

data/lib/commando.rb

@@ -1,8 +1,5 @@
 require_relative 'commando/config'
-require_relative 'commando/interpreter'
-require_relative 'commando/io_handler'
-require_relative 'commando/quit_exception'
-require_relative 'commando/version'
+require_relative 'commando/runner'
 
 # Entry point for the Command Line Interface (CLI).
 #
@@ -11,34 +8,10 @@ require_relative 'commando/version'
 # repeated indefinitely until the user give either the "quit" command, or
 # presses <CMD>+D.
 module Commando
-  # Initialize and configure the global config object
-  def self.configure(&block)
-    yield config
-  end
-
-  def self.config
-    @config ||= Config.new
-  end
-
   # Begin the prompt, get input, process loop.
-  def self.start(output: $stdout)
-    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.interpret(line)
-        end
-      rescue ArgumentError => error
-        output.puts "Error: #{error}"
-      rescue QuitException
-        break
-      end
-    end
+  def self.start(&block)
+    config = Config.new
+    yield config if block_given?
+    Runner.new(config: config).start
   end
 end

data/lib/commando/action/help.rb

@@ -3,14 +3,22 @@ require_relative '../../commando'
 module Commando
   module Action
     # Action that prints out all available commands
-    module Help
-      def self.perform(args:, output: $stdout)
-        output.puts "Valid commands are"
-        descriptions = Commando.config.descriptions
+    class Help
+      def initialize(config:)
+        @config = config
+      end
+
+      def perform(args:)
+        config.output.puts "Valid commands are"
+        descriptions = config.descriptions
         descriptions.sort_by { |cmd, _| cmd }.each do |command, description|
-          output.puts "  * #{command} - #{description}"
+          config.output.puts "  * #{command} - #{description}"
         end
       end
+
+      private
+
+      attr_reader :config
     end
   end
 end

data/lib/commando/action/history.rb

@@ -3,14 +3,22 @@ require 'readline'
 module Commando
   module Action
     # Action that prints out command history
-    module History
-      def self.perform(args:, output: $stdout)
+    class History
+      def initialize(config:)
+        @config = config
+      end
+
+      def perform(args:)
         max_digits = Math.log(Readline::HISTORY.size, 10).ceil
         Readline::HISTORY.each.with_index do |history, index|
           line_no = (index + 1).to_s.rjust(max_digits, ' ')
-          output.puts " #{line_no}\t#{history}"
+          config.output.puts " #{line_no}\t#{history}"
         end
       end
+
+      private
+
+      attr_reader :config
     end
   end
 end

data/lib/commando/action/quit.rb

@@ -3,8 +3,8 @@ require_relative '../quit_exception'
 module Commando
   module Action
     # Action to exit out of the CLI
-    module Quit
-      def self.perform(args:, output: $stdout)
+    class Quit
+      def perform(args:)
         raise QuitException
       end
     end

data/lib/commando/config.rb

@@ -13,16 +13,32 @@ module Commando
       'Welcome to the commando interface. Type "help" to list available commands'
 
     attr_accessor :history_file
-    
-    attr_writer :prompt, :greeting
+
+    attr_writer :prompt, :greeting, :output
 
     def initialize
       @mapping = {}
 
       # Register the default actions
-      register('help',    Commando::Action::Help,    'Print this message')
-      register('history', Commando::Action::History, 'Print the history of commands')
-      register('quit',    Commando::Action::Quit,    'Exit the program')
+      register(
+        'help',
+        Commando::Action::Help.new(config: self),
+        'Print this message'
+      )
+      register(
+        'history',
+        Commando::Action::History.new(config: self),
+        'Print the history of commands'
+      )
+      register(
+        'quit',
+        Commando::Action::Quit.new,
+        'Exit the program'
+      )
+    end
+
+    def output
+      @output || $stdout
     end
 
     def prompt

data/lib/commando/interpreter.rb

@@ -1,9 +1,9 @@
 module Commando
   # Interpret a single command from the user.
   class Interpreter
-    # @param output [IO] the stream any actions should write messages to.
-    def initialize(output: $stdout)
-      @output = output
+    # @param config [Config] the application configuration
+    def initialize(config:)
+      @config = config
     end
 
     # Performs the action (if valid) for the given input command line
@@ -12,18 +12,18 @@ module Commando
     def interpret(line)
       args = line.split(' ')
       command = args.shift
-      action = Commando.config.lookup(command)
+      action = config.lookup(command)
 
       if action.nil?
-        output.puts %Q(Unrecognized command: #{command}. Type "help" for a list of valid commands)
+        config.output.puts %Q(Unrecognized command: #{command}. Type "help" for a list of valid commands)
       else
-        action.perform(args: args, output: output)
+        action.perform(args: args)
       end
     end
 
     private
 
-    attr_reader :output
+    attr_reader :config
   end
 
   private_constant :Interpreter

data/lib/commando/io_handler.rb

@@ -5,19 +5,19 @@ require_relative 'quit_exception'
 module Commando
   # Handle the prompt/input for the command line interface
   class IOHandler
-    def initialize(output:)
-      @output = output
+    def initialize(config:)
+      @config = config
 
       configure_readline
       load_history
     end
 
     def readline
-      line = Readline.readline(Commando.config.prompt, true)
+      line = Readline.readline(config.prompt, true)
       if line.nil?
         # When the user presses <CMD>+D, this comes through as nil. In that
         # case we want to exit
-        output.puts
+        config.output.puts
         raise QuitException
       elsif line.strip == ''
         # If the user just hit enter without typing a command, remove that line
@@ -32,12 +32,12 @@ module Commando
 
     private
 
-    attr_reader :output
+    attr_reader :config
 
     def configure_readline
-      Readline.output = output
+      Readline.output = config.output
       Readline.completion_proc =
-        proc { |s| Commando.config.commands.grep(/^#{Regexp.escape(s)}/) }
+        proc { |s| config.commands.grep(/^#{Regexp.escape(s)}/) }
     end
 
     def load_history
@@ -53,7 +53,7 @@ module Commando
     end
 
     def history_file
-      Commando.config.history_file
+      config.history_file
     end
   end
 

data/lib/commando/runner.rb

@@ -0,0 +1,36 @@
+require_relative 'interpreter'
+require_relative 'io_handler'
+require_relative 'quit_exception'
+
+module Commando
+  class Runner
+    def initialize(config:)
+      @config = config
+    end
+
+    def start
+      config.output.puts config.greeting
+
+      io = IOHandler.new(config: config)
+      interpreter = Interpreter.new(config: config)
+
+      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.interpret(line)
+          end
+        rescue ArgumentError => error
+          config.output.puts "Error: #{error}"
+        rescue QuitException
+          break
+        end
+      end
+    end
+
+    private
+
+    attr_reader :config
+  end
+end

data/lib/commando/version.rb

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

metadata

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