defra_ruby_style 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29b0b223aa2eeffdc62e2d839134a2c71db7a354
-  data.tar.gz: 602b2ce08954050f68f36f26dd2df67bedabb023
+  metadata.gz: 0c6dd1fde6b73075da53caf161fde3e56508926e
+  data.tar.gz: a3b19d22fe67b54f50f3f425e6cfea3baf5692b9
 SHA512:
-  metadata.gz: 1841e1547bb97ed4ae7ced8f608a4b22f103e0dd1640effb8ad483a47059e50bed83608aa5a058555da1ece901a977c9e72cb42a6d73b7dab69c021266e2a7fd
-  data.tar.gz: 7055b465fbca3f84a69b478090878a2690d1349bb2d43bf9c35bf0ae0521a0d96de1df91fc1a77594750d4769e95f1dd1bc2cabd78733983c6dd6714e01f6113
+  metadata.gz: fecbab42bca3a7a25495575a09ce70a4fa9ace8f796880d810a1d6c8583007abdd5799458f2b4de33d888931720751f59abfc379f943da4f51c922743ecee768
+  data.tar.gz: 1251fb973723f7e0afca8407b3d2e204f71fc11347914c87706b489196a6bd63f14574fedd9d29b8393e3e45189c77733c1dab18465702ca65140ad36539ebbc

data/README.md

@@ -1,6 +1,8 @@
 <img src="/defra-ruby-style.png" alt="Defra ruby style logo" />
 
 [![Build Status](https://travis-ci.com/DEFRA/defra-ruby-style.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-style)
+[![Gem Version](https://badge.fury.io/rb/defra_ruby_style.svg)](https://badge.fury.io/rb/defra_ruby_style)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
 
 This repository is used to manage the ruby code style we use at DEFRA.
 

data/default.yml

@@ -0,0 +1,107 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  # Cop names are not displayed in offense messages by default. We find it
+  # useful to include this information so we can use it to investigate what the
+  # fix may be.
+  DisplayCopNames: true
+  # Style guide URLs are not displayed in offense messages by default. Again we
+  # find it useful to go straight to the documentation for a rule when
+  # investigating what the fix may be.
+  DisplayStyleGuide: true
+  Include:
+    - "**/*.gemspec"
+    - "**/*.rake"
+    - "**/*.thor"
+    - "**/*.rb"
+    - "**/*.ru"
+    - "**/Gemfile"
+    - "**/Rakefile"
+  Exclude:
+    # config contains standard files created when Rails is initialised and
+    # therefore they should be left as is
+    - "config/**/*"
+    # bin contains standard files created when Rails is initialised and
+    # therefore they should be left as is
+    - "bin/**/*"
+    # locally when we run rubocop it ignores the vendor folder but when running
+    # in Travis-CI it seems to include. This will stop this from happening
+    - "vendor/**/*"
+    ## schema.rb is generated automatically based on migrations, so leave as is
+    - "**/db/schema.rb"
+    - "db/migrate*/**/*.rb"
+    # Skip dummy application files as they're only used for testing purposes
+    - "spec/dummy/**/*"
+
+# It is our opinion that code is easier to read if a white space is
+# permitted between the initial declaration and the first statement. Ditto the
+# last statement and the closing tag.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# It's okay to use `catch { foo }` in specs
+#
+# https://github.com/rubocop-hq/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+# We felt as a team that the default size of 15 was too low, and blocked what to
+# us are sound methods which would not add any value if broken up, for example
+# composer type methods. Therefore we agreed to up the score to 30 to allow for
+# these types of methods
+Metrics/AbcSize:
+  Max: 30
+
+# We don't feel it makes sense to split specs and factories over multiple files,
+# or when in a context be forced to try and come up with slightly different ones
+# in order to reduce the block length. Hence we exclude specs and factories from
+# this rule.
+# Shared examples are the same as specs, but don't have the _spec.rb extension
+# hence they are listed separately
+Metrics/BlockLength:
+  Exclude:
+    # We're not bothered about a gemspec file having long block length
+    - "**/*.gemspec"
+    - "spec/**/*_spec.rb"
+    - "spec/shared_examples/**/*.rb"
+    - "spec/factories/**/*.rb"
+    - "spec/support/shared_examples/**/*.rb"
+
+# We believe the default 80 characters is too restrictive and that lines can
+# still be readable and maintainable when no more than 120 characters. This also
+# allows us to maximise our screen space.
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "spec/factories/**/*.rb"
+    - "spec/support/shared_examples/**/*.rb"
+
+# We wish we were good enough to remain within the rubocop limit of 10 lines
+# however we often just seem to tip over by a few lines. Hence we have chosen
+# to bump it to 20.
+Metrics/MethodLength:
+  Max: 20
+
+# Spec files can be quite long, so we shouldn't be forced to break them up
+# if it doesn't make sense.
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "spec/factories/**/*.rb"
+    - "spec/support/shared_examples/**/*.rb"
+
+# As a web app, as long as the team commit to using well named classes for
+# controllers, models etc it should not be necessary to add top-level class
+# documentation.
+Style/Documentation:
+  Enabled: false
+
+# There are no relative performance improvements using '' over "", therefore we believe there is more
+# value in using "" for all strings irrespective of whether string interpolation is used
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/lib/defra/style/version.rb

@@ -2,6 +2,6 @@
 
 module Defra
   module Style
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_style
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Defra
@@ -63,6 +63,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- default.yml
 - lib/defra/style.rb
 - lib/defra/style/version.rb
 homepage: https://github.com/DEFRA/defra-ruby-style