rspec-benchmark 0.3.0 → 0.4.0

data/spec/unit/perform_linear_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+RSpec.describe 'RSpec::Benchmark::ComplexityMatcher', '#perform_linear' do
+  # exponential
+  def fibonacci(n)
+    n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2)
+  end
+
+  it "propagates error inside expectation" do
+    expect {
+      expect { raise 'boom' }.to perform_linear
+    }.to raise_error(StandardError, /boom/)
+  end
+
+  it "provides a default range" do
+    range = [1,2,3]
+    allow(::Benchmark::Trend).to receive(:range).and_return(range)
+    allow(::Benchmark::Trend).to receive(:infer_trend).and_return(:linear, {})
+
+    expect { |n, i| n }.to perform_linear
+
+    expect(::Benchmark::Trend).to have_received(:range).with(8, 8192, ratio: 8)
+  end
+
+  it "changes default range using in_range and ratio matchers" do
+    range = [1,2,3]
+    allow(::Benchmark::Trend).to receive(:range).and_return(range)
+    allow(::Benchmark::Trend).to receive(:infer_trend).and_return(:linear, {})
+
+    expect { |n, i| n }.to perform_linear.in_range(3, 33_000).ratio(2)
+
+    expect(::Benchmark::Trend).to have_received(:range).with(3, 33_000, ratio: 2)
+  end
+
+  context "expect { ... }.to perfom_linear" do
+    it "passes if the block performs linear" do
+      range = bench_range(1, 8 << 10)
+      numbers = range.map { |n| Array.new(n) { rand(n) } }
+
+      expect { |n, i|
+        numbers[i].max
+      }.to perform_linear.in_range(range[0], range[-1]).sample(100)
+    end
+
+    it "fails if the block doesn't perform linear" do
+      expect {
+        expect { |n, i|
+          fibonacci(n)
+        }.to perform_linear.in_range(1, 18).ratio(2).sample(100)
+      }.to raise_error("expected block to perform linear, but performed exponential")
+    end
+  end
+
+  context "expect { ... }.not_to perfom_linear" do
+    it "passes if the block does not perform linear" do
+      expect { |n, i|
+        fibonacci(n)
+      }.not_to perform_linear.in_range(1, 18).ratio(2).sample(100)
+    end
+
+    it "fails if the block doesn't perform linear" do
+      range = bench_range(10, 8 << 12)
+      numbers = range.map { |n| Array.new(n) { rand(n) } }
+
+      expect {
+        expect { |n, i|
+          numbers[i].max
+        }.not_to perform_linear.in_range(range[0], range[-1]).sample(100)
+      }.to raise_error("expected block not to perform linear, but performed linear")
+    end
+  end
+end

data/spec/unit/perform_logarithmic_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+RSpec.describe 'RSpec::Benchmark::ComplexityMatcher', '#perform_logarithmic' do
+  # Iterated logarithm
+  # https://en.wikipedia.org/wiki/Iterated_logarithm
+  def log_star(n, repeat = 0)
+    n <= 1 ? repeat : 1 + log_star(Math.log(n), repeat += 1)
+  end
+
+  it "propagates error inside expectation" do
+    expect {
+      expect { raise 'boom' }.to perform_logarithmic
+    }.to raise_error(StandardError, /boom/)
+  end
+
+  context "expect { ... }.to perfom_logarithmic" do
+    xit "passes if the block performs logarithmic" do
+      range = bench_range(1, 8 << 18, ratio: 2)
+      numbers = range.map { |n| (1..n).to_a }
+
+      expect { |n, i|
+        numbers[i].bsearch { |x| x == 1 }
+      }.to perform_logarithmic.in_range(range[0], range[-1]).ratio(2).sample(100).times
+    end
+
+    it "fails if the block doesn't perform logarithmic" do
+      expect {
+        expect { |n| n }.to perform_logarithmic.in_range(1, 10_000).sample(100)
+      }.to raise_error("expected block to perform logarithmic, but performed constant")
+    end
+  end
+
+  context "expect { ... }.not_to perfom_logarithmic" do
+    it "passes if the block does not perform logarithmic" do
+      expect { |n| n }.not_to perform_logarithmic.in_range(1, 10_000).sample(100)
+    end
+
+    xit "fails if the block doesn't perform logarithmic" do
+      range = bench_range(1, 8 << 18, ratio: 2)
+      numbers = range.map { |n| (1..n).to_a }
+
+      expect {
+        expect { |n, i|
+          numbers[i].bsearch { |x| x == 1 }
+        }.not_to perform_logarithmic.in_range(range[0], range[-1]).ratio(2).sample(100).times
+      }.to raise_error("expected block not to perform logarithmic, but performed logarithmic")
+    end
+  end
+end

