rspec-activerecord-expectations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8090634964dbd7f2f5f8a386cfd0de07257d6f08cd6f9b14606982f983489815
+  data.tar.gz: 007eef50aa9f1eb61da08fba2a6e7eb6a4f4114c5e0b4fa68f2cb629d4ef86c6
+SHA512:
+  metadata.gz: 6c7072fc9e686e66c750e0e117515094d4b6cde5e764a8b07c750f3d8fa64cfd210f010c8816bbef6a6e0edd6c5af7983f6886e1c0fefe05de19b9a4bf2cf0af
+  data.tar.gz: 8196d1a03e6e7b1c73ab3b8524a759cadf554db7fee528a8a350df601661b0b21b7bb1cc3078ea852634aea64c5b6ba9c755ba9ce0232bcef46735e959dd57b1

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: [3.0, 2.7, 2.6, 2.5]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# this is a gem, don't track the specific deps

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.3

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [1.0.0] - 2020-12-30
+- Basic gem w/ all the fixins and README and such.
+- Add `less_than` comparison, and `queries` type.
+- Basic tests in place, and not bad tbh.
+ 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 302011+jmmastey@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Joseph Mastey
+
+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,158 @@
+# RSpec Activerecord Expectations
+
+Rspec::ActiveRecord::Expectations is a library for testing that your code
+doesn't execute too many queries during execution. In development mode, it's
+common to use gems like [bullet](https://github.com/flyerhzm/bullet), but no
+similar functionality exists in RSpec.
+
+Tests of this sort are useful when trying to write regression tests for code
+that frequently has N+1s introduced accidentally by new feature development.
+
+While it's possible to use
+[Benchmark.measure](https://ruby-doc.org/stdlib-2.7.3/libdoc/benchmark/rdoc/Benchmark.html#method-c-measure)
+to assert that runtime hasn't changed, tests typically run with a very small
+number of records. This can make it difficult to ascertain whether new problems
+have been introduced. That's because the natural variance in execution time for
+queries takes over the majority of runtime, so benchmarked times are no longer
+valid.
+
+This gem introduces a number of new expectation types for your tests that
+should make it easier to express the kinds of verification you're looking for.
+
+## Setup
+
+Setup is fairly straightforward. Add this gem to your `Gemfile` in the test
+group.
+
+```ruby
+group 'test' do
+  gem 'rspec-activerecord-expectations', '~> 1.0'
+end
+```
+
+Then, include the functionality within your spec helper (or in a support file).
+
+```ruby
+RSpec.configure do |config|
+  include RSpec::ActiveRecord::Expectations
+end
+```
+
+That's it! Easy peasy.
+
+## Basic Usage
+
+At its core, `Rspec::ActiveRecord::Expectations` is just a series of new
+matchers that you can apply to your tests. Let's take an example piece of app
+functionality.
+
+```ruby
+class WastefulnessReport
+  def perform
+    (1..100).each do |n|
+      ResourceType.find(n).summarize
+    end
+  end
+end
+```
+
+This report obviously needs some refactoring. Let's add a test.
+
+```ruby
+# spec/reports/wastefulness_report_spec.rb
+
+RSpec.describe WastefulnessReport do
+
+  it "is reasonably efficient" do
+    expect {
+      WastefulnessReport.new.perform
+    }.to execute.fewer_than(10).queries
+  end
+
+end
+```
+
+Running this example, we'll see a usefully failing test!
+
+```ruby
+Failures:
+
+  1) WastefulnessReport is reasonably efficient
+     Failure/Error:
+       expect {
+         WastefulnessReport.new.perform
+       }.to execute.fewer_than(10).queries
+
+       expected block to execute fewer than 10 queries, but it executed 100
+     # ./spec/reports/wastefulness_report_spec.rb:30:in `block (2 levels) in <top (required)>'
+```
+
+That's it! Refactor your report to be more efficient and then leave the test in
+place to make sure that future developers don't accidentally cause a
+performance regression.
+
+## Supported Matchers
+
+```ruby
+expect {}.to execute.fewer_than(20).queries
+expect {}.to execute.less_than(20).queries    # alias for fewer_than
+```
+
+## Future Planned Functionality
+
+This gem still has lots of future functionality. See below.
+
+```ruby
+expect {}.to execute.more_than(20).activerecord_queries
+expect {}.to execute.fewer_than(20).insert_queries
+expect {}.to execute.exactly(5).queries
+expect {}.to execute.at_least(5).handrolled_queries
+
+expect {}.to execute.less_than(20).delete_queries
+expect {}.to execute.less_than(20).load_queries
+expect {}.to execute.less_than(20).schema_queries
+expect {}.to execute.less_than(20).exists_queries
+expect {}.to execute.less_than(20).queries
+expect {}.to execute.less_than(20).queries_of_type("Audited::Audit Load")
+
+expect {}.not_to rollback_transaction.exactly(5).times
+expect {}.not_to commit_transaction.once
+expect {}.to run_a_transaction
+
+expect {}.to create.exactly(5).of_type(User)
+expect {}.to insert.exactly(5).subscription_changes
+expect {}.to update.exactly(2).of_any_type
+expect {}.to delete.exactly(2).of_any_type
+
+expect {}.not_to repeatedly_load(Audited::Audit)
+
+at_least, more_than, at_most, less_than, lteq?
+exactly(1) => once?
+```
+
+- ignore transactionals (begin / rollback)
+- `name: Foo Load`
+- differentiate AR queries from generic ones? arbitrary execution somehow?
+- warn about warmup
+- make sure we don't smite any built in methods (or from other libs)
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `rake spec` to run the tests.
+
+Bug reports and PRs are welcome at
+https://github.com/jmmastey/rspec-activerecord-expectations.
+
+## Code of Conduct
+
+Everyone interacting in the Rspec::Activerecord::Expectations project's
+codebases, issue trackers, chat rooms and mailing lists is expected to follow
+the [code of
+conduct](https://github.com/jmmastey/rspec-activerecord-expectations/blob/master/CODE_OF_CONDUCT.md).
+
+## Thanks
+
+This gem was heavily patterned after
+[shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers), a project
+by Thoughtbot that has some seriously complex matchers. Thanks y'all.

data/lib/rspec/activerecord/expectations/collector.rb

@@ -0,0 +1,23 @@
+module RSpec::ActiveRecord::Expectations
+  class Collector
+    def initialize
+      @counts = {
+        queries: 0
+      }
+
+      ActiveSupport::Notifications.subscribe("sql.active_record", method(:record_query))
+    end
+
+    def queries_of_type(type)
+      @counts.fetch(type)
+    end
+
+    def valid_type?(type)
+      @counts.include? type
+    end
+
+    def record_query(*_unused, data)
+      @counts[:queries] += 1
+    end
+  end
+end

data/lib/rspec/activerecord/expectations/errors.rb

@@ -0,0 +1,17 @@
+module RSpec::ActiveRecord::Expectations
+  class NoComparisonError < ArgumentError
+    def message
+      "You must provide an entire expectation " \
+      "(e.g. expect {}.to execute.less_than(n).queries). " \
+      "Try appending `less_than` to your expectation."
+    end
+  end
+
+  class NoQueryTypeError < ArgumentError
+    def message
+      "You must provide an entire expectation " \
+      "(e.g. expect {}.to execute.less_than(n).queries). " \
+      "Try appending `queries` to your expectation."
+    end
+  end
+end

data/lib/rspec/activerecord/expectations/matchers/query_count.rb

@@ -0,0 +1,57 @@
+module RSpec::ActiveRecord::Expectations
+  module Matchers
+    class QueryCountMatcher
+      attr_reader :failure_message, :failure_message_when_negated
+
+      def initialize
+        @collector = Collector.new
+
+        @match_method = nil
+        @comparison   = nil
+        @query_type   = nil
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def matches?(block)
+        raise NoComparisonError unless @match_method
+        raise NoQueryTypeError unless @collector.valid_type?(@query_type)
+
+        result    = block.call
+
+        !!@match_method.call
+      end
+
+      # COMPARISON TYPES
+
+      def fewer_than(n)
+        @comparison   = n
+        @match_method = method(:match_fewer_than)
+        self
+      end
+      alias_method :less_than, :fewer_than
+
+      # TARGET QUERY TYPES
+
+      def queries
+        @query_type = :queries
+        self
+      end
+
+      private
+
+      # MATCHERS
+
+      def match_fewer_than
+        count = @collector.queries_of_type(@query_type)
+
+        @failure_message = "expected block to execute fewer than #{@comparison} queries, but it executed #{count}"
+        @failure_message_when_negated = "expected block not to execute fewer than #{@comparison} queries, but it executed #{count}"
+
+        count < @comparison
+      end
+    end
+  end
+end

data/lib/rspec/activerecord/expectations.rb

@@ -0,0 +1,13 @@
+module RSpec
+  module ActiveRecord
+    module Expectations
+      def execute
+        Matchers::QueryCountMatcher.new
+      end
+    end
+  end
+end
+
+require_relative 'expectations/errors'
+require_relative 'expectations/collector'
+require_relative 'expectations/matchers/query_count'

data/lib/rspec/activerecord-expectations.rb

@@ -0,0 +1 @@
+require_relative 'activerecord/expectations'

data/rspec-activerecord-expectations.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-activerecord-expectations"
+  spec.version       = '1.0.0'
+  spec.authors       = ["Joseph Mastey"]
+  spec.email         = ["hello@joemastey.com"]
+
+  spec.summary       = %q{A gem to test how many activerecord queries your code executes.}
+  spec.description   = %q{Adds new matchers to rspec to help you test whether your code is executing an unreasonable number of queries.}
+  spec.homepage      = "https://github.com/jmmastey/rspec-activerecord-expectations"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/jmmastey/rspec-activerecord-expectations/blob/master/CHANGELOG.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 5.0", "< 7.0" # TODO run tests to loosen me
+  spec.add_dependency "sqlite3", "~> 1.0"
+
+  spec.add_development_dependency "pry", "~> 0.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rspec-activerecord-expectations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joseph Mastey
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: Adds new matchers to rspec to help you test whether your code is executing
+  an unreasonable number of queries.
+email:
+- hello@joemastey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/rspec/activerecord-expectations.rb
+- lib/rspec/activerecord/expectations.rb
+- lib/rspec/activerecord/expectations/collector.rb
+- lib/rspec/activerecord/expectations/errors.rb
+- lib/rspec/activerecord/expectations/matchers/query_count.rb
+- rspec-activerecord-expectations.gemspec
+homepage: https://github.com/jmmastey/rspec-activerecord-expectations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jmmastey/rspec-activerecord-expectations
+  source_code_uri: https://github.com/jmmastey/rspec-activerecord-expectations
+  changelog_uri: https://github.com/jmmastey/rspec-activerecord-expectations/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A gem to test how many activerecord queries your code executes.
+test_files: []