benchmark_g_c 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af54b96fde0fbc9a0e24fe66507ac9374bd5a96a
+  data.tar.gz: b3fc137a41a8e935a90cdca8f838870ce00cba8e
+SHA512:
+  metadata.gz: 56ed8d4f500b4f15685789245cb680da694b1844c00c5b3dc5b656c3aa31cfe7f41d4dbc4fef1ce55449b576bcac0f8e0bcd415f5747788d44df8fc960c89ad0
+  data.tar.gz: 0b9ac1c1bb2156a085d2072ed0b18bdaf29831c7e3b9244408ee4589d29d7575a3073f0a46168618b435ca0ba2783190b9f6cef52a787fa63225950d9ccf6ffd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in benchmark_g_c.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nicholas Jacques
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# BenchmarkGC
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/benchmark_g_c`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'benchmark_g_c'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install benchmark_g_c
+
+## Usage
+
+class Thing
+  include BenchmarkGC
+
+  def method_name
+    do_some_stuff
+  end
+end
+
+Thing.new.bcheck(logger: false) { method_name }
+
+Parameter options (all are optional):
+  name: (string) Print the name of the benchmarked code
+  times: (integer) Number of times to run the benchmarked code in succession
+  logger: (boolean) ActiveRecord::Base.logger should log
+
+bcheck returns the value of the benchmarked code, making this possible:
+class Thing
+...
+  def method_name
+    bcheck { do_some_stuff }
+  end
+end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/benchmark_g_c.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/benchmark_g_c.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchmark_g_c/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "benchmark_g_c"
+  spec.version       = BenchmarkGC::VERSION
+  spec.authors       = ["Nicholas Jacques"]
+  spec.email         = ["jnicholasjacques@gmail.com"]
+
+  spec.summary       = %q{Benchmark Garbage Collect stats relevant to memory optimization.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "benchmark_g_c"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/benchmark_g_c/version.rb

@@ -0,0 +1,3 @@
+module BenchmarkGC
+  VERSION = "1.0.1"
+end

data/lib/benchmark_g_c.rb

@@ -0,0 +1,111 @@
+require "benchmark_g_c/version"
+
+module BenchmarkGC
+  @@total_objects_allocated = 0
+  @@total_bchecks = 0
+
+  def self.total_bchecks
+    @@total_bchecks
+  end
+
+  def self.increment_bchecks
+    @@total_bchecks += 1
+  end
+
+  def self.total_objects_allocated
+    @@total_objects_allocated
+  end
+
+  def self.add_objects(objects)
+    @@total_objects_allocated += objects
+  end
+
+  def bcheck(options = {})
+    default_options = { name: '', times: 1, logger: true }
+    options = default_options.merge(options)
+    name = options[:name]
+    times = options[:times]
+    logger = options[:logger]
+    # This should first check if gem is in Rails environment
+    ActiveRecord::Base.logger = nil unless logger
+    results = []
+    return_value = nil
+    times.times do
+      time_before = Time.now
+      stat_before = GC.stat
+      return_value = yield
+      time_after = Time.now
+      stat_after = GC.stat
+      results.push(
+        time_elapsed: time_after - time_before,
+        heap_free_slots_added: stat_after[:heap_free_slots] - stat_before[:heap_free_slots],
+        objects_allocated: stat_after[:total_allocated_objects] - stat_before[:total_allocated_objects],
+        objects_freed: stat_after[:total_freed_objects] - stat_before[:total_freed_objects]
+      )
+      print_benchmark(name, time_before, time_after, stat_before, stat_after)
+    end
+    averaged_results = average_results(results)
+    BenchmarkGC::increment_bchecks
+    BenchmarkGC::add_objects(averaged_results[:objects_allocated])
+    print_averaged_results(averaged_results, times)
+    return_value
+  end
+
+  def print_benchmark(name, time_before, time_after, stat_before, stat_after)
+    print "-------------------------------------------------------------------\n"
+    print "#{name}\n"
+    print "Time Elapsed: #{time_after - time_before}\n\n"
+    printf("%-25s %-14s %-14s %-14s\n", 'GC Stat', 'before', 'after', 'diff')
+    print "-------------------------------------------------------------------\n"
+    print_stats('heap_free_slots', stat_before[:heap_free_slots], stat_after[:heap_free_slots])
+    print_stats('total_allocated_objects', stat_before[:total_allocated_objects], stat_after[:total_allocated_objects])
+    print_stats('total_freed_objects', stat_before[:total_freed_objects], stat_after[:total_freed_objects])
+    print "-------------------------------------------------------------------\n"
+  end
+
+  def print_stats(name, before, after)
+    formatter = "%-25s %-14d %-14d %-14d\n"
+    printf(formatter, name, before, after, after - before)
+  end
+
+  def average_results(results)
+    summed_results = sum_results(results)
+    summed_results.each do |key, value|
+      summed_results[key] = value / results.length
+    end
+  end
+
+  def sum_results(results)
+    summed_results = results[0].clone
+    results[1..-1].each do |result|
+      summed_results.keys.each do |key|
+        summed_results[key] += result[key]
+      end
+    end
+    summed_results
+  end
+
+  def print_averaged_results(results, times_run)
+    print "-------------------------------------------------------------------\n"
+    print "Average Results after running #{times_run} times\n"
+    print "-------------------------------------------------------------------\n"
+    formatter = "%-25s %-14s\n"
+    results.each do |key, value|
+      printf(formatter, key, underscore_number(value))
+    end
+    print "Total bchecks run for server instance: #{underscore_number BenchmarkGC::total_bchecks}\n"
+    print "Total Objects Allocated for server instance: #{underscore_number BenchmarkGC::total_objects_allocated}\n"
+    print "-------------------------------------------------------------------\n"
+  end
+
+  def underscore_number(number)
+    insert_underscores(number.round.to_s.reverse).reverse
+  end
+
+  def insert_underscores(string)
+    (1..(string.length - 1) / 3).each do |n|
+      string.insert(n * 3 + n - 1, '_') unless string[n * 3 + n - 1] == '-'
+    end
+    string
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_g_c
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nicholas Jacques
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- jnicholasjacques@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark_g_c.gemspec
+- bin/console
+- bin/setup
+- lib/benchmark_g_c.rb
+- lib/benchmark_g_c/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Benchmark Garbage Collect stats relevant to memory optimization.
+test_files: []