lhs 24.1.0 → 25.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a87032458b0558f6659a20e25b28b4f2523533fb9775f44148adeca6c4109263
-  data.tar.gz: 3395b718c795e0128bb8e33d646b2319720c6280c9eff1f32f498485a3f9bad4
+  metadata.gz: '030995aefe88b5d0494d0e7ccaa760eb2a67d8ebf728ce4aaaa8646ca5b130ef'
+  data.tar.gz: af0e530a38ff5c816a797613506b40c996f58aea8c391ca59099d1ee6152ce00
 SHA512:
-  metadata.gz: d0ac63a7eaed408a1612ff55db6388f3b375458d60ee9e4e6ea70f9399800a022456c4cce030a593b902ffc775c4a9deac17b7a801613ac7df4b69ca199d5849
-  data.tar.gz: 64135aa329e9127e04664a43746cd1e4d57236d3dc7ea405e74553cd0b9ef3cd01d479f70ff4dc66c44930010fae56be8780e719a0504bde6907def5832d5c7a
+  metadata.gz: 70859dbf4582c03d84edeb5aa6b750ee76a4908e2bd43e9c324b4ab8ca318da457087f2b95d3c433e570f48d2ee4a6cc691dd821830c82f86acc44f7e8ff4652
+  data.tar.gz: ab20d6595519d82cf47a9b203f0e246062ce6d611c9997c4ae50cc3fb33c0b1378c911415df845ddbc2f714c98bc05d63c562e5364227a7ccba1a573af9f1954

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

@@ -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/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'
+  VERSION = '25.0.2'
 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

@@ -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
+  version: 25.0.2
 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-30 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,6 +505,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
@@ -617,6 +620,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,6 +736,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