lhs 24.1.2 → 25.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf423437a22db27b055a47b11b77edad75d4fb22895330bb33b439c03d9e89f
-  data.tar.gz: 228b803160ce5cfeaa801e25eac36a84fa75196ca906183336e649cd17c5604a
+  metadata.gz: cbf1bd4d4d3bec5d8264176e1b7806a4b04f56bceabd6b72f51efb50a0a49b46
+  data.tar.gz: f60fffae1148244ddb5d52c379668dbac292a3868baa1862f52362ecb7537ea5
 SHA512:
-  metadata.gz: dd83a4d879c72a201b29420021562da78945a1ef731a87023c735efe90144f1d088318c293064d9361aa559df8405132d88af0011225c43e675144d1c5af7b5f
-  data.tar.gz: 6da5e46c3e113bbf48a3821a02b88a6379bd54846889acb7cf77ce269be9645404d443656215979d7b3311ae1139ba07c00993542cacbd17562dc79b733af8eb
+  metadata.gz: 22e0045d22ae49e4537329ffb53d1db8ef070da54822ffda08315e85ed7fe6c6e66656e65f61d7d06a4aa2010f34a8a52d6f614c1da8ad13e88628538ebc0b4f
+  data.tar.gz: e297eabef047eed5cc42b102d13b6043c678ea7f2fc8c620d04a4b8b794ee0028459e65d80a3361cc7ea43ad2e17aa966323859b735a632847e77e376266fb9c

data/lhs.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activemodel'
   s.add_dependency 'activesupport', '>= 4.2.11'
-  s.add_dependency 'lhc', '>= 12.1.1', '< 13'
+  s.add_dependency 'lhc', '>= 12.1.1', '< 14'
   s.add_dependency 'local_uri'
 
   s.add_development_dependency 'capybara'

data/lib/lhs/collection.rb

@@ -14,7 +14,7 @@ class LHS::Collection < LHS::Proxy
 
   METHOD_NAMES_EXLCUDED_FROM_WRAPPING = %w(to_a to_ary map).freeze
 
-  delegate :select, :length, :size, to: :_collection
+  delegate :select, :length, :size, :insert, to: :_collection
   delegate :_record, :_raw, to: :_data
   delegate :limit, :count, :total, :offset, :current_page, :start,
            :next?, :previous?, to: :_pagination

data/lib/lhs/concerns/autoload_records.rb

@@ -32,7 +32,7 @@ module AutoloadRecords
         end
 
         def self.require_direct_inheritance
-          model_files.map do |file|
+          model_files.sort.map do |file|
             next unless File.read(file).match('LHS::Record')
             require_dependency file
             file.split('models/').last.gsub('.rb', '').classify
@@ -41,7 +41,9 @@ module AutoloadRecords
 
         def self.require_inheriting_records(parents)
           model_files.each do |file|
-            next if parents.none? { |parent| File.read(file).match(parent) }
+            file_content = File.read(file)
+            next if parents.none? { |parent| file_content.match(/\b#{parent}\b/) }
+            next if file_content.match?('extend ActiveSupport::Concern')
             require_dependency file
           end
         end

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, to: :raw
+               :<<, :push, :insert, to: :raw
 
       def initialize(raw, parent, record)
         self.raw = raw
@@ -39,7 +39,7 @@ class LHS::Collection < LHS::Proxy
       def compact
         dup.tap do |collection|
           collection.compact! if collection.raw.present?
-        end
+        end.as_json # do not return an internal collection!
       end
 
       def compact!

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

@@ -9,11 +9,11 @@ class LHS::Data
 
     # Extends already fetched data (self) with additionally
     # fetched data (addition) using the given key
-    def extend!(addition, key)
+    def extend!(addition, key = nil)
       addition = cast_relation_class_for_extension(addition, key)
       if collection?
         extend_collection!(addition, key)
-      elsif self[key]._raw.is_a? Array
+      elsif _raw.is_a?(Array) || self[key]._raw.is_a?(Array)
         extend_array!(addition, key)
       elsif item?
         extend_item!(addition, key)
@@ -22,14 +22,14 @@ class LHS::Data
 
     private
 
-    def cast_relation_class_for_extension(addition, key)
-      return addition if _record.nil? || _record._relations.nil? || _record._relations[key].nil?
+    def cast_relation_class_for_extension(addition, key = nil)
+      return addition if _record.nil? || key.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)
+    def extend_collection!(addition, key = nil)
       map do |item|
-        item_raw = item._raw[key]
+        item_raw = key ? item._raw[key] : item._raw
         item_raw.blank? ? [nil] : item_raw
       end
         .flatten
@@ -45,25 +45,25 @@ class LHS::Data
         end
     end
 
-    def extend_array!(addition, key)
-      self[key].zip(addition) do |item, additional_item|
+    def extend_array!(addition, key = nil)
+      (key ? self[key] : self).zip(addition) do |item, additional_item|
         item._raw.merge!(additional_item._raw) if additional_item.present?
       end
     end
 
-    def extend_item!(addition, key)
+    def extend_item!(addition, key = nil)
       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)
