materialist 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52edad7b633726d80df5bf86cb2190a0f68b6094
-  data.tar.gz: 2db6abb9165052f9a564751c49ea3c9c6f7c7a34
+  metadata.gz: d2acc5e6e25f3d5fb77c44a7c6dc465442b307b4
+  data.tar.gz: 155b6c787990989d49e59eb83190ad9adeb592f0
 SHA512:
-  metadata.gz: 8ae7bb5132903ff79355624196fdb2e0e087534b29ab7c76734ce014b65959701b414539ce937f0cbe787c4335119778a622a76cf5f0f15599279675e97aefb1
-  data.tar.gz: 404ed0434c32eaf7c7353771f05cdf3c907214d7fec93503227eb359beb37ca4bd6ad1e29d140c427e797d186df04f6e798c58a665f50c9743e57ae06877b722
+  metadata.gz: c65249eadde28bed09a39c7114569a5d420f6f356b139b135913db8b84e732751d65aa3e27e12e8706f44d25c8af67fef0c3afc344e03a0f941911873f46ae2f
+  data.tar.gz: '0296ac0b29e449b14259be7f175898172f5fb8e65785f8e6cb082a95365d24dd969d26a2e4747df77a9e253db0c3a7149e9fd95a7c747a0b3cf60ee50d137cd8'

data/README.md

@@ -118,6 +118,10 @@ class ZoneMaterializer
 
   persist_to :zone
 
+  source_key :source_id do |url|
+    /(\d+)\/?$/.match(url)[1]
+  end
+
   capture :id, as: :orderweb_id
   capture :code
   capture :name
@@ -142,6 +146,12 @@ 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)`
+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.
+
 #### `capture <key>, as: <column> (default: key)`
 describes mapping a resource key to a database column.
 
@@ -169,7 +179,7 @@ class ZoneMaterializer
 
   def my_method(record)
   end
-  
+
   def my_second_method(record)
   end
 end

data/lib/materialist/materializer.rb

@@ -80,6 +80,11 @@ module Materialist
           __materialist_options[:model_class] = klass
         end
 
+        def source_key(key, &url_parser_block)
+          __materialist_options[:source_key] = key
+          __materialist_options[:url_parser] = url_parser_block
+        end
+
         def after_upsert(*method_array)
           __materialist_options[:after_upsert] = method_array
         end
@@ -120,7 +125,7 @@ module Materialist
 
         def destroy
           return unless materialize_self?
-          model_class.find_by(source_url: url).tap do |entity|
+          model_class.find_by(source_lookup(url)).tap do |entity|
             entity.destroy!.tap do |entity|
               send_messages(after_destroy, entity) unless after_destroy.nil?
             end if entity
@@ -136,7 +141,7 @@ module Materialist
         end
 
         def upsert_record
-          model_class.find_or_initialize_by(source_url: url).tap do |entity|
+          model_class.find_or_initialize_by(source_lookup(url)).tap do |entity|
             entity.update_attributes attributes
             entity.save!
           end
@@ -176,6 +181,18 @@ module Materialist
           options.fetch(:model_class).to_s.camelize.constantize
         end
 
+        def source_key
+          options.fetch(:source_key, :source_url)
+        end
+
+        def url_parser
+          options[:url_parser] || ->url { url }
+        end
+
+        def source_lookup(url)
+          @_source_lookup ||= { source_key => url_parser.call(url) }
+        end
+
         def attributes
           build_attributes root_resource, mapping
         end

data/lib/materialist.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/materialist/materializer_spec.rb

@@ -11,6 +11,7 @@ RSpec.describe Materialist::Materializer do
         include Materialist::Materializer
 
         persist_to :foobar
+
         capture :name
         capture :age, as: :how_old
         capture_link_href :city, as: :city_url
@@ -31,6 +32,19 @@ RSpec.describe Materialist::Materializer do
         include Materialist::Materializer
 
         persist_to :city
+        source_key :source_url
+        capture :name
+      end
+
+      class DefinedSourceMaterializer
+        include Materialist::Materializer
+
+        persist_to :defined_source
+
+        source_key :source_id do |url|
+          url.split('/').last.to_i
+        end
+
         capture :name
       end
     end
@@ -42,37 +56,49 @@ RSpec.describe Materialist::Materializer do
       end
 
       def save!
-        self.class.all[source_url] = self
+        self.class.all[source_key_value] = self
       end
 
       def destroy!
-        self.class.all.delete source_url
+        self.class.all.delete source_key_value
       end
 
       def reload
-        self.class.all[source_url]
+        self.class.all[source_key_value]
       end
 
       def actions_called
         @_actions_called ||= {}
       end
 
+      private def source_key_value
+        send(self.class.source_key_column)
+      end
+
       class << self
-        attr_accessor :error_to_throw_once_in_find_or_initialize_by
+        attr_accessor :error_to_throw_once_in_find_or_initialize_by,
+                      :source_key_column
 
-        def find_or_initialize_by(source_url:)
+        def find_or_initialize_by(kv_hash)
           if(err = error_to_throw_once_in_find_or_initialize_by)
             self.error_to_throw_once_in_find_or_initialize_by = nil
             raise err
           end
 
-          (all[source_url] || self.new).tap do |record|
-            record.source_url = source_url
+          key_value = kv_hash[source_key_column]
+
+          (all[key_value] || self.new).tap do |record|
+            record.send("#{source_key_column}=", key_value)
           end
         end
 
-        def find_by(source_url:)
-          all[source_url]
+        def source_key_column
+          @source_key_column || :source_url
+        end
+
+        def find_by(kv_hash)
+          key_value = kv_hash[source_key_column]
+          all[key_value]
         end
 
         def create!(attrs)
@@ -109,6 +135,11 @@ RSpec.describe Materialist::Materializer do
       attr_accessor :source_url, :name
     end
 
+    class DefinedSource < BaseModel
+      attr_accessor :source_id, :name
+      self.source_key_column = :source_id
+    end
+
     module ActiveRecord
       class RecordNotUnique < StandardError; end
       class RecordInvalid < StandardError; end
@@ -120,6 +151,9 @@ RSpec.describe Materialist::Materializer do
     let(:city_body) {{ _links: { country: { href: country_url }}, name: 'paris', timezone: 'Europe/Paris' }}
     let(:source_url) { 'https://service.dev/foobars/1' }
     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' }}
 
     def stub_resource(url, body)
       stub_request(:get, url).to_return(
@@ -132,10 +166,12 @@ RSpec.describe Materialist::Materializer do
     before do
       Foobar.destroy_all
       City.destroy_all
+      DefinedSource.destroy_all
 
       stub_resource source_url, source_body
       stub_resource country_url, country_body
       stub_resource city_url, city_body
+      stub_resource defined_source_url, defined_source_body
     end
 
     let(:action) { :create }
@@ -362,5 +398,49 @@ RSpec.describe Materialist::Materializer do
         end
       end
     end
+
+    context "when creating a new entity based on the source_key column" do
+      let(:perform) { DefinedSourceMaterializer.perform(defined_source_url, action) }
+
+      it "creates based on source_key" do
+        expect{perform}.to change{DefinedSource.count}.by 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]
+      end
+    end
+
+    context "when updating a new entity based on the source_key column" do
+      let(:action) { :update }
+      let!(:record) { DefinedSource.create!(source_id: defined_source_id, name: 'mo') }
+      let(:perform) { DefinedSourceMaterializer.perform(defined_source_url, action) }
+
+      it "updates based on source_key" do
+        perform
+        expect(DefinedSource.count).to eq 1
+      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]
+      end
+    end
+
+    context "when deleting an entity based on the source_key column" do
+      let(:action) { :delete }
+      let!(:record) { DefinedSource.create!(source_id: defined_source_id, name: 'mo') }
+      let(:perform) { DefinedSourceMaterializer.perform(defined_source_url, action) }
+
+      it "deletes based on source_key" do
+        perform
+        expect(DefinedSource.count).to eq 0
+      end
+    end
   end
 end

metadata

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