cexpect 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ccc43da0141c2168408e3a9f931f58e37c0a71edab8b2bcd40066396ed8dfbe
-  data.tar.gz: 543082cfb8016426f41aad970df5cadee7109f285aec39b8062cb097662ab49a
+  metadata.gz: 7d6f51d1822901ccaef277fd26017749f6d65ed3eaea50836fa2fbe5b7e90410
+  data.tar.gz: 9eade35e51126e2ce00f99a02f3f1052f09314ecd19b516cb51f0d7ea4438139
 SHA512:
-  metadata.gz: faf35c685141bbe365000a483594932614fc9b5873b152a5fff7fdbdc961b769f62c91f69b8553f6265b31cf4d9beaf5913f0736e5d21c4f9e644d48b27c98cb
-  data.tar.gz: '0383c442a569ac777e57f9bd38b2c63025ad2d1bfb2748ddc6adf0859f32cdc85c755a66d9dfc6c15a336ed5258bafd2566652299954d56d357d3fcb6d9f025f'
+  metadata.gz: 28a4cc9e4edfa0b18fa6d57f0c43f0fefae54b8872de8fe09c56595b31bf203a0aa5a24fe8005ebc737483c5a7d5e293fdd1d95276a57faccb717e786420ddc1
+  data.tar.gz: 180e097fe5134c7527264a9a464bb5d4c27a8317dd08aef3886a560e997a00f1836f6740987fe6ccf83e8f181be8e5509f6a0ad2849b5788f89d9ac60312c1d6

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1.70.1
+      with:
+        ruby-version: 3.0
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --require spec_helper
+-Ilib

data/.rubocop.yml

@@ -0,0 +1,43 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'bin/{console,setup}' # not mine
+    - 'Gemfile'             # maintained through "bundle" command
+
+# TODO: Clean up tests
+RSpec/ExpectInHook:
+  Enabled: false
+RSpec/FilePath:
+  Exclude:
+    - spec/cexpect_spec.rb
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+# Personal preferences
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+
+# New stuff in rubocop, not yet enabled/disabled by default
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,2 +1,4 @@
 # Changelog for the `cexpect` gem
 * cexpect 0.1.0: First version
+* cexpect 0.1.1: Different logging interface, general clean-up
+* cexpect 0.1.2: Update CHANGELOG.md and fix gemspec

data/Gemfile

@@ -5,3 +5,6 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.82.0"
+gem "rubocop-rspec", "~> 1.38"

data/Gemfile.lock

@@ -1,26 +1,45 @@
 PATH
   remote: .
   specs:
-    cexpect (0.1.0)
+    cexpect (0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    jaro_winkler (1.5.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
     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)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-rspec (1.41.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -29,6 +48,8 @@ DEPENDENCIES
   cexpect!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop (~> 0.82.0)
+  rubocop-rspec (~> 1.38)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -62,6 +62,16 @@ end
 
 wr.puts('cat very-large-file')
 contents = rd.fexpect('$ ')
+
+# If CExpect.spawn doesn't suit you
+orig_rd, wr = IO.pipe
+rd = CExpect::Reader.new(orig_rd)
+
+wr.puts "Hello, World!\n"
+greeting = rd.fexpect("\n")
+
+# If you want logging
+
 ```
 
 ## Development

data/Rakefile

@@ -1,6 +1,10 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: %i(spec rubocop)

data/cexpect.gemspec

@@ -1,27 +1,32 @@
+# frozen_string_literal: true
+
 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.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.summary       = 'An improved expect method'
+  spec.description   = '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"
+  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)/}) }
+  # 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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

data/lib/cexpect.rb

@@ -1,31 +1,30 @@
+# frozen_string_literal: true
+
+require 'cexpect/module_methods'
 require 'delegate'
 require 'observer'
-require 'pty'
 
+#
+# A module for supplying a different expect method
+#
 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
+  extend CExpect::ModuleMethods
 
+  #
+  # A class delegating normal operations to a wrapped IO, adding an
+  # expect method
+  #
   class Reader < SimpleDelegator
-    include Observable
-
-    def initialize(_original)
-      @leftovers = ''
-      super
+    def initialize(io, observers = nil)
+      extend(LoggingReader) if observers
+      super(io)
     end
 
-    def expect(pat, timeout = nil, match_method: :_expect_re_match)
+    def expect(pat, timeout = nil, match_method: :re_match)
       buf = +''
 
       result = catch(:result) do
-        loop { _expect_try(pat, buf, timeout, match_method) }
+        loop { expect_try(pat, buf, timeout, match_method) }
       end
 
       if block_given?
@@ -36,48 +35,52 @@ module CExpect
     end
 
     def fexpect(pat, timeout = nil)
-      expect(pat, timeout, match_method: :_expect_string_match)
+      expect(pat, timeout, match_method: :string_match)
     end
 
     private
 
-    def _expect_try(pat, buf, timeout, match_method)
-      c = _expect_getc(timeout)
+    def expect_try(pat, buf, timeout, match_method)
+      c = getc(timeout)
 
-      if c.nil?
-        @leftovers = buf
-        throw(:result, nil)
-      end
+      throw(:result, nil) if c.nil?
 
       buf << c
 
-      _expect_log(pat, buf)
+      log(pat, buf) if respond_to?(:log)
 
       result = send(match_method, buf, pat)
       throw(:result, result) if result
     end
 
-    def _expect_getc(timeout)
-      return @leftovers.slice!(0).chr unless @leftovers.empty?
+    def getc(timeout)
+      rd = __getobj__
 
-      return nil if !IO.select([self], nil, nil, timeout) || eof?
+      return nil if !IO.select([rd], nil, nil, timeout) || eof?
 
-      getc.chr
+      rd.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)
+    def re_match(buf, pat)
       buf.match(pat)
     end
 
-    def _expect_string_match(buf, pat)
+    def string_match(buf, pat)
       buf[0, buf.size - pat.size] if buf.end_with?(pat)
     end
   end
+
+  #
+  # Adds logging capability when observers are given to constructor
+  #
+  module LoggingReader
+    include Observable
+
+    def log(pat, buf)
+      return if count_observers.zero?
+
+      changed
+      notify_observers(pat, buf)
+    end
+  end
 end

data/lib/cexpect/module_methods.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'pty'
+
+module CExpect
+  #
+  # Module methods for CExpect
+  #
+  module ModuleMethods
+    #
+    # Assume first element benefits from using CExpect
+    #
+    # This generalization is a bit iffy; it works for class methods
+    # that returns and yields an IO reader first, followed by any
+    # other parameters. But hey, if we need to wrap things that behave
+    # differently, we can just give this one (and its shared examples
+    # in the specs) a more specific name and implement another.
+    #
+    def cexpect_wrap(array, &block)
+      array[0] = CExpect::Reader.new(array[0])
+      if block_given?
+        block.call(*array)
+      else
+        array
+      end
+    end
+
+    def pipe(*args, &block)
+      cexpect_wrap(IO.pipe(*args), &block)
+    end
+
+    def spawn(*args, &block)
+      cexpect_wrap(PTY.spawn(*args), &block)
+    end
+  end
+end

data/lib/cexpect/version.rb

@@ -1,3 +1,5 @@
-module Cexpect
-  VERSION = "0.1.0"
+# frozen_string_literal: true
+
+module CExpect
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cexpect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Christer Jansson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies: []
 description: An expect method with more reasonable return values and logging functionality
 email:
@@ -17,8 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -30,10 +32,11 @@ files:
 - bin/setup
 - cexpect.gemspec
 - lib/cexpect.rb
+- lib/cexpect/module_methods.rb
 - lib/cexpect/version.rb
 homepage: https://github.com/kondensatorn/cexpect
 licenses:
-- BSD 2-clause
+- BSD-2-Clause
 metadata:
   homepage_uri: https://github.com/kondensatorn/cexpect
   source_code_uri: https://github.com/kondensatorn/cexpect
@@ -53,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: An improved expect method