radius-spec 0.2.0 → 0.6.0

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
+```

data/benchmarks/gsub_vs_tr.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/gsub_vs_tr.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+[
+  ["No Replacement",       "Any String", "m", /m/, "-"],
+  ["Single Replacement",   "Any String", "i", /i/, "-"],
+  ["Multiple Replacement", "Any String", "n", /n/, "-"],
+].each do |title, str, pattern, regexp, replacement|
+  section title do |bench|
+    bench.report("gsub(string)") do
+      str.gsub(pattern, replacement)
+    end
+
+    bench.report("gsub(regexp)") do
+      str.gsub(regexp, replacement)
+    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 Replacement
+
+```
+Warming up --------------------------------------
+        gsub(string)   225.903k i/100ms
+        gsub(regexp)   150.469k i/100ms
+                  tr   225.874k i/100ms
+Calculating -------------------------------------
+        gsub(string)      4.848M (± 0.7%) i/s -     24.398M in   5.042073s
+        gsub(regexp)      2.558M (± 1.3%) i/s -     12.790M in   5.018370s
+                  tr      4.872M (± 1.0%) i/s -     24.394M in   5.020983s
+                   with 95.0% confidence
+
+Comparison:
+                  tr:  4872264.7 i/s
+        gsub(string):  4847903.4 i/s - same-ish: difference falls within error
+        gsub(regexp):  2557821.1 i/s - 1.91x  (± 0.03) slower
+                   with 95.0% confidence
+```
+
+#### Single Replacement
+
+```
+Warming up --------------------------------------
+        gsub(string)   115.202k i/100ms
+        gsub(regexp)    64.609k i/100ms
+                  tr   230.643k i/100ms
+Calculating -------------------------------------
+        gsub(string)      1.431M (± 1.6%) i/s -      7.143M in   5.010792s
+        gsub(regexp)    663.965k (± 1.0%) i/s -      3.360M in   5.067248s
+                  tr      4.517M (± 0.9%) i/s -     22.603M in   5.014505s
+                   with 95.0% confidence
+
+Comparison:
+                  tr:  4516906.0 i/s
+        gsub(string):  1430926.3 i/s - 3.16x  (± 0.06) slower
+        gsub(regexp):   663964.7 i/s - 6.80x  (± 0.09) slower
+                   with 95.0% confidence
+```
+
+#### Multiple Replacement
+
+```
+Warming up --------------------------------------
+        gsub(string)    92.833k i/100ms
+        gsub(regexp)    51.482k i/100ms
+                  tr   222.779k i/100ms
+Calculating -------------------------------------
+        gsub(string)      1.263M (± 1.3%) i/s -      6.313M in   5.014495s
+        gsub(regexp)    663.557k (± 1.4%) i/s -      3.346M in   5.061408s
+                  tr      4.786M (± 0.9%) i/s -     24.060M in   5.040074s
+                   with 95.0% confidence
+
+Comparison:
+                  tr:  4785813.8 i/s
+        gsub(string):  1262609.0 i/s - 3.79x  (± 0.06) slower
+        gsub(regexp):   663557.0 i/s - 7.21x  (± 0.12) slower
+                   with 95.0% confidence
+```

data/benchmarks/hash_merge.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/hash_merge.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+ENUM = (1..100)
+
+def hash_merge
+  tmp = {}
+  ENUM.each do |e|
+    tmp.merge! e => e
+  end
+  tmp
+end
+
+def hash_assign
+  tmp = {}
+  ENUM.each do |e|
+    tmp[e] = e
+  end
+  tmp
+end
+
+COMPOSE = {
+  a: 'a',
+  b: 'b',
+  c: 'c',
+}.freeze
+
+def hash_compose_merge
+  { one: 1 }.merge(COMPOSE)
+end
+
+def hash_compose_merge!
+  { one: 1 }.merge!(COMPOSE)
+end
+
+def hash_compose_splat
+  { one: 1, **COMPOSE }
+end
+
+section "Hash merge vs assign" do |bench|
+  bench.report("Hash#merge!") do
+    hash_merge
+  end
+
+  bench.report("Hash#[]=") do
+    hash_assign
+  end
+end
+
+section "Hash compose: merge vs splat" do |bench|
+  bench.report("merge") do
+    hash_compose_merge
+  end
+
+  bench.report("merge!") do
+    hash_compose_merge!
+  end
+
+  bench.report("splat") do
+    hash_compose_splat
+  end
+end
+
+__END__
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### Hash merge vs assign
+
+```
+Warming up --------------------------------------
+         Hash#merge!     1.760k i/100ms
+            Hash#[]=     7.821k i/100ms
+Calculating -------------------------------------
+         Hash#merge!     17.746k (± 1.1%) i/s -     89.760k in   5.065762s
+            Hash#[]=     83.691k (± 1.2%) i/s -    422.334k in   5.057697s
+                   with 95.0% confidence
+
+Comparison:
+            Hash#[]=:    83691.2 i/s
+         Hash#merge!:    17746.3 i/s - 4.71x  (± 0.08) slower
+                   with 95.0% confidence
+```
+
+#### Hash compose: merge vs splat
+
+```
+Warming up --------------------------------------
+               merge    78.448k i/100ms
+              merge!   111.435k i/100ms
+               splat   111.927k i/100ms
+Calculating -------------------------------------
+               merge    978.337k (± 1.0%) i/s -      4.942M in   5.061428s
+              merge!      1.571M (± 1.0%) i/s -      7.912M in   5.046875s
+               splat      1.587M (± 1.0%) i/s -      7.947M in   5.017037s
+                   with 95.0% confidence
+
+Comparison:
+               splat:  1587073.4 i/s
+              merge!:  1570636.9 i/s - same-ish: difference falls within error
+               merge:   978337.3 i/s - 1.62x  (± 0.02) slower
+                   with 95.0% confidence
+```

data/benchmarks/kwargs.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/kwargs.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+NAME = "any name"
+STATIC_OPTS = { name: "any name" }.freeze
+
+def hash_param(hash)
+  hash
+end
+
+def kwarg_param(name: nil)
+  name
+end
+
+def kwarg_splat_param(**kwargs)
+  kwargs
+end
+
+def static_opts
+  kwarg_param STATIC_OPTS
+end
+
+def named_opts
+  kwarg_param name: NAME
+end
+
+def splat_opts
+  kwarg_splat_param name: NAME
+end
+
+def hash_opts
+  hash_param name: NAME
+end
+
+section "kwargs vs hash method" do |x|
+  x.report("hash param") do
+    hash_opts
+  end
+
+  x.report("kwarg param") do
+    named_opts
+  end
+
+  x.report("kwarg splat param") do
+    splat_opts
+  end
+
+  x.compare!
+end
+
+section "Call kwargs method" do |x|
+  x.report("static opts") do
+    static_opts
+  end
+
+  x.report("named opts") do
+    named_opts
+  end
+
+  x.compare!
+end
+
+__END__
+
+Perhaps surprisingly the kwarg parameters option is much faster. I'm not sure
+why this actually is, but my guess is that Ruby optimizes this during the byte
+code process.
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: false
+
+### Test Cases
+
+#### kwargs vs hash method
+
+```
+Warming up --------------------------------------
+          hash param   131.753k i/100ms
+         kwarg param   266.657k i/100ms
+   kwarg splat param    66.641k i/100ms
+Calculating -------------------------------------
+          hash param      2.057M (± 1.6%) i/s -     10.277M in   5.023252s
+         kwarg param      7.351M (± 0.7%) i/s -     36.799M in   5.015356s
+   kwarg splat param    850.179k (± 1.4%) i/s -      4.265M in   5.035194s
+                   with 95.0% confidence
+
+Comparison:
+         kwarg param:  7351007.8 i/s
+          hash param:  2056501.2 i/s - 3.57x  (± 0.06) slower
+   kwarg splat param:   850179.4 i/s - 8.64x  (± 0.13) slower
+                   with 95.0% confidence
+```
+
+#### Call kwargs method
+
+```
+Warming up --------------------------------------
+         static opts   127.699k i/100ms
+          named opts   274.978k i/100ms
+Calculating -------------------------------------
+         static opts      1.879M (± 1.0%) i/s -      9.450M in   5.039627s
+          named opts      6.938M (± 1.1%) i/s -     34.647M in   5.014500s
+                   with 95.0% confidence
+
+Comparison:
+          named opts:  6937888.3 i/s
+         static opts:  1878705.6 i/s - 3.69x  (± 0.05) slower
+                   with 95.0% confidence
+```
+
+### Environment
+
+ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin16]
+GC Disabled: true
+
+### Test Cases
+
+#### kwargs vs hash method
+
+```
+Warming up --------------------------------------
+          hash param   144.722k i/100ms
+         kwarg param   266.216k i/100ms
+   kwarg splat param    67.212k i/100ms
+Calculating -------------------------------------
+          hash param      2.318M (± 5.2%) i/s -     10.709M in   5.017846s
+         kwarg param      7.381M (± 0.8%) i/s -     37.004M in   5.026198s
+   kwarg splat param    893.963k (±15.1%) i/s -      3.159M in   5.180853s
+                   with 95.0% confidence
+
+Comparison:
+         kwarg param:  7380700.1 i/s
+          hash param:  2317626.6 i/s - 3.19x  (± 0.17) slower
+   kwarg splat param:   893963.2 i/s - 8.26x  (± 1.26) slower
+                   with 95.0% confidence
+```
+
+#### Call kwargs method
+
+```
+Warming up --------------------------------------
+         static opts   157.568k i/100ms
+          named opts   271.741k i/100ms
+Calculating -------------------------------------
+         static opts      1.741M (±12.7%) i/s -      7.091M in   5.038616s
+          named opts      7.335M (± 0.7%) i/s -     36.685M in   5.010800s
+                   with 95.0% confidence
+
+Comparison:
+          named opts:  7335402.3 i/s
+         static opts:  1740760.5 i/s - 4.21x  (± 0.53) slower
+                   with 95.0% confidence
+```