materialist 3.5.0 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad5a7f5ef0961f9e8cf3317baaf07cbb53d8e021
-  data.tar.gz: 394077c4817dd29106c78f02124f6c145ab6dafd
+SHA256:
+  metadata.gz: a087fb6cf53741a69d823d1ba2e6c95213584bd7c32e608b997f7a18cfbd04de
+  data.tar.gz: 4ed4006703f538a5bf28b09c9a88818a274fc3d0de0c41a8c48222f2463a0960
 SHA512:
-  metadata.gz: 1fc7dd6e7563ec9205631a5f8520c6928b8ca10c269c3c8f74cb2093080e500878b8a5220ae5fabab1a985090d8f66ffcd55dac2fdaed4253a6de679601ade13
-  data.tar.gz: 4d293933436137b9daf41d3de5117eeb707653d0ce73f7865356d5fe1bfad6b8354a4073ae1ecfeec3adae7ad1c4b7ad38a2713f6668ca7a7b9d77e956e1fcfa
+  metadata.gz: 68164c5054c6fb24c21b05740eb4e252b51d9140da4f41338b20f4c9f7fa795057648ef1c97c9fdc8712828e705ed40d066021518c3510c8f15955f7cb93b025
+  data.tar.gz: 3a06570c0102381dd6415784cfada797bc2e9434a69b91df10549ade261f1286bc5caab3cdb47c323a11361a884914536a7704dbd3adbbe5ae671e7bc27e287d

data/README.md

@@ -25,6 +25,20 @@ Then do
 bundle
 ```
 
+### Release
+
+After merging all of your PRs:
+
+1. Bump the version in `lib/materialist/version.rb` -- let's say `x.y.z`
+1. Build the gem: `gem build materialist.gemspec`
+1. Push the gem: `gem push materialist-x.y.z.gem`
+1. Commit changes: `git commit -am "Bump version"`
+1. Create a tag: `git tag -a vx.y.z`
+1. Push changes: `git push origin master`
+1. Push the new: `git push origin --tags`
+
+## Usage
+
 ### Entity
 
 Your materialised entity need to have a **unique** `source_url` column, alongside any other field you wish to materialise.
@@ -77,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
@@ -141,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
@@ -175,14 +189,20 @@ 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.
 
+You can optionally provide a block for parsing the value:
+
+```ruby
+capture(:location, as: :latitude) { |location| location[:latitude] }
+```
+
 #### `capture_link_href <key>, as: <column>`
 describes mapping a link href (as it appears on the hateous response) to a database column.
 
@@ -223,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/RELEASE_NOTES.md

@@ -1,6 +1,13 @@
 ## Next
 
-_description of next release_
+_list pending release notes here..._
+## 3.8.1
+
+- ActiveSupport >= 6
+
+## 3.6.0
+
+- Add support for parsing value when using `capture`
 
 ## 3.5.0
 

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

@@ -6,8 +6,12 @@ module Materialist
           __materialist_options[:links_to_materialize][key] = { topic: topic }
         end
 
-        def capture(key, as: key)
-          __materialist_dsl_mapping_stack.last << FieldMapping.new(key: key, as: as)
+        def capture(key, as: key, &value_parser_block)
+          __materialist_dsl_mapping_stack.last << FieldMapping.new(
+            key: key,
+            as: as,
+            value_parser: value_parser_block
+          )
         end
 
         def capture_link_href(key, as:, &url_parser_block)
@@ -34,9 +38,18 @@ 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
+        # 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)

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

@@ -2,13 +2,14 @@ module Materialist
   module Materializer
     module Internals
       class FieldMapping
-        def initialize(key:, as: key)
+        def initialize(key:, as: key, value_parser: nil)
           @key = key
           @as = as
+          @value_parser = value_parser || ->value { value }
         end
 
         def map(resource)
-          { @as => resource.dig(@key) }
+          { @as => @value_parser.call(resource.dig(@key)) }
         end
       end
     end

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

@@ -59,8 +59,9 @@ 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)
           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
@@ -106,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.5.0'
+  VERSION = '3.8.1'
 end

data/spec/materialist/materializer/internals/field_mapping_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'materialist/materializer/internals'
+
+include Materialist::Materializer::Internals
+
+RSpec.describe Materialist::Materializer::Internals::FieldMapping, type: :internals do
+  let(:instance) { described_class.new(key: key, as: as, value_parser: value_parser_block) }
+
+  describe '#map' do
+    let(:key) { :b }
+    let(:as) { :z }
+    let(:value_parser_block) { nil }
+    let(:resource) do
+      {
+        a: 1,
+        b: {
+          c: 2
+        }
+      }
+    end
+    let(:map) { instance.map(resource) }
+
+    context 'when no parse block is passed' do
+      let(:expected_result) { { z: { c: 2 } } }
+
+      it { expect(map).to eq(expected_result) }
+    end
+
+    context 'when a value parse block is passed' do
+      let(:value_parser_block) { ->value { value[:c] } }
+      let(:expected_result) { { z: 2 } }
+
+      it { expect(map).to eq(expected_result) }
+    end
+  end
+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(
@@ -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
@@ -360,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.5.0
+  version: 3.8.1
 platform: ruby
 authors:
 - Mo Valipour
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2021-11-08 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: []
@@ -219,6 +219,7 @@ files:
 - materialist.gemspec
 - spec/materialist/event_handler_spec.rb
 - spec/materialist/materialized_record_spec.rb
+- spec/materialist/materializer/internals/field_mapping_spec.rb
 - spec/materialist/materializer/internals/link_mapping_spec.rb
 - spec/materialist/materializer_factory_spec.rb
 - spec/materialist/materializer_spec.rb
@@ -231,7 +232,7 @@ homepage: http://github.com/deliveroo/materialist
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,14 +247,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Utilities to materialize routemaster topics
 test_files:
 - spec/materialist/event_handler_spec.rb
 - spec/materialist/materialized_record_spec.rb
+- spec/materialist/materializer/internals/field_mapping_spec.rb
 - spec/materialist/materializer/internals/link_mapping_spec.rb
 - spec/materialist/materializer_factory_spec.rb
 - spec/materialist/materializer_spec.rb