salsify_rubocop 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2056598e677c6cf0b213308613d5ab676b7eee1e97dd93534321a75ba341e2b9
-  data.tar.gz: f0053c47716a510ef4ef57c5e90465e2309a0573ab5944d92b23a42cd154ab2c
+  metadata.gz: bf4488cacf9244dcc1eef749f7e8be0aec426462bbdd97bba63f2585d9e341fa
+  data.tar.gz: 7c804cbcb3576fd3ba2852a667f0db842eb5b2393a7e775101930488eb2b97d4
 SHA512:
-  metadata.gz: fe21f0ff75e19ef071efe283cce27a01cde095fe4918d3ef7eb10bddff6d9ca476b8b4a4263b92f871c55ec7434283b9a6812400e546012c8c3d11cb0d280b73
-  data.tar.gz: 339fc5ad332c3602d2d73106f76c6d26fc9103c398b6bee9059971b1ac97dcbbe930b7ce731d21cda5794d9fdd53f04454d6c203ba8ffe6e7dc6b67695971062
+  metadata.gz: a19b74a0b2600a044f45ae9203a4115cf8dc66b8422c7cf3424d9028d81e273e9cd474dc2f518c5d1f6b39c48b8b95ffb28ec534f56ce14f5bf1ac8f4973689a
+  data.tar.gz: 30b89b5377a2a32895e26947cee22985a17221334519e26bf7e0e3b63e37becd2616c1856626350a5123d51958254beebb5fdde7e1fd1bb16f4d67d8c1bffef5

data/.circleci/config.yml

@@ -0,0 +1,34 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+    environment:
+      CIRCLE_TEST_REPORTS: "test-results"
+    working_directory: ~/salsify_rubocop
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-gems-ruby-2.5.8-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v1-gems-ruby-2.5.8-{{ checksum "salsify_rubocop.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+      - run:
+          name: Run Tests
+          command: |
+            bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/junit.xml --format progress spec
+      - store_test_results:
+          path: "test-results"

data/CHANGELOG.md

@@ -1,17 +1,17 @@
 # salsify_rubocop
 
-## 1.0.0
+## 1.0.1
+- Configure file exclusions for `Rails/RakeEnvironment` and `Gemspec/RequiredRubyVersion`
 
+## 1.0.0
 - Upgrade to `rubocop` v1.0.0
 - Upgrade to `rubocop-rspec` v2.0.0
 
 ## 0.93.1
-
 - Upgrade to `rubocop` v0.93.1
 - Add configuration for pending 1.0 cops
 
 ## 0.91.0
-
 - Upgrade to `rubocop` v0.91.0
 
 ## 0.85.0

data/README.md

@@ -93,6 +93,30 @@ This gem also includes a dependency on `rubocop-rspec` that will be updated to
 the latest compatible version each time that the MAJOR.MINOR version of `rubocop` 
 is updated.
 
+## Change Process
+
+This configuration is meant to represent the general opinion of Salsify's Ruby community around best practices for
+writing readable Ruby code. As a result, changes to this configuration should go through a discussion phase in the
+#rubocop-changes Slack channel to ensure the broader Salsify Ruby community is on board with the change. Non-Salsify
+developers should file an issue via GitHub with proposed changes.
+
+When enabling a cop we try to keep the following points in mind to avoid overburdening consumers:
+
+* Does the cop support safe auto-correction? If not, do we expect a large number of offenses needing manual remediation?
+* Does the cop help avoid bugs or is it merely stylistic?
+* For stylistic cops, does the enforced style reflect that of Salsify developers?
+
+### Updating RuboCop
+
+Updating to a new minor version of `rubocop` may add new "pending" cops which are not enabled until the next major
+version (see: [RuboCop Versioning](https://docs.rubocop.org/rubocop/versioning.html)). However, we may wish to eagerly
+enable or explicitly disable newly introduced cops. Any such decisions around "pending" cops should go through the
+change process described above.
+
+When updating to a new major version or updating other dependencies that don't follow the same versioning pattern, we
+should check if there are any newly enabled cops included in the update. Any new cops should go through a review process
+in #rubocop-changes to ensure we truly want to enable the cop.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec salsify_rubocop` to use the gem in this directory, ignoring other installed copies of this gem.

data/conf/rubocop_rails.yml

@@ -15,6 +15,10 @@ Rails/TimeZone:
   Exclude:
     - 'spec/**/*'
 
+Rails/RakeEnvironment:
+  Exclude:
+    - lib/tasks/auto_annotate_models.rake
+
 Rails/UniqBeforePluck:
   EnforcedStyle: aggressive
 

data/conf/rubocop_without_rspec.yml

@@ -19,6 +19,10 @@ Bundler/GemComment:
     - 'github'
     - 'gist'
 
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - schemas_gem/*_schemas.gemspec
+
 # This cop has poor handling for the common case of a lambda arg in a DSL
 Lint/AmbiguousBlockAssociation:
   Enabled: false

data/lib/salsify_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SalsifyRubocop
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/salsify_rubocop.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
 
   spec.add_runtime_dependency 'rubocop', '~> 1.0.0'
   spec.add_runtime_dependency 'rubocop-performance', '~> 1.5.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salsify_rubocop
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Salsify, Inc
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -115,10 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.7.0
-  - 2.6.0
-  - 2.5.3
-  - 2.4.5
-before_install:
-  - gem update --system
-  - gem install bundler
-script:
-  - bundle exec rubocop
-  - bundle exec rspec