snapshot_testing 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa10b4d611599255fcbb0ddfea02d05c400c951a
-  data.tar.gz: d794383a14439bbcaaec7fa4be0016563ba4090d
+  metadata.gz: a09c878dab9b37cfb19478f2647d404fc1091840
+  data.tar.gz: 83d05b1d4a199a08f44e0c4a3d5a01b3e07f9754
 SHA512:
-  metadata.gz: a74f16d1f1a897d94aa2bf67308d6e693ba464348e711ac176511c6870836698bd1a4c7bc17d277dcf79084fb4c8addd8f4be213018d0b426b92b3661364ae6b
-  data.tar.gz: 6e96bc7657a8bdcc29746dc87fdb29232aecc7d94843c5af02175ae10290121f04cedcf492801f1c38ff3af51d577dea4f3cb1a8a585b8d026df81587b530b43
+  metadata.gz: 3d630db5ee68d5dcb9df88b29f6991eacbdee0f150c03282f6e6121eb434bf9476985111e71438e5b8ae8d66af1c29d12d50078f6fd18b558ecd3bf77281ed0a
+  data.tar.gz: 44402a6591987118f01cdc357e5b089625a0406850da4e8e2e16c8134a7571102d02f3594dc3d0212dc423115abf20b3b0a3e54acd8ee270e705904e66a8976a

data/.travis.yml

@@ -5,3 +5,7 @@ cache: bundler
 rvm:
   - 2.6.3
 before_install: gem install bundler -v 2.0.2
+
+script:
+  - bundle exec rspec
+  - bundle exec rake examples

data/Gemfile

@@ -2,4 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in snapshot_testing.gemspec
 gemspec
-gem 'pry'

data/README.md

@@ -47,6 +47,7 @@ RSpec.describe "Example" do
   it "takes a snapshot" do
     expect("hello").to match_snapshot
     expect("goodbye").to match_snapshot
+    expect("hello").to match_snapshot("hello.txt")
   end
 end
 ```
@@ -63,6 +64,7 @@ class ExampleTest < Minitest::Test
   def test_takes_a_snapshot
     assert_snapshot "hello"
     assert_snapshot "goodbye"
+    assert_snapshot "hello.txt", "hello"
   end
 end
 
@@ -70,8 +72,9 @@ class ExampleSpec < Minitest::Spec
   include SnapshotTesting::Minitest
 
   it "takes a snapshot" do
-    "hello".must_match_snapshot
-    "goodbye".must_match_snapshot
+    _("hello").must_match_snapshot
+    _("goodbye").must_match_snapshot
+    _("hello").must_match_snapshot "hello.txt"
   end
 end
 ```
@@ -88,6 +91,7 @@ class ExampleTest < Test::Unit::TestCase
   def test_snapshot
     assert_snapshot "hello"
     assert_snapshot "goodbye"
