rspec-json_matchers 0.1.0.alpha.1

data/lib/rspec/json_matchers/utils/collection_keys_extractor.rb

@@ -0,0 +1,35 @@
+module RSpec
+  module JsonMatchers
+    module Utils
+      # @api private
+      class CollectionKeysExtractor
+        #
+        # @param collection [Array, Hash]
+        #
+        # @return [Set] set of keys/indexes of the collection
+        # @raise [TypeError] When `collection` is not one of expected types
+        def self.extract(collection)
+          new(collection).extract
+        end
+
+        COLLECTION_TYPE_TO_VALUE_EXTRACTION_PROC_MAP = {
+          Array => -> (collection) { collection.each_index.to_a.to_set },
+          Hash  => -> (collection) { collection.each_key.map(&:to_s).to_set },
+        }.freeze
+        private_constant :COLLECTION_TYPE_TO_VALUE_EXTRACTION_PROC_MAP
+
+        attr_reader :collection
+
+        def initialize(collection)
+          @collection = collection
+        end
+
+        def extract
+          COLLECTION_TYPE_TO_VALUE_EXTRACTION_PROC_MAP.fetch(collection.class) do
+            raise TypeError
+          end.call(collection)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_matchers/utils/key_path/extraction_result.rb

@@ -0,0 +1,22 @@
+module RSpec
+  module JsonMatchers
+    module Utils
+      # @api private
+      module KeyPath
+        # Only as a value object
+        class ExtractionResult
+          attr_reader :object, :successful
+
+          def initialize(object, successful)
+            @object = object
+            @successful = successful
+          end
+
+          def failed?
+            !successful
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_matchers/utils/key_path/extractor.rb

@@ -0,0 +1,70 @@
+require_relative "path"
+
+module RSpec
+  module JsonMatchers
+    module Utils
+      # @api private
+      module KeyPath
+        class Extractor
+
+          private
+          attr_accessor *[
+            :object,
+          ]
+          attr_reader *[
+            :path,
+          ]
+          public
+
+          # Create a new extractor with the "source object"
+          # and the path to be used for extracting our target object
+          #
+          # @param object [Object]
+          #   The source object to extract our target object from
+          # @param path [String, Path]
+          #   the path of target object
+          #   Will convert into {Path}
+          #
+          # @see JsonMatchers::Matchers::BeJsonWithSomethingMatcher#at_path
+          def initialize(object, path)
+            @object = object
+            @path = KeyPath::Path.new(path)
+          end
+
+          # Actually perform the extraction and return the result
+          # Since the object could be falsy,
+          # an object of custom class is returned instead of the object only
+          #
+          # Assume the path to be valid
+          #
+          # @return (see Path#extract)
+          def extract
+            path.each_path_part do |path_part|
+              self.object = case object
+              when Hash
+                # Allow nil as object, but disallow key to be absent
+                unless object.key?(path_part)
+                  return ExtractionResult.new(object, false)
+                end
+                object.fetch(path_part)
+              when Array
+                index = path_part.to_i
+                # Disallow index to be out of range
+                # Disallow negative number as index
+                unless (path_part =~ /\A\d+\z/) && index < object.size
+                  return ExtractionResult.new(object, false)
+                end
+                object.slice(index)
+              else
+                # Disallow non JSON collection type
+                return ExtractionResult.new(object, false)
+              end
+            end
+
+            ExtractionResult.new(object, true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_matchers/utils/key_path/path.rb

@@ -0,0 +1,104 @@
+require_relative "extraction_result"
+require_relative "extractor"
+
+module RSpec
+  module JsonMatchers
+    module Utils
+      # @api private
+      module KeyPath
+        class Path
+          # The "path part" separator
+          # Period is used since it's the least used char as part of a key name
+          # (it can never by used for index anyway)
+          # As a side effect this char CANNOT be used, escaping is not planned to be added
+          PATH_PART_SPLITTER = ".".freeze
+          # The regular expression for checking "invalid" path
+          # The separator should NOT at the start/end of the string,
+          # or repeating itself without other chars in between
+          INVALID_PATH_REGEX = %r_(
+          ^#{Regexp.escape(PATH_PART_SPLITTER)}
+          |
+          #{Regexp.escape(PATH_PART_SPLITTER)}{2,}
+          |
+          #{Regexp.escape(PATH_PART_SPLITTER)}$
+          )_x.freeze
+
+          # Creates a {Path}
+          # with a {String} (mainly from external) (will store it internally)
+          # or a {Path} (mainly from internal) (will get and assign the string path it internally)
+          #
+          # @note
+          #   It does not copy the string object since there is not need
+          #   This might lead to some strange bug
+          #
+          # @param path [String, Path]
+          #   the path to be used
+          #   {String} is mainly for external use, {Path} for internal use
+          #
+          # @raise [TypeError] when `path` is not a {String} or {Path}
+          def initialize(path)
+            case path
+            when Path
+              @string_path = path.string_path
+            when String
+              @string_path = path
+            else
+              raise TypeError, "Only String and Path is expected"
+            end
+          end
+
+          def valid?
+            !invalid?
+          end
+
+          # Run a loop on all "path parts" without exposing the parts
+          # a block is required
+          #
+          # @yieldparam part [String] a "path part" if the {#string_path}
+          #
+          # @return [Path] The path object itself
+          def each_path_part(&block)
+            path_parts.each(&block)
+            self
+          end
+
+          # Return successful extraction result when path is empty
+          # Return failed extraction result when path is invalid
+          # Delegate to {Extractor} otherwise
+          #
+          # @param object [Object]
+          #   The "source object" to extract our "target object" from
+          #
+          # @return [ExtractionResult] The result of object extraction
+          def extract(object)
+            return ExtractionResult.new(object, true) if empty?
+            return ExtractionResult.new(object, false) if invalid?
+            Extractor.new(object, self).extract
+          end
+
+          protected
+
+          attr_reader :string_path
+
+          private
+
+          def path_parts
+            string_path.split(PATH_PART_SPLITTER)
+          end
+
+          def invalid?
+            INVALID_PATH_REGEX =~ string_path
+          end
+
+          def empty?
+            path_parts.empty?
+          end
+
+          def to_s
+            string_path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_matchers/utils.rb

@@ -0,0 +1,10 @@
+require_relative "utils/collection_keys_extractor"
+require_relative "utils/key_path/path"
+
+module RSpec
+  module JsonMatchers
+    # @api private
+    module Utils
+    end
+  end
+end

data/lib/rspec/json_matchers/version.rb

@@ -0,0 +1,8 @@
+module RSpec
+  module JsonMatchers
+    # The version of the gem
+    # Used for generating the value in gemspec file
+    # Also can be referenced by code for debugging or other purposes
+    VERSION = "0.1.0.alpha.1"
+  end
+end

data/lib/rspec/json_matchers.rb

@@ -0,0 +1,15 @@
+require "rspec"
+
+require_relative "json_matchers/version"
+require_relative "json_matchers/matchers"
+require_relative "json_matchers/expectation"
+require_relative "json_matchers/expectations"
+
+# The namespace for {RSpec}
+# We only add {JsonMatchers} to it
+module RSpec
+  # The actual namespace for this gem
+  # All other classes/modules are defined within this module
+  module JsonMatchers
+  end
+end

data/lib/rspec-json_matchers.rb

@@ -0,0 +1 @@
+require_relative  "rspec/json_matchers"

data/rspec-json_matchers.gemspec

@@ -0,0 +1,47 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/json_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-json_matchers"
+  spec.version       = RSpec::JsonMatchers::VERSION
+  spec.authors       = ["PikachuEXE"]
+  spec.email         = ["pikachuexe@gmail.com"]
+
+  spec.summary       = %q{A collection of RSpec matchers for testing JSON data.}
+  spec.description   = <<-DESC
+    This gem provides a collection of RSpec matchers for testing JSON data.
+    It aims to make JSON testing flexible & easier, especially for testing multiple properties.
+    It does not and will not have anything related to JSON Schema.
+  DESC
+  spec.homepage      = "https://github.com/PikachuEXE/rspec-json_matchers"
+  spec.license       = "MIT"
+
+  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_dependency "rspec", "~> 3.0"
+  spec.add_dependency "awesome_print", "~> 1.6"
+  spec.add_dependency "abstract_class", "~> 1.0", ">= 1.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "appraisal", "~> 2.0"
+
+  spec.add_development_dependency "rspec-its", "~> 1.0"
+
+  spec.add_development_dependency "coveralls", "~> 0.8"
+
+  spec.add_development_dependency "gem-release", "~> 0.7"
+
+  spec.add_development_dependency "rubocop", "~> 0.32"
+  spec.add_development_dependency "inch", "~> 0.6"
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.required_rubygems_version = ">= 1.4.0"
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: rspec-json_matchers
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha.1
+platform: ruby
+authors:
+- PikachuEXE
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: abstract_class
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: 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: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: |2
+      This gem provides a collection of RSpec matchers for testing JSON data.
+      It aims to make JSON testing flexible & easier, especially for testing multiple properties.
+      It does not and will not have anything related to JSON Schema.
+email:
+- pikachuexe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rspec_3_0.gemfile
+- gemfiles/rspec_3_1.gemfile
+- gemfiles/rspec_3_2.gemfile
+- gemfiles/rspec_3_3.gemfile
+- lib/rspec-json_matchers.rb
+- lib/rspec/json_matchers.rb
+- lib/rspec/json_matchers/comparers.rb
+- lib/rspec/json_matchers/comparers/abstract_comparer.rb
+- lib/rspec/json_matchers/comparers/comparison_result.rb
+- lib/rspec/json_matchers/comparers/exact_keys_comparer.rb
+- lib/rspec/json_matchers/comparers/include_keys_comparer.rb
+- lib/rspec/json_matchers/expectation.rb
+- lib/rspec/json_matchers/expectations.rb
+- lib/rspec/json_matchers/expectations/abstract.rb
+- lib/rspec/json_matchers/expectations/core.rb
+- lib/rspec/json_matchers/expectations/mixins/built_in.rb
+- lib/rspec/json_matchers/expectations/private.rb
+- lib/rspec/json_matchers/matchers.rb
+- lib/rspec/json_matchers/matchers/be_json_matcher.rb
+- lib/rspec/json_matchers/matchers/be_json_with_content_matcher.rb
+- lib/rspec/json_matchers/matchers/be_json_with_sizes_matcher.rb
+- lib/rspec/json_matchers/matchers/be_json_with_something_matcher.rb
+- lib/rspec/json_matchers/utils.rb
+- lib/rspec/json_matchers/utils/collection_keys_extractor.rb
+- lib/rspec/json_matchers/utils/key_path/extraction_result.rb
+- lib/rspec/json_matchers/utils/key_path/extractor.rb
+- lib/rspec/json_matchers/utils/key_path/path.rb
+- lib/rspec/json_matchers/version.rb
+- rspec-json_matchers.gemspec
+homepage: https://github.com/PikachuEXE/rspec-json_matchers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.4.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A collection of RSpec matchers for testing JSON data.
+test_files: []
+has_rdoc: