radius-spec 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39d958bd163dfff166917fa80d417ccf9afcfe576ec63e18863a75b5fdd46781
-  data.tar.gz: '0722783dcba93751f3b78462b9c7f75c468532b1d3f1bc929316859ed2ba3825'
+  metadata.gz: 199cf6c21d0f54935244a6f92f77bfd2292648ae7817e0dc6d2556dca0cddb40
+  data.tar.gz: fe88a096f2fac711be28918c786242796616375dfd5f7d038210c577104866a2
 SHA512:
-  metadata.gz: 5ecde76170420bfd8af1f96e7430a771ac2ded9f033f4cdb509f5abe74e523ee9e9f8df8a308062f6dd6a4ba8f5f50387fdeb83fb5abb0cea1265fcbb4431f1a
-  data.tar.gz: 4e88ba079d4c3e64a810ec77dc0d88ab7129e7c870c473cf2ab94029a4ff2c7db69f485f44e949e0a2630aa2db86bbef5426987cb28e23ef99e50c2bd330957a
+  metadata.gz: d881caef9047764de02e3e59a2de2722c620ecfd4c55c825d19d6ac2a90dceeb8e229a52363120991fd6c166737ddfef8f49e3b3b74621da9eed27318dfc221b
+  data.tar.gz: c8a090b6431ec6c6d3439b4947ac4640ddeb10f9b48c6c29c992e7207c0a71f1e5db48c26d630fdc95830be79b62c99ed1b2d4599eccd28c61a206615cf2de12

data/.rubocop.yml

@@ -8,3 +8,9 @@ inherit_from: common_rubocop.yml
 Metrics/BlockLength:
   Exclude:
     - 'lib/radius/spec/rspec.rb'
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Exclude:
+    - 'radius-spec.gemspec'

data/.travis.yml

@@ -1,6 +1,9 @@
 sudo: false
 language: ruby
 cache: bundler
+before_install:
+  - gem update --system
+  - gem install bundler
 bundler_args: --jobs=3 --retry=3 --without documentation debug
 script: bin/ci
 rvm:

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.2.0 (May 17, 2018)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.1.1...v0.2.0)
+
+### Enhancements
+
+- Adjust common Rubocop configuration (Aaron Kromer, #2):
+  - Ignore `Lint/AmbiguousBlockAssociation` for specs
+  - Ignore long lines due to Rubocop directives
+  - Ignore long lines due to comments
+  - Prefer a line length of 80, but don't complain until 100
+  - Disable ASCII only comments
+  - Set the `MinSize` for `Style/SymbolArray` and `Style/WordArray` to three
+  - Use squiggly `<<~` heredoc indentation
+  - Allow common `EOF` as a heredoc delimiter
+  - Indent multi-line operations
+  - Allow unspecified rescue as a catch-all
+- Adjust common Rubocop Rails configuration (Aaron Kromer, #2):
+  - Ignore `Rails/ApplicationRecord` for benchmarks
+  - Ignore more common gem binstubs
+
+
 ## 0.1.1 (March 16, 2018)
 
 [Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.1.0...v0.1.1)

data/common_rubocop.yml

@@ -51,6 +51,47 @@ Layout/ClosingParenthesisIndentation:
 Layout/FirstParameterIndentation:
   Enabled: false
 
+# This project only uses newer Ruby versions which all support the "squiggly"
+# style. We prefer to use pure Ruby calls when possible instead of relying on
+# alternatives; even for Rails app.
+#
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  EnforcedStyle: squiggly
+
+# We tend to indent multi-line operation statements. I think this is because
+# it's tends to be the default style auto-formatted by VIM (which many of us
+# use). It also helps show the continuation of the statement instead of it
+# potentially blending in with the start of the next statement.
+#
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# In our specs Rubocop inconsistently complains when using the block form of
+# `expect` and `change`. It accepts code when a method is chained onto
+# `change`, but otherwise it complains. Since this is a widely used pattern in
+# our specs we just tell Rubocop to ignore our spec files.
+#
+#     # Acceptable to Rubocop
+#     expect {
+#       some_action
+#     }.to change {
+#       object.state
+#     }.from(:original).to(:updated)
+#
+#     # Rubocop complains
+#     expect {
+#       some_action
+#     }.to change {
+#       object.state
+#     }
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
 # Often with benchmarking we don't explictly "use" a variable or return value.
 # We simply need to perform the operation which generates said value for the
 # benchmark.
@@ -69,6 +110,39 @@ Metrics/BlockLength:
     - 'spec/**/*_spec.rb'
     - 'spec/support/model_factories.rb'
 
+# We generally prefer to use the default line length of 80. Though sometimes
+# we just need a little extra space because it makes it easier to read.
+#
+# The only way to disable Rubocop for a single line is either to wrap the line
+# with two comments or append the disable comment to the end of the line. For
+# guard clauses, we tend to prefer trailing comments to avoid adding two lines
+# just to disable a cop on one line.
+#
+# Sometimes comments include ASCII diagrams, flow charts, etc. These cannot
+# always be reformatted to fit within the 80 column limit. Also, we write most
+# comments in markdown format. Rubocop isn't very good at understanding when
+# the line is long because of a URL in a markdown link. Instead of requiring
+# additional comments to turn this cop off for comments we ignore any long
+# lines which are only comments.
+#
+# There are also cases where for one valid reason or another we have a trailing
+# comment that extends a little too far. We'd like to be able to ignore those
+# as well. This _attempts_ to do that, however, as this uses simple regular
+# expressions we can only attempt to match so much. We probably should change
+# this for a node pattern matcher in the future.
+#
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes,
+#                           IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  IgnoreCopDirectives: true
+  IgnoredPatterns:
+    # Leading comments
+    - '\A\s*#'
+    # Attempt at trailing comments
+    - '\A.{1,78}\s#\s.*\z'
+  Max: 100
+
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
@@ -77,6 +151,18 @@ Naming/FileName:
     - '**/*.gemspec'
     - '**/Brewfile'
 
+# This allows `EOF` as the only `EO*` variant.
+#
+# `EOF` is a common terminal abbreviate indicating end-of-file. We allow this
+# for those heredocs which represent "file" text.
+#
+# Configuration parameters: Blacklist.
+# Blacklist: END, (?-mix:EO[A-Z]{1})
+Naming/HeredocDelimiterNaming:
+  Blacklist:
+    - 'END'
+    - '(?-mix:EO[A-EG-Z]{1})'
+
 # `alias` behavior changes on scope. In general we expect the behavior to be
 # that which is defined by `alias_method`.
 #
@@ -87,6 +173,13 @@ Naming/FileName:
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
+# These days most people have editors which support unicode and other
+# non-ASCII characters.
+#
+# Configuration parameters: AllowedChars.
+Style/AsciiComments:
+  Enabled: false
+
 # Use semantic style for blocks:
 #   - Prefer `do...end` over `{...}` for procedural blocks.
 #   - Prefer `{...}` over `do...end` for functional blocks.
@@ -215,6 +308,47 @@ Style/NumericPredicate:
 Style/RegexpLiteral:
   EnforcedStyle: mixed
 
+# If you only need to rescue a single, or predefined set of exceptions, then
+# catch the exceptions explicitly. However, when you need to include a general
+# error handler / "catch-all" use the "unspecified rescue".
+#
+# Using the unspecified `rescue` on blocks is common Ruby practice. It is a
+# core feature of the language which has semantic meaning. The Rubocop docs do
+# not provide much justification for defaulting to an explicit style and there
+# is no real mention of this in the associated style guide except the following
+# buried in an example for [_Avoid rescuing the `Exception`
+# class_](https://github.com/bbatsov/ruby-style-guide#no-blind-rescues) though
+# the anchor suggests this is for "no blind rescues":
+#
+# > # a blind rescue rescues from StandardError, not Exception as many
+# > # programmers assume.
+#
+# Our general rule for Ruby exceptions is to create your custom errors from
+# `StandardError`. Creating custom errors off of `Exception` is reserved for
+# special edge cases where you don't intend for someone to normally catch it
+# (such as system resource issues; e.g. `NoMemoryError`, `SecurityError`).
+#
+# With that in mind, we can make the same counter argument that since
+# programmers generally assume the unspecified rescue rescues `Exception`,
+# which they normally should not be rescuing, system errors are more likely to
+# noticed.
+#
+# Additionally, use of the unspecified rescue looks and behaves like a
+# "catch-all" or the `else` clause in a `case` statement:
+#
+#   begin
+#     # do something that may cause a standard error
+#   rescue TypeError
+#     handle_type_error
+#   rescue => e
+#     handle_error e
+#   end
+#
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, explicit
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
 # We generally prefer double quotes but many generators use single quotes. We
 # don't view the performance difference to be all that much so we don't care
 # if the style is mixed or double quotes are used for static strings.
@@ -224,6 +358,18 @@ Style/RegexpLiteral:
 Style/StringLiterals:
   Enabled: false
 
+# We don't feel too strongly about percent vs bracket array style. We tend to
+# use the percent style, which also happens to be Rubocop's default. So for
+# pedantic consistency we'll enforce this.
+#
+# However, as we don't feel that strongly about this we'll increase the
+# minimum size to 3 to allow very small arrays to exist either way.
+#
+# Configuration parameters: EnforcedStyle, MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  MinSize: 3
+
 # When ternaries become complex they can be difficult to read due to increased
 # cognative load parsing the expression. Cognative load can increase further
 # when assignment is involved.
@@ -282,6 +428,18 @@ Style/TrailingCommaInHashLiteral:
     simplifies adding, removing, and re-arranging the elements.
   EnforcedStyleForMultiline: consistent_comma
 
+# We don't feel too strongly about percent vs bracket array style. We tend to
+# use the percent style, which also happens to be Rubocop's default. So for
+# pedantic consistency we'll enforce this.
+#
+# However, as we don't feel that strongly about this we'll increase the
+# minimum size to 3 to allow very small arrays to exist either way.
+#
+# Configuration parameters: EnforcedStyle, MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  MinSize: 3
+
 # When it comes to constants it's safer to place the constant on the right-hand
 # side. With a constant accidental assignment will produce a syntax error.
 #

data/common_rubocop_rails.yml

@@ -11,9 +11,11 @@ Rails:
 AllCops:
   Exclude:
     - 'bin/puma'
+    - 'bin/pumactl'
     - 'bin/rails'
     - 'bin/shoryuken'
     - 'bin/sidekiq'
+    - 'bin/sidekiqctl'
     - 'bin/spring'
     - 'db/schema.rb'
     - 'db/migrate/**/*'
@@ -36,6 +38,17 @@ Metrics/LineLength:
     - '\A#  fk_rails_'
     - '\A#  index_'
 
+# Ignore subclass parent for one off benchmarks
+#
+# Benchmarks are generally meant to be small and targeted. They often have
+# custom model declarations which help direct the focus of the benchmarks.
+# These one-off models exist outside of the main Rails app. We don't want this
+# cop to run for them because including `ApplicationRecord` is unnecessary in
+# these cases and just adds noise to the setup.
+Rails/ApplicationRecord:
+  Exclude:
+    - 'benchmarks/**/*'
+
 # As Rails defaults to creating timestamps you need to go out of your way to
 # explicitly have them removed from the table. This cop is almost always a
 # false negative so we're disabling it.

data/lib/radius/spec/version.rb

@@ -2,6 +2,6 @@
 
 module Radius
   module Spec
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/radius-spec.gemspec

@@ -10,6 +10,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Radius Networks", "Aaron Kromer"]
   spec.email         = ["support@radiusnetworks.com"]
 
+  spec.metadata      = {
+    "bug_tracker_uri" => "https://github.com/RadiusNetworks/radius-spec/issues",
+    "changelog_uri"   => "https://github.com/RadiusNetworks/radius-spec/blob/v#{Radius::Spec::VERSION}/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/RadiusNetworks/radius-spec/tree/v#{Radius::Spec::VERSION}",
+  }
   spec.summary       = "Radius Networks RSpec setup and plug-ins"
   spec.description   = "Standard RSpec setup and a collection of plug-ins " \
                        "to help improve specs."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: radius-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Radius Networks
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,7 +91,10 @@ files:
 homepage: https://github.com/RadiusNetworks/radius-spec
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/RadiusNetworks/radius-spec/issues
+  changelog_uri: https://github.com/RadiusNetworks/radius-spec/blob/v0.2.0/CHANGELOG.md
+  source_code_uri: https://github.com/RadiusNetworks/radius-spec/tree/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: