worker_tools 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1660c965e25b8331d1aa6a7643f5bee9f0441c02a6593ce71028c7e89ea4c14
-  data.tar.gz: 06c98881c9cf9a1f8c1312a8fbbff6bdc3c4471203cdb0678f89cd8570e4c8e4
+  metadata.gz: a53ae86156768dd1b1f80601a50f8c6926918d3f625be933173f7d4513c0f2d8
+  data.tar.gz: 48dfc8c5430311e2b6dae3d5bfbb55d6d2ce0444d3c5e5dd5a9cf044e42afdf7
 SHA512:
-  metadata.gz: d3b7e56590008364884c685285be80264c435ff4b6129649e9c8f1b26ae01d4655c352390896cf2e5ca8726ba537933812cf15eedc6cae73be8de60d8e8a1178
-  data.tar.gz: fcb3b2479c852071296443df0cdca53aba6ace592231a14011436013b52591650c2b558d0955c067ef37a4ae16bce4f873f62fbe9681841ba047b686ede87544
+  metadata.gz: 95ac0fe0d5255b995a5c7a0193edf6a56eb5d376234e1f6088f6c97ad03ea6e760d499c62c2c711f5ad2b453f5c9f7b5309f9bea2acfb50b9c60621b83ed3800
+  data.tar.gz: e2a09d6b64d813a0296f81d5ef995ed49178957bfdbf67349e5b2d811ec84e98b08850e9565f875f02a6b105f9ae9769cfd177d660b2a4d98bf0b2ae03ecf77c

data/README.md

@@ -59,6 +59,7 @@ In this case the migration would be something like this:
       t.integer :state, default: 0, null: false
       t.text :information
       t.json  :options, default: {}
+      t.json :meta, default: {}
 
       t.string :attachment_file_name
       t.integer :attachment_file_size
@@ -199,6 +200,52 @@ def perform(model_id)
 end
 ```
 
+## Counters
+
+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:
+- include WorkerTools::Counters to your class
+- add :counters to the wrappers method props
+- call counters method with your custom counters
+You can see an example below. After that, you can access your custom counters via the meta attribute.
+
+```ruby
+class MyImporter
+  include WorkerTools::Counters
+  wrappers :counters
+  counters :foo, :bar
+
+  def run
+    example_foo_counter_methods
+  end
+
+  def example_foo_counter_methods
+    self.foo = 0
+
+    10.times { increment_foo }
+
+    puts foo # foo == 10
+  end
+  
+  # ..
+end
+```
+
+## Benchmark
+
+There is a benchmark wrapper that you can use to record the benchmark. The only thing you need to do is to include the benchmark module and append the name to the wrapper array. Below you can see an example of the integration.
+
+```ruby
+class MyImporter
+  include WorkerTools::CustomBenchmark
+  wrappers :benchmark
+
+  def run
+    # do stuff
+  end
+
+  # ..
+end
+```
 
 ## Contributing
 

data/lib/worker_tools/basics.rb

@@ -33,6 +33,7 @@ module WorkerTools
 
     def perform(model_id = nil)
       @model_id = model_id
+
       with_wrappers(wrapper_methods) do
         run
       end

data/lib/worker_tools/benchmark.rb

@@ -0,0 +1,15 @@
+module WorkerTools
+  module CustomBenchmark
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :benchmark
+
+      def with_wrapper_benchmark(&block)
+        @benchmark = Benchmark.measure(&block)
+
+        model.meta['duration'] = @benchmark.real.round if model.respond_to?(:meta)
+      end
+    end
+  end
+end

data/lib/worker_tools/counters.rb

@@ -0,0 +1,41 @@
+module WorkerTools
+  module Counters
+    extend ActiveSupport::Concern
+
+    included do
+      def self.counters(*args)
+        @counters ||= args.flatten
+        add_counter_methods
+      end
+
+      def self.read_counters
+        @counters || []
+      end
+
+      def self.add_counter_methods
+        @counters.each do |name|
+          define_method name do
+            model.meta[name]
+          end
+          define_method "#{name}=" do |value|
+            model.meta[name] = value
+          end
+          define_method "increment_#{name}" do
+            model.meta[name] += 1
+          end
+        end
+      end
+
+      def with_wrapper_counters(&block)
+        reset_counters
+        block.call
+      end
+
+      def reset_counters
+        self.class.read_counters.each do |name|
+          model.meta[name] = 0
+        end
+      end
+    end
+  end
+end

data/lib/worker_tools/recorder.rb

@@ -1,5 +1,6 @@
 module WorkerTools
   module Recorder
+
     def with_wrapper_recorder(&block)
       block.yield
     # this time we do want to catch Exception to attempt to handle some of the

data/lib/worker_tools/version.rb

@@ -1,3 +1,3 @@
 module WorkerTools
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worker_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - fsainz
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,7 +220,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - fernando.sainz@i22.de
 executables: []
@@ -238,6 +238,8 @@ files:
 - bin/setup
 - lib/worker_tools.rb
 - lib/worker_tools/basics.rb
+- lib/worker_tools/benchmark.rb
+- lib/worker_tools/counters.rb
 - lib/worker_tools/csv_input.rb
 - lib/worker_tools/csv_output.rb
 - lib/worker_tools/recorder.rb
@@ -251,7 +253,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -266,8 +268,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A collection of modules to help writing common worker tasks)
 test_files: []