jiminy 0.1.0.pre1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed071d31bf26f4a0beaed34426656d9afbf1a99122b57d27aabcf58a03439910
-  data.tar.gz: 59c64b03f115328b28da4eb4fda6e573891c770845e97a584cc3d4e400816e37
+  metadata.gz: 0c2d7c5c5ca5c253b2c1c9962f4d2c846a1bf2ebb9ecbcfa4d5a254832dae2ec
+  data.tar.gz: 77f60976535c54d0e42205aedbca82067164b15956d1b0b7a44a49791a7d4de5
 SHA512:
-  metadata.gz: 7ec6ebd488281ebf37f80885fd7e824f9cccbcd076447afc91551d9a96791db4e801ae413305b565f920d090b3c79afda48f8cdceae8fd9d9f7cee3ce0c76f05
-  data.tar.gz: e02a8751271ccd992976f7a98b5fd636d7e3d369d4f1cf9e3eecead0fcc0a29fc56126e9181b526bfc1205c933436506de04d4c409593a13a72b8c2b92c2b1a6
+  metadata.gz: 8ee0316e181e196a2a091e68aedbfded41f0a4834f7c71370a71ba7fcaa512380a58d300aa79fae33e8302c13b7c1dd4796dce0027a3218ef25722d5c7983135
+  data.tar.gz: f15f0f87a0b1bdd97eed27e250f23b51c72049b8b86fcd9468a226b559a379d10ef0cc30deb7697dfe9c62b86b3e6a009984a7e698e4f4607dd99800566126d7

data/.rubocop.yml

@@ -1,3 +1,6 @@
+inherit_from:
+  - https://raw.githubusercontent.com/cookpad/global-style-guides/main/.rubocop.ruby.yml
+
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable

data/Gemfile.lock

@@ -1,91 +1,21 @@
 PATH
   remote: .
   specs:
-    jiminy (0.1.0.pre1)
-      octokit (>= 4, < 5)
-      prosopite (>= 1, < 2)
-      rails (>= 5, < 7.2)
-      thor (>= 1.2, < 2)
+    jiminy (0.2.0)
+      octokit (>= 4)
+      prosopite (>= 1)
+      rspec
+      thor (>= 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      actionview (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.2.2)
-      actionview (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      rack (~> 2.0, >= 2.2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.2.2)
-      activesupport (= 7.0.2.2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.2.2)
-      activesupport (= 7.0.2.2)
-      globalid (>= 0.3.6)
-    activemodel (7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activerecord (7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activestorage (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    builder (3.2.4)
     byebug (11.1.3)
-    concurrent-ruby (1.1.9)
-    crass (1.0.6)
     diff-lcs (1.5.0)
-    digest (3.1.0)
-    erubi (1.10.0)
-    faraday (1.9.3)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -108,124 +38,54 @@ GEM
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    io-wait (0.2.1)
-    loofah (2.14.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.15.0)
     multipart-post (2.1.1)
-    net-imap (0.2.3)
-      digest
-      net-protocol
-      strscan
-    net-pop (0.1.1)
-      digest
-      net-protocol
-      timeout
-    net-protocol (0.1.2)
-      io-wait
-      timeout
-    net-smtp (0.3.1)
-      digest
-      net-protocol
-      timeout
-    nio4r (2.5.8)
-    nokogiri (1.13.3-x86_64-darwin)
-      racc (~> 1.4)
     octokit (4.22.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    prosopite (1.0.7)
-    public_suffix (4.0.6)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (7.0.2.2)
-      actioncable (= 7.0.2.2)
-      actionmailbox (= 7.0.2.2)
-      actionmailer (= 7.0.2.2)
-      actionpack (= 7.0.2.2)
-      actiontext (= 7.0.2.2)
-      actionview (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      bundler (>= 1.15.0)
-      railties (= 7.0.2.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
+    prosopite (1.0.8)
+    public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.3.0)
     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.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.25.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.2)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.8.0)
+    rubocop-rspec (2.9.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    strscan (3.0.1)
     thor (1.2.1)
-    timeout (0.2.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
 
 PLATFORMS
   x86_64-darwin-20
@@ -238,8 +98,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
-  rubocop-rake (>= 0.6.0, < 1)
-  rubocop-rspec (>= 2, < 3)
+  rubocop-rake (>= 0.6.0)
+  rubocop-rspec (>= 2)
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -67,21 +67,39 @@ group :development, :test do
 end
 ```
 
-### Extending your test suite
+Then run the following command:
 
-Add the following in `spec/support.rb`:
+``` ruby
+$ bundle exec jiminy init
+```
+
+## Configuration
+
+The init command will add this file to your repo. Change the settings here to configure Jiminy:
 
 ``` ruby
-require "jiminy/rspec"
+# config/jiminy.rb
+Jiminy.configure do |config|
+  config.ci_workflow_name = "build_and_test"
 
-RSpec.configure do |config|
-  config.before(:suite) { Jiminy.reset_results_file! }
-  config.around do |example|
-    Jiminy.wrap_rspec_example(example)
-  end
+  config.project_username = "bodacious"
+
+  # NOTE: This is case sensitive on CircleCI
+  config.project_reponame = "jiminy"
+
+  config.circle_ci_api_token = ENV["CIRCLE_CI_API_TOKEN"]
+
+  config.github_token = ENV["GITHUB_TOKEN"]
+
+  # config.ignore_file_path =  File.join("./.jiminy_ignores.yml")
+
+  # config.temp_file_location = File.join("./tmp/jiminy/results.yml")
 end
 ```
 
+_NOTE: This file must be named `config/jiminy.rb` or **the gem will not detect the configuration**._
+
+
 ### Running the CLI
 
 ``` bash
@@ -114,32 +132,6 @@ Call the Jiminy CLI from a GitHub action:
     bundle exec jiminy report --commit ${{ github.event.pull_request.head.sha }} --pr-number=$PR_NUMBER --poll-interval=15 --timeout=300
 ```
 
-## Configuration
-
-Add an initializer to your Rails initializers directory:
-
-``` ruby
-# config/initializers/jiminy.rb
-Jiminy.configure do |config|
-  config.ci_workflow_name = "build_and_test"
-
-  config.project_username = "bodacious"
-
-  # NOTE: This is case sensitive on CircleCI
-  config.project_reponame = "jiminy"
-
-  config.circle_ci_api_token = ENV["CIRCLE_CI_API_TOKEN"]
-
-  config.github_token = ENV["GITHUB_TOKEN"]
-
-  # config.ignore_file_path =  File.join("./.jiminy_ignores.yml")
-
-  # config.temp_file_location = File.join("./tmp/jiminy/results.yml")
-end
-```
-
-_NOTE: This file must be named `config/initializers/jiminy.rb` or **the gem will not detect the configuration**._
-
 ## Ignoring instances
 
 If you're adding Jiminy to an existing app, you might want to silence some of the existing warnings and focus on preventing new n+1s being introduced.

data/Rakefile

@@ -9,4 +9,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i(spec rubocop)

data/exe/jiminy

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
 require "jiminy/setup"
 require "jiminy/cli"
 require "jiminy/reporting"

data/jiminy.gemspec

@@ -2,6 +2,7 @@
 
 require_relative "lib/jiminy/version"
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = "jiminy"
   spec.version       = Jiminy::VERSION
@@ -30,13 +31,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "octokit", ">= 4", "< 5"
-  spec.add_runtime_dependency "prosopite", ">= 1", "< 2"
-  spec.add_runtime_dependency "rails", ">= 5", "< 7.2"
-  spec.add_runtime_dependency "thor", ">= 1.2", "< 2"
+  spec.add_runtime_dependency "octokit", ">= 4"
+  spec.add_runtime_dependency "prosopite", ">= 1"
+  spec.add_runtime_dependency "rspec"
+  spec.add_runtime_dependency "thor", ">= 1.2"
   spec.add_development_dependency "byebug"
-  spec.add_development_dependency "rubocop", ">= 1", "< 2"
-  spec.add_development_dependency "rubocop-rake", ">= 0.6.0", "< 1"
-  spec.add_development_dependency "rubocop-rspec", ">= 2", "< 3"
+  spec.add_development_dependency "rubocop", ">= 1"
+  spec.add_development_dependency "rubocop-rake", ">= 0.6.0"
+  spec.add_development_dependency "rubocop-rspec", ">= 2"
   spec.metadata["rubygems_mfa_required"] = "true"
 end
+# rubocop:enable Metrics/BlockLength

data/lib/jiminy/cli.rb

@@ -2,16 +2,18 @@
 
 module Jiminy
   require "thor"
-  require "byebug"
   class CLI < Thor
     require "jiminy/reporting/ci_providers/circle_ci"
+    include Thor::Actions
     include Jiminy::Reporting::CIProviders
 
     class WorkflowStillRunningError < StandardError; end
     private_constant :WorkflowStillRunningError
 
-    MAX_TIMEOUT = 1800 # 1 hour
-    POLL_INTERVAL = 60 # 1 min
+    MAX_TIMEOUT_SECONDS = 1800
+    POLL_INTERVAL_SECONDS = 60
+
+    source_root File.expand_path("templates/", __dir__)
 
     def self.exit_on_failure?
       false
@@ -19,37 +21,41 @@ module Jiminy
 
     desc "Report results", "Reports the results of tests"
     method_option :commit, type: :string, aliases: "c", required: true,
-                           banner: "3e078f8770743549b722382ec5d412a30b9fdcc5",
-                           desc: "The full SHA for the current HEAD commit"
-    method_option :pr_number, type: :numeric, aliases: %w[pr p], required: true,
-                              banner: "1",
-                              desc: "The GitHub PR number"
+      banner: "3e078f8770743549b722382ec5d412a30b9fdcc5",
+      desc: "The full SHA for the current HEAD commit"
+    method_option :pr_number, type: :numeric, aliases: %w(pr p), required: true,
+      banner: "1",
+      desc: "The GitHub PR number"
     method_option :dry_run, type: :boolean, default: false, lazy_default: true,
-                            desc: "Print to STDOUT instead of leaving a comment on GitHub"
-    method_option :timeout, type: :numeric, aliases: %w[max-timeout], default: MAX_TIMEOUT,
-                            desc: "How long to poll CircleCI before timing out (in seconds)"
-    method_option :poll_interval, type: :numeric, aliases: %w[poll-interval], default: POLL_INTERVAL,
-                                  desc: "How frequently to poll CircleCI (in seconds)"
+      desc: "Print to STDOUT instead of leaving a comment on GitHub"
+    method_option :timeout, type: :numeric, aliases: %w(max-timeout), default: MAX_TIMEOUT_SECONDS,
+      desc: "How long to poll CircleCI before timing out (in seconds)"
+    method_option :poll_interval, type: :numeric, aliases: %w(poll-interval), default: POLL_INTERVAL_SECONDS,
+      desc: "How frequently to poll CircleCI (in seconds)"
     method_option :source, type: :string, default: "circleci",
-                           desc: "Where are the results.yml files we should report?"
+      desc: "Where are the results.yml files we should report?"
     def report
       self.start_time = Time.now
       artifact_urls = artifacts.map(&:url)
-
       Jiminy::Reporting.report!(*artifact_urls,
-                                pr_number: options[:pr_number],
-                                dry_run: options[:dry_run])
+        pr_number: options[:pr_number],
+        dry_run: options[:dry_run])
 
       $stdout.puts "Reported N+1s successfully"
       exit(0)
     end
 
+    desc "Install Jiminy", "Installs jiminy configuration files in your app"
+    def init
+      template("config.rb", "./config/jiminy.rb")
+    end
+
     # rubocop:disable Metrics/BlockLength
     no_tasks do
       attr_accessor :start_time
 
       def poll_interval
-        options[:poll_interval] || POLL_INTERVAL
+        options[:poll_interval] || POLL_INTERVAL_SECONDS
       end
 
       def source
@@ -57,7 +63,7 @@ module Jiminy
       end
 
       def max_timeout
-        options[:timeout] || MAX_TIMEOUT
+        options[:timeout] || MAX_TIMEOUT_SECONDS
       end
 
       def timed_out?
@@ -84,7 +90,7 @@ module Jiminy
         end
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/AbcSize
       def workflow
         @_workflow ||= begin
           result = CircleCI::Workflow.find(pipeline_id: pipeline.id, workflow_name: Jiminy.config.ci_workflow_name)
@@ -107,7 +113,7 @@ module Jiminy
           abort("Process timed out after #{Time.now - start_time} seconds")
         end
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/AbcSize
 
       def jobs
         @_jobs ||= CircleCI::Job.all(workflow_id: workflow.id)
@@ -127,8 +133,12 @@ module Jiminy
         Local::Artifact.all
       end
 
+      def test_job
+        @_test_job ||= jobs.detect { |job| job.name == Jiminy.config.ci_job_name }
+      end
+
       def artifacts_from_circle_ci
-        CircleCI::Artifact.all(job_number: jobs.first.job_number)
+        CircleCI::Artifact.all(job_number: test_job.job_number)
       end
       alias_method :artifacts_from_circleci, :artifacts_from_circle_ci
     end

data/lib/jiminy/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "logger"
+
 module Jiminy
   class Configuration
     DEFAULT_CONFIG_READER = -> { instance_variable_get(:"@_#{__callee__}" || raise_missing_required(__callee__)) }
@@ -34,6 +36,8 @@ module Jiminy
       end
     end
 
+    define_config :ci_job_name, default: "test"
+
     define_config :ci_workflow_name, default: "build"
 
     define_config :circle_ci_api_token
@@ -42,6 +46,8 @@ module Jiminy
 
     define_config :ignore_file_path, default: File.join("./jiminy_ignores.yml")
 
+    define_config :logger, default: Logger.new(IO::NULL)
+
     define_config :project_reponame
 
     define_config :project_username
@@ -58,25 +64,25 @@ module Jiminy
 
     private
 
-    def defined_configs_with_defaults
-      self.class.defined_configs.select { |_config_name, options| options[:default] }
-    end
+      def defined_configs_with_defaults
+        self.class.defined_configs.select { |_config_name, options| options[:default] }
+      end
 
-    def required_configs
-      self.class.defined_configs.select { |_config_name, options| options[:required] }
-    end
+      def required_configs
+        self.class.defined_configs.select { |_config_name, options| options[:required] }
+      end
 
-    def apply_defaults!
-      defined_configs_with_defaults.each do |config_name, options|
-        public_send(:"#{config_name}=", options[:default])
+      def apply_defaults!
+        defined_configs_with_defaults.each do |config_name, options|
+          public_send(:"#{config_name}=", options[:default])
+        end
       end
-    end
 
-    def raise_missing_required(config_name)
-      return unless required_configs.key?(config_name)
+      def raise_missing_required(config_name)
+        return unless required_configs.key?(config_name)
 
-      raise MissingConfigError, config_name
-    end
+        raise MissingConfigError, config_name
+      end
   end
 
   module ConfigurationMethods
@@ -93,5 +99,9 @@ module Jiminy
     def configured?
       !!configuration
     end
+
+    def logger
+      configuration.logger
+    end
   end
 end

data/lib/jiminy/github_apiable.rb

@@ -6,12 +6,12 @@ module Jiminy
 
     private
 
-    def env_config
-      @_env_config ||= Reporting::CIProviders::Github::Configuration.new
-    end
+      def env_config
+        @_env_config ||= Reporting::CIProviders::Github::Configuration.new
+      end
 
-    def client
-      @_client ||= Octokit::Client.new(access_token: env_config.github_token)
-    end
+      def client
+        @_client ||= Octokit::Client.new(access_token: env_config.github_token)
+      end
   end
 end

data/lib/jiminy/recording/n_plus_one.rb

@@ -5,21 +5,19 @@ module Jiminy
     class NPlusOne
       attr_reader :file, :location
 
-      LOCATION_MATCHER = /(?<file>.+\.rb):
-        (?<line>\d+):in\s`
-        (?:block\sin\s)?
-        (?<method_name>.+)'
-      /x.freeze
+      LOCATION_REGEXP = /^(?<file>[\w_\-\/.]+\.e?rb):(?<line>\d+):in\s`(?:block\sin\s)?(?<method>.+)'/x.freeze
 
       EXAMPLES_COUNT = 3
 
       def initialize(location:, queries: [])
         @location = location.to_s.strip
         @queries = queries
-        match = location.match(LOCATION_MATCHER)
-        @line = match[:line]
-        @method_name = match[:method_name]
-        @file = match[:file]
+        match_result = location.match(LOCATION_REGEXP)
+
+        @file = match_result[:file]
+        @line = match_result[:line]
+        @method_name = match_result[:method]
+
         freeze
       end
 
@@ -35,16 +33,16 @@ module Jiminy
 
       private
 
-      attr_reader :queries, :line, :method_name
+        attr_reader :queries, :line, :method_name
 
-      def attributes
-        {
-          "file" => file,
-          "line" => line,
-          "method" => method_name,
-          "examples" => queries.take(EXAMPLES_COUNT)
-        }
-      end
+        def attributes
+          {
+            "file" => file,
+            "line" => line,
+            "method" => method_name,
+            "examples" => queries.take(EXAMPLES_COUNT)
+          }
+        end
     end
   end
 end

data/lib/jiminy/recording/prosopite_ext/send_notifications_with_tmp_file.rb

@@ -35,9 +35,9 @@ module Jiminy
 
         private
 
-        def tmp_file_recorder
-          @_tmp_file_recorder ||= TmpFileRecorder.new
-        end
+          def tmp_file_recorder
+            @_tmp_file_recorder ||= TmpFileRecorder.new
+          end
       end
     end
   end

data/lib/jiminy/recording/prosopite_ext/tmp_file_recorder.rb

@@ -6,34 +6,46 @@ module Jiminy
       class TmpFileRecorder
         require_relative "../n_plus_one"
 
+        # rubocop:disable Metrics/AbcSize
         def record(location:, queries:)
           yaml_content = File.read(Jiminy.config.temp_file_location)
           array = YAML.safe_load(yaml_content)
           n_plus_one = NPlusOne.new(location: location, queries: queries)
 
-          array << n_plus_one.to_h unless location_in_array?(location, array) || filepath_ignored?(n_plus_one.file)
+          if filepath_ignored?(n_plus_one.file)
+            Jiminy.logger.debug { "Ignoring n+1 instance #{n_plus_one}" }
+            return
+          end
+
+          if location_in_array?(location, array)
+            Jiminy.logger.debug { "Already reported n+1 instance #{n_plus_one}" }
+            return
+          end
+
+          array << n_plus_one.to_h
           File.write(Jiminy.config.temp_file_location, array.to_yaml)
         end
+        # rubocop:enable Metrics/AbcSize
 
         private
 
-        def location_in_array?(location, array)
-          array.detect { |hash| hash.key?(location) }
-        end
+          def location_in_array?(location, array)
+            array.detect { |hash| hash.key?(location) }
+          end
 
-        def filepath_ignored?(filepath)
-          ignored_files.include?(filepath)
-        end
+          def filepath_ignored?(filepath)
+            ignored_files.include?(filepath)
+          end
 
-        def ignored_files
-          @_ignored_files ||= load_ignored_files
-        end
+          def ignored_files
+            @_ignored_files ||= load_ignored_files
+          end
 
-        def load_ignored_files
-          return [] unless File.exist?(Jiminy.config.ignore_file_path)
+          def load_ignored_files
+            return [] unless File.exist?(Jiminy.config.ignore_file_path)
 
-          YAML.load_file(Jiminy.config.ignore_file_path) || []
-        end
+            YAML.load_file(Jiminy.config.ignore_file_path) || []
+          end
       end
     end
   end

data/lib/jiminy/recording/rspec.rb

@@ -20,3 +20,9 @@ module Jiminy
     end
   end
 end
+RSpec.configure do |config|
+  config.before(:suite) { Jiminy.reset_results_file! }
+  config.around do |example|
+    Jiminy.wrap_rspec_example(example)
+  end
+end

data/lib/jiminy/recording/test_controller_concern.rb

@@ -11,16 +11,16 @@ module Jiminy
 
       private
 
-      def _test_n_plus_one_detection
-        yield and return if Prosopite.scan?
+        def _test_n_plus_one_detection
+          yield and return if Prosopite.scan?
 
-        begin
-          Prosopite.scan
-          yield
-        ensure
-          Prosopite.finish
+          begin
+            Prosopite.scan
+            yield
+          ensure
+            Prosopite.finish
+          end
         end
-      end
     end
   end
 end

data/lib/jiminy/reporting/ci_providers/circle_ci/api_request.rb

@@ -14,30 +14,30 @@ module Jiminy
           end
 
           def perform!
-            puts url
+            Jiminy.logger.debug { "API request: #@url" }
             response
           end
 
           private
 
-          attr_reader :url
+            attr_reader :url
 
-          def response
-            @_response ||= http.request(request)
-          end
+            def response
+              @_response ||= http.request(request)
+            end
 
-          def request
-            @_request ||= Net::HTTP::Get.new(url).tap do |req|
-              req[CIRCLE_TOKEN_HEADER] = Jiminy.config.circle_ci_api_token
+            def request
+              @_request ||= Net::HTTP::Get.new(url).tap do |req|
+                req[CIRCLE_TOKEN_HEADER] = Jiminy.config.circle_ci_api_token
+              end
             end
-          end
 
-          def http
-            @_http ||= Net::HTTP.new(url.host, url.port).tap do |http_instance|
-              http_instance.use_ssl = true
-              http_instance.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            def http
+              @_http ||= Net::HTTP.new(url.host, url.port).tap do |http_instance|
+                http_instance.use_ssl = true
+                http_instance.verify_mode = OpenSSL::SSL::VERIFY_NONE
+              end
             end
-          end
         end
       end
     end

data/lib/jiminy/reporting/ci_providers/circle_ci/artifact.rb

@@ -8,7 +8,9 @@ module Jiminy
           define_attribute_readers :url
 
           def self.all(job_number:)
-            fetch_api_resource("project/gh/#{Jiminy.config.repo_path}/#{job_number}/artifacts")
+            # TODO: Support different results names here
+            fetch_api_resource("project/gh/#{Jiminy.config.repo_path}/#{job_number}/artifacts").
+              select { |artifact| artifact.url.end_with?("jiminy/results.yml") }
           end
         end
       end

data/lib/jiminy/reporting/ci_providers/circle_ci/job.rb

@@ -5,7 +5,7 @@ module Jiminy
     module CIProviders
       module CircleCI
         class Job < Base
-          define_attribute_readers :job_number
+          define_attribute_readers :job_number, :name
 
           def self.all(workflow_id:)
             fetch_api_resource("workflow/#{workflow_id}/job")

data/lib/jiminy/reporting/ci_providers/circle_ci.rb

@@ -44,9 +44,9 @@ module Jiminy
 
           private
 
-          def match_data
-            @_match_data ||= ensure_env_variable("CIRCLE_PULL_REQUEST").match(PR_URL_MATCHERS)
-          end
+            def match_data
+              @_match_data ||= ensure_env_variable("CIRCLE_PULL_REQUEST").match(PR_URL_MATCHERS)
+            end
         end
       end
     end

data/lib/jiminy/reporting/ci_providers/provider_configuration.rb

@@ -16,12 +16,12 @@ module Jiminy
 
         private
 
-        def ensure_configuration(name)
-          value = Jiminy.config.public_send(name)
-          return value unless value.empty?
+          def ensure_configuration(name)
+            value = Jiminy.config.public_send(name)
+            return value unless value.empty?
 
-          raise("Please provide a value for Jiminy.config.#{name}")
-        end
+            raise("Please provide a value for Jiminy.config.#{name}")
+          end
       end
     end
   end

data/lib/jiminy/reporting/n_plus_one.rb

@@ -31,9 +31,9 @@ module Jiminy
 
       private
 
-      def markdown_template
-        @_markdown_template ||= File.read(File.join(TEMPLATES_DIR, "n_plus_one.md.erb"))
-      end
+        def markdown_template
+          @_markdown_template ||= File.read(File.join(TEMPLATES_DIR, "n_plus_one.md.erb"))
+        end
     end
   end
 end

data/lib/jiminy/reporting/reporters/base_reporter.rb

@@ -15,11 +15,11 @@ module Jiminy
 
         private
 
-        attr_reader :header, :body
+          attr_reader :header, :body
 
-        def report_body
-          "#{header}\n\n#{body}"
-        end
+          def report_body
+            "#{header}\n\n#{body}"
+          end
       end
     end
   end

data/lib/jiminy/reporting/reporters/github_reporter.rb

@@ -19,9 +19,9 @@ module Jiminy
 
         private
 
-        attr_reader :pr_number
+          attr_reader :pr_number
 
-        alias comment_body report_body
+          alias comment_body report_body
       end
     end
   end

data/lib/jiminy/reporting/yaml_file_comment_presenter.rb

@@ -7,8 +7,6 @@ module Jiminy
       require "yaml"
       require "jiminy/github_apiable"
 
-      class MissingFileError < StandardError; end
-
       include GithubAPIable
 
       INSTANCE_SEPARATOR = "\n"
@@ -26,46 +24,46 @@ module Jiminy
 
       private
 
-      attr_reader :source_filepath, :pr_number
+        attr_reader :source_filepath, :pr_number
 
-      def instances
-        @_instances ||= YAML.safe_load(file_content).map do |hash|
-          options = hash.values.first.transform_keys!(&:to_sym)
-          NPlusOne.new(**options)
+        def instances
+          @_instances ||= YAML.safe_load(file_content).map do |hash|
+            options = hash.values.first.transform_keys!(&:to_sym)
+            NPlusOne.new(**options)
+          end
         end
-      end
 
-      def file_content
-        @_file_content ||= file_content_for_filepath(source_filepath)
-      end
+        def file_content
+          @_file_content ||= file_content_for_filepath(source_filepath)
+        end
 
-      def file_content_for_filepath(source_filepath)
-        return file_content_for_remote_file(source_filepath) if source_filepath.start_with?("https://")
+        def file_content_for_filepath(source_filepath)
+          return file_content_for_remote_file(source_filepath) if source_filepath.start_with?("https://")
 
-        file_content_for_local_file(source_filepath)
-      end
+          file_content_for_local_file(source_filepath)
+        end
 
-      def file_content_for_remote_file(source_filepath)
-        URI.parse(source_filepath).open({ "Circle-Token" => ENV["CIRCLE_CI_API_TOKEN"] }).read
-      end
+        def file_content_for_remote_file(source_filepath)
+          URI.parse(source_filepath).open({ "Circle-Token" => ENV["CIRCLE_CI_API_TOKEN"] }).read
+        end
 
-      def file_content_for_local_file(source_filepath)
-        File.read(source_filepath)
-      end
+        def file_content_for_local_file(source_filepath)
+          File.read(source_filepath)
+        end
 
-      def build_comment_body
-        instances.map do |instance|
-          file = file_from_instance(instance)
-          instance.blob_url = file.blob_url
-          instance.to_markdown
-        end.join(INSTANCE_SEPARATOR)
-      end
+        def build_comment_body
+          Array(instances).map do |instance|
+            file = file_from_instance(instance) || next
+            instance.blob_url = file.blob_url
+            instance.to_markdown
+          end.compact.join(INSTANCE_SEPARATOR)
+        end
 
-      def file_from_instance(instance)
-        client.pull_request_files(env_config.repo_path, pr_number).detect do |file|
-          file.filename == instance.file
-        end or raise(MissingFileError)
-      end
+        def file_from_instance(instance)
+          client.pull_request_files(env_config.repo_path, pr_number).detect do |file|
+            file.filename == instance.file
+          end
+        end
     end
   end
 end

data/lib/jiminy/reporting.rb

@@ -21,11 +21,14 @@ module Jiminy
       comment_content = yaml_files.map do |yaml_file|
         YAMLFileCommentPresenter.new(source_filepath: yaml_file, pr_number: options[:pr_number]).to_s
       end.join(LINE_SEPARATOR)
+
+      return if comment_content.strip.empty?
+
       if options[:dry_run]
         Reporters::DryRunReporter.new(header: COMMENT_HEADER, body: comment_content).report!
       else
         Reporters::GithubReporter.new(header: COMMENT_HEADER, body: comment_content,
-                                      pr_number: options[:pr_number]).report!
+          pr_number: options[:pr_number]).report!
       end
     end
   end

data/lib/jiminy/setup.rb

@@ -5,6 +5,6 @@ require_relative "configuration"
 Jiminy.extend(Jiminy::ConfigurationMethods)
 
 begin
-  load "./config/initializers/jiminy.rb"
+  load "./config/jiminy.rb"
 rescue LoadError; nil
 end

data/lib/jiminy/templates/config.rb

@@ -0,0 +1,15 @@
+Jiminy.configure do |config|
+  config.ci_workflow_name = "build_and_test"
+
+  config.project_username = "<your github username>"
+
+  config.project_reponame = Rails.application.name
+
+  config.circle_ci_api_token = ENV["CIRCLE_CI_API_TOKEN"]
+
+  config.github_token = ENV["GITHUB_TOKEN"]
+
+  config.ignore_file_path = File.join("./.jiminy_ignores.yml")
+
+  config.temp_file_location = File.join("./tmp/jiminy/results.yml")
+end

data/lib/jiminy/templates/reporting/n_plus_one.md.erb

@@ -2,7 +2,7 @@
 - [<%= file %>](<%= blob_url_with_line %>)
 
   <details>
-    <summary>SQL sample from the issue detected</summary>
+    <summary>Click to view samples of this issue</summary>
 
     ``` sql
     <%- for example in examples %>

data/lib/jiminy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jiminy
-  VERSION = "0.1.0.pre1"
+  VERSION = "0.2.0"
 end

data/lib/jiminy.rb

@@ -3,6 +3,7 @@
 require_relative "jiminy/version"
 require_relative "jiminy/setup"
 require_relative "jiminy/recording" if defined?(Rails)
+require_relative "jiminy/rspec" if defined?(Rspec) && ENV["RAILS_ENV"] == "test"
 
 module Jiminy
   module_function

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jiminy
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bodacious
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: prosopite
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,29 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -77,9 +59,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -87,9 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -111,9 +87,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -121,9 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -131,9 +101,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -141,9 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -151,9 +115,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -161,9 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 description: 'Wraps around your CI integration to detect and warn about n+1 queries
   before they''re merged
 
@@ -221,6 +179,7 @@ files:
 - lib/jiminy/reporting/yaml_file_comment_presenter.rb
 - lib/jiminy/rspec.rb
 - lib/jiminy/setup.rb
+- lib/jiminy/templates/config.rb
 - lib/jiminy/templates/reporting/comment_header.md.erb
 - lib/jiminy/templates/reporting/n_plus_one.md.erb
 - lib/jiminy/version.rb
@@ -243,9 +202,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key: