worker_tools 1.1.1 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c80c0e36c172bb743ef9906a76fa10ddc47c624c8b61bd86d0910c1808c452
-  data.tar.gz: ce7cda946cace6bee98b2ad5d3faa0b89acad160eede6b93ea2ba464cd628cb7
+  metadata.gz: 6a69e014d2d2959641972ad163b5567e957693c90b54ae9e7aec4a723f1f39c6
+  data.tar.gz: 3cc3536cf26ab79054761570671361d23bbcb2c708e4974ebfd07ea8671180f3
 SHA512:
-  metadata.gz: 93b3c452a9238d6b85d6c39a5f47b9717535728e8f264a96dddea871455f48f2d81506b2d55003e075d055e377e4d670d48d83db915fff75381c7d04ec11b1ab
-  data.tar.gz: dcfac783ca52f62365be559827ad4de0690b95e62724975a40c8b4daaf58e861878cf61503613ecad6669d948ae76a833aa8c718a2a457e670ce1467110699fb
+  metadata.gz: f4d622417f3afd6057ae548f2b0e688ce1d8087d1e75a176ff4fe85caef5b1a1469e3ad07db2e21da2be6a365e97ba0bae18fbdd818f2eaea47bc7bb4e2fd0b7
+  data.tar.gz: e479438605973cf104b4c9d60cf3a7f821d09c053c7e569370afa7a1bbcc5e52006f65863a8a2085caa31f878df987c85d8daa7461c41f229aaa71094f9a6c2b

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.5

data/README.md

