lhs 14.5.0 → 14.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66878335134271a8a2adadfb4a3318d029f0a854
-  data.tar.gz: c579b0f2377f06413b247d58023f10ed1bb908b6
+  metadata.gz: 077d421d6966d805ebcd502e5a0c093cc6bcf4a4
+  data.tar.gz: c687c58f9bde359b6576812aa9eebd19b984c5cc
 SHA512:
-  metadata.gz: 48df46b051c333e615122cf5fda68298b2bf3f4116631f93a987408c8942e7e295e52b4d24830861867f099bc74f473e28bd6a9c1c7ae16c43007d7be81f9c31
-  data.tar.gz: f138b1a4a1d25b7b43de711b7bdf4038a13330cd34c94784123234cf9b0be62f25c9cd2c02593916f111542bb1c9c24b70c60d356be90fed82a87a3a5d908f1e
+  metadata.gz: a63875a01836b652d4b049df0c50b3c314fe2ff6306e37134e149defb1bdf1addc904455406991f974954c6de2ee0906c20205f4bd3ad4127fd583755c64afff
+  data.tar.gz: 78388e5606346ecbb96d944cf25285e2fbbbecdb1b9d6647dac8c940646186ae7a5ec88574cf1ec2d42b164f9f7fc75588dd4927d7d4689719f2515b775b8341

data/.rubocop.yml

@@ -35,3 +35,6 @@ Style/EmptyLinesAroundBlockBody:
 
 RSpec/MultipleExpectations:
   Enabled: false
+
+Naming/PredicateName:
+  Enabled: false

data/README.md

@@ -266,6 +266,36 @@ After fetching [single](#find-single-records) or [multiple](#find-multiple-recor
   record.parent == records # true
 ```
 
+## Relations
+
+Even though, nested data is automatically casted when accessed, see: [Nested records](#nested-records), sometimes api's don't provide dedicated endpoints to retrive these records.
+
+As those records also don't have an href, nested records can not be casted automatically, when accessed.
+
+Those kind of relations, you can still configure manually:
+
+```ruby
+
+class Location < LHS::Record
+  
+  endpoint 'http://uberall/locations/:id'
+
+  has_many :listings
+
+end
+
+class Listing < LHS::Record
+  
+  def supported?
+    type == 'SUPPORTED'
+  end
+end
+
+Location.find(1).listings.first.supported? # true
+
+```
+
+
 ## Request based options
 
 You can apply options to the request chain. Those options will be forwarded to the request perfomed by the chain/query.
@@ -643,7 +673,7 @@ class LocalEntry < LHS::Record
 end
 ```
 
-### Nested records
+## Nested records
 
 Nested records (in nested data) are automaticaly casted when the href matches any defined endpoint of any LHS::Record.
 

data/lib/lhs/concerns/{item → data}/becomes.rb

@@ -1,6 +1,6 @@
 require 'active_support'
 
-class LHS::Item < LHS::Proxy
+class LHS::Data
 
   module Becomes
     extend ActiveSupport::Concern

data/lib/lhs/concerns/proxy/accessors.rb

@@ -67,8 +67,9 @@ class LHS::Proxy
       wrap_return(collection, record, name)
     end
 
-    # Wraps with record and adds nested errors/warnings to data,
-    # if errors are existing
+    # Wraps the return value with a record class.
+    # Adds errors and warnings if existing.
+    # Returns plain data if no record class was found.
     def wrap_return(value, record, name, args = nil)
       name = args.first if name == :[]
       return value unless worth_wrapping?(value)
@@ -76,6 +77,7 @@ class LHS::Proxy
       data.errors = LHS::Problems::Nested::Errors.new(errors, name) if errors.any?
       data.warnings = LHS::Problems::Nested::Warnings.new(warnings, name) if warnings.any?
       return record.new(data) if record && !value.is_a?(LHS::Record)
+      return data.becomes(_record._relations[name][:record_class_name].constantize) if _record && _record._relations[name]
       data
     end
 

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

@@ -0,0 +1,20 @@
+require 'active_support'
+require 'active_support/core_ext/class/attribute'
+
+class LHS::Record
+
+  module Relations
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_relations
+      self._relations = {}
+    end
+
+    module ClassMethods
+      def has_many(name)
+        _relations[name] = { record_class_name: name.to_s.singularize.classify }
+      end
+    end
+  end
+end

data/lib/lhs/data.rb

@@ -1,5 +1,7 @@
 # Data provides functionalities to accesses information
 class LHS::Data
+  autoload :Becomes,
+    'lhs/concerns/data/becomes'
   autoload :Equality,
     'lhs/concerns/data/equality'
   autoload :Json,
@@ -7,6 +9,7 @@ class LHS::Data
   autoload :ToHash,
     'lhs/concerns/data/to_hash'
 
+  include Becomes
   include Equality
   include Json
   include ToHash

data/lib/lhs/item.rb

@@ -1,8 +1,6 @@
 # An item is a concrete record.
 # It can be part of another proxy like collection.
 class LHS::Item < LHS::Proxy
-  autoload :Becomes,
-    'lhs/concerns/item/becomes'
   autoload :Destroy,
     'lhs/concerns/item/destroy'
   autoload :Save,
@@ -12,7 +10,6 @@ class LHS::Item < LHS::Proxy
   autoload :Validation,
     'lhs/concerns/item/validation'
 
-  include Becomes
   include Create
   include Destroy
   include Save

data/lib/lhs/proxy.rb

@@ -17,7 +17,7 @@ class LHS::Proxy
 
   # prevent clashing with attributes of underlying data
   attr_accessor :_data, :_loaded
-  delegate :_record, to: :_data, allow_nil: true
+  delegate :_record, :becomes, to: :_data, allow_nil: true
 
   def initialize(data)
     self._data = data

data/lib/lhs/record.rb

@@ -27,6 +27,8 @@ class LHS::Record
     'lhs/concerns/record/pagination'
   autoload :Request,
     'lhs/concerns/record/request'
+  autoload :Relations,
+    'lhs/concerns/record/relations'
   autoload :Scope,
     'lhs/concerns/record/scope'
 
@@ -52,10 +54,11 @@ class LHS::Record
   include Model
   include Pagination
   include Request
+  include Relations
   include RequestCycleCache
   include Scope
 
-  delegate :_proxy, :_endpoint, :merge_raw!, :select, to: :_data
+  delegate :_proxy, :_endpoint, :merge_raw!, :select, :becomes, to: :_data
 
   def initialize(data = nil, apply_customer_setters = true)
     data = LHS::Data.new({}, nil, self.class) unless data

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '14.5.0'
+  VERSION = '14.6.0'
 end

data/spec/record/has_many_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  before(:each) do
+    class Location < LHS::Record
+      endpoint 'http://uberall/locations'
+      endpoint 'http://uberall/locations/:id'
+      has_many :listings
+    end
+
+    class Listing < LHS::Record
+
+      def supported?
+        true
+      end
+    end
+  end
+
+  context 'has_many' do
+    let(:location) { Location.find(1) }
+    let(:listing) { location.listings.first }
+
+    it 'casts the relation into the correct type' do
+      stub_request(:get, 'http://uberall/locations/1')
+        .to_return(body: {
+          listings: [{
+            directory: { name: 'Instagram' }
+          }]
+        }.to_json)
+      expect(listing).to be_kind_of(Listing)
+      expect(listing.supported?).to eq true
+    end
+  end
+end

data/spec/support/cleanup.rb

@@ -25,7 +25,7 @@ RSpec.configure do |config|
     LHC::Config.instance._cleanup
     LHS::Record::Endpoints.all = {}
     LHS::Record::CHILDREN.each do |child|
-      child.endpoints = [] if !child.name['LHS']
+      child.endpoints = [] if !child.name['LHS'] && defined?(child.endpoints)
       child.configuration({}) if !child.name['LHS']
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 14.5.0
+  version: 14.6.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -201,11 +201,11 @@ files:
 - lib/lhs/concerns/collection/handle_nested.rb
 - lib/lhs/concerns/collection/internal_collection.rb
 - lib/lhs/concerns/configuration.rb
+- lib/lhs/concerns/data/becomes.rb
 - lib/lhs/concerns/data/equality.rb
 - lib/lhs/concerns/data/json.rb
 - lib/lhs/concerns/data/to_hash.rb
 - lib/lhs/concerns/inspect.rb
-- lib/lhs/concerns/item/becomes.rb
 - lib/lhs/concerns/item/destroy.rb
 - lib/lhs/concerns/item/save.rb
 - lib/lhs/concerns/item/update.rb
@@ -227,6 +227,7 @@ files:
 - lib/lhs/concerns/record/mapping.rb
 - lib/lhs/concerns/record/model.rb
 - lib/lhs/concerns/record/pagination.rb
+- lib/lhs/concerns/record/relations.rb
 - lib/lhs/concerns/record/request.rb
 - lib/lhs/concerns/record/request_cycle_cache/interceptor.rb
 - lib/lhs/concerns/record/request_cycle_cache/request_cycle_thread_registry.rb
@@ -372,6 +373,7 @@ files:
 - spec/record/find_in_parallel_spec.rb
 - spec/record/find_spec.rb
 - spec/record/first_spec.rb
+- spec/record/has_many_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
 - spec/record/includes_all_spec.rb
@@ -555,6 +557,7 @@ test_files:
 - spec/record/find_in_parallel_spec.rb
 - spec/record/find_spec.rb
 - spec/record/first_spec.rb
+- spec/record/has_many_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
 - spec/record/includes_all_spec.rb