jiminy 0.1.0.pre1

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "provider_configuration"
+
+require_relative "circle_ci/base"
+require_relative "circle_ci/api_request"
+require_relative "circle_ci/artifact"
+require_relative "circle_ci/job"
+require_relative "circle_ci/pipeline"
+require_relative "circle_ci/vcs"
+require_relative "circle_ci/workflow"
+
+module Jiminy
+  module Reporting
+    module CIProviders
+      module CircleCI
+        # Not currently used, but kept for future use.
+        class Configuration < ProviderConfiguration
+          PR_URL_MATCHERS = %r{github\.com/
+            (?<username>[\w\-_]+)/
+            (?<reponame>[\w\-_]+)/
+            pull/
+            (?<pr_number>\d+)}x.freeze
+
+          def repo_path
+            [project_username, project_reponame].join("/")
+          end
+
+          def pr_number
+            match_data[:pr_number]
+          end
+
+          def project_username
+            match_data[:username]
+          end
+
+          def project_reponame
+            match_data[:reponame]
+          end
+
+          def github_token
+            ensure_env_variable("GITHUB_TOKEN")
+          end
+
+          private
+
+          def match_data
+            @_match_data ||= ensure_env_variable("CIRCLE_PULL_REQUEST").match(PR_URL_MATCHERS)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "provider_configuration"
+
+module Jiminy
+  module Reporting
+    module CIProviders
+      module Github
+        class Configuration < ProviderConfiguration
+          def repo_path
+            ensure_configuration(:repo_path)
+          end
+
+          def project_username
+            repo_path.to_s.split("/").first
+          end
+
+          def project_reponame
+            repo_path.to_s.split("/").last
+          end
+
+          def github_token
+            ensure_configuration(:github_token)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    module CIProviders
+      module Local
+        class Artifact
+          attr_accessor :url
+
+          def self.all
+            Dir[Jiminy.configuration.temp_file_location].map do |filepath|
+              new(url: filepath)
+            end
+          end
+
+          def initialize(attributes)
+            attributes.each do |key, value|
+              public_send(:"#{key}=", value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "provider_configuration"
+require_relative "local/artifact"
+
+module Jiminy
+  module Reporting
+    module CIProviders
+      module Local
+        class Configuration < ProviderConfiguration
+          def repo_path
+            ensure_configuration(:repo_path)
+          end
+
+          def project_username
+            repo_path.to_s.split("/").first
+          end
+
+          def project_reponame
+            repo_path.to_s.split("/").last
+          end
+
+          def github_token
+            ensure_configuration(:github_token)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    module CIProviders
+      class ProviderConfiguration
+        TEMPLATE_METHOD_PROC = -> { raise NotImplementedError, "Define #{__callee__} in #{self}" }
+
+        define_method(:repo_path, TEMPLATE_METHOD_PROC)
+
+        define_method(:project_username, TEMPLATE_METHOD_PROC)
+
+        define_method(:project_reponame, TEMPLATE_METHOD_PROC)
+
+        define_method(:github_token, TEMPLATE_METHOD_PROC)
+
+        private
+
+        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
+      end
+    end
+  end
+end

data/lib/jiminy/reporting/ci_providers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    module CIProviders
+      require_relative "ci_providers/provider_configuration"
+      require_relative "ci_providers/circle_ci"
+      require_relative "ci_providers/github"
+      require_relative "ci_providers/local"
+    end
+  end
+end

data/lib/jiminy/reporting/n_plus_one.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    class NPlusOne
+      require "erb"
+
+      # https://docs.ruby-lang.org/en/2.3.0/ERB.html#method-c-new
+      ERB_SAFE_LEVEL = nil
+
+      TRIM_MODE = "-"
+
+      attr_reader :file, :line, :method, :examples
+
+      attr_accessor :blob_url
+
+      def initialize(file:, line:, method:, examples: [])
+        @examples = examples
+        @file = file
+        @line = line
+        @method = method
+      end
+
+      def to_markdown
+        ERB.new(markdown_template, trim_mode: TRIM_MODE).result(binding)
+      end
+
+      def blob_url_with_line
+        "#{blob_url}#L#{line}"
+      end
+
+      private
+
+      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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    module Reporters
+      class BaseReporter
+        def initialize(header:, body:)
+          @header = header
+          @body   = body
+        end
+
+        def report!
+          raise NotImplementedError, "Please define #{report!} in #{self}"
+        end
+
+        private
+
+        attr_reader :header, :body
+
+        def report_body
+          "#{header}\n\n#{body}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    module Reporters
+      class DryRunReporter < BaseReporter
+        def report!
+          $stdout.puts report_body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    module Reporters
+      class GithubReporter < BaseReporter
+        require "jiminy/github_apiable"
+
+        include GithubAPIable
+
+        def initialize(header:, body:, pr_number:)
+          super(header: header, body: body)
+          @pr_number = pr_number
+        end
+
+        def report!
+          client.add_comment(env_config.repo_path, pr_number, comment_body)
+        end
+
+        private
+
+        attr_reader :pr_number
+
+        alias comment_body report_body
+      end
+    end
+  end
+end

data/lib/jiminy/reporting/reporters.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    module Reporters
+      require_relative "reporters/base_reporter"
+      require_relative "reporters/dry_run_reporter"
+      require_relative "reporters/github_reporter"
+    end
+  end
+end

data/lib/jiminy/reporting/yaml_file_comment_presenter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    class YAMLFileCommentPresenter
+      require "open-uri"
+      require "yaml"
+      require "jiminy/github_apiable"
+
+      class MissingFileError < StandardError; end
+
+      include GithubAPIable
+
+      INSTANCE_SEPARATOR = "\n"
+
+      def initialize(source_filepath:, pr_number:)
+        @source_filepath = source_filepath
+        @pr_number = pr_number
+      end
+
+      def comment_body
+        @_comment_body ||= build_comment_body
+      end
+
+      alias to_s comment_body
+
+      private
+
+      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)
+        end
+      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://")
+
+        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_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 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
+    end
+  end
+end

data/lib/jiminy/reporting.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Jiminy
+  module Reporting
+    require_relative "reporting/n_plus_one"
+    require_relative "reporting/yaml_file_comment_presenter"
+    require_relative "reporting/ci_providers"
+    require_relative "reporting/reporters"
+
+    TEMPLATES_DIR = File.expand_path("templates/reporting", __dir__).freeze
+
+    COMMENT_HEADER = ERB.new(File.read(File.join(TEMPLATES_DIR, "comment_header.md.erb"))).result.freeze
+
+    LINE_SEPARATOR = "\n"
+
+    module_function
+
+    def report!(*yaml_files, **options)
+      return if yaml_files.empty?
+
+      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)
+      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!
+      end
+    end
+  end
+end

data/lib/jiminy/rspec.rb

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

data/lib/jiminy/setup.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "configuration"
+
+Jiminy.extend(Jiminy::ConfigurationMethods)
+
+begin
+  load "./config/initializers/jiminy.rb"
+rescue LoadError; nil
+end

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

@@ -0,0 +1,5 @@
+It looks like the following changes might have introduced new N+1 queries.
+
+Please investigate this issue before merging these changes into `main`.
+
+(You can ignore this issue by adding the file path to `.jiminy_ignores.yml`)

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

@@ -0,0 +1,12 @@
+
+- [<%= file %>](<%= blob_url_with_line %>)
+
+  <details>
+    <summary>SQL sample from the issue detected</summary>
+
+    ``` sql
+    <%- for example in examples %>
+    <%= example -%>
+    <% end %>
+    ```
+  </details>

data/lib/jiminy/version.rb

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

data/lib/jiminy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "jiminy/version"
+require_relative "jiminy/setup"
+require_relative "jiminy/recording" if defined?(Rails)
+
+module Jiminy
+  module_function
+
+  def reset_results_file!
+    Jiminy::Recording.reset_results_file!
+  end
+end