@@ -349,6 +349,25 @@ class MyImporter
 end
 ```
 
+## MemoryUsage
+
+There is a memory usage wrapper that you can use to record the memory consumption of your worker tasks. The memory usage is recorded in megabytes and stored in `model.meta['memory_usage']`. The module uses the `get_process_mem` gem to measure memory usage before and after the task execution.
+
+```ruby
+class MyImporter
+  include WorkerTools::MemoryUsage
+  wrappers :memory_usage
+
+  def run
+    # do stuff that consumes memory
+  end
+
+  # ..
+end
+```
+
+The memory usage will be automatically recorded in the model's meta attribute as `memory_usage` with the value in megabytes (rounded to 2 decimal places). The measurement represents the difference in memory usage before and after the task execution.
+
 ## Module 'Notes'
 
 If you use ActiveRecord you may need to modify the serializer as well as deserializer from the note attribute. After that you can easily serialize hashes and array of hashes with indifferent access. For that purpose the gem provides two utility methods. (HashWithIndifferentAccessType, SerializedArrayType). There is an example of how you can use it.

data/lib/worker_tools/memory_usage.rb

@@ -0,0 +1,28 @@
+require 'get_process_mem'
+
+module WorkerTools
+  module MemoryUsage
+    extend ActiveSupport::Concern
+
+    included do
+      # rubocop:disable Metrics/MethodLength
+      def with_wrapper_memory_usage(&block)
+        memory_error = nil
+        start_memory = GetProcessMem.new.mb
+
+        begin
+          block.call
+        rescue StandardError => e
+          memory_error = e
+        ensure
+          end_memory = GetProcessMem.new.mb
+          memory_used = (end_memory - start_memory).round(2)
+          model.meta['memory_usage'] = memory_used if model.respond_to?(:meta)
+        end
+
+        raise memory_error if memory_error
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end

data/lib/worker_tools/version.rb

@@ -1,3 +1,3 @@
 module WorkerTools
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.3'.freeze
 end

data/lib/worker_tools/xlsx_output.rb

@@ -1,5 +1,8 @@
 require 'rubyXL'
+require 'rubyXL/convenience_methods'
+
 module WorkerTools
+  # rubocop:disable Metrics/ModuleLength
   module XlsxOutput
     def xlsx_output_entries
       raise "xlsx_output_entries has to be defined in #{self}"
@@ -25,7 +28,8 @@ module WorkerTools
           label: 'Sheet 1',
           headers: xlsx_output_column_headers,
           rows: xlsx_output_entries.lazy.map { |entry| xlsx_output_row_values(entry) },
-          column_style: xlsx_output_column_format
+          column_style: xlsx_output_column_format,
+          number_format: xlsx_output_number_format
         }
       }
     end
@@ -48,6 +52,21 @@ module WorkerTools
       {}
     end
 
+    def xlsx_output_number_format
+      # set the cell number format for a given column
+      # number format also applies to dates, see the excel documentation:
+      #  https://support.microsoft.com/en-us/office/number-format-codes-in-excel-for-mac-5026bbd6-04bc-48cd-bf33-80f18b4eae68
+      #  https://www.rubydoc.info/gems/rubyXL/3.3.21/RubyXL/NumberFormats
+      #
+      # Ex:
+      # @xlsx_output_number_format ||= {
+      #   foo: :auto,
+      #   bar: '0.00',
+      #   # nothing for baz, it will go through `.to_s`
+      # }
+      {}
+    end
+
     def xlsx_output_insert_headers(spreadsheet, headers)
       return unless headers
 
@@ -62,13 +81,30 @@ module WorkerTools
       end
     end
 
-    def xlsx_output_insert_rows(spreadsheet, rows, headers)
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def xlsx_output_insert_rows(spreadsheet, rows, headers, number_formats)
+      number_format_by_col_index = Hash(number_formats).each_with_object({}) do |(col, number_format), hash|
+        hash[headers.keys.index(col)] = number_format
+      end
+
       rows.each_with_index do |row, row_index|
         xlsx_output_iterators(row, headers).each_with_index do |value, col_index|
-          spreadsheet.add_cell(row_index + 1, col_index, value.to_s)
+          number_format = number_format_by_col_index[col_index]
+
+          case number_format
+          when :auto, 'auto'
+            spreadsheet.add_cell(row_index + 1, col_index, value)
+          when nil
+            spreadsheet.add_cell(row_index + 1, col_index, value.to_s)
+          else
+            spreadsheet.add_cell(row_index + 1, col_index, value).set_number_format(number_format)
+          end
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     def xlsx_output_iterators(iterable, compare_hash = nil)
       if iterable.is_a? Hash
@@ -108,6 +144,7 @@ module WorkerTools
       )
     end
 
+    # rubocop:disable Metrics/AbcSize
     def xlsx_output_write_sheet(workbook, sheet_content, index)
       sheet = workbook.worksheets[index]
       sheet = workbook.add_worksheet(sheet_content[:label]) if sheet.nil?
@@ -115,8 +152,9 @@ module WorkerTools
       sheet.sheet_name = sheet_content[:label]
       xlsx_output_style_columns(sheet, sheet_content[:column_style], sheet_content[:headers])
       xlsx_output_insert_headers(sheet, sheet_content[:headers])
-      xlsx_output_insert_rows(sheet, sheet_content[:rows], sheet_content[:headers])
+      xlsx_output_insert_rows(sheet, sheet_content[:rows], sheet_content[:headers], sheet_content[:number_format])
     end
+    # rubocop:enable Metrics/AbcSize
 
     def xlsx_output_write_file
       book = RubyXL::Workbook.new
@@ -129,4 +167,5 @@ module WorkerTools
       xlsx_output_add_attachment
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/worker_tools.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'get_process_mem'
   spec.add_dependency 'roo'
   spec.add_dependency 'rubyXL'
   spec.add_dependency 'slack-notifier'
@@ -39,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop', '0.71.0'
+  spec.add_development_dependency 'rubocop', '0.72.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worker_tools
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '1.3'
 platform: ruby
 authors:
 - fsainz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2025-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  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: roo
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +198,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.72.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.72.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -229,6 +243,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".tool-versions"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -244,6 +259,7 @@ files:
 - lib/worker_tools/csv_input.rb
 - lib/worker_tools/csv_output.rb
 - lib/worker_tools/errors.rb
+- lib/worker_tools/memory_usage.rb
 - lib/worker_tools/recorder.rb
 - lib/worker_tools/slack_error_notifier.rb
 - lib/worker_tools/utils/hash_with_indifferent_access_type.rb
@@ -272,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A collection of modules to help writing common worker tasks)