simple_approvals-rspec 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a51d82a022a6e84e8aaf9ff114cea20d3c514aa
-  data.tar.gz: 73ee8e2d6c0470bbda063095cd59d69446688425
+  metadata.gz: 814f75f6418ca6f93bcb761ef3e3ad6589c5584a
+  data.tar.gz: a7d45f22b4751d8afd90ace0623d0cb897282c59
 SHA512:
-  metadata.gz: 360e703a519796166e7c817bb0fee99e192d0fd698a32699888dcffeb66709604a5daaf9902fafcb629446b0021e401e97c7c44f532780a70395988e91801555
-  data.tar.gz: 9ac38624579b13149acbfe87f9210344ef18380764d54d0969197c91ba2d9a53dbe50ab5ada381cda7158dc66a21a954f0e32a71dc3056d1bc93c4cd77f2de31
+  metadata.gz: cf1e5b00dd26c840d45d495ce0da9bffbda755c5ad3ab5798fde864a4dbf1482014bf7350852237a95f594ee1073d7019a29206fc45de03d5534f464cc5661ce
+  data.tar.gz: da4e6c6e613f3501382dc853f121e84771118ba7f0ec74cfd84c9c4fc27d9776155023bcc532e7401fa790b197e5703ba29a9eb6a4b11cc7a920a2814bf7179c

data/lib/simple_approvals/rspec.rb

@@ -0,0 +1,2 @@
+require 'simple_approvals/rspec/approvals'
+require 'simple_approvals/rspec/matchers'

data/lib/simple_approvals/rspec/approvals.rb

@@ -0,0 +1,68 @@
+# Top-level class to provide approval test support (inspired by http://approvaltests.com/)
+class Approvals
+  class << self
+    def verify(rendered_content, approved_path, **options)
+      scrubbed_content = apply_optional_scrubber(rendered_content, options)
+      pre_approve_if_asked(approved_path, scrubbed_content, options)
+
+      expected_content = load_expected_content(approved_path, **options)
+      received_path = received_path_for approved_path
+
+      if scrubbed_content.strip.empty?
+        raise_verify_error_with_diff(approved_path, received_path, scrubbed_content, **options) unless options[:allow_empty]
+      elsif scrubbed_content.strip == expected_content.strip
+        handle_match(received_path, scrubbed_content, **options)
+      else
+        raise_verify_error_with_diff(approved_path, received_path, scrubbed_content, **options)
+      end
+    end
+
+    private
+
+    def apply_optional_scrubber(content, **options)
+      if options.key?(:scrubber) && options[:scrubber]
+        options[:scrubber].call(content)
+      else
+        content
+      end
+    end
+
+    def pre_approve_if_asked(approved_path, scrubbed_content, **options)
+      File.write(approved_path, scrubbed_content) if options[:approve_all] || options[:accept_all]
+    end
+
+    def handle_match(received_path, received_content, **options)
+      if options[:keep_received_file] == true
+        File.write(received_path, received_content)
+      elsif File.file?(received_path)
+        File.delete received_path
+      end
+    end
+
+    def received_path_for(approved_path)
+      "#{approved_path}.received"
+    end
+
+    def load_expected_content(approved_path, **options)
+      if File.file? approved_path
+        File.read(approved_path)
+      else
+        File.open(approved_path, 'w') { |f| f.write('') } if options[:create_if_missing]
+        ''
+      end
+    end
+
+    def raise_verify_error_with_diff(approved_path, received_path, received_content, **options)
+      File.write(received_path, received_content)
+
+      # and generate a diff for the console
+      message = options[:message_override] || %(Approval failed to match "#{approved_path}")
+      message << "\n"
+      message << %(- writing received content to: "#{received_path}")
+      message << "\n"
+
+      expected_content = load_expected_content(approved_path)
+      ::RSpec::Expectations.fail_with message, expected_content, received_content
+    end
+  end
+end

data/lib/simple_approvals/rspec/matchers.rb

@@ -0,0 +1,9 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :match_hash do |expected|
+  match do |actual|
+    expect(JSON.pretty_generate(actual).strip).to eq(JSON.pretty_generate(expected).strip)
+  end
+
+  diffable
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_approvals-rspec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - David Alpert
@@ -115,13 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rubocop.yml"
-- Gemfile
 - README.md
-- VERSION
-- rakefile.rb
+- lib/simple_approvals/rspec.rb
+- lib/simple_approvals/rspec/approvals.rb
+- lib/simple_approvals/rspec/matchers.rb
 homepage: https://github.com/davidalpert/simple_approvals-rspec/
 licenses: []
 metadata: {}

data/.editorconfig

@@ -1,15 +0,0 @@
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[*.rb]
-indent_style = space
-indent_size = 2
-
-[*.json]
-indent_style = space
-indent_size = 2

data/.gitignore

@@ -1,29 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.idea/*
-*.swp
-*Gemfile.lock
-.DS_Store
-.gradle/
-archive*
-build/*
-*.pyc
-node_modules/
-rubocop.html
-tags
-.fingerprint
-LOGFILE_*

data/.rubocop.yml

@@ -1,33 +0,0 @@
-# encoding: utf-8
-AllCops:
-  Exclude:
-    - 'vendor/**/*'
-    - 'spec/fixtures/**/*'
-    - 'spec/spec_helper.rb'
-    - 'rakefile.rb'
-    # - 'simple_approvals.gemspec'
-    # - 'Gemfile'
-    # - 'example/rakefile.rb'
-    # - 'example/Gemfile'
-    # - 'example/**/*'
-    # - 'spec/**/*'
-Style/Encoding:
-  Enabled: true
-
-SignalException:
-  EnforcedStyle: only_raise
-
-CaseIndentation:
-  EnforcedStyle: end
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Max: 6

data/Gemfile

@@ -1,2 +0,0 @@
-source 'https://rubygems.org'
-gemspec

data/VERSION

@@ -1 +0,0 @@
-1.0.1

data/rakefile.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-$: << './'
-
-require 'rubygems'
-require 'bundler/setup'
-
-require 'version_bumper'
-require 'bundler'
-require 'bundler/gem_helper'
-require 'geminabox_client'
-
-module SimpleApprovals
-  # Helper for setting version
-  module RSpec
-    # Helper for setting version
-    class GemHelper < Bundler::GemHelper
-      def reload_version
-        @gemspec.version = SimpleApprovals::RSpec.gem_version
-      end
-    end
-
-    # The current version of the gem
-    def self.gem_version
-      File.read('VERSION').strip
-    end
-  end
-end