schwad_performance_logger 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd6d203c9729e56ed7684650aa2fa88d9f20265f6d98db56eeff1d5a95aef1b1
-  data.tar.gz: dfcbec9237c8928e7becf1bbf13c52d9955abade5fa11dc10ecec4dd8047e2bc
+  metadata.gz: ae71b883d6ce1e62e230e41a71b01c1f5b7c1e5e5c45992478c575e09a7dfb57
+  data.tar.gz: 5a16178772f46465ad4af1d938ed19f3950090026b1e2730c41ae1718828027e
 SHA512:
-  metadata.gz: c7d454c9f5954b58c3326f1a60dac72a0d092a4b8e39b1a50160013f53cae011523ca53fe8591d49e702466c7b0d5683f3e2266426e6efa2b4900c40ca947ad2
-  data.tar.gz: caa3f2a8fea167cef1fb66ff35c6ede2c7264853a5a7a1b4318983bb62536e55fc1a2736156c46a8975812e2781a9fb748d88e704584453e853771c7887bba93
+  metadata.gz: 3812e45de8ca0808bdfe89569a7091e7146ed387c9f661c1d2fd8e8f6cf76c2170ba1a625df9631c2927f18f947b16e8f62b1f8af74058dc404350ecafdb7861
+  data.tar.gz: a4ae0ada2de63085af0ba737dcd426f404b3b0c69032069d47058ea76f89bc49054eafacd26c969da1b6ddb1bd953065cd7598456204a9117300740da6bb8e7b

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at nick.schwaderer@oceanshq.com. All
+reported by contacting the project team at nick.schwaderer@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Nick Schwaderer
+Copyright (c) 2019 Nick Schwaderer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 # SchwadPerformanceLogger
 
 This gem allows you to track memory usage and time passage during the life of
-the SchwadPerformanceLogger object, as well as deltas between each check. The output
+the SPL object, as well as deltas between each check. The output
 is `puts`'d to the console, and it also writes to a long-running CSV and per-object
 log file in `logs/schwad_performance_logger`
 
@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-`pl = SchwadPerformanceLogger.new({full_memo: 'Check extract method refactoring'})`
+`pl = SPL.new({full_memo: 'Check extract method refactoring'})`
 
 ```
 **********************************************************************
@@ -47,17 +47,17 @@ Starting Test memo. Current memory: 12(Mb), difference of 0 (mb) since beginning
 
 To disable any of the outputs:
 
-`SchwadPerformanceLogger.new({puts: false, log: false, csv: false})`
+`SPL.new({puts: false, log: false, csv: false})`
 
 To have the logger 'pause' a number of seconds during the `puts` logging so that
 you can actually see the log as it goes by. This does not affect the 'time' measurement:
 
-`SchwadPerformanceLogger.new({pause: 8})`
+`SPL.new({pause: 8})`
 
 ## Usage example:
 
 ```
-pl = SchwadPerformanceLogger.new({pause: 3, full_memo: 'Retry object-oriented approach.', log: false})
+pl = SPL.new({pause: 3, full_memo: 'Retry object-oriented approach.', log: false})
 pl.log_performance('check status before writing to database')
 
 # code here
@@ -69,6 +69,135 @@ pl.log_performance('check status after writing to database')
 pl.log_performance('inspect final performance after executing service')
 ```
 
+## Further Profiling Tools
+
+As well as logging memory and time throughout your code, SPL gives you easy access to frequently used popular profiling tools to inspect your code blocks.
+
+### IPS
+
+Handy access to [Benchmark-ips](https://github.com/evanphx/benchmark-ips) measurements, just pass a block to ips:
+
+```ruby
+SPL.ips do
+   ary = []
+   35.times do
+     ary << (1..99).to_a.sample
+   end
+end
+
+#=> #<Benchmark::IPS::Report:0x00007fbc7f91df50 @entries=[#<Benchmark::IPS::Report::Entry:0x00007fbc7e0c3bd0 @label="PerformanceLogMethod", @microseconds=5002798.0, @iterations=34020, @stats=#<Benchmark::IPS::Stats::SD:0x00007fbc7e0c3c48 @mean=6805.780564500376, @error=195>, @measurement_cycle=630, @show_total_time=true>], @data=nil>
+```
+
+### Time
+
+Same flow as above. Tired of writing out `start_time` and `Time.now - start_time` and also needing to 'puts' it out? Pass a block to `#time`. Runs ten times and spits out an average as well.
+
+```ruby
+SPL.time do
+   ary = []
+   35.times do
+     ary << (1..99).to_a.sample
+   end
+end
+
+#=> Average runtime 0.0002649 seconds. Max time 0.000508.seconds
+```
+
+### Allocate Count
+
+Before, you would have to enable the `GC` before your code, use `ObjectSpace` to count objects before your code, then use it again after your code to compare allocated objects during your block of code. You'd also have to re-enable the `GC`! Gosh, that sure is a lot of work if you want to do this frequently. We make it simple.
+
+```ruby
+SPL.allocate_count do
+   ary = []
+   35.times do
+     ary << (1..99).to_a.sample
+   end
+end
+
+#=> {:FREE=>-121, :T_STRING=>50, :T_ARRAY=>36, :T_IMEMO=>35}
+```
+
+### Profile Memory
+
+Gives you quick access to the amazing [memory_profiler](https://github.com/SamSaffron/memory_profiler) gem.
+
+```ruby
+SPL.profile_memory do
+   ary = []
+   35.times do
+     ary << (1..99).to_a.sample
+   end
+end
+
+# Total allocated: 37576 bytes (36 objects)
+# Total retained:  0 bytes (0 objects)
+#
+# allocated memory by gem
+# -----------------------------------
+#      37576  other
+#
+# allocated memory by file
+# -----------------------------------
+#      37576  (irb)
+#
+# allocated memory by location
+# -----------------------------------
+#      37240  (irb):37
+#        336  (irb):35
+#
+# allocated memory by class
+# -----------------------------------
+#      37576  Array
+#
+# allocated objects by gem
+# -----------------------------------
+#         36  other
+#
+# allocated objects by file
+# -----------------------------------
+#         36  (irb)
+#
+# allocated objects by location
+# -----------------------------------
+#         35  (irb):37
+#          1  (irb):35
+#
+# allocated objects by class
+# -----------------------------------
+#         36  Array
+```
+
+### All Objects
+
+Similarly, it's nice to get a rundown of all objects, in hash format, instead of goofing around with `ObjectSpace` manually we offer that up for you as well.
+
+```ruby
+SPL.all_objects do
+  ary = []
+  35.times do
+    ary << (1..99).to_a.sample
+  end
+end
+
+#=> [[Benchmark::IPS::Job, 1], [Rational, 1], [Benchmark::IPS::Report::Entry, 1], [Benchmark::IPS::Stats::SD, 1], [FFI::DynamicLibrary, 1], [DidYouMean::ClassNameChecker, 1], [Thread::Backtrace, 1], [NameError::message, 1], [NameError, 1], [#<Class:0x00007fbc7e816478>, 1], [Gem::Platform, 1], [IRB::Notifier::CompositeNotifier, 1], [IRB::Notifier::NoMsgNotifier, 1], [Enumerator, 1], [RubyToken::TkSPACE, 1], [FFI::Type::Mapped, 1], [IRB::ReadlineInputMethod, 1], [IRB::WorkSpace, 1], [IRB::Context, 1], [IRB::Irb, 1], [Gem::PathSupport, 1], [Monitor, 1], [IRB::Locale, 1], [DidYouMean::PlainFormatter, 1], [DidYouMean::DeprecatedIgnoredCallers, 1], [IRB::SLex, 1], [RubyLex, 1], [DidYouMean::ClassNameChecker::ClassName, 1], [URI::RFC2396_Parser, 1], [URI::RFC3986_Parser, 1], [Complex, 1], [ThreadGroup, 1], [IOError, 1], [Thread, 1], [RubyVM, 1], [NoMemoryError, 1], [SystemStackError, 1], [Random, 1], [ARGF.class, 1], [Benchmark::IPS::Job::Entry, 1], [Benchmark::IPS::Report, 1], [Benchmark::IPS::Job::StdoutReport, 1], [#<Class:0x00007fbc7e023e50>, 1], [FFI::Pointer, 1], [FFI::FunctionType, 2], [Integer, 2], [IRB::StdioOutputMethod, 2], [Binding, 2], [RubyToken::TkDOT, 2], [RubyToken::TkIDENTIFIER, 2], [FFI::StructLayout, 2], [UnboundMethod, 2], [RubyToken::TkEND, 2], [FFI::DynamicLibrary::Symbol, 2], [FFI::Function, 2], [fatal, 2], [RubyToken::TkNL, 3], [Thread::Mutex, 3], [IRB::Notifier::LeveledNotifier, 3], [IO, 5], [IRB::Inspector, 5], [BigDecimal, 6], [Float, 6], [FFI::StructLayout::Number, 7], [Object, 9], [Range, 17], [FFI::Type::Builtin, 21], [MatchData, 27], [Gem::Specification, 30], [Time, 31], [Module, 71], [IRB::SLex::Node, 78], [Gem::Dependency, 89], [Proc, 91], [Encoding, 101], [Symbol, 127], [Gem::Requirement, 159], [Hash, 188], [Gem::Version, 209], [Gem::StubSpecification, 252], [Gem::StubSpecification::StubLine, 252], [Regexp, 279], [Class, 633], [Array, 1838], [String, 15818]]
+```
+
+### Objects by Size
+
+You can break down your objects by size as well, useful for debugging.
+
+```ruby
+SPL.objects_by_size do
+  ary = []
+  35.times do
+    ary << (1..99).to_a.sample
+  end
+end
+
+#=> {:T_OBJECT=>101848, :T_CLASS=>730344, :T_MODULE=>76808, :T_FLOAT=>240, :T_STRING=>882168, :T_REGEXP=>200350, :T_ARRAY=>714384, :T_HASH=>150408, :T_STRUCT=>800, :T_BIGNUM=>80, :T_FILE=>1160, :T_DATA=>1074338, :T_MATCH=>28280, :T_COMPLEX=>40, :T_RATIONAL=>40, :T_SYMBOL=>5080, :T_IMEMO=>325040, :T_ICLASS=>3280, :TOTAL=>4294688}
+```
+
 ## 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.
@@ -85,4 +214,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SchwadPerformanceLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/schwad_performance_logger/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SPL project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/schwad_performance_logger/blob/master/CODE_OF_CONDUCT.md).

data/lib/schwad_performance_logger.rb

@@ -12,7 +12,7 @@ module SchwadPerformanceLogger
     if opts.is_a?(Hash)
       PLogger.new(opts)
     else
-      puts "I'm sorry, I don't know what you're trying to pass here!\n\n Please refer to the docs or pass an options hash https://github.com/oceanshq/schwad_performance_logger"
+      puts "I'm sorry, I don't know what you're trying to pass here!\n\n Please refer to the docs or pass an options hash https://github.com/schwad/schwad_performance_logger"
     end
   end
 

data/lib/schwad_performance_logger/version.rb

@@ -1,3 +1,3 @@
 module SchwadPerformanceLogger
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schwad_performance_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Nick Schwaderer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2019-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem
@@ -115,8 +115,6 @@ files:
 - lib/schwad_performance_logger.rb
 - lib/schwad_performance_logger/schwad_performance_logger.rb
 - lib/schwad_performance_logger/version.rb
-- schwad_performance_logger-0.2.0.gem
-- schwad_performance_logger-0.3.0.gem
 - schwad_performance_logger.gemspec
 homepage: https://schwad.github.io
 licenses:
@@ -137,7 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Track your memory and time performance in console, csv and/or logs.