lhs 24.0.0 → 24.1.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e31a9b37f1bc0f12b3a6c87933b145781ed3054e08ea4ea347d5b27d00a069ea
-  data.tar.gz: d67f414e70fdcae5567dcf5c81c2e2dec93237026e829c9dc9522df5eb778480
+  metadata.gz: '0098eb4147ef54ee7e80bb67e1a466c39165ef4b65ad2ac18f6a2c024ee2e9f7'
+  data.tar.gz: 853bd4e9697debd6c559d24d295019473793c3c5bcf4c1a3f5cdba3d966a743c
 SHA512:
-  metadata.gz: f39832a96aa989660bfbaf051c53bd53c647d4e75f7b9fa3ca81ab1243ec94bd17828da931207f80fd57a9f98f38188cca659143912a01a4ffc5e197090f6b3a
-  data.tar.gz: 19ea228303da96f4f4e831825c19c98ea9a81c15b76ad645b3ecbe23532f0a7336eb87d815f432f2d25ee5d6f0c07d98963ed0ba5388022cd79521cd0ae04424
+  metadata.gz: d3db0060e2155188d1697ec6e9c9000d05b13592d6a8ec7c5f952a28b25d1162f72c009f5f70375e06e67637a8d4e488e1946a161bda24513cbb1ea17fe626a3
+  data.tar.gz: aa448eeb65c3b13ba529040d79b4a3cb6ac31f3961cf407e6d72d6f69bdc3dfc5f543c8d02cd1a3d4932b6a57e0c26fabbd91f365f7629676445cbc328e93e42

data/README.md

