materialist 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c6ac14f9290917ab258407ab5a9107b7c6d5dfd
-  data.tar.gz: 933bb41d482b11ada3dfa436a8f2ba884d729d38
+  metadata.gz: ddfdebe864838d6fdb912aee5d3002417aca969b
+  data.tar.gz: 13ebd4c0bad48a307820aaa28c81d674335da88c
 SHA512:
-  metadata.gz: 8348c3f30fb8202e7d714dab4ff995c3090f5a1cd401beebea3804d100ef917bc577aa9ec7d2c3be78181befb030e3c8b48f4fb6f71f622b1a8f1ba8f61b5787
-  data.tar.gz: 526c7ba494e18b1df3a1a19dbf47965f3960e622250dd64001ce4f72ca6abdc5e6414df49fb52ff948018774f69062a344fec4b886df20f565663a45e788bd78
+  metadata.gz: c082a2dfffdae443aaafb41d20f4a12da3203a90bbae0e4bd8075f77364fdc67d2386de3373572d1a0b6b46bbb93d0e7a1adca2df59777f15de7c9eb9fbf0d02
+  data.tar.gz: 80d88005986ec167b4d599085e9fcd424c37b4cab98baacc44a38deed1731e035c8acc8da118e0be286b17f5c2de1adf95ddd4a45253b43ba9648169b4f79113

data/README.md

@@ -116,31 +116,33 @@ require 'materialist/materializer'
 class ZoneMaterializer
   include Materialist::Materializer
 
-  use_model :zone
+  persist_to :zone
 
-  materialize :id, as: :orderweb_id
-  materialize :code
-  materialize :name
+  capture :id, as: :orderweb_id
+  capture :code
+  capture :name
 
   link :city do
-    materialize :tz_name, as: :timezone
+    capture :tz_name, as: :timezone
 
     link :country do
-      materialize :name, as: :country_name
-      materialize :iso_alpha2_code, as: :country_iso_alpha2_code
+      capture :name, as: :country_name
+      capture :iso_alpha2_code, as: :country_iso_alpha2_code
     end
   end
+
+  materialize_link :settings, topic: :zone_settings
 end
 ```
 
 Here is what each part of the DSL mean:
 
-#### `use_model <model_name>`
-describes the name of the active record model to be used.  
+#### `persist_to <model_name>`
+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`.
 
-#### `materialize <key>, as: <column> (default: key)`
+#### `capture <key>, as: <column> (default: key)`
 describes mapping a resource key to database column.
 
 #### `link <key>`
@@ -150,8 +152,8 @@ When inside the block of a `link` any other part of DSL can be used and will be
 
 ### `materialize_link <key>, topic: <topic> (default: key)`
 describes materializing the linked entity.
-This simulates a `:noop` event on the given topic and the `url` if the
-liked resource `<key>` as it appears on the response (`_links`)
+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>` -- also `after_destroy`
 describes the name of the instance method to be invoked after a record was materialized.

data/lib/materialist/materializer.rb

@@ -51,7 +51,7 @@ module Materialist
           __materialist_options[:links_to_materialize][key] = { topic: topic }
         end
 
-        def materialize(key, as: key)
+        def capture(key, as: key)
           __materialist_dsl_mapping_stack.last << FieldMapping.new(key: key, as: as)
         end
 
@@ -63,7 +63,7 @@ module Materialist
           __materialist_dsl_mapping_stack.pop
         end
 
-        def use_model(klass)
+        def persist_to(klass)
           __materialist_options[:model_class] = klass
         end
 

data/lib/materialist.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/materialist.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = %w(lib)
 
-  spec.add_runtime_dependency 'sidekiq'
+  spec.add_runtime_dependency 'sidekiq', '>= 5.0'
   spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'routemaster-drain', '>= 3.0'
 

data/spec/materialist/materializer_spec.rb

@@ -10,17 +10,17 @@ RSpec.describe Materialist::Materializer do
       class FoobarMaterializer
         include Materialist::Materializer
 
-        use_model :foobar
-        materialize :name
-        materialize :age, as: :how_old
+        persist_to :foobar
+        capture :name
+        capture :age, as: :how_old
 
         materialize_link :city
 
         link :city do
-          materialize :timezone
+          capture :timezone
 
           link :country do
-            materialize :tld, as: :country_tld
+            capture :tld, as: :country_tld
           end
         end
       end
@@ -28,8 +28,8 @@ RSpec.describe Materialist::Materializer do
       class CityMaterializer
         include Materialist::Materializer
 
-        use_model :city
-        materialize :name
+        persist_to :city
+        capture :name
       end
     end
 
@@ -240,7 +240,7 @@ RSpec.describe Materialist::Materializer do
         class FoobarMaterializer
           include Materialist::Materializer
 
-          use_model :foobar
+          persist_to :foobar
           after_upsert :my_method
 
           def my_method(entity)
@@ -274,7 +274,7 @@ RSpec.describe Materialist::Materializer do
         class FoobarMaterializer
           include Materialist::Materializer
 
-          use_model :foobar
+          persist_to :foobar
           after_destroy :my_method
 
           def my_method(entity)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Mo Valipour
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement