radius-spec 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72f2b3e03304c307956320dcaf22bf432d7ddbda2cd893c3b9bd772b8bd3a73b
-  data.tar.gz: cb707ef2cf3c9bdacfefd43047fdb5bf777292acf3adfbb5a251257e63b5d1f7
+  metadata.gz: 623e5f2ff9f43d04105288432e6c098baedf4a782cd079015ebeb7aeb1602d25
+  data.tar.gz: 5c06b3a06f58ea096cfd940c0366ae83b29254b5580cc53378e0004b36e55a2c
 SHA512:
-  metadata.gz: 0df7e27e7c00b3bb076a9b3b84b3076971dd3b15b086e18d350fe43e08116a95637a48213f2a7400169daac766b0e67486fb291bb486906e1cc276acac917490
-  data.tar.gz: 532110d779de9e684f7dc422dbf6413e3f9162901ea8a11380d1d7878d8622c488e5d005bc81e35081624cbc3f30dc254cfd8e4333eb0020cd161d2838c17fd3
+  metadata.gz: 2779d47b61810a6b0f7c079d4e4f993e9564f9e8c63b477e7a79907d857f0c36a00553cb888ea12a6d23d93fedc03193ae55e3e7481274b7e14dbcbcf0cd9b0d
+  data.tar.gz: ddd46b237b7fb16f1693ab44c2a1887b98056cebc03276674b1feedf1e8d456836f66ad1691229679cc8bcf9d45539daa2d3aff78043dcde7a3b52e540cf772f

data/.rubocop.yml

@@ -8,6 +8,7 @@ inherit_from: common_rubocop.yml
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
   Exclude:
+    - 'benchmarks/**/*'
     - 'lib/radius/spec/rspec.rb'
 
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.

data/.travis.yml

@@ -5,6 +5,8 @@ before_install:
   - gem update --system
   - gem install bundler
 bundler_args: --jobs=3 --retry=3 --without documentation debug
+before_script:
+  - "bin/ci-code-review"
 script: bin/ci
 rvm:
   - 2.5

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 0.3.0 (June 15, 2018)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.2.1...v0.3.0)
+
+### Breaking Change
+
+- Lock Rubocop to a minor release version in gemspec (Aaron Kromer, #5)
+
+### Enhancements
+
+- Adjust common Rubocop configuration (Aaron Kromer, #5)
+  - Customize `Style/AndOr` to flag only conditionals allowing `and` / `or` for
+    control flow
+  - Add `find` to functional method blocks
+  - Disable `Style/DoubleNegation` as this is a common Ruby idiom
+  - Disable `Style/StringLiteralsInInterpolation` to stay consistent with our
+    no preferences for single versus double quotes
+
+### Bug Fixes
+
+- Remove `Include` from common Rubocop all cops configuration to fix issues
+  with Rubocop 0.56.0+ not seeing all expected files. (Aaron Kromer, #5)
+
+
 ## 0.2.1 (May 17, 2018)
 
 [Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.2.0...v0.2.1)

data/Gemfile

@@ -7,15 +7,18 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in radius-spec.gemspec
 gemspec
 
+group :benchmark, optional: true do
+  gem 'benchmark-ips', require: false
+  # TODO: See if this gem has an update in the future as it's gemspec is too
+  # strict and it was blocking other gems from installing / updating
+  gem 'kalibera', require: false, git: 'https://github.com/cupakromer/libkalibera.git'
+end
+
 group :debug do
   gem "pry-byebug", "~> 3.6", require: false
   gem "travis", require: false
 end
 
-group :development do
-  gem "rubocop", "~> 0.53", require: false
-end
-
 group :documentation do
   gem 'yard', '~> 0.9', require: false
 end

data/benchmarks/bm_setup.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'kalibera'
+require 'benchmark/ips'
+
+# Enable and start GC before each job run. Disable GC afterwards.
+#
+# Inspired by https://www.omniref.com/ruby/2.2.1/symbols/Benchmark/bm?#annotation=4095926&line=182
+class GCSuite
+  def warming(*)
+    run_gc
+  end
+
+  def running(*)
+    run_gc
+  end
+
+  def warmup_stats(*)
+  end
+
+  def add_report(*)
+  end
+
+private
+
+  def run_gc
+    GC.enable
+    GC.start
+    GC.disable
+  end
+end
+
+def as_boolean(val, default: nil)
+  case val.to_s.strip.downcase
+  when "true", "t", "yes", "y", "on", "1"
+    true
+  when "false", "f", "no", "n", "off", "0"
+    false
+  else
+    raise "Unknown boolean value #{val}" if default.nil?
+    default
+  end
+end
+
+def section(title = nil)
+  puts "\n#### #{title}" if title
+  puts "\n```"
+  GC.start
+  Benchmark.ips do |bench|
+    bench.config suite: GCSuite.new if GC_DISABLED
+    bench.config stats: :bootstrap, confidence: 95
+
+    yield bench
+    bench.compare!
+  end
+  puts "```"
+end
+
+def display_benchmark_header
+  puts
+  puts "### Environment"
+  puts
+  puts RUBY_DESCRIPTION
+  puts "GC Disabled: #{GC_DISABLED}"
+  puts
+  puts "### Test Cases"
+end
+
+GC_DISABLED = as_boolean(ENV['GC_DISABLED'], default: false)

data/benchmarks/call_vs_yield.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/call_vs_yield.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+# rubocop:disable Performance/RedundantBlockCall
+def block_call(&block)
+  block.call
+end
+
+def block_yield(&_block)
+  yield
+end
+
+def block_arg(&_block)
+  1 + 1 # Always do the same amount of work
+end
+
+def no_arg_yield
+  yield
+end
+
+def pass_through(&block)
+  no_arg_yield(&block)
+end
+
+section "Block call vs yield" do |bench|
+  bench.report("block.call") do |times|
+    i = 0
+    while i < times
+      block_call do
+        1 + 1
+      end
+      i += 1
+    end
+  end
+
+  bench.report("block yield") do |times|
+    i = 0
+    while i < times
+      block_yield do
+        1 + 1
+      end
+      i += 1
+    end
+  end
+
+  bench.report("block arg only") do |times|
+    i = 0
+    while i < times
+      block_arg do
+        1 + 1
+      end
+      i += 1
+    end
+  end
+
+  bench.report("no arg yield") do |times|
+    i = 0
+    while i < times
+      no_arg_yield do
+        1 + 1
+      end
+      i += 1
+    end
+  end
+
+  bench.report("pass through block") do |times|
+    i = 0
+    while i < times
+      pass_through do
+        1 + 1
+      end
+      i += 1
+    end
+  end
+end
+# rubocop:enable Performance/RedundantBlockCall
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Block call vs yield
+
+```
+Warming up --------------------------------------
+          block.call   117.672k i/100ms
+         block yield   272.613k i/100ms
+      block arg only   287.821k i/100ms
+        no arg yield   286.217k i/100ms
+  pass through block   251.757k i/100ms
+Calculating -------------------------------------
+          block.call      3.181M (± 0.9%) i/s -     15.886M in   5.010444s
+         block yield     14.017M (± 0.7%) i/s -     70.062M in   5.015163s
+      block arg only     17.835M (± 0.7%) i/s -     88.937M in   5.011243s
+        no arg yield     18.056M (± 0.6%) i/s -     90.158M in   5.010075s
+  pass through block     10.776M (± 0.8%) i/s -     53.876M in   5.019221s
+                   with 95.0% confidence
+
+Comparison:
+        no arg yield: 18056296.4 i/s
+      block arg only: 17835047.6 i/s - same-ish: difference falls within error
+         block yield: 14017426.6 i/s - 1.29x  (± 0.01) slower
+  pass through block: 10776151.4 i/s - 1.68x  (± 0.02) slower
+          block.call:  3180610.0 i/s - 5.68x  (± 0.06) slower
+                   with 95.0% confidence
+```
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: true
+
+### Test Cases
+
+#### Block call vs yield
+
+```
+Warming up --------------------------------------
+          block.call   134.623k i/100ms
+         block yield   276.955k i/100ms
+      block arg only   306.377k i/100ms
+        no arg yield   286.201k i/100ms
+  pass through block   259.025k i/100ms
+Calculating -------------------------------------
+          block.call      3.558M (± 2.6%) i/s -     17.097M in   5.033155s
+         block yield     14.469M (± 0.7%) i/s -     72.285M in   5.013029s
+      block arg only     18.173M (± 0.6%) i/s -     90.688M in   5.005679s
+        no arg yield     18.207M (± 0.6%) i/s -     90.726M in   5.001766s
+  pass through block     10.794M (± 0.8%) i/s -     53.877M in   5.010781s
+                   with 95.0% confidence
+
+Comparison:
+        no arg yield: 18206595.2 i/s
+      block arg only: 18172764.0 i/s - same-ish: difference falls within error
+         block yield: 14469142.9 i/s - 1.26x  (± 0.01) slower
+  pass through block: 10793657.6 i/s - 1.69x  (± 0.02) slower
+          block.call:  3557929.5 i/s - 5.12x  (± 0.14) slower
+                   with 95.0% confidence
+```

data/benchmarks/case_equality_vs_class_check.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/case_equality_vs_class_check.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+section "Class match" do |bench|
+  x = "Any String"
+
+  bench.report("===") do
+    String === x # rubocop:disable Style/CaseEquality
+  end
+
+  bench.report("is_a?") do
+    x.is_a?(String)
+  end
+end
+
+section "Class NO match" do |bench|
+  x = :any_symbol
+
+  bench.report("===") do
+    String === x # rubocop:disable Style/CaseEquality
+  end
+
+  bench.report("is_a?") do
+    x.is_a?(String)
+  end
+end
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: true
+
+### Test Cases
+
+#### Class match
+
+```
+Warming up --------------------------------------
+                 ===   284.703k i/100ms
+               is_a?   280.367k i/100ms
+Calculating -------------------------------------
+                 ===     11.394M (± 0.8%) i/s -     56.941M in   5.014392s
+               is_a?     11.068M (± 0.8%) i/s -     55.232M in   5.007549s
+                   with 95.0% confidence
+
+Comparison:
+                 ===: 11394313.8 i/s
+               is_a?: 11068062.4 i/s - 1.03x  (± 0.01) slower
+                   with 95.0% confidence
+```
+
+#### Class NO match
+
+```
+Warming up --------------------------------------
+                 ===   298.288k i/100ms
+               is_a?   290.294k i/100ms
+Calculating -------------------------------------
+                 ===     10.567M (± 0.7%) i/s -     52.797M in   5.007023s
+               is_a?     10.405M (± 0.7%) i/s -     51.963M in   5.006983s
+                   with 95.0% confidence
+
+Comparison:
+                 ===: 10567130.4 i/s
+               is_a?: 10405382.6 i/s - 1.02x  (± 0.01) slower
+                   with 95.0% confidence
+```

data/benchmarks/cover_vs_include.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/cover_vs_include.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+INT_RANGE = (0..15)
+INT_VAR = 10
+
+section "Integer ranges" do |bench|
+  bench.report('range#cover?') do
+    INT_RANGE.cover?(INT_VAR)
+  end
+
+  bench.report('range#include?') do
+    INT_RANGE.include?(INT_VAR)
+  end
+
+  bench.report('range#member?') do
+    INT_RANGE.member?(INT_VAR)
+  end
+
+  bench.report('plain compare') do
+    0 < INT_VAR && INT_VAR < 15
+  end
+end
+
+BEGIN_OF_JULY = Time.utc(2015, 7, 1)
+END_OF_JULY = Time.utc(2015, 7, 31)
+DAY_IN_JULY = Time.utc(2015, 7, 15)
+
+TIME_RANGE = (BEGIN_OF_JULY..END_OF_JULY)
+
+section "Time ranges" do |bench|
+  bench.report('range#cover?') do
+    TIME_RANGE.cover?(DAY_IN_JULY)
+  end
+
+  bench.report('range#include?') do
+    TIME_RANGE.include?(DAY_IN_JULY)
+  end
+
+  bench.report('range#member?') do
+    TIME_RANGE.member?(DAY_IN_JULY)
+  end
+
+  bench.report('plain compare') do
+    BEGIN_OF_JULY < DAY_IN_JULY && DAY_IN_JULY < END_OF_JULY
+  end
+end
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Integer ranges
+
+```
+Warming up --------------------------------------
+        range#cover?   247.959k i/100ms
+      range#include?   251.846k i/100ms
+       range#member?   251.416k i/100ms
+       plain compare   305.858k i/100ms
+Calculating -------------------------------------
+        range#cover?      6.400M (± 0.8%) i/s -     31.987M in   5.008881s
+      range#include?      6.328M (± 0.8%) i/s -     31.733M in   5.025377s
+       range#member?      6.366M (± 0.6%) i/s -     31.930M in   5.022146s
+       plain compare     11.042M (± 0.8%) i/s -     55.054M in   4.999666s
+                   with 95.0% confidence
+
+Comparison:
+       plain compare: 11041684.3 i/s
+        range#cover?:  6399832.9 i/s - 1.73x  (± 0.02) slower
+       range#member?:  6366323.6 i/s - 1.73x  (± 0.02) slower
+      range#include?:  6327682.0 i/s - 1.75x  (± 0.02) slower
+                   with 95.0% confidence
+```
+
+#### Time ranges
+
+```
+Warming up --------------------------------------
+        range#cover?   249.380k i/100ms
+      range#include?   247.775k i/100ms
+       range#member?   247.446k i/100ms
+       plain compare   223.517k i/100ms
+Calculating -------------------------------------
+        range#cover?      5.942M (± 0.7%) i/s -     29.676M in   5.002164s
+      range#include?      5.724M (± 0.7%) i/s -     28.742M in   5.028509s
+       range#member?      5.771M (± 0.7%) i/s -     28.951M in   5.024809s
+       plain compare      4.751M (± 0.9%) i/s -     23.916M in   5.046978s
+                   with 95.0% confidence
+
+Comparison:
+        range#cover?:  5941582.8 i/s
+       range#member?:  5770708.7 i/s - 1.03x  (± 0.01) slower
+      range#include?:  5723795.5 i/s - 1.04x  (± 0.01) slower
+       plain compare:  4750545.5 i/s - 1.25x  (± 0.01) slower
+                   with 95.0% confidence
+```