jiminy 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26a3afee95d97458dce74ea14893726e5edb8111c2db4bb362c557536fb3be44
-  data.tar.gz: 034cb7891aee6949d476dd8b519cca22764ff09623e92f10d0e576cef5b42753
+  metadata.gz: c6d04e4d260d197712f1b3772110fd5ef1026ab903838746a7e97b229815c0b3
+  data.tar.gz: afafff4e148443368dc94297beecc151708ecae6f6e4f008b9fb70226d68b3b7
 SHA512:
-  metadata.gz: 75ead9773e96336b05bf9fc72fa1757efc3860215b4fd585948bc3fa17df5cc9ea46f273b5cab66cbce951e7796641695c5be94444db145ca507008bea70cb4f
-  data.tar.gz: a0857f6f144d878d86f04eba20f040919eef944cb3bfcbbab698b2e32953410bccb627235f45b38f97613a1cb6bfca461682d56c066bd3f49cdff009d7839598
+  metadata.gz: 385cc76c40a7954e820d5f3f55a187407fb65934d378b487d0cf22a5efea2a1d56b8082930779332cd4e8e86b4a8c6353535cfba11cdfb97b804d4570ee15bd0
+  data.tar.gz: faa1fc3009eab77ee0237ad42326e1cc86c0ff26441bedcbd299107245299fd1380948a2b98db2968f01e256645482e94eba8e84e3e6548b70b276e6c0270c21

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jiminy (0.1.0)
+    jiminy (0.3.0)
       octokit (>= 4)
       prosopite (>= 1)
       rspec

data/lib/jiminy/cli/exit_codes/base.rb

@@ -0,0 +1,11 @@
+module Jiminy
+  class CLI
+    module ExitCodes
+      Base = Struct.new(:message, :value) do
+        def to_s
+          message
+        end
+      end
+    end
+  end
+end

data/lib/jiminy/cli/exit_codes/pipeline_not_found.rb

@@ -0,0 +1,11 @@
+module Jiminy
+  class CLI
+    module ExitCodes
+      class PipelineNotFound < Base
+        def initialize(git_revision:)
+          super("No such Pipeline with commit SHA #{git_revision}", 1)
+        end
+      end
+    end
+  end
+end

data/lib/jiminy/cli/exit_codes/process_timeout.rb

@@ -0,0 +1,11 @@
+module Jiminy
+  class CLI
+    module ExitCodes
+      class ProcessTimeout < Base
+        def initialize(start_time:)
+          super("Process timed out after #{Time.now - start_time} seconds", 1)
+        end
+      end
+    end
+  end
+end

data/lib/jiminy/cli/exit_codes/success.rb

@@ -0,0 +1,11 @@
+module Jiminy
+  class CLI
+    module ExitCodes
+      class Success < Base
+        def initialize
+          super("Reported N+1s successfully", 0)
+        end
+      end
+    end
+  end
+end

data/lib/jiminy/cli/exit_codes/workflow_not_found.rb

@@ -0,0 +1,11 @@
+module Jiminy
+  class CLI
+    module ExitCodes
+      class WorkflowNotFound < Base
+        def initialize(pipeline_id:, workflow_name:)
+          super("Unable to find workflow called '#{workflow_name}' in Pipeline #{pipeline_id}", 1)
+        end
+      end
+    end
+  end
+end

data/lib/jiminy/cli/exit_codes/workflow_not_success.rb

@@ -0,0 +1,11 @@
+module Jiminy
+  class CLI
+    module ExitCodes
+      class WorkflowNotSuccess < Base
+        def initialize(status:)
+          super("Workflow #{status}—aborting...", 0)
+        end
+      end
+    end
+  end
+end

data/lib/jiminy/cli/exit_codes.rb

@@ -0,0 +1,6 @@
+require_relative "exit_codes/base"
+require_relative "exit_codes/pipeline_not_found"
+require_relative "exit_codes/process_timeout"
+require_relative "exit_codes/success"
+require_relative "exit_codes/workflow_not_found"
+require_relative "exit_codes/workflow_not_success"

data/lib/jiminy/cli.rb

@@ -4,6 +4,8 @@ module Jiminy
   require "thor"
   class CLI < Thor
     require "jiminy/reporting/ci_providers/circle_ci"
+    require "jiminy/cli/exit_codes"
+
     include Thor::Actions
     include Jiminy::Reporting::CIProviders
 
@@ -41,8 +43,7 @@ module Jiminy
         pr_number: options[:pr_number],
         dry_run: options[:dry_run])
 
-      $stdout.puts "Reported N+1s successfully"
-      exit(0)
+      finish(ExitCodes::Success)
     end
 
     desc "Install Jiminy", "Installs jiminy configuration files in your app"
@@ -54,6 +55,16 @@ module Jiminy
     no_tasks do
       attr_accessor :start_time
 
+      def finish(exit_code_klass, *args, **kwargs)
+        exit_code = exit_code_klass.new(*args, **kwargs)
+        if exit_code.value == 0
+          puts exit_code
+        else
+          warn exit_code
+        end
+        exit(exit_code.value)
+      end
+
       def poll_interval
         options[:poll_interval] || POLL_INTERVAL_SECONDS
       end
@@ -80,7 +91,7 @@ module Jiminy
 
       def pipeline
         @_pipeline ||= CircleCI::Pipeline.find_by_revision(git_revision: git_revision, pr_number: pr_number) or
-          abort("No such Pipeline with commit SHA #{git_revision}")
+          finish(ExitCodes::PipelineNotFound, git_revision: git_revision)
       end
 
       def missing_options
@@ -95,14 +106,18 @@ module Jiminy
         @_workflow ||= begin
           result = CircleCI::Workflow.find(pipeline_id: pipeline.id, workflow_name: Jiminy.config.ci_workflow_name)
           if result.nil?
-            abort("Unable to find workflow called '#{Jiminy.config.ci_workflow_name}' in Pipeline #{pipeline.id}")
+            finish(ExitCodes::WorkflowNotFound,
+              workflow_name: Jiminy.config.ci_workflow_name,
+              pipeline_id: pipeline.id)
           end
 
           if result.not_run? || result.running?
             $stdout.puts "Workflow still running..."
             raise(WorkflowStillRunningError)
           end
-          abort("Workflow #{result.status}—aborting...") unless result.success?
+          unless result.success?
+            finish(ExitCodes::WorkflowNotSuccess, status: result.status)
+          end
 
           result
         rescue WorkflowStillRunningError
@@ -110,7 +125,7 @@ module Jiminy
           $stdout.puts "Retrying..."
           retry unless timed_out?
 
-          abort("Process timed out after #{Time.now - start_time} seconds")
+          finish(ExitCodes::ProcessTimeout, start_time: start_time)
         end
       end
       # rubocop:enable Metrics/AbcSize

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

@@ -6,24 +6,26 @@ 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)
 
           if filepath_ignored?(n_plus_one.file)
-            Jiminy.logger.debug("Ignoring n+1 instance #{n_plus_one}")
+            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}")
+            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
 

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

@@ -14,7 +14,7 @@ module Jiminy
           end
 
           def perform!
-            Jiminy.logger.debug("API request: #@url")
+            Jiminy.logger.debug { "API request: #@url" }
             response
           end
 

data/lib/jiminy/reporting.rb

@@ -21,6 +21,9 @@ 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

data/lib/jiminy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jiminy
-  VERSION = "0.1.0"
+  VERSION = "0.3.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
+  version: 0.3.0
 platform: ruby
 authors:
 - Bodacious
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -149,6 +149,13 @@ files:
 - jiminy.gemspec
 - lib/jiminy.rb
 - lib/jiminy/cli.rb
+- lib/jiminy/cli/exit_codes.rb
+- lib/jiminy/cli/exit_codes/base.rb
+- lib/jiminy/cli/exit_codes/pipeline_not_found.rb
+- lib/jiminy/cli/exit_codes/process_timeout.rb
+- lib/jiminy/cli/exit_codes/success.rb
+- lib/jiminy/cli/exit_codes/workflow_not_found.rb
+- lib/jiminy/cli/exit_codes/workflow_not_success.rb
 - lib/jiminy/configuration.rb
 - lib/jiminy/github_apiable.rb
 - lib/jiminy/recording.rb