capsula 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1e116a89071a460417f16918fbc8ea0871ba2217a3b513d90f76028ff789c0
-  data.tar.gz: d66bf5ca919d2df33b664b5e50d9dab8afd3866a115ce47ab5e458335610d6fc
+  metadata.gz: c534b9fef1cf66293f27706a7399215013ca7d41f58b3fd7bbf6e1f4990bc0a8
+  data.tar.gz: 16af229a6c5155c34e8fc4e91eac9911fae50c6cfd29e5b102aa14ebae28a07d
 SHA512:
-  metadata.gz: 9919c5c93000fa52a3615c41bb579ca202be4805b7d879219b59cb0b941ed214b07bf5d260ae5c3775bd0494d3c4abe808b92fb510942cc277243a575bde7dd8
-  data.tar.gz: d467d3cadada0ffb8cf7cb7ccc86b32b683a30e97b4a3aab079df1d101583a57c934673553a824544359011c0cdefa1fff2d2969997288a16dbaaf7fe54194d2
+  metadata.gz: 3480eb2df25870f7e9fd507847897cdc8cee3037bbef3c25312ef822218bf9ac54e34ecb4e7acfbf5609bc18334300fb8b71f799b5ca107989b14e17368aef12
+  data.tar.gz: 2240b2987901d94a39d5407f0b4caa9ad943987d0e0bfe1ae4433cb1dbed18673977a13f92eaa65a4ae14c4dd52c53a70e68b43c0501e3a98ad3f636986d5643

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capsula (0.0.1)
+    capsula (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -82,4 +82,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -3,16 +3,26 @@ The tool for encapsulating (preloading, including) related objects into **any**
 
 ## How to use:
 
+Add to Gemfile:
+
+```
+gem 'capsula'
+```
+
+Then:
+
 ```ruby
 starships = <get_your_space_fleet>
 
-StarshipsEncapsulator.new(starships).plans(
+starships = StarshipsEncapsulator.new(starships).plans(
   :fuel, :oxygen, :food, { spaceman: [:space_suit] }
 ).encapsulate
 
 # Now let's get a suit for our spaceman:
 starships.first&.spaceman&.space_suit
-=> <awesome space suit> # Capsula's wrapper answers
+=> <awesome space suit>
+# no actual action was triggered,
+# immediate result was received from Capsula's wrapper
 ```
 
 Let's see how `StarshipsEncapsulator` looks:
@@ -29,23 +39,38 @@ class StarshipsEncapsulator < Capsula::Base
   # Plans for other relations...
 end
 ```
+
+### src_key, dst_key
+
+**default values:**
+
 Definition for `src_key` and `dst_key` can be skipped if they values are `:fuel_id` (`<key_name>_id`) and `:id`
 
+**lambdas:**
 
-Also, for key-definition can be used lambdas:
+For key-definition can be used lambdas:
 
 ```ruby
-src_key: ->(o){ o.some_hash_data.fetch(:fuel_id, default: 'A-95') }
-dst_key: ->(o){ o.extact_fuel_id_from_octane_number }
+src_key: ->(o){ o.some_hash_data.fetch(:fuel_id, 'A-95') }
+dst_key: ->(o){ o.extract_fuel_id_from_octane_number }
 ```
 
+### dst_loader
+
+**nested plans:**
+
+`dst_loader` receive plans in `opt[:plans]` only for related class.
+
+So, if user request plans for `:fuel, :oxygen, :food, { spaceman: [:space_suit] }`,
+then `SpacemanEncapsulator` receive `[:space_suit]` plans in `opt[:plans]` and so on.
+
 ## How it works:
 
 All objects is wrapping into special transparent wrapper which
 translate all methods to wrapped object, except methods-names which was used for encapsulating before:
 
 ```ruby
-StarshipsEncapsulator.new(starships).plan(:fuel, :oxygen).encapsulate
+starships = StarshipsEncapsulator.new(starships).plans(:fuel, :oxygen).encapsulate
 starships.first.oxygen
 => <oxygen> # instant response, because already present in Capsula
 ```
@@ -62,20 +87,20 @@ For difficult preloading logic can be used custom loader:
 
 ```ruby
 class CustomLoader
-	def initialize items:, opt: {}
-		@items = items; @opt = opt; @store = [];
-	end
-
-	# This method is triggered by Capsula
-	def collect_ids_and_load_relations
-		ids = @items.map{ |i| i.fuel_id }
-		@store = Fuel.where(id: ids).to_a
-	end
-
-	# This method is calling by Capsula during encapsulation
-	def get_preloads_for_object starship
-		@store.find { |fuel| starship.fuel_id == fuel.id }
-	end
+  def initialize items:, opt: {}
+    @items = items; @opt = opt; @store = [];
+  end
+
+  # This method is triggered by Capsula
+  def collect_ids_and_load_relations
+    ids = @items.map{ |i| i.fuel_id }
+    @store = Fuel.where(id: ids).to_a
+  end
+
+  # This method is calling by Capsula during encapsulation
+  def get_preloads_for_object starship
+    @store.find { |fuel| starship.fuel_id == fuel.id }
+  end
 end
 
 

data/capsula.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'capsula'
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.date        = '2019-02-04'
   s.summary     = 'Encapsulating tool'
   s.description = 'The tool for encapsulating (preloading, including) related objects'

data/lib/capsula/encapsulator.rb

@@ -98,14 +98,24 @@ module Capsula
     end
 
     def native_preload key, dec, opt
-      # collect relation ids
-      ids = @items.map do |o|
-        get_key(o, dec[:src_key])
-      end.flatten.uniq.compact
+      # collect ids for preloading
+      ids =
+        @items.map do |o|
+          get_value(o, dec[:src_key])
+        end.flatten.uniq.compact
+
+      # preload and index objects
+      col =
+        if ids.any?
+          preloads = dec[:dst_loader].call(ids,opt)
+          # build hash: {id1 => Obj1, ..., idN => ObjN }
+          index_array_by(preloads) { |el| get_value(el, dec[:dst_key]) }
+        else
+          {}
+        end
 
-      # preload relations
       @collections[key] = {
-        collection: (ids.any? ? dec[:dst_loader].call(ids,opt) : []),
+        collection: col,
         declaration: dec
       }
     end
@@ -122,24 +132,26 @@ module Capsula
       dec = declaration
 
       @items.each do |i|
-        src_id = get_key(i, dec[:src_key])
+        src_id = get_value(i, dec[:src_key])
+
+        val =
+          if src_id.is_a?(Array)
+            # if object has many links to related objects (Array)
+            col.values_at(*src_id)
+          else
+            # only one link
+            col[src_id]
+          end
 
-        val = if src_id.is_a?(Array)
-          # if object has many links to related objects (Array)
-          col.select{|c| src_id.include?(c.id) }
-        else
-          # only one link
-          col.find{|c| get_key(c, dec[:dst_key]) == src_id }
-        end
         i[plan_key] = val
       end
     end
 
-    def get_key _object_, key_or_lambda
+    def get_value _object_, key_or_lambda
       case key_or_lambda
-      when Symbol, String
+      when ::Symbol, ::String
         _object_.send(key_or_lambda)
-      when Proc
+      when ::Proc
         key_or_lambda.call(_object_)
       else
         nil
@@ -162,5 +174,12 @@ module Capsula
       end
     end
 
+    # copypasted from activesupport
+    # https://www.rubydoc.info/github/rails/rails/Enumerable:index_by
+    def index_array_by arr
+      result = {}
+      arr.each { |elem| result[yield(elem)] = elem }
+      result
+    end
   end
 end

data/spec/capsula_spec.rb

@@ -22,8 +22,6 @@ RSpec.describe Capsula do
       objects = [1,2].map{ |i| a.new(i) }
       objects = klass.new(objects).plans(:b).encapsulate
 
-      puts objects.first.b
-
       expect(objects.first).to respond_to(:b)
       expect(objects.first).to be_a(Capsula::Wrapper)
       expect(objects.first.b.id).to be == objects.first.b_id

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capsula
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Rodion V