rspec_match_structure 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6709f65f70b8cca91150e482fb321aab0386d6ccd366278dfc6bbf0e285cc14a
+  data.tar.gz: 00afb99ea29475957b602d4b28dff18f447d6c766da981117b0961d7e29cf41b
+SHA512:
+  metadata.gz: b1f7b19820592a1bda44f5ded02f3f1f9f7bf276954426510b6ce23b5886622c409f5e3eef76334597211430f68c359a373f4c173246004d00df2df5b7ca36d6
+  data.tar.gz: 99ee1bae15f18dc187919e79f87ac87b4cd65b4e8030f644c48e98dcf70a38311b5456524d8637fb72c54b6eb5efef43e3c39e1446fe79d87180066226abfa2e

data/.github/workflows/gem-push.yml

@@ -0,0 +1,46 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    environment: production
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## [Unreleased]
+
+## [0.3.2] - 2022-05-16
+
+- Bumped version
+- Fixed workflow
+
+## [0.3.1] - 2022-05-16
+
+- Renamed gem
+
+## [0.3.0] - 2022-05-13
+
+- Added more test cases
+- Added readme
+
+## [0.2.0] - 2022-03-23
+
+- Added more thorough testing
+- Added a_list_with matcher
+
+
+## [0.1.0] - 2022-03-22
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec_match_structure.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "simplecov"
+

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    rspec_match_structure (0.3.2)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.22.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec_match_structure!
+  rubocop (~> 1.7)
+  simplecov
+
+BUNDLED WITH
+   2.2.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Fabrizio Mele
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# RSpec match_structure
+
+[![Ruby Gem](https://github.com/monade/rspec_match_structure/actions/workflows/gem-push.yml/badge.svg)](https://github.com/monade/rspec_match_structure/actions/workflows/gem-push.yml)
+
+Raise your expectations! RSpec match_structure is a gem that allows to test the structure of your string, hashes and lists.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_match_structure'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec_match_structure
+
+## Usage
+
+`match_strucure` can match various types of data and structures against schemas. A dead simple example of what it can do is:
+
+```ruby
+expect(["a", "b", "c"]).to match_structure(a_list_of(String).with(2).elements_at_least)
+```
+
+Another example:
+
+```ruby
+expect([
+         {
+           id: '1',
+           type: 'users'
+         },
+         {
+           id: '2',
+           type: 'users'
+         },
+         {
+           id: '1',
+           type: 'posts'
+         }
+       ]).to match_structure(a_list_with({ type: 'users' }).exactly(2).times)
+```
+
+It can also match string agains regular expressions:
+
+```ruby
+ expect("abc").to match_structure( /abc/ )
+```
+
+This is especially useful when you want to test a JSON:API response:
+
+```ruby
+
+    expect(response.body).to match_structure(
+                               {
+                                 data: {
+                                     id: String,
+                                     type: 'someType',
+                                     attributes: {
+                                       anAttribute: String
+                                     }
+                                },
+                                 included: [
+                                   a_list_with({ type: 'relatedType' }).exactly(1).times
+                                 ]
+                               }
+                             )
+```
+
+To see all the various features please refer to the [spec file](https://github.com/monade/rspec_match_structure/blob/master/spec/rspec_match_structure_spec.rb).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/monade/rspec_match_structure.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rspec_match_structure"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec_match_structure/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RspecMatchStructure
+  VERSION = "0.3.2"
+end

data/lib/rspec_match_structure.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "rspec_match_structure/version"
+require 'active_support/core_ext/hash'
+
+require_relative "structure"
+
+include Structure::Type::Methods
+
+RSpec::Matchers.define :match_structure do |structure|
+  match do |json|
+    @key = 'root'
+    begin
+      explore_structure(structure, json)
+    rescue Structure::Type::SizeError => e
+      @message = e.message
+      false
+    rescue Structure::Type::MatchError => e
+      @message = e.message
+      false
+    end
+  end
+
+  def size_fail(structure, json)
+    raise Structure::Type::SizeError,
+          "Wrong size at #{@key}: #{json.size} != #{structure.size}"
+  end
+
+  def structure_fail(structure, json)
+    raise Structure::Type::MatchError,
+          "Structure:\n#{structure.pretty_inspect}\nGiven:\n#{json.pretty_inspect}"
+  end
+
+  def explore_structure(struc, json)
+    # example: 1 ~= Integer
+    if struc.is_a? Class
+      structure_fail(struc, json) unless json.is_a?(struc)
+      # example: "foobar" ~= /f[o]+bar/
+    elsif struc.is_a?(Regexp) && json.is_a?(String)
+      structure_fail(struc, json) unless json.match?(struc)
+      # example: [1, 2, 3] ~= a_list_of(Integer)
+    elsif struc.is_a? Structure::Type::Array
+      struc.matches?(json) { |j, s| explore_structure(j, s) }
+      # example: 1 ~= one_of(Integer, String)
+    elsif struc.is_a? Structure::Type::Single
+      struc.matches?(json) { |j, s| explore_structure(j, s) }
+    elsif struc.is_a? Structure::Type::ArrayWithStruct
+      struc.matches?(json) { |j, s| explore_structure(j, s) }
+      # example: {a: b, c: d} ~= {a: Integer, b: String}
+    elsif json.is_a?(Hash)
+      structure_fail(struc, json) unless struc.is_a? Hash
+      struc = struc.with_indifferent_access
+      json = json.with_indifferent_access
+      struc.all? do |k, v|
+        @key = k
+        structure_fail(struc, json) unless json.key?(k)
+        explore_structure(v, json[k])
+      end
+      # example: [1, 2, 3] ~= [1, 2, 3]
+    elsif json.is_a?(Array)
+      structure_fail(struc, json) unless struc.is_a? Array
+      size_fail(struc, json) if struc.size != json.size
+      return struc.zip(json).all? do |s, j|
+        @key = s
+        explore_structure(s, j)
+      end
+      # example: 3 ~= 3
+    else
+      structure_fail(struc, json) unless json == struc
+    end
+    true
+  end
+
+  failure_message do |json|
+    "#{json.pretty_inspect}\ndoes not match structure\n#{structure.pretty_inspect}\n\n#{@message}"
+  end
+
+  failure_message_when_negated do |json|
+    "#{json.pretty_inspect}\nis matching structure\n#{structure.pretty_inspect}"
+  end
+end

data/lib/structure.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require "pp"
+
+module Structure
+  module Type
+    class Error < ::StandardError; end
+
+    class SizeError < Error; end
+
+    class MatchError < Error; end
+
+    class Single
+      attr_reader :classes
+
+      def initialize(classes)
+        @classes = classes
+      end
+
+      def class?
+        @classes.all? { |c| c.is_a?(Class) || c.is_a?(Module) }
+      end
+
+      def matches?(json)
+        result = classes.any? do |s|
+          yield s, json
+        rescue Structure::Type::Error
+          false
+        end
+        raise MatchError, "#{json}\n is not one of #{inspect}" unless result
+
+        true
+      end
+
+      def inspect
+        "one_of(#{@classes})"
+      end
+    end
+
+    class Array < Single
+      def initialize(classes)
+        super(classes)
+        @max = 999_999
+        @min = 0
+      end
+
+      def between(min, max)
+        @min = min
+        @max = max
+        self
+      end
+
+      def at_least(number)
+        between(number, Float::INFINITY)
+      end
+
+      def with(number)
+        @number = number
+        self
+      end
+
+      def elements
+        @min = @number
+        @max = @number
+        self
+      end
+
+      def items
+        elements
+      end
+
+      def elements_at_most
+        raise "Wrong use of at_most" unless @number
+
+        @max = @number
+        @number = nil
+        self
+      end
+
+      def elements_at_least
+        raise "Wrong use of at_least" unless @number
+
+        @min = @number
+        @number = nil
+        self
+      end
+
+      def matches?(json)
+        unless json.size.between?(
+          @min, @max
+        )
+          raise SizeError,
+                "Size Error: #{inspect} size (#{json.size}) is not between #{@min} and #{@max}."
+        end
+
+        json.all? { |j| classes.any? { |s| yield s, j } }
+      end
+
+      def inspect
+        if class?
+          "a_list_of(#{@classes.inspect})"
+        else
+          "a_list_of(\n#{@classes.pretty_inspect})"
+        end
+      end
+    end
+
+    class ArrayWithStruct < Array
+      attr_reader :min, :max, :struct
+
+      def initialize(struct)
+        super([])
+        @struct = struct
+        @max = 999_999
+        @min = 1
+      end
+
+      def exactly(number)
+        with(number)
+      end
+
+      def times
+        elements
+      end
+
+      def matches?(json)
+        result = json.count do |j|
+          yield @struct, j
+        rescue Structure::Type::Error
+          false
+        end
+        raise MatchError, "#{json}\n has no #{@struct}" unless result && result.between?(@min, @max)
+
+        true
+      end
+    end
+
+    module Methods
+      def a_list_of(*class_list)
+        Structure::Type::Array.new(class_list)
+      end
+
+      def one_of(*class_list)
+        Structure::Type::Single.new(class_list)
+      end
+
+      def a_list_with(struct)
+        Structure::Type::ArrayWithStruct.new(struct)
+      end
+    end
+  end
+end

data/rspec_match_structure.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec_match_structure/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_match_structure"
+  spec.version       = RspecMatchStructure::VERSION
+  spec.authors       = ["Mònade"]
+  spec.email         = ["hello@monade.io"]
+
+  spec.summary       = "An RSpec matcher to match json:api structures and lists"
+  spec.description   = "An RSpec matcher to match json:api structures and lists."
+  spec.homepage      = "https://github.com/monade/rspec_match_structure"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5"
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/monade/rspec_match_structure/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rspec_match_structure
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Mònade
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An RSpec matcher to match json:api structures and lists.
+email:
+- hello@monade.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_match_structure.rb
+- lib/rspec_match_structure/version.rb
+- lib/structure.rb
+- rspec_match_structure.gemspec
+homepage: https://github.com/monade/rspec_match_structure
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/monade/rspec_match_structure
+  source_code_uri: https://github.com/monade/rspec_match_structure
+  changelog_uri: https://github.com/monade/rspec_match_structure/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: An RSpec matcher to match json:api structures and lists
+test_files: []