ndr_dev_support 5.4.8 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56da4da690a220d64f0cdbc7ae4be4a4f4f7342d4e46ab8964c48224c95c8ce0
-  data.tar.gz: 9338de8d07f2c938895f9fb6e31c7d4aceddd7f2551ae4fef4b61d678d0fac1b
+  metadata.gz: 266a4e4e0fe8d5aaf551ce205b4d699aec39922d634c34a922cdf825b2e38f0d
+  data.tar.gz: 1f07112de5ce4ecb8e18aa1b9a2013bd71d6b99e4442aeb27b8a239928242d0b
 SHA512:
-  metadata.gz: 06bae4cb67f71d45e020e0bba1f1aca560ee9f2722f46407d5b7fd0c6a703e8d5a4e79c8c4b8d73c7233ac3b5c55405e63acf788e8dde396932a530db6c90ad4
-  data.tar.gz: a113098d8df517ed19b967dc53d4ae8c75fbe3fd5c3a207f5bc6a951c81b135b2700e9dfc704394730b82a7618118dac797fa2a85070380a54f66b7a7f9a5ad0
+  metadata.gz: d458bf7e248657f21ae473e6809288f91fd0b71dfa660b8706a199c3f4e74f06a02f850d5a3b3008ec5c7ae03545a3720a3a0917ca84f6c69793c629fe1a65bb
+  data.tar.gz: b6d391962ebe0e2c5522c4e60186f8a3c0dce42df2e11c8534db28f8e6838d1390c0910adf67007ffc419dfbbe8ee2f346e02d8c77b49366b950661d571659bb

data/.rubocop.yml

@@ -1,138 +1 @@
-# This file contains NDR's agreed deviations from the standard Ruby
-# Style Guide, the configuration for which can be found here:
-#   https://github.com/bbatsov/rubocop/blob/master/config/default.yml
-#
-# See the README for instructions on using in a project.
-
-require:
-  - rubocop-rails
-
-AllCops:
-  # All cops should ignore files in the following locations:
-  Exclude:
-  - 'bin/*'
-  - 'db/schema.rb'
-  - 'lib/generators/**/templates/*'
-  - 'tmp/**/*'
-  - 'vendor/**/*'
-
-# Once supported by RuboCop, this will prevent cop-specific Excludes from
-# overwriting the AllCops defaults above:
-#
-#   inherit_mode:
-#     merge:
-#       - Exclude
-
-# Run the Rails cops by default (-R/--rails not required):
-Rails:
-  Enabled: true
-
-##################### Layout #################################
-
-Layout/DotPosition:
-  # Multi-line method chaining should be done with trailing dots.
-  EnforcedStyle: trailing
-
-Layout/HashAlignment:
-  EnforcedColonStyle:
-  - key
-  - table
-  EnforcedHashRocketStyle:
-  - key
-  - table
-
-##################### Style ##################################
-
-# We make use of block comments, e.g. for validation documentation.
-Style/BlockComments:
-  Enabled: false
-
-Style/Documentation:
-  Exclude:
-  - 'test/**/*.rb'
-
-Style/FrozenStringLiteralComment:
-  # We're not confident enough to make this recommendation everywhere
-  Enabled: false
-
-Style/ModuleFunction:
-  # `extend self` has fewer side effects than `module_function`.
-  EnforcedStyle: extend_self
-
-Style/NumericLiterals:
-  Exclude:
-  - 'db/migrate/*.rb'
-  - 'test/**/*.rb'
-
-Style/YodaCondition:
-  # Disagree; literals as first argument can guard against accidental assignment.
-  Enabled: false
-
-Style/SingleLineBlockParams:
-  # Prefer readability of contextually-named variables.
-  Enabled: false
-
-##################### Metrics ##################################
-# NOTE: we bump some metrics by 50%, in recognition of Rubocop's
-#       desire to split that which we would consider atomic.
-
-Metrics/AbcSize:
-  Max: 23
-  Exclude:
-  - 'db/migrate/*.rb'
-  - 'test/**/*.rb'
-
-Metrics/BlockLength:
-  # We're already limiting method size, blocks outside of methods
-  # can legitimately be long (RuboCop defaults to max: 25 lines).
-  Enabled: false
-
-Metrics/ClassLength:
-  Max: 150
-  Exclude:
-  - 'db/migrate/*.rb'
-  - 'test/**/*.rb'
-
-Metrics/ModuleLength:
-  Max: 150
-  Exclude:
-  - 'test/**/*.rb'
-
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-Layout/LineLength:
-  Max: 100
-  Exclude:
-  - 'db/migrate/*.rb'
-  - 'test/**/*.rb'
-
-Metrics/MethodLength:
-  Max: 15
-  Exclude:
-  - 'db/migrate/*.rb'
-  - 'test/**/*.rb'
-
-Metrics/PerceivedComplexity:
-  Max: 12
-
-##################### Rails ##################################
-
-Rails/ActionFilter:
-  # 'action' is the default already; we explicitly list here as Rails 3.x
-  # projects will want to override this configuration to use 'filter' instead.
-  EnforcedStyle: action
-
-Rails/DynamicFindBy:
-  Exclude:
-  - 'test/integration/**/*.rb'
-
-Rails/RefuteMethods:
-  Enabled: false
-
-Rails/SkipsModelValidations:
-  # Methods like 'update_column' exist for a reason, and it is the developer's
-  # responsibilty to understand the behaviour of the code they write; blanket
-  # avoiding them is not helpful/practical.
-  Enabled: false
-
+require: ndr_dev_support

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 ## [Unreleased]
 *no unreleased changes*
 
+## 5.5.0 / 2020-01-27
+* bundle master RuboCop config, and allow it to be `required`
+
 ## 5.4.8 / 2020-01-24
 ### Fixed
 * deploy: insert temporary DB config to allow asset precompilation

data/README.md

@@ -49,16 +49,22 @@ For more details of the audit tasks available, execute:
 
 ### RuboCop configuration
 
-ndr_dev_support includes tweaks to the default Ruby Style Guide, to better suit NDR.
-To use this updated style guide from within a project, add the following to top of the project's `.rubocop.yml` file:
+`ndr_dev_support` includes tweaks to the default Ruby and Ruby on Rails Style Guides, to better suit NDR.
+To use these updated style guides from within a project, add the following to top of the project's `.rubocop.yml` file:
 
 ```yaml
-inherit_from: 'https://raw.githubusercontent.com/PublicHealthEngland/ndr_dev_support/master/.rubocop.yml'
+require: ndr_dev_support
 ```
 
-RuboCop also allows `inherit_gem`, but this currently doesn't work with relative paths (paths are deemed relative to the config file, rather than the project including `ndr_dev_support`).
+Or, if using other extensions too:
 
-In order for these configuration to apply, you will need to invoke RuboCop using Bundler:
+```yaml
+require:
+  - ndr_dev_support
+  - some_other_extension
+```
+
+In order for these configurations to apply, you will need to invoke RuboCop using Bundler:
 
 ```
 $ bundle exec rubocop .

data/code_safety.yml

@@ -11,7 +11,7 @@ file safety:
   ".rubocop.yml":
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 83097be1002f924a37fcbd6d9099e08e9ed65621
+    safe_revision: 6211cff0ce44645ed3752723b5b0ee65f24c66aa
   ".travis.yml":
     comments: 
     reviewed_by: josh.pencheon
@@ -19,7 +19,7 @@ file safety:
   CHANGELOG.md:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 57f7530eb0be94318d40a09a9648ca3df9d7575b
+    safe_revision: aa0d11190daa8842da406b933d61c4043823ef9a
   CODE_OF_CONDUCT.md:
     comments: 
     reviewed_by: timgentry
@@ -35,7 +35,7 @@ file safety:
   README.md:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: dd220d1cd30d878bf8a35495efe474f08c5c0971
+    safe_revision: 2cf2b6e3ce2f054289699527c13cd7d795347ce3
   Rakefile:
     comments: 
     reviewed_by: josh.pencheon
@@ -48,6 +48,10 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
+  config/rubocop/ndr.yml:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 6211cff0ce44645ed3752723b5b0ee65f24c66aa
   gemfiles/Gemfile.rails52:
     comments: 
     reviewed_by: josh.pencheon
@@ -66,8 +70,8 @@ file safety:
     safe_revision: 26efe45f35f211e7cb7a04967c51c0b6d116321e
   lib/ndr_dev_support.rb:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
+    reviewed_by: josh.pencheon
+    safe_revision: 6211cff0ce44645ed3752723b5b0ee65f24c66aa
   lib/ndr_dev_support/capistrano/assets.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -180,6 +184,10 @@ file safety:
     comments: 
     reviewed_by: josh.pencheon
     safe_revision: e56876f46536ba006a9b68029306f41a188bf9c6
+  lib/ndr_dev_support/rubocop/inject.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: 6211cff0ce44645ed3752723b5b0ee65f24c66aa
   lib/ndr_dev_support/rubocop/range_augmenter.rb:
     comments: 
     reviewed_by: joshpencheon
@@ -203,7 +211,7 @@ file safety:
   lib/ndr_dev_support/version.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 57f7530eb0be94318d40a09a9648ca3df9d7575b
+    safe_revision: aa0d11190daa8842da406b933d61c4043823ef9a
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support

data/config/rubocop/ndr.yml

@@ -0,0 +1,138 @@
+# This file contains NDR's agreed deviations from the standard Ruby
+# Style Guide, the configuration for which can be found here:
+#   https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+#
+# See the README for instructions on using in a project.
+
+require:
+  - rubocop-rails
+
+AllCops:
+  # All cops should ignore files in the following locations:
+  Exclude:
+  - 'bin/*'
+  - 'db/schema.rb'
+  - 'lib/generators/**/templates/*'
+  - 'tmp/**/*'
+  - 'vendor/**/*'
+
+# Once supported by RuboCop, this will prevent cop-specific Excludes from
+# overwriting the AllCops defaults above:
+#
+#   inherit_mode:
+#     merge:
+#       - Exclude
+
+# Run the Rails cops by default (-R/--rails not required):
+Rails:
+  Enabled: true
+
+##################### Layout #################################
+
+Layout/DotPosition:
+  # Multi-line method chaining should be done with trailing dots.
+  EnforcedStyle: trailing
+
+Layout/HashAlignment:
+  EnforcedColonStyle:
+  - key
+  - table
+  EnforcedHashRocketStyle:
+  - key
+  - table
+
+##################### Style ##################################
+
+# We make use of block comments, e.g. for validation documentation.
+Style/BlockComments:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+  - 'test/**/*.rb'
+
+Style/FrozenStringLiteralComment:
+  # We're not confident enough to make this recommendation everywhere
+  Enabled: false
+
+Style/ModuleFunction:
+  # `extend self` has fewer side effects than `module_function`.
+  EnforcedStyle: extend_self
+
+Style/NumericLiterals:
+  Exclude:
+  - 'db/migrate/*.rb'
+  - 'test/**/*.rb'
+
+Style/YodaCondition:
+  # Disagree; literals as first argument can guard against accidental assignment.
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  # Prefer readability of contextually-named variables.
+  Enabled: false
+
+##################### Metrics ##################################
+# NOTE: we bump some metrics by 50%, in recognition of Rubocop's
+#       desire to split that which we would consider atomic.
+
+Metrics/AbcSize:
+  Max: 23
+  Exclude:
+  - 'db/migrate/*.rb'
+  - 'test/**/*.rb'
+
+Metrics/BlockLength:
+  # We're already limiting method size, blocks outside of methods
+  # can legitimately be long (RuboCop defaults to max: 25 lines).
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 150
+  Exclude:
+  - 'db/migrate/*.rb'
+  - 'test/**/*.rb'
+
+Metrics/ModuleLength:
+  Max: 150
+  Exclude:
+  - 'test/**/*.rb'
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+  - 'db/migrate/*.rb'
+  - 'test/**/*.rb'
+
+Metrics/MethodLength:
+  Max: 15
+  Exclude:
+  - 'db/migrate/*.rb'
+  - 'test/**/*.rb'
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+##################### Rails ##################################
+
+Rails/ActionFilter:
+  # 'action' is the default already; we explicitly list here as Rails 3.x
+  # projects will want to override this configuration to use 'filter' instead.
+  EnforcedStyle: action
+
+Rails/DynamicFindBy:
+  Exclude:
+  - 'test/integration/**/*.rb'
+
+Rails/RefuteMethods:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  # Methods like 'update_column' exist for a reason, and it is the developer's
+  # responsibilty to understand the behaviour of the code they write; blanket
+  # avoiding them is not helpful/practical.
+  Enabled: false
+

data/lib/ndr_dev_support.rb

@@ -1,5 +1,8 @@
+require 'ndr_dev_support/rubocop/inject'
 require 'ndr_dev_support/version'
 
 module NdrDevSupport
-  # Your code goes here...
+  # Bootstrap our RuboCop config in to any project
+  # when ndr_dev_support is required in .rubocop.yml.
+  Rubocop::Inject.defaults!
 end

data/lib/ndr_dev_support/rubocop/inject.rb

@@ -0,0 +1,26 @@
+require 'rubocop'
+
+module NdrDevSupport
+  module Rubocop
+    # Following approach of rubocop-hq/rubocop-extension-generator,
+    # monkey-patch in default configuration.
+    module Inject
+      def self.defaults!
+        root = Pathname.new(__dir__).parent.parent.parent.expand_path
+        path = root.join('config', 'rubocop', 'ndr.yml').to_s
+
+        # Whereas by default, the raw YAML would be processed, we pass
+        # through the ConfigLoader fully - this ensures `require` and
+        # `inherit_from` statements are properly evaluated.
+        #
+        # PR at rubocop-hq/rubocop-extension-generator/pull/9
+        #
+        config = ::RuboCop::ConfigLoader.load_file(path)
+        puts "configuration from \#{path}" if ::RuboCop::ConfigLoader.debug?
+
+        config = ::RuboCop::ConfigLoader.merge_with_default(config, path)
+        ::RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/ndr_dev_support/version.rb

@@ -2,5 +2,5 @@
 # This defines the NdrDevSupport version. If you change it, rebuild and commit the gem.
 # Use "rake build" to build the gem, see rake -T for all bundler rake tasks (and our own).
 module NdrDevSupport
-  VERSION = '5.4.8'.freeze
+  VERSION = '5.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 5.4.8
+  version: 5.5.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -392,6 +392,7 @@ files:
 - bin/console
 - bin/setup
 - code_safety.yml
+- config/rubocop/ndr.yml
 - gemfiles/Gemfile.rails52
 - gemfiles/Gemfile.rails60
 - lib/minitest/rake_ci.rb
@@ -425,6 +426,7 @@ files:
 - lib/ndr_dev_support/rake_ci/redmine/ticket_resolver.rb
 - lib/ndr_dev_support/rake_ci/simple_cov_helper.rb
 - lib/ndr_dev_support/rubocop/executor.rb
+- lib/ndr_dev_support/rubocop/inject.rb
 - lib/ndr_dev_support/rubocop/range_augmenter.rb
 - lib/ndr_dev_support/rubocop/range_finder.rb
 - lib/ndr_dev_support/rubocop/reporter.rb