ezcater_rubocop 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d02f5757933c7be1b1a9e9a241538356c9065b6a04c34b1dfaa277654731c7b
-  data.tar.gz: 57202741bf6252b2ac2bbd5199032bbd9c6bdde31246a48324a02ad4b95fbb6b
+  metadata.gz: 63b5162f2f4de001caee81127febb34027aa4199181d6c098936deec38a83068
+  data.tar.gz: ef6e3e1a319ecdd9db2550bffc519879df3d77182a54c470930214d811fc060e
 SHA512:
-  metadata.gz: 5392b2b295c38b07aea42910192df5c5f095b12cdbbc0863f95acf558b91e994c404eaca0e8c8044bbc7a819214accb44b713342771ab310e028ab326f307f71
-  data.tar.gz: dac7a7cfbf12311396c612bbe4831801b0ec8dac98d3ed13bcf2cd1ac23b4ce1b24ef0bb48998eb2d96322a17f8418b1062db97b6cedfa49022bc16173210a86
+  metadata.gz: 345e0c7c537cc2081b9469ea91261dfda7abe63d5b60a087bc8cb16084bf95054490c0232cab8bd17201023448a0b180077d3732aae60cc325e36ab07a58d912
+  data.tar.gz: 92976b7169ad4de3b931afb570a40946371716e49634f99a0f1e524f78b9d076a869a405a6ad95f055659e6a498489d32587e85fe319d40ba82d0b9751f7d64d

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @agrobbin @aprescott @tjwp

data/CHANGELOG.md

@@ -4,8 +4,16 @@
 
 This gem is moving onto its own [Semantic Versioning](https://semver.org/) scheme starting with v1.0.0. All version bumps moving forward should increment using `MAJOR.MINOR.PATCH` based on changes.
 
-Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of RuboCop. The first release of the
-ezcater_rubocop gem was `v0.49.0`.
+Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of RuboCop. The first release of the ezcater_rubocop gem was `v0.49.0`.
+
+## Unreleased
+
+- ...
+
+## v1.1.0
+
+- Add `Ezcater/RailsEnv` cop.
+- Add `Ezcater/DirectEnvCheck` cop.
 
 ## v1.0.2
 - Exclude bootsnap cache directory (`tmp/cache`).

data/conf/rubocop_rails.yml

@@ -46,3 +46,20 @@ Rails/UnknownEnv:
     - test
     - staging
     - production
+
+Ezcater/RailsEnv:
+  Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `Rails.env`.'
+  Enabled: true
+  Exclude:
+    - "config/**/*"
+    - "spec/rails_helper.rb"
+    - "db/**/*"
+
+Ezcater/DirectEnvCheck:
+  Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `ENV`.'
+  Enabled: true
+  Exclude:
+    - "bin/**/*"
+    - "config/**/*"
+    - "spec/rails_helper.rb"
+    - "db/**/*"

data/config/default.yml

@@ -2,6 +2,14 @@ Ezcater/RailsConfiguration:
   Description: 'Enforce the use of `Rails.configuration` instead of `Rails.application.config`.'
   Enabled: true
 
+Ezcater/RailsEnv:
+  Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `Rails.env`.'
+  Enabled: false
+
+Ezcater/DirectEnvCheck:
+  Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `ENV`.'
+  Enabled: false
+
 Ezcater/RspecDotNotSelfDot:
   Description: 'Enforce ".<class method>" instead of "self.<class method>" for example group description.'
   Enabled: true

data/lib/ezcater_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzcaterRubocop
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/ezcater_rubocop.rb

@@ -14,7 +14,9 @@ puts "configuration from #{DEFAULT_FILES}" if RuboCop::ConfigLoader.debug?
 config = RuboCop::ConfigLoader.merge_with_default(config, path)
 RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 
+require "rubocop/cop/ezcater/direct_env_check"
 require "rubocop/cop/ezcater/rails_configuration"
+require "rubocop/cop/ezcater/rails_env"
 require "rubocop/cop/ezcater/require_gql_error_helpers"
 require "rubocop/cop/ezcater/rspec_match_ordered_array"
 require "rubocop/cop/ezcater/rspec_require_browser_mock"

data/lib/rubocop/cop/ezcater/direct_env_check.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Ezcater
+      # Use the `Rails.configuration.x` namespace for configuration backed by
+      # environment variables, rather than inspecting `ENV` directly.
+      #
+      # Restricting environment variables references to be within application
+      # configuration makes it more obvious which env vars an application relies
+      # upon. See https://ezcater.atlassian.net/wiki/x/ZIChNg.
+      #
+      # @example
+      #
+      #   # good
+      #   enforce_foo! if Rails.configuration.x.foo_enforced
+      #
+      #   # bad
+      #   enforce_foo! if ENV["FOO_ENFORCED"] == "true"
+      #
+      class DirectEnvCheck < Cop
+        MSG = <<~END_MESSAGE.split("\n").join(" ")
+          Use `Rails.configuration.x.<foo>` for env-backed configuration instead of inspecting `ENV`. Restricting
+          environment variables references to be within application configuration makes it more obvious which env vars
+          an application relies upon. https://ezcater.atlassian.net/wiki/x/ZIChNg
+        END_MESSAGE
+
+        def_node_matcher "env_ref", <<-PATTERN
+          (const _ :ENV)
+        PATTERN
+
+        def on_const(node)
+          env_ref(node) do
+            add_offense(node, location: :expression, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ezcater/rails_env.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Ezcater
+      # Use the `Rails.configuration.x` namespace for configuration backed by
+      # environment variables, rather than inspecting `Rails.env` directly.
+      #
+      # Centralizing application configuration helps avoid scattering it
+      # throughout the codebase, and avoids coarse environment grouping under
+      # a single env var. See https://ezcater.atlassian.net/wiki/x/ZIChNg.
+      #
+      # @example
+      #
+      #   # good
+      #   enforce_foo! if Rails.configuration.x.foo_enforced
+      #
+      #   # bad
+      #   enforce_foo! if Rails.env.production?
+      #
+      #   # bad
+      #   enforce_foo! if ENV["RAILS_ENV"] == "production"
+      #
+      class RailsEnv < Cop
+        MSG = <<~END_MESSAGE.split("\n").join(" ")
+          Use `Rails.configuration.x.<foo>` for env-backed configuration instead of inspecting `Rails.env`, so that
+          configuration is more centralized and gives finer control. https://ezcater.atlassian.net/wiki/x/ZIChNg
+        END_MESSAGE
+
+        def_node_matcher "rails_env", <<-PATTERN
+          (send (send (const _ :Rails) :env) _ ...)
+        PATTERN
+
+        def on_send(node)
+          rails_env(node) do
+            add_offense(node, location: :expression, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - CHANGELOG.md
 - Gemfile
@@ -157,7 +158,9 @@ files:
 - ezcater_rubocop.gemspec
 - lib/ezcater_rubocop.rb
 - lib/ezcater_rubocop/version.rb
+- lib/rubocop/cop/ezcater/direct_env_check.rb
 - lib/rubocop/cop/ezcater/rails_configuration.rb
+- lib/rubocop/cop/ezcater/rails_env.rb
 - lib/rubocop/cop/ezcater/require_gql_error_helpers.rb
 - lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb
 - lib/rubocop/cop/ezcater/rspec_match_ordered_array.rb
@@ -186,8 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ezCater custom cops and shared configuration