worker_tools 1.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df0b1a0aede242ffcdd30a20f86adc4b05d78cf1634e998ad25c5edb0b654b9e
-  data.tar.gz: be05c13b2ab05fc02d67692bc676087c97502b9ef8d7598910d54650c9122241
+  metadata.gz: 36547805fb8cfbbf750b84c31fb325a918c54501830bbdfd68f8f2c8f5b1267e
+  data.tar.gz: 47361b96ca6e8964b688b0ea50e426c2786edc9b0415984fc9dd4c5247c9cc1d
 SHA512:
-  metadata.gz: ea0934e1b034b0011707909f2ef17c98c52458885d1ead4ee537373c668cf50a72c44c5b3dfcb6dfc1e9beab7a97e12892372415fe9f73c1b4a2952b9c032584
-  data.tar.gz: 27550fcf2510fe836215ee316b24780f732afda39714d69a8d1d60047048c91c01c6595475cc0396cc2b64d838d4eb9e953efcf078e6660e52a3c36f13b565cc
+  metadata.gz: d0fbe8c88c4aa16ea93840bae76823d43aa98539110ba3f347607ca809ddf0ae5687a84608d86b73ae3b771816ad746d9e2006c681192fca3c1bec33c04a9af6
+  data.tar.gz: c0bbd1d018d2d77a61fd538c337423d6380ed1a351e8844eb930e6fd416068461df06fa8732527cadd5949348be44f3ec70bf6ac97dcfdb1b7eec02825dfd0e2

data/.tool-versions

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

data/README.md

@@ -84,6 +84,7 @@ class Import < ApplicationRecord
     complete_with_warnings
     failed
     running
+    empty
   ].map { |e| [e, e] }.to_h
 
   enum kind: { foo: 0, bar: 1 }
@@ -99,6 +100,8 @@ The state `complete` and `failed` are used by the modules. Both `state` and `kin
 
 The state `complete_with_warnings` indicates that the model contains notes that did not lead to a failure but should get some attention. By default those levels are `warning` and `errors` and can be customized.
 
+The state `empty` is automatically set by the CSV and XLSX input modules when the input file does not exist or is empty (0 bytes).
+
 In this case the migration would be something like this:
 
 ```ruby
@@ -199,6 +202,22 @@ See all methods in [slack_error_notifier](/lib/worker_tools/slack_error_notifier
 
 See all methods in [csv_input](/lib/worker_tools/csv_input.rb)
 
+### Skipping File Presence Check
+
+By default, the CSV Input module checks if the file exists and is not empty. If you need to skip this validation (for example, if an empty file is valid for your process), you can override the `csv_input_file_presence_check` method:
+
+```ruby
+class CsvInputExample
+  include WorkerTools::CsvInput
+
+  def csv_input_file_presence_check
+    true
+  end
+
+  # ... rest of your implementation
+end
+```
+
 ## Module CSV Output
 
 See all methods in [csv_output](/lib/worker_tools/csv_output.rb)
@@ -349,6 +368,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/basics.rb

@@ -57,7 +57,9 @@ module WorkerTools
     # rubocop:disable Lint/RescueException
     rescue Exception => e
       # rubocop:enable Lint/RescueException
-      save_state_without_validate('failed')
+      state = e.is_a?(WorkerTools::Errors::EmptyFile) ? 'empty' : 'failed'
+      save_state_without_validate(state)
+
       raise unless silent_error?(e)
     end
 

data/lib/worker_tools/csv_input.rb

@@ -59,6 +59,8 @@ module WorkerTools
     end
 
     def csv_input_columns_array_check(csv_rows_enum)
+      return if csv_rows_enum.first.nil?
+
       expected_columns_length = csv_input_columns.length
       actual_columns_length = csv_rows_enum.first.length
       return if expected_columns_length == actual_columns_length
@@ -68,6 +70,8 @@ module WorkerTools
     end
 
     def csv_input_columns_hash_check(csv_rows_enum)
+      raise Errors::MissingColumns, 'The headers are missing' if csv_rows_enum.first.nil?
+
       expected_names = csv_input_columns.values
       filtered_actual_names = csv_rows_enum.first.map { |n| csv_input_header_normalized(n) }
       csv_input_columns_hash_check_duplicates(filtered_actual_names)
@@ -145,8 +149,14 @@ module WorkerTools
       true
     end
 
+    def csv_input_file_presence_check
+      raise Errors::EmptyFile, 'The file does not exist' unless File.exist?(csv_input_file_path)
+      raise Errors::EmptyFile, 'The file is empty' if File.zero?(csv_input_file_path)
+    end
+
     def csv_input_foreach
       @csv_input_foreach ||= begin
+        csv_input_file_presence_check
         csv_input_columns_check(csv_rows_enum)
 
         CsvInputForeach.new(

data/lib/worker_tools/errors.rb

@@ -6,5 +6,11 @@ module WorkerTools
     WrongNumberOfColumns = Class.new(Silent)
     DuplicatedColumns = Class.new(Silent)
     MissingColumns = Class.new(Silent)
+
+    class EmptyFile < Silent
+      def initialize(msg = 'The file is empty')
+        super(msg)
+      end
+    end
   end
 end

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.2'.freeze
+  VERSION = '1.3.1'.freeze
 end

data/lib/worker_tools/xlsx_input.rb

@@ -142,8 +142,14 @@ module WorkerTools
       true
     end
 
+    def xlsx_input_file_presence_check
+      raise Errors::EmptyFile, 'The file does not exist' unless File.exist?(xlsx_input_file_path)
+      raise Errors::EmptyFile, 'The file is empty' if File.zero?(xlsx_input_file_path)
+    end
+
     def xlsx_input_foreach
       @xlsx_input_foreach ||= begin
+        xlsx_input_file_presence_check
         xlsx_input_columns_check(xlsx_rows_enum)
 
         XlsxInputForeach.new(

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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worker_tools
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.3.1
 platform: ruby
 authors:
 - fsainz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-18 00:00:00.000000000 Z
+date: 2026-01-12 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
@@ -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