materialist 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f32f9a147b1122264cdef5eb29571ef0080c064c
-  data.tar.gz: 8b1dee6b091fa976459723bf8adf096098d0e0fe
+  metadata.gz: 742d36bce66476aa11b5a36399c4fcdb7b6d4b48
+  data.tar.gz: 8f22cc1e86242ca63fd87145d5cbbd57b56f889c
 SHA512:
-  metadata.gz: a9c94a53752b839970d4293870ab7de99bda93019e1df6e1320c574771173188d31fe27d801d0f3b0dffdce98a80f047bd1be311dde849759166e59a62226467
-  data.tar.gz: 1204895096c3f37b369bac5219d6808b174acf0054cf7e32a66a4030d05d3d2b8b52d296d779445fb42babf3f26fdf438cffb2a27474e34afa3b4635afaeb48c
+  metadata.gz: 37148508f6fb84debd7e0975462164ba71f98855299fb8d9aa9f09eef7aba38dd21d5ddacf10bfbbb9496eb51204860f30ced33127c727c11e1c152c9d14ad8a
+  data.tar.gz: 4930c84c558fcb9d5fcc89353d4f4098d39958cbbe25bc4e811a9e1c9e3cc7b4f75143185f2d81246fd4417f6fdbd9f110f35aa228f92b731cd010586253fed7

data/README.md

@@ -169,14 +169,14 @@ describes materializing the linked entity.
 This simulates a `:noop` event on the given topic and the `url` of the
 liked resource `<key>` as it appears on the response (`_links`) -- meaning the materializer for the given topic will be invoked.
 
-#### `after_upsert <method> (, <method>(, ...))` -- also `after_destroy`
-describes the name of the instance method(s) to be invoked after a record was materialized.
+#### `before_upsert <method> (, <method>(, ...))` -- also `before_destroy`
+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.
 
 ```ruby
 class ZoneMaterializer
   include Materialist::Materializer
 
-  after_upsert :my_method, :my_second_method
+  before_upsert :my_method, :my_second_method
 
   def my_method(record)
   end
@@ -186,6 +186,11 @@ class ZoneMaterializer
 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.
+
+
 ### Materialized record
 
 Imagine you have materialized rider from a routemaster topic and you need to access a key from the remote source that you HAVEN'T materialized locally.

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## 2.3.0
+
+Features:
+ - Add `before_upsert` and `before_destroy` (#31)
+
 ## 2.2.0
 
 Features:

data/lib/materialist/materializer.rb

@@ -85,6 +85,10 @@ module Materialist
           __materialist_options[:url_parser] = url_parser_block
         end
 
+        def before_upsert(*method_array)
+          __materialist_options[:before_upsert] = method_array
+        end
+
         def after_upsert(*method_array)
           __materialist_options[:after_upsert] = method_array
         end
@@ -92,6 +96,10 @@ module Materialist
         def after_destroy(*method_array)
           __materialist_options[:after_destroy] = method_array
         end
+
+        def before_destroy(*method_array)
+          __materialist_options[:before_destroy] = method_array
+        end
       end
 
       class Materializer
@@ -126,6 +134,7 @@ module Materialist
         def destroy
           return unless materialize_self?
           model_class.find_by(source_lookup(url)).tap do |entity|
+            send_messages(before_destroy, entity) unless before_destroy.nil?
             entity.destroy!.tap do |entity|
               send_messages(after_destroy, entity) unless after_destroy.nil?
             end if entity
@@ -142,6 +151,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?
             entity.update_attributes attributes
             entity.save!
           end
@@ -169,10 +179,18 @@ module Materialist
           options.fetch :mapping
         end
 
+        def before_upsert
+          options[:before_upsert]
+        end
+
         def after_upsert
           options[:after_upsert]
         end
 
+        def before_destroy
+          options[:before_destroy]
+        end
+
         def after_destroy
           options[:after_destroy]
         end

data/lib/materialist.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/spec/materialist/materializer_spec.rb

@@ -274,38 +274,54 @@ RSpec.describe Materialist::Materializer do
       end
     end
 
-    context "when after_upsert is configured" do
+    context "when {after, before}_upsert is configured" do
       let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
       let!(:materializer_class) do
         class FoobarMaterializer
           include Materialist::Materializer
 
           persist_to :foobar
+          before_upsert :my_before_method
           after_upsert :my_method
 
           def my_method(entity)
             entity.actions_called[:after_upsert] = true
           end
+
+          def my_before_method(entity)
+            entity.actions_called[:before_upsert] = true
+          end
         end
       end
 
       %i(create update noop).each do |action_name|
         context "when action is :#{action_name}" do
           let(:action) { action_name }
+          it "calls before_upsert method" do
+            expect{ perform }.to change { record.actions_called[:before_upsert] }
+          end
+
           it "calls after_upsert method" do
             expect{ perform }.to change { record.actions_called[:after_upsert] }
           end
 
-          it "calls more than one after_upsert method" do
+          it "calls more than one method" do
             class FoobarMaterializer
+              before_upsert :my_before_method, :my_before_method2
               after_upsert :my_method, :my_method2
 
               def my_method2(entity)
                 entity.actions_called[:after_upsert2] = true
               end
+
+              def my_before_method2(entity)
+                entity.actions_called[:before_upsert2] = true
+              end
             end
-            expect{ perform }.to  change { record.actions_called[:after_upsert]  }
-                             .and change { record.actions_called[:after_upsert2] }
+            expect{ perform }.to  change { record.actions_called[:after_upsert]   }
+                             .and change { record.actions_called[:after_upsert2]  }
+                             .and change { record.actions_called[:before_upsert]  }
+                             .and change { record.actions_called[:before_upsert2] }
           end
         end
       end
@@ -316,22 +332,31 @@ RSpec.describe Materialist::Materializer do
         it "does not call after_upsert method" do
           expect{ perform }.to_not change { record.actions_called[:after_upsert] }
         end
+
+        it "does call after_upsert method" do
+          expect{ perform }.to_not change { record.actions_called[:before_upsert] }
+        end
       end
 
     end
 
-    context "when after_destroy is configured" do
+    context "when {before, after}_destroy is configured" do
       let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
       let!(:materializer_class) do
         class FoobarMaterializer
           include Materialist::Materializer
 
           persist_to :foobar
+          before_destroy :my_before_method
           after_destroy :my_method
 
           def my_method(entity)
             entity.actions_called[:after_destroy] = true
           end
+
+          def my_before_method(entity)
+            entity.actions_called[:before_destroy] = true unless entity.nil?
+          end
         end
       end
 
@@ -341,6 +366,10 @@ RSpec.describe Materialist::Materializer do
           it "does not call after_destroy method" do
             expect{ perform }.to_not change { record.actions_called[:after_destroy] }
           end
+
+          it "does not call before_destroy method" do
+            expect{ perform }.to_not change { record.actions_called[:before_destroy] }
+          end
         end
       end
 
@@ -351,16 +380,27 @@ RSpec.describe Materialist::Materializer do
           expect{ perform }.to change { record.actions_called[:after_destroy] }
         end
 
-        it "calls more than one after_destroy method" do
+        it "calls before_destroy method" do
+          expect{ perform }.to change { record.actions_called[:before_destroy] }
+        end
+
+        it "calls more than one method" do
           class FoobarMaterializer
+            before_destroy :my_before_method, :my_before_method2
             after_destroy :my_method, :my_method2
 
             def my_method2(entity)
               entity.actions_called[:after_destroy2] = true
             end
+
+            def my_before_method2(entity)
+              entity.actions_called[:before_destroy2] = true unless entity.nil?
+            end
           end
-          expect{ perform }.to change  { record.actions_called[:after_destroy]  }
-                           .and change { record.actions_called[:after_destroy2] }
+          expect{ perform }.to change  { record.actions_called[:after_destroy]   }
+                           .and change { record.actions_called[:after_destroy2]  }
+                           .and change { record.actions_called[:before_destroy]  }
+                           .and change { record.actions_called[:before_destroy2] }
         end
 
         context "when resource doesn't exist locally" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Mo Valipour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq