rspec_approvals 0.8.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5b4e09ac5169c8240d4edf4c4af422845f6508064c93d2277ecafb477c3280f
-  data.tar.gz: f95d71fc3c4986f9e22675acb082f7c0dce415a3d92b940b98ddd494e256c154
+  metadata.gz: 0fb4bded8ab248d2bd2826a66f0bbac01188b92614bea48bfb0203f80f118934
+  data.tar.gz: cfaf0bea149ef3926d99f136f291b837756af97dda04d807ce47d55f57dc72a9
 SHA512:
-  metadata.gz: 62a96b36858efaa4d83363ce260c0e873bd6cd3dd42ed09c5e9ef5463193a813a16e7cda50d3cdd0f48a61b015679ccb8804c6fabe5c68808f9c8d3f7753b523
-  data.tar.gz: a207d63a7719161c9bb333030b22dec35b04ea391ba17e6a8c2bde5f780c1ebe7264590023eeb6651f7d547e21f99e2ab5c6d2eb2f3d76455fad8cf7a8c3e54e
+  metadata.gz: 041c95b54d4a62f16f0de9fb0502eb482723caca78698e7d9c0d41e5ce42031acbb59ced32bf18524962044ef3baa2daf6db0e07d5802350d13d550bd3cf3d50
+  data.tar.gz: e77f8886c6a274455423a2ee584342a78d89a53536d75419d5965d4013d8f5166c96faadd4aec4e1980d4a0dc80c8a9cb0e1fc33d04048f62170841f911a8d26

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/rspec_approvals.svg)](https://badge.fury.io/rb/rspec_approvals)
 [![Build Status](https://github.com/DannyBen/rspec_approvals/workflows/Test/badge.svg)](https://github.com/DannyBen/rspec_approvals/actions?query=workflow%3ATest)
-[![Maintainability](https://api.codeclimate.com/v1/badges/a06ed5e30412062c454c/maintainability)](https://codeclimate.com/github/DannyBen/rspec_approvals/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b6ca26de93d9236c706a/maintainability)](https://codeclimate.com/github/DannyBen/rspec_approvals/maintainability)
 
 ---
 
@@ -237,6 +237,17 @@ ENV['COLUMNS'] = '80'
 ENV['LINES'] = '24'
 ```
 
+### Recommended rspec flags
+
+For best results, it is recommended you configure rspec to use the
+documentation format. Place the code below in a file named `.rspec`
+in your project's directory:
+
+```
+--color
+--format documentation
+```
+
 ## Contributing / Support
 
 If you experience any issue, have a question or a suggestion, or if you wish

data/lib/rspec_approvals/approval_handler.rb

@@ -1,6 +1,5 @@
 require 'io/console'
 require 'colsole'
-require 'tty-prompt'
 require 'diffy'
 
 module RSpecApprovals
@@ -20,7 +19,7 @@ module RSpecApprovals
       prompt_user
     end
 
-    private
+  private
 
     def prompt_user
       response = auto_approve? ? :approve : get_response
@@ -45,23 +44,19 @@ module RSpecApprovals
     end
 
     def get_response
-      prompt.select "Please Choose:", menu_options, symbols: { marker: '>' }
-    rescue TTY::Reader::InputInterrupt
-      # :nocov:
-      return :reject
-      # :nocov:
+      Prompt.select "Please Choose:", 'r', menu_options
     end
 
     def menu_options
       base = {
-        'Reject (and fail test)' => :reject,
-        'Approve (and save)' => :approve,
+        'a' => ['Approve (and save)', :approve],
+        'r' => ['Reject (and fail test)', :reject]
       }
 
       extra = {
-        'Show actual output' => :actual,
-        'Show expected output' => :expected,
-        'Show diff' => :diff,
+        '1' => ['Show actual output', :actual],
+        '2' => ['Show expected output', :expected],
+        '3' => ['Show diff', :diff]
       }
 
       expected.empty? ? base : base.merge(extra) 
@@ -87,13 +82,10 @@ module RSpecApprovals
     end
 
     def show(what)
+      say ""
       say separator
       say what
       say separator
     end
-
-    def prompt
-      @prompt ||= TTY::Prompt.new
-    end
   end
 end

data/lib/rspec_approvals/extensions/stringio.rb

@@ -0,0 +1,28 @@
+# This is a fix for a pesky issue with tty-screen, which is a sub-dependency
+# of tty-* gems.
+# Without this fix, gems that include rspec_approval and tty-* gems might
+# cause an error in some cases.
+#
+# ref: https://github.com/piotrmurach/tty-screen/issues/11
+require 'stringio'
+
+unless StringIO.method_defined? :ioctl
+  class StringIO
+    def ioctl(*)
+      # :nocov:
+      80
+      # :nocov:
+    end
+  end
+end
+
+unless StringIO.method_defined? :wait_readable
+  class StringIO
+    def wait_readable(*)
+      # :nocov:
+      true
+      # :nocov:
+    end
+  end
+end
+

data/lib/rspec_approvals/prompt.rb

@@ -0,0 +1,25 @@
+require 'io/console'
+require 'colsole'
+
+module RSpecApprovals
+  class Prompt
+    class << self
+      include Colsole
+
+      def select(prompt, default, options)
+        options.each do |key, config|
+          color = key == default ? 'txtred' : 'txtgrn'
+          say "!#{color}!#{key}!txtrst!) #{config.first}"
+        end
+        
+        say "\n!txtblu!#{prompt}!txtrst! "
+        response = STDIN.getch.downcase
+        
+        response = default unless options.has_key? response
+        
+        resay "!txtpur!#{options[response].first}"
+        options[response].last
+      end
+    end
+  end
+end

data/lib/rspec_approvals/stream.rb

@@ -6,35 +6,36 @@ module RSpecApprovals
   # These methods are borrowed from rspec's built in matchers
   # https://github.com/rspec/rspec-expectations/blob/add9b271ecb1d65f7da5bc8a9dd8c64d81d92303/lib/rspec/matchers/built_in/output.rb
   module Stream
-    module Stdout
-      def self.capture(block)
+    module Capture
+      def self.capture(stream, block)
         RSpecApprovals.stdout.truncate 0
         RSpecApprovals.stdout.rewind
+        RSpecApprovals.stderr.truncate 0
+        RSpecApprovals.stderr.rewind
 
-        original_stream = $stdout
+        stdout_original_stream = $stdout
+        stderr_original_stream = $stderr
         $stdout = RSpecApprovals.stdout
+        $stderr = RSpecApprovals.stderr
         block.call
-        RSpecApprovals.stdout.string.dup
+        RSpecApprovals.send(stream).string.dup
 
       ensure
-        $stdout = original_stream
+        $stdout = stdout_original_stream
+        $stderr = stderr_original_stream
 
       end
     end
 
-    module Stderr
+    module Stdout
       def self.capture(block)
-        RSpecApprovals.stderr.truncate 0
-        RSpecApprovals.stderr.rewind
-
-        original_stream = $stderr
-        $stderr = RSpecApprovals.stderr
-        block.call
-        RSpecApprovals.stderr.string.dup
-
-      ensure
-        $stderr = original_stream
+        Capture.capture :stdout, block
+      end
+    end
 
+    module Stderr
+      def self.capture(block)
+        Capture.capture :stderr, block
       end
     end
   end

data/lib/rspec_approvals/version.rb

@@ -1,3 +1,3 @@
 module RSpecApprovals
-  VERSION = "0.8.0"
+  VERSION = "0.9.2"
 end

data/lib/rspec_approvals.rb

@@ -1,6 +1,8 @@
 require 'rspec_approvals/extensions/file'
+require 'rspec_approvals/extensions/stringio'
 
 require 'rspec_approvals/module_functions'
+require 'rspec_approvals/prompt'
 require 'rspec_approvals/stream'
 require 'rspec_approvals/approval_handler'
 require 'rspec_approvals/matchers/base'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_approvals
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: tty-prompt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: strings-ansi
   requirement: !ruby/object:Gem::Requirement
@@ -90,11 +76,13 @@ files:
 - lib/rspec_approvals.rb
 - lib/rspec_approvals/approval_handler.rb
 - lib/rspec_approvals/extensions/file.rb
+- lib/rspec_approvals/extensions/stringio.rb
 - lib/rspec_approvals/matchers/base.rb
 - lib/rspec_approvals/matchers/match_approval.rb
 - lib/rspec_approvals/matchers/output_approval.rb
 - lib/rspec_approvals/matchers/raise_approval.rb
 - lib/rspec_approvals/module_functions.rb
+- lib/rspec_approvals/prompt.rb
 - lib/rspec_approvals/rspec_config.rb
 - lib/rspec_approvals/stream.rb
 - lib/rspec_approvals/version.rb
@@ -117,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Interactive RSpec Approvals