easy_repl 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 154ddd2d3a29b8ecc78ee38f814c6bbe729a5a6b
+  data.tar.gz: 4b8aef184bd7704e2919a3d386d21e1cd588e4df
+SHA512:
+  metadata.gz: 2402148318a7fbb6ffb553e816574043980f0bb8b0113cbb71260f678c371febf46cbe2635ac88fdccbbb9b717f73c8a3774609f66523aa07d37268a83eb2997
+  data.tar.gz: 222955fe253831f03f4aeb6ed71062faa9a90facfd6e3ce06d15d94aa71239b952cb02dfe187a60de8b1899a769f39f88fc151948b769ff10159367c7cc5eac9

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.easyrepl_history

data/.ruby-gemset

@@ -0,0 +1 @@
+easy_repl

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christopher Erin
+
+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,109 @@
+# EasyRepl
+
+A Repl (Read Eval Print Loop) library.
+
+## Features
+
+  * Ease of use.  Just pass a block to the start method to process the user's input.
+  * Command History
+  * Exit Command
+  * Reload Command
+  * Setup and Teardown lifecycle methods
+  * After Input and Before Input lifecylce methods
+
+## Usage
+
+```ruby
+  require 'easy_repl'
+
+  #start an echoing repl
+  EasyRepl.start
+
+  # > a
+  # a
+  # > b
+  # b
+  # > exit
+
+  #start a repl that reverses input
+  EasyRepl.start do |input|
+    puts input.reverse
+  end
+
+  # > abc
+  # cba
+  # > def
+  # fed
+  # > exit
+
+  #create a repl class with a life cycle
+  class MyRepl
+    include EasyRepl::Repl
+
+    def setup
+      puts "LOADING RESOURCES"
+    end
+
+    def before_input
+      puts "before_input"
+    end
+
+    def process_input(input)
+      puts input.reverse
+    end
+
+    def after_input
+      puts "after_input"
+    end
+
+    def teardown
+      puts "CLOSING RESOURCES"
+    end
+
+  end
+
+  MyRepl.new.start
+
+  # LOADING RESOURCES
+  # before_input
+  # > abc
+  # after_input
+  # cba
+  # before_input
+  # > reload
+  # after_input
+  # CLOSING RESOURCES
+  # LOADING RESOURCES
+  # before_input
+  # > exit
+  # after_input
+  # CLOSING RESOURCES
+
+
+  # rename the history file before starting the repl
+  EasyRepl.history_file = ".myrepl_history"
+  EasyRepl.start
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_repl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_repl
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/easy_repl.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_repl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_repl"
+  spec.version       = EasyRepl::VERSION
+  spec.authors       = ["Christopher Erin"]
+  spec.email         = ["chris.erin@gmail.com"]
+  spec.description   = %q{easy repl}
+  spec.summary       = %q{easy repl}
+  spec.homepage      = "https://github.com/chriserin/easy_repl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/easy_repl/commands/exit.rb

@@ -0,0 +1,15 @@
+module EasyRepl
+  module Commands
+    class Exit
+      extend Matchable
+
+      def self.cmd_txt
+        "exit"
+      end
+
+      def self.run
+        throw :exit_repl, :exit
+      end
+    end
+  end
+end

data/lib/easy_repl/commands/matchable.rb

@@ -0,0 +1,9 @@
+module EasyRepl
+  module Commands
+    module Matchable
+      def matches(input)
+        input =~ /^#{cmd_txt}/
+      end
+    end
+  end
+end

data/lib/easy_repl/commands/reload.rb

@@ -0,0 +1,15 @@
+module EasyRepl
+  module Commands
+    class Reload
+      extend Matchable
+
+      def self.cmd_txt
+        "reload"
+      end
+
+      def self.run
+        throw :exit_repl, :reload
+      end
+    end
+  end
+end

data/lib/easy_repl/repl.rb

@@ -0,0 +1,70 @@
+require 'irb/locale'
+require 'irb/input-method'
+require 'irb/ext/save-history'
+
+module IRB
+  def self.conf
+    {
+      LC_MESSAGES: Locale.new,
+      SAVE_HISTORY: 100,
+      HISTORY_FILE: EasyRepl.history_file || '.easyrepl_history',
+      AT_EXIT: []
+    }
+  end
+end
+
+module EasyRepl
+  module Repl
+    def start
+      IRB::HistorySavingAbility.extend(IRB::HistorySavingAbility) unless IRB::HistorySavingAbility === IRB::HistorySavingAbility
+      loop do
+        setup if respond_to? :setup
+        begin
+          exit_value = catch(:exit_repl) do
+            loop do
+              begin
+                before_input if respond_to? :before_input
+                if block_given?
+                  yield EasyRepl.gets
+                elsif respond_to? :process_input
+                  process_input(EasyRepl.gets)
+                else
+                  puts EasyRepl.gets
+                end
+              ensure
+                after_input if respond_to? :after_input
+              end
+            end
+          end
+          return if exit_value == :exit
+        ensure
+          teardown if respond_to? :teardown
+        end
+      end
+    ensure
+      IRB::HistorySavingAbility.save_history
+    end
+
+    def gets
+      input = prompt.gets
+      command = commands.find {|c| c.matches(input)}
+      if command
+        command.run
+        return ""
+      else
+        return input
+      end
+    end
+
+    private
+    def commands
+      @commands ||= [EasyRepl::Commands::Exit, EasyRepl::Commands::Reload]
+    end
+
+    def prompt
+      @io ||= IRB::ReadlineInputMethod.new.tap do |new_io|
+        new_io.prompt = "> "
+      end
+    end
+  end
+end

data/lib/easy_repl/version.rb

@@ -0,0 +1,3 @@
+module EasyRepl
+  VERSION = "0.0.2"
+end

data/lib/easy_repl.rb

@@ -0,0 +1,19 @@
+
+
+module EasyRepl
+  attr_accessor :history_file
+  def self.history_file=(value)
+    @history_file = value
+  end
+
+  def self.history_file
+    @history_file
+  end
+
+  require 'easy_repl/repl'
+  require 'easy_repl/commands/matchable'
+  require 'easy_repl/commands/exit'
+  require 'easy_repl/commands/reload'
+  require "easy_repl/version"
+  extend EasyRepl::Repl
+end

data/test/easy_repl_test.rb

@@ -0,0 +1,126 @@
+require './test/support'
+require './lib/easy_repl'
+require 'ostruct'
+
+describe EasyRepl do
+  it "starts and exits" do
+    out = ''
+    EasyRepl.stub :prompt, OpenStruct.new(:gets => "exit") do
+      out, err = capture_io do
+        EasyRepl.start
+      end
+    end
+    assert_includes out, ""
+  end
+
+  it "easy repl accepts a block" do
+    out = ''
+    seq = Support::CommandSequence.new "XXX", "exit"
+    EasyRepl.stub :prompt, seq do
+      out, err = capture_io do
+        EasyRepl.start do |input|
+          puts input
+        end
+      end
+    end
+    assert_equal out, "XXX\n"
+  end
+
+  it "echos all inputs before exit" do
+    out = ''
+    seq = Support::CommandSequence.new "abc", "def", "ghi", "exit"
+    EasyRepl.stub :prompt, seq do
+      out, err = capture_io do
+        EasyRepl.start
+      end
+    end
+    assert_equal "abc\ndef\nghi\n", out
+  end
+
+  it "accepts a block that echos reversed input" do
+    out = ''
+    seq = Support::CommandSequence.new "abc", "def", "ghi", "exit"
+    EasyRepl.stub :prompt, seq do
+      out, err = capture_io do
+        EasyRepl.start do |input|
+          puts input.reverse
+        end
+      end
+    end
+    assert_equal "cba\nfed\nihg\n", out
+  end
+
+  describe "setup is defined" do
+    it "calls setup before asking for input" do
+      out = ''
+      seq = Support::CommandSequence.new "exit"
+      EasyRepl.stub :prompt, seq do
+        out, err = capture_io do
+          Support::SetupEasyRepl.start
+        end
+      end
+      assert_equal "SETUP\n", out
+    end
+
+    it "calls setup when the reload command is entered" do
+      out = ''
+      seq = Support::CommandSequence.new "reload", "exit"
+      EasyRepl.stub :prompt, seq do
+        out, err = capture_io do
+          Support::SetupEasyRepl.start
+        end
+      end
+      assert_equal "SETUP\nSETUP\n", out
+    end
+  end
+
+  describe "teardown is defined" do
+    it "calls teardown before exiting" do
+      out = ''
+      seq = Support::CommandSequence.new "exit"
+      EasyRepl.stub :prompt, seq do
+        out, err = capture_io do
+          Support::TeardownEasyRepl.start
+        end
+      end
+      assert_equal "TEARDOWN\n", out
+    end
+
+    it "calls teardown when the reload command is entered" do
+      out = ''
+      seq = Support::CommandSequence.new "reload", "exit"
+      EasyRepl.stub :prompt, seq do
+        out, err = capture_io do
+          Support::TeardownEasyRepl.start
+        end
+      end
+      assert_equal "TEARDOWN\nTEARDOWN\n", out
+    end
+  end
+
+  describe "before input is defined" do
+    it "calls before input before every command" do
+      out = ''
+      seq = Support::CommandSequence.new "XXX", "exit"
+      EasyRepl.stub :prompt, seq do
+        out, err = capture_io do
+          Support::BeforeInputEasyRepl.start
+        end
+      end
+      assert_equal "BEFOREINPUT\nXXX\nBEFOREINPUT\n", out
+    end
+  end
+
+  describe "after input is defined" do
+    it "calls after input after every command" do
+      out = ''
+      seq = Support::CommandSequence.new "XXX", "exit"
+      EasyRepl.stub :prompt, seq do
+        out, err = capture_io do
+          Support::AfterInputEasyRepl.start
+        end
+      end
+      assert_equal "XXX\nAFTERINPUT\nAFTERINPUT\n", out
+    end
+  end
+end

data/test/support/after_input_easy_repl.rb

@@ -0,0 +1,11 @@
+require './lib/easy_repl'
+
+module Support
+  class AfterInputEasyRepl
+    extend EasyRepl::Repl
+
+    def self.after_input
+      puts "AFTERINPUT"
+    end
+  end
+end

data/test/support/before_input_easy_repl.rb

@@ -0,0 +1,12 @@
+require './lib/easy_repl'
+
+module Support
+  class BeforeInputEasyRepl
+    extend EasyRepl::Repl
+
+    def self.before_input
+      puts "BEFOREINPUT"
+    end
+  end
+end
+

data/test/support/command_sequence.rb

@@ -0,0 +1,11 @@
+module Support
+  class CommandSequence
+    def initialize(*args)
+      @commands = args
+    end
+
+    def gets
+      @commands.shift
+    end
+  end
+end

data/test/support/setup_easy_repl.rb

@@ -0,0 +1,11 @@
+require './lib/easy_repl'
+
+module Support
+  class SetupEasyRepl
+    extend EasyRepl::Repl
+
+    def self.setup
+      puts "SETUP"
+    end
+  end
+end

data/test/support/teardown_easy_repl.rb

@@ -0,0 +1,11 @@
+require './lib/easy_repl'
+
+module Support
+  class TeardownEasyRepl
+    extend EasyRepl::Repl
+
+    def self.teardown
+      puts "TEARDOWN"
+    end
+  end
+end

data/test/support.rb

@@ -0,0 +1,8 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require './test/support/command_sequence'
+require './test/support/setup_easy_repl'
+require './test/support/teardown_easy_repl'
+require './test/support/before_input_easy_repl'
+require './test/support/after_input_easy_repl'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: easy_repl
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Christopher Erin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-05 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: easy repl
+email:
+- chris.erin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_repl.gemspec
+- lib/easy_repl.rb
+- lib/easy_repl/commands/exit.rb
+- lib/easy_repl/commands/matchable.rb
+- lib/easy_repl/commands/reload.rb
+- lib/easy_repl/repl.rb
+- lib/easy_repl/version.rb
+- test/easy_repl_test.rb
+- test/support.rb
+- test/support/after_input_easy_repl.rb
+- test/support/before_input_easy_repl.rb
+- test/support/command_sequence.rb
+- test/support/setup_easy_repl.rb
+- test/support/teardown_easy_repl.rb
+homepage: https://github.com/chriserin/easy_repl
+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.1.11
+signing_key: 
+specification_version: 4
+summary: easy repl
+test_files:
+- test/easy_repl_test.rb
+- test/support.rb
+- test/support/after_input_easy_repl.rb
+- test/support/before_input_easy_repl.rb
+- test/support/command_sequence.rb
+- test/support/setup_easy_repl.rb
+- test/support/teardown_easy_repl.rb