+    assert_snapshot "hello.txt", "hello"
   end
 end
 ```

data/Rakefile

@@ -3,10 +3,19 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
+def info(message)
+  puts "\033[1m#{message}\033[0m"
+end
+
 task :examples do
-  ruby 'examples/minitest.rb'
-  ruby 'examples/test_unit.rb'
-  ruby 'examples/rspec.rb'
+  info "==>> Running RSpec..."
+  ruby "examples/rspec.rb -f progress"
+
+  info "\n\n==>> Running Minitest..."
+  ruby "examples/minitest.rb"
+
+  info "\n\n==>> Running TestUnit..."
+  ruby "examples/test_unit.rb"
 end
 
 task :default => :spec

data/examples/__snapshots__/named.minitest.spec.txt

@@ -0,0 +1 @@
+named

data/examples/__snapshots__/named.minitest.test.txt

@@ -0,0 +1 @@
+named

data/examples/__snapshots__/named.rspec.txt

@@ -0,0 +1 @@
+named

data/examples/__snapshots__/named.unit.txt

@@ -0,0 +1 @@
+named

data/examples/minitest.rb

@@ -9,13 +9,21 @@ class ExampleTest < Minitest::Test
     assert_snapshot "hello"
     assert_snapshot "goodbye"
   end
+
+  def test_named_snapshot
+    assert_snapshot "named.minitest.test.txt", "named"
+  end
 end
 
 class ExampleSpec < Minitest::Spec
   include SnapshotTesting::Minitest
 
   it "takes a snapshot" do
-    "hello".must_match_snapshot
-    "goodbye".must_match_snapshot
+    _("hello").must_match_snapshot
+    _("goodbye").must_match_snapshot
+  end
+
+  it "takes a named snapshot" do
+    _("named").must_match_snapshot "named.minitest.spec.txt"
   end
 end

data/examples/rspec.rb

@@ -11,4 +11,8 @@ RSpec.describe "Example" do
     expect("hello").to match_snapshot
     expect("goodbye").to match_snapshot
   end
+
+  it "takes a named snapshot" do
+    expect("named").to match_snapshot("named.rspec.txt")
+  end
 end

data/examples/test_unit.rb

@@ -9,4 +9,8 @@ class ExampleTest < Test::Unit::TestCase
     assert_snapshot "hello"
     assert_snapshot "goodbye"
   end
+
+  def test_named_snapshot
+    assert_snapshot "named.unit.txt", "named"
+  end
 end

data/lib/snapshot_testing.rb

@@ -3,4 +3,7 @@ require "snapshot_testing/snapshot"
 require "snapshot_testing/recorder"
 
 module SnapshotTesting
+  def self.update?
+    !ENV["UPDATE_SNAPSHOTS"].nil?
+  end
 end

data/lib/snapshot_testing/minitest.rb

@@ -2,17 +2,10 @@ require "snapshot_testing"
 
 module SnapshotTesting
   module Minitest
-    def self.included(_)
-      return unless defined?(::Minitest::Expectations)
-      return if ::Minitest::Expectations.method_defined?(:must_match_snapshot)
-      ::Minitest::Expectations.infect_an_assertion(:assert_snapshot, :must_match_snapshot, true)
-    end
-
     def before_setup
       @__snapshot_recorder__ = SnapshotTesting::Recorder.new(
         name: name,
-        path: method(name).source_location.first,
-        update: !ENV['UPDATE_SNAPSHOTS'].nil?
+        path: method(name).source_location.first
       )
       super
     end
@@ -22,8 +15,16 @@ module SnapshotTesting
       @__snapshot_recorder__.commit
     end
 
-    def assert_snapshot(actual)
-      assert_equal(@__snapshot_recorder__.record(actual), actual)
+    def assert_snapshot(name = nil, actual)
+      if name.nil?
+        assert_equal(@__snapshot_recorder__.record(actual), actual)
+      else
+        assert_equal(@__snapshot_recorder__.record_file(name, actual), actual)
+      end
+    end
+
+    if respond_to? :infect_an_assertion
+      infect_an_assertion :assert_snapshot, :must_match_snapshot
     end
   end
 end

data/lib/snapshot_testing/recorder.rb

@@ -2,80 +2,125 @@ require "fileutils"
 
 module SnapshotTesting
   class Recorder
-    def initialize(name:, path:, update:)
+    def initialize(name:, path:, update: SnapshotTesting.update?)
       @name   = name
       @path   = path
       @update = update
-      @state  = {}
+      @visited = []
+      @added = 0
+      @updated = 0
     end
 
-    def snapshot_dir
-      File.join(File.dirname(@path), "__snapshots__")
-    end
-
-    def snapshot_file
-      File.join(snapshot_dir, "#{File.basename(@path)}.snap")
+    def snapshot_path
+      File.join(snapshots_path, "#{File.basename(path)}.snap")
     end
 
     def snapshots
       @snapshots ||= begin
-        Snapshot.load_file(snapshot_file)
+        Snapshot.load_file(snapshot_path)
       rescue Errno::ENOENT
         {}
       end
     end
 
+    def record_file(name, actual)
+      expected = begin
+        read(name)
+      rescue Errno::ENOENT
+        write(name, actual)
+        log(1, :written)
+        actual
+      end
+
+      if update? && actual != expected
+        write(name, actual)
+        log(1, :updated)
+        actual
+      else
+        expected
+      end
+    end
+
     def record(actual)
-      key = "#{@name} #{@state.length + 1}"
+      key = "#{name} #{visited.length + 1}"
 
-      # keep track each encounter, so we can diff later
-      @state[key] = actual
+      self.visited << key
 
-      # pass the test when updating snapshots
-      return actual if @update
+      unless snapshots.key?(key)
+        self.added += 1
+        self.snapshots[key] = actual
+      end
 
-      # pass the test when the snapshot does not exist
-      return actual unless snapshots.key?(key)
+      if update? && actual != snapshots[key]
+        self.updated += 1
+        self.snapshots[key] = actual
+      end
 
-      # otherwise, compare actual to the snapshot
       snapshots[key]
     end
 
     def commit
-      added   = @state.select { |k, _| !snapshots.key?(k) }
-      changed = @state.select { |k, v| snapshots.key?(k) && snapshots[k] != v }
-      removed = snapshots.keys.select do |k|
-        k.match?(/^#{@name}\s\d+$/) && !@state.key?(k)
-      end
+      removed = snapshots.keys - visited
+      removed = removed.grep(/^#{name}\s\d+$/)
+      removed.each { |key| snapshots.delete(key) }
+
+      write_snapshots(snapshots) if write?
+      log(added, :written) unless added.zero?
+      log(updated, :updated) unless updated.zero?
+      log(removed.length, :removed) if update? && !removed.empty?
+      log(removed.length, :obsolete) if !update? && !removed.empty?
+    end
 
-      result = snapshots.merge(added)
-      result = result.merge(changed) if @update
-      result = result.reject { |k, _| removed.include?(k) } if @update
+    protected
 
-      write(result) if result != snapshots
-      log(added.length, :written, :green) if added.any?
-      log(changed.length, :updated, :green) if @update && changed.any?
-      log(removed.length, :removed, :green) if @update && removed.any?
-      log(removed.length, :obsolete, :yellow) if !@update && removed.any?
-    end
+    # the number of added snapshots
+    attr_accessor :added
+
+    # the number of updated snapshots
+    attr_accessor :updated
+
+    # all snapshots that have been compared
+    attr_reader :visited
 
     private
 
-    def log(count, status, color)
+    # the name of the current test
+    attr_reader :name
+
+    # the file location of the current test
+    attr_reader :path
+
+    # should we update failing snapshots?
+    def update?
+      @update
+    end
+
+    # should we write to the filesystem?
+    def write?
+      update? || !added.zero?
+    end
+
+    def snapshots_path
+      File.join(File.dirname(path), "__snapshots__")
+    end
+
+    def log(count, status)
       label = count == 1 ? "snapshot" : "snapshots"
-      message = "#{count} #{label} #{status}."
+      warn "\e[33m#{count} #{label} #{status}\e[0m"
+    end
 
-      case color
-      when :yellow
-        warn "\e[33m#{message}\e[0m"
-      when :green
-        warn "\e[32m#{message}\e[0m"
-      end
+    def read(name)
+      File.read(File.join(snapshots_path, name))
+    end
+
+    def write(name, data)
+      FileUtils.mkdir_p(snapshots_path)
+      File.write(File.join(snapshots_path, name), data)
     end
 
-    def write(snapshots)
-      FileUtils.mkdir_p(snapshot_dir)
-      File.write(snapshot_file, Snapshot.dump(snapshots))
+    def write_snapshots(snapshots)
+      FileUtils.mkdir_p(snapshots_path)
+      File.write(snapshot_path, Snapshot.dump(snapshots))
     end
   end
 end

data/lib/snapshot_testing/rspec.rb

@@ -2,12 +2,13 @@ require "snapshot_testing"
 
 module SnapshotTesting
   module RSpec
+    extend ::RSpec::Matchers::DSL
+
     def self.included(base)
       base.let :__snapshot_recorder__ do |example|
         SnapshotTesting::Recorder.new(
           name: example.description,
-          path: example.metadata[:absolute_file_path],
-          update: !ENV['UPDATE_SNAPSHOTS'].nil?
+          path: example.metadata[:absolute_file_path]
         )
       end
 
@@ -16,35 +17,30 @@ module SnapshotTesting
       end
     end
 
-    def match_snapshot
-      SnapshotTesting::RSpec::MatchSnapshot.new(recorder: __snapshot_recorder__)
-    end
-
-    class MatchSnapshot
-      attr_reader :expected, :actual
+    matcher :match_snapshot do |name|
+      match do |actual|
+        @expected = if name.nil?
+          __snapshot_recorder__.record(actual)
+        else
+          __snapshot_recorder__.record_file(name, actual)
+        end
 
-      def initialize(recorder:)
-        @recorder = recorder
+        @expected == actual
       end
 
-      def matches?(actual)
-        @actual = actual
-        @expected = @recorder.record(@actual)
-        @actual == @expected
-      end
+      diffable
+      description { "match snapshot #{expected_formatted}"}
 
-      def failure_message
-        expected = ::RSpec::Support::ObjectFormatter.format(@expected)
-        actual = ::RSpec::Support::ObjectFormatter.format(@actual)
-        "\nexpected: #{expected}\n     got: #{actual}\n\n(compared using ==)\n"
+      failure_message do |actual|
+        "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using ==)\n"
       end
 
-      def diffable?
-        true
+      def expected_formatted
+        ::RSpec::Support::ObjectFormatter.format(@expected)
       end
 
-      def supports_block_expectations?
-        false
+      def actual_formatted
+        ::RSpec::Support::ObjectFormatter.format(@actual)
       end
     end
   end

data/lib/snapshot_testing/test_unit.rb

@@ -5,8 +5,7 @@ module SnapshotTesting
     def setup
       @__snapshot_recorder__ = SnapshotTesting::Recorder.new(
         name: method_name,
-        path: method(method_name).source_location.first,
-        update: !ENV['UPDATE_SNAPSHOTS'].nil?
+        path: method(method_name).source_location.first
       )
       super
     end
@@ -16,8 +15,12 @@ module SnapshotTesting
       @__snapshot_recorder__.commit
     end
 
-    def assert_snapshot(actual)
-      assert_equal(@__snapshot_recorder__.record(actual), actual)
+    def assert_snapshot(name = nil, actual)
+      if name.nil?
+        assert_equal(@__snapshot_recorder__.record(actual), actual)
+      else
+        assert_equal(@__snapshot_recorder__.record_file(name, actual), actual)
+      end
     end
   end
 end

data/lib/snapshot_testing/version.rb

@@ -1,3 +1,3 @@
 module SnapshotTesting
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot_testing
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Ray Zane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-22 00:00:00.000000000 Z
+date: 2019-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,10 @@ files:
 - bin/console
 - bin/setup
 - examples/__snapshots__/minitest.rb.snap
+- examples/__snapshots__/named.minitest.spec.txt
+- examples/__snapshots__/named.minitest.test.txt
+- examples/__snapshots__/named.rspec.txt
+- examples/__snapshots__/named.unit.txt
 - examples/__snapshots__/rspec.rb.snap
 - examples/__snapshots__/test_unit.rb.snap
 - examples/minitest.rb