benchmark_g_c 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af54b96fde0fbc9a0e24fe66507ac9374bd5a96a
-  data.tar.gz: b3fc137a41a8e935a90cdca8f838870ce00cba8e
+  metadata.gz: 6a59d6f59ec9b87756e23483ac227e27c9d94dbb
+  data.tar.gz: d57f583f194dac07ee8f85aa4fb46741061d2700
 SHA512:
-  metadata.gz: 56ed8d4f500b4f15685789245cb680da694b1844c00c5b3dc5b656c3aa31cfe7f41d4dbc4fef1ce55449b576bcac0f8e0bcd415f5747788d44df8fc960c89ad0
-  data.tar.gz: 0b9ac1c1bb2156a085d2072ed0b18bdaf29831c7e3b9244408ee4589d29d7575a3073f0a46168618b435ca0ba2783190b9f6cef52a787fa63225950d9ccf6ffd
+  metadata.gz: 7e7d7ba4ad5c638e828fa413e7243b799bb1159573503fd2772975c03f59b6e43b733555c6833f7ece7d049b11a73725fba5d1af695ace7fc0e683d0649fb959
+  data.tar.gz: 9a943a819b2cd47e8d2eb55302cabb544917a4f134dfd8054e4c30ecfd3cb21df79ad4c8a4e207b56285b9486b1e5ca54876e558c3e82859d4835b90bd6cbf4c

data/README.md

@@ -1,8 +1,6 @@
 # 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
+A lightweight gem for benchmarking garbage collect stats relevant to memory optimization.
 
 ## Installation
 
@@ -22,39 +20,43 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
 class Thing
   include BenchmarkGC
 
+  # A method you want to benchmark
   def method_name
     do_some_stuff
   end
+
+  # Add this method in order to benchmark (name doesn't matter)
+  def check
+    bcheck { method_name }
+  end
 end
+```
+
+In a console:
 
-Thing.new.bcheck(logger: false) { method_name }
+```ruby
+Thing.new.check
+```
 
-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
+#### 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:
+#### bcheck returns the value of the benchmarked code, making this possible:  
+```ruby
 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.
-
+```
+Now you can run any code that uses method_name, and method_name will get benchmarked each time it is run.
 
 ## License
 

data/benchmark_g_c.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["jnicholasjacques@gmail.com"]
 
   spec.summary       = %q{Benchmark Garbage Collect stats relevant to memory optimization.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/jacquesn/benchmark_g_c"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/benchmark_g_c.rb

@@ -26,8 +26,9 @@ module BenchmarkGC
     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
+    if defined? Rails.env
+      ActiveRecord::Base.logger = nil unless logger
+    end
     results = []
     return_value = nil
     times.times do

data/lib/benchmark_g_c/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: benchmark_g_c
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Nicholas Jacques
@@ -55,7 +55,7 @@ files:
 - bin/setup
 - lib/benchmark_g_c.rb
 - lib/benchmark_g_c/version.rb
-homepage: ''
+homepage: https://github.com/jacquesn/benchmark_g_c
 licenses:
 - MIT
 metadata: {}