pig-ci-rails 0.2.0 → 1.1.0

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
 
   RSpec::Core::RakeTask.new(:spec)
 

data/config/locales/pig_ci/en.yml

@@ -1,10 +1,5 @@
 en:
   pig_ci:
-    api:
-      reports:
-        success: 'PigCI: Successfully submitted report to pigci.com'
-        error: 'Unable to connect to PigCI API: %{error}'
-        api_error: 'Unable to connect to PigCI API'
     summary:
       ci_start: 'PigCI Thresholds Summary:'
       ci_failure: 'PigCI: This commit has exceeded the thresholds defined in PigCI.thresholds'
@@ -13,7 +8,7 @@ en:
       view_historic_reports: 'Historic Reports'
       footer_html: |
         <p>Generated <time datetime="%{generated_at}">%{generated_at}</time> by PigCI.</p>
-        <p>Support <a href="https://pigci.com/" target="_blank" rel="noopener">PigCI</a> by <a href="https://github.com/apps/pigci/installations/new" target="_blank" rel="noopener">adding us on GitHub</a>.</p>
+        <p>Support <a href="https://pigci.mikerogers.io/" target="_blank" rel="noopener">PigCI</a> by <a href="https://www.buymeacoffee.com/MikeRogers0" target="_blank" rel="noopener">buying me a coffee</a>.</p>
 
     report:
       memory:

data/lib/pig_ci.rb

@@ -1,30 +1,42 @@
-require 'active_support'
-require 'active_support/core_ext/string/inflections'
-require 'rake'
-
-require 'pig_ci/version'
-require 'pig_ci/api'
-require 'pig_ci/configuration'
-require 'pig_ci/decorator'
-require 'pig_ci/summary'
-require 'pig_ci/profiler_engine'
-require 'pig_ci/profiler'
-require 'pig_ci/metric'
-require 'pig_ci/report'
+require "active_support"
+require "active_support/core_ext/string/inflections"
+require "rake"
+
+require "pig_ci/version"
+require "pig_ci/configuration"
+require "pig_ci/decorator"
+require "pig_ci/summary"
+require "pig_ci/profiler_engine"
+require "pig_ci/profiler"
+require "pig_ci/metric"
+require "pig_ci/report"
+require "pig_ci/test_frameworks"
 
 module PigCI
   extend self
 
   attr_accessor :pid
 
+  attr_writer :enabled
+  def enabled?
+    @enabled.nil? ? true : @enabled
+  end
+
+  # Rails caches repeated queries within the same request. You can not count
+  # any cached queries if you'd like.
+  attr_writer :ignore_cached_queries
+  def ignore_cached_queries?
+    @ignore_cached_queries.nil? ? false : @ignore_cached_queries
+  end
+
   attr_writer :tmp_directory
   def tmp_directory
-    @tmp_directory || Pathname.new(Dir.getwd).join('tmp', 'pig-ci')
+    @tmp_directory || Pathname.new(Dir.getwd).join("tmp", "pig-ci")
   end
 
   attr_writer :output_directory
   def output_directory
-    @output_directory || Pathname.new(Dir.getwd).join('pig-ci')
+    @output_directory || Pathname.new(Dir.getwd).join("pig-ci")
   end
 
   attr_accessor :generate_terminal_summary
@@ -88,29 +100,19 @@ module PigCI
     @profiler_engine ||= PigCI::ProfilerEngine::Rails.new
   end
 
-  attr_writer :api_base_uri
-  def api_base_uri
-    @api_base_uri || 'https://api.pigci.com/api'
-  end
-
-  attr_accessor :api_verify_ssl
-  def api_verify_ssl?
-    !@api_verify_ssl.nil? ? @api_verify_ssl : true
-  end
-
-  attr_accessor :api_key
-  def api_key?
-    !@api_key.nil? && @api_key != ''
-  end
-
   attr_writer :commit_sha1
   def commit_sha1
-    @commit_sha1 || ENV['CI_COMMIT_ID'] || ENV['CIRCLE_SHA1'] || ENV['TRAVIS_COMMIT'] || `git rev-parse HEAD`.strip
+    @commit_sha1 || ENV["CI_COMMIT_ID"] || ENV["CIRCLE_SHA1"] || ENV["TRAVIS_COMMIT"] || `git rev-parse HEAD`.strip
   end
 
   attr_writer :head_branch
   def head_branch
-    @head_branch || ENV['CI_BRANCH'] || ENV['CIRCLE_BRANCH'] || ENV['TRAVIS_BRANCH'] || `git rev-parse --abbrev-ref HEAD`.strip
+    @head_branch || ENV["CI_BRANCH"] || ENV["CIRCLE_BRANCH"] || ENV["TRAVIS_BRANCH"] || `git rev-parse --abbrev-ref HEAD`.strip
+  end
+
+  # Throw deprecation notice for setting API
+  def api_key=(value)
+    puts "DEPRECATED: PigCI.com API has been retired, you no longer need to set config.api_key in your spec/rails_helper.rb file."
   end
 
   attr_writer :locale
@@ -130,8 +132,9 @@ module PigCI
 
   def start(&block)
     self.pid = Process.pid
+    PigCI::TestFrameworks::Rspec.configure! if defined?(::RSpec)
 
-    block.call(self) if block_given?
+    block&.call(self)
 
     # Add our translations
     load_i18ns!
@@ -146,7 +149,7 @@ module PigCI
 
   def load_i18ns!
     I18n.available_locales << PigCI.locale
-    I18n.load_path += Dir["#{File.expand_path('../config/locales/pig_ci', __dir__)}/*.{rb,yml}"]
+    I18n.load_path += Dir["#{File.expand_path("../config/locales/pig_ci", __dir__)}/*.{rb,yml}"]
   end
 
   def run_exit_tasks!
@@ -161,9 +164,6 @@ module PigCI
     # Save the report summary to the project root.
     PigCI::Summary::HTML.new(reports: profiler_engine.reports).save! if PigCI.generate_html_summary?
 
-    # If they have an API key, share it with PigCI.com
-    PigCI::Api::Reports.new(reports: profiler_engine.reports).share! if PigCI.api_key?
-
     # Make sure CI fails when metrics are over thresholds.
     PigCI::Summary::CI.new(reports: profiler_engine.reports).call!
   end

data/lib/pig_ci/configuration.rb

@@ -1,7 +1,7 @@
 class PigCI::Configuration
-  Thresholds = Struct.new(:memory, :request_time, :database_request) do
+  Thresholds = Struct.new(:memory, :request_time, :database_request) {
     def initialize(memory: 350, request_time: 250, database_request: 35)
       super(memory, request_time, database_request)
     end
-  end
+  }
 end

data/lib/pig_ci/decorator.rb

@@ -6,4 +6,4 @@ class PigCI::Decorator
   end
 end
 
-require 'pig_ci/decorator/report_terminal_decorator'
+require "pig_ci/decorator/report_terminal_decorator"

data/lib/pig_ci/decorator/report_terminal_decorator.rb

@@ -1,4 +1,4 @@
-require 'colorized_string'
+require "colorized_string"
 
 class PigCI::Decorator::ReportTerminalDecorator < PigCI::Decorator
   %i[key max min mean number_of_requests].each do |field|
@@ -8,9 +8,9 @@ class PigCI::Decorator::ReportTerminalDecorator < PigCI::Decorator
   end
 
   def max_change_percentage
-    if @object[:max_change_percentage].start_with?('-')
+    if @object[:max_change_percentage].start_with?("-")
       ColorizedString[@object[:max_change_percentage]].colorize(:green)
-    elsif @object[:max_change_percentage].start_with?('0.0')
+    elsif @object[:max_change_percentage].start_with?("0.0")
       @object[:max_change_percentage]
     else
       ColorizedString[@object[:max_change_percentage]].colorize(:red)

data/lib/pig_ci/metric.rb

@@ -1,4 +1,4 @@
 class PigCI::Metric; end
 
-require 'pig_ci/metric/current'
-require 'pig_ci/metric/historical'
+require "pig_ci/metric/current"
+require "pig_ci/metric/historical"

data/lib/pig_ci/metric/current.rb

@@ -7,7 +7,7 @@ class PigCI::Metric::Current
     @to_h = {}
 
     File.foreach(@log_file) do |f|
-      key, value = f.strip.split('|')
+      key, value = f.strip.split("|")
       value = value.to_i
 
       @to_h[key] ||= {

data/lib/pig_ci/metric/historial/change_percentage.rb

@@ -11,7 +11,7 @@ class PigCI::Metric::Historical::ChangePercentage
       previous_run_data = previous_run_data_for_key(data[:key]) || data
 
       data[:max_change_percentage] = (((BigDecimal(data[:max]) - BigDecimal(previous_run_data[:max])) / BigDecimal(previous_run_data[:max])) * 100).round(PigCI.max_change_percentage_precision)
-      data[:max_change_percentage] = BigDecimal('0') if data[:max_change_percentage].to_s == 'NaN' || data[:max_change_percentage] == BigDecimal('-0.0')
+      data[:max_change_percentage] = BigDecimal("0") if data[:max_change_percentage].to_s == "NaN" || data[:max_change_percentage] == BigDecimal("-0.0")
       data[:max_change_percentage] = data[:max_change_percentage].to_f
 
       data

data/lib/pig_ci/metric/historical.rb

@@ -29,15 +29,15 @@ class PigCI::Metric::Historical
 
   def remove_old_historical_data!
     new_historical_data = @to_h
-                          .sort_by { |timestamp, _data| timestamp.to_s.to_i * -1 }[0..(PigCI.historical_data_run_limit - 1)]
-                          .to_h
-                          .sort_by { |timestamp, _data| timestamp.to_s.to_i * -1 }.to_h
+      .sort_by { |timestamp, _data| timestamp.to_s.to_i * -1 }[0..(PigCI.historical_data_run_limit - 1)]
+      .to_h
+      .sort_by { |timestamp, _data| timestamp.to_s.to_i * -1 }.to_h
     @to_h = new_historical_data
   end
 
   def read_historical_log_file
     if File.exist?(@historical_log_file)
-      JSON.parse(File.open(@historical_log_file, 'r').read, symbolize_names: true)
+      JSON.parse(File.open(@historical_log_file, "r").read, symbolize_names: true)
     else
       {}
     end
@@ -49,4 +49,4 @@ class PigCI::Metric::Historical
   end
 end
 
-require 'pig_ci/metric/historial/change_percentage'
+require "pig_ci/metric/historial/change_percentage"

data/lib/pig_ci/profiler.rb

@@ -2,14 +2,14 @@ class PigCI::Profiler
   attr_accessor :log_value, :log_file, :historical_log_file, :i18n_key
 
   def initialize(i18n_key: nil, log_file: nil, historical_log_file: nil)
-    @i18n_key = i18n_key || self.class.name.underscore.split('/').last
+    @i18n_key = i18n_key || self.class.name.underscore.split("/").last
     @log_file = log_file || PigCI.tmp_directory.join("#{@i18n_key}.txt")
     @historical_log_file = historical_log_file || PigCI.tmp_directory.join("#{@i18n_key}.json")
     @log_value = 0
   end
 
   def setup!
-    File.open(log_file, 'w') { |file| file.truncate(0) }
+    File.open(log_file, "w") { |file| file.truncate(0) }
   end
 
   def reset!
@@ -17,8 +17,8 @@ class PigCI::Profiler
   end
 
   def log_request!(request_key)
-    File.open(log_file, 'a+') do |f|
-      f.puts([request_key, log_value].join('|'))
+    File.open(log_file, "a+") do |f|
+      f.puts([request_key, log_value].join("|"))
     end
   end
 
@@ -36,6 +36,6 @@ class PigCI::Profiler
   end
 end
 
-require 'pig_ci/profiler/memory'
-require 'pig_ci/profiler/request_time'
-require 'pig_ci/profiler/database_request'
+require "pig_ci/profiler/memory"
+require "pig_ci/profiler/request_time"
+require "pig_ci/profiler/database_request"

data/lib/pig_ci/profiler/memory.rb

@@ -1,4 +1,4 @@
-require 'get_process_mem'
+require "get_process_mem"
 
 class PigCI::Profiler::Memory < PigCI::Profiler
   def reset!

data/lib/pig_ci/profiler_engine.rb

@@ -8,7 +8,7 @@ class PigCI::ProfilerEngine
   end
 
   def request_key?
-    !@request_key.nil? && @request_key != ''
+    !@request_key.nil? && @request_key != ""
   end
 
   def request_captured?
@@ -37,4 +37,4 @@ class PigCI::ProfilerEngine
   end
 end
 
-require 'pig_ci/profiler_engine/rails'
+require "pig_ci/profiler_engine/rails"

data/lib/pig_ci/profiler_engine/rails.rb

@@ -31,10 +31,13 @@ class PigCI::ProfilerEngine::Rails < ::PigCI::ProfilerEngine
   def precompile_assets!
     # From: https://github.com/rails/sprockets-rails/blob/e9ca63edb6e658cdfcf8a35670c525b369c2ccca/test/test_railtie.rb#L7-L13
     ::Rails.application.load_tasks
-    ::Rake.application['assets:precompile'].execute
+    ::Rake.application["assets:precompile"].execute
   end
 
   def eager_load_rails!
+    # None of these methods will work pre-rails 5.
+    return unless ::Rails.version.to_f >= 5.0
+
     # Eager load rails to give more accurate memory levels.
     ::Rails.application.eager_load!
     ::Rails.application.routes.eager_load!
@@ -45,30 +48,32 @@ class PigCI::ProfilerEngine::Rails < ::PigCI::ProfilerEngine
   def make_blank_application_request!
     # Make a call to the root path to load up as much of rails as possible
     # Done within a timezone block as it affects the timezone.
-    Time.use_zone('UTC') do
-      ::Rails.application.call(::Rack::MockRequest.env_for('/'))
+    Time.use_zone("UTC") do
+      ::Rails.application.call(::Rack::MockRequest.env_for("/"))
     end
   end
 
   def attach_listeners!
-    ::ActiveSupport::Notifications.subscribe 'start_processing.action_controller' do |_name, _started, _finished, _unique_id, payload|
+    ::ActiveSupport::Notifications.subscribe "start_processing.action_controller" do |_name, _started, _finished, _unique_id, payload|
       request_key_from_payload!(payload)
 
       profilers.each(&:reset!)
     end
 
-    ::ActiveSupport::Notifications.subscribe 'sql.active_record' do |_name, _started, _finished, _unique_id, _payload|
-      if request_key?
-        profilers.select { |profiler| profiler.class == PigCI::Profiler::DatabaseRequest }.each(&:increment!)
+    ::ActiveSupport::Notifications.subscribe "sql.active_record" do |_name, _started, _finished, _unique_id, payload|
+      if request_key? && PigCI.enabled? && (!PigCI.ignore_cached_queries? || (PigCI.ignore_cached_queries? && !payload[:cached]))
+        profilers.select { |profiler| profiler.instance_of?(PigCI::Profiler::DatabaseRequest) }.each(&:increment!)
       end
     end
 
-    ::ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |_name, _started, _finished, _unique_id, _payload|
-      profilers.each do |profiler|
-        profiler.log_request!(request_key)
-      end
+    ::ActiveSupport::Notifications.subscribe "process_action.action_controller" do |_name, _started, _finished, _unique_id, _payload|
+      if PigCI.enabled?
+        profilers.each do |profiler|
+          profiler.log_request!(request_key)
+        end
 
-      request_captured!
+        request_captured!
+      end
       self.request_key = nil
     end
   end

data/lib/pig_ci/report.rb

@@ -2,7 +2,7 @@ class PigCI::Report
   attr_accessor :historical_log_file, :i18n_key
 
   def initialize(historical_log_file: nil, i18n_key: nil, timestamp: nil)
-    @i18n_key = i18n_key || self.class.name.underscore.split('/').last
+    @i18n_key = i18n_key || self.class.name.underscore.split("/").last
     @historical_log_file = historical_log_file || PigCI.tmp_directory.join("#{@i18n_key}.json")
     @timestamp = timestamp || PigCI.run_timestamp
   end
@@ -12,7 +12,7 @@ class PigCI::Report
   end
 
   def i18n_name
-    I18n.t('.name', scope: i18n_scope, locale: PigCI.locale)
+    I18n.t(".name", scope: i18n_scope, locale: PigCI.locale)
   end
 
   def max_for(timestamp)
@@ -30,9 +30,9 @@ class PigCI::Report
   end
 
   def sorted_and_formatted_data_for(timestamp)
-    data_for(timestamp)[@i18n_key.to_sym].sort_by do |data|
+    data_for(timestamp)[@i18n_key.to_sym].sort_by { |data|
       PigCI.report_row_sort_by(data)
-    end.collect do |data|
+    }.collect do |data|
       self.class.format_row(data)
     end
   end
@@ -73,6 +73,6 @@ class PigCI::Report
   end
 end
 
-require 'pig_ci/report/memory'
-require 'pig_ci/report/request_time'
-require 'pig_ci/report/database_request'
+require "pig_ci/report/memory"
+require "pig_ci/report/request_time"
+require "pig_ci/report/database_request"

data/lib/pig_ci/report/memory.rb

@@ -10,6 +10,6 @@ class PigCI::Report::Memory < PigCI::Report
   end
 
   def self.bytes_in_a_megabyte
-    @bytes_in_a_megabyte ||= BigDecimal(1_048_576)
+    @bytes_in_a_megabyte ||= BigDecimal("1_048_576")
   end
 end

data/lib/pig_ci/summary.rb

@@ -1,5 +1,5 @@
 class PigCI::Summary; end
 
-require 'pig_ci/summary/ci'
-require 'pig_ci/summary/html'
-require 'pig_ci/summary/terminal'
+require "pig_ci/summary/ci"
+require "pig_ci/summary/html"
+require "pig_ci/summary/terminal"

data/lib/pig_ci/summary/ci.rb

@@ -1,4 +1,4 @@
-require 'colorized_string'
+require "colorized_string"
 
 class PigCI::Summary::CI < PigCI::Summary
   def initialize(reports:)
@@ -7,8 +7,8 @@ class PigCI::Summary::CI < PigCI::Summary
   end
 
   def call!
-    puts ''
-    puts I18n.t('pig_ci.summary.ci_start')
+    puts ""
+    puts I18n.t("pig_ci.summary.ci_start")
 
     over_threshold = false
     @reports.each do |report|
@@ -17,22 +17,22 @@ class PigCI::Summary::CI < PigCI::Summary
     end
 
     fail_with_error! if over_threshold
-    puts ''
+    puts ""
   end
 
   private
 
   def fail_with_error!
-    puts I18n.t('pig_ci.summary.ci_failure')
+    puts I18n.t("pig_ci.summary.ci_failure")
     Kernel.exit(2)
   end
 
   def print_report(report)
     max_and_threshold = [
       report.max_for(@timestamp).to_s,
-      '/',
+      "/",
       report.threshold
-    ].join(' ')
+    ].join(" ")
 
     if report.over_threshold_for?(@timestamp)
       puts "#{report.i18n_name}: #{ColorizedString[max_and_threshold].colorize(:red)}\n"