radius-spec 0.2.1 → 0.3.0

data/benchmarks/delete_vs_tr.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/delete_vs_tr.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+[
+  ["No Removal",         "Any String Chars", "m",   ""],
+  ["Single Removal",     "Any String Chars", "i",   ""],
+  ["Multiple Removal",   "Any String Chars", "n",   ""],
+  ["Multi-Char Removal", "Any String Chars", "nar", ""],
+].each do |title, str, pattern, replacement|
+  section title do |bench|
+    bench.report("delete") do
+      str.delete(pattern)
+    end
+
+    bench.report("tr") do
+      str.tr(pattern, replacement)
+    end
+  end
+end
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### No Removal
+
+```
+Warming up --------------------------------------
+              delete   164.989k i/100ms
+                  tr   163.504k i/100ms
+Calculating -------------------------------------
+              delete      2.578M (± 0.9%) i/s -     13.034M in   5.065099s
+                  tr      2.566M (± 0.8%) i/s -     12.917M in   5.039546s
+                   with 95.0% confidence
+
+Comparison:
+              delete:  2578043.5 i/s
+                  tr:  2565794.9 i/s - same-ish: difference falls within error
+                   with 95.0% confidence
+```
+
+#### Single Removal
+
+```
+Warming up --------------------------------------
+              delete   169.321k i/100ms
+                  tr   173.594k i/100ms
+Calculating -------------------------------------
+              delete      2.779M (± 1.1%) i/s -     13.884M in   5.010559s
+                  tr      2.721M (± 1.0%) i/s -     13.714M in   5.050566s
+                   with 95.0% confidence
+
+Comparison:
+              delete:  2778762.2 i/s
+                  tr:  2721121.1 i/s - 1.02x  (± 0.02) slower
+                   with 95.0% confidence
+```
+
+#### Multiple Removal
+
+```
+Warming up --------------------------------------
+              delete   173.074k i/100ms
+                  tr   171.824k i/100ms
+Calculating -------------------------------------
+              delete      2.804M (± 1.0%) i/s -     14.019M in   5.009616s
+                  tr      2.739M (± 1.0%) i/s -     13.746M in   5.030533s
+                   with 95.0% confidence
+
+Comparison:
+              delete:  2804348.9 i/s
+                  tr:  2739399.1 i/s - 1.02x  (± 0.01) slower
+                   with 95.0% confidence
+```
+
+#### Multi-Char Removal
+
+```
+Warming up --------------------------------------
+              delete   165.485k i/100ms
+                  tr   158.961k i/100ms
+Calculating -------------------------------------
+              delete      2.547M (± 1.3%) i/s -     12.742M in   5.019971s
+                  tr      2.507M (± 1.0%) i/s -     12.558M in   5.018688s
+                   with 95.0% confidence
+
+Comparison:
+              delete:  2547442.6 i/s
+                  tr:  2507427.2 i/s - same-ish: difference falls within error
+                   with 95.0% confidence
+```

data/benchmarks/double_negation.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/double_negation.rb
+require_relative 'bm_setup'
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+
+display_benchmark_header
+
+# rubocop:disable Style/NonNilCheck
+# As this is basically a micro-benchmark we use the block with `while` idiom
+[nil, [], Object.new].each do |x|
+  section x.inspect do |bench|
+    bench.report("!!") do |times|
+      i = 0
+      while i < times
+        !!x
+        i += 1
+      end
+    end
+
+    bench.report("!nil?") do |times|
+      i = 0
+      while i < times
+        !x.nil?
+        i += 1
+      end
+    end
+
+    bench.report("nil !=") do |times|
+      i = 0
+      while i < times
+        nil != x
+        i += 1
+      end
+    end
+
+    bench.report("present?") do |times|
+      i = 0
+      while i < times
+        x.present?
+        i += 1
+      end
+    end
+  end
+end
+
+# When performing the initial testing we used `x == nil`. However, that was
+# shockingly slow for the empty array case. Because of that we inverted the
+# conditional in the above condition. However, as proof of this oddity and to
+# allow us to track behavior in future versions we include this additional
+# benchmark showing the issue.
+section "Empty array `nil` comparison" do |bench|
+  x = []
+
+  bench.report("!= nil") do |times|
+    i = 0
+    while i < times
+      nil != x
+      i += 1
+    end
+  end
+
+  bench.report("nil !=") do |times|
+    i = 0
+    while i < times
+      x != nil
+      i += 1
+    end
+  end
+end
+# rubocop:enable Style/NonNilCheck
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: true
+
+### Test Cases
+
+#### nil
+
+```
+Warming up --------------------------------------
+                  !!   320.852k i/100ms
+               !nil?   313.833k i/100ms
+              nil !=   330.298k i/100ms
+            present?   294.813k i/100ms
+Calculating -------------------------------------
+                  !!     41.841M (± 0.6%) i/s -    207.591M in   5.000435s
+               !nil?     30.851M (± 0.7%) i/s -    153.464M in   5.005301s
+              nil !=     38.424M (± 0.5%) i/s -    191.573M in   5.007580s
+            present?     19.660M (± 0.7%) i/s -     97.878M in   4.999761s
+                   with 95.0% confidence
+
+Comparison:
+                  !!: 41841263.8 i/s
+              nil !=: 38424408.4 i/s - 1.09x  (± 0.01) slower
+               !nil?: 30850983.5 i/s - 1.36x  (± 0.01) slower
+            present?: 19660459.4 i/s - 2.13x  (± 0.02) slower
+                   with 95.0% confidence
+```
+
+#### []
+
+```
+Warming up --------------------------------------
+                  !!   317.562k i/100ms
+               !nil?   311.181k i/100ms
+              nil !=   319.266k i/100ms
+            present?   293.159k i/100ms
+Calculating -------------------------------------
+                  !!     42.487M (± 0.6%) i/s -    211.179M in   5.005333s
+               !nil?     31.078M (± 0.5%) i/s -    154.968M in   5.005557s
+              nil !=     38.313M (± 0.6%) i/s -    190.283M in   5.000799s
+            present?     21.854M (± 0.7%) i/s -    108.762M in   5.002198s
+                   with 95.0% confidence
+
+Comparison:
+                  !!: 42487427.1 i/s
+              nil !=: 38312618.0 i/s - 1.11x  (± 0.01) slower
+               !nil?: 31078123.9 i/s - 1.37x  (± 0.01) slower
+            present?: 21854143.8 i/s - 1.94x  (± 0.02) slower
+                   with 95.0% confidence
+```
+
+#### #<Object:0x00007f9c0a968310>
+
+```
+Warming up --------------------------------------
+                  !!   328.432k i/100ms
+               !nil?   307.084k i/100ms
+              nil !=   324.749k i/100ms
+            present?   261.758k i/100ms
+Calculating -------------------------------------
+                  !!     40.897M (± 0.5%) i/s -    203.628M in   5.005426s
+               !nil?     30.242M (± 0.6%) i/s -    150.471M in   5.000563s
+              nil !=     39.610M (± 0.6%) i/s -    197.123M in   5.005610s
+            present?     12.163M (± 0.8%) i/s -     60.728M in   5.011771s
+                   with 95.0% confidence
+
+Comparison:
+                  !!: 40897495.2 i/s
+              nil !=: 39610078.3 i/s - 1.03x  (± 0.01) slower
+               !nil?: 30242403.1 i/s - 1.35x  (± 0.01) slower
+            present?: 12162705.7 i/s - 3.36x  (± 0.03) slower
+                   with 95.0% confidence
+```
+
+#### Empty array `nil` comparison
+
+```
+Warming up --------------------------------------
+              != nil   326.024k i/100ms
+              nil !=   270.805k i/100ms
+Calculating -------------------------------------
+              != nil     40.133M (± 0.5%) i/s -    199.853M in   5.004102s
+              nil !=     11.551M (± 0.9%) i/s -     57.681M in   5.020992s
+                   with 95.0% confidence
+
+Comparison:
+              != nil: 40133046.7 i/s
+              nil !=: 11551012.8 i/s - 3.47x  (± 0.04) slower
+                   with 95.0% confidence
+```

data/benchmarks/empty_literal.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/empty_literal.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+# rubocop:disable Style/EmptyLiteral
+section "[] vs Array.new" do |bench|
+  bench.report("Array.new") do
+    Array.new
+    nil
+  end
+
+  bench.report("[]") do
+    []
+    nil
+  end
+end
+
+section "{} vs Hash.new" do |bench|
+  bench.report("Hash.new") do
+    Hash.new
+    nil
+  end
+
+  bench.report("{}") do
+    {}
+    nil
+  end
+end
+# rubocop:enable Style/EmptyLiteral
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### [] vs Array.new
+
+```
+Warming up --------------------------------------
+           Array.new   238.371k i/100ms
+                  []   336.249k i/100ms
+Calculating -------------------------------------
+           Array.new      6.298M (± 1.0%) i/s -     31.465M in   5.014660s
+                  []     14.157M (± 0.8%) i/s -     70.612M in   5.004166s
+                   with 95.0% confidence
+
+Comparison:
+                  []: 14157286.9 i/s
+           Array.new:  6297668.8 i/s - 2.25x  (± 0.03) slower
+                   with 95.0% confidence
+```
+
+#### {} vs Hash.new
+
+```
+Warming up --------------------------------------
+            Hash.new   140.548k i/100ms
+                  {}   348.340k i/100ms
+Calculating -------------------------------------
+            Hash.new      2.203M (± 1.1%) i/s -     11.103M in   5.056212s
+                  {}     14.285M (± 0.6%) i/s -     71.410M in   5.010915s
+                   with 95.0% confidence
+
+Comparison:
+                  {}: 14285184.2 i/s
+            Hash.new:  2202622.4 i/s - 6.49x  (± 0.08) slower
+                   with 95.0% confidence
+```

data/benchmarks/format_string.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/format_string.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+SINGLE_TOKEN_HASH = { greeting: 'Hello' }.freeze
+MULTI_TOKEN_HASH = {
+  greeting: 'Hello',
+  name: 'Benchmark',
+  message: 'Always a good idea to benchmark',
+}.freeze
+
+# rubocop:disable Style/FormatString
+section "Format String" do |bench|
+  bench.report("String#%") do
+    '%10s' % 'hoge'
+  end
+
+  bench.report("format") do
+    format '%10s', 'hoge'
+  end
+
+  bench.report("sprintf") do
+    sprintf '%10s', 'hoge'
+  end
+end
+# rubocop:enable Style/FormatString
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Format String
+
+```
+Warming up --------------------------------------
+            String#%   148.922k i/100ms
+              format   162.561k i/100ms
+             sprintf   157.745k i/100ms
+Calculating -------------------------------------
+            String#%      2.363M (± 0.8%) i/s -     11.914M in   5.049141s
+              format      2.668M (± 0.8%) i/s -     13.330M in   5.002105s
+             sprintf      2.609M (± 0.8%) i/s -     13.093M in   5.025561s
+                   with 95.0% confidence
+
+Comparison:
+              format:  2668054.9 i/s
+             sprintf:  2609234.8 i/s - 1.02x  (± 0.01) slower
+            String#%:  2363040.2 i/s - 1.13x  (± 0.01) slower
+                   with 95.0% confidence
+```

data/benchmarks/format_string_token.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/format_string_token.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+SINGLE_TOKEN_HASH = { greeting: 'Hello' }.freeze
+MULTI_TOKEN_HASH = {
+  greeting: 'Hello',
+  name: 'Benchmark',
+  message: 'Always a good idea to benchmark',
+}.freeze
+
+# rubocop:disable Style/FormatStringToken
+section "Format String Token (single token - inline token hash)" do |bench|
+  bench.report("annotated") do
+    format '%<greeting>s', greeting: 'Hello'
+  end
+
+  bench.report("template") do
+    format '%{greeting}', greeting: 'Hello'
+  end
+
+  bench.report("unannotated") do
+    format '%s', 'Hello'
+  end
+end
+
+section "Format String Token (single token - constant token hash)" do |bench|
+  bench.report("annotated") do
+    format '%<greeting>s', SINGLE_TOKEN_HASH
+  end
+
+  bench.report("template") do
+    format '%{greeting}', SINGLE_TOKEN_HASH
+  end
+
+  bench.report("unannotated") do
+    format '%s', 'Hello'
+  end
+end
+
+section "Format String Token (multiple tokens - constant token hash)" do |bench|
+  bench.report("annotated") do
+    format '%<greeting>s %<name>s, %<message>s!', MULTI_TOKEN_HASH
+  end
+
+  bench.report("template") do
+    format '%{greeting} %{name}, %{message}!', MULTI_TOKEN_HASH
+  end
+
+  bench.report("unannotated") do
+    format '%s %s, %s', 'Hello', 'Benchmark!', 'Always a good idea to benchmark'
+  end
+end
+# rubocop:enable Style/FormatStringToken
+
+section "Format String Token (annotated)" do |bench|
+  bench.report("inline hash") do
+    format '%<greeting>s', greeting: 'Hello'
+  end
+
+  bench.report("constant hash") do
+    format '%<greeting>s', SINGLE_TOKEN_HASH
+  end
+end
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Format String Token (single token - inline token hash)
+
+```
+Warming up --------------------------------------
+           annotated    88.435k i/100ms
+            template    87.693k i/100ms
+         unannotated   173.134k i/100ms
+Calculating -------------------------------------
+           annotated      1.160M (± 1.3%) i/s -      5.837M in   5.044452s
+            template      1.188M (± 1.2%) i/s -      5.963M in   5.031961s
+         unannotated      3.053M (± 0.8%) i/s -     15.409M in   5.055505s
+                   with 95.0% confidence
+
+Comparison:
+         unannotated:  3053228.5 i/s
+            template:  1187997.4 i/s - 2.57x  (± 0.04) slower
+           annotated:  1160462.9 i/s - 2.63x  (± 0.04) slower
+                   with 95.0% confidence
+```
+
+#### Format String Token (single token - constant token hash)
+
+```
+Warming up --------------------------------------
+           annotated   142.944k i/100ms
+            template   142.146k i/100ms
+         unannotated   178.653k i/100ms
+Calculating -------------------------------------
+           annotated      2.155M (± 0.8%) i/s -     10.864M in   5.048122s
+            template      2.158M (± 1.0%) i/s -     10.803M in   5.016911s
+         unannotated      3.081M (± 0.8%) i/s -     15.543M in   5.053055s
+                   with 95.0% confidence
+
+Comparison:
+         unannotated:  3080897.8 i/s
+            template:  2157563.3 i/s - 1.43x  (± 0.02) slower
+           annotated:  2155420.1 i/s - 1.43x  (± 0.02) slower
+                   with 95.0% confidence
+```
+
+#### Format String Token (multiple tokens - constant token hash)
+
+```
+Warming up --------------------------------------
+           annotated    69.462k i/100ms
+            template    59.389k i/100ms
+         unannotated    57.845k i/100ms
+Calculating -------------------------------------
+           annotated    890.828k (± 3.4%) i/s -      4.307M in   5.042996s
+            template    885.637k (± 2.8%) i/s -      4.276M in   5.017872s
+         unannotated      1.343M (± 3.8%) i/s -      6.189M in   5.104055s
+                   with 95.0% confidence
+
+Comparison:
+         unannotated:  1342803.3 i/s
+           annotated:   890828.1 i/s - 1.51x  (± 0.08) slower
+            template:   885637.5 i/s - 1.52x  (± 0.07) slower
+                   with 95.0% confidence
+```
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Format String Token (annotated)
+
+```
+Warming up --------------------------------------
+         inline hash    91.059k i/100ms
+       constant hash   135.572k i/100ms
+Calculating -------------------------------------
+         inline hash      1.218M (± 1.2%) i/s -      6.101M in   5.024187s
+       constant hash      2.135M (± 1.0%) i/s -     10.710M in   5.028115s
+                   with 95.0% confidence
+
+Comparison:
+       constant hash:  2135050.5 i/s
+         inline hash:  1217810.2 i/s - 1.75x  (± 0.03) slower
+                   with 95.0% confidence
+```