radius-spec 0.2.1 → 0.3.0

data/benchmarks/max_ternary_micro.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/max_ternary_micro.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+section "Min First" do |bench|
+  x = 1
+  y = 2
+
+  bench.report("max") do |times|
+    i = 0
+    while i < times
+      [x, y].max
+      i += 1
+    end
+  end
+
+  bench.report("ternary") do |times|
+    i = 0
+    while i < times
+      (x < y) ? y : x
+      i += 1
+    end
+  end
+end
+
+section "Max First" do |bench|
+  x = 2
+  y = 1
+
+  bench.report("max") do |times|
+    i = 0
+    while i < times
+      [x, y].max
+      i += 1
+    end
+  end
+
+  bench.report("ternary") do |times|
+    i = 0
+    while i < times
+      (x < y) ? y : x
+      i += 1
+    end
+  end
+end
+
+section "Equal values" do |bench|
+  x = 2
+  y = 2
+
+  bench.report("max") do |times|
+    i = 0
+    while i < times
+      [x, y].max
+      i += 1
+    end
+  end
+
+  bench.report("ternary") do |times|
+    i = 0
+    while i < times
+      (x < y) ? y : x
+      i += 1
+    end
+  end
+end
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Min First
+
+```
+Warming up --------------------------------------
+                 max   318.262k i/100ms
+             ternary   330.711k i/100ms
+Calculating -------------------------------------
+                 max     38.997M (± 0.6%) i/s -    193.822M in   5.001947s
+             ternary     48.280M (± 0.5%) i/s -    240.096M in   5.002313s
+                   with 95.0% confidence
+
+Comparison:
+             ternary: 48279773.6 i/s
+                 max: 38996762.1 i/s - 1.24x  (± 0.01) slower
+                   with 95.0% confidence
+```
+
+#### Max First
+
+```
+Warming up --------------------------------------
+                 max   336.333k i/100ms
+             ternary   344.267k i/100ms
+Calculating -------------------------------------
+                 max     38.699M (± 0.7%) i/s -    192.046M in   5.000931s
+             ternary     50.601M (± 0.6%) i/s -    251.315M in   5.002150s
+                   with 95.0% confidence
+
+Comparison:
+             ternary: 50601023.9 i/s
+                 max: 38699482.7 i/s - 1.31x  (± 0.01) slower
+                   with 95.0% confidence
+```
+
+#### Equal values
+
+```
+Warming up --------------------------------------
+                 max   331.543k i/100ms
+             ternary   342.686k i/100ms
+Calculating -------------------------------------
+                 max     39.661M (± 0.6%) i/s -    197.268M in   5.004271s
+             ternary     47.147M (± 0.5%) i/s -    234.740M in   5.006089s
+                   with 95.0% confidence
+
+Comparison:
+             ternary: 47147208.6 i/s
+                 max: 39660659.9 i/s - 1.19x  (± 0.01) slower
+                   with 95.0% confidence
+```

data/benchmarks/unfreeze_string.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/unfreeze_string.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+# rubocop:disable Performance/UnfreezeString
+section "Unfreezing empty string" do |bench|
+  bench.report("String.new") do
+    String.new
+  end
+
+  bench.report("+") do
+    +""
+  end
+
+  bench.report("dup") do
+    "".dup
+  end
+end
+
+STRING = "Any String"
+section "Unfreezing string" do |bench|
+  bench.report("String.new") do
+    String.new(STRING)
+  end
+
+  bench.report("+") do
+    +STRING
+  end
+
+  bench.report("dup") do
+    STRING.dup
+  end
+end
+# rubocop:enable Performance/UnfreezeString
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Unfreezing empty string
+
+```
+Warming up --------------------------------------
+          String.new   262.027k i/100ms
+                   +   286.997k i/100ms
+                 dup   217.963k i/100ms
+Calculating -------------------------------------
+          String.new      6.791M (± 0.9%) i/s -     34.064M in   5.029927s
+                   +      8.811M (± 1.1%) i/s -     43.911M in   5.011455s
+                 dup      4.627M (± 1.0%) i/s -     23.104M in   5.007394s
+                   with 95.0% confidence
+
+Comparison:
+                   +:  8810714.9 i/s
+          String.new:  6791074.6 i/s - 1.30x  (± 0.02) slower
+                 dup:  4626875.0 i/s - 1.90x  (± 0.03) slower
+                   with 95.0% confidence
+```
+
+#### Unfreezing string
+
+```
+Warming up --------------------------------------
+          String.new   220.258k i/100ms
+                   +   287.795k i/100ms
+                 dup   214.192k i/100ms
+Calculating -------------------------------------
+          String.new      4.624M (± 0.8%) i/s -     23.127M in   5.010887s
+                   +      8.946M (± 0.9%) i/s -     44.608M in   5.001680s
+                 dup      4.513M (± 0.9%) i/s -     22.704M in   5.041383s
+                   with 95.0% confidence
+
+Comparison:
+                   +:  8946340.5 i/s
+          String.new:  4624267.9 i/s - 1.93x  (± 0.02) slower
+                 dup:  4513230.8 i/s - 1.98x  (± 0.02) slower
+                   with 95.0% confidence
+```

data/benchmarks/unpack_first.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/unpack_first.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+PACKED_STRING = "foo"
+PACKED_FORMAT = "h*"
+
+# rubocop:disable Style/UnpackFirst
+section "Unpacking strings" do |bench|
+  bench.report("unpack.first") do
+    PACKED_STRING.unpack(PACKED_FORMAT).first
+  end
+
+  bench.report("unpack[0]") do
+    PACKED_STRING.unpack(PACKED_FORMAT)[0]
+  end
+
+  bench.report("unpack1") do
+    PACKED_STRING.unpack1(PACKED_FORMAT)
+  end
+end
+# rubocop:enable Style/UnpackFirst
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Unpacking strings
+
+```
+Warming up --------------------------------------
+        unpack.first   228.848k i/100ms
+           unpack[0]   225.375k i/100ms
+             unpack1   254.431k i/100ms
+Calculating -------------------------------------
+        unpack.first      5.074M (± 1.0%) i/s -     25.402M in   5.021645s
+           unpack[0]      5.412M (± 1.0%) i/s -     27.045M in   5.012499s
+             unpack1      7.185M (± 0.9%) i/s -     35.875M in   5.011588s
+                   with 95.0% confidence
+
+Comparison:
+             unpack1:  7184877.9 i/s
+           unpack[0]:  5412005.1 i/s - 1.33x  (± 0.02) slower
+        unpack.first:  5074389.3 i/s - 1.42x  (± 0.02) slower
+                   with 95.0% confidence
+```

data/bin/ci

@@ -20,4 +20,4 @@ bundle-audit check --update
 
 # Run style checker
 echo " ---> Running rubocop"
-bin/rubocop --extra-details --display-style-guide
+bin/rubocop --extra-details --display-style-guide --lint

data/bin/ci-code-review

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# See:
+#   - https://docs.travis-ci.com/user/environment-variables/#Convenience-Variables
+#   - https://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
+#   - https://docs.travis-ci.com/user/pull-requests/#Pull-Requests-and-Security-Restrictions
+if [[ "$TRAVIS_PULL_REQUEST" = "false" ]] || [[ "$TRAVIS_BRANCH" = "production" ]]; then
+  exit
+fi
+
+set -e
+cd "$(dirname "$0")/.."
+
+REVIEWDOG_VERSION="0.9.9"
+
+if ! [ "$(./bin/reviewdog -version)" = "$REVIEWDOG_VERSION" ]; then
+  echo "Installing reviewdog version ${REVIEWDOG_VERSION}..."
+  curl -fsSL https://github.com/haya14busa/reviewdog/releases/download/$REVIEWDOG_VERSION/reviewdog_linux_amd64 \
+    -o ./bin/reviewdog
+  chmod +x ./bin/reviewdog
+fi
+
+echo Rubocop Version: $(./bin/rubocop --version)
+echo Review Dog Version: $(./bin/reviewdog -version)
+
+# Add `-diff="git diff master"` to reviewdog args when running locally
+./bin/rubocop --config .rubocop.yml --extra-details --display-style-guide --rails | \
+  ./bin/reviewdog -f=rubocop -reporter=github-pr-check

data/common_rubocop.yml

@@ -12,9 +12,6 @@ AllCops:
     - 'bin/yard'
     # Exclude vendored content
     - 'vendor/**/*'
-  Include:
-    - '**/Brewfile'
-    - '**/Rakefile'
 
 # Modifiers should be indented as deep as method definitions, or as deep as the
 # class/module keyword, depending on configuration.
@@ -34,20 +31,14 @@ Layout/AccessModifierIndentation:
 Layout/BlockAlignment:
   Enabled: false
 
-# Disabling this until it is fixed to handle multi-line method chains where the
-# first method call is multi-line.
-#
-# See # https://github.com/bbatsov/rubocop/issues/5650
-Layout/ClosingParenthesisIndentation:
-  Enabled: false
-
 # Disabling this until it is fixed to handle multi-line method chains where the
 # first method call is multi-line.
 #
 # See # https://github.com/bbatsov/rubocop/issues/5650
 #
 # Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: consistent, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+# SupportedStyles: consistent, consistent_relative_to_receiver,
+#                  special_for_inner_method_call, special_for_inner_method_call_in_parentheses
 Layout/FirstParameterIndentation:
   Enabled: false
 
@@ -160,8 +151,7 @@ Naming/FileName:
 # Blacklist: END, (?-mix:EO[A-Z]{1})
 Naming/HeredocDelimiterNaming:
   Blacklist:
-    - 'END'
-    - '(?-mix:EO[A-EG-Z]{1})'
+    - !ruby/regexp '/(^|\s)(EO[A-EG-Z]{1}|END)(\s|$)/'
 
 # `alias` behavior changes on scope. In general we expect the behavior to be
 # that which is defined by `alias_method`.
@@ -173,6 +163,20 @@ Naming/HeredocDelimiterNaming:
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
+# Keeping with our semantic style we allow use of `and` / `or` conditionals
+# when it is used for control flow:
+#
+#     system("some command") or system("another command")
+#
+# Used in this manner it provides additional semantic clues to the intent of
+# the code. However, when there is a conditional, or the intent is to perform
+# a boolean comparison, the `&&` / `||` style should be used.
+#
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, conditionals
+Style/AndOr:
+  EnforcedStyle: conditionals
+
 # These days most people have editors which support unicode and other
 # non-ASCII characters.
 #
@@ -209,6 +213,7 @@ Style/BlockDelimiters:
     - with_object
   FunctionalMethods:
     - each_with_object
+    - find
     - git_source
     - let
     - let!
@@ -221,6 +226,51 @@ Style/BlockDelimiters:
     - proc
     - it
 
+# The double negation idiom is a common Ruby-ism. All languages have various
+# idioms and part of learning the language is learning the common idioms. Once
+# learning the meaning it is not cryptic as Rubocop implies.
+#
+#   > Double negation converts converts a value to boolean.
+#   >
+#   > It converts "truthy" values to `true` and "falsey" values, `nil` and
+#   > `false`, to `false`.
+#
+# The [Rubocop style guide](https://github.com/rubocop-hq/ruby-style-guide#no-bang-bang)
+# does have a valid complaint about it's use in a conditional:
+#
+#   > you don't need this explicit conversion in the condition of a control
+#   > expression; using it only obscures your intention...
+#   >
+#   > ```ruby
+#   > # bad
+#   > x = 'test'
+#   > # obscure nil check
+#   > if !!x
+#   >   # body omitted
+#   > end
+#   >
+#   > # good
+#   > x = 'test'
+#   > if x
+#   >   # body omitted
+#   > end
+#   > ```
+#
+# This is true and we completely agree. However the check isn't limited to just
+# conditional control expressions. It affects any use of the idiom.
+#
+# We believe using the idiom is completely valid for predicate methods to
+# ensure either a `true` or `false` return, instead of just a "truthy" or
+# "falsey" response. As it is an op it is a bit faster than the alternative of
+# sending `nil?` to the object and more concise than using `obj == nil`. It
+# also works with something that is potentially `false` as expected.
+#
+# As we cannot customize this to only limit it to the conditional control
+# expressions, or instances which may be better replaced with something else
+# (like `blank?`), we are disabling it.
+Style/DoubleNegation:
+  Enabled: false
+
 # Using `case` instead of an `if` expression when the case condition is empty
 # can be more expressive of intent. Using multiple "cases" informs the reader
 # that all of the conditions are related or coupled in a meaningful way.
@@ -301,7 +351,17 @@ Style/NumericPredicate:
   Enabled: false
 
 # Prefer slashes for simple expressions. For multi-line use percent literal
-# to support comments and other advanced features.
+# to support comments and other advanced features. By using the mixed style we
+# are choosing to use `%r{}` for multi-line regexps. In general we are not a
+# fan of single vs multi-line dictating a style. We do make an exception in
+# this case because of the parity the braces give to general code block
+# grouping:
+#
+#     regex = %r{
+#       foo
+#       (bar)
+#       (baz)
+#     }x
 #
 # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed
@@ -358,6 +418,15 @@ Style/RescueStandardError:
 Style/StringLiterals:
   Enabled: false
 
+# As with regular string literals we have no real preference for this. Forcing
+# one style of strings over others for this case just adds to Rubocop noise and
+# in our experience developer frustration.
+#
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiteralsInInterpolation:
+  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.