+        (key ? _raw[key.to_sym] : _raw).merge!(addition._raw)
       end
     end
 
-    def extend_item_with_collection!(addition, key)
-      target = self[key]
+    def extend_item_with_collection!(addition, key = nil)
+      target = (key ? self[key] : self)
       if target._raw.is_a? Array
-        self[key] = addition.map(&:_raw)
+        self[key] = addition.map(&:_raw) if key
       else # hash with items
         extend_item_with_hash_containing_items!(target, addition)
       end
@@ -72,7 +72,11 @@ class LHS::Data
     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)
+        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])

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

@@ -29,7 +29,10 @@ class LHS::Record
         if options.is_a?(Hash)
           options.deep_merge(LHS::OptionBlocks::CurrentOptionBlock.options)
         elsif options.is_a?(Array)
-          options.map { |option| option.deep_merge(LHS::OptionBlocks::CurrentOptionBlock.options) }
+          options.map do |option|
+            return LHS::OptionBlocks::CurrentOptionBlock.options unless option
+            option.deep_merge(LHS::OptionBlocks::CurrentOptionBlock.options)
+          end
         end
       end
 
@@ -118,7 +121,7 @@ class LHS::Record
         else
           options = options_for_data(data, included)
           options = extend_with_reference(options, reference)
-          addition = load_include(options, data, sub_includes, reference)
+          addition = load_existing_includes(options, data, sub_includes, reference)
           data.extend!(addition, included)
           expand_addition!(data, included, reference) unless expanded_data?(addition)
         end
@@ -277,6 +280,21 @@ class LHS::Record
         end
       end
 
+      def load_existing_includes(options, data, sub_includes, references)
+        if data.collection? && data.any?(&:blank?)
+          # filter only existing items
+          loaded_includes = load_include(options.compact, data.compact, sub_includes, references)
+          # fill up skipped items before returning
+          data.each_with_index do |item, index|
+            next if item.present?
+            loaded_includes.insert(index, {})
+          end
+          loaded_includes
+        else
+          load_include(options, data, sub_includes, references)
+        end
+      end
+
       # Load additional resources that are requested with include
       def load_include(options, _data, sub_includes, references)
         record = record_for_options(options) || self
@@ -303,11 +321,22 @@ class LHS::Record
       end
 
       # Continues loading included resources after one complete batch/level has been fetched
-      def continue_including(data, including, referencing)
-        handle_includes(including, data, referencing) if including.present? && data.present?
+      def continue_including(data, included, reference)
+        return data if included.blank? || data.blank?
+        expand_data!(data, included, reference) unless expanded_data?(data)
+        handle_includes(included, data, reference)
         data
       end
 
+      def expand_data!(data, _included, reference)
+        options = options_for_data(data)
+        options = extend_with_reference(options, reference)
+        record = record_for_options(options) || self
+        options = convert_options_to_endpoints(options) if record_for_options(options)
+        expanded_data = record.request(options)
+        data.extend!(expanded_data)
+      end
+
       # Loads all included/linked resources,
       # paginates itself to ensure all records are fetched
       def load_all_included!(record, options)

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '24.1.2'
+  VERSION = '25.0.4'
 end

data/spec/dummy/app/models/concerns/dummy_customer/some_concern.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class DummyCustomer < Providers::CustomerSystem
+  module SomeConcern
+    extend ActiveSupport::Concern
+
+    # dont auto load this again with LHS as it would raise an exception
+  end
+end

data/spec/dummy/app/models/dummy_customer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 class DummyCustomer < Providers::CustomerSystem
+  include SomeConcern
   endpoint 'http://customers'
   endpoint 'http://customers/{id}'
 end

data/spec/record/compact_spec.rb

@@ -66,6 +66,11 @@ describe LHS::Record do
   end
 
   context '.compact' do
+
+    it 'does NOT return an internal data type, but the Record class' do
+      expect(places.compact.class).to eq User
+    end
+
     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

data/spec/record/includes_after_expansion_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'includes records after expansion' do
+
+    before do
+      class User < LHS::Record
+        endpoint 'http://users/{id}'
+      end
+
+      class Places < LHS::Record
+        endpoint 'http://users/{id}/places'
+        endpoint 'http://places/{id}'
+      end
+
+      class Contracts < LHS::Record
+        endpoint 'http://places/{place_id}/contracts'
+      end
+
+      stub_request(:get, 'http://users/1')
+        .to_return(
+          body: {
+            places: {
+              href: 'http://users/1/places'
+            }
+          }.to_json
+        )
+
+      stub_request(:get, 'http://users/1/places?limit=100')
+        .to_return(
+          body: {
+            items: [
+              { href: 'http://places/345' }
+            ],
+            total: 1,
+            offset: 0,
+            limit: 10
+          }.to_json
+        )
+
+      stub_request(:get, 'http://places/345')
+        .to_return(
+          body: {
+            contracts: {
+              href: "http://places/345/contracts?offset=0&limit=10"
+            }
+          }.to_json
+        )
+
+      stub_request(:get, 'http://places/345/contracts?offset=0&limit=10')
+        .to_return(
+          body: {
+            items: [
+              {
+                product: { name: 'OPL' }
+              }
+            ]
+          }.to_json
+        )
+
+    end
+
+    it 'includes resources after expanding plain links' do
+      user = User.includes(places: :contracts).find(1)
+      expect(
+        user.places.first.contracts.first.product.name
+      ).to eq 'OPL'
+    end
+  end
+end

data/spec/record/includes_missing_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+
+  context 'merge request options ' do
+    before do
+      class Record < LHS::Record
+        endpoint 'http://records/{id}'
+      end
+
+      stub_request(:get, 'http://records/1')
+        .to_return(body: {
+          place_attributes: [
+            { href: 'https://attributes/bar' },
+            { href: 'https://attributes/restaurant' },
+            { href: 'https://attributes/cafe' }
+          ]
+        }.to_json)
+
+      stub_request(:get, "https://attributes/restaurant?limit=100")
+        .to_return(body: {}.to_json)
+      stub_request(:get, "https://attributes/restaurant")
+        .to_return(body: {}.to_json)
+      stub_request(:get, "https://attributes/bar?limit=100")
+        .to_return(body: {
+          group: {
+            href: 'https://group/general'
+          }
+        }.to_json)
+      stub_request(:get, "https://attributes/cafe?limit=100")
+        .to_return(body: {
+          group: {
+            href: 'https://group/general'
+          }
+        }.to_json)
+      stub_request(:get, "https://group/general?limit=100&status=active")
+        .to_return(body: {
+          name: 'General'
+        }.to_json)
+    end
+
+    context 'missing referenced options due to none existance of include' do
+
+      it 'does not raise when trying to merge options with the options block' do
+        LHS.options(throttle: { break: '80%' }) do
+          record = Record
+            .references(place_attributes: { group: { params: { status: 'active' } } })
+            .includes([{ place_attributes: :group }])
+            .find(1)
+          expect(record.place_attributes[0].group.name).to eq 'General'
+          expect(record.place_attributes[1].group).to eq nil
+          expect(record.place_attributes[2].group.name).to eq 'General'
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 24.1.2
+  version: 25.0.4
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -47,7 +47,7 @@ dependencies:
         version: 12.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: 12.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: local_uri
   requirement: !ruby/object:Gem::Requirement
@@ -389,6 +389,7 @@ files:
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/concerns/dummy_customer/some_concern.rb
 - spec/dummy/app/models/dummy_customer.rb
 - spec/dummy/app/models/dummy_record.rb
 - spec/dummy/app/models/dummy_record_with_auto_oauth_provider.rb
@@ -504,8 +505,10 @@ files:
 - spec/record/href_for_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
+- spec/record/includes_after_expansion_spec.rb
 - spec/record/includes_expanded_spec.rb
 - spec/record/includes_first_page_spec.rb
+- spec/record/includes_missing_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb
 - spec/record/item_key_spec.rb
@@ -619,6 +622,7 @@ test_files:
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/concerns/dummy_customer/some_concern.rb
 - spec/dummy/app/models/dummy_customer.rb
 - spec/dummy/app/models/dummy_record.rb
 - spec/dummy/app/models/dummy_record_with_auto_oauth_provider.rb
@@ -734,8 +738,10 @@ test_files:
 - spec/record/href_for_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
+- spec/record/includes_after_expansion_spec.rb
 - spec/record/includes_expanded_spec.rb
 - spec/record/includes_first_page_spec.rb
+- spec/record/includes_missing_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb
 - spec/record/item_key_spec.rb