ndr_dev_support 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d05cff14bd3e934da25aa7c61393b21781c2d2b2
-  data.tar.gz: a5c68805421f5b62c3af2ba7173659e1dff20ac9
+  metadata.gz: 5ba6131ef761d1d8b2fb442bd73356f764ddc325
+  data.tar.gz: af5629685eee9297d3ac137e8105193b4aa2c370
 SHA512:
-  metadata.gz: 20c50dba870dddf9e92c23b9bbddc6b12ede7596a262926bfbd2d6811f2254971a600683e55ce4ac106bf495a7205fd7183e60147777a7d1277f449be297b28a
-  data.tar.gz: 01de99ac267f20da8a8187f16bac9f2075589a84cf5fd84c34a638647071996fccf314d3dbb3b2b6741481b7f1c9bcba519958ad051ba224adfecb5782e01989
+  metadata.gz: 5094045b9d8b7ed2d6ae03459a1cb1e40f771d4136246ec5addc69db103e1add3d478a12e7dbffc4cdb74f8cc3c5b9563e3b82815ca0f31e9c83dbcecd3ce639
+  data.tar.gz: 4313585e21ce9e76d2026de9addfacc0e93df926f53216597f1541de1761e31cb3c05c696b69c24c805c8b4e7e10f2a12f45b2d571b17668d0ade0e6dc9a797c

data/.rubocop.yml

@@ -1,19 +1,83 @@
-# By default, would enforce { key: value } rather than { :key => value }.
-# AllCops:
-#   RunRailsCops: true
+# 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.
+
+AllCops:
+  # All cops should ignore files in the following locations:
+  Exclude:
+    - 'bin/*'
+    - 'db/**/*'
+    - 'lib/generators/**/templates/*'
+    - 'vendor/**/*'
+
+# Run the Rails cops by default (-R/--rails not required):
+Rails:
+  Enabled: true
+
+##################### Style ##################################
+
+# We make use of block comments, e.g. for validation documentation.
+Style/BlockComments:
+  Enabled: false
 
-# Multi-line method chaining should be done with trailing dots.
 Style/DotPosition:
+  # Multi-line method chaining should be done with trailing dots.
   EnforcedStyle: trailing
 
-# ...
-LineLength:
-  Max: 99
+Style/IfUnlessModifier:
+  MaxLineLength: 100
+
+Style/ModuleFunction:
+  # `extend self` has fewer side effects than `module_function`.
+  EnforcedStyle: extend_self
+
+Style/NumericLiterals:
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/SingleLineBlockParams:
+  # Prefer readability of contextually-named variables.
+  Enabled: false
+
+Style/WhileUntilModifier:
+  MaxLineLength: 100
+
+##################### Metrics ##################################
+# NOTE: we bump some metrics by 50%, in recognition of Rubocop's
+#       desire to split that which we would consider atomic.
 
-# Relax some of the cops for tests
 Metrics/ClassLength:
+  Max: 150
   Exclude:
     - test/**/*.rb
+
+Metrics/ModuleLength:
+  Max: 150
+  Exclude:
+    - test/**/*.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - test/**/*.rb
+
 Metrics/MethodLength:
+  Max: 15
   Exclude:
     - 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
+

data/README.md

@@ -1,10 +1,11 @@
-## NdrDevSupport [![Build Status](https://travis-ci.org/PublicHealthEngland/ndr_dev_support.svg?branch=master)](https://travis-ci.org/PublicHealthEngland/ndr_dev_support)
+## NdrDevSupport [![Build Status](https://travis-ci.org/PublicHealthEngland/ndr_dev_support.svg?branch=master)](https://travis-ci.org/PublicHealthEngland/ndr_dev_support) [![Gem Version](https://badge.fury.io/rb/ndr_dev_support.svg)](https://badge.fury.io/rb/ndr_dev_support)
 
 This is the Public Health England (PHE) National Disease Registers (NDR) Developer Support ruby gem,
 providing:
 
-1. rake tasks to manage code auditing of ruby based projects; and
-2. a rake task to limit Rubocop's output to changed (and related) code.
+1. rake tasks to manage code auditing of ruby based projects
+2. rake tasks to limit Rubocop's output to changed (and related) code
+3. integration testing support, which can be required from a project's `test_helper.rb`
 
 ## Installation
 
@@ -38,9 +39,26 @@ For more details of the audit tasks available, execute:
 
     $ rake -T audit
 
+### 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:
+
+```yaml
+inherit_gem:
+  ndr_dev_support: .rubocop.yml
+```
+
+In order for these configuration to apply, you will need to invoke RuboCop using Bundler:
+
+```
+$ bundle exec rubocop .
+```
+...or use the bundled rake task (see next section).
+
 ### RuboCop filtering
 
-ndr_dev_support provides rake tasks to enable more targeted use of RuboCop, to analyse only relevant code changes:
+ndr_dev_support also provides rake tasks to enable more targeted use of RuboCop, to analyse only relevant code changes:
 ```
 $ rake rubocop:diff HEAD
 $ rake rubocop:diff HEAD~3..HEAD~2

data/code_safety.yml

@@ -6,8 +6,8 @@ file safety:
     safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
   ".rubocop.yml":
     comments: 
-    reviewed_by: joshpencheon
-    safe_revision: e1ead45a8d1fd525f3a39cc4a87e6c0338c6b879
+    reviewed_by: timgentry
+    safe_revision: 1cc4e768fd872e0776962c50fa220a17ee738558
   ".travis.yml":
     comments: 
     reviewed_by: josh.pencheon
@@ -26,8 +26,8 @@ file safety:
     safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
   README.md:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
+    reviewed_by: timgentry
+    safe_revision: 337228acefd995d094490b51f554c74aeec69e89
   Rakefile:
     comments: 
     reviewed_by: josh.pencheon
@@ -86,8 +86,8 @@ file safety:
     safe_revision: a55c971cb770a8e5dc4be7ed66663dd5d695fcd1
   lib/ndr_dev_support/version.rb:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 5ad343255973352fe41a9285ea7234276ebc49ab
+    reviewed_by: timgentry
+    safe_revision: d34d36104299c4debfd2a02cd1af050fcbbcc3e8
   lib/tasks/audit_code.rake:
     comments: Identical to the version reviewed by josh.pencheon when contained within
       ndr_support
@@ -99,12 +99,12 @@ file safety:
     safe_revision: 41cf1558f567928faaa1e670a36d941c03c78044
   ndr_dev_support.gemspec:
     comments: 
-    reviewed_by: josh.pencheon
-    safe_revision: 88ac9269eb8f0b44c5920a946708e4715421bcad
+    reviewed_by: timgentry
+    safe_revision: 73f74aa9091f21a153a0e9ba140aedbc7b94da90
   test/ndr_dev_support_test.rb:
     comments: 
     reviewed_by: timgentry
-    safe_revision: c59a45986f8b6d087c8c21b1e889f31f7346da17
+    safe_revision: 26a8907a7a8a6b0d836aa12ca0335fa40be12240
   test/test_helper.rb:
     comments: 
     reviewed_by: timgentry

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 = '1.2.1'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/ndr_dev_support.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.2'
 
   # Rubocop dependencies:
-  spec.add_dependency 'rubocop', '0.36.0'
+  spec.add_dependency 'rubocop', '0.44.0'
   spec.add_dependency 'parser'
   spec.add_dependency 'rainbow'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_dev_support
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.44.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.44.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: NDR Developer Support library