rspec_fixtures 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 824a68775a4a3f44ab6c7f897de7df47431f7b1b233e4f3224cb71b9dc4ca5a1
-  data.tar.gz: 1d8830af166d11392768543e9ab6cc924e1dc9c985c52f1906f44da3d94b77f1
+  metadata.gz: 45b4a358e1d0676243ab8e196d564a24004925cea26a4e4e7fea2260c207947b
+  data.tar.gz: 24e457d02d6cb4508da343bbce5bf55bc8c69978db0590a2fc78ea305c1aeef5
 SHA512:
-  metadata.gz: b8a0198c92a30cbd6600598b41d74df121f64d96202d368a187a04027689301175c256ca672cfe2d34aa7e63a152382f4c27b3a771220b0bc6dbc68fa6a2d3eb
-  data.tar.gz: 7d5687f648b7e9e5b3e2ff733a3e91495c4279103726069f91c9d53d5872386169a221c4f64c78bac55dc4127cea6bd0713972fc0ed80c34379d0c26815c2a62
+  metadata.gz: 5b0ba1c117b24f8f5eda492b846d6e398e284243823a64039fb8178a5921f19eaf5ccf55880a3f370a0d7f5b16f2dff174b64f994ca748fb4429ad515066ebe7
+  data.tar.gz: 2143684b0101b840ef918a91d8eaf55ae87cac86bcfd2772207c8c24dc93b96f57cf10bb248a79302a7e83a7d85d4f551b05bcc216779c342a649016d82b3cee

data/README.md

@@ -17,6 +17,7 @@ content.
 ---
 
 
+
 Install
 --------------------------------------------------
 
@@ -31,6 +32,7 @@ gem 'rspec_fixtures'
 ```
 
 
+
 Usage
 --------------------------------------------------
 
@@ -51,10 +53,12 @@ describe 'ls' do
 end
 ```
 
+
+
 Matchers
 --------------------------------------------------
 
-### `match_fixture`
+### `match_fixture` - Compare Strings
 
 Compare a string with a pre-approved fixture.
 
@@ -62,7 +66,8 @@ Compare a string with a pre-approved fixture.
 expect('some string').to match_fixture('fixture_filename')
 ```
 
-### `output_fixture`
+
+### `output_fixture` - Compare STDOUT/STDERR
 
 Compare an output (stdout or stderr) with a pre-approved fixture.
 
@@ -75,6 +80,24 @@ expect{ $stderr.puts "hello" }.to output_fixture('fixture_filename').to_stderr
 ```
 
 
+### `diff` - String Similarity
+
+Adding `diff(distance)` to either `match_fixture` or `output_fixture` will
+change the matching behavior. Instead of expecting the strings to be exactly
+the same, using `diff` compares the strings using the Levenshtein text 
+similarity algorithm.
+
+In the below example, we allow up to 5 characters to be different.
+
+```ruby
+expect('some string').to match_fixture('fixture_filename').diff(5)
+expect{ puts 'some string' }.to output_fixture('fixture_filename').diff(5)
+```
+
+Distance is measured using the Levenshtein algorithm.
+
+
+
 Configuration
 --------------------------------------------------
 
@@ -90,6 +113,7 @@ RSpec.configure do |config|
 end
 ```
 
+
 ### `fixtures_path`
 
 By default, fixtures are stored in `spec/fixtures`. To change the path,
@@ -99,4 +123,5 @@ add this to your `spec_helper`.
 RSpec.configure do |config|
   config.fixtures_path = 'spec/anywhere/else'
 end
-```
+```
+

data/lib/rspec_fixtures/approval_handler.rb

@@ -2,6 +2,8 @@ require 'colsole'
 require 'io/console'
 
 module RSpecFixtures
+
+  # Handles user input and interactive fixture approvals
   class ApprovalHandler
     include Colsole
 

data/lib/rspec_fixtures/matchers/base.rb

@@ -1,52 +1,98 @@
 module RSpecFixtures
   module Matchers
 
+    # A base matcher for fixture approvals
     class Base
-      attr_reader :fixture_name, :actual
+      attr_reader :fixture_name, :actual, :distance, :actual_distance
 
       def initialize(fixture_name=nil)
         @fixture_name = fixture_name
       end
 
+      # Called by RSpec. This will be overridden by child matchers.
       def matches?(actual)
-        @actual = actual
-        false
+        @actual ||= actual
+
+        success = strings_match?
+
+        if success or !interactive?
+          success
+        else
+          approve_fixture
+        end
+      end
+
+      # Provides a chained matcher to do something like:
+      # `expect(string).to match_fixture(file).diff(10)
+      # The distance argument is the max allowed Levenshtein Distance.
+      def diff(distance)
+        @distance = distance
+        self
       end
 
+      # Returns the expected value, from a fixture file
       def expected
         @expected ||= expected!
       end
 
+      # Called by RSpec when there is a failure
       def failure_message
-        "expected #{actual}\nto match #{expected}"
+        result = "expected: #{actual}\nto match: #{expected}"
+        
+        if distance
+          result = "#{result}\n(actual distance is #{actual_distance} instead of the expected #{distance})"
+        end
+
+        result
       end
 
+      # Lets RSpec know these matchers support diffing
       def diffable?
         true
       end
 
+      # Returns true if RSpec is configured to allow interactivity.
+      # By default, interactivity is enabled unless the environment 
+      # variable `CI` is set.
       def interactive?
         RSpec.configuration.interactive_fixtures
       end
 
+      # Returns the path to the fixtures directory.
+      # Default: `spec/fixtures`
       def fixtures_dir
         RSpec.configuration.fixtures_path
       end
 
+      # Returns the path to the fixture file
       def fixture_file
         "#{fixtures_dir}/#{fixture_name}"
       end
       
       protected
 
+      # Asks for user approval. Used by child classes.
       def approve_fixture
         approval_handler = ApprovalHandler.new
         approval_handler.run expected, actual, fixture_file
       end
 
+      # Returns the actual fixture file content.
       def expected!
         File.exist?(fixture_file) ? File.read(fixture_file) : ''
       end
+
+      # Do the actual test. If .diff() was used, then distance will be 
+      # set and then we "levenshtein it". Otherwise, compare with ==
+      def strings_match?
+        if distance
+          @actual_distance = String::Similarity.levenshtein_distance expected, actual
+          @actual_distance <= distance
+        else
+          actual == expected
+        end
+      end
+
     end
 
   end

data/lib/rspec_fixtures/matchers/match_fixture.rb

@@ -1,18 +1,14 @@
+require 'string-similarity'
+
 module RSpecFixtures
   module Matchers
+    # Adds the matcher to RSpec:
+    # `expect(string).to match_fixture(file)`
     def match_fixture(expected)
       MatchFixture.new expected
     end
     
     class MatchFixture < Base
-      def matches?(actual)
-        @actual = actual
-        if actual == expected or !interactive?
-          actual == expected
-        else
-          approve_fixture
-        end
-      end
     end
     
   end

data/lib/rspec_fixtures/matchers/output_fixture.rb

@@ -1,30 +1,34 @@
 module RSpecFixtures
   module Matchers
+    # Adds the matcher to RSpec:
+    # `expect{ stream }.to output_fixture(file)`
     def output_fixture(expected)
       OutputFixture.new expected
     end
     
     class OutputFixture < Base
+      # Called by RSpec
       def matches?(block)
         return false unless block.is_a? Proc
         @actual = stream_capturer.capture block
-
-        if actual == expected or !interactive?
-          actual == expected
-        else
-          approve_fixture
-        end
+        super
       end
 
+      # Lets RSpec know that this matcher requires a block.
       def supports_block_expectations?
         true
       end
 
+      # Adds chained matcher, to allow:
+      # expect{ stream }.to output_fixture(file).to_stdout
+      # This is the default, and only provided for completeness.
       def to_stdout
         @stream_capturer = CaptureStdout
         self
       end
 
+      # Adds chained matcher, to allow:
+      # expect{ stream }.to output_fixture(file).to_stderr
       def to_stderr
         @stream_capturer = CaptureStderr
         self

data/lib/rspec_fixtures/rspec_config.rb

@@ -1,3 +1,4 @@
+# Add our custom matchers and configuration options to RSpec
 if defined? RSpec
   RSpec.configure do |config|
     config.include RSpecFixtures::Matchers

data/lib/rspec_fixtures/stream_capturer.rb

@@ -1,4 +1,6 @@
 module RSpecFixtures
+  # Capture stdout and stderr
+  #
   # 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 CaptureStdout

data/lib/rspec_fixtures/version.rb

@@ -1,3 +1,3 @@
 module RSpecFixtures
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_fixtures
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: string-similarity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Automatic interactive fixtures for rspec
 email: db@dannyben.com
 executables: []