lhs 24.1.0.pre.1 → 25.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0098eb4147ef54ee7e80bb67e1a466c39165ef4b65ad2ac18f6a2c024ee2e9f7'
-  data.tar.gz: 853bd4e9697debd6c559d24d295019473793c3c5bcf4c1a3f5cdba3d966a743c
+  metadata.gz: 75364b152de7b958acefbb09ab084ca96dd15f1daad2465ab80db56584f5f600
+  data.tar.gz: 1456ffc9b3a696bc871248981364f7012deeb921647d88493041db4d40effea5
 SHA512:
-  metadata.gz: d3db0060e2155188d1697ec6e9c9000d05b13592d6a8ec7c5f952a28b25d1162f72c009f5f70375e06e67637a8d4e488e1946a161bda24513cbb1ea17fe626a3
-  data.tar.gz: aa448eeb65c3b13ba529040d79b4a3cb6ac31f3961cf407e6d72d6f69bdc3dfc5f543c8d02cd1a3d4932b6a57e0c26fabbd91f365f7629676445cbc328e93e42
+  metadata.gz: c271c49bce686c2686ef1d80b535433aba05f1cd58dc98b2265cc8cc63149faa9b3094e0cf82acf8f0afd80721fbbfa5369aea1ffb091e0b14ce35120bc400fc
+  data.tar.gz: a24a6debcbe0866a73167eee9b44a3adc7cda111bcd4971e77982d14d44e2bda3cce3eaa63666e257f60f5653a3e013321eb622ca2d6e152cae9b03fce79839d

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.
@@ -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/concerns/collection/internal_collection.rb

@@ -47,7 +47,7 @@ class LHS::Collection < LHS::Proxy
           if item.is_a?(LHS::Data) && item._request && !item._request.response.success?
             nil
           else
-            item
+            cast_item(item)
           end
         end.compact
       end
@@ -55,10 +55,18 @@ class LHS::Collection < LHS::Proxy
       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

@@ -10,6 +10,7 @@ class LHS::Data
     # 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
@@ -21,6 +22,11 @@ class LHS::Data
 
     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]

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

@@ -120,7 +120,7 @@ class LHS::Record
           options = extend_with_reference(options, reference)
           addition = load_include(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
 

data/lib/lhs/version.rb

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

data/spec/record/compact_spec.rb

@@ -6,6 +6,11 @@ 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
@@ -24,14 +29,24 @@ describe LHS::Record do
         items: [
           {
             href: 'http://datastore/users/123/places/789'
+          }, {
+            href: 'http://datastore/users/123/places/790'
           }
         ],
-        total: 4,
+        total: 2,
         offset: 0,
         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',
+          name: 'Mc Donalds'
+        }.to_json
+      )
+
+    stub_request(:get, 'http://datastore/users/123/places/790')
       .to_return(
         status: 404,
         body: {
@@ -51,17 +66,25 @@ describe LHS::Record do
   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
+      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 0
-      expect(places.length).to eq 0 # and changes the original intact
+      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.1.0.pre.1
+  version: 25.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-10-07 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
@@ -503,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
@@ -563,9 +565,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: 1.3.1
+      version: '0'
 requirements:
 - Ruby >= 2.3.0
 rubygems_version: 3.0.6
@@ -732,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