snapshot_testing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9eceaf595a2736c2f1f8a0600c2ec583de320dd972d248256a11a981c52b3580
+  data.tar.gz: eeefbc3eaa2c80e65b87d4af75943385ef7421b9f890c921fcdb61fffb3530de
+SHA512:
+  metadata.gz: 374a7c9ac3da75ce4a81a9d72eeefd2c87cfe72db678860a0b74d944a3fc0a027ee83203322086a25e8abea6e4a3b512e74426a98a10f2320597d8444fe771ec
+  data.tar.gz: 23a778788ae7d2bd6165702dc3a34fc66831f974d958c6101e5f3f9fbb1468c3088be709d6ea0a5461772433617c992bb2c677f05a6550214137775a7c91a346

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snapshot_testing.gemspec
+gemspec
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    snapshot_testing (0.1.0)
+      pastel (~> 0.7.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    equatable (0.6.1)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    power_assert (1.1.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    test-unit (3.2.9)
+      power_assert
+    tty-color (0.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.11.3)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.17.0)
+  snapshot_testing!
+  test-unit (~> 3.2.9)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,123 @@
+# :camera: Snapshot Testing
+
+Snapshot testing for all Ruby test frameworks.
+
+### Features
+
+- Human-readable snapshots
+- Supports RSpec, Minitest, and Test::Unit
+- Custom serializers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snapshot_testing'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The examples below will show you how to use `snapshot_testing` in each testing framework.
+
+On the first test run, a [`.snap` file](examples/__snapshots__/rspec.rb.snap) will be created. The contents of the `.snap` file will be compared to the value under test on subsequent test runs.
+
+If the value in the snapshot is not equal to the value under test, the test will fail. You can update the snapshots by rerunning the test suite by setting `UPDATE_SNAPSHOTS=1` in the environment.
+
+### RSpec
+
+Configure `snapshot_testing` in your `spec_helper.rb`:
+
+```ruby
+require 'snapshot_testing/rspec'
+
+RSpec.configure do |config|
+  config.include SnapshotTesting::RSpec
+end
+```
+
+Now, you can take snapshots:
+
+```ruby
+RSpec.describe "Example" do
+  it "takes a snapshot" do
+    expect("hello").to match_snapshot
+    expect("goodbye").to match_snapshot
+  end
+end
+```
+
+### Minitest
+
+```ruby
+require 'minitest/autorun'
+require 'snapshot_testing/minitest'
+
+class ExampleTest < Minitest::Test
+  include SnapshotTesting::Minitest
+
+  def test_takes_a_snapshot
+    assert_snapshot "hello"
+    assert_snapshot "goodbye"
+  end
+end
+
+class ExampleSpec < Minitest::Spec
+  include SnapshotTesting::Minitest
+
+  it "takes a snapshot" do
+    "hello".must_match_snapshot
+    "goodbye".must_match_snapshot
+  end
+end
+```
+
+### Test::Unit
+
+```ruby
+require 'test/unit'
+require 'snapshot_testing/test_unit'
+
+class ExampleTest < Test::Unit::TestCase
+  include SnapshotTesting::TestUnit
+
+  def test_snapshot
+    assert_snapshot "hello"
+    assert_snapshot "goodbye"
+  end
+end
+```
+
+## Custom Serializers
+
+Sometimes, you might want to define how objects get serialized as a snapshot. For example, you could define a custom serializer to convert an object to YAML.
+
+```ruby
+class PersonSerializer
+  def accepts?(object)
+    object.is_a? Person
+  end
+
+  def dump(object)
+    YAML.dump(object)
+  end
+end
+
+SnapshotTesting::Snapshot.use PersonSerializer.new
+```
+
+Now, in your test, you can take snapshots of `Person` objects:
+
+```ruby
+it "serializes a person" do
+  expect(Person.new).to match_snapshot
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/snapshot_testing.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :examples do
+  ruby 'examples/minitest.rb'
+  ruby 'examples/test_unit.rb'
+  ruby 'examples/rspec.rb'
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snapshot_testing"
+
+# 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/examples/__snapshots__/minitest.rb.snap

@@ -0,0 +1,15 @@
+snapshots["test_0001_takes a snapshot 1"] = <<~SNAP
+hello
+SNAP
+
+snapshots["test_0001_takes a snapshot 2"] = <<~SNAP
+goodbye
+SNAP
+
+snapshots["test_snapshot 1"] = <<~SNAP
+hello
+SNAP
+
+snapshots["test_snapshot 2"] = <<~SNAP
+goodbye
+SNAP

data/examples/__snapshots__/rspec.rb.snap

@@ -0,0 +1,7 @@
+snapshots["takes a snapshot 1"] = <<~SNAP
+hello
+SNAP
+
+snapshots["takes a snapshot 2"] = <<~SNAP
+goodbye
+SNAP

data/examples/__snapshots__/test_unit.rb.snap

@@ -0,0 +1,7 @@
+snapshots["test_snapshot 1"] = <<~SNAP
+hello
+SNAP
+
+snapshots["test_snapshot 2"] = <<~SNAP
+goodbye
+SNAP

data/examples/minitest.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "snapshot_testing/minitest"
+
+class ExampleTest < Minitest::Test
+  include SnapshotTesting::Minitest
+
+  def test_snapshot
+    assert_snapshot "hello"
+    assert_snapshot "goodbye"
+  end
+end
+
+class ExampleSpec < Minitest::Spec
+  include SnapshotTesting::Minitest
+
+  it "takes a snapshot" do
+    "hello".must_match_snapshot
+    "goodbye".must_match_snapshot
+  end
+end

data/examples/rspec.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "rspec/autorun"
+require "snapshot_testing/rspec"
+
+RSpec.configure do |config|
+  config.include SnapshotTesting::RSpec
+end
+
+RSpec.describe "Example" do
+  it "takes a snapshot" do
+    expect("hello").to match_snapshot
+    expect("goodbye").to match_snapshot
+  end
+end

data/examples/test_unit.rb

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require "test/unit"
+require "snapshot_testing/test_unit"
+
+class ExampleTest < Test::Unit::TestCase
+  include SnapshotTesting::TestUnit
+
+  def test_snapshot
+    assert_snapshot "hello"
+    assert_snapshot "goodbye"
+  end
+end

data/lib/snapshot_testing.rb

@@ -0,0 +1,6 @@
+require "snapshot_testing/version"
+require "snapshot_testing/snapshot"
+require "snapshot_testing/recorder"
+
+module SnapshotTesting
+end

data/lib/snapshot_testing/minitest.rb

@@ -0,0 +1,29 @@
+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?
+      )
+      super
+    end
+
+    def after_teardown
+      super
+      @__snapshot_recorder__.commit
+    end
+
+    def assert_snapshot(actual)
+      assert_equal(@__snapshot_recorder__.record(actual), actual)
+    end
+  end
+end

data/lib/snapshot_testing/recorder.rb

@@ -0,0 +1,76 @@
+require "fileutils"
+require "pastel"
+
+module SnapshotTesting
+  class Recorder
+    def initialize(name:, path:, update:)
+      @name   = name
+      @path   = path
+      @update = update
+      @state  = {}
+    end
+
+    def snapshot_dir
+      File.join(File.dirname(@path), "__snapshots__")
+    end
+
+    def snapshot_file
+      File.join(snapshot_dir, "#{File.basename(@path)}.snap")
+    end
+
+    def snapshots
+      @snapshots ||= begin
+        Snapshot.load_file(snapshot_file)
+      rescue Errno::ENOENT
+        {}
+      end
+    end
+
+    def record(actual)
+      key = "#{@name} #{@state.length + 1}"
+
+      # keep track each encounter, so we can diff later
+      @state[key] = actual
+
+      # pass the test when updating snapshots
+      return actual if @update
+
+      # pass the test when the snapshot does not exist
+      return actual unless snapshots.key?(key)
+
+      # 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
+
+      result = snapshots.merge(added)
+      result = result.merge(changed) if @update
+      result = result.reject { |k, _| removed.include?(k) } if @update
+
+      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
+
+    private
+
+    def log(count, status, color)
+      label = count == 1 ? "snapshot" : "snapshots"
+      message = "#{count} #{label} #{status}."
+      warn Pastel.new.public_send(color, message)
+    end
+
+    def write(snapshots)
+      FileUtils.mkdir_p(snapshot_dir)
+      File.write(snapshot_file, Snapshot.dump(snapshots))
+    end
+  end
+end

data/lib/snapshot_testing/rspec.rb

@@ -0,0 +1,51 @@
+require "snapshot_testing"
+
+module SnapshotTesting
+  module RSpec
+    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?
+        )
+      end
+
+      base.after :each do
+        __snapshot_recorder__.commit
+      end
+    end
+
+    def match_snapshot
+      SnapshotTesting::RSpec::MatchSnapshot.new(recorder: __snapshot_recorder__)
+    end
+
+    class MatchSnapshot
+      attr_reader :expected, :actual
+
+      def initialize(recorder:)
+        @recorder = recorder
+      end
+
+      def matches?(actual)
+        @actual = actual
+        @expected = @recorder.record(@actual)
+        @actual == @expected
+      end
+
+      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"
+      end
+
+      def diffable?
+        true
+      end
+
+      def supports_block_expectations?
+        false
+      end
+    end
+  end
+end

data/lib/snapshot_testing/serializer.rb

@@ -0,0 +1,11 @@
+module SnapshotTesting
+  class Serializer
+    def accepts?(value)
+      true
+    end
+
+    def dump(value)
+      value.to_s
+    end
+  end
+end

data/lib/snapshot_testing/snapshot.rb

@@ -0,0 +1,34 @@
+require "pathname"
+require "snapshot_testing/serializer"
+
+module SnapshotTesting
+  module Snapshot
+    TEMPLATE = "snapshots[%s] = <<~SNAP\n%s\nSNAP\n".freeze
+
+    @@serializers = [SnapshotTesting::Serializer.new]
+
+    def self.use(serializer)
+      @@serializers.unshift(serializer)
+    end
+
+    def self.load_file(file)
+      load File.read(file)
+    end
+
+    def self.load(input)
+      snapshots = {}
+      eval(input)
+      snapshots.transform_values(&:chomp)
+    end
+
+    def self.dump(values)
+      entries = values.map do |name, value|
+        serializer = @@serializers.find { |s| s.accepts?(value) }
+        snapshot = serializer.dump(value)
+        format(TEMPLATE, name.inspect, snapshot)
+      end
+
+      entries.join("\n")
+    end
+  end
+end

data/lib/snapshot_testing/test_unit.rb

@@ -0,0 +1,23 @@
+require "snapshot_testing"
+
+module SnapshotTesting
+  module TestUnit
+    def setup
+      @__snapshot_recorder__ = SnapshotTesting::Recorder.new(
+        name: method_name,
+        path: method(method_name).source_location.first,
+        update: !ENV['UPDATE_SNAPSHOTS'].nil?
+      )
+      super
+    end
+
+    def teardown
+      super
+      @__snapshot_recorder__.commit
+    end
+
+    def assert_snapshot(actual)
+      assert_equal(@__snapshot_recorder__.record(actual), actual)
+    end
+  end
+end

data/lib/snapshot_testing/version.rb

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

data/snapshot_testing.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "snapshot_testing/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "snapshot_testing"
+  spec.version       = SnapshotTesting::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["raymondzane@gmail.com"]
+
+  spec.summary       = %q{Proper snapshot support for RSpec.}
+  spec.description   = %q{Create snapshots of your data for simpler testing.}
+  spec.homepage      = "https://github.com/rzane/snapshot_testing"
+
+  # 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"]
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_dependency "pastel", "~> 0.7.3"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "minitest", "~> 5.11.3"
+  spec.add_development_dependency "test-unit", "~> 3.2.9"
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: snapshot_testing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: Create snapshots of your data for simpler testing.
+email:
+- raymondzane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/__snapshots__/minitest.rb.snap
+- examples/__snapshots__/rspec.rb.snap
+- examples/__snapshots__/test_unit.rb.snap
+- examples/minitest.rb
+- examples/rspec.rb
+- examples/test_unit.rb
+- lib/snapshot_testing.rb
+- lib/snapshot_testing/minitest.rb
+- lib/snapshot_testing/recorder.rb
+- lib/snapshot_testing/rspec.rb
+- lib/snapshot_testing/serializer.rb
+- lib/snapshot_testing/snapshot.rb
+- lib/snapshot_testing/test_unit.rb
+- lib/snapshot_testing/version.rb
+- snapshot_testing.gemspec
+homepage: https://github.com/rzane/snapshot_testing
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Proper snapshot support for RSpec.
+test_files: []