repl_runner 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6202f0b227dbf9c88ab52cf6f10b7294c2f97630
-  data.tar.gz: 0dad45ad6ab909015bda06202b69496a18c6260e
+  metadata.gz: 17d75b996b5cda53bf314490ad7f65a014cae74f
+  data.tar.gz: 3d3a8e485b8ec3994c956c91155722788682efd0
 SHA512:
-  metadata.gz: b54cd9a521ec9df9c82086d4b7441ea7d04c3a09ad5fd384dfb2200b922579a0269e05fb5a17195aef7cd4af99bc43a830eb6ac05c93705ccf4c5c9b3d3a21b9
-  data.tar.gz: a963bcb45e11f9b1b74016d996923994a49e2310fbbc8f6023f68e12b719313b85bb788401b257d44d01a09a34cfa5af86f8b38adb843dbd3814a7fb5c031bf7
+  metadata.gz: dc1f2891ff45a80042105f1562fc86bca5de45964f7ff02079c9085220e6fc0b12c852bab3453fe9e5541928c1996cd11187b860590e9c803e3c9fa1833bd654
+  data.tar.gz: 4bf24b4a0f3275ae713a68098810bb33dc330065ddcef38b2605495daa59e54aa5cc838c216bf116e0c513740cfe91f6e6a896f711fa3b76857a3aa714b9dead

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.3 (02/18/2014)
+
+* Ability to register commands by regex `ReplRunner.register_command(/^bin\/rails/)`
+
 ## 0.0.2 (10/02/2013)
 
 * Remove trailing prompts by default

data/README.md

@@ -28,7 +28,7 @@ Then run `$ bundle install`.
 
 To open a remote rails console on heroku with the heroku toolbelt installed, you could drive it like this:
 
-```
+```ruby
 ReplRunner.new(:rails_console, "heroku run rails console -a testapp").run do |repl|
   repl.run('a = 1 + 1')         {|result| assert_match '2', result }
   repl.run('"hello" + "world"') {|result| assert_match 'helloworld', result }
@@ -36,6 +36,8 @@ ReplRunner.new(:rails_console, "heroku run rails console -a testapp").run do |re
 end
 ```
 
+**Note:** do not forget to call `run` on the ReplRunner object.
+
 The first argument `:rails_console` tells ReplReader what type of a session we are going to open up. The second `"heroku run rails console -a testapp"` is the command we want to use to start our psuedo remote terminal.
 
 You can then call `run` on this and pass in a block. The block yields to a `MultiRepl` instance that can take the command `run` along with arguments to pass into the command line such as `'1+1'`
@@ -47,13 +49,13 @@ Also note that you will get the entire return including any prompts if you run a
 ```
 $ irb
 1.9.3p392 :001 > 1 + 1
- => 2
+=> 2
 ```
 
 So when you run this via ReplRunner you will get a result string like this
 
-```
-ReplRunner.new(:irb) do |repl|
+```ruby
+ReplRunner.new(:irb).run do |repl|
   repl.run('1 + 1') {|result| puts result }
 end
 " => 2\r\r\n"

data/lib/repl_runner.rb

@@ -6,11 +6,12 @@ require 'pty'
 require 'active_support/core_ext/object/blank'
 
 class ReplRunner
-  attr_accessor :command, :repl
+  attr_accessor :command, :repl, :config
 
-  class NoResults < StandardError
-    def initialize(command, string)
-      msg = "No result found for command: #{command.inspect} in output: #{string.inspect}"
+  class NoResultsError < StandardError
+    def initialize(command, regex, string)
+      msg =  "No result found for command: #{command.inspect}\nIn output: \n  #{string.inspect}\n"
+      msg << "Using regex: \n  /#{regex}/\n"
       super(msg)
     end
   end
@@ -23,15 +24,23 @@ class ReplRunner
   end
 
   def initialize(cmd_type, command = nil, options = {})
+    raise "Unexpected block, use the `run` command instead?" if block_given?
     command  = cmd_type.to_s if command.nil?
     cmd_type = cmd_type.chomp.gsub(/\s/, '_').to_sym if cmd_type.is_a?(String)
     @command = command
     @repl    = nil
-    @config  = known_configs[cmd_type]
+    @config  = get_config_for_command(cmd_type)
     raise UnregisteredCommand.new(cmd_type) unless @config
     @options = options
   end
 
+  def get_config_for_command(cmd_type)
+    known_configs.detect do |cmd_match, config|
+      return config if cmd_match == cmd_type
+      return config if cmd_match.is_a?(Regexp) && cmd_match =~ cmd_type.to_s
+    end
+  end
+
   def known_configs
     self.class.known_configs
   end
@@ -61,13 +70,13 @@ class ReplRunner
 
   def zip(string)
     results = []
-    lines   = string.lines.map(&:rstrip)
+    inputs  = string.lines.map(&:rstrip)
     self.run do |repl|
-      lines.each do |line|
+      inputs.each do |line|
         repl.run(line) {|result| results << result }
       end
     end
-    lines.zip(results)
+    inputs.zip(results)
   end
 
   def run(&block)

data/lib/repl_runner/default_config.rb

@@ -1,4 +1,4 @@
-ReplRunner.register_command(:rails_console, :irb)  do |config|
+ReplRunner.register_command(:rails_console, :irb, /^bin\/rails/)  do |config|
   config.terminate_command "exit"          # the command you use to end the 'rails console'
   config.startup_timeout 60                # seconds to boot
   config.return_char "\n"                  # the character that submits the command

data/lib/repl_runner/multi_command_parser.rb

@@ -24,7 +24,7 @@ class ReplRunner
         regex = command_to_regex(command)
         before, match, result = string.rpartition(regex)
 
-        raise NoResults.new(command, raw) if result.empty?
+        raise NoResultsError.new(command, regex, raw) if result.empty?
 
         string = before
         @parsed_result << result.rpartition(STRIP_TRAILING_PROMPT_REGEX).first

data/lib/repl_runner/multi_repl.rb

@@ -73,7 +73,7 @@ class ReplRunner
       @jobs.each_with_index do |job, index|
         job.call(output_array[index])
       end
-    rescue NoResults => e
+    rescue NoResultsError => e
       raise e, "Booting up REPL with command: #{command.inspect} \n#{e.message}"
     end
   end

data/lib/repl_runner/version.rb

@@ -1,3 +1,3 @@
 class ReplRunner
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/config_test.rb

@@ -25,4 +25,9 @@ class ConfigTest < Test::Unit::TestCase
 
     assert_equal @hash, config.to_options
   end
+
+  def test_default_config
+    runner = ReplRunner.new("bin/rails console")
+    assert_equal "exit", runner.config.to_options[:terminate_command]
+  end
 end

data/test/pty_party_test.rb

@@ -9,10 +9,22 @@ class StreamExecTest < Test::Unit::TestCase
   end
 
   def test_multi_command_read
-    repl  = ReplRunner::PtyParty.new("irb --simple-prompt")
+    repl  = ReplRunner::PtyParty.new("env TERM=ansi-mono irb --simple-prompt")
     repl.write("STDOUT.sync = true\n")
     repl.write("1+1\n")
     repl.write("exit\n")
-    assert_equal "STDOUT.sync = true\r\n1+1\r\nexit\r\n>> STDOUT.sync = true\r\n=> true\r\n>> 1+1\r\n=> 2\r\n>> exit\r\n", repl.read
+    result = repl.read
+    [
+      "STDOUT.sync = true",
+      "1+1",
+      "exit",
+      ">> STDOUT.sync = true",
+      "=> true",
+      ">> 1+1",
+      "=> 2",
+      ">> exit"
+    ].each do |expected|
+      assert_match /#{Regexp.escape(expected)}/, result
+    end
   end
 end

data/test/repl_runner_test.rb

@@ -19,6 +19,13 @@ class ReplRunnerTest < Test::Unit::TestCase
     end
   end
 
+  def test_forgot_run
+    assert_raise RuntimeError do
+      ReplRunner.new(:irb, "irb") do |repl|
+      end
+    end
+  end
+
   def test_does_not_have_trailing_prompts
     ReplRunner.new(:irb, "irb ").run do |repl|
       repl.run('111+111')           {|r| assert_equal "=> 222", r.strip }
@@ -26,7 +33,7 @@ class ReplRunnerTest < Test::Unit::TestCase
   end
 
   def test_ensure_exit
-    assert_raise(ReplRunner::NoResults) do
+    assert_raise(ReplRunner::NoResultsError) do
       ReplRunner.new(:irb, "irb -r ./test/require/never-boots.rb", startup_timeout: 2).run do |repl|
         repl.run('111+111') {|r| }
       end
@@ -46,19 +53,25 @@ class ReplRunnerTest < Test::Unit::TestCase
   end
 
   def test_zipping_commands
-    commands = "a = 3\nb = 'foo' * a\nputs b"
-    zip      = ReplRunner.new(:irb).zip(commands)
-    actual   = [["a = 3", "=> 3\r"],
-                ["b = 'foo' * a", "=> \"foofoofoo\"\r"],
-                ["puts b", "foofoofoo\r\n=> nil\r"]]
-    assert_equal actual, zip
+    commands = []
+    results  = []
+    commands << "a = 3\n"
+    commands << "b = 'foo' * a\n"
+    commands << "puts b"
+
+    repl = ReplRunner.new(:irb)
+    zip  = repl.zip(commands.join(""))
+
+    repl.run do |repl|
+      commands.each do |command|
+        repl.run(command.rstrip) {|r| results << r }
+      end
+    end
+    expected = [[commands[0].rstrip, results[0]],
+                [commands[1].rstrip, results[1]],
+                [commands[2].rstrip, results[2]]]
+    assert_equal expected, zip
 
-    expected = ["a = 3",
-                "=> 3\r",
-                "b = 'foo' * a",
-                "=> \"foofoofoo\"\r",
-                "puts b",
-                "foofoofoo\r\n=> nil\r"]
-    assert_equal expected, zip.flatten
+    assert_equal expected.flatten, zip.flatten
   end
 end

metadata

@@ -1,66 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: repl_runner
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !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: mocha
   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: ' Programatically drive REPL like interfaces, irb, bash, etc. '
+description: " Programatically drive REPL like interfaces, irb, bash, etc. "
 email:
 - richard@heroku.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -91,17 +91,17 @@ 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.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Run your REPL like interfaces like never before
@@ -113,3 +113,4 @@ test_files:
 - test/repl_runner_test.rb
 - test/require/never-boots.rb
 - test/test_helper.rb
+has_rdoc: