benchmark-malloc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f4aeccd4fe1f05278d14d87023639aad34522818a4189d7b72479351ce2565
-  data.tar.gz: faf9e95804733e6de3a77e32c7f6965e27358bc157810857de5da55c074fb7df
+  metadata.gz: 48576a6003a6fd1a9a0f38673fe26a07d1c08a273a30b35a70129eb0cca17295
+  data.tar.gz: 7260d8c45bab763a0fa86e3a0f83e433bd636e4281c7efd58e528225d08a4948
 SHA512:
-  metadata.gz: 1ada0b8d9a8b86ee935ec5ca3acb871fff6b8a110b154fdde435f793271e42a95907383303d8151856ce252c91b1ce605f14cf7c3802d0351967bfc935e6812f
-  data.tar.gz: 4b35be840c0e8a63730a5627e36efb53e19ba4fdae5d106544d37a8bf325bf6f6c35a90d3aafedf2ce0f84fb117e45a18b24ddfd0d1cd0842dc93a35fec81a54
+  metadata.gz: c9729e0e361bcc64c7b0c9563d0c10ad351e2275d2de3ee49358ae9f99f893079d1304af5208f587aab31ab54935317c73c1ce164ee5ae2924943c5fe9a5e0c5
+  data.tar.gz: 12d4b77967a79b3a8c87c8e5198f87f5c104dc62b5308e3fe1201158817e000c3bc75bb6853c8fde33c9f7f665c48b57ad7383daf301f0ae0b2ed0b120cf85a4

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Change log
 
-## [v0.1.0] - 2016-04-06
+## [v0.2.0] - 2020-03-07
+
+### Changed
+* Change class level #run call to #trace
+* Change gemspec to only load source files
+
+## [v0.1.0] - 2019-04-06
 
 Initial release
 
+[v0.2.0]: https://github.com/piotrmurach/benchmark-malloc/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/piotrmurach/benchmark-malloc/compare/v0.1.0

data/README.md

@@ -16,6 +16,8 @@
 
 > Trace memory allocations and collect stats.
 