data/spec/unit/perform_power_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+RSpec.describe 'RSpec::Benchmark::ComplexityMatcher', '#perform_power' do
+  def prefix_avg(numbers)
+    result = []
+    numbers.each_with_index do |i, num|
+      sum = 0.0
+      numbers[0..i].each do |a|
+        sum += a
+      end
+      result[i] = sum / i
+    end
+    result
+  end
+
+  it "propagates error inside expectation" do
+    expect {
+      expect { raise 'boom' }.to perform_power
+    }.to raise_error(StandardError, /boom/)
+  end
+
+  context "expect { ... }.to perfom_power" do
+    it "passes if the block performs power" do
+      range = bench_range(10, 8 << 5)
+      numbers = range.map { |n| Array.new(n) { rand(n) } }
+
+      expect { |n, i|
+        prefix_avg(numbers[i])
+      }.to perform_power.in_range(range[0], range[-1]).sample(100).times
+    end
+
+    it "fails if the block doesn't perform power" do
+      expect {
+        expect { |n| n }.to perform_power.in_range(1, 10_000).sample(100)
+      }.to raise_error("expected block to perform power, but performed constant")
+    end
+  end
+
+  context "expect { ... }.not_to perfom_power" do
+    it "passes if the block does not perform power" do
+      expect { |n| n }.not_to perform_power.in_range(1, 10_000).sample(100)
+    end
+
+    it "fails if the block doesn't perform power" do
+      range = bench_range(10, 8 << 5)
+      numbers = range.map { |n| Array.new(n) { rand(n) } }
+
+      expect {
+        expect { |n, i|
+          prefix_avg(numbers[i])
+        }.not_to perform_power.in_range(range[0], range[-1]).sample(100).times
+      }.to raise_error("expected block not to perform power, but performed power")
+    end
+  end
+end

data/spec/unit/perform_under_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe 'RSpec::Benchmark::TimingMatcher', '#perform_under' do
   it "propagates error inside expectation" do
@@ -8,40 +8,46 @@ RSpec.describe 'RSpec::Benchmark::TimingMatcher', '#perform_under' do
   end
 
   it "allows to configure warmup cycles" do
-    bench = double(run: [0.005, 0.00001])
-    allow(::Benchmark::Perf::ExecutionTime).to receive(:new).and_return(bench)
-    expect { 'x' * 1024 * 10 }.to perform_under(0.006, warmup: 2).sec.and_sample(2)
-    expect(::Benchmark::Perf::ExecutionTime).to have_received(:new).with(warmup: 2)
+    bench = [0.005, 0.00001]
+    allow(::Benchmark::Perf::ExecutionTime).to receive(:run).and_return(bench)
+    expect { 'x' * 1024 * 10 }.to perform_under(0.006).sec.warmup(2).times.sample(3)
+    expect(::Benchmark::Perf::ExecutionTime).to have_received(:run).with(repeat: 3, warmup: 2)
   end
 
-  context "expect { ... }.to perfom_under(...).and_sample" do
+  it "doesn't allow sample size less than 1" do
+    expect {
+      expect { 'x' * 1024 * 10 }.to perform_under(0.006).sec.sample(0)
+    }.to raise_error(/Repeat value: 0 needs to be greater than 0/)
+  end
+
+  context "expect { ... }.to perfom_under(...).sample" do
     it "passes if the block performs under threshold" do
       expect {
         'x' * 1024 * 10
-      }.to perform_under(0.006).sec.and_sample(10)
+      }.to perform_under(0.006).sec.sample(10).times
     end
 
     it "fails if the block performs above threshold" do
       expect {
         expect {
           'x' * 1024 * 1024 * 100
-        }.to perform_under(0.0001).and_sample(5)
+        }.to perform_under(0.0001).sample(5)
       }.to raise_error(/expected block to perform under 100 μs, but performed above \d+(\.\d+)? ([μmn]s|sec) \(± \d+(\.\d+)? ([μmn]s|sec)\)/)
     end
   end
 
-  context "expect { ... }.not_to perform_under(...).and_sample" do
+  context "expect { ... }.not_to perform_under(...).sample" do
     it "passes if the block does not perform under threshold" do
       expect {
         'x' * 1024 * 1024 * 10
-      }.to_not perform_under(0.001).and_sample(2)
+      }.to_not perform_under(0.001).sample(2)
     end
 
     it "fails if the block perfoms under threshold" do
       expect {
         expect {
           'x' * 1024 * 1024 * 10
-        }.to_not perform_under(1).and_sample(2)
+        }.to_not perform_under(1).sample(2)
       }.to raise_error(/expected block to not perform under 1 sec, but performed \d+(\.\d+)? ([μmn]s|sec) \(± \d+(\.\d+)? ([μmn]s|sec)\) under/)
     end
   end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rspec-benchmark
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-05 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-perf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: benchmark-trend
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -48,55 +62,46 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 description: Performance testing matchers for RSpec that provide simple way to specify
-  speed benchmark expectations
+  speed and algorithmic complexity benchmark expectations
 email:
 - ''
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rspec-benchmark.rb
 - lib/rspec/benchmark.rb
 - lib/rspec/benchmark/comparison_matcher.rb
+- lib/rspec/benchmark/complexity_matcher.rb
 - lib/rspec/benchmark/format_time.rb
 - lib/rspec/benchmark/iteration_matcher.rb
 - lib/rspec/benchmark/matchers.rb
@@ -105,8 +110,14 @@ files:
 - rspec-benchmark.gemspec
 - spec/spec_helper.rb
 - spec/unit/comparison_matcher_spec.rb
+- spec/unit/composable_spec.rb
 - spec/unit/format_time_spec.rb
 - spec/unit/perform_at_least_spec.rb
+- spec/unit/perform_constant_spec.rb
+- spec/unit/perform_exponential_spec.rb
+- spec/unit/perform_linear_spec.rb
+- spec/unit/perform_logarithmic_spec.rb
+- spec/unit/perform_power_spec.rb
 - spec/unit/perform_under_spec.rb
 - tasks/coverage.rake
 - tasks/spec.rake
@@ -122,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -130,14 +141,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Performance testing matchers for RSpec
 test_files:
 - spec/spec_helper.rb
 - spec/unit/comparison_matcher_spec.rb
+- spec/unit/composable_spec.rb
 - spec/unit/format_time_spec.rb
 - spec/unit/perform_at_least_spec.rb
+- spec/unit/perform_constant_spec.rb
+- spec/unit/perform_exponential_spec.rb
+- spec/unit/perform_linear_spec.rb
+- spec/unit/perform_logarithmic_spec.rb
+- spec/unit/perform_power_spec.rb
 - spec/unit/perform_under_spec.rb
-has_rdoc: 

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.travis.yml

@@ -1,28 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-script: "bundle exec rake ci"
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-  - ruby-head
-  - jruby-9000
-  - jruby-head
-  - rbx-3
-env:
-  global:
-    - JRUBY_OPTS="-Xcli.debug=true --debug"
-matrix:
-  allow_failures:
-    - rvm: rbx-3
-    - rvm: ruby-head
-    - rvm: jruby-head
-  fast_finish: true
-branches:
-  only: master
-notifications:
-  email: false

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-  gem 'coveralls', '~> 0.8.15'
-  gem 'simplecov', '~> 0.12.0'
-  gem 'yardstick', '~> 0.9.9'
-end