lhs 24.0.0 → 24.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e31a9b37f1bc0f12b3a6c87933b145781ed3054e08ea4ea347d5b27d00a069ea
-  data.tar.gz: d67f414e70fdcae5567dcf5c81c2e2dec93237026e829c9dc9522df5eb778480
+  metadata.gz: 9bf423437a22db27b055a47b11b77edad75d4fb22895330bb33b439c03d9e89f
+  data.tar.gz: 228b803160ce5cfeaa801e25eac36a84fa75196ca906183336e649cd17c5604a
 SHA512:
-  metadata.gz: f39832a96aa989660bfbaf051c53bd53c647d4e75f7b9fa3ca81ab1243ec94bd17828da931207f80fd57a9f98f38188cca659143912a01a4ffc5e197090f6b3a
-  data.tar.gz: 19ea228303da96f4f4e831825c19c98ea9a81c15b76ad645b3ecbe23532f0a7336eb87d815f432f2d25ee5d6f0c07d98963ed0ba5388022cd79521cd0ae04424
+  metadata.gz: dd83a4d879c72a201b29420021562da78945a1ef731a87023c735efe90144f1d088318c293064d9361aa559df8405132d88af0011225c43e675144d1c5af7b5f
+  data.tar.gz: 6da5e46c3e113bbf48a3821a02b88a6379bd54846889acb7cf77ce269be9645404d443656215979d7b3311ae1139ba07c00993542cacbd17562dc79b733af8eb

data/README.md

@@ -126,6 +126,7 @@ record.review # "Lunch was great
         * [Include various levels of linked data](#include-various-levels-of-linked-data)
         * [Identify and cast known records when including records](#identify-and-cast-known-records-when-including-records)
         * [Apply options for requests performed to fetch included records](#apply-options-for-requests-performed-to-fetch-included-records)
+        * [compact: Remove included resources that didn't return any records](#compact-remove-included-resources-that-didnt-return-any-records)
      * [Record batch processing](#record-batch-processing)
         * [all](#all-1)
            * [Using all, when endpoint does not implement response pagination meta data](#using-all-when-endpoint-does-not-implement-response-pagination-meta-data)
@@ -149,12 +150,15 @@ record.review # "Lunch was great
      * [Test query chains](#test-query-chains)
         * [By explicitly resolving the chain: fetch](#by-explicitly-resolving-the-chain-fetch)
         * [Without resolving the chain: where_values_hash](#without-resolving-the-chain-where_values_hash)
+  * [Extended developer documentation](#extended-developer-documentation)
+     * [Accessing data in LHS](#accessing-data-in-lhs)
   * [License](#license)
 
 
 
 
 
+
 ## Installation/Startup checklist
 
 - [ ] Install LHS gem, preferably via `Gemfile`
@@ -1698,7 +1702,7 @@ record.partial_update(recommended: true)
 
 ```
 ```
-POST https://service.example.com/records/1z-5r1fkaj { body: "{ 'name': 'Starbucks', 'recommended': true }" }
+POST https://service.example.com/records/1z-5r1fkaj { body: "{ 'recommended': true }" }
 ```
 
 -> See [record validation](#record-validation) for how to handle validation errors when updating records.
@@ -2290,6 +2294,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!**
@@ -2830,6 +2882,12 @@ expect(
 ).to eq {color: 'red', available: true}
 ```
 
+## Extended developer documentation
+
+### Accessing data in LHS
+
+![diagram](docs/accessing-data-in-lhs.png)
+
 ## License
 
 [GNU General Public License Version 3.](https://www.gnu.org/licenses/gpl-3.0.en.html)

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,13 +36,37 @@ 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
+            cast_item(item)
+          end
+        end.compact
+      end
+
       private
 
       def cast_item(item)
-        record_by_href = LHS::Record.for_url(item[:href]) if item[:href]
         data = LHS::Data.new(item, @parent, @record)
-        return (record_by_href || @record).new(data) if record_by_href || @record
-        data
+        (record_by_href(item) || @record)&.new(data) || data
+      end
+
+      def record_by_href(item)
+        return if plain_value?(item) || item[:href].blank?
+
+        LHS::Record.for_url(item[:href])
+      end
+
+      def plain_value?(item)
+        item.is_a?(String) || item.is_a?(Numeric) || item.is_a?(TrueClass) || item.is_a?(FalseClass)
       end
     end
   end

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

@@ -0,0 +1,83 @@
+# 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)
+      addition = cast_relation_class_for_extension(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 cast_relation_class_for_extension(addition, key)
+      return addition if _record.nil? || _record._relations.nil? || _record._relations[key].nil?
+      addition.becomes(_record._relations[key][:record_class_name].constantize, errors: addition.errors, warnings: addition.warnings)
+    end
+
+    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,8 +119,8 @@ 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)
-          expand_addition!(data, included, options) unless expanded_data?(addition)
+          data.extend!(addition, included)
+          expand_addition!(data, included, reference) 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.2'
 end

data/spec/record/compact_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  before do
+    class Place < LHS::Record
+      endpoint 'http://datastore/places/{id}'
+      endpoint 'http://datastore/users/{user_id}/places/{id}'
+
+      def display_name
+        "*#{name}*"
+      end
+    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'
+          }, {
+            href: 'http://datastore/users/123/places/790'
+          }
+        ],
+        total: 2,
+        offset: 0,
+        limit: 10
+      }.to_json)
+
+    stub_request(:get, 'http://datastore/users/123/places/789')
+      .to_return(
+        body: {
+          href: 'http://datastore/users/123/places/789?limit=100',
+          name: 'Mc Donalds'
+        }.to_json
+      )
+
+    stub_request(:get, 'http://datastore/users/123/places/790')
+      .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 1
+      expect(places.length).not_to eq 1 # leaves the original intact
+    end
+  end
+
+  context 'record casting' do
+    let(:expected_display_name) { '*Mc Donalds*' }
+
+    it 'finds the right record class' do
+      expect(places.first.display_name).to eq expected_display_name
+      expect(places.compact.map(&:display_name)).to eq [expected_display_name]
+    end
+  end
+
+  context '.compact!' do
+    it 'removes linked resouces which could not get fetched' do
+      expect(places.compact!.length).to eq 1
+      expect(places.length).to eq 1 # and changes the original intact
+    end
+  end
+end

data/spec/record/includes_expanded_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'includes all (expanded)' do
+    before do
+      class Record < LHS::Record
+        endpoint 'http://records/{id}'
+      end
+
+      stub_request(:get, "http://records/1")
+        .to_return(
+          body: {
+            car: { href: 'http://records/1/car' }
+          }.to_json
+        )
+
+      stub_request(:get, "http://records/1/car?color=blue&limit=100")
+        .to_return(
+          body: { href: 'http://records/cars/1' }.to_json
+        )
+
+      stub_request(:get, "http://records/cars/1?color=blue&limit=100")
+        .to_return(
+          body: { name: 'wrum wrum' }.to_json
+        )
+    end
+
+    it 'expands linked resources and forwards proper reference' do
+      record = Record.includes(:car).references(car: { params: { color: :blue } }).find(1)
+      expect(
+        record.car.name
+      ).to eq 'wrum wrum'
+    end
+  end
+end

data/spec/record/references_spec.rb

@@ -8,6 +8,14 @@ describe LHS::Record do
       class Customer < LHS::Record
         endpoint 'http://datastore/customers/{id}'
       end
+
+      class User < LHS::Record
+        endpoint 'http://datastore/users/{id}'
+        endpoint 'http://datastore/customers/{customer_id}/users/{id}'
+        def reversed_name
+          name.split.reverse.join(' ')
+        end
+      end
     end
 
     let!(:customer_request) do
@@ -18,6 +26,9 @@ describe LHS::Record do
           },
           'contact_addresses' => {
             'href' => "http://datastore/contact_addresses"
+          },
+          'users' => {
+            'href' => 'http://datastore/customers/1/users'
           }
         }.to_json)
     end
@@ -49,5 +60,37 @@ describe LHS::Record do
       assert_requested(electronic_addresses_request)
       assert_requested(contact_addresses_request)
     end
+
+    describe 'mapping related classes correctly' do
+      before do
+        stub_request(:get, 'http://datastore/customers/1/users?limit=100').to_return(
+          status: 200,
+          body: {
+            href: 'http://datastore/customers/1/users?offset=0&limit=100',
+            items: [
+              { href: 'http://datastore/customers/1/users/1' }
+            ],
+            total: 1,
+            offset: 0,
+            limit: 10
+          }.to_json
+        )
+
+        stub_request(:get, 'http://datastore/customers/1/users/1')
+          .with(headers: { 'Authentication' => 'Bearer 123' })
+          .to_return(body: { href: 'http://datastore/users/1', name: 'Elizabeth Baker' }.to_json)
+      end
+
+      it 'maps correctly' do
+        users = Customer
+          .includes(:users)
+          .references(users: referencing_options)
+          .find(1)
+          .users
+
+        expect(users.first.reversed_name).to be_present
+      end
+    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.2
 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-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -263,6 +263,7 @@ files:
 - cider-ci/task_components/rspec.yml
 - cider-ci/task_components/rubocop.yml
 - cider-ci/task_components/ruby.yml
+- docs/accessing-data-in-lhs.png
 - friday.yml
 - lhs.gemspec
 - lib/lhs.rb
@@ -274,6 +275,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 +473,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
@@ -501,6 +504,7 @@ files:
 - spec/record/href_for_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
+- spec/record/includes_expanded_spec.rb
 - spec/record/includes_first_page_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb
@@ -699,6 +703,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
@@ -729,6 +734,7 @@ test_files:
 - spec/record/href_for_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
+- spec/record/includes_expanded_spec.rb
 - spec/record/includes_first_page_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb