worker_tools 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1415ea362f335ec470179b445eb6b2c7c8c6466068d8dcc9fb7af6c082be270c
-  data.tar.gz: 9ec83f9b2f8efe9739ddf6c33b4c0942ac63a7d4d280b318aa98280bda751eb9
+  metadata.gz: 762658656dbb6922693f4a5c53c1dcbadf5ef2c9ab1e6059078aef2b14ff9a70
+  data.tar.gz: 7e0cb67a63bc63e478f6d741d5ecd1d400489a6cc00bbefc66831687e0b968ed
 SHA512:
-  metadata.gz: 062fb7d927b8d362c065c42a4e06c2764f42e94dd5a2feb954f1c3a13a4ed0a57386013e395c532d34afcd8a6528b04d4558aeee112ca19d29d4448119127519
-  data.tar.gz: f3986d2a27f1adce89120e3b6dd6a4197202b277323d263d8b51b426293752e31bf0489c23e06f1068ffbb48a0d9059429d43d8710185c36c5072a9aec9b3636
+  metadata.gz: 33c69281ec2a6577bb9be3ce2ac1c02937d10fa032a143f0ceed0afbe11b2f5ecbf5082862f06df68c41368b085b4f08c2757f9a45d3f472508e57f4eb09c1e3
+  data.tar.gz: 556c5fa62fae0c8e51b34bfa0561dac1b05c14d4602687520505a04ee317ea989d64514760de931e7926f127656166e44897f9b078782cc08643de18627db369

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.1.0] - 2023-07-13
+
+### New
+
+- Custom run_modes
+- XlsxInput without headers
+- Custom reset hook
+- Increment counters by a given amount
+
+### BREAKING CHANGES
+
+`WorkerTools::Errors::Invalid` has being replaced with `WorkerTools::Errors::Silent`
+
+The method `non_failure_error?` has being replaced with `silent_error?`
+
 ## [1.0.0] - 2022-05-20
 
 Compared to 0.2.1

data/README.md

@@ -145,7 +145,7 @@ end
 
 The basics module contains a `perform` method, which is the usual entry point for ApplicationJob and Sidekiq. It can receive the id of the model, the model instance, or nothing, in which case it will attempt to create this model on its own.
 
-By default errors subclassed from WorkerTools::Errors::Invalid (such as those related to wrong headers in the input modules) will not raise and mark the model as failed. The method `non_failure_error?` lets you modifiy this behaviour.
+By default errors subclassed from WorkerTools::Errors::Silent (such as those related to wrong headers in the input modules) will mark the model as failed but not raise. The method `silent_error?` lets you modifiy this behaviour.
 
 ## Module 'Recorder'
 
@@ -269,6 +269,35 @@ def perform(model_id)
 end
 ```
 
+## Run Modes
+
+It is possible to run the same task in different modes by providing the key `run_mode` inside `options`. For example, by setting it to `:destroy`, the method `run_in_destroy_mode` will get called instead of the usual `run`
+
+```ruby
+    # options[:run_mode] = :destroy
+
+    def run_in_destroy_mode
+      # add_some note
+      # delete plenty of stuff, take your time
+    end
+```
+
+As a convention, use `options[:run_mode_option]` to provide more context:
+
+```ruby
+    # options[:run_mode] = :destroy
+    # options[:run_mode_option] = :all / :only_foos / :only_bars
+    def run_in_destroy_mode
+      case run_mode_option
+      when :all then kaboom
+      when :only_foos then delete_foos
+      when :only_bars then delete_bars
+      end
+    end
+```
+
+If the corresponding run method is not available an exeception will be raised. A special case is the run_mode `:repeat` which will try to use the method `:run_in_repeat_mode` and fallback to `run` if not present.
+
 ## Counter
 
 There is a counter wrapper that you can use to add custom counters to the meta attribute. To do this, you need to complete the following tasks:
@@ -290,7 +319,8 @@ class MyImporter
 
   def example_foo_counter_methods
     # you can use the increment helper
-    10.times { increment_foo }
+    10.times { increment_foo } # +1
+    increment_foo(5) # +5
 
     # the counter works like a regular accessor, you can read it and modify it
     # directly

data/lib/worker_tools/basics.rb

@@ -33,8 +33,9 @@ module WorkerTools
     def perform(model_id = nil)
       @model_id = model_id
 
+      default_reset
       with_wrappers(wrapper_methods) do
-        run
+        send(run_method)
       end
     end
 
@@ -48,18 +49,16 @@ module WorkerTools
     end
 
     def with_wrapper_basics(&block)
-      save_state_without_validate('running')
+      custom_reset if respond_to?(:custom_reset, true)
       block.yield
       finalize
     # this time we do want to catch Exception to attempt to handle some of the
     # critical errors.
     # rubocop:disable Lint/RescueException
     rescue Exception => e
-      return finalize if non_failure_error?(e)
-
       # rubocop:enable Lint/RescueException
       save_state_without_validate('failed')
-      raise
+      raise unless silent_error?(e)
     end
 
     def finalize
@@ -85,14 +84,37 @@ module WorkerTools
       send(current_wrapper_symbol) { with_wrappers(wrapper_symbols, &block) }
     end
 
-    def non_failure_error?(error)
-      error.is_a?(WorkerTools::Errors::Invalid)
+    def silent_error?(error)
+      error.is_a?(WorkerTools::Errors::Silent)
       # or add your list
-      # [WorkerTools::Errors::Invalid, SomeOtherError].any? { |k| e.is_a?(k) }
+      # [WorkerTools::Errors::Silent, SomeOtherError].any? { |k| e.is_a?(k) }
     end
 
     private
 
+    def run_mode
+      model.try(:options).try(:[], 'run_mode').try(:to_sym)
+    end
+
+    def run_mode_option
+      model.try(:options).try(:[], 'run_mode_option').try(:to_sym)
+    end
+
+    def run_method
+      return :run unless run_mode.present?
+
+      method_name = "run_in_#{run_mode}_mode"
+      return method_name.to_sym if respond_to?(method_name, true)
+      return :run if run_mode == :repeat # common fallback
+
+      raise "Missing method #{method_name}"
+    end
+
+    def default_reset
+      model.attributes = { notes: [], meta: {}, state: 'running' }
+      model.save!(validate: false)
+    end
+
     def save_state_without_validate(state)
       model.state = state
       model.save!(validate: false)

data/lib/worker_tools/counters.rb

@@ -21,7 +21,7 @@ module WorkerTools
           define_method("#{name}=") { |value| model.meta[name] = value }
 
           # ex `increment_inserts`
-          define_method("increment_#{name}") { model.meta[name] += 1 }
+          define_method("increment_#{name}") { |inc = 1| model.meta[name] += inc }
         end
       end
 

data/lib/worker_tools/csv_input.rb

@@ -151,7 +151,6 @@ module WorkerTools
 
         CsvInputForeach.new(
           rows_enum: csv_rows_enum,
-          input_columns: csv_input_columns,
           mapping_order: csv_input_mapping_order(csv_rows_enum.first),
           cleanup_method: method(:cvs_input_value_cleanup),
           headers_present: csv_input_headers_present
@@ -162,9 +161,8 @@ module WorkerTools
     class CsvInputForeach
       include Enumerable
 
-      def initialize(rows_enum:, input_columns:, mapping_order:, cleanup_method:, headers_present:)
+      def initialize(rows_enum:, mapping_order:, cleanup_method:, headers_present:)
         @rows_enum = rows_enum
-        @input_columns = input_columns
         @mapping_order = mapping_order
         @cleanup_method = cleanup_method
         @headers_present = headers_present
@@ -181,20 +179,10 @@ module WorkerTools
       end
 
       def values_to_row(values)
-        return values_to_row_according_to_mapping(values) if @mapping_order
-
-        values_to_row_according_to_position(values)
-      end
-
-      def values_to_row_according_to_mapping(values)
         @mapping_order.each_with_object(HashWithIndifferentAccess.new) do |(k, v), h|
           h[k] = @cleanup_method.call(values[v])
         end
       end
-
-      def values_to_row_according_to_position(values)
-        @input_columns.map.with_index { |c, i| [c, @cleanup_method.call(values[i])] }.to_h.with_indifferent_access
-      end
     end
   end
 end

data/lib/worker_tools/errors.rb

@@ -2,9 +2,9 @@ module WorkerTools
   Error = Class.new(StandardError)
 
   module Errors
-    Invalid = Class.new(Error)
-    WrongNumberOfColumns = Class.new(Invalid)
-    DuplicatedColumns = Class.new(Invalid)
-    MissingColumns = Class.new(Invalid)
+    Silent = Class.new(Error)
+    WrongNumberOfColumns = Class.new(Silent)
+    DuplicatedColumns = Class.new(Silent)
+    MissingColumns = Class.new(Silent)
   end
 end

data/lib/worker_tools/version.rb

@@ -1,3 +1,3 @@
 module WorkerTools
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/worker_tools/xlsx_input.rb

@@ -138,6 +138,10 @@ module WorkerTools
       end
     end
 
+    def xlsx_input_headers_present
+      true
+    end
+
     def xlsx_input_foreach
       @xlsx_input_foreach ||= begin
         xlsx_input_columns_check(xlsx_rows_enum)
@@ -145,7 +149,8 @@ module WorkerTools
         XlsxInputForeach.new(
           rows_enum: xlsx_rows_enum,
           mapping_order: xlsx_input_mapping_order(xlsx_rows_enum.first),
-          cleanup_method: method(:xlsx_input_value_cleanup)
+          cleanup_method: method(:xlsx_input_value_cleanup),
+          headers_present: xlsx_input_headers_present
         )
       end
     end
@@ -153,17 +158,18 @@ module WorkerTools
     class XlsxInputForeach
       include Enumerable
 
-      def initialize(rows_enum:, mapping_order:, cleanup_method:)
+      def initialize(rows_enum:, mapping_order:, cleanup_method:, headers_present:)
         @rows_enum = rows_enum
         @mapping_order = mapping_order
         @cleanup_method = cleanup_method
+        @headers_present = headers_present
       end
 
       def each
         return enum_for(:each) unless block_given?
 
         @rows_enum.with_index.each do |values, index|
-          next if index.zero? # headers
+          next if index.zero? && @headers_present
 
           yield values_to_row(values)
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worker_tools
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - fsainz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport