rspec-golden-files 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1c393bc388b86d3741692619898b67ddffd186fa167a4d5caf453efe8830dd5
+  data.tar.gz: 23132b6702d2da10b1604eb1713e822543f0a3e3d4553b6396c1fe86be40cc4e
+SHA512:
+  metadata.gz: fb60190f4c79728c99d75b57d42f304015fbb3b87dc356ab1096cbec0b0bf74b45624df5af920a7890dc90548e491c5d6e42a577bee083f74b9de16f86c598a0
+  data.tar.gz: 7c679d6bf09b62be815736e9083eb35726f42c8e0febdd97543534fba32c91d555f1f71115ba4035ea38b1809ff8f8087f408f5004defee61d0b56bd79b447b6

data/.gitignore

@@ -0,0 +1,51 @@
+.idea
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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 rspec-golden-files.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Anton Antonov
+
+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,39 @@
+# RSpec::Matchers::GoldenFiles
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/golden/files`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-golden-files'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-golden-files
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/rspec-golden-files.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/golden_files.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'erb'
+require 'ostruct'
+
+module RSpec
+  module Matchers
+    module GoldenFiles
+      VERSION = '0.1.0'.freeze
+
+      class SimpleFileReader
+        def initialize(filename)
+          @filename = filename
+          @file_contents = File.read(@filename)
+        end
+
+        def filename
+          @filename
+        end
+
+        def expected_value
+          @file_contents
+        end
+
+        def close; end
+      end
+
+      class ErbFileReader < SimpleFileReader
+        # HACK: Make hash keys usable in templates
+        # due to ERB's poor `#result_with_hash` usefulness.
+        class TemplateStruct < OpenStruct
+          def render(template)
+            template.result(binding)
+          end
+        end
+
+        def initialize(filename, template_vars)
+          plain_file_contents = File.read(filename)
+          template = ERB.new(plain_file_contents)
+          template_struct = TemplateStruct.new(template_vars)
+
+          @file_contents = template_struct.render(template)
+
+          @tmpfile = Tempfile.new('expected')
+          @tmpfile.write(@file_contents)
+          @tmpfile.close(false)
+
+          @filename = @tmpfile.path
+        end
+
+        def close
+          @tmpfile.delete
+        end
+      end
+
+      class GoldenFilesMatcher
+        def initialize(filename, file_reader_type, template_vars)
+          @filename = filename
+          @file_reader_type = file_reader_type
+          @template_vars = template_vars
+        end
+
+        def matches?(value)
+          unless File.exist?(@filename)
+            raise ArgumentError "golden file '#{@filename}' not found"
+          end
+
+          @value = value
+
+          actual_tmpfile = Tempfile.new('actual')
+          actual_tmpfile.write(value.to_s)
+          actual_tmpfile.close(false)
+
+          file_reader = case @file_reader_type.to_sym
+                        when :simple
+                          SimpleFileReader.new(@filename)
+                        when :erb
+                          ErbFileReader.new(@filename, @template_vars)
+                        else
+                          raise ArgumentError "unknown file reader type #{@file_reader_type}. `simple` and `erb` are supported"
+                        end
+
+          @expected_value = file_reader.expected_value
+          system("diff #{actual_tmpfile.path} #{file_reader.filename} > /dev/null")
+          is_successful = $CHILD_STATUS.to_i.zero?
+
+          file_reader.close
+          actual_tmpfile.delete
+
+          is_successful
+        end
+
+        def actual
+          @value
+        end
+
+        def expected
+          @expected_value
+        end
+
+        def description
+          "be matching golden file with name #{@filename}"
+        end
+
+        def diffable?
+          true
+        end
+
+        def failure_message
+          "expected #{@value.inspect} does not match golden file '#{@filename}'"
+        end
+
+        def failure_message_when_negated
+          "expected #{@value.inspect} matches golden file '#{@filename}'"
+        end
+      end
+    end
+
+    def match_golden_file(filename, file_reader_type: 'simple', template_vars: {})
+      RSpec::Matchers::GoldenFiles::GoldenFilesMatcher.new(filename, file_reader_type, template_vars)
+    end
+  end
+end

data/rspec-golden-files.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/golden_files.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-golden-files"
+  spec.version       = RSpec::Matchers::GoldenFiles::VERSION
+  spec.authors       = ["Anton Antonov"]
+  spec.email         = ["anton.synd.antonov@gmail.com"]
+
+  spec.summary       = 'rspec matcher for golden files'
+  spec.description   = 'rspec matcher for golden files'
+  spec.homepage      = 'https://github.com/syndbg/rspec-golden-files'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rspec-golden-files
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Antonov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-18 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'
+- !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'
+description: rspec matcher for golden files
+email:
+- anton.synd.antonov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- lib/golden_files.rb
+- rspec-golden-files.gemspec
+homepage: https://github.com/syndbg/rspec-golden-files
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/syndbg/rspec-golden-files
+  source_code_uri: https://github.com/syndbg/rspec-golden-files
+  changelog_uri: https://github.com/syndbg/rspec-golden-files
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: rspec matcher for golden files
+test_files: []