@@ -2290,6 +2290,54 @@ feedback = Feedback
   .find(12345)
 ```
 
+#### compact: Remove included resources that didn't return any records
+
+In case you include nested data and ignored errors while including, it can happen that you get back a collection that contains data based on response errors:
+
+```ruby
+# app/controllers/some_controller.rb
+
+user = User
+  .includes(:places)
+  .references(places: { ignore: LHC::NotFound })
+  .find(123)
+```
+
+```
+GET http://service/users/123
+{ "places": { "href": "http://service/users/123/places" } }
+
+GET http://service/users/123/places
+{ "items": [
+  { "href": "http://service/places/1" },
+  { "href": "http://service/places/2" }
+] }
+
+GET http://service/places/1
+200 { "name": "Casa Ferlin" }
+
+GET http://service/places/2
+404 { "status": 404, "error": "not found" }
+```
+
+```ruby
+user.places[1] # { "status": 404, "error": "not found" }
+```
+
+In order to exclude items from a collection which where not based on successful responses, use `.compact` or `.compact!`:
+
+```ruby
+# app/controllers/some_controller.rb
+
+user = User
+  .includes(:places)
+  .references(places: { ignore: LHC::NotFound })
+  .find(123)
+places = user.places.compact
+
+places # { "items": [ { "href": "http://service/places/1", "name": "Casa Ferlin" } ] }
+```
+
 ### Record batch processing
 
 **Be careful using methods for batch processing. They could result in a lot of HTTP requests!**

data/lib/lhs/concerns/collection/internal_collection.rb

@@ -14,7 +14,7 @@ class LHS::Collection < LHS::Proxy
 
       attr_accessor :raw
       delegate :length, :size, :first, :last, :sample, :[], :present?, :blank?, :empty?,
-               :<<, :push, :compact, to: :raw
+               :<<, :push, to: :raw
 
       def initialize(raw, parent, record)
         self.raw = raw
@@ -36,6 +36,22 @@ class LHS::Collection < LHS::Proxy
         end
       end
 
+      def compact
+        dup.tap do |collection|
+          collection.compact! if collection.raw.present?
+        end
+      end
+
+      def compact!
+        self.raw = raw.map do |item|
+          if item.is_a?(LHS::Data) && item._request && !item._request.response.success?
+            nil
+          else
+            item
+          end
+        end.compact
+      end
+
       private
 
       def cast_item(item)

data/lib/lhs/concerns/data/extend.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+class LHS::Data
+
+  module Extend
+    extend ActiveSupport::Concern
+
+    # Extends already fetched data (self) with additionally
+    # fetched data (addition) using the given key
+    def extend!(addition, key)
+      if collection?
+        extend_collection!(addition, key)
+      elsif self[key]._raw.is_a? Array
+        extend_array!(addition, key)
+      elsif item?
+        extend_item!(addition, key)
+      end
+    end
+
+    private
+
+    def extend_collection!(addition, key)
+      map do |item|
+        item_raw = item._raw[key]
+        item_raw.blank? ? [nil] : item_raw
+      end
+        .flatten
+        .each_with_index do |item, index|
+          item_addition = addition[index]
+          next if item_addition.nil? || item.nil?
+          if item_addition._raw.is_a?(Array)
+            item[items_key] ||= []
+            item[items_key].concat(item_addition._raw)
+          else
+            item.merge! item_addition._raw
+          end
+        end
+    end
+
+    def extend_array!(addition, key)
+      self[key].zip(addition) do |item, additional_item|
+        item._raw.merge!(additional_item._raw) if additional_item.present?
+      end
+    end
+
+    def extend_item!(addition, key)
+      return if addition.nil?
+      if addition.collection?
+        extend_item_with_collection!(addition, key)
+      else # simple case merges hash into hash
+        _raw[key.to_sym].merge!(addition._raw)
+      end
+    end
+
+    def extend_item_with_collection!(addition, key)
+      target = self[key]
+      if target._raw.is_a? Array
+        self[key] = addition.map(&:_raw)
+      else # hash with items
+        extend_item_with_hash_containing_items!(target, addition)
+      end
+    end
+
+    def extend_item_with_hash_containing_items!(target, addition)
+      LHS::Collection.nest(input: target._raw, value: [], record: self) # inits the nested collection
+      if LHS::Collection.access(input: target._raw, record: self).empty?
+        LHS::Collection.nest(input: target._raw, value: addition.reject { |item| item.nil? }, record: self)
+      else
+        LHS::Collection.access(input: target._raw, record: self).each_with_index do |item, index|
+          item.merge!(addition[index])
+        end
+      end
+    end
+  end
+end

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

@@ -98,74 +98,6 @@ class LHS::Record
         )
       end
 
-      # Extends existing raw data with additionaly fetched data
-      def extend_raw_data!(data, addition, key)
-        if data.collection?
-          extend_base_collection!(data, addition, key)
-        elsif data[key]._raw.is_a? Array
-          extend_base_array!(data, addition, key)
-        elsif data.item?
-          extend_base_item!(data, addition, key)
-        end
-      end
-
-      def extend_base_collection!(data, addition, key)
-        data.map do |item|
-          item_raw = item._raw[key]
-          item_raw.blank? ? [nil] : item_raw
-        end
-          .flatten
-          .each_with_index do |item, index|
-            item_addition = addition[index]
-            next if item_addition.nil? || item.nil?
-            if item_addition._raw.is_a?(Array)
-              extend_base_collection_with_array!(item, item_addition._raw)
-            else
-              item.merge! item_addition._raw
-            end
-          end
-      end
-
-      def extend_base_collection_with_array!(item, addition)
-        item[items_key] ||= []
-        item[items_key].concat(addition)
-      end
-
-      def extend_base_array!(data, addition, key)
-        data[key].zip(addition) do |item, additional_item|
-          item._raw.merge!(additional_item._raw) if additional_item.present?
-        end
-      end
-
-      def extend_base_item!(data, addition, key)
-        return if addition.nil?
-        if addition.collection?
-          extend_base_item_with_collection!(data, addition, key)
-        else # simple case merges hash into hash
-          data._raw[key.to_sym].merge!(addition._raw)
-        end
-      end
-
-      def extend_base_item_with_collection!(data, addition, key)
-        target = data[key]
-        if target._raw.is_a? Array
-          data[key] = addition.map(&:_raw)
-        else # hash with items
-          extend_base_item_with_hash_of_items!(target, addition)
-        end
-      end
-
-      def extend_base_item_with_hash_of_items!(target, addition)
-        LHS::Collection.nest(input: target._raw, value: [], record: self)
-        if LHS::Collection.access(input: target._raw, record: self).empty?
-          LHS::Collection.nest(input: target._raw, value: addition.compact.map(&:_raw), record: self)
-        else
-          LHS::Collection.access(input: target._raw, record: self).each_with_index do |item, index|
-            item.merge!(addition[index])
-          end
-        end
-      end
-
       def handle_includes(includes, data, references = {})
         references ||= {}
         if includes.is_a? Hash
@@ -187,7 +119,7 @@ class LHS::Record
           options = options_for_data(data, included)
           options = extend_with_reference(options, reference)
           addition = load_include(options, data, sub_includes, reference)
-          extend_raw_data!(data, addition, included)
+          data.extend!(addition, included)
           expand_addition!(data, included, options) unless expanded_data?(addition)
         end
       end
@@ -210,7 +142,7 @@ class LHS::Record
         record = record_for_options(options) || self
         options = convert_options_to_endpoints(options) if record_for_options(options)
         expanded_data = record.request(options)
-        extend_raw_data!(data, expanded_data, included)
+        data.extend!(expanded_data, included)
       end
 
       def expanded_data?(addition)

data/lib/lhs/data.rb

@@ -6,6 +6,8 @@ class LHS::Data
     'lhs/concerns/data/becomes'
   autoload :Equality,
     'lhs/concerns/data/equality'
+  autoload :Extend,
+    'lhs/concerns/data/extend'
   autoload :Json,
     'lhs/concerns/data/json'
   autoload :ToHash,
@@ -13,6 +15,7 @@ class LHS::Data
 
   include Becomes
   include Equality
+  include Extend
   include Json
   include ToHash
   include LHS::Inspect
@@ -30,6 +33,7 @@ class LHS::Data
     self._proxy = proxy_from_input(input)
     self._request = request
     self._endpoint = endpoint
+    preserve_input_requests!(input)
   end
 
   # merging data
@@ -97,6 +101,17 @@ class LHS::Data
 
   private
 
+  def preserve_input_requests!(input)
+    if input.is_a?(LHS::Data)
+      _request = input._request if _request.nil?
+    elsif input.is_a?(Array) && input.first.is_a?(LHS::Data)
+      input.each_with_index do |item, index|
+        next if item.nil?
+        self[index]._request = item._request
+      end
+    end
+  end
+
   def collection_proxy?(input)
     (input.is_a?(Hash) && LHS::Collection.access(input: input, record: _record)) ||
       input.is_a?(Array) ||

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '24.0.0'
+  VERSION = '24.1.0.pre.1'
 end

data/spec/record/compact_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  before do
+    class Place < LHS::Record
+      endpoint 'http://datastore/places/{id}'
+    end
+
+    class User < LHS::Record
+      endpoint 'http://datastore/users/{id}'
+    end
+
+    stub_request(:get, 'http://datastore/users/123')
+      .to_return(status: 200, body: {
+        href: 'http://datastore/users/123',
+        places: { href: 'http://datastore/users/123/places' }
+      }.to_json)
+
+    stub_request(:get, 'http://datastore/users/123/places?limit=100')
+      .to_return(status: 200, body: {
+        href: 'http://datastore/users/123/places?offset=0&limit=100',
+        items: [
+          {
+            href: 'http://datastore/users/123/places/789'
+          }
+        ],
+        total: 4,
+        offset: 0,
+        limit: 10
+      }.to_json)
+
+    stub_request(:get, 'http://datastore/users/123/places/789?limit=100')
+      .to_return(
+        status: 404,
+        body: {
+          status: 404,
+          message: 'The requested resource does not exist.'
+        }.to_json
+      )
+
+  end
+
+  let(:places) do
+    User
+      .includes(:places)
+      .references(places: { ignore: LHC::NotFound })
+      .find('123')
+      .places
+  end
+
+  context '.compact' do
+
+    it 'removes linked resouces which could not get fetched' do
+      expect(places.compact.length).to eq 0
+      expect(places.length).not_to eq 0 # leaves the original intact
+    end
+  end
+
+  context '.compact!' do
+    it 'removes linked resouces which could not get fetched' do
+      expect(places.compact!.length).to eq 0
+      expect(places.length).to eq 0 # and changes the original intact
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 24.0.0
+  version: 24.1.0.pre.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -274,6 +274,7 @@ files:
 - lib/lhs/concerns/configuration.rb
 - lib/lhs/concerns/data/becomes.rb
 - lib/lhs/concerns/data/equality.rb
+- lib/lhs/concerns/data/extend.rb
 - lib/lhs/concerns/data/json.rb
 - lib/lhs/concerns/data/to_hash.rb
 - lib/lhs/concerns/inspect.rb
@@ -471,6 +472,7 @@ files:
 - spec/record/attribute_assignment_spec.rb
 - spec/record/build_spec.rb
 - spec/record/cast_nested_data_spec.rb
+- spec/record/compact_spec.rb
 - spec/record/create_spec.rb
 - spec/record/creation_failed_spec.rb
 - spec/record/custom_setters_spec.rb
@@ -561,9 +563,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - Ruby >= 2.3.0
 rubygems_version: 3.0.6
@@ -699,6 +701,7 @@ test_files:
 - spec/record/attribute_assignment_spec.rb
 - spec/record/build_spec.rb
 - spec/record/cast_nested_data_spec.rb
+- spec/record/compact_spec.rb
 - spec/record/create_spec.rb
 - spec/record/creation_failed_spec.rb
 - spec/record/custom_setters_spec.rb