tcollier-commando 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fb82072f6cdcc9e0520a32ade43924acd20dfff
+  data.tar.gz: d856cb9045676d0954ea1688f229dcbbb3c2772e
+SHA512:
+  metadata.gz: 3f9309d4f4f84b37fd4036c64fc0463a35650bc79cdf104298018c982c8dfd5fb2439b86b20a005c2d96add8e852f0f7263f7f6bda5daf0474a158c6ed3a4005
+  data.tar.gz: 002b84ff2a1f5b49e51a4bc4992e1f36a20675d78f46ed51feab96472fdd7e1420fd1bb351dda594787e146b969f6d2d390e29c8bd3210e53e3d9991a9411fc8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--require 'spec_helper'
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at collier@apartmentlist.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in commando.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tom Collier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Commando
+
+A command line interface builder with Readline support
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'commando'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install commando
+
+## Configuration
+
+You can configure the start up greeting, the command line prompt, and the set
+of available commands to use.
+
+```ruby
+Commando.configure do |config|
+  config.greeting = 'Welcome to my CLI. Type "help" for a list of commands'
+  config.prompt = 'my-app> '
+
+  config.register 'addfriend', MyApp::AddFriend, 'Adds a friend to your network'
+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`
+
+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
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/commando

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/commando'
+
+Commando.start

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "commando"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/commando.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commando/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tcollier-commando'
+  spec.version       = Commando::VERSION
+  spec.authors       = ['Tom Collier']
+  spec.email         = ['collier@apartmentlist.com']
+
+  spec.summary       = 'A simple command line interface builder.'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/commando/action/help.rb

@@ -0,0 +1,15 @@
+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"
+        Commando.config.each_action do |command, description|
+          output.puts "  * #{command} - #{description}"
+        end
+      end
+    end
+  end
+end

data/lib/commando/action/history.rb

@@ -0,0 +1,16 @@
+require 'readline'
+
+module Commando
+  module Action
+    # Action that prints out command history
+    module History
+      def self.perform(args:, output: $stdout)
+        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}"
+        end
+      end
+    end
+  end
+end

data/lib/commando/action/quit.rb

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

data/lib/commando/config.rb

@@ -0,0 +1,69 @@
+require_relative 'action/help'
+require_relative 'action/history'
+require_relative 'action/quit'
+
+module Commando
+  ActionConfig = Struct.new(:action_class, :description)
+
+  # Manage the configuration for the actions available to the CLI
+  class Config
+    DEFAULT_PROMPT = 'commando> '
+    DEFAULT_GREETING =
+      'Welcome to the commando interface. Type "help" to list available commands'
+
+    attr_writer :prompt, :greeting
+
+    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')
+    end
+
+    def prompt
+      @prompt || DEFAULT_PROMPT
+    end
+
+    def greeting
+      @greeting || DEFAULT_GREETING
+    end
+
+    # Register a new command/action to be available to the CLI
+    #
+    # @param command [String] the string that a user will type to execute the
+    #   action, e.g. "help" for the command the will print out help info.
+    # @param action_class [Class] the class that will execute the logic for
+    #   the given command.
+    def register(command, action_class, description)
+      mapping[command] = ActionConfig.new(action_class, description)
+    end
+
+    # @return [Array<String>] the list of all configured actions.
+    def commands
+      @mapping.keys
+    end
+
+    # @param command [String] the command to find an action class for.
+    # @return [Class] the action class that is registered for the command,
+    #   nil if none is registered.
+    def lookup(command)
+      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
+      end
+    end
+
+    private
+
+    attr_reader :mapping
+  end
+
+  private_constant :Config
+end

data/lib/commando/interpreter.rb

@@ -0,0 +1,29 @@
+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
+      @output = output
+    end
+
+    # Performs the action (if valid) for the given input command line
+    def interpret
+      action = Commando.config.lookup(command)
+
+      if action.nil?
+        output.puts %Q(Unrecognized command: #{command}. Type "help" for a list of valid commands)
+      else
+        action.perform(args: args, output: output)
+      end
+    end
+
+    private
+
+    attr_reader :command, :args, :output
+  end
+
+  private_constant :Interpreter
+end

data/lib/commando/quit_exception.rb

@@ -0,0 +1,6 @@
+module Commando
+  class QuitException < StandardError
+  end
+
+  private_constant :QuitException
+end

data/lib/commando/validation_error.rb

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

data/lib/commando/version.rb

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

data/lib/commando.rb

@@ -0,0 +1,63 @@
+require_relative 'commando/config'
+require_relative 'commando/interpreter'
+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,
+# then commands are read from stardard in, then executed. This process is
+# 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)
+    Readline.output = output
+    output.puts config.greeting
+    quit = false
+
+    loop do
+      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
+        break
+      elsif line.strip != ''
+        # 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
+          interpreter.interpret
+        rescue ValidationError => error
+          output.puts "Error: #{error}"
+        rescue QuitException
+          break
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: tcollier-commando
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Collier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- collier@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/commando
+- bin/console
+- commando.gemspec
+- lib/commando.rb
+- lib/commando/action/help.rb
+- lib/commando/action/history.rb
+- lib/commando/action/quit.rb
+- lib/commando/config.rb
+- lib/commando/interpreter.rb
+- lib/commando/quit_exception.rb
+- lib/commando/validation_error.rb
+- lib/commando/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A simple command line interface builder.
+test_files: []