benchable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c0476be4799e0045af57ce9be72401caf7acc7a0de12f0288d02b5c0dac1be5
-  data.tar.gz: edfd89e36cbb1e2d63d16d20f2b40ae8c441580d97bee9bdd5fc4710afd62bd5
+  metadata.gz: ea8211a8067a809843da4eb4597f8410b066885729d16a09a5ee5996fb3e2af9
+  data.tar.gz: 2fa2084edce688c7184591c2ce01b4b4ff7bedb7212a9a4dbbc99f6e3b80ac0b
 SHA512:
-  metadata.gz: 46ce119b1f4d4991e1e022b3b79449b857d60cdc635afa435983b3cab2a1719a5cf6586faa6f2685627592fae6badff8e0110e254a99067183e89721788dd899
-  data.tar.gz: dbf498e5e3fc4aa94846f0cb4e701bf97f456e68c4bd68af5bb577338228efa56328ef1676cc1f55369874026c71d70e0f2b7c0c75026c87973761fae10180cc
+  metadata.gz: a1e2f7cb8f1ef3165917b10dee6701ee8397b1b5d65e2d859f43fb0fab3af20858d2b86362cef964282e4978e551e7287ab1927f072c05c8b05620790c3d7e0c
+  data.tar.gz: 6a1c2a65c2895b296051a4daaa5cc2b20972e747678582fe3459db0f705b9dd558d1de1aa1982725bd3235be462c41732156548405a2b4bf8a54f4e9adfb12c2

data/CHANGELOG.md

@@ -12,6 +12,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <!-- ### Removed -->
 ---
 
+## [0.2.0] - 2020-10-23
+
+### Added
+- Support for `Benchmark.memory` via [benchmark-memory](https://github.com/michaelherold/benchmark-memory).
+
+[unreleased]: https://github.com/MatheusRich/benchable/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/MatheusRich/benchable/releases/tag/v0.2.0
+
 ## [0.1.0] - 2020-08-16
 
 ### Added

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    benchable (0.1.0)
+    benchable (0.2.0)
       benchmark-ips (~> 2.8, >= 2.8.2)
+      benchmark-memory (~> 0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -10,7 +11,9 @@ GEM
     ast (2.4.1)
     backport (1.1.2)
     benchmark (0.1.0)
-    benchmark-ips (2.8.2)
+    benchmark-ips (2.8.3)
+    benchmark-memory (0.1.2)
+      memory_profiler (~> 0.9)
     coderay (1.1.3)
     diff-lcs (1.4.4)
     docile (1.3.2)
@@ -37,6 +40,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.7)
     maruku (0.7.3)
+    memory_profiler (0.9.14)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
     nenv (0.3.0)

data/README.md

@@ -64,7 +64,7 @@ end
 > We've used `Array#dup` in the example above to prevent the benchmarks for modifying the original array
 
 ### Benchmark types
-There are 3 benchmark types available: `bm`, `bmbm` and `ips`. You can specify it by passing the type as a symbol on the `Benchable.bench` method. The default type is `bm`.
+There are 4 benchmark types available: `bm`, `bmbm`, `ips` and `memory`. You can specify the type by passing it as a symbol on the `Benchable.bench` method. The default type is `bm`.
 
 ```ruby
 Benchable.bench(:bm) do
@@ -78,6 +78,10 @@ end
 Benchable.bench(:ips) do
   # ...
 end
+
+Benchable.bench(:memory) do
+  # ...
+end
 ```
 
 Given an invalid benchmark type, Benchable will raise an exception.
@@ -91,7 +95,7 @@ end
 ### Benchmark options
 You can provide benchmark options by passing a hash to the `Benchable.bench` method.
 
-### Options for `Benchmark.bm` and `Benchmark.bmbm`
+#### Options for `Benchmark.bm` and `Benchmark.bmbm`
 On `bm` and `bmbm` benchmarks the only available option is `width`, which specifies the leading spaces for labels on each line. The default width is `20`.
 
 ```ruby
@@ -100,12 +104,12 @@ Benchable.bench(width: 25) do
 end
 ```
 
-### Options for `Benchmark::IPS`
-If you're using, you can pass any option accepted by `Benchmark::IPS` `config` method.
+#### Options for `Benchmark::IPS`
+If you're using `::IPS`, you can pass any option accepted by `Benchmark::IPS`' `config` method.
 
 ```ruby
 Benchable.bench(:ips, time: 5, warmup: 2) do
-  # 
+  # ...
 end
 # Output:
 # Warming up --------------------------------------
@@ -116,6 +120,18 @@ end
 #                Sort!      2.120  (± 0.0%) i/s -     11.000  in   5.189772s
 ```
 
+#### Options for `Benchmark::Memory`
+You can pass [any option accepted](https://github.com/michaelherold/benchmark-memory#options) by `Benchmark::Memory`.
+
+```ruby
+Benchable.bench(:memory, quiet: true) do
+  # ...
+end
+# Output:
+# => #<Benchmark::Memory::Report:0x0000558cdfdbc498 ...>
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -128,7 +144,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Matheu
 
 
 ## Acknowledgments
-Thanks [@naomik](https://github.com/naomik) for building the bease idea for this in [his gist](https://gist.github.com/naomik/6012505)!
+Thanks [@naomik](https://github.com/naomik) for building the base idea for this in [his gist](https://gist.github.com/naomik/6012505)!
 
 ## License
 

data/benchable.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'benchmark-ips', '~> 2.8', '>= 2.8.2'
+  spec.add_runtime_dependency 'benchmark-memory', '~> 0.1.2'
 end

data/lib/benchable/benchmark.rb

@@ -2,11 +2,12 @@
 
 require 'benchmark'
 require 'benchmark/ips'
+require 'benchmark/memory'
 
 module Benchable
   class Benchmark
     DEFAULT_WIDTH = 20
-    BENCHMARK_TYPES = %i[bm bmbm ips].freeze
+    BENCHMARK_TYPES = %i[bm bmbm ips memory].freeze
 
     def initialize(benchmark_type, options = {})
       @benchmark_type = benchmark_type
@@ -63,9 +64,17 @@ module Benchable
     end
 
     def benchmark(&block)
+      ::Benchmark.public_send(*benchmark_args, &block)
+    end
+
+    def benchmark_args
       width = options[:width] || DEFAULT_WIDTH
 
-      ::Benchmark.public_send(benchmark_type, width, &block)
+      args = [benchmark_type]
+      args << width unless benchmark_type == :memory
+      args << options if benchmark_type == :memory
+
+      args
     end
   end
 end

data/lib/benchable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Benchable
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matheus Richard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.8.2
+- !ruby/object:Gem::Dependency
+  name: benchmark-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 description: 
 email:
 - matheusrichardt@gmail.com