cexpect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ccc43da0141c2168408e3a9f931f58e37c0a71edab8b2bcd40066396ed8dfbe
+  data.tar.gz: 543082cfb8016426f41aad970df5cadee7109f285aec39b8062cb097662ab49a
+SHA512:
+  metadata.gz: faf35c685141bbe365000a483594932614fc9b5873b152a5fff7fdbdc961b769f62c91f69b8553f6265b31cf4d9beaf5913f0736e5d21c4f9e644d48b27c98cb
+  data.tar.gz: '0383c442a569ac777e57f9bd38b2c63025ad2d1bfb2748ddc6adf0859f32cdc85c755a66d9dfc6c15a336ed5258bafd2566652299954d56d357d3fcb6d9f025f'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Changelog for the `cexpect` gem
+* cexpect 0.1.0: First version

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cexpect.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    cexpect (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cexpect!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2017, Christer Jansson (christer@janssons.org)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,89 @@
+# CExpect
+
+The `IO#expect` in the `expect` ruby module is very useful for
+automating interaction with interactive shell scripts. However, it has
+a few shortcomings:
+
+* Its return value is not as useful as it could be
+* Logging can only be achieved by setting a global variable
+* Using regexps for matching becomes slow with large amounts of data
+* The default expect timeout is a very large number (this doesn't
+  actually affect the functionality negatively, it just feels awkward)
+
+To adress this, the CExpect (Christer's Expect) gem offers a different
+interface:
+
+* The exposed `expect` method returns or yields the match data when a
+  match is found, which makes it possible to e.g. use capturing in a
+  meaningful way (see Usage below)
+* It also returns the return value of the block, when a block is given
+* Logging can be achieved by adding observers
+* There is an alternate `fexpect` method (the f can be thought of as
+  "fixed" or "fast"), which is useful for capturing large outputs from
+  shell commands
+* The default timeout is `nil`, which will cause `expect` to wait
+  indefinitely (again, this merely makes more sense to someone reading
+  the code)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cexpect'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cexpect
+
+## Usage
+
+```ruby
+require 'cexpect'
+
+# Same semantics as PTY.spawn
+rd, wr, pid = CExpect.spawn('sh')
+
+rd.fexpect('$ ')
+wr.puts('ls -1')
+md = rd.expect(/ls -1\r\n(?<files>.*)\$ /m)
+files = md[:files].split
+
+# Or, equivalently
+rd.expect(/ls -1\r\n(?<files>.*)\$ /m) do |md|
+  files = md[:files].split
+  # do something with files
+end
+
+wr.puts('cat very-large-file')
+contents = rd.fexpect('$ ')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake spec` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will
+create a git tag for the version, push git commits and tags, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/kondensatorn/cexpect.
+
+
+## License
+
+The gem is available as open source under the terms of the [BSD 2-Clause
+License](https://opensource.org/licenses/BSD-2-Clause).

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 "cexpect"
+
+# 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/cexpect.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/cexpect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cexpect"
+  spec.version       = Cexpect::VERSION
+  spec.authors       = ["Christer Jansson"]
+  spec.email         = ["christer@janssons.org"]
+
+  spec.summary       = %q{An improved expect method}
+  spec.description   = %q{An expect method with more reasonable return values and logging functionality}
+  spec.homepage      = "https://github.com/kondensatorn/cexpect"
+  spec.license       = "BSD 2-clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # 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('..', __FILE__)) 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"]
+end

data/lib/cexpect.rb

@@ -0,0 +1,83 @@
+require 'delegate'
+require 'observer'
+require 'pty'
+
+module CExpect
+  def self.spawn(*args)
+    original_rd, wr, pid = PTY.spawn(*args)
+    rd = CExpect::Reader.new(original_rd)
+    if block_given?
+      yield(rd, wr, pid)
+    else
+      [rd, wr, pid]
+    end
+  end
+
+  class Reader < SimpleDelegator
+    include Observable
+
+    def initialize(_original)
+      @leftovers = ''
+      super
+    end
+
+    def expect(pat, timeout = nil, match_method: :_expect_re_match)
+      buf = +''
+
+      result = catch(:result) do
+        loop { _expect_try(pat, buf, timeout, match_method) }
+      end
+
+      if block_given?
+        yield result
+      else
+        result
+      end
+    end
+
+    def fexpect(pat, timeout = nil)
+      expect(pat, timeout, match_method: :_expect_string_match)
+    end
+
+    private
+
+    def _expect_try(pat, buf, timeout, match_method)
+      c = _expect_getc(timeout)
+
+      if c.nil?
+        @leftovers = buf
+        throw(:result, nil)
+      end
+
+      buf << c
+
+      _expect_log(pat, buf)
+
+      result = send(match_method, buf, pat)
+      throw(:result, result) if result
+    end
+
+    def _expect_getc(timeout)
+      return @leftovers.slice!(0).chr unless @leftovers.empty?
+
+      return nil if !IO.select([self], nil, nil, timeout) || eof?
+
+      getc.chr
+    end
+
+    def _expect_log(pat, buf)
+      return if count_observers.zero?
+
+      changed
+      notify_observers("pat: #{pat.inspect}\nbuf: #{buf.inspect}\n")
+    end
+
+    def _expect_re_match(buf, pat)
+      buf.match(pat)
+    end
+
+    def _expect_string_match(buf, pat)
+      buf[0, buf.size - pat.size] if buf.end_with?(pat)
+    end
+  end
+end

data/lib/cexpect/version.rb

@@ -0,0 +1,3 @@
+module Cexpect
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: cexpect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christer Jansson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-28 00:00:00.000000000 Z
+dependencies: []
+description: An expect method with more reasonable return values and logging functionality
+email:
+- christer@janssons.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cexpect.gemspec
+- lib/cexpect.rb
+- lib/cexpect/version.rb
+homepage: https://github.com/kondensatorn/cexpect
+licenses:
+- BSD 2-clause
+metadata:
+  homepage_uri: https://github.com/kondensatorn/cexpect
+  source_code_uri: https://github.com/kondensatorn/cexpect
+  changelog_uri: https://github.com/kondensatorn/cexpect/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: An improved expect method
+test_files: []