lhs 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42f49d74b6cae3f84139b46895b5defb5454c184
-  data.tar.gz: 9232b8df9672d9caa11e3f0a3a36f2474ba3386e
+  metadata.gz: b5e2d8c23fc37ece5d7b13aebd02f43df60aec96
+  data.tar.gz: 650560241439a1cb5b97c86894ef4a5e133d5bd4
 SHA512:
-  metadata.gz: 7fbeecfceee4e4c6ebb5f125d427d98cbc1ece337469fb3ae8070de018616e33e5c8923df319863c835367cfcbda6581cc24f22512d3d3b11899bd8531aa801a
-  data.tar.gz: 36520b86b942ac32f0c01191a7e6f418100122f18724b760a0d7f4c7ef630b8c32c3974fa49c714bf6631dc044b5e8448bf8a87ef6be26e7a6f1bb552537d059
+  metadata.gz: 7d086164639d3fd4b3a40a772c2c98360cf212f6b58e6d55a5debe7317daecb341e42aec62948783e79f3eb18f398a607a9cffc99a7828d73f9fc02c894cc36a
+  data.tar.gz: 329fbdb7a8edc677a156588061af8e99e9a15db6bec9684f50e057157f6c4489fd1eb71d5c58c8378bb7e194682b2679e77b58c0ada1f3fc2b012bdfc70c2e9d

data/README.md

@@ -293,7 +293,7 @@ feedback.ratings # {:quality=>3}
 
 ## Include linked resources
 
-When fetching records, you can specify in advance all the linked resources that you want to include in the results. With `includes`, LHS ensures that all matching and explicitly linked resources are loaded and merged.
+When fetching records, you can specify in advance all the linked resources that you want to include in the results. With `includes`, LHS ensures that all matching and explicitly linked resources are loaded and merged, if they're included in the server response.
 
 The implementation is heavily influenced by [http://guides.rubyonrails.org/active_record_class_querying](http://guides.rubyonrails.org/active_record_class_querying.html#eager-loading-associations) and you should read it to understand this feature in all its glory.
 

data/lib/lhs/concerns/record/request.rb

@@ -26,6 +26,7 @@ class LHS::Record
       end
 
       def convert_option_to_endpoints(option)
+        return unless option.present?
         new_options = option.dup
         url = option[:url]
         endpoint = LHS::Endpoint.for_url(url)
@@ -38,10 +39,12 @@ class LHS::Record
 
       # Extends existing raw data with additionaly fetched data
       def extend_raw_data(data, addition, key)
-        if data._proxy.is_a? LHS::Collection
+        return if addition.empty?
+        if data.collection?
           data.each_with_index do |item, i|
             item = item[i] if item.is_a? LHS::Collection
-            item._raw[key.to_sym].merge!(addition[i]._raw)
+            link = item[key.to_sym]
+            link.merge_raw!(addition[i]) if link.present?
           end
         elsif data._proxy.is_a? LHS::Item
           data._raw[key.to_sym].merge!(addition._raw)
@@ -59,19 +62,25 @@ class LHS::Record
       end
 
       def handle_include(included, data, sub_includes = nil)
-        return unless data.present?
+        return if data.blank? || skip_loading_includes?(data, included)
         options =
-          if data._proxy.is_a? LHS::Collection
-            options_for_multiple(data, included)
+          if data.collection?
             options_for_multiple(data, included)
           else
             url_option_for(data, included)
-            url_option_for(data, included)
           end
         addition = load_include(options, data, sub_includes)
         extend_raw_data(data, addition, included)
       end
 
+      def skip_loading_includes?(data, included)
+        if data.collection?
+          data.to_a.none? { |item| item[included].present? }
+        else
+          !data._raw.key?(included)
+        end
+      end
+
       # Load additional resources that are requested with include
       def load_include(options, data, sub_includes)
         record = record_for_options(options) || self
@@ -92,14 +101,31 @@ class LHS::Record
       end
 
       def multiple_requests(options)
-        options = options.map { |option| process_options(option, find_endpoint(option[:params])) }
-        responses = LHC.request(options)
-        data = responses.map { |response| LHS::Data.new(response.body, nil, self, response.request) }
-        data = LHS::Data.new(data, nil, self)
-        handle_includes(including, data) if including
+        options = options.map do |option|
+          next unless option.present?
+          process_options(option, find_endpoint(option[:params]))
+        end
+        data = LHC.request(options.compact).map { |response| LHS::Data.new(response.body, nil, self, response.request) }
+        data = restore_with_nils(data, locate_nils(options)) # nil objects in data provide location information for mapping
+        unless data.empty?
+          data = LHS::Data.new(data, nil, self)
+          handle_includes(including, data) if including
+        end
         data
       end
 
+      def locate_nils(array)
+        nils = []
+        array.each_with_index { |value, index| nils << index if value.nil? }
+        nils
+      end
+
+      def restore_with_nils(array, nils)
+        array = array.dup
+        nils.sort.each { |index| array.insert(index, nil) }
+        array
+      end
+
       def options_for_multiple(data, key)
         data.map do |item|
           url_option_for(item, key)
@@ -119,7 +145,7 @@ class LHS::Record
       def record_for_options(options)
         records = []
         if options.is_a?(Array)
-          options.each do |option|
+          options.compact.each do |option|
             record = LHS::Record.for_url(option[:url])
             next unless record
             records.push(record)
@@ -143,7 +169,7 @@ class LHS::Record
 
       def url_option_for(item, key)
         link = item[key]
-        { url: link.href }
+        return { url: link.href } if link.present? && link.href.present?
       end
     end
   end

data/lib/lhs/data.rb

@@ -23,7 +23,7 @@ class LHS::Data
   # merging data
   # e.g. when loading remote data via link
   def merge_raw!(data)
-    return false unless data._raw.is_a?(Hash)
+    return false if data.blank? || !data._raw.is_a?(Hash)
     _raw.merge! data._raw
   end
 

data/lib/lhs/record.rb

@@ -18,9 +18,7 @@ class LHS::Record
   include Request
   include Scope
 
-  delegate :_proxy, to: :_data
-  delegate :_endpoint, to: :_data
-  delegate :select, to: :_data
+  delegate :_proxy, :_endpoint, :merge_raw!, :select, to: :_data
 
   def initialize(data = nil)
     data = LHS::Data.new({}, nil, self.class) unless data

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "5.2.0"
+  VERSION = "5.3.0"
 end

data/spec/record/includes_spec.rb

@@ -170,6 +170,59 @@ describe LHS::Record do
         # rubocop:enable RSpec/InstanceVariable
       end
     end
+
+    context 'includes not present in response' do
+      before :each do
+        class Parent < LHS::Record
+          endpoint ':datastore/local-parents'
+          endpoint ':datastore/local-parents/:id'
+        end
+
+        class OptionalChild < LHS::Record
+          endpoint ':datastore/local-children/:id'
+        end
+      end
+
+      it 'handles missing but included fields in single object response' do
+        stub_request(:get, "#{datastore}/local-parents/1")
+          .to_return(status: 200, body: {
+            'href' => "#{datastore}/local-parents/1",
+            'name' => 'RspecName'
+          }.to_json)
+
+        parent = Parent.includes(:optional_children).find(1)
+        expect(parent).not_to be nil
+        expect(parent.name).to eq 'RspecName'
+        expect(parent.optional_children).to be nil
+      end
+
+      it 'handles missing but included fields in collection response' do
+        stub_request(:get, "#{datastore}/local-parents")
+          .to_return(status: 200, body: {
+            items: [
+              {
+                'href' => "#{datastore}/local-parents/1",
+                'name' => 'RspecParent'
+              }, {
+                'href'           => "#{datastore}/local-parents/2",
+                'name'           => 'RspecParent2',
+                'optional_child' => {
+                  'href' => "#{datastore}/local-children/1"
+                }
+              }]
+          }.to_json)
+
+        stub_request(:get, "#{datastore}/local-children/1")
+          .to_return(status: 200, body: {
+            href: "#{datastore}/local_children/1",
+            name: 'RspecOptionalChild1'
+          }.to_json)
+
+        child = Parent.includes(:optional_child).where[1].optional_child
+        expect(child).not_to be nil
+        expect(child.name).to eq 'RspecOptionalChild1'
+      end
+    end
   end
 
   context 'links pointing to nowhere' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -343,7 +343,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 1.9.2
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface for http json services