+The **Benchmark::Malloc** is used by [rspec-benchmark](https://github.com/piotrmurach/rspec-benchmark)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -35,7 +37,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-benc_malloc = Benchmark::Malloc.new
+bench_malloc = Benchmark::Malloc.new
 
 stats = bench_malloc.run { %w[foo bar baz].sort[1] }
 
@@ -44,6 +46,29 @@ stats.allocated.total_objects # => 3
 stats.allocated.total_memory # => 120
 ```
 
+## API
+
+### start & stop
+
+You can manually begin tracing memory allocations with the `start` method:
+
+```ruby
+malloc = Benchmark::Malloc.new
+malloc.start
+```
+
+Any Ruby code after the `start` invocation will count towards the stats:
+
+```ruby
+%w[foo bar baz].sort[1]
+```
+
+Finally, to finish tracing call the `stop` method:
+
+```ruby
+malloc.stop
+```
+
 ## 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.
@@ -52,7 +77,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/benchmark-malloc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/benchmark-malloc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/benchmark-malloc.rb

@@ -1 +1 @@
-require_relative 'benchmark/malloc'
+require_relative "benchmark/malloc"

data/lib/benchmark/malloc.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'objspace'
+require "objspace"
 
-require_relative 'malloc/allocation'
-require_relative 'malloc/allocation_set'
-require_relative 'malloc/allocation_result'
-require_relative 'malloc/version'
+require_relative "malloc/allocation"
+require_relative "malloc/allocation_set"
+require_relative "malloc/allocation_result"
+require_relative "malloc/version"
 
 module Benchmark
   class Malloc
@@ -18,14 +18,20 @@ module Benchmark
     # @api public
     attr_reader :warmup
 
-    def self.run(&work)
+    # Trace memory allocations
+    #
+    # @api public
+    def self.trace(&work)
       Malloc.new.run(&work)
     end
 
+    # Create a memory allocation tracer
+    #
+    # @api public
     def initialize(warmup: 0)
       @warmup = warmup
       @running = false
-      @alloc_path = ::File.join(__FILE__[0...-3], 'allocation.rb')
+      @alloc_path = ::File.join(__FILE__[0...-3], "allocation.rb")
     end
 
     # @api private

data/lib/benchmark/malloc/allocation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'objspace'
+require "objspace"
 
 module Benchmark
   class Malloc

data/lib/benchmark/malloc/version.rb

@@ -1,7 +1,7 @@
-# frozen_stirng_literal: true
+# frozen_string_literal: true
 
 module Benchmark
   class Malloc
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # Malloc
 end # Benchmark

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-malloc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-04-06 00:00:00.000000000 Z
+date: 2020-03-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,48 +28,45 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Trace memory allocations and collect stats.
 email:
-- me@piotrmurach.com
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- benchmark-malloc.gemspec
 - lib/benchmark-malloc.rb
 - lib/benchmark/malloc.rb
 - lib/benchmark/malloc/allocation.rb
 - lib/benchmark/malloc/allocation_result.rb
 - lib/benchmark/malloc/allocation_set.rb
 - lib/benchmark/malloc/version.rb
-- spec/spec_helper.rb
-- spec/unit/allocation/new_spec.rb
-- spec/unit/allocation_set/new_spec.rb
-- spec/unit/run_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
 homepage: https://github.com/piotrmurach/benchmark-malloc
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/benchmark-malloc/issues
+  changelog_uri: https://github.com/piotrmurach/benchmark-malloc/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/benchmark-malloc
   homepage_uri: https://github.com/piotrmurach/benchmark-malloc
   source_code_uri: https://github.com/piotrmurach/benchmark-malloc
-  changelog_uri: https://github.com/piotrmurach/benchmark-malloc/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -99,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Trace memory allocations and collect stats.

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/benchmark-malloc.gemspec

@@ -1,34 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "benchmark/malloc/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "benchmark-malloc"
-  spec.version       = Benchmark::Malloc::VERSION
-  spec.authors       = ["Piotr Murach"]
-  spec.email         = ["me@piotrmurach.com"]
-
-  spec.summary       = %q{Trace memory allocations and collect stats.}
-  spec.description   = %q{Trace memory allocations and collect stats.}
-  spec.homepage      = "https://github.com/piotrmurach/benchmark-malloc"
-  spec.license       = "MIT"
-
-  if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/piotrmurach/benchmark-malloc"
-    spec.metadata["changelog_uri"] = "https://github.com/piotrmurach/benchmark-malloc/CHANGELOG.md"
-  end
-
-  spec.files         = Dir['{lib,spec}/**/*.rb']
-  spec.files        += Dir['tasks/*', 'benchmark-malloc.gemspec']
-  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 2.1.0'
-
-  spec.add_development_dependency "bundler", ">= 1.17"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 3.0"
-end

data/spec/spec_helper.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-if ENV['COVERAGE'] || ENV['TRAVIS']
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  SimpleCov.start do
-    command_name 'spec'
-    add_filter 'spec'
-  end
-end
-
-require "bundler/setup"
-require "benchmark-malloc"
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end

data/spec/unit/allocation/new_spec.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Benchmark::Malloc::Allocation do
-  it "gathers info about allocated object" do
-    object = Object.new
-    alloc = described_class.new(object)
-
-    expect(alloc.memsize).to be <= 40
-    expect(alloc.source_line).to eq(nil)
-    expect(alloc.method_id).to eq(nil)
-    expect(alloc.class_path).to eq(nil)
-    expect(alloc.source_file).to eq(nil)
-  end
-
-  it "extracts allocation info" do
-    object = Object.new
-    alloc = described_class.new(object)
-
-    extracted = alloc.extract(:class, :memsize)
-
-    expect(extracted[0]).to eq(Object)
-    expect(extracted[1]).to be <= 40
-  end
-end

data/spec/unit/allocation_set/new_spec.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Benchmark::Malloc::AllocationSet do
-
-  def make_allocation(object)
-    Benchmark::Malloc::Allocation.new(object)
-  end
-
-  it "counts allocated objects" do
-    object_alloc = make_allocation(Object.new)
-    hash_alloc = make_allocation({Object.new => :foo})
-    string_alloc = make_allocation(:bar)
-
-    allocations = [object_alloc, hash_alloc, string_alloc]
-    alloc_set = described_class.new(allocations)
-
-    expect(alloc_set.count_objects).to eq({Hash => 1, Object => 1, Symbol => 1})
-    expect(alloc_set.total_objects).to eq(3)
-  end
-
-  it "counts allocated memory" do
-    object_alloc = make_allocation(Object.new)
-    hash_alloc = make_allocation({Object.new => :foo})
-    string_alloc = make_allocation(:bar)
-
-    allocations = [object_alloc, hash_alloc, string_alloc]
-    alloc_set = described_class.new(allocations)
-
-    expect(alloc_set.count_memory[Hash]).to be <= 240
-    expect(alloc_set.count_memory[Object]).to be <= 40
-    expect(alloc_set.count_memory[Symbol]).to eq 0
-
-    expect(alloc_set.total_memory).to be < 300
-  end
-
-  it "filters allocated objects" do
-    object_alloc = make_allocation(Object.new)
-    hash_alloc = make_allocation({Object.new => :foo})
-    string_alloc = make_allocation(:bar)
-
-    allocations = [object_alloc, hash_alloc, string_alloc]
-    alloc_set = described_class.new(allocations)
-
-    expect(alloc_set.filter(Object)).to eq([object_alloc])
-  end
-end

data/spec/unit/run_spec.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Benchmark::Malloc do
-  it "traces only new object allocations" do
-    %i[foo bar baz].freeze
-
-    sample = described_class.run do
-      %i[foo bar baz].freeze
-    end
-
-    expect(sample.allocated.total_objects).to eq(1)
-    expect(sample.allocated.total_memory).to be <= 40
-  end
-
-  it "traces block assigned instances" do
-    memory = described_class.new
-
-    sample = memory.run do
-      _new_object = Object.new
-      _new_array  = [:baz]
-      _new_string = 'foo' + 'baz'
-    end
-
-    # allocated
-    expect(sample.allocated.total_objects).to be <= 5
-    expect(sample.allocated.total_memory).to be <= 200
-
-    expect(sample.allocated.count_objects[Object]).to eq(1)
-    expect(sample.allocated.count_objects[Array]).to eq(1)
-    expect(sample.allocated.count_objects[String]).to be <= 3
-
-    expect(sample.allocated.count_memory[Object]).to be <= 40
-    expect(sample.allocated.count_memory[String]).to be <= 120
-    expect(sample.allocated.count_memory[Array]).to be <= 40
-
-    # retained
-    expect(sample.retained.total_objects).to be <= 5
-    expect(sample.retained.total_memory).to be <= 200
-
-    expect(sample.retained.count_objects[Object]).to eq(1)
-    expect(sample.retained.count_objects[Array]).to eq(1)
-    expect(sample.retained.count_objects[String]).to be <= 3
-
-    expect(sample.retained.count_memory[Object]).to be <= 40
-    expect(sample.retained.count_memory[String]).to be <= 120
-    expect(sample.retained.count_memory[Array]).to be <= 40
-  end
-
-  it "traces large number of objects" do
-    result = described_class.run do
-      10.times { |i| [i.to_s, {}] }
-    end
-
-    expect(result.allocated.total_objects).to eq(10 * 3)
-    expect(result.allocated.total_memory).to be <= (3120)
-    expect(result.allocated.count_objects).to eq({
-      Array => 10, String => 10, Hash => 10})
-
-    # memory
-    expect(result.allocated.count_memory[Array]).to be <= 400
-    expect(result.allocated.count_memory[String]).to be <= 400
-    expect(result.allocated.count_memory[Hash]).to be <= 2400
-  end
-
-  it "raises when stopped without starting" do
-    expect {
-      described_class.new.stop
-    }.to raise_error(Benchmark::Malloc::Error, "not started yet")
-  end
-
-  it "raises when started again" do
-    expect {
-      malloc = described_class.new
-      malloc.start
-      malloc.start
-    }.to raise_error(Benchmark::Malloc::Error, "already running")
-  end
-end

data/tasks/console.rake

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-desc 'Load gem inside irb console'
-task :console do
-  require 'irb'
-  require 'irb/completion'
-  require_relative '../lib/benchmark-malloc'
-  ARGV.clear
-  IRB.start
-end
-task c: %w[ console ]

data/tasks/coverage.rake

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-desc 'Measure code coverage'
-task :coverage do
-  begin
-    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
-    Rake::Task['spec'].invoke
-  ensure
-    ENV['COVERAGE'] = original
-  end
-end

data/tasks/spec.rake

@@ -1,34 +0,0 @@
-# encoding: utf-8
-
-begin
-  require 'rspec/core/rake_task'
-
-  desc 'Run all specs'
-  RSpec::Core::RakeTask.new(:spec) do |task|
-    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
-  end
-
-  namespace :spec do
-    desc 'Run unit specs'
-    RSpec::Core::RakeTask.new(:unit) do |task|
-      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
-    end
-
-    desc 'Run integration specs'
-    RSpec::Core::RakeTask.new(:integration) do |task|
-      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
-    end
-
-    desc 'Run performance specs'
-    RSpec::Core::RakeTask.new(:perf) do |task|
-      task.pattern = 'spec/performance{,/*/**}/*_spec.rb'
-    end
-  end
-
-rescue LoadError
-  %w[spec spec:unit spec:integration spec:perf].each do |name|
-    task name do
-      $stderr.puts "In order to run #{name}, do `gem install rspec`"
-    end
-  end
-end