materialist 3.7.0 → 3.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a241994e95f26afa7c395df4780b3ff7a2b0dc3063498e97a73f5a36ecb008
-  data.tar.gz: 014d469aec8cffe93f23d8aafb3036a8d4dab62c95c12f400bad372e4a9fb438
+  metadata.gz: dd1ef7f5805827d74ef21e82711656a04d402a7b8e5e03a636538aced1e6f491
+  data.tar.gz: cf0e8a01fbdc6751f9eadb59307fc46cba53bb4ca04f562fe2c51531a893e051
 SHA512:
-  metadata.gz: acc437009c5508649e436e6bf4bc7d12fedf2d6996c69d8a6e26608c62f84adf70507a37b9ac1ff58f765e676fe3ab005d5305dc9793147d1dc4e98b3f23cf36
-  data.tar.gz: 16136c16315f64400870154db95092ade08d595f8c916f145df33c887b27b8fb89bcb91408c621a7fe7a0b9982f74e28fd66fc90afe7c7589f37d1f7d8c651e5
+  metadata.gz: de64d93e429085b0aefe268c346c42a56c669507e867f1b40ab7d0f7f6ddcf4b63023391e7468b8fac472304a1959e5eb0b0a8fda4c00c3ed26395a13f08195b
+  data.tar.gz: b593a01f94002824f1068dc36873ff1ae364d2b2a8147116ee97ecb5c408faf7202c60add6886e1ca5b35fc496c5b04cc32e16e43dc7d2766b3a53bec1594382

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/RELEASE_NOTES.md

@@ -1,6 +1,13 @@
 ## Next
 
 _list pending release notes here..._
+## 3.8.2
+
+- Fix Rails 6 deprecation warning for `update_attributes!`
+
+## 3.8.1
+
+- ActiveSupport >= 6
 
 ## 3.6.0
 

data/lib/configuration.rb

@@ -1,5 +1,3 @@
-require 'routemaster/api_client'
-
 module Materialist
   class << self
     def configuration
@@ -21,11 +19,14 @@ module Materialist
     def initialize
       @topics = []
       @sidekiq_options = {}
-      @api_client = Routemaster::APIClient.new(response_class: ::Routemaster::Responses::HateoasResponse)
       @metrics_client = NullMetricsClient
       @notice_error = nil
     end
 
+    def api_client
+      @api_client || (raise StandardError.new('missing HTTP client'))
+    end
+
     class NullMetricsClient
       def self.increment(_, tags:); end
       def self.histogram(_, _v, tags:); end

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,10 +59,10 @@ 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)
+            entity.update!(attributes)
           end
         end
 
@@ -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.3'
 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', '< 6.0'
+  spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'routemaster-drain', '>= 3.0'
 
   spec.add_development_dependency 'activerecord'

data/spec/materialist/materialized_record_spec.rb

@@ -29,6 +29,9 @@ RSpec.describe Materialist::MaterializedRecord do
   let(:source_url) { 'https://service.dev/foobars/1' }
   let(:source_body) {{ _links: { city: { href: city_url }}, name: 'jack', age: 30 }}
   before do
+    Materialist.configure do |c|
+      c.api_client = Routemaster::APIClient.new(response_class: ::Routemaster::Responses::HateoasResponse)
+    end
     stub_request(:get, source_url).to_return(
       status: 200,
       body: source_body.to_json,

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(
@@ -63,6 +63,9 @@ RSpec.describe Materialist::Materializer::Internals::Materializer do
     let!(:source_stub) { stub_resource source_url, source_body }
 
     before do
+      Materialist.configure do |c|
+        c.api_client = Routemaster::APIClient.new(response_class: ::Routemaster::Responses::HateoasResponse)
+      end
       stub_resource country_url, country_body
       stub_resource city_url, city_body
       stub_resource defined_source_url, defined_source_body
@@ -380,62 +383,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
-
-          persist_to :defined_source
+      shared_examples 'an upsert materialization event' do
+        context "when creating" do
+          let(:perform) { subject.perform(defined_source_url, action) }
 
-          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
 
-        it "updates based on source_key" do
-          perform
-          expect(DefinedSource.count).to eq 1
+            source_key :source_id do |url|
+              url.split('/').last.to_i
+            end
+
+            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

data/spec/materialist/workers/event_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'materialist/workers/event'
+require 'routemaster/api_client'
 
 RSpec.describe Materialist::Workers::Event do
   describe "#perform" do
@@ -10,7 +11,10 @@ RSpec.describe Materialist::Workers::Event do
 
     before do
       allow(FoobarMaterializer).to receive(:perform)
-      Materialist.configure { |c| c.metrics_client = metrics_client }
+      Materialist.configure do |c|
+        c.metrics_client = metrics_client
+        c.api_client = Routemaster::APIClient.new(response_class: ::Routemaster::Responses::HateoasResponse)
+      end
     end
 
     after { Object.send(:remove_const, :FoobarMaterializer) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.3
 platform: ruby
 authors:
 - Mo Valipour
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2021-11-16 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: '6.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: routemaster-drain
   requirement: !ruby/object:Gem::Requirement
@@ -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: