rspec-golden-files 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1c393bc388b86d3741692619898b67ddffd186fa167a4d5caf453efe8830dd5
-  data.tar.gz: 23132b6702d2da10b1604eb1713e822543f0a3e3d4553b6396c1fe86be40cc4e
+  metadata.gz: a98878d75b0018ab0a1a8860e07fc9f5dcbffbe5cfd079e87e7afc42af82f6bc
+  data.tar.gz: 2554850a7dc5b799613fd40558949ae709d8210c14df3754571058a95431c56d
 SHA512:
-  metadata.gz: fb60190f4c79728c99d75b57d42f304015fbb3b87dc356ab1096cbec0b0bf74b45624df5af920a7890dc90548e491c5d6e42a577bee083f74b9de16f86c598a0
-  data.tar.gz: 7c679d6bf09b62be815736e9083eb35726f42c8e0febdd97543534fba32c91d555f1f71115ba4035ea38b1809ff8f8087f408f5004defee61d0b56bd79b447b6
+  metadata.gz: 4d4e6054cf62ef5cef0496f5209f1d548522bfe9f703904f8b59bf9fd08a835e20ca954ff8df47c4263230758156ab8ea3993c9135e22c6a087d6b58a556fad4
+  data.tar.gz: d976117750b9e7c5834164e15d63edb1953328191c9294e0571cb42d907083149a821ad08206dc1a9f73e0ab9f46bf0e1a72ddae5db5d4d65e0e0a6208ef162a

data/README.md

@@ -1,4 +1,4 @@
-# RSpec::Matchers::GoldenFiles
+# RSpec::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.
 

data/lib/rspec-golden-files.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'erb'
+require 'ostruct'
+
+module RSpec
+  module GoldenFiles
+    VERSION = '0.1.1'.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

data/rspec-golden-files.gemspec

@@ -1,11 +1,11 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require_relative 'lib/golden_files.rb'
+require 'rspec-golden-files'
 
 Gem::Specification.new do |spec|
   spec.name          = "rspec-golden-files"
-  spec.version       = RSpec::Matchers::GoldenFiles::VERSION
+  spec.version       = RSpec::GoldenFiles::VERSION
   spec.authors       = ["Anton Antonov"]
   spec.email         = ["anton.synd.antonov@gmail.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-golden-files
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Anton Antonov
@@ -64,7 +64,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- lib/golden_files.rb
+- lib/rspec-golden-files.rb
 - rspec-golden-files.gemspec
 homepage: https://github.com/syndbg/rspec-golden-files
 licenses:

data/lib/golden_files.rb

@@ -1,124 +0,0 @@
-# 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