rspec-json_helpers 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10aa419eb89e6a30f376b366b7a40cc3abb8560e
+  data.tar.gz: 50fddf43ce7afe458390b798c1e4451fb8043231
+SHA512:
+  metadata.gz: beeaddaf3b01488b64dfc949899ccb573c7833e8b5bab6f8a55dd161789385dca9f7b5b1f156f43326cfecd23018326702b93022801ffa59986c5d980217ad63
+  data.tar.gz: 89a7378b3ff33f352535cad5097a5588a7fb0f29f22ddc4da1e6ac16f66a2d1f6ef12cc60ee6495cb55d9e76ced4cb98ccb070692cd2a310e8aca0f24623892a

data/lib/rspec/json_helpers.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'json_helpers/equal_json_matcher'
+require_relative 'json_helpers/formatter'
+
+module RSpec
+  # Provides a `equal_json` rspec matcher.
+  module JsonHelpers
+
+    # @param [String<JSON>] expected
+    # @raise ArgumentError Raises an ArgumentError when the expected
+    #   value is not a String that contains valid JSON.
+    def equal_json(expected)
+      EqualJsonMatcher.new(expected)
+    end
+
+    class << self
+
+      # @param [String<JSON>] json
+      # @return [String<JSON>]
+      # @raise ArgumentError Raises an ArgumentError when the given
+      #   value is not valid JSON. expected
+      # @api private
+      def normalize_json(json)
+        Formatter.new.format(json)
+      end
+
+    end
+
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::JsonHelpers
+end
+
+RSpec::Matchers.alias_matcher :eq_json, :equal_json

data/lib/rspec/json_helpers/equal_json_matcher.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'diff-lcs'
+require 'diffy'
+require 'stringio'
+
+module RSpec
+  module JsonHelpers
+    # @api private
+    class EqualJsonMatcher
+
+      def initialize(expected, colorize: true)
+        @expected = JsonHelpers.normalize_json(expected)
+        @diff_format = colorize ? :color : :text
+      end
+
+      def matches?(actual)
+        @actual = JsonHelpers.normalize_json(actual)
+        @expected == @actual
+      rescue ArgumentError => error
+        @wrong_type_error_message = error.message
+        false
+      end
+
+      def failure_message
+        if @actual.is_a?(String)
+          diff_json_error_message
+        else
+          wrong_type_error_message
+        end
+      end
+
+      def failure_message_when_negated
+        raise NotImplementedError
+      end
+
+      def diff_json_error_message
+        message = StringIO.new
+        message << "expected: #{@expected}\n\n"
+        message << "got: #{@actual}\n\n"
+        message << "Diff: #{diff}"
+        message.string
+      end
+
+      def diff
+        diff = Diffy::Diff.new(@expected, @actual).to_s(@diff_format)
+        diff.lines[0..-2].join
+      end
+
+      def wrong_type_error_message
+        @wrong_type_error_message
+      end
+
+    end
+  end
+end

data/lib/rspec/json_helpers/formatter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module RSpec
+  module JsonHelpers
+    # @api private
+    class Formatter
+
+      WRONG_TYPE = 'Expected a JSON string, got %<type>s.'
+
+      # @param [String<JSON>] json
+      # @return [String<JSON>]
+      # @raise ArgumentError Raises `ArgumentError` when the given
+      #   json value is not a string, or when when there is an error
+      #   parsring string as JSON.
+      def format(json)
+        dump_json(deep_sort(parse_json(json)))
+      rescue JSON::ParserError => e
+        raise ArgumentError, 'Expected a string containing valid ' \
+          "JSON; got #{e.class.name}: #{e.message}"
+      end
+
+      private
+
+      def parse_json(json)
+        if json.is_a?(String)
+          JSON.parse(json)
+        else
+          raise ArgumentError, Kernel.format(WRONG_TYPE, type: json.class.name)
+        end
+      end
+
+      def dump_json(value)
+        JSON.pretty_generate(value, indent: '  ')
+      end
+
+      def deep_sort(obj)
+        case obj
+        when Hash
+          obj.keys.sort.each_with_object({}) do |key, hash|
+            hash[key] = deep_sort(obj[key])
+          end
+        when Array
+          obj.map { |value| deep_sort(value) }
+        when String, Numeric, true, false, nil
+          obj
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: rspec-json_helpers
+version: !ruby/object:Gem::Version
+  version: 0.9.2
+platform: ruby
+authors:
+- The Incognito Coder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+- !ruby/object:Gem::Dependency
+  name: semver-string
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-sitemap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- theincognitocoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/json_helpers.rb
+- lib/rspec/json_helpers/equal_json_matcher.rb
+- lib/rspec/json_helpers/formatter.rb
+homepage: https://github.com/theincognitocoder/rspec-json_helpers
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/theincognitocoder/rspec-json_helpers/issues
+  changelog_uri: https://github.com/theincognitocoder/rspec-json_helpers/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/github/theincognitocoder/rspec-json_helpers/master
+  homepage_uri: https://github.com/theincognitocoder/rspec-json_helpers
+  source_code_uri: https://github.com/theincognitocoder/rspec-json_helpers
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RSpec helpers for working with JSON values.
+test_files: []