pig-ci-rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa85e7daa23732df9df64cf061da94032f1546feeee471e8acb2fc9a371b4ac8
-  data.tar.gz: 40c1e02b9ebc1e0983341bde07ea117daff01ce9c5c063018c7bc9ca18d4e80c
+  metadata.gz: db71bd9b82ebe9f9f4e9d88184f6c85f8883d4f94043df05dfc22acef1ca7a6e
+  data.tar.gz: 621ff89d5cdb3cac6b9dbeb51d4f5f4b6d929c9fb7488ecf6b10600add3beff1
 SHA512:
-  metadata.gz: 61a77bce177551a4813bde57f4a8485cfc5f1919c738e67030381a7618a9bacdfd69ee157a7a285cae1418d8deb0515abb2409eff53707a17b6a3e6a795d268b
-  data.tar.gz: 8c238ab03b28ac1b556a466198ae8849f304f372d343deee6d78d75882bde588567479ee72ed7faeda6678f8d587e11c593a8ef6d4ef21c76c515ca8fd09ee21
+  metadata.gz: 05f65a26d7dfcf639d28087f530d93b661051d5145afe9906fa8dc07247980dc76096b389e0e44916b5586b27901722c09554b1614b4fe110db70f3b7c55effa
+  data.tar.gz: 12bbaa13fa3a727a272220d6cedeabb6758c4c9099835d8a00fb10e7726665ebb092104a4724a319347fb4af05641f3966010d75121e68ffee08c065f0e98ec5

data/CHANGELOG.md

@@ -2,14 +2,16 @@
 
 ## 0.1.2
 
-  * Codacy changes
+* [Improving Codacy Rating](https://github.com/PigCI/pig-ci-rails/pull/4)
+* [Correcting issue where app warm up would negatively affect timezone](https://github.com/PigCI/pig-ci-rails/pull/5)
+* [Adding option to control if app is preloaded or not](https://github.com/PigCI/pig-ci-rails/pull/3)
 
 ## 0.1.1
 
-  * Updating API Endpoints for PigCI.com
-  * Adding fallback for if API is down to not fail CI.
-  * Removing unnecessary JS,
+* Updating API Endpoints for PigCI.com
+* Adding fallback for if API is down to not fail CI.
+* Removing unnecessary JS,
 
 ## 0.1.0
 
-  * Initial Release
+* Initial Release

data/README.md

@@ -42,7 +42,7 @@ require 'pig_ci'
 PigCI.start
 ```
 
-### With [PigCI.com](https://pigci.com) - For sharing runs as a team via CI.
+### With [PigCI.com](https://pigci.com) - For sharing runs as a team via CI
 
 You can hookup your project to PigCI.com, this will fail PRs when metric thresholds are exceeded (e.g. your app see a big increase in memory).
 
@@ -67,7 +67,7 @@ PigCI.start do |config|
 
   # E.g. disable terminal summary output
   config.generate_terminal_summary = false
-end # if RSpec.configuration.files_to_run.count > 1
+end # if ENV['RUN_PIG_CI'] || RSpec.configuration.files_to_run.count > 1
 ```
 
 You can see the full configuration options [lib/pig_ci.rb](https://github.com/PigCI/pig-ci-rails/blob/master/lib/pig_ci.rb#L21).
@@ -78,33 +78,39 @@ Currently this gem only supports Ruby on Rails.
 
 ### Metric notes
 
+Minor fluctuations in memory usage and request time are to be expected and are nothing to worry about. Though any large spike is a signal of something worth investigating.
+
 #### Memory
 
-Minor fluctuations in memory usage and request time are to be expected and are nothing to worry about. Though any large spike is a signal of something worth investigating.
+By default, this gem will tell Rails to eager load your application on startup. This aims to help identify leaks, over just pure bulk.
 
-You can improve its accuracy by updating your `config/environments/test.rb` to have the line:
+You can disable this functionality by setting your configuration to be:
 
 ```ruby
-config.eager_load = true
+require 'pig_ci'
+PigCI.start do |config|
+  config.during_setup_eager_load_application = false
+end
 ```
 
 #### Request Time
 
-Often the first request test will be slow, as rails is loading a full environment. While this metric is useful, I'd suggest focusing on other metrics (like memory, or database requests).
+Often the first request test will be slow, as rails is loading a full environment. To mitigate this issue, this gem will make a blank request to your application before your test suite starts.
 
-Alternatively add:
+You can disable this functionality by setting your configuration to be:
 
 ```ruby
-Rails.application.call(::Rack::MockRequest.env_for('/'))
+require 'pig_ci'
+PigCI.start do |config|
+  config.during_setup_make_blank_application_request = false
+end
 ```
 
-Before you call `PigCI.start`.
-
 ## Authors
 
-  * This gem was made by [@MikeRogers0](https://github.com/MikeRogers0).
-  * It was originally inspired by [oink](https://github.com/noahd1/oink), after it was used to [monitor acceptance tests](https://mikerogers.io/2015/03/28/monitor-rails-memory-usage-in-integration-tests.html) and it spotted a memory leak. It seemed like something that would be useful to have as part of CI.
-  * The HTML output was inspired by [simplecov](https://github.com/colszowka/simplecov).
+* This gem was made by [@MikeRogers0](https://github.com/MikeRogers0).
+* It was originally inspired by [oink](https://github.com/noahd1/oink), after it was used to [monitor acceptance tests](https://mikerogers.io/2015/03/28/monitor-rails-memory-usage-in-integration-tests.html) and it spotted a memory leak. It seemed like something that would be useful to have as part of CI.
+* The HTML output was inspired by [simplecov](https://github.com/colszowka/simplecov).
 
 ## Development
 
@@ -116,11 +122,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Features I'd like to add at some point:
  
-  * HTML output to include branch - Right now they're just timestamps which makes filtering hard.
-  * Should I disable terminal output by default? It feels like noise.
-  * Should I reject database requests that have a value of 0? I think so.
-  * Document setting branch/commit encase of weird CI.
-  * Add rake rake for submitting reports.
+* HTML output to include branch - Right now they're just timestamps which makes filtering hard.
+* Should I disable terminal output by default? It feels like noise.
+* Should I reject database requests that have a value of 0? I think so.
+* Document setting branch/commit encase of weird CI.
+* Add rake rake for submitting reports.
 
 ## Contributing
 

data/lib/pig_ci/api/reports.rb

@@ -18,7 +18,7 @@ class PigCI::Api::Reports < PigCI::Api
 
   def post_payload
     self.class.post(
-      '/api/v1/reports',
+      '/v1/reports',
       base_uri: PigCI.api_base_uri,
       verify: PigCI.api_verify_ssl?,
       body: payload,

data/lib/pig_ci/profiler_engine/rails.rb

@@ -20,7 +20,8 @@ class PigCI::ProfilerEngine::Rails < ::PigCI::ProfilerEngine
 
   def setup!
     super do
-      eager_load_rails!
+      eager_load_rails! if PigCI.during_setup_eager_load_application?
+      make_blank_application_request! if PigCI.during_setup_make_blank_application_request?
     end
   end
 
@@ -31,9 +32,14 @@ class PigCI::ProfilerEngine::Rails < ::PigCI::ProfilerEngine
     ::Rails.application.eager_load!
     ::Rails::Engine.subclasses.map(&:instance).each(&:eager_load!)
     ::ActiveRecord::Base.descendants
+  end
 
+  def make_blank_application_request!
     # Make a call to the root path to load up as much of rails as possible
-    ::Rails.application.call(::Rack::MockRequest.env_for('/'))
+    # Done within a timezone block as it affects the timezone.
+    Time.use_zone('UTC') do
+      ::Rails.application.call(::Rack::MockRequest.env_for('/'))
+    end
   end
 
   def attach_listeners!

data/lib/pig_ci/version.rb

@@ -1,3 +1,3 @@
 module PigCI
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/pig_ci.rb

@@ -45,6 +45,16 @@ module PigCI
     @report_memory_precision || 2
   end
 
+  attr_writer :during_setup_eager_load_application
+  def during_setup_eager_load_application?
+    @during_setup_eager_load_application.nil? || @during_setup_eager_load_application
+  end
+
+  attr_writer :during_setup_make_blank_application_request
+  def during_setup_make_blank_application_request?
+    @during_setup_make_blank_application_request.nil? || @during_setup_make_blank_application_request
+  end
+
   attr_writer :terminal_report_row_limit
   def terminal_report_row_limit
     @terminal_report_row_limit || -1
@@ -73,7 +83,7 @@ module PigCI
 
   attr_writer :api_base_uri
   def api_base_uri
-    @api_base_uri || 'https://api.pigci.com'
+    @api_base_uri || 'https://api.pigci.com/api'
   end
 
   attr_accessor :api_verify_ssl
@@ -88,12 +98,12 @@ module PigCI
 
   attr_writer :commit_sha1
   def commit_sha1
-    @commit_sha1 || 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['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
 
   attr_writer :locale

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pig-ci-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mike Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport