materialist 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc140c911742867585c275c7b87a08cce340b165
-  data.tar.gz: dd08e90c55127a4b8375f859613ec73cda95970d
+SHA256:
+  metadata.gz: a7a241994e95f26afa7c395df4780b3ff7a2b0dc3063498e97a73f5a36ecb008
+  data.tar.gz: 014d469aec8cffe93f23d8aafb3036a8d4dab62c95c12f400bad372e4a9fb438
 SHA512:
-  metadata.gz: 4bcb195f30deff05ab9c83de55475473f8efee6a599cb694f47fdb55438b5374988a6f12872d5078af57c76c978d45208f0829a962b1d41d79f9ef1c824740eb
-  data.tar.gz: 0d15e15c152b85765a3dca6c96dbe28787e780a15b68c505cf4dfd6d0c4e1b732c17c64275794733a096790999e3a0d59be32ba9e48a8c7d374c5fd1b4c6e33b
+  metadata.gz: acc437009c5508649e436e6bf4bc7d12fedf2d6996c69d8a6e26608c62f84adf70507a37b9ac1ff58f765e676fe3ab005d5305dc9793147d1dc4e98b3f23cf36
+  data.tar.gz: 16136c16315f64400870154db95092ade08d595f8c916f145df33c887b27b8fb89bcb91408c621a7fe7a0b9982f74e28fd66fc90afe7c7589f37d1f7d8c651e5

data/README.md

@@ -91,7 +91,7 @@ Materialist.configure do |config|
 end
 ```
 
-- `topics` (only when using in `.subscribe`): A string array of topics to be used.  
+- `topics` (only when using in `.subscribe`): A string array of topics to be used.
 If not provided nothing would be materialized.
 - `sidekiq_options` (optional, default: `{ retry: 10 }`) -- See [Sidekiq docs](https://github.com/mperham/sidekiq/wiki/Advanced-Options#workers) for list of options
 - `api_client` (optional) -- You can pass your `Routemaster::APIClient` instance
@@ -243,6 +243,24 @@ class ZoneMaterializer
 end
 ```
 
+#### `before_upsert_with_payload <method> (, <method>(, ...))`
+describes the name of the instance method(s) to be invoked before a record is
+materialized, with the record as it exists in the database, or nil if it has
+not been created yet. The function will get as a second argument the `payload`
+of the HTTP response, this can be used to add additional information/persist
+other objects.
+
+
+```ruby
+class ZoneMaterializer
+  include Materialist::Materializer
+
+  before_upsert_with_payload :my_method
+
+  def my_method(record, payload); end
+end
+```
+
 
 #### `after_upsert <method> (, <method>(, ...))` -- also `after_destroy`
 describes the name of the instance method(s) to be invoked after a record was materialized, with the updated record as a parameter. See above for a similar example implementation.

data/lib/materialist/materializer/internals/dsl.rb

@@ -43,6 +43,15 @@ module Materialist
           __materialist_options[:url_parser] = url_parser_block
         end
 
+        # This method is meant to be used for cases when the application needs
+        # to have access to the `payload` that is returned on the HTTP call.
+        # Such an example would be if the application logic requires all
+        # relationships to be present before the `resource` is saved in the
+        # database. Introduced in https://github.com/deliveroo/materialist/pull/47
+        def before_upsert_with_payload(*method_array)
+          __materialist_options[:before_upsert_with_payload] = method_array
+        end
+
         def before_upsert(*method_array)
           __materialist_options[:before_upsert] = method_array
         end

data/lib/materialist/materializer/internals/materializer.rb

@@ -61,6 +61,7 @@ module Materialist
         def upsert_record
           model_class.find_or_initialize_by(source_lookup(url)).tap do |entity|
             send_messages(before_upsert, entity) unless before_upsert.nil?
+            before_upsert_with_payload&.each { |m| instance.send(m, entity, resource) }
             entity.update_attributes!(attributes)
           end
         end
@@ -74,7 +75,6 @@ module Materialist
           return unless link = resource.dig(:_links, key)
           return unless materializer_class = MaterializerFactory.class_from_topic(opts.fetch(:topic))
 
-          # TODO: perhaps consider doing this asynchronously some how?
           materializer_class.perform(link[:href], :noop)
         end
 
@@ -86,6 +86,10 @@ module Materialist
           options[:before_upsert]
         end
 
+        def before_upsert_with_payload
+          options[:before_upsert_with_payload]
+        end
+
         def after_upsert
           options[:after_upsert]
         end

data/lib/materialist/version.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '3.6.0'
+  VERSION = '3.7.0'
 end

data/materialist.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w(lib)
 
   spec.add_runtime_dependency 'sidekiq', '>= 5.0'
-  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'activesupport', '< 6.0'
   spec.add_runtime_dependency 'routemaster-drain', '>= 3.0'
 
   spec.add_development_dependency 'activerecord'

data/spec/materialist/materializer_spec.rb

@@ -199,8 +199,13 @@ RSpec.describe Materialist::Materializer::Internals::Materializer do
 
           persist_to :foobar
           before_upsert :before_hook
+          before_upsert_with_payload :before_hook_with_payload
           after_upsert :after_hook
 
+          def before_hook_with_payload(entity, payload)
+            self.actions_called[:before_hook_with_payload] = true
+          end
+
           def before_hook(entity); self.actions_called[:before_hook] = true; end
           def after_hook(entity); self.actions_called[:after_hook] = true; end
         end
@@ -209,6 +214,11 @@ RSpec.describe Materialist::Materializer::Internals::Materializer do
       %i(create update noop).each do |action_name|
         context "when action is :#{action_name}" do
           let(:action) { action_name }
+
+          it "calls before_upsert_with_payload method" do
+            expect{ perform }.to change { actions_called[:before_hook_with_payload] }
+          end
+
           it "calls before_upsert method" do
             expect{ perform }.to change { actions_called[:before_hook] }
           end
@@ -225,8 +235,16 @@ RSpec.describe Materialist::Materializer::Internals::Materializer do
 
                 persist_to :foobar
                 before_upsert :before_hook, :before_hook2
+                before_upsert_with_payload :before_hook_with_payload, :before_hook_with_payload2
                 after_upsert :after_hook, :after_hook2
 
+                def before_hook_with_payload(entity, payload)
+                  self.actions_called[:before_hook_with_payload] = true
+                end
+                def before_hook_with_payload2(entity, payload)
+                  self.actions_called[:before_hook_with_payload2] = true
+                end
+
                 def before_hook(entity); self.actions_called[:before_hook] = true; end
                 def before_hook2(entity); self.actions_called[:before_hook2] = true; end
                 def after_hook(entity); self.actions_called[:after_hook] = true; end
@@ -239,6 +257,8 @@ RSpec.describe Materialist::Materializer::Internals::Materializer do
                                .and change { actions_called[:before_hook2] }
                                .and change { actions_called[:after_hook] }
                                .and change { actions_called[:after_hook2] }
+                               .and change { actions_called[:before_hook_with_payload] }
+                               .and change { actions_called[:before_hook_with_payload2] }
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Mo Valipour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -28,16 +28,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: routemaster-drain
   requirement: !ruby/object:Gem::Requirement
@@ -247,8 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Utilities to materialize routemaster topics