materialist 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a241994e95f26afa7c395df4780b3ff7a2b0dc3063498e97a73f5a36ecb008
-  data.tar.gz: 014d469aec8cffe93f23d8aafb3036a8d4dab62c95c12f400bad372e4a9fb438
+  metadata.gz: 3cef103c710bdfcf4b9a5ee36bad6b4474bc88c194a436bb935aa15b090a69f0
+  data.tar.gz: f91fcd7467e60889d34ed33ed57c08ac67a6365a4168d5c52e7dd8564f2ec331
 SHA512:
-  metadata.gz: acc437009c5508649e436e6bf4bc7d12fedf2d6996c69d8a6e26608c62f84adf70507a37b9ac1ff58f765e676fe3ab005d5305dc9793147d1dc4e98b3f23cf36
-  data.tar.gz: 16136c16315f64400870154db95092ade08d595f8c916f145df33c887b27b8fb89bcb91408c621a7fe7a0b9982f74e28fd66fc90afe7c7589f37d1f7d8c651e5
+  metadata.gz: cc547ca1823460c517b5b1a8720e3259004bcbf1f8b92c91847d90d9ea6638af4ffb39d2f7a50994fc8070b997b1fb61b69a12ae49e2009125c61af4e2a5ac26
+  data.tar.gz: dd6b84e5541132b052bce821853348a62a0fd6608837f7d141b2bb472a6c32eb0fb01211ad07837c093ed62da9b55788a720034f1d398aef9e9eda7ba0b09d1a

data/README.md

@@ -155,8 +155,8 @@ class ZoneMaterializer
 
   persist_to :zone
 
-  source_key :source_id do |url|
-    /(\d+)\/?$/.match(url)[1]
+  source_key :source_id do |url, response|
+    /(\d+)\/?$/.match(url)[1] # or response.dig(:some_attr)
   end
 
   capture :id, as: :orderweb_id
@@ -189,10 +189,10 @@ describes the name of the active record model to be used.
 If missing, materialist skips materialising the resource itself, but will continue
 with any other functionality -- such as `materialize_link`.
 
-#### `source_key <column> <url_parser_block> (default: url)`
+#### `source_key <column> <parser_block> (default: url, resource response body[create, update action only])`
 describes the column used to persist the unique identifier parsed from the url_parser_block.
 By default the column used is `:source_url` and the original `url` is used as the identifier.
-Passing an optional block allows you to extract an identifier from the URL.
+Passing an optional block allows you to extract an identifier from the URL and captured attributes.
 
 #### `capture <key>, as: <column> (default: key)`
 describes mapping a resource key to a database column.

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

@@ -38,9 +38,9 @@ module Materialist
           __materialist_options[:sidekiq_options] = options
         end
 
-        def source_key(key, &url_parser_block)
+        def source_key(key, &source_key_parser)
           __materialist_options[:source_key] = key
-          __materialist_options[:url_parser] = url_parser_block
+          __materialist_options[:source_key_parser] = source_key_parser
         end
 
         # This method is meant to be used for cases when the application needs

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

@@ -59,7 +59,7 @@ module Materialist
         end
 
         def upsert_record
-          model_class.find_or_initialize_by(source_lookup(url)).tap do |entity|
+          model_class.find_or_initialize_by(source_lookup(url, resource)).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)
@@ -110,12 +110,12 @@ module Materialist
           options.fetch(:source_key, :source_url)
         end
 
-        def url_parser
-          options[:url_parser] || ->url { url }
+        def source_key_parser
+          options[:source_key_parser] || ->(url, data) { url }
         end
 
-        def source_lookup(url)
-          @_source_lookup ||= { source_key => url_parser.call(url) }
+        def source_lookup(url, resource={})
+          @_source_lookup ||= { source_key => source_key_parser.call(url, resource) }
         end
 
         def attributes

data/lib/materialist/version.rb

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

data/spec/materialist/materializer_spec.rb

@@ -50,7 +50,7 @@ RSpec.describe Materialist::Materializer::Internals::Materializer do
     let(:source_body) {{ _links: { city: { href: city_url }}, name: 'jack', age: 30 }}
     let(:defined_source_id) { 65 }
     let(:defined_source_url) { "https://service.dev/defined_sources/#{defined_source_id}" }
-    let(:defined_source_body) {{ name: 'ben' }}
+    let(:defined_source_body) {{ name: 'ben', id: defined_source_id }}
 
     def stub_resource(url, body)
       stub_request(:get, url).to_return(
@@ -380,62 +380,87 @@ RSpec.describe Materialist::Materializer::Internals::Materializer do
     end
 
     context "entity based on the source_key column" do
-      subject do
-        Class.new do
-          include Materialist::Materializer
+      shared_examples 'an upsert materialization event' do
+        context "when creating" do
+          let(:perform) { subject.perform(defined_source_url, action) }
 
-          persist_to :defined_source
-
-          source_key :source_id do |url|
-            url.split('/').last.to_i
+          it "creates based on source_key" do
+            expect{perform}.to change{DefinedSource.count}.by 1
           end
 
-          capture :name
+          it "sets the correct source key" do
+            perform
+            inserted = DefinedSource.find_by(source_id: defined_source_id)
+            expect(inserted.source_id).to eq defined_source_id
+            expect(inserted.name).to eq defined_source_body[:name]
+          end
         end
-      end
 
-      context "when creating" do
-        let(:perform) { subject.perform(defined_source_url, action) }
+        context "when updating" do
+          let(:action) { :update }
+          let!(:record) { DefinedSource.create!(source_id: defined_source_id, name: 'mo') }
+          let(:perform) { subject.perform(defined_source_url, action) }
 
-        it "creates based on source_key" do
-          expect{perform}.to change{DefinedSource.count}.by 1
-        end
+          it "updates based on source_key" do
+            perform
+            expect(DefinedSource.count).to eq 1
+          end
 
-        it "sets the correct source key" do
-          perform
-          inserted = DefinedSource.find_by(source_id: defined_source_id)
-          expect(inserted.source_id).to eq defined_source_id
-          expect(inserted.name).to eq defined_source_body[:name]
+          it "updates the existing record" do
+            perform
+            inserted = DefinedSource.find_by(source_id: defined_source_id)
+            expect(inserted.source_id).to eq defined_source_id
+            expect(inserted.name).to eq defined_source_body[:name]
+          end
         end
       end
 
-      context "when updating" do
-        let(:action) { :update }
-        let!(:record) { DefinedSource.create!(source_id: defined_source_id, name: 'mo') }
-        let(:perform) { subject.perform(defined_source_url, action) }
+      context 'with url source key parser' do
+        subject do
+          Class.new do
+            include Materialist::Materializer
+
+            persist_to :defined_source
+
+            source_key :source_id do |url|
+              url.split('/').last.to_i
+            end
 
-        it "updates based on source_key" do
-          perform
-          expect(DefinedSource.count).to eq 1
+            capture :name
+          end
         end
 
-        it "updates the existing record" do
-          perform
-          inserted = DefinedSource.find_by(source_id: defined_source_id)
-          expect(inserted.source_id).to eq defined_source_id
-          expect(inserted.name).to eq defined_source_body[:name]
+        context "when deleting" do
+          let(:action) { :delete }
+          let!(:record) { DefinedSource.create!(source_id: defined_source_id, name: 'mo') }
+          let(:perform) { subject.perform(defined_source_url, action) }
+
+          it "deletes based on source_key" do
+            perform
+            expect(DefinedSource.count).to eq 0
+          end
         end
+
+        it_behaves_like 'an upsert materialization event'
       end
 
-      context "when deleting" do
-        let(:action) { :delete }
-        let!(:record) { DefinedSource.create!(source_id: defined_source_id, name: 'mo') }
-        let(:perform) { subject.perform(defined_source_url, action) }
+      context 'with resource source key parser' do
+        subject do
+          Class.new do
+            include Materialist::Materializer
 
-        it "deletes based on source_key" do
-          perform
-          expect(DefinedSource.count).to eq 0
+            persist_to :defined_source
+
+            source_key :source_id do |_, resource|
+              resource.dig(:id)
+            end
+
+            capture :name
+            capture :id
+          end
         end
+
+        it_behaves_like 'an upsert materialization event'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Mo Valipour
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -178,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - valipour@gmail.com
 executables: []
@@ -232,7 +232,7 @@ homepage: http://github.com/deliveroo/materialist
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -247,8 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Utilities to materialize routemaster topics
 test_files: