lhs 24.1.1 → 25.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00243f3b3ea3dd2e97864c126dc7b8177c3f6e38cd217aba7c1a2843d9215d4c
-  data.tar.gz: 2c63934cbc1752513d1336997d2c9743c40b518d31b177d30f18a6ffe00ea99a
+  metadata.gz: 7aa5e0e072a78d7029c968c255ac6c41e5425504b7e121fc5c205a672c59d4a7
+  data.tar.gz: 59a90ded930e12b7cc54842db415d5d0f2c09ade777eaccc44d9703d4bc1f46a
 SHA512:
-  metadata.gz: 492a78447b6b7985bed8a82025a95551f94943f6e712d09863ca99d3952bb16a26da46a88d6fc1edc5cb744dae230eab22319a038c3a0e67e76747e406afd2aa
-  data.tar.gz: 274eacd3f4815d81514b7273d6613851be0eb6427cd7c9fca1c0a8105cd5a28e62e1f5b740ad31331446a10d2cfe6fdc13c64808fb957511cbcf6b4e7790dc99
+  metadata.gz: e953b0d8278c209f1a398298d6bbf85b91469cf285bc7c0470b401cacfce2db7b692822e7d13488c4b36c823cef1c093bc8ffb4a5d2d53ab5782765589711b07
+  data.tar.gz: d7124e16eca63583fb58922354253c902bbd86e0079c22e3d8b864a7a80b8acd098128a67c2e32cfe45c6ed28d19158def5a063fec174bdba364435b11054d92

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`
@@ -2878,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/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

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,9 +121,9 @@ 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, options) unless expanded_data?(addition)
+          expand_addition!(data, included, reference) unless expanded_data?(addition)
         end
       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

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '24.1.1'
+  VERSION = '25.0.3'
 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

@@ -38,7 +38,7 @@ describe LHS::Record do
         limit: 10
       }.to_json)
 
-    stub_request(:get, 'http://datastore/users/123/places/789?limit=100')
+    stub_request(:get, 'http://datastore/users/123/places/789')
       .to_return(
         body: {
           href: 'http://datastore/users/123/places/789?limit=100',
@@ -46,7 +46,7 @@ describe LHS::Record do
         }.to_json
       )
 
-    stub_request(:get, 'http://datastore/users/123/places/790?limit=100')
+    stub_request(:get, 'http://datastore/users/123/places/790')
       .to_return(
         status: 404,
         body: {

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/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

data/spec/record/references_spec.rb

@@ -76,7 +76,7 @@ describe LHS::Record do
           }.to_json
         )
 
-        stub_request(:get, 'http://datastore/customers/1/users/1?limit=100')
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 24.1.1
+  version: 25.0.3
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2020-11-10 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
@@ -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
@@ -388,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
@@ -503,7 +505,9 @@ 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_missing_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb
 - spec/record/item_key_spec.rb
@@ -552,7 +556,7 @@ homepage: https://github.com/local-ch/lhs
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -568,8 +572,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.3.0
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.6
+signing_key: 
 specification_version: 4
 summary: 'REST services accelerator: Rails gem providing an easy, active-record-like
   interface for http (hypermedia) json services'
@@ -617,6 +621,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
@@ -732,7 +737,9 @@ 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_missing_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb
 - spec/record/item_key_spec.rb