rspec-resembles_json_matchers 0.5.0

data/lib/rspec/resembles_json_matchers/resembles_hash_matcher.rb

@@ -0,0 +1,110 @@
+require "active_support/core_ext/string/indent" # indent
+
+module RSpec::ResemblesJsonMatchers
+  class ResemblesHashMatcher
+    include Helpers
+
+    def self.can_match?(hash)
+      hash.is_a? Hash
+    end
+
+    attr_reader :expected
+
+    def initialize(expected)
+      @expected = expected
+      @failed_matches = {}
+      @matched_keys = []
+      @matched_matchers = []
+    end
+
+    def matches?(actual)
+      @actual = actual
+      expected_matchers.each do |expected_key, value_matcher|
+        @matched_keys << expected_key
+
+        attr_matcher = RSpec::ResemblesJsonMatchers::AttributeMatcher.new(expected_key, value_matcher)
+        match = attr_matcher.matches?(actual)
+
+        if match
+          @matched_matchers << value_matcher
+        else
+          @failed_matches[expected_key] = value_matcher unless match
+        end
+      end
+
+      actual.keys.each { |k| unmatched_matchers.delete(k) }
+
+      !failed_matches.any? and
+        !unmatched_keys.any? and
+        !unmatched_matchers.any?
+    end
+
+    def description
+      "resemble json\n" + expected_formatted.indent(2)
+    end
+
+    def failure_message
+      "failed because\n" +
+        pretty_failed_matches.indent(2) +
+        pretty_unmatched_keys.indent(2) +
+        pretty_unmatched_matchers.indent(2) +
+        "\n"
+    end
+
+    protected
+
+    def expected_matchers
+      @expected_matchers ||= {}.tap do |hsh|
+        expected.each do |key, value_matcher|
+          hsh[key] = matcherize(value_matcher)
+        end
+      end
+    end
+
+    def failed_matches
+      @failed_matches
+    end
+
+    def unmatched_keys
+      @actual.keys - @matched_keys
+    end
+
+    def unmatched_matchers
+      @unmatched_matchers ||= expected_matchers.dup
+    end
+
+    def expected_formatted
+      out = "{\n"
+      out << expected_matchers.map do |k,v|
+        %{  "%s": %s} % [k, v.expected_formatted]
+      end.join(",\n")
+      out << "\n}\n"
+    end
+
+    def pretty_failed_matches
+      failed_matches.map do |k,matcher|
+        next unless @actual.key?(k) # Covered by the unmatched matchers messages
+        matcher_failure_message =
+          matcher.failure_message
+                 .gsub("(compared using ==)", "") # From the equality matcher, ugly in this context
+                 .strip
+                 .indent(2)
+
+        "attribute #{k.to_s.inspect}:\n#{matcher_failure_message}"
+      end.join("\n")
+    end
+
+    def pretty_unmatched_keys
+      unmatched_keys.map do |key|
+        "attribute #{key.to_s.inspect}:\n  is present, but no matcher provided to match it"
+      end.join("\n")
+    end
+
+    def pretty_unmatched_matchers
+      unmatched_matchers.map do |key, matcher|
+        "attribute #{key.to_s.inspect}:\n  has a matcher defined, but that attribute was not provided"
+      end.join("\n")
+    end
+
+  end
+end

data/lib/rspec/resembles_json_matchers/resembles_matcher.rb

@@ -0,0 +1,59 @@
+require "active_support/core_ext/array/wrap"
+
+module RSpec::ResemblesJsonMatchers
+
+  def resembles(expected)
+    ResemblesMatcher.new(expected)
+  end
+
+  class ResemblesMatcher
+    def initialize(expected, inclusion: nil)
+      @expected = expected
+
+      candidate_class = if inclusion == :any
+                          ResemblesAnyOfMatcher
+                        elsif inclusion == :all
+                          ResemblesAllOfMatcher
+                        else
+                          candidates.detect { |candidate| candidate.can_match?(@expected) }
+                        end
+
+      if candidate_class
+        @candidate = candidate_class.new(expected)
+      else
+        fail "Could not find an acceptable resembles matcher for #{@expected.inspect}"
+      end
+    end
+
+    def description
+      @candidate.description
+    end
+
+    def matches?(actual)
+      @actual = actual
+      if @candidate
+        @candidate.matches?(actual)
+      end
+    end
+
+    def failure_message(negated: false)
+      "expected #{@actual.inspect} to #{negated ? "not " : ""}#{description}"
+    end
+
+    def negative_failure_message
+      failure_message(negated: true)
+    end
+
+    def candidates
+    end
+  end
+
+  class ResemblesAllOfMatcher
+
+  end
+
+
+
+  RSpec.configure { |c| c.include self }
+end
+

data/lib/rspec/resembles_json_matchers/resembles_numeric_matcher.rb

@@ -0,0 +1,32 @@
+
+module RSpec::ResemblesJsonMatchers
+  class ResemblesNumericMatcher
+    NUMBER_REGEX = /\A\d+\Z/.freeze
+    def self.can_match?(number)
+      number.is_a?(Numeric) ||
+        number =~ NUMBER_REGEX
+    end
+
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def description
+      "resemble the number #{@expected.inspect}"
+    end
+
+    # TODO Make sure int/float matches? Numbers are within an order of magnitude?
+    def matches?(actual)
+      @actual = actual
+      self.class.can_match?(actual)
+    end
+
+    def expected_formatted
+      @expected
+    end
+
+    def failure_message
+      "#{@actual.inspect} does not resemble a number"
+    end
+  end
+end

data/lib/rspec/resembles_json_matchers/resembles_route_matcher.rb

@@ -0,0 +1,25 @@
+
+module RSpec::ResemblesJsonMatchers
+  class ResemblesRouteMatcher
+    ROUTE_REGEX = %r{\A/.*:}.freeze
+    def self.can_match?(route_string)
+      defined?(ActionDispatch) &&
+        route_string.is_a?(String) &&
+        route_string.start_with?("/") &&
+        route_string.include?(":")
+    end
+
+    def initialize(expected_route)
+      @expected_route = expected_route
+    end
+
+    def description
+      "resemble route #{@expected_route.inspect}"
+    end
+
+    def matches?(actual)
+      path = ActionDispatch::Journey::Path::Pattern.from_string(@expected_route)
+      actual =~ path.to_regexp
+    end
+  end
+end

data/lib/rspec/resembles_json_matchers/resembles_string_matcher.rb

@@ -0,0 +1,25 @@
+
+module RSpec::ResemblesJsonMatchers
+  class ResemblesStringMatcher
+    def self.can_match?(string)
+      string.is_a? String
+    end
+
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def description
+      "resemble text #{@expected.inspect}"
+    end
+
+    # TODO make sure the lengths are kinda the same? Levenschtien distances?
+    def matches?(actual)
+      self.class.can_match?(actual)
+    end
+
+    def expected_formatted
+      @expected
+    end
+  end
+end

data/lib/rspec/resembles_json_matchers/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module ResemblesJsonMatchers
+    VERSION = "0.5.0"
+  end
+end

data/rspec-resembles_json_matchers.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/resembles_json_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-resembles_json_matchers"
+  spec.version       = Rspec::ResemblesJsonMatchers::VERSION
+  spec.authors       = ["Paul Sadauskas"]
+  spec.email         = ["psadauskas@gmail.com"]
+
+  spec.summary       = %q{Helpful matchers for comparing JSON documents.}
+  spec.homepage      = "https://github.com/paul/rspec-resembles_json_matchers"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "awesome_print"
+
+  spec.add_runtime_dependency "rspec", ">= 2.0", "< 4.0.0.a"
+  spec.add_runtime_dependency "rspec-expectations", ">= 2.0", "< 4.0.0.a"
+  spec.add_runtime_dependency "activesupport", ">= 4.0" # For String#indent
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: rspec-resembles_json_matchers
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- psadauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- examples/example_spec.rb
+- gemfiles/rails_42.gemfile
+- gemfiles/rails_42.gemfile.lock
+- gemfiles/rails_42_rspec_33.gemfile
+- gemfiles/rails_42_rspec_33.gemfile.lock
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_5.gemfile.lock
+- lib/rspec/resembles_json_matchers.rb
+- lib/rspec/resembles_json_matchers/attribute_matcher.rb
+- lib/rspec/resembles_json_matchers/helpers.rb
+- lib/rspec/resembles_json_matchers/json_matcher.rb
+- lib/rspec/resembles_json_matchers/matcherizer.rb
+- lib/rspec/resembles_json_matchers/resembles_any_of_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_array_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_class_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_date_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_hash_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_numeric_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_route_matcher.rb
+- lib/rspec/resembles_json_matchers/resembles_string_matcher.rb
+- lib/rspec/resembles_json_matchers/version.rb
+- rspec-resembles_json_matchers.gemspec
+homepage: https://github.com/paul/rspec-resembles_json_matchers
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Helpful matchers for comparing JSON documents.
+test_files: []