shelley 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca77da0be4417eacb0a9fb6372f53a20b37b5e954184ee39203edb99eac6b500
+  data.tar.gz: b393d7034752f6f78c7b7f83b77572b1aa8fedd49d958a9068f52a22bc333178
+SHA512:
+  metadata.gz: 5c1dc1c8e19862b99dd32f8291e618e9697f9d007bc0cbcb595c7a02cf429abb76d26a0e647421b99aabd58ea1dece3d6d27c97fd8e8e7c84f363c62e3f3db78
+  data.tar.gz: 19b81645ce0ae60236c9e0117b8b6397a639569256fb313b585b464598c5195f724cc33d57b47363aa537db2610df670fa28e21bf769c5fefe94ae4870a0f7fa

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in shelley.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    shelley (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  shelley!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,138 @@
+# Shelley
+
+A gem for converting your classes and method into a shell supporting nested commands, autocomplete and history.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shelley'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shelley
+
+## Usage
+
+### A simple shell
+
+```ruby
+class Calculator
+  def initialize
+    @value = 0
+  end
+
+  def add(n)
+    @value += n.to_i
+  end
+
+  def subtract(n)
+    @value -= n.to_i
+  end
+
+  def multiply_by(n)
+    @value *= n.to_i
+  end
+
+  def divide_by(n)
+    @value /= n.to_i
+  end
+
+  def result
+    puts @value
+  end
+end
+
+command_registry = Shelley::CommandRegistry.new
+command_registry.add_command(Calculator.new)
+shell = Shelley::InteractiveShell.new(command_registry)
+shell.start
+```
+
+Sample output
+
+```
+> add 3
+> result
+3
+> add 5
+> subtract 2
+> result
+6
+> divide_by 3
+> result
+2
+> multiply_by 10
+> result
+20
+> divide_by 0
+divided by 0
+>
+```
+
+### A shell with subcommands
+
+```ruby
+class Timer
+  def initialize
+    @started_at = nil
+    @elapsed = 0
+  end
+
+  def start
+    return unless @started_at.nil?
+    @started_at = Time.now
+  end
+
+  def stop
+    return if @started_at.nil?
+    @elapsed += Time.now - @started_at
+    @started_at = nil
+  end
+
+  def elapsed
+    elapsed = @elapsed
+    elapsed += (Time.now - @started_at) unless @started_at.nil?
+    puts elapsed
+  end
+end
+
+command_registry = Shelley::CommandRegistry.new
+command_registry.add_command(Calculator.new, 'calc')
+command_registry.add_command(Timer.new, 'timer')
+shell = Shelley::InteractiveShell.new(command_registry)
+shell.start
+```
+
+Sample output
+
+```
+> calc add 1
+> calc add 3
+> timer start
+> calc subtract 2
+> calc result
+2
+> timer elapsed
+10.156443773
+> timer stop
+> timer elapsed
+12.239438967
+> timer elapsed
+12.239438967
+> calc result
+2
+```
+
+## TODO
+
+* Support for adding single methods
+* Automatic argument convertion
+* Argument autocomplete
+* Refactor `InteractiveShell` and `CommandRegistry` in order to not expose the internal state of `CommandRegistry`

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shelley'
+
+# 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/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shelley.rb

@@ -0,0 +1,7 @@
+require 'readline'
+
+module Shelley
+  require 'shelley/version'
+  require 'shelley/registry'
+  require 'shelley/shells'
+end

data/lib/shelley/registry.rb

@@ -0,0 +1,116 @@
+module Shelley
+  # A node of the command tree
+  class CommandNode
+    attr_reader :children, :parent
+    attr_accessor :name
+    attr_accessor :command
+
+    def initialize(parent = nil)
+      @children = []
+      @parent = parent
+    end
+
+    def ensure_exists(*path)
+      return self if path.count.zero?
+      curr_name = path.shift
+      node = @children.find { |n| n.name == curr_name }
+      if node.nil?
+        node = CommandNode.new(self)
+        node.name = curr_name
+        @children << node
+      end
+      return node if path.count.zero?
+      node.ensure_exists(*path)
+    end
+
+    def node_by_path(*path)
+      return self if path.count.zero?
+      curr_name = path.shift
+      node = @children.find { |n| n.name == curr_name }
+      return nil if node.nil?
+      return node if path.count.zero?
+      node.node_by_path(*path)
+    end
+
+    def full_path
+      curr_node = self
+      path = []
+      until curr_node.parent.nil?
+        path << curr_node.name
+        curr_node = curr_node.parent
+      end
+      path.reverse
+    end
+
+    def to_s
+      "CommandNode(name=#{name}, command=#{command}, children={#{children.map(&:to_s)}})"
+    end
+  end
+
+  # A command
+  class Command
+    def initialize(method)
+      @method = method
+    end
+
+    def execute(*args)
+      @method.call(*args)
+    rescue StandardError => msg
+      raise CommandError, msg
+    end
+  end
+
+  # An error raised by the CommandRegistry if a command fails
+  class CommandError < StandardError
+  end
+
+  # A shell
+  class CommandRegistry
+    def initialize
+      @tree = CommandNode.new
+    end
+
+    # Returns the command tree
+    def commands_tree
+      @tree
+    end
+
+    def command?(*path)
+      !@tree.node_by_path(*path).nil?
+    end
+
+    # Adds a command to the shell
+    def add_command(instance, *path)
+      node = @tree.ensure_exists(*path)
+      instance.class.public_instance_methods(false).each do |method_name|
+        child = node.ensure_exists(method_name.to_s)
+        child.command = Command.new(instance.method(method_name))
+      end
+    end
+
+    def raise_error(command)
+      raise CommandError, "Cannot find command \"#{command}\""
+    end
+
+    # Executes a command
+    def execute_command(command)
+      tokens = command.split
+      node = @tree
+      until tokens.count.zero?
+        prev_node = node
+        curr_name = tokens.shift
+        node = node.node_by_path(curr_name)
+        if node.nil?
+          raise_error(command) if prev_node.command.nil?
+          tokens.insert(0, curr_name)
+          prev_node.command.execute(*tokens)
+          return
+        elsif tokens.count.zero?
+          node.command.execute
+          return
+        end
+      end
+      raise_error(command)
+    end
+  end
+end

data/lib/shelley/shells.rb

@@ -0,0 +1,62 @@
+module Shelley
+  # An interactive shell, supporting history and autocompletion
+  class InteractiveShell
+    attr_accessor :prompt
+
+    def initialize(command_registry)
+      @command_registry = command_registry
+      @prompt = '> '
+    end
+
+    # Retrieves candidate nodes for a given path
+    def candidate_nodes(*path)
+      return @command_registry.commands_tree.children if path.count.zero?
+      last_name = path.pop
+      node = @command_registry.commands_tree.node_by_path(*path)
+      return [] if node.nil?
+      last_node = node.node_by_path(last_name)
+      return last_node.children unless last_node.nil?
+      node.children.select { |n| n.name =~ /^#{Regexp.escape(last_name)}/ }
+    end
+
+    # Tries to autocomplete a lines
+    def autocomplete(line)
+      candidate_nodes(*line.split).map(&:name).sort
+    end
+
+    # Starts the shell
+    def start
+      Readline.completion_append_character = ' '
+      Readline.completion_proc = lambda do |_line|
+        autocomplete(Readline.line_buffer)
+      end
+      while (line = Readline.readline(@prompt, true))
+        begin
+          @command_registry.execute_command(line)
+        rescue StandardError => msg
+          puts msg
+        end
+      end
+    end
+  end
+
+  # A non-interactive shell. Executes given commands sequentially
+  class NonInteractiveShell
+    def initialize(command_registry, commands)
+      @command_registry = command_registry
+      @commands = commands
+    end
+
+    # Starts the shell
+    def start
+      @commands.each do |command|
+        begin
+          puts "> #{command}"
+          @command_registry.execute_command(command)
+        rescue StandardError => msg
+          puts msg
+        end
+      end
+    end
+  end
+end

data/lib/shelley/version.rb

@@ -0,0 +1,3 @@
+module Shelley
+  VERSION = '0.1.0'.freeze
+end

data/shelley.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shelley/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shelley'
+  spec.version       = Shelley::VERSION
+  spec.authors       = ['Lorenzo Benvenuti']
+  spec.email         = ['lorenzo.benvenuti@gmail.com']
+
+  spec.summary       = 'Convert your ruby code into a shell'
+  spec.description   = 'Shelley allows to convert your classes and method into a shell supporting nested commands, autocomplete and history.'
+  spec.homepage      = 'https://github.com/lorenzobenvenuti/shelley'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/test.rb

@@ -0,0 +1,57 @@
+require_relative 'lib/shelley'
+
+class Calculator
+  def initialize
+    @value = 0
+  end
+
+  def add(n)
+    @value += n.to_i
+  end
+
+  def subtract(n)
+    @value -= n.to_i
+  end
+
+  def multiply_by(n)
+    @value *= n.to_i
+  end
+
+  def divide_by(n)
+    @value /= n.to_i
+  end
+
+  def result
+    puts @value
+  end
+end
+
+class Timer
+  def initialize
+    @started_at = nil
+    @elapsed = 0
+  end
+
+  def start
+    return unless @started_at.nil?
+    @started_at = Time.now
+  end
+
+  def stop
+    return if @started_at.nil?
+    @elapsed += Time.now - @started_at
+    @started_at = nil
+  end
+
+  def elapsed
+    elapsed = @elapsed
+    elapsed += (Time.now - @started_at) unless @started_at.nil?
+    puts elapsed
+  end
+end
+
+command_registry = Shelley::CommandRegistry.new
+command_registry.add_command(Calculator.new, 'calc')
+command_registry.add_command(Timer.new, 'timer')
+shell = Shelley::InteractiveShell.new(command_registry)
+shell.start

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: shelley
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lorenzo Benvenuti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Shelley allows to convert your classes and method into a shell supporting
+  nested commands, autocomplete and history.
+email:
+- lorenzo.benvenuti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shelley.rb
+- lib/shelley/registry.rb
+- lib/shelley/shells.rb
+- lib/shelley/version.rb
+- shelley.gemspec
+- test.rb
+homepage: https://github.com/lorenzobenvenuti/shelley
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Convert your ruby code into a shell
+test_files: []