pig-ci-rails 1.0.1 → 1.1.0

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,25 +48,25 @@ 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? && PigCI.enabled? && ( !PigCI.ignore_cached_queries? || ( PigCI.ignore_cached_queries? && !payload[:cached] ))
-        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|
+    ::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)

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"

data/lib/pig_ci/summary/html.rb

@@ -2,7 +2,7 @@
 # It aims to save to the project root in /pig-ci.
 # It is inspired by https://github.com/colszowka/simplecov-html
 
-require 'erb'
+require "erb"
 
 class PigCI::Summary::HTML < PigCI::Summary
   def initialize(reports:)
@@ -11,15 +11,15 @@ class PigCI::Summary::HTML < PigCI::Summary
 
   def save!
     copy_assets!
-    File.write(index_file_path, template('index').result(binding))
+    File.write(index_file_path, template("index").result(binding))
 
-    puts I18n.t('pig_ci.summary.saved_successfully', output_directory: PigCI.output_directory)
+    puts I18n.t("pig_ci.summary.saved_successfully", output_directory: PigCI.output_directory)
   end
 
   private
 
   def render_report(report)
-    template('report').result(binding)
+    template("report").result(binding)
   end
 
   def timestamps
@@ -27,11 +27,11 @@ class PigCI::Summary::HTML < PigCI::Summary
   end
 
   def template(name)
-    ERB.new(File.read(File.join(File.dirname(__FILE__), '../views', "#{name}.erb")))
+    ERB.new(File.read(File.join(File.dirname(__FILE__), "../views", "#{name}.erb")))
   end
 
   def index_file_path
-    PigCI.output_directory.join('index.html')
+    PigCI.output_directory.join("index.html")
   end
 
   def copy_assets!
@@ -40,10 +40,10 @@ class PigCI::Summary::HTML < PigCI::Summary
   end
 
   def output_assets_directory
-    PigCI.output_directory.join('assets')
+    PigCI.output_directory.join("assets")
   end
 
   def assets_directory
-    File.join(File.dirname(__FILE__), '../../../public/assets')
+    File.join(File.dirname(__FILE__), "../../../public/assets")
   end
 end

data/lib/pig_ci/summary/terminal.rb

@@ -1,4 +1,4 @@
-require 'terminal-table'
+require "terminal-table"
 
 class PigCI::Summary::Terminal < PigCI::Summary
   def initialize(reports:)
@@ -19,8 +19,8 @@ class PigCI::Summary::Terminal < PigCI::Summary
 
     table = ::Terminal::Table.new headings: report.headings do |t|
       report.sorted_and_formatted_data_for(@timestamp)[0..PigCI.terminal_report_row_limit]
-            .collect { |data| PigCI::Decorator::ReportTerminalDecorator.new(data) }
-            .each do |data|
+        .collect { |data| PigCI::Decorator::ReportTerminalDecorator.new(data) }
+        .each do |data|
         t << report.column_keys.collect { |key| data.send(key) }
       end
     end

data/lib/pig_ci/test_frameworks.rb

@@ -1,3 +1,3 @@
 module PigCI::TestFrameworks; end
 
-require 'pig_ci/test_frameworks/rspec'
+require "pig_ci/test_frameworks/rspec"

data/lib/pig_ci/test_frameworks/rspec.rb

@@ -1,20 +1,21 @@
 class PigCI::TestFrameworks::Rspec
   def self.configure!
-    ::RSpec.configure do |config|
-      config.around(:each, pig_ci: false) do |example|
-        @pig_ci_enabled = PigCI.enabled?
-        PigCI.enabled = false
-        example.run
-        PigCI.enabled = @pig_ci_enabled
-      end
+    if defined?(::RSpec)
+      ::RSpec.configure do |config|
+        config.around(:each, pig_ci: false) do |example|
+          @pig_ci_enabled = PigCI.enabled?
+          PigCI.enabled = false
+          example.run
+          PigCI.enabled = @pig_ci_enabled
+        end
 
-      config.around(:each, pig_ci: true) do |example|
-        @pig_ci_enabled = PigCI.enabled?
-        PigCI.enabled = true
-        example.run
-        PigCI.enabled = @pig_ci_enabled
+        config.around(:each, pig_ci: true) do |example|
+          @pig_ci_enabled = PigCI.enabled?
+          PigCI.enabled = true
+          example.run
+          PigCI.enabled = @pig_ci_enabled
+        end
       end
-
-    end if defined?(::RSpec)
+    end
   end
 end

data/lib/pig_ci/version.rb

@@ -1,3 +1,3 @@
 module PigCI
-  VERSION = '1.0.1'.freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/pig_ci/views/index.erb

@@ -10,8 +10,8 @@
     <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
     <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
-    <link rel="shortcut icon" href="https://pigci.com/images/favicon.png"/>
-    <link rel="icon" type="image/ico" href="https://pigci.com/images/favicon.ico"/>
+    <link rel="shortcut icon" href="https://pigci.mikerogers.io/images/favicon.png"/>
+    <link rel="icon" type="image/ico" href="https://pigci.mikerogers.io/images/favicon.ico"/>
   </head>
   <body>
 
@@ -19,8 +19,8 @@
       <header class="py-3">
         <div class="row">
           <div class="col-6">
-            <a href="https://pigci.com/" target="_blank" rel="noopener">
-              <img src="https://pigci.com/images/logo_pigci.svg" class="float-left mr-4" alt="PigCI Logo" />
+            <a href="https://pigci.mikerogers.io/" target="_blank" rel="noopener">
+              <img src="https://pigci.mikerogers.io/images/logo_pigci.svg" class="float-left mr-4" alt="PigCI Logo" />
             </a>
             <h1><%= I18n.t('.pig_ci.summary.title') %></h1>
           </div>

data/pig_ci.gemspec

@@ -1,46 +1,48 @@
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pig_ci/version'
+require "pig_ci/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'pig-ci-rails'
-  spec.version       = PigCI::VERSION
-  spec.authors       = ['Mike Rogers']
-  spec.email         = ['me@mikerogers.io']
+  spec.name = "pig-ci-rails"
+  spec.version = PigCI::VERSION
+  spec.authors = ["Mike Rogers"]
+  spec.email = ["me@mikerogers.io"]
 
-  spec.summary       = 'Monitor your Ruby Applications metrics via your test suite.'
-  spec.description   = 'A gem for Ruby on Rails that will track key metrics (memory, request time & SQL Requests) for request & feature tests.'
-  spec.homepage      = 'https://github.com/PigCI/pig-ci-rails'
-  spec.license       = 'MIT'
+  spec.summary = "Monitor your Ruby Applications metrics via your test suite."
+  spec.description = "A gem for Ruby on Rails that will track key metrics (memory, request time & SQL Requests) for request & feature tests."
+  spec.homepage = "https://github.com/PigCI/pig-ci-rails"
+  spec.license = "MIT"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md",
+    "documentation_uri" => spec.homepage,
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "funding_uri" => "https://www.buymeacoffee.com/MikeRogers0"
+  }
 
   # 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(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3'
-
-  spec.add_dependency 'activesupport', '>= 4.2'
-  spec.add_dependency 'colorize', '>= 0.8.1'
-  spec.add_dependency 'get_process_mem', '~> 0.2.3'
-  spec.add_dependency 'i18n', '>= 0.9', '< 2'
-  spec.add_dependency 'rails', '>= 4.2.0'
-  spec.add_dependency 'terminal-table', '~> 1.8.0'
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.5"
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'webmock', '~> 3.8.0'
+  spec.add_dependency "activesupport", ">= 4.2"
+  spec.add_dependency "colorize", ">= 0.8.1"
+  spec.add_dependency "get_process_mem", "~> 0.2.3"
+  spec.add_dependency "i18n", ">= 0.9", "< 2"
+  spec.add_dependency "rails", ">= 4.2.0"
+  spec.add_dependency "terminal-table", ">= 1.8", "< 2.1"
 
-  spec.add_development_dependency 'json-schema', '~> 2.8.1'
-  spec.add_development_dependency 'rspec', '~> 3.9.0'
-  spec.add_development_dependency 'simplecov', '~> 0.17.0'
-  spec.add_development_dependency 'yard', '~> 0.9.24'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "webmock", "~> 3.11.0"
 
-  spec.post_install_message = [
-    'Thank you for installing Pig CI!',
-    'Upgrade Notes:',
-    'The latest version adds a "config.thresholds" option which replaces the PigCI.com GitHub integration.',
-    'See https://github.com/PigCI/pig-ci-rails#configuring-thresholds for more information :)'
-  ].join("\n")
+  spec.add_development_dependency "json-schema", "~> 2.8.1"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "simplecov", "~> 0.20.0"
+  spec.add_development_dependency "yard", "~> 0.9.24"
 end