rspec_sql_matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed99090194cf07fdc3987913d6c7ccf1df974562ab956b264485c4fba14f4b98
+  data.tar.gz: 674769907fe00545cfa3c7bd71c20de292201635a472fb4d2c8bbf1e5cd5edf2
+SHA512:
+  metadata.gz: 0e3b3366ed415f5be60b01b2406ad20020a57f2f02b4265b1459cd0665ab5832bcbbbc21829cd4894afa8274298c4b1d60308f797179f7a2f88231a160c5f8ff
+  data.tar.gz: fc444744b9c9dcdf16d25c8dd998934b5733dea9b47c4d90ce81edd02956851a367fb6854c97bed7eb91f369b206a7a1f06f0a3b17d2993dd58dea8d147e5427

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '19 13 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

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

@@ -0,0 +1,44 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags: [ '*' ]
+
+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 3.0
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 3.0.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/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.7, '3.0', 3.1, head, truffleruby, truffleruby-head]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rspec

data/.gitignore

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

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2022-09-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec_sql_matcher.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "simplecov"
+
+gem "activerecord", "~> 7.0", ">= 7.0.3"
+gem "sqlite3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mònade
+
+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,74 @@
+# RSpec match_structure
+
+![Tests](https://github.com/monade/rspec_sql_matcher/actions/workflows/test.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/rspec_sql_matcher.svg)](https://badge.fury.io/rb/rspec_sql_matcher)
+
+A gem to match SQL queries within your RSpec tests
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_sql_matcher'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec_sql_matcher
+
+## Usage
+
+This gem defines a couple of matchers that can help to capture queries and check if they are correctly formatted.
+
+Moreover, with the `RSpec::SqlMatcher::Helpers` module, it defines a set of helper methods to capture data from queries executed inside theirs blocks.
+
+### have_run_queries
+`have_run_queries` can match if a query has been run inside a block. For instance:
+
+```ruby
+expect { YourJob.perform_now }.to have_run_queries
+```
+
+It accepts various options:
+
+```ruby
+expect { YourJob.perform_now }.to have_run_queries(exactly: 2)
+expect { YourJob.perform_now }.to have_run_queries(min: 2, max: 5)
+```
+
+### match_query
+`match_query` can match query content using regular expressions. For instance:
+
+```ruby
+expect { User.very_complex_scope }.to match_query(/ GROUP BY "users"."id"/)
+```
+
+To see all the various features please refer to the [spec file](https://github.com/monade/rspec_sql_matcher/blob/main/rspec_sql_matcher).
+
+## 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_sql_matcher.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+About Monade
+----------------
+
+![monade](https://monade.io/wp-content/uploads/2021/06/monadelogo.png)
+
+rspec_sql_matcher is maintained by [mònade srl](https://monade.io/en/home-en/).
+
+We <3 open source software. [Contact us](https://monade.io/en/contact-us/) for your next project!

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_sql_matcher"
+
+# 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/sql_matcher/have_run_queries.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RSpec
+  module SqlMatcher
+    module HaveRunQueries
+      def self.evaluate_expectation(count, options = {})
+        condition = true
+        condition &&= count >= options[:min] if options[:min]
+        condition &&= count <= options[:max] if options[:max]
+        condition &&= count == options[:exactly] if options[:exactly]
+
+        condition
+      end
+
+      def self.failure_message(count, options = {})
+        return "Expected { } to run #{options[:exactly]} queries, but there were #{count} instead." if options[:exactly]
+
+        if options[:min] && options[:max]
+          return "Expected { } to run a number of query between #{options[:min]} and #{options[:max]}, but there were #{count} instead."
+        end
+
+        if options[:min]
+          return "Expected { } to run at least #{options[:min]} queries, but there were #{count} instead."
+        end
+
+        return "Expected { } to run at most #{options[:max]} queries, but there were #{count} instead." if options[:max]
+
+        'Invalid expectation parameters. Please pass min, max or exactly.'
+      end
+
+      def self.failure_message_when_negated(_count, options = {})
+        return "Expected { } not to execute #{options[:exactly]} queries, but it did." if options[:exactly]
+        if options[:min] && options[:max]
+          return "Expected { } not to run a number of query between #{options[:min]} and #{options[:max]}, but it did."
+        end
+        return "Expected { } not to run at least #{options[:min]} queries, but it did." if options[:min]
+
+        return "Expected { } not to run at most #{options[:max]} queries, but it did." if options[:max]
+
+        'Invalid expectation parameters. Please pass min, max or exactly.'
+      end
+    end
+  end
+end
+
+RSpec::Matchers.define :have_run_queries do |options = { min: 1 }|
+  match(notify_expectation_failures: true) do |block|
+    include RSpec::SqlMatcher
+    @real_count = count_queries(&block)
+
+    RSpec::SqlMatcher::HaveRunQueries.evaluate_expectation(@real_count, options)
+  end
+
+  supports_block_expectations
+
+  failure_message do |_|
+    RSpec::SqlMatcher::HaveRunQueries.failure_message(@real_count, options)
+  end
+
+  failure_message_when_negated do |_|
+    RSpec::SqlMatcher::HaveRunQueries.failure_message_when_negated(@real_count, options)
+  end
+end

data/lib/rspec/sql_matcher/helpers.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RSpec
+  module SqlMatcher
+    module Helpers
+      def count_queries(&block)
+        count = 0
+        _record_sql_queries(->(_) { count += 1 }, &block)
+        count
+      end
+
+      def collect_queries(&block)
+        queries = []
+        _record_sql_queries(->(query) { queries << query }, &block)
+        queries
+      end
+
+      def log_queries(&block)
+        _record_sql_queries(
+          lambda { |data|
+            puts
+            binds = data[:binds].map { |e| "#{e.name} => #{e.value}" }.join(', ')
+            puts "#{data[:sql]} | #{binds}"
+            puts
+            puts
+          }, &block
+        )
+      end
+
+      private
+
+      def _record_sql_queries(callback)
+        instance = ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
+          callback.call(data)
+        end
+        yield
+      ensure
+        ActiveSupport::Notifications.unsubscribe(instance) if instance
+      end
+    end
+  end
+end

data/lib/rspec/sql_matcher/match_query.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :match_query do |regexp|
+  match(notify_expectation_failures: true) do |block|
+    include RSpec::SqlMatcher::Helpers
+    @queries = collect_queries(&block).map do |data|
+      query = data[:sql].dup
+      data[:binds].each_with_index { |bind, index| query.gsub!("\$#{index + 1}", bind.value.inspect) }
+      query
+    end
+
+    @queries.any? { |query| regexp =~ query }
+  end
+
+  supports_block_expectations
+
+  failure_message do |_|
+    "Expected { } to match query with #{regexp}, but it didn't. Current queries where:\n#{@queries.join("\n")}:"
+  end
+
+  failure_message_when_negated do |_|
+    "Expected { } not to match query with #{regexp}, but it did. Current queries where:\n#{@queries.join("\n")}:"
+  end
+end

data/lib/rspec/sql_matcher/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module SqlMatcher
+    VERSION = '0.1.0'
+  end
+end

data/lib/rspec/sql_matcher.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'sql_matcher/version'
+require 'active_support'
+require 'rspec/sql_matcher/helpers'
+require 'rspec/sql_matcher/have_run_queries'
+require 'rspec/sql_matcher/match_query'
+
+RSpec.configure do |config|
+  config.include RSpec::SqlMatcher::Helpers
+end

data/rspec_sql_matcher.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rspec/sql_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec_sql_matcher'
+  spec.version       = RSpec::SqlMatcher::VERSION
+  spec.authors       = ['Mònade']
+  spec.email         = ['hello@monade.io']
+
+  spec.summary       = 'An RSpec matcher to check SQL queries'
+  spec.description   = 'An RSpec matcher to check SQL queries'
+  spec.homepage      = 'https://github.com/monade/rspec_sql_matcher'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/monade/rspec_sql_matcher/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,79 @@
+--- !ruby/object:Gem::Specification
+name: rspec_sql_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mònade
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-18 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 check SQL queries
+email:
+- hello@monade.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/sql_matcher.rb
+- lib/rspec/sql_matcher/have_run_queries.rb
+- lib/rspec/sql_matcher/helpers.rb
+- lib/rspec/sql_matcher/match_query.rb
+- lib/rspec/sql_matcher/version.rb
+- rspec_sql_matcher.gemspec
+homepage: https://github.com/monade/rspec_sql_matcher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/monade/rspec_sql_matcher
+  source_code_uri: https://github.com/monade/rspec_sql_matcher
+  changelog_uri: https://github.com/monade/rspec_sql_matcher/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: An RSpec matcher to check SQL queries
+test_files: []