shellissimo 0.0.1

data/.gitignore

@@ -0,0 +1,13 @@
+tmp/
+doc/
+.yardoc/
+.DS_Store
+.tags*
+.rvmrc
+.exrc
+nohup.out
+pkg/
+coverage/
+*.sublime-project
+*.sublime-workspace
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'simplecov', :require => false
+gem 'coveralls', :require => false
+gem "rake"
+
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vladimir Yarotsky
+
+MIT License
+
+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,29 @@
+# Shellissimo
+
+Minimalistic framework for constructing shell-like applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shellissimo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shellissimo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "yard"
+require "yard/rake/yardoc_task"
+require "rake/testtask"
+
+desc "generate YARD documentation"
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = FileList['lib/**/*.rb']
+end
+
+desc "run unit tests"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/lib/**/test*.rb']
+end
+
+task :default => :test

data/lib/shellissimo.rb

@@ -0,0 +1,6 @@
+require "shellissimo/version"
+require "shellissimo/dsl"
+require "shellissimo/shell"
+
+module Shellissimo
+end

data/lib/shellissimo/command.rb

@@ -0,0 +1,33 @@
+require 'shellissimo/command_name'
+
+module Shellissimo
+
+  class Command
+    attr_reader :name, :aliases, :description, :params, :block
+
+    def initialize(name, description = "", aliases = [],  params = [], &block)
+      @name, @description, @params = CommandName.new(name, aliases), String(description), params
+      self.block = block
+    end
+
+    def block=(b)
+      @block = b or raise ArgumentError, "command block is required"
+    end
+
+    def prepend_params(params)
+      old_block = block # let's fool ruby
+      dup.tap { |c| c.block = proc { instance_exec(params, &old_block) } }
+    end
+
+    def call(*args)
+      block.call(*args)
+    end
+    alias_method :[], :call
+
+    def to_proc
+      block
+    end
+  end
+
+end
+

data/lib/shellissimo/command_name.rb

@@ -0,0 +1,46 @@
+module Shellissimo
+
+  class CommandName
+    include Comparable
+
+    attr_reader :name, :aliases
+
+    def initialize(name, aliases = [])
+      @name, @aliases = String(name), Array(aliases).map(&:to_s)
+      raise ArgumentError, "command name can't be blank" if @name.empty?
+    end
+
+    def hash
+      @name.hash ^ @aliases.hash
+    end
+
+    def ==(other)
+      case other
+      when CommandName
+        return true if other.equal? self
+        return true if name == other.name && aliases == other.aliases
+      when String, Symbol
+        return true if other.to_s == @name
+        return true if @aliases.include?(other.to_s)
+      else
+        false
+      end
+    end
+
+    def <=>(other)
+      self == other or name <=> other.name
+    end
+
+    def to_s
+      result = "\e[1m#{name}\e[0m"
+      result += " (aliases: #{aliases.join(", ")})" unless aliases.empty?
+      result
+    end
+
+    def inspect
+      "<CommandName:#{self.object_id} name: #{@name.inspect}, aliases: #{@aliases.inspect}"
+    end
+  end
+
+end
+

data/lib/shellissimo/dsl.rb

@@ -0,0 +1,45 @@
+require 'shellissimo/dsl/command_builder'
+
+module Shellissimo
+  class CommandNotFoundError < StandardError; end
+
+  #
+  # Provides a DSL for defining shellissimo commands
+  #
+  module DSL
+    def self.included(base)
+      base.extend ClassMethods
+      base.extend Macros
+    end
+
+    module Macros
+      #
+      # @param name [String] Primary name for command
+      # @yieldparam [CommandBuilder] command_builder
+      #
+      def command(name)
+        builder = CommandBuilder.new(name)
+        yield builder
+        commands << builder.result
+      end
+
+    end
+
+    module ClassMethods
+      #
+      # @return [Array] a list of defined commands
+      #
+      def commands
+        @commands ||= begin
+          c = Array.new
+          def c.find_by_name_or_alias(name_or_alias)
+            detect { |c| c.name == name_or_alias } or
+              raise CommandNotFoundError, "Command #{command_name} not found"
+          end
+          c
+        end
+      end
+    end
+  end
+
+end

data/lib/shellissimo/dsl/command_builder.rb

@@ -0,0 +1,33 @@
+require 'shellissimo/command'
+
+module Shellissimo
+  module DSL
+
+    class CommandBuilder
+      def initialize(name)
+        @name = name
+      end
+
+      def description(desc)
+        @description = desc
+      end
+
+      def shortcut(*aliases)
+        @aliases = Array(aliases)
+      end
+      alias :shortcuts :shortcut
+
+      #
+      # A block to run upon command execution
+      #
+      def run(&block)
+        @block = block
+      end
+
+      def result
+        Command.new(String(@name), @description, @aliases, &@block)
+      end
+    end
+
+  end
+end

data/lib/shellissimo/error_handling.rb

@@ -0,0 +1,20 @@
+module Shellissimo
+
+  #
+  # Wraps code in catch-all block
+  #
+  def self.with_error_handling
+    begin
+      yield
+    rescue SystemExit
+      exit 0
+    rescue Exception => e
+      $stderr.puts "An error occured: #{e.message}"
+      if ENV['DEBUG']
+        $stderr.puts e.class.name
+        $stderr.puts e.backtrace
+      end
+    end
+  end
+
+end

data/lib/shellissimo/input_parser.rb

@@ -0,0 +1,44 @@
+require 'json'
+
+module Shellissimo
+
+  class InputParser
+    COMMAND_PATTERN = /(\w+)(?:\s*(.*))/
+
+    #
+    # @param commands [#find_by_name_or_alias] a list of commands
+    #
+    def initialize(commands)
+      @commands = commands
+    end
+
+    #
+    # @param line [String] a line of input from shell
+    # @return [Command] a command with pre-populated params
+    #
+    def parse_command(line)
+      command_name, command_params = line.match(COMMAND_PATTERN)[1..2]
+      command = @commands.find_by_name_or_alias(command_name)
+      command.prepend_params(parse_params(command_params))
+    end
+
+    private
+
+    def parse_params(params_string)
+      params_json = normalize_json(params_string)
+      symbolize_hash_keys(JSON.parse(params_json))
+    rescue JSON::ParserError => e
+      raise ArgumentError, "Can not parse command params: #{e.message}"
+    end
+
+    def normalize_json(json_string)
+      json_string.gsub(/\A(.*)\Z/, "{\\1}").gsub(/([{,]\s*)(\w+)(\s*:\s*["\d])/, '\1"\2"\3')
+    end
+
+    def symbolize_hash_keys(hash)
+      hash.inject({}) { |h, (k, v)| h[k.to_sym] = v; h }
+    end
+  end
+
+end
+

data/lib/shellissimo/shell.rb

@@ -0,0 +1,105 @@
+require 'readline'
+require 'shellissimo/error_handling'
+require 'shellissimo/dsl'
+require 'shellissimo/input_parser'
+
+module Shellissimo
+
+  #
+  # Base class for Shells
+  # Allows to define commands via DSL
+  # @see DSL
+  # Arovides 'help' and 'quit' commands out-of-box
+  #
+  # Supports REPL and one-shot mode
+  #
+  # Commands are instance-evaled against Shell instance,
+  # so all instance variables are available in command blocks.
+  #
+  # Example:
+  #
+  #   class MyShell < Shellissimo::Shell
+  #     command :hi do |c|
+  #       c.description "Says hello to the user"
+  #       c.run { |params| @greeter.say_hi(params[:user]) }
+  #     end
+  #
+  #     def initialize
+  #       @greeter = Greeter.new
+  #     end
+  #   end
+  #
+  # Usage:
+  #
+  #   -> hi user: "vlyrs"
+  #
+  class Shell
+    include DSL
+
+    command :help do |c|
+      c.shortcut :h
+      c.description "Show available commands"
+      c.run do |*|
+        result = "Available commands:\n\n"
+        print_command = proc { |cmd| result += "%-40s - %s\n" % [cmd.name, cmd.description] }
+        commands.partition { |c| !%w(help quit).include? c.name.name }.each do |some_commands|
+          some_commands.sort_by(&:name).each(&print_command)
+          result += "\n"
+        end
+        result.chomp
+      end
+    end
+
+    command :quit do |c|
+      c.description "Quit #$0"
+      c.run { |*| exit 0 }
+    end
+
+    def initialize(*)
+      @input_parser = InputParser.new(self.class.commands)
+    end
+
+    #
+    # Runs REPL
+    # @note swallows exceptions!
+    #
+    def run
+      while buf = Readline.readline(prompt, true) do
+        run_command(buf)
+      end
+    end
+
+    #
+    # Runs a single command
+    # @param str [String] command and parameters (like for REPL)
+    # @note swallows exceptions!
+    #
+    def run_command(str)
+      Shellissimo.with_error_handling do
+        command = @input_parser.parse_command(str)
+        puts format instance_eval(&command.block)
+      end
+    end
+
+    private
+
+    def prompt
+      '-> '
+    end
+
+    def format(obj)
+      case obj
+      when String
+        obj
+      when Hash
+        obj.map { |data| "%-20s: %s" % data }.join("\n")
+      when Array
+        obj.map(&method(:format)).join("\n")
+      else
+        obj.inspect
+      end
+    end
+  end
+
+end
+

data/lib/shellissimo/version.rb

@@ -0,0 +1,3 @@
+module Shellissimo
+  VERSION = "0.0.1"
+end

data/shellissimo.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shellissimo/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "shellissimo"
+  gem.version       = Shellissimo::VERSION
+  gem.authors       = ["Vladimir Yarotsky"]
+  gem.email         = ["vladimir.yarotsky@gmail.com"]
+  gem.summary       = %q{Minimalistic framework for constructing shell-like applications}
+  gem.homepage      = "https://github.com/v-yarotsky/shellissimo"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.has_rdoc = "yard"
+
+  gem.add_dependency("yard")
+  gem.add_dependency("redcarpet")
+  gem.add_development_dependency("minitest")
+end

data/test/lib/shellissimo/test_command.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+require 'shellissimo/command'
+
+include Shellissimo
+
+class TestCommand < ShellissimoTestCase
+  test "has name as an CommandName instance" do
+    assert_instance_of CommandName, command("hello") { |*| }.name
+  end
+
+  test "can't be created without proc" do
+    assert_raises ArgumentError, "command proc is required" do
+      command("foo")
+    end
+  end
+
+  test "is callable" do
+    called = false
+    c = command("foo") { |*| called = true }
+    c.call
+    assert called, "expected command block to be called"
+  end
+
+  private
+
+  def command(*args, &block)
+    Command.new(*args, &block)
+  end
+end
+

data/test/lib/shellissimo/test_command_name.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+require 'shellissimo/command_name'
+
+include Shellissimo
+
+class TestCommandName < ShellissimoTestCase
+  test "can not be created with blank name" do
+    assert_raises ArgumentError, "command name can't be blank" do
+      command_name(nil)
+    end
+  end
+
+  test "CommandName instance is equal to itself" do
+    n = command_name("foo")
+    assert_equal n, n
+  end
+
+  test "CommandName instances are equal if both name and aliases are equal" do
+    assert_equal command_name("foo"), command_name("foo")
+    assert_equal command_name("foo", ["baz"]), command_name("foo", ["baz"])
+  end
+
+  test "CommandName instances are not equal if names aren't equal" do
+    refute_equal command_name("foo"), command_name("bar")
+  end
+
+  test "CommandName instances are not equal if aliases aren't equal" do
+    refute_equal command_name("foo", ["baz"]), command_name("foo", ["qux"])
+  end
+
+  test "CommandName instance is equal to a string if the string is a command's name" do
+    assert_equal command_name("foo"), "foo"
+  end
+
+  test "CommandName instance is equal to a string if the string is one of command's aliases" do
+    assert_equal command_name("foo", ["bar", "baz"]), "bar"
+    assert_equal command_name("foo", ["bar", "baz"]), "baz"
+  end
+
+  test "CommandName instance is not equal to a string if the string is neither command's name nor one of command's aliases" do
+    refute_equal command_name("foo", ["bar", "baz"]), "qux"
+  end
+
+  test "is sorted by name" do
+    assert command_name("foo") > command_name("bar"), "expected 'foo' to be greater than 'bar'"
+    assert command_name("bar") < command_name("baz"), "expected 'bar' to be less than 'baz'"
+  end
+
+  test "#to_s returns name (bright)" do
+    assert_equal "\e[1mfoo\e[0m", command_name("foo").to_s
+  end
+
+  test "#to_s returns name (bright) and aliases if present" do
+    assert_equal "\e[1mfoo\e[0m (aliases: f, q)", command_name("foo", ["f", "q"]).to_s
+  end
+
+  private
+
+  def command_name(*args)
+    CommandName.new(*args)
+  end
+end
+

data/test/lib/shellissimo/test_dsl.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+require 'shellissimo/dsl'
+
+include Shellissimo
+
+class TestDsl < ShellissimoTestCase
+  test ".command creates a command" do
+    assert fake_with_command_foo.commands.find_by_name_or_alias("foo"), "expected command 'foo' to be defined"
+  end
+
+  test "#run inside .command sets command block" do
+    assert_equal :hello, fake_with_command_foo.commands.find_by_name_or_alias("foo").call
+  end
+
+  test "#shortcut inside .command sets command aliases" do
+    assert fake_with_command_foo.commands.find_by_name_or_alias("f"), "expected command 'foo' to be found by alias 'f'"
+  end
+
+  test "#description inside .command sets command description" do
+    assert_equal "foo description", fake_with_command_foo.commands.find_by_name_or_alias("foo").description
+  end
+
+  private
+
+  def fake_with_command_foo
+    fake do
+      command :foo do |c|
+        c.shortcut :f
+        c.description "foo description"
+        c.run { :hello }
+      end
+    end
+  end
+
+  def fake(*args, &block)
+    Class.new do
+      include DSL
+      instance_eval(&block)
+    end
+  end
+end
+

data/test/lib/shellissimo/test_input_parser.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+require 'shellissimo/input_parser'
+require 'shellissimo/command'
+
+include Shellissimo
+
+class TestInputParser < ShellissimoTestCase
+  test "returns command by name" do
+    assert_equal parser.parse_command("foo").name, "foo"
+  end
+
+  test "supports multiple params" do
+    assert_equal [{ :a => 1, :b => 2 }], parser.parse_command('foo "a": 1, "b": 2')[]
+  end
+
+  test "supports quoted params" do
+    assert_equal [{ :a => "hello, world" }], parser.parse_command('foo "a": "hello, world"')[]
+  end
+
+  test "supports unquoted keys" do
+    assert_equal [{ :a => "hello, world" }], parser.parse_command('foo a: "hello, world"')[]
+  end
+
+  private
+
+  def commands
+    cmds = [Command.new("foo") { |*args| args }]
+    def cmds.find_by_name_or_alias(name); first; end
+    cmds
+  end
+
+  def parser
+    InputParser.new(commands)
+  end
+end
+
+

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start
+elsif ENV["TRAVIS"]
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'minitest/unit'
+require 'minitest/pride'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+class ShellissimoTestCase < MiniTest::Unit::TestCase
+  def self.test(name, &block)
+    raise ArgumentError, "Example name can't be empty" if String(name).empty?
+    block ||= proc { skip "Not implemented yet" }
+    define_method "test #{name}", &block
+  end
+end
+
+require 'minitest/autorun'
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: shellissimo
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Vladimir Yarotsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+description: 
+email:
+- vladimir.yarotsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shellissimo.rb
+- lib/shellissimo/command.rb
+- lib/shellissimo/command_name.rb
+- lib/shellissimo/dsl.rb
+- lib/shellissimo/dsl/command_builder.rb
+- lib/shellissimo/error_handling.rb
+- lib/shellissimo/input_parser.rb
+- lib/shellissimo/shell.rb
+- lib/shellissimo/version.rb
+- shellissimo.gemspec
+- test/lib/shellissimo/test_command.rb
+- test/lib/shellissimo/test_command_name.rb
+- test/lib/shellissimo/test_dsl.rb
+- test/lib/shellissimo/test_input_parser.rb
+- test/test_helper.rb
+homepage: https://github.com/v-yarotsky/shellissimo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 1124256564094815538
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 1124256564094815538
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Minimalistic framework for constructing shell-like applications
+test_files:
+- test/lib/shellissimo/test_command.rb
+- test/lib/shellissimo/test_command_name.rb
+- test/lib/shellissimo/test_dsl.rb
+- test/lib/shellissimo/test_input_parser.rb
+- test/test_helper.rb
+has_rdoc: yard