tcollier-commando 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5068609960424981817aae65f87d2bb72aff7e6c
-  data.tar.gz: c29d26dfa5bbc1cb4d8520282978afa12ded2c6b
+  metadata.gz: 9bab78dc964fa7ce13e372cfed2902f152c3a0a2
+  data.tar.gz: c34eddbfb57a271a68c635d79d278c76053cb38b
 SHA512:
-  metadata.gz: bc279c68c0428d8189770de8ecaf093dc5426cd14f23aca2fa8832906c2a13c68ec7828c608945130bc403e4a5c06c0d9c07ee9976a26e72af33a4d4a7e5c8fa
-  data.tar.gz: a2a589ed3016084bf27f3eb3ece1613fea5dbd2dcaa92c6010b580dbf90cf08df96ac49c8ddad4e948eb8db0db84139f0d6d3e7b85efdde487d878011b7d4b01
+  metadata.gz: 57425515b9b2cd72748222130d6ea4ea39b65834c4315b3921c7e933505b70b4af0112ebb81f68c03155139437fd1af496f6dc842abe27b18d7df0fc5ee6df91
+  data.tar.gz: 8a7870cfe6aed8d9bab534d3161fbfacd448e7a0a1639b8682cc496db9b892197f20fd1ff78a454c4e113fbf3845cea2bbf79aa221f6ad47d71465cf5939bf19

data/README.md

@@ -7,6 +7,7 @@ A command line interface builder with Readline support
 * `0.1.0` - Initial release
 * `0.1.1` - Alphabetize commands printed via `help`
 * `0.1.2` - Remove empty lines from history
+* `0.2.0` - Persist history across CLI sessions
 
 ## Installation
 
@@ -31,9 +32,16 @@ of available commands to use.
 
 ```ruby
 Commando.configure do |config|
+  # The greeting to print when the CLI is started
   config.greeting = 'Welcome to my CLI. Type "help" for a list of commands'
+
+  # The prompt to print every time a new command is desired
   config.prompt = 'my-app> '
 
+  # An optional file where command line history is stored across sessions
+  config.history_file = '/tmp/.commando_history'
+
+  # Register multiple commands
   config.register 'addfriend', MyApp::AddFriend, 'Adds a friend to your network'
 end
 ```

data/lib/commando.rb

@@ -1,16 +1,10 @@
 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'
 
-require 'readline'
-# Configure readline
-comp = proc { |s| Commando.config.commands.grep(/^#{Regexp.escape(s)}/) }
-
-Readline.completion_append_character = " "
-Readline.completion_proc = comp
-
 # Entry point for the Command Line Interface (CLI).
 #
 # Present the user with a text-based interface, where a prompt is printed,
@@ -29,38 +23,22 @@ module Commando
 
   # Begin the prompt, get input, process loop.
   def self.start(output: $stdout)
-    Readline.output = output
     output.puts config.greeting
-    quit = false
 
-    loop do
-      line = Readline.readline(config.prompt, true)
+    io = IOHandler.new(output: output)
 
-      if line.nil?
-        # When the user presses <CMD>+D, this comes through as nil. In that
-        # case we want to exit
-        output.puts
-        break
-      elsif line.strip == ''
-        # If the user just hit enter without typing a command, remove that line
-        # from history.
-        Readline::HISTORY.pop
-      else
-        # When the user enters a non-empty string, pass the line to the
-        # interpreter and handle the command.
-        #
-        # If the user enters an empty string (e.g. "" or "   "), we simply
-        # go back to the top of the loop to print out the prompt and wait
-        # for the next command.
-        interpreter = Interpreter.new(input: line, output: output)
-
-        begin
+    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
-        rescue ValidationError => error
-          output.puts "Error: #{error}"
-        rescue QuitException
-          break
         end
+      rescue ValidationError => error
+        output.puts "Error: #{error}"
+      rescue QuitException
+        break
       end
     end
   end

data/lib/commando/config.rb

@@ -12,6 +12,8 @@ module Commando
     DEFAULT_GREETING =
       'Welcome to the commando interface. Type "help" to list available commands'
 
+    attr_accessor :history_file
+    
     attr_writer :prompt, :greeting
 
     def initialize

data/lib/commando/io_handler.rb

@@ -0,0 +1,61 @@
+require 'readline'
+
+require_relative 'quit_exception'
+
+module Commando
+  # Handle the prompt/input for the command line interface
+  class IOHandler
+    def initialize(output:)
+      @output = output
+
+      configure_readline
+      load_history
+    end
+
+    def readline
+      line = Readline.readline(Commando.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
+        raise QuitException
+      elsif line.strip == ''
+        # If the user just hit enter without typing a command, remove that line
+        # from history.
+        Readline::HISTORY.pop
+        nil
+      else
+        save_history(line)
+        line
+      end
+    end
+
+    private
+
+    attr_reader :output
+
+    def configure_readline
+      Readline.output = output
+      Readline.completion_proc =
+        proc { |s| Commando.config.commands.grep(/^#{Regexp.escape(s)}/) }
+    end
+
+    def load_history
+      if Commando.config.history_file
+        File.readlines(Commando.config.history_file).each do |line|
+          Readline::HISTORY.push(line.chomp)
+        end
+      end
+    end
+
+    def save_history(line)
+      if Commando.config.history_file
+        File.open(Commando.config.history_file, 'a') do |f|
+          f.puts line
+        end
+      end
+    end
+  end
+
+  private_constant :IOHandler
+end

data/lib/commando/version.rb

@@ -1,3 +1,3 @@
 module Commando
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tcollier-commando
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Collier
@@ -76,6 +76,7 @@ files:
 - lib/commando/action/quit.rb
 - lib/commando/config.rb
 - lib/commando/interpreter.rb
+- lib/commando/io_handler.rb
 - lib/commando/quit_exception.rb
 - lib/commando/validation_error.rb
 - lib/commando/version.rb