pig-ci-rails 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a0910dfcd93b0aa8da420798e8888787f3c7c614a86836c6d456c89123aeea3
-  data.tar.gz: c550a0069bd3d36eeba1511a3c9601777c8bbdb7f939d6c039b5cf0415f54b0a
+  metadata.gz: 45e75a450ac91998d1c684580aadb2f2beab4dc4b12aefc2b1cc39ff18d6aced
+  data.tar.gz: 35ceebb576bae40eaeb17566ae3cfa764e165c68e4c2680f4257b1046849d79d
 SHA512:
-  metadata.gz: f7411322993aa119f7e8f70d545ec214aed0730467b7274aab4ea4f33a9359ef6569b649056882c9eaaed4f44e9429232b65c980e536539bf98c703dc5feb7c3
-  data.tar.gz: 82d3ed70e9f709d0d464c8df1acb9c37f9a2c62c722f48c98362d2d4f5e5d3f6a402cbcfe8c522a0ffcd5b85533c2dda38f81e05d2f34d158f446c32e3d93ac1
+  metadata.gz: d59558555c2138ea84554770b9e296c5e49d7f3c9b50f2913bf7d5a3b64be795e947440cf297665e9e726bae9ad5ab1934fec67f8194ed95692c8555d99b0b4b
+  data.tar.gz: 74e3514d08d9021ab082f4e75c3edc8bf7e7c369b10a83583f96ec701e1f312325e1bf338286a168793eb06eb24de0aa54dac6540932fadc83ba26d8ba05d11c

data/.github/workflows/gempush.yml

@@ -0,0 +1,29 @@
+name: Build & Publish Ruby Gem
+
+on:
+  create:
+    tags:
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+        OWNER: MikeRogers0

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -7,10 +7,10 @@ cache: bundler
 
 rvm:
   - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.3
-  - ruby-head
+  - 2.4.7
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0-preview1
 
 before_install: 
   - gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.3.0 (In Development)
+
+* TODO: Deprecate pigci.com integration.
+
+## 0.2.0
+
+* [Updating TravisCI to test latest ruby versions](https://github.com/PigCI/pig-ci-rails/pull/15)
+* [Update rake requirement from ~> 12.3 to ~> 13.0](https://github.com/PigCI/pig-ci-rails/pull/14)
+* [Update rspec requirement from ~> 3.8.0 to ~> 3.9.0](https://github.com/PigCI/pig-ci-rails/pull/16)
+* [Update webmock requirement from ~> 3.7.0 to ~> 3.8.0](https://github.com/PigCI/pig-ci-rails/pull/17)
+* [Adding config.thresholds, this allows standalone usage without pigci.com](https://github.com/PigCI/pig-ci-rails/pull/18) & [Replace references for limit to be threshold](https://github.com/PigCI/pig-ci-rails/pull/21)
+* Setting up repo to publish gem when new tags are created.
+
 ## 0.1.5
 
 * [Widen i18n gem version requirement](https://github.com/PigCI/pig-ci-rails/pull/12)

data/README.md

@@ -45,22 +45,26 @@ require 'pig_ci'
 PigCI.start
 ```
 
-### With [PigCI.com](https://pigci.com) - For sharing runs as a team via CI
+### Configuring thresholds
 
-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).
+Configuring the thresholds will allow your test suite to fail in CI. You will need to configure the thresholds depending on your application.
 
 ```ruby
 # In spec/rails_helper.rb
 require 'pig_ci'
 PigCI.start do |config|
-  # When you connect your project, you'll be given an API key.
-  config.api_key = 'your-api-key-here'
-end
-```
+  # Maximum memory in megabytes
+  config.thresholds.memory = 350
 
-It's a great way to track metrics over time & support this project.
+  # Maximum time per a HTTP request
+  config.thresholds.request_time = 250
 
-### Configuring PigCI
+  # Maximum database calls per a request
+  config.thresholds.database_request = 35
+end if RSpec.configuration.files_to_run.count > 1
+```
+
+### Configuring other options
 
 This gems was setup to be configured by passing a block to the `PigCI.start` method, e.g:
 
@@ -77,9 +81,27 @@ end # if 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).
 
+
+### With [PigCI.com](https://pigci.com) - For sharing runs as a team via CI
+
+_Note: This feature will be deprecated in the future. Instead use "Configuring thresholds" to have CI pass/fail._
+
+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).
+
+```ruby
+# In spec/rails_helper.rb
+require 'pig_ci'
+PigCI.start do |config|
+  # When you connect your project, you'll be given an API key.
+  config.api_key = 'your-api-key-here'
+end
+```
+
+It's a great way to track metrics over time & support this project.
+
 ### Framework support
 
-Currently this gem only supports Ruby on Rails.
+Currently this gem only supports Ruby on Rails tested via RSpec.
 
 ### Metric notes
 
@@ -128,12 +150,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Features I'd like to add at some point:
 
+* Add support for "upsert" for when tests are split over multiple machines
 * HTML output to include branch - Right now they're just timestamps which makes filtering hard.
 * Document setting branch/commit to handle when CI doesn't set it correctly.
 * Add rake for submitting reports.
 * https://rubydoc.info/gems/yard/file/docs/GettingStarted.md - Document the gem so it's easier for people to jump on.
 * Support ActionCable (when requests have no key).
-* Add support for "upsert" for when tests are split over multiple machines
 
 ## Contributing
 

data/config/locales/pig_ci/en.yml

@@ -2,9 +2,12 @@ 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'
       saved_successfully: PigCI report generated to %{output_directory}
       title: PigCI Results
       view_historic_reports: 'Historic Reports'

data/lib/pig_ci.rb

@@ -4,6 +4,7 @@ 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'
@@ -117,6 +118,14 @@ module PigCI
     @locale || :en
   end
 
+  def thresholds=(values)
+    @thresholds = PigCI::Configuration::Thresholds.new(values)
+  end
+
+  def thresholds
+    @thresholds ||= PigCI::Configuration::Thresholds.new
+  end
+
   module_function
 
   def start(&block)
@@ -154,6 +163,9 @@ module PigCI
 
     # 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
 end
 

data/lib/pig_ci/api/reports.rb

@@ -5,7 +5,10 @@ class PigCI::Api::Reports < PigCI::Api
 
   def share!
     response = post_payload
-    return if response.success?
+    if response.success?
+      puts I18n.t('pig_ci.api.reports.success')
+      return
+    end
 
     puts I18n.t('pig_ci.api.reports.error', error: JSON.parse(response.parsed_response || '{}')['error'])
   rescue JSON::ParserError => _e

data/lib/pig_ci/configuration.rb

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

data/lib/pig_ci/report.rb

@@ -15,6 +15,20 @@ class PigCI::Report
     I18n.t('.name', scope: i18n_scope, locale: PigCI.locale)
   end
 
+  def max_for(timestamp)
+    sorted_and_formatted_data_for(timestamp).collect { |row| row[:max] }.max
+  end
+
+  def threshold
+    PigCI.thresholds.dig(@i18n_key.to_sym)
+  end
+
+  def over_threshold_for?(timestamp)
+    return false unless threshold.present? && max_for(timestamp).present?
+
+    max_for(timestamp) > threshold
+  end
+
   def sorted_and_formatted_data_for(timestamp)
     data_for(timestamp)[@i18n_key.to_sym].sort_by do |data|
       PigCI.report_row_sort_by(data)

data/lib/pig_ci/summary.rb

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

data/lib/pig_ci/summary/ci.rb

@@ -0,0 +1,43 @@
+require 'colorized_string'
+
+class PigCI::Summary::CI < PigCI::Summary
+  def initialize(reports:)
+    @reports = reports
+    @timestamp = PigCI.run_timestamp
+  end
+
+  def call!
+    puts ''
+    puts I18n.t('pig_ci.summary.ci_start')
+
+    over_threshold = false
+    @reports.each do |report|
+      print_report(report)
+      over_threshold = true if report.over_threshold_for?(@timestamp)
+    end
+
+    fail_with_error! if over_threshold
+    puts ''
+  end
+
+  private
+
+  def fail_with_error!
+    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(' ')
+
+    if report.over_threshold_for?(@timestamp)
+      puts "#{report.i18n_name}: #{ColorizedString[max_and_threshold].colorize(:red)}\n"
+    else
+      puts "#{report.i18n_name}: #{ColorizedString[max_and_threshold].colorize(:green)}\n"
+    end
+  end
+end

data/lib/pig_ci/version.rb

@@ -1,3 +1,3 @@
 module PigCI
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/pig_ci.gemspec

@@ -13,15 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/PigCI/pig-ci-rails'
   spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
   # 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
@@ -39,10 +30,18 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'terminal-table', '~> 1.8.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'webmock', '~> 3.7.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'webmock', '~> 3.8.0'
 
   spec.add_development_dependency 'json-schema', '~> 2.8.1'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  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.post_install_message = [
+    'Thank you for install Pig CI!',
+    'Upgrade Notes:',
+    'The latest version adds a "config.thresholds" option which will replace the pigci.com integration in future.',
+    'See https://github.com/PigCI/pig-ci-rails#configuring-thresholds for more information :)'
+  ].join("\n")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pig-ci-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -134,28 +134,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -176,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +198,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
 description: A gem for Ruby on Rails that will report key metrics (memory, request
   time & SQL Requests) for request & feature tests.
 email:
@@ -207,8 +221,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/gempush.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -222,6 +238,7 @@ files:
 - lib/pig_ci.rb
 - lib/pig_ci/api.rb
 - lib/pig_ci/api/reports.rb
+- lib/pig_ci/configuration.rb
 - lib/pig_ci/decorator.rb
 - lib/pig_ci/decorator/report_terminal_decorator.rb
 - lib/pig_ci/metric.rb
@@ -239,6 +256,7 @@ files:
 - lib/pig_ci/report/memory.rb
 - lib/pig_ci/report/request_time.rb
 - lib/pig_ci/summary.rb
+- lib/pig_ci/summary/ci.rb
 - lib/pig_ci/summary/html.rb
 - lib/pig_ci/summary/terminal.rb
 - lib/pig_ci/version.rb
@@ -250,9 +268,12 @@ files:
 homepage: https://github.com/PigCI/pig-ci-rails
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
-post_install_message: 
+metadata: {}
+post_install_message: |-
+  Thank you for install Pig CI!
+  Upgrade Notes:
+  The latest version adds a "config.thresholds" option which will replace the pigci.com integration in future.
+  See https://github.com/PigCI/pig-ci-rails#configuring-thresholds for more information :)
 rdoc_options: []
 require_paths:
 - lib