milemarker 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc6c3aa16cc1d24991354663de1ceea5859d82a025e83d2683b9fa3b49d5f9e
-  data.tar.gz: 924edbc92d18fd924d4934f188a88e9c36ed8bbbae443a7815462b4d40388fe0
+  metadata.gz: 650f11afa03ba842418cd343cf81b0355e1c827299efa42b5a538e9f269babb9
+  data.tar.gz: 36705399cfe48604b955d3906a9190990a305fe624aaf64f45e98cff49bc0828
 SHA512:
-  metadata.gz: 7841d99693517311d47206ca49890278386643130dd934b6ca6f93fa0b0032c5e6f8aaaf038f8c0336ff2e967744d0e86a86c7dcb9b34e8030cdcecaf97a5773
-  data.tar.gz: 033d5566f4d893668c03f358f40a8ee2d0bd26610010e05ca11871225b94c2288f3bd252c1e9fc05f75034f200ba43d28520be5eba5d715e6f63766f8b19e765
+  metadata.gz: e73efc0e49af4e0ea25b68af7f158c38e01db35993ead87367d32306e485ac504d022c0dba7b5ad6b4deb4179151037aa5db25e73c5bd920747e589dd0ddf350
+  data.tar.gz: 21df5eb7752f0b5f70d3225682d2cf4fc1692cca9b0b94b8571246dd551fc71cc0df0f4f9883359d4f2a38f60a81ed8d66240d7e65bbd501ed31f550ae74da2c

data/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Run Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+env:
+  # See https://github.com/jruby/jruby/issues/5509
+  JAVA_OPTS: "--add-opens java.xml/com.sun.org.apache.xerces.internal.impl=org.jruby.dist"
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.2, 3.3, 3.4, jruby]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.0.2] - 2023-10-23
+
+- Add logger to gemfile, since it's no longer in stdlib
+
 ## [1.0.0] - 2021-11-29
 
 First public release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Bill Dueber
+Copyright (c) 2021 The Regents of the University of Michigan
 
 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/lib/milemarker/structured.rb

@@ -27,12 +27,12 @@ class Milemarker
         when Hash
           msg
         when String
-          { msg: msg }
+          {msg: msg}
         when Exception
           exception_message_hash(msg)
         else
           other_message_hash(msg)
-        end.merge({ level: severity, time: datetime }).to_json
+        end.merge({level: severity, time: datetime}).to_json
       end
       self
     end
@@ -50,7 +50,7 @@ class Milemarker
       }
     end
 
-    alias batch_data batch_line
+    alias_method :batch_data, :batch_line
 
     # @return [Hash] hash with information about the last batch
     def final_line
@@ -63,17 +63,17 @@ class Milemarker
       }
     end
 
-    alias final_data final_line
+    alias_method :final_data, :final_line
 
     def exception_message_hash(msg)
-      { msg: msg.message, error: msg.class, at: msg.backtrace&.first, hostname: Socket.gethostname }
+      {msg: msg.message, error: msg.class, at: msg.backtrace&.first, hostname: Socket.gethostname}
     end
 
     def other_message_hash(msg)
       if msg.respond_to? :to_h
         msg.to_h
       else
-        { msg: msg.inspect }
+        {msg: msg.inspect}
       end
     end
   end

data/lib/milemarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Milemarker
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/lib/milemarker.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "ppnum"
-require 'logger'
-require 'socket'
-require 'json'
-require 'milemarker/structured'
+require "logger"
+require "socket"
+require "json"
+require "milemarker/structured"
 
 # milemarker class, to keep track of progress over time for long-running
 # iterating processes
@@ -51,18 +51,18 @@ class Milemarker
   # @param [Logger, #info, #warn] Optional logger that responds to the normal #info, #warn, etc.
   def initialize(batch_size: 1000, name: nil, logger: nil)
     @batch_size = batch_size
-    @name       = name
-    @logger     = logger
+    @name = name
+    @logger = logger
 
     @batch_number = 0
-    @last_batch_size    = 0
+    @last_batch_size = 0
     @last_batch_seconds = 0
 
-    @start_time       = Time.now
+    @start_time = Time.now
     @batch_start_time = @start_time
-    @batch_end_time   = @start_time
+    @batch_end_time = @start_time
 
-    @count      = 0
+    @count = 0
     @prev_count = 0
   end
 
@@ -84,7 +84,7 @@ class Milemarker
     self
   end
 
-  alias increment incr
+  alias_method :increment, :incr
 
   # Create a logger for use in logging milemaker information
   # @example mm.create_logger!(STDOUT)
@@ -108,7 +108,7 @@ class Milemarker
     incr.on_batch(&blk)
   end
 
-  alias increment_and_on_batch _increment_and_on_batch
+  alias_method :increment_and_on_batch, :_increment_and_on_batch
 
   # Threadsafe version of #increment_and_on_batch, doing the whole thing as a single atomic action
   def threadsafe_increment_and_on_batch(&blk)
@@ -154,7 +154,7 @@ class Milemarker
     count - prev_count
   end
 
-  alias batch_count_so_far final_batch_size
+  alias_method :batch_count_so_far, :final_batch_size
 
   # A line describing the entire run, suitable for logging, of the form
   #   load records.ndj FINISHED. 27_138_118 total records in 00h 12m 39s. Overall 35_718 r/s.
@@ -208,8 +208,8 @@ class Milemarker
   # Set/reset all the internal state. Called by #on_batch when necessary;
   # should probably not be called manually
   def set_milemarker!
-    @batch_end_time     = Time.now
-    @last_batch_size    = @count - @prev_count
+    @batch_end_time = Time.now
+    @last_batch_size = @count - @prev_count
     @last_batch_seconds = @batch_end_time - @batch_start_time
 
     reset_for_next_batch!
@@ -218,8 +218,8 @@ class Milemarker
   # Reset the internal counters/timers at the end of a batch. Taken care of
   # by #on_batch; should probably not be called manually.
   def reset_for_next_batch!
-    @batch_start_time  = batch_end_time
-    @prev_count        = count
+    @batch_start_time = batch_end_time
+    @prev_count = count
     @batch_number = batch_divisor
   end
 
@@ -242,7 +242,7 @@ class Milemarker
 
   def seconds_to_time_string(sec)
     hours, leftover = sec.divmod(3600)
-    minutes, secs   = leftover.divmod(60)
+    minutes, secs = leftover.divmod(60)
     format("%02dh %02dm %02ds", hours, minutes, secs)
   end
 end

data/lib/ppnum.rb

@@ -20,15 +20,15 @@
 def ppnum(num, width = 0, decimals = 0)
   num = num.round(decimals)
   dec_str = if decimals.zero?
-              ""
-            else
-              ".#{format("%.#{decimals}f", num).split(".").last}"
-            end
+    ""
+  else
+    ".#{format("%.#{decimals}f", num).split(".").last}"
+  end
   numstr = num.floor.to_s.reverse.split(/(...)/)
-              .reject(&:empty?)
-              .map(&:reverse)
-              .reverse
-              .join("_") + dec_str
+    .reject(&:empty?)
+    .map(&:reverse)
+    .reverse
+    .join("_") + dec_str
   if width.zero?
     numstr
   else

data/milemarker.gemspec

@@ -3,39 +3,39 @@
 require_relative "lib/milemarker/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "milemarker"
-  spec.version       = Milemarker::VERSION
-  spec.authors       = ["Bill Dueber"]
-  spec.email         = ["bill@dueber.com"]
-
-  spec.summary       = "Track and produce loglines for batch processing progress."
-  spec.homepage      = "https://github.com/billdueber/milemarker"
-  spec.license       = "MIT"
+  spec.name = "milemarker"
+  spec.version = Milemarker::VERSION
+  spec.authors = ["Bill Dueber"]
+  spec.email = ["bill@dueber.com"]
+
+  spec.summary = "Track and produce loglines for batch processing progress."
+  spec.homepage = "https://github.com/billdueber/milemarker"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage + '/CHANGELOG.md'
+  spec.metadata["changelog_uri"] = spec.homepage + "/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "logger"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
   #
 
-  spec.add_development_dependency 'bundler', '~>2.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~>13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "standardrb"
 end

metadata

@@ -1,29 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: milemarker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Bill Dueber
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -42,52 +55,51 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standardrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
-description:
+        version: '0'
 email:
 - bill@dueber.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -110,7 +122,6 @@ metadata:
   homepage_uri: https://github.com/billdueber/milemarker
   source_code_uri: https://github.com/billdueber/milemarker
   changelog_uri: https://github.com/billdueber/milemarker/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Track and produce loglines for batch processing progress.
 test_files: []

data/.github/workflows/main.yml

@@ -1,16 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6.6
-        bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake