rspec-prosopite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54fc0df85ee71be1d78527d323716260477e4e260ce0bd99e3a6db2d854ebe12
+  data.tar.gz: ecdf05b07786bc132d765c2c98faadfe1d7a33e68d4310f59ff2f38e24420455
+SHA512:
+  metadata.gz: 90bd5947ba8530f8cc77b05f72acb496a6d97ae1c75872929eca9f4442c62993a4a2c14a668aca6dd71628fb61bad15dc853a5aee95f72d72702a2d395a6993d
+  data.tar.gz: c5df55b6cc1ee3857fbda1dba487828717f40ce934e24588731b585f5b031af1c0d87d4f2df7a7e1325f6f2d195ea658caa3bf04a2da55857bd66b12263a910d

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,9 @@
+fix: true
+parallel: true
+format: progress
+ruby_version: 2.7
+default_ignores: false
+
+ignore:
+  - 'spec/**/*':
+    - Layout/AlignHash

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Hiroshi Kajisha
+
+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,53 @@
+# RSpec::Prosopite
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rspec-prosopite
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rspec-prosopite
+
+## Usage
+
+### perform_queries matcher
+
+Use `perform_queries` matcher to detect N+1 query in your spec.
+
+```ruby
+it "N+1" do
+  expect { suspicious_something }.to perform_queries
+end
+```
+
+### allow_stack_paths
+
+If you want to allow some N+1, use allow_stack_paths or ignore_queries, like this:
+
+Except N+1 query in the method:
+```ruby
+expect { suspicious_something }.to perform_queries.allow_stack_paths([/method_name/])
+```
+
+Except N+1 query by SQL:
+```ruby
+expect { suspicious_something }.to perform_queries.ignore_queries([/SELECT \* FROM users/])
+```
+
+More details about `allow_stack_paths` and `ignore_queries`, see [prosopite](https://github.com/charkost/prosopite).
+
+## 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/kajisha/rspec-prosopite.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/rspec/matchers/perform_queries.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+::RSpec::Matchers.define :perform_queries do
+  supports_block_expectations
+
+  chain :ignore_queries do |queries|
+    Prosopite.ignore_queries = queries
+  end
+
+  chain :allow_stack_paths do |paths|
+    Prosopite.allow_stack_paths = paths
+  end
+
+  match(notify_expectation_failures: true) do |actual|
+    raise ArgumentError, "Block is required" unless actual.is_a?(Proc)
+
+    begin
+      Prosopite.scan { actual.call }
+    ensure
+      Prosopite.ignore_queries = []
+      Prosopite.allow_stack_paths = []
+    end
+  end
+end
+
+::RSpec.configure do |config|
+  config.before(:suite) do
+    Prosopite.raise = true
+  end
+end

data/lib/rspec/prosopite/version.rb

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

data/lib/rspec/prosopite.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "rspec-prosopite/rspec/prosopite"

data/lib/rspec-prosopite.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "prosopite"
+require "rspec"
+require "rspec/expectations"
+
+require_relative "rspec/prosopite/version"
+require_relative "rspec/matchers/perform_queries"
+
+module RSpec
+  module Prosopite
+  end
+end

data/rspec-prosopite.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec/prosopite/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rspec-prosopite"
+  spec.version = RSpec::Prosopite::VERSION
+  spec.authors = ["Hiroshi Kajisha"]
+  spec.email = ["kajisha@gmail.com"]
+
+  spec.summary = "RSpec matcher for Prosopite"
+  spec.description = "RSpec matcher  for Prosopite"
+  spec.homepage = "https://github.com/kajisha/rspec-prosopite"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "prosopite"
+  spec.add_dependency "rspec"
+end

data/sig/rspec/prosopite.rbs

@@ -0,0 +1,6 @@
+module Rspec
+  module Prosopite
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rspec-prosopite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiroshi Kajisha
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prosopite
+  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: rspec
+  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: RSpec matcher  for Prosopite
+email:
+- kajisha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-prosopite.rb
+- lib/rspec/matchers/perform_queries.rb
+- lib/rspec/prosopite.rb
+- lib/rspec/prosopite/version.rb
+- rspec-prosopite.gemspec
+- sig/rspec/prosopite.rbs
+homepage: https://github.com/kajisha/rspec-prosopite
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kajisha/rspec-prosopite
+  source_code_uri: https://github.com/kajisha/rspec-prosopite
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: RSpec matcher for Prosopite
+test_files: []