schwad_performance_logger 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae71b883d6ce1e62e230e41a71b01c1f5b7c1e5e5c45992478c575e09a7dfb57
-  data.tar.gz: 5a16178772f46465ad4af1d938ed19f3950090026b1e2730c41ae1718828027e
+  metadata.gz: 1cd2043d45f57759843573942457ed5c635fb32d911d0119178c798ca162ece9
+  data.tar.gz: 79f240f10f256b9b04513385486b24e26da6d352dee79587ea8802ef41b517a1
 SHA512:
-  metadata.gz: 3812e45de8ca0808bdfe89569a7091e7146ed387c9f661c1d2fd8e8f6cf76c2170ba1a625df9631c2927f18f947b16e8f62b1f8af74058dc404350ecafdb7861
-  data.tar.gz: a4ae0ada2de63085af0ba737dcd426f404b3b0c69032069d47058ea76f89bc49054eafacd26c969da1b6ddb1bd953065cd7598456204a9117300740da6bb8e7b
+  metadata.gz: c2a1badb587b6c532a170a80fccef850f085ba38cfc6e9a15286eee90b97ee9f9778efd95ad166bf7978acbd4f0ba08040b2635e397749f581857c55944a7f62
+  data.tar.gz: 7df45a0cebe6b180a4822c8046803d99219d09a99a6841fbb9517f2204c24d955767063bf787e76f3b43406528f75deec6838bd9a1a1204ef88997ed827dbde7

data/Gemfile.lock

@@ -1,37 +1,62 @@
 PATH
   remote: .
   specs:
-    schwad_performance_logger (0.2.0)
+    schwad_performance_logger (0.5.0)
+      benchmark-ips
       get_process_mem
+      memory_profiler
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    get_process_mem (0.2.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    benchmark-ips (2.13.0)
+    diff-lcs (1.5.1)
+    ffi (1.17.0)
+    ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-aarch64-linux-musl)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm-linux-musl)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86-linux-musl)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0-x86_64-linux-musl)
+    get_process_mem (0.2.7)
+      ffi (~> 1.0)
+    memory_profiler (1.0.2)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
 
 PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
   ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   schwad_performance_logger!
 
 BUNDLED WITH
-   1.16.2
+   2.5.11

data/README.md

@@ -1,7 +1,7 @@
 # SchwadPerformanceLogger
 
-This gem allows you to track memory usage and time passage during the life of
-the SPL object, as well as deltas between each check. The output
+This gem allows you to track memory usage and time passage in your code. It does this during the life of
+the SPL object, as well as giving 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`
 

data/lib/schwad_performance_logger/schwad_performance_logger.rb

@@ -1,27 +1,16 @@
-##
-# Logs performance during life of the object. Defaults to a trifecta of `puts`
-# output as well as logging to CSV (in the root folder) and
-# `log/schwad_performance_logger` for traditional info-level logging. It also gives
-# timing and memory usage info. Options include disabling extra logging,
-# including a 'sleep' parameter to have the application pause at each output
-# (so your puts info is not drowned). This does not impact the time output
-#
-# It also puts out delta memory and time so you can see 'between-log' spikes.
-#
-# This is stored in the system as 'second_delta'
-#
-class PLogger
+require 'logger'
+require 'csv'
+require 'get_process_mem'
 
+class PLogger
   attr_accessor :initial_memory, :initial_time, :current_memory, :last_memory, :current_time, :last_time, :delta_memory, :second_delta_memory, :delta_time, :second_delta_time, :sleep_amount, :sleep_adjuster, :logger
-
   attr_reader :options
 
-  def initialize( options = {} )
-    system('mkdir log')
-    system('mkdir log/schwad_performance_logger')
+  def initialize(options = {})
+    system('mkdir -p log/schwad_performance_logger')
     filename = "./log/schwad_performance_logger/performance-#{Time.now.strftime("%e-%m_%l:%M%p")}.log"
     File.write(filename, "")
-    another_empty_csv_row
+    initialize_csv
     @logger = Logger.new(filename)
     @options = options
     @sleep_amount = options[:pause].to_i
@@ -33,33 +22,50 @@ class PLogger
     @current_time = @initial_time
     @last_time = @initial_time
     @last_memory = @initial_memory
-    @sleep_adjuster = -@sleep_amount #This is to remove the sleeps for performance checking.
+    @sleep_adjuster = -@sleep_amount # This is to remove the sleeps for performance checking.
     log_performance('initialization')
   end
 
-  def log_performance(memo=nil)
-    update_checks
-    puts_performance(memo) unless @options[:puts] == false
-    logger_performance(memo) unless @options[:log] == false
-    csv_performance(memo) unless @options[:csv] == false
+  def log_performance(memo = nil)
+    if block_given?
+      update_checks
+      yield
+      update_checks
+      puts_performance("After: #{memo}", gblock: true) unless @options[:puts] == false
+      logger_performance("After: #{memo}") unless @options[:log] == false
+      csv_performance("After: #{memo}") unless @options[:csv] == false
+    else
+      update_checks
+      puts_performance(memo) unless @options[:puts] == false
+      logger_performance(memo) unless @options[:log] == false
+      csv_performance(memo) unless @options[:csv] == false
+    end
     sleep @sleep_amount
   end
+  alias :log :log_performance
+  alias :lp :log_performance
 
   private
 
-  def puts_performance(memo)
-    puts '*' * 300
-    puts "Starting #{memo}. Current memory: #{@current_memory}(Mb), difference of #{@delta_memory} (mb) since beginning and difference of #{@second_delta_memory} since last log. time passed: #{@delta_time} seconds, time since last run: #{@second_delta_time}"
-    puts '*' * 300
+  def puts_performance(memo, gblock: false)
+    separator = '*' * 80
+    puts "\e[34m#{separator}\e[0m"
+    puts "\e[32m#{memo}\e[0m"
+    if gblock
+      puts format_output_block
+    else
+      puts format_output
+    end
+    puts "\e[34m#{separator}\e[0m"
   end
 
   def logger_performance(memo)
-    @logger.log(1, "#{options[:full_memo]}\n----------------------\n\n#{memo}: \n\n Current Memory: #{@current_memory} \n\n Memory Since Start: #{@delta_memory}\n\n Memory Since Last Run: #{@second_delta_memory}\n\n Time Passed: #{@delta_time} \n\n Time Since Last Run: #{@second_delta_time}\n--------------------\n\n ")
+    @logger.info("#{options[:full_memo]}\n----------------------\n\n#{memo}:\n\n#{format_output}\n--------------------\n\n")
   end
 
-  def another_empty_csv_row
-    CSV.open("schwad_performance_logger_measurements.csv", "ab") do |csv|
-      csv << []
+  def initialize_csv
+    CSV.open("schwad_performance_logger_measurements.csv", "wb") do |csv|
+      csv << ["Full Memo", "Memo", "Current Memory (Mb)", "Memory Since Start (Mb)", "Memory Since Last Log (Mb)", "Time Passed (s)", "Time Since Last Run (s)"]
     end
   end
 
@@ -80,4 +86,24 @@ class PLogger
     @second_delta_time = @current_time - @last_time
     @delta_time = (@current_time - @initial_time) - @sleep_adjuster
   end
+
+  def format_output_block
+    <<~OUTPUT
+      \e[33mCurrent memory:\e[0m          #{@current_memory} Mb
+      \e[33mDifference since start:\e[0m  #{@delta_memory} Mb
+      \e[33mMemory used within block:\e[0m #{@second_delta_memory} Mb
+      \e[33mTime passed:\e[0m             #{@delta_time * 1000} milliseconds
+      \e[33mTime executing block:\e[0m     #{@second_delta_time * 1000} milliseconds
+    OUTPUT
+  end
+
+  def format_output
+    <<~OUTPUT
+      \e[33mCurrent memory:\e[0m          #{@current_memory} Mb
+      \e[33mDifference since start:\e[0m  #{@delta_memory} Mb
+      \e[33mDifference since last log:\e[0m #{@second_delta_memory} Mb
+      \e[33mTime passed:\e[0m             #{@delta_time * 1000} milliseconds
+      \e[33mTime since last run:\e[0m     #{@second_delta_time * 1000} milliseconds
+    OUTPUT
+  end
 end

data/lib/schwad_performance_logger/version.rb

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

data/schwad_performance_logger.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["nicholas.schwaderer@gmail.com"]
 
   spec.summary       = %q{Track your memory and time performance in console, csv and/or logs.}
-  spec.homepage      = "https://schwad.github.io"
+  spec.homepage      = "https://github.com/Schwad/schwad_performance_logger"
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.
@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "benchmark-ips"
   spec.add_dependency "memory_profiler"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schwad_performance_logger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nick Schwaderer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem
@@ -52,34 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - nicholas.schwaderer@gmail.com
 executables: []
@@ -104,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -116,11 +103,11 @@ files:
 - lib/schwad_performance_logger/schwad_performance_logger.rb
 - lib/schwad_performance_logger/version.rb
 - schwad_performance_logger.gemspec
-homepage: https://schwad.github.io
+homepage: https://github.com/Schwad/schwad_performance_logger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Track your memory and time performance in console, csv and/or logs.
 test_files: []