sql_matchers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f1773fdab03f1f4a89f6b58bcdaeb0833ab5666836cd7536acd4627f65e9618
+  data.tar.gz: ba267a8def94f0e7579e9d0be92dead4504ec0c2a8f02f5d92cc3991adf9f840
+SHA512:
+  metadata.gz: adf3277acce82bff99919c98242e3aa8dd83145fd3db5349bfc3ee34e07bb1fae2815cb68f0edc33342b0758a64a2d346ede745a21f7f97e1f1e4241e0c16365
+  data.tar.gz: 35980c31136c6b60c3f462376fc502f752dbf692de108ce38cde0ef9f3d8e56d5618caaad54f861a7b026403784a5a6820d0531f5ad3afb06c815f7fa0e382e0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+## [Unreleased]

data/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+## Security issues
+
+If you have found a security related issue, please do not file an issue on
+GitHub or send a PR addressing the issue. Contact [Keygen](mailto:security@keygen.sh)
+directly. You will be given public credit for your disclosure.
+
+## Reporting issues
+
+Please try to answer the following questions in your bug report:
+
+- What did you do?
+- What did you expect to happen?
+- What happened instead?
+
+Make sure to include as much relevant information as possible. Ruby version,
+Rails version, `sql_matchers` version, OS version and any stack traces
+you have are very valuable.
+
+## Pull Requests
+
+- **Add tests!** Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour**. Make sure the README and any other
+  relevant documentation are kept up-to-date.
+
+- **Create topic branches**. Please don't ask us to pull from your master branch.
+
+- **One pull request per feature**. If you want to do more than one thing, send
+  multiple pull requests.
+
+- **Send coherent history**. Make sure each individual commit in your pull
+  request is meaningful. If you had to make multiple intermediate commits while
+  developing, please squash them before sending them to us.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 Keygen LLC
+
+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,131 @@
+# sql_matchers
+
+[![CI](https://github.com/keygen-sh/sql_matchers/actions/workflows/test.yml/badge.svg)](https://github.com/keygen-sh/sql_matchers/actions)
+[![Gem Version](https://badge.fury.io/rb/sql_matchers.svg)](https://badge.fury.io/rb/sql_matchers)
+
+Use `sql_matchers` to create temporary tables and models in RSpec specs,
+rather than create and maintain a dummy Rails application or messy block-level
+constants.
+
+This gem was extracted from [Keygen](https://keygen.sh).
+
+Sponsored by:
+
+<a href="https://keygen.sh?ref=sql_matchers">
+  <div>
+    <img src="https://keygen.sh/images/logo-pill.png" width="200" alt="Keygen">
+  </div>
+</a>
+
+_A fair source software licensing and distribution API._
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'sql_matchers'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sql_matchers
+```
+
+## Usage
+
+### `temporary_table`
+
+To define a temporary table:
+
+```ruby
+describe Example do
+  temporary_table :user do |t|
+    t.string :email
+    t.string :first_name
+    t.string :last_name
+    t.index :email, unique: true
+  end
+
+  it 'should define a table' do
+    expect(ActiveRecord::Base.connection.table_exists?(:user)).to be true
+  end
+end
+```
+
+The full Active Record schema API is available.
+
+### `temporary_model`
+
+To define an Active Record:
+
+```ruby
+describe Example do
+  temporary_model :user do
+    has_many :posts
+  end
+
+  it 'should define a record' do
+    expect(const_defined?(:User)).to be true
+  end
+end
+```
+
+To define an Active Model:
+
+```ruby
+describe Example do
+  temporary_model :guest_user, table_name: nil, base_class: nil do
+    include ActiveModel::Model
+  end
+
+  it 'should define a model' do
+    expect(const_defined?(:GuestUser)).to be true
+  end
+end
+```
+
+To define a PORO:
+
+```ruby
+describe Example do
+  temporary_model :null_user, table_name: nil, base_class: nil do
+    # ...
+  end
+
+  it 'should define a PORO' do
+    expect(const_defined?(:NullUser)).to be true
+  end
+end
+```
+
+## Future
+
+Right now, the gem only supports RSpec, but we're open to pull requests that
+extend the functionality to other testing frameworks.
+
+## Supported Rubies
+
+**`sql_matchers` supports Ruby 3.1 and above.** We encourage you to upgrade
+if you're on an older version. Ruby 3 provides a lot of great features, like
+better pattern matching and a new shorthand hash syntax.
+
+## Is it any good?
+
+Yes.
+
+## Contributing
+
+If you have an idea, or have discovered a bug, please open an issue or create a
+pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/SECURITY.md

@@ -0,0 +1,8 @@
+# Security Policy
+
+## Reporting a vulnerability
+
+If you find a vulnerability in `sql_matchers`, please contact Keygen via
+[email](mailto:security@keygen.sh).
+
+You will be given public credit for your disclosure.

data/lib/sql_matchers/loggers/query.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SqlMatchers
+  module Loggers
+    class Query
+      IGNORED_STATEMENTS   = %w[CACHE SCHEMA]
+      IGNORED_STATEMENT_RE = %r{^(?:ROLLBACK|BEGIN|COMMIT|SAVEPOINT|RELEASE)}
+      IGNORED_COMMENT_RE   = %r{
+        /\*(\w+='\w+',?)+\*/ # query log tags
+      }x
+
+      def initialize
+        @queries = []
+      end
+
+      def self.subscribe(&) = new.subscribe(&)
+      def subscribe(&block)
+        ActiveSupport::Notifications.subscribed(
+          logger_proc,
+          'sql.active_record',
+          &proc {
+            result = block.call
+            result.load if result in ActiveRecord::Relation # autoload relations
+          }
+        )
+
+        @queries
+      end
+
+      private
+
+      def logger_proc = proc(&method(:logger))
+      def logger(event)
+        unless IGNORED_STATEMENTS.include?(event.payload[:name]) || IGNORED_STATEMENT_RE.match(event.payload[:sql])
+          query = event.payload[:sql].gsub(IGNORED_COMMENT_RE, '')
+                                    .squish
+
+          @queries << query
+        end
+      end
+    end
+  end
+end

data/lib/sql_matchers/loggers.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SqlMatchers
+  module Loggers; end
+end

data/lib/sql_matchers/matchers/query.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../loggers/query'
+
+module SqlMatchers
+  module Matchers
+    class Query
+      def initialize(count: nil, &block)
+        @count = count
+        @block = block
+      end
+
+      def supports_block_expectations? = true
+      def supports_value_expectations? = true
+
+      def matches?(block)
+        @queries = Loggers::Query.subscribe(&block)
+
+        (@count.nil? || @queries.size == @count) && (
+          @block.nil? || @block.call(@queries)
+        )
+      end
+
+      def failure_message
+        "expected to match #{@count} queries but got #{@queries.size}"
+      end
+
+      def failure_message_when_negated
+        "expected to not match #{@count} queries"
+      end
+    end
+  end
+end

data/lib/sql_matchers/matchers/sql.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'anbt-sql-formatter/formatter'
+
+module SqlMatchers
+  module Matchers
+    class Sql
+      attr_reader :actual, :expected
+
+      def initialize(expected)
+        @expected  = expected
+        @formatter = AnbtSql::Formatter.new(
+          AnbtSql::Rule.new.tap do |r|
+            r.keyword         = AnbtSql::Rule::KEYWORD_UPPER_CASE
+            r.function_names += %w[count sum substr date]
+            r.indent_string   = '  '
+          end
+        )
+      end
+
+      def diffable? = true
+      def matches?(actual)
+        @expected = formatter.format(+expected.to_s.strip)
+        @actual   = formatter.format(+actual.to_s.strip)
+
+        @actual == @expected
+      end
+
+      def failure_message
+        <<~MSG
+          Expected SQL to match:
+            expected:
+              #{@expected.squish}
+            got:
+              #{@actual.squish}
+        MSG
+      end
+
+      private
+
+      attr_reader :formatter
+    end
+  end
+end

data/lib/sql_matchers/matchers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'matchers/query'
+require_relative 'matchers/sql'
+
+module SqlMatchers
+  module Matchers
+    def match_query(...)   = Query.new(...)
+    def match_queries(...) = match_query(...)
+    def match_sql(...)     = Sql.new(...)
+  end
+end

data/lib/sql_matchers/methods.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'matchers'
+
+module SqlMatchers
+  module Methods
+    include Matchers
+  end
+end

data/lib/sql_matchers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SqlMatchers
+  VERSION = '0.0.1'
+end

data/lib/sql_matchers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require_relative 'sql_matchers/methods'
+require_relative 'sql_matchers/version'
+
+module SqlMatchers; end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sql_matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zeke Gabrielse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: anbt-sql-formatter
+  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'
+- !ruby/object:Gem::Dependency
+  name: temporary_tables
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.rc.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.rc.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Query and SQL matchers for RSpec.
+email:
+- oss@keygen.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- SECURITY.md
+- lib/sql_matchers.rb
+- lib/sql_matchers/loggers.rb
+- lib/sql_matchers/loggers/query.rb
+- lib/sql_matchers/matchers.rb
+- lib/sql_matchers/matchers/query.rb
+- lib/sql_matchers/matchers/sql.rb
+- lib/sql_matchers/methods.rb
+- lib/sql_matchers/version.rb
+homepage: https://github.com/keygen-sh/sql_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: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key: 
+specification_version: 4
+summary: Query and SQL matchers for RSpec.
+test_files: []