mysh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be90389579f158cf24d6bc6865749b44cc9f21b8
+  data.tar.gz: dc61d9d021c118448d29cd22ddff718c69834965
+SHA512:
+  metadata.gz: 3e7196157f03f97324b95c3b1d4d1e46b619b085517403e918780e5a433332f8cae11ba9f39b5d8c0508cd875feae1451afc43412fbe0f97a3fe093460310c51
+  data.tar.gz: 9594ca2ee74430d85e7a068354b5062c3569adc4ca86a24225186ec66e0a35b0dcfb46cd8f070f8e4e122460f68bbab006679028b7f1267b9c87419bccdb5443

data/.gitignore

@@ -0,0 +1,17 @@
+*.bat
+*.zip
+*.tmp
+*.gem
+*.rbc
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+rdoc
+tmp
+temp.txt

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Camilleri
+
+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,56 @@
+# Mysh
+
+Inspired by the excellent article "Writing a Shell in 25 Lines of Ruby Code"
+found at (http://www.blackbytes.info/2016/07/writing-a-shell-in-ruby/) I
+thought it would be fun to experiment with that concept and see if it could
+be taken further.
+
+Many years ago, a popular shell program was modeled after
+the 'C' programming language. It went by the csh for C-shell (by the C shore :-)
+Instead of 'C', my shell would be based on Ruby (were you shocked?)!  The
+obvious name rsh for Ruby-shell was already in use by the Remote-shell. So,
+given the limited scope of this effort, and not wanting to do a lot of typing
+all the time, I chose the name mysh for My-shell.
+
+Since that name was available, it would seem that no one had yet written a
+shell program at this level of narcissism.
+
+The mysh is available as both a stand-alone CLI program and for use as a
+command shell within Ruby applications and Rails web sites.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysh'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysh
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/mysh/fork )
+2. Switch to the development branch ('git branch development')
+3. Create your feature branch ('git checkout -b my-new-feature')
+4. Commit your changes ('git commit -am "Add some feature"')
+5. Push to the branch ('git push origin my-new-feature')
+6. Create new Pull Request
+
+#### Plan B
+
+Go to the GitHub repository at (https://github.com/PeterCamilleri/mysh) and
+raise an issue calling attention to some aspect that could use some TLC or a
+suggestion or an idea.

data/lib/mysh/commands/exit.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+
+#* commands/exit.rb -- The mysh internal exit command.
+module Mysh
+
+  #* exit.rb -- The mysh internal exit command.
+  class InternalCommand
+    #Add the exit command to the library.
+    add(self.new('exit', 'exit mysh.') do |args|
+      raise MiniReadlineEOI
+    end)
+
+    add_alias('quit', 'exit')
+  end
+end
+

data/lib/mysh/internal/instance.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+#* internal.rb -- mysh internal command instance data and methods.
+module Mysh
+
+  #The mysh internal command instance data and methods.
+  class InternalCommand
+    #The name of the command.
+    attr_reader :name
+
+    #The description of the command.
+    attr_reader :description
+
+    #The action of the command.
+    attr_reader :action
+
+    #Setup an internal command
+    def initialize(name, description, &action)
+      @name        = name
+      @description = description
+      @action      = action
+    end
+
+    #Execute the command.
+    def execute(args)
+      @action.call(args)
+    end
+
+    #Get information about the command.
+    def info
+      [@name, @description]
+    end
+
+  end
+
+end

data/lib/mysh/internal/klass.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+#* internal/klass.rb -- mysh internal command class level data and methods.
+module Mysh
+
+  #The mysh internal command class level data and methods.
+  class InternalCommand
+
+    #Set up the command library hash.
+    @commands = {}
+
+    class << self
+      #The command library, a hash.
+      attr_reader :commands
+    end
+
+    #Add a command to the command library.
+    def self.add(command)
+      @commands[command.name] = command
+    end
+
+    #Add an alias for an existing command.
+    def self.add_alias(new_name, old_name)
+      unless (command = @commands[old_name])
+        fail "Error adding alias #{new_name} for #{old_name}"
+      end
+
+      @commands[new_name] = new(new_name,
+                                command.description,
+                                &command.action)
+    end
+
+    #Execute an internal command
+    def self.execute(str)
+      args = str.split
+
+      if (command = @commands[args[0]])
+        command.execute(args[1..-1])
+        true
+      else
+        false
+      end
+    end
+
+  end
+end
+

data/lib/mysh/internal.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+require_relative 'internal/klass.rb'
+require_relative 'internal/instance.rb'
+
+#Load up the commands!
+Dir[File.dirname(__FILE__) + '/commands/*.rb'].each {|file| require file }

data/lib/mysh/version.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+module Mysh
+  #The version string of MY SHell.
+  VERSION = "0.0.1"
+
+  #A brief summary of this gem.
+  SUMMARY = "mysh -- a Ruby inspired command shell"
+end

data/lib/mysh.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+# mysh -- MY SHell -- a Ruby/Rails inspired command shell.
+
+#Use the mini_readline gem but make sure that it does
+#not interfere with the standard readline library.
+$no_alias_read_line_module = true
+require "mini_readline"
+
+require_relative "mysh/internal"
+require_relative "mysh/version"
+
+#The MY SHell module. A container for its functionality.
+module Mysh
+
+  class << self
+    #The input text source.
+    attr_reader :input
+  end
+
+  #The actual shell method.
+  def self.do_mysh
+    @input = MiniReadline::Readline.new(history: true, eoi_detect: true)
+
+    loop do
+      input = @input.readline
+      InternalCommand.execute(input) || system(input)
+    end
+
+    rescue MiniReadlineEOI
+  end
+
+end
+
+#Some test code to run a shell if this file is run directly.
+if __FILE__ == $0
+  Mysh.do_mysh
+end

data/mysh.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mysh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysh"
+  spec.version       = Mysh::VERSION
+  spec.authors       = ["Peter Camilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = Mysh::SUMMARY
+  spec.description   = "mysh -- a Ruby inspired command shell " +
+                       "for CLI and application use.[WIP]"
+  spec.homepage      = "http://teuthida-technologies.com/"
+
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>=1.9.3'
+
+  spec.add_development_dependency "bundler",          "~> 1.3"
+  spec.add_development_dependency "rake",             "~> 10.0"
+  spec.add_development_dependency 'reek',             "~> 3.0"
+  spec.add_development_dependency 'minitest',         "~> 5.7"
+  spec.add_development_dependency 'minitest_visible', ">= 0.1.1"
+  spec.add_development_dependency 'rdoc',             "~> 4.0.1"
+
+  spec.add_runtime_dependency     'mini_readline',    ">= 0.5.2"
+end

data/rakefile.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+# coding: utf-8
+
+require 'rake/testtask'
+require 'rdoc/task'
+require "bundler/gem_tasks"
+
+#Generate internal documentation with rdoc.
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+
+  #List out all the files to be documented.
+  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt", "README.md")
+
+  #Set a title.
+  rdoc.options << '--title' << 'My Shell Gem Internals'
+end
+
+#Run the mini_readline unit test suite.
+Rake::TestTask.new do |t|
+  #List out all the test files.
+  t.test_files = FileList['tests/**/*.rb']
+  t.verbose = false
+end
+
+desc "Run a scan for smelly code!"
+task :reek do |t|
+  `reek --no-color lib > reek.txt`
+end
+
+desc "What version of mine_readline is this?"
+task :vers do |t|
+  puts
+  puts "mysh (My Shell) version = #{Mysh::VERSION}"
+end

data/reek.txt

@@ -0,0 +1 @@
+0 total warnings

data/tests/my_shell_tests.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+require_relative '../lib/mysh'
+gem              'minitest'
+require          'minitest/autorun'
+require          'minitest_visible'
+
+#Test the monkey patches applied to the Object class.
+class MyShellTester < Minitest::Test
+
+  #Track mini-test progress.
+  include MinitestVisible
+
+  def test_that_module_entities_exists
+    assert_equal(Module, Mysh.class)
+    assert_equal(Class,  Mysh::InternalCommand.class)
+  end
+
+  def test_for_internal_commands
+    assert(Mysh::InternalCommand.commands['exit'], "The exit command is missing.")
+    assert(Mysh::InternalCommand.commands['quit'], "The quit command is missing.")
+
+    assert_raises { Mysh::InternalCommand.add_alias('blam', 'shazzam') }
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: mysh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Camilleri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: reek
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: mini_readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+description: mysh -- a Ruby inspired command shell for CLI and application use.[WIP]
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/mysh.rb
+- lib/mysh/commands/exit.rb
+- lib/mysh/internal.rb
+- lib/mysh/internal/instance.rb
+- lib/mysh/internal/klass.rb
+- lib/mysh/version.rb
+- mysh.gemspec
+- rakefile.rb
+- reek.txt
+- tests/my_shell_tests.rb
+homepage: http://teuthida-technologies.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: mysh -- a Ruby inspired command shell
+test_files: []
+has_rdoc: