minitest-snapshots 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e17fe15d82b6f7622d31e0fb69cb56508001994fac052a3ad82a5ee2c41adc92
+  data.tar.gz: 8ee736f647f6efa7b7239bed17a2c8ff4cbb8e28a5da7d776f1a26b3b7f66670
+SHA512:
+  metadata.gz: f5a7aa37d3f7f297aa8705762953f0ddb105870e7869a2fd54ddff01e7cb43309a83788d58db92a6359858ed73d8222977f498751189150af791ddfecd471342
+  data.tar.gz: aecb23fcbae3e353072bcee5dca5ae4480a57a9757cb88c68544318ba8e3636ab72b0a7220cd5d1ead7b6af0722b123aff7cd5c3f029741720036b5dcd022945

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at harry.brundage@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in minitest-snapshots.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    minitest-snapshots (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest-snapshots!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Harry Brundage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Minitest::Snapshots
+
+Simple minitest plugin gem implementing Jest style snapshot testing. It's like VCR, but for any string.
+
+## Usage
+
+Instead of copying and pasting large segments of machine generated text into your test files, and updating them all the time, assert against a snapshot managed by this library. The first time the snapshot assertion is run it will write the value to disk, and then then next time, it will check against that value.
+
+Example:
+
+```ruby
+class QueryCompilerText extends Minitest::Test
+    def test_it_can_compile_a_query
+        assert_matches_snapshot QueryCompiler.new.compile
+    end
+end
+```
+
+## Command line options
+
+* `-u` or `--update-snapshots`: Update snapshots on disk to the new actual value when re-running the test. Useful when you know the new output of a test case is correct and the snapshot is out of date.
+* `-l` or `--lock-snapshots`: Prevents new snapshots from being written. Useful on CI to ensure all snapshots have been written by the developer.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-snapshots'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-snapshots
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/superpro-inc/minitest-snapshots. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Minitest::Snapshots project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/superpro-inc/minitest-snapshots/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,18 @@
+module Minitest
+  module Assertions
+    def assert_matches_snapshot(string, snapshot_name = nil)
+      snapshot_file = snapshot_path(snapshot_name || (@snapshot_assertion_counter += 1))
+
+      if !Minitest::Snapshots.force_updates && File.exist?(snapshot_file)
+        assert_equal File.read(snapshot_file), string, "The string does not match the snapshot (located at #{snapshot_file})"
+      else
+        if Minitest::Snapshots.lock_snapshots
+          assert false, "New snapshot tried to be created when snapshot writing is prevented with the --lock-snapshots option."
+        end
+        File.open(snapshot_file, "w") do |file|
+          file.write(string)
+        end
+      end
+    end
+  end
+end

data/lib/minitest/snapshots/test_extensions.rb

@@ -0,0 +1,17 @@
+module Minitest
+  module Snapshots
+    module TestExtensions
+      def before_setup
+        super
+        @snapshot_assertion_counter = 0
+        @snapshot_dir ||= Rails.root.join("test", "snapshots").to_s
+      end
+
+      private
+
+      def snapshot_path(snapshot_name)
+        File.join(@snapshot_dir, "#{name}__#{snapshot_name}.snap.txt")
+      end
+    end
+  end
+end

data/lib/minitest/snapshots/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Snapshots
+    VERSION = "0.1.0"
+  end
+end

data/lib/minitest/snapshots.rb

@@ -0,0 +1,6 @@
+module Minitest::Snapshots
+  class << self
+    attr_accessor :force_updates
+    attr_accessor :lock_snapshots
+  end
+end

data/lib/minitest/snapshots_plugin.rb

@@ -0,0 +1,20 @@
+require "minitest/snapshots/version"
+
+module Minitest
+  def self.plugin_snapshots_options(opts, options)
+    opts.on "-u", "--update-snapshots", "Update (overwrite) stored snapshots" do
+      Minitest::Snapshots.force_updates = true
+    end
+
+    opts.on "-l", "--lock-snapshots", "Prevent any snapshots from being stored" do
+      Minitest::Snapshots.lock_snapshots = true
+    end
+  end
+
+  def self.plugin_snapshots_init(options)
+    require "minitest/snapshots"
+    require "minitest/snapshots/test_extensions"
+    require "minitest/snapshots/assertion_extensions"
+    Minitest::Test.send :include, Minitest::Snapshots::TestExtensions
+  end
+end

data/minitest-snapshots.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "minitest/snapshots/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "minitest-snapshots"
+  spec.version = Minitest::Snapshots::VERSION
+  spec.authors = ["Harry Brundage"]
+  spec.email = ["harry.brundage@gmail.com"]
+
+  spec.summary = %q{Adds jest style snapshot testing asserting against long values stored on the filesystem.}
+  spec.homepage = "https://github.com/superpro-inc/minitest-snapshots"
+  spec.license = "MIT"
+
+  # 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.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: minitest-snapshots
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Brundage
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: 
+email:
+- harry.brundage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitest/snapshots.rb
+- lib/minitest/snapshots/assertion_extensions.rb
+- lib/minitest/snapshots/test_extensions.rb
+- lib/minitest/snapshots/version.rb
+- lib/minitest/snapshots_plugin.rb
+- minitest-snapshots.gemspec
+homepage: https://github.com/superpro-inc/minitest-snapshots
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Adds jest style snapshot testing asserting against long values stored on
+  the filesystem.
+test_files: []