lhs 15.4.1 → 15.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aae793d07885f60a78b3ba1a00620126cb5abe0e
-  data.tar.gz: 3aae37c869254994499545d59b3059c0baac6038
+SHA256:
+  metadata.gz: 9b17b15e82a095cf72eb05a914ced03c99f32d9c209b4a4e1c4e11c981a85f4c
+  data.tar.gz: 9f0303112e9847a8797582894c7d109eb19aba94144bd6c692b4ce9a3f06ee83
 SHA512:
-  metadata.gz: b32efb89e71c58078da3c14a9e86ed094ead7a7553241944a7110ba62a9aaf24a18b248e9a511bca437464186f554689c211205c7aea97d6bc17318914192208
-  data.tar.gz: 24b40b24d88d3047760687ec664430588c9abe84e70aa7268852ff51c99e917a95023a20b4958615f0a006551d98b8f1683b14d7f8cacafa1275090ae6264204
+  metadata.gz: 30f6194e142c4e83414f7e7c8d425f4297c92be6043518d310cf763c7a990546835d5ef604390987daf1b41ad19f054be7b3d11078c76212fc6a842d0d0742d3
+  data.tar.gz: 7306ff1a0d92ba35ea3992f3f5900d5bb6a90897918e8091006e174df90ab68c0261b885f27cc77795fd3b0a4cd5f180d43de35e361a998e84734ca5a5c0ecdc

data/README.md

@@ -268,6 +268,28 @@ If no record is found, `nil` is returned.
 
 `first!` raises LHC::NotFound if nothing was found.
 
+`first` can also be used with options:
+
+```ruby
+Record.first(params: { color: :blue })
+```
+
+`last` is an alias for finding the last record without parameters.
+
+```ruby
+  Record.last
+```
+
+If no record is found, `nil` is returned.
+
+`last!` raises LHC::NotFound if nothing was found.
+
+`last` can also be used with options:
+
+```ruby
+Record.last(params: { color: :blue })
+```
+
 # Find multiple single records in parallel
 
 In case you want to fetch multiple records by id in parallel, you can also do this with `find`:

data/lib/lhs/collection.rb

@@ -27,9 +27,11 @@ class LHS::Collection < LHS::Proxy
   end
 
   def _collection
-    raw = _data._raw if _data._raw.is_a?(Array)
-    raw ||= _data.access(input: _data._raw, record: _record)
-    Collection.new(raw, _data, _record)
+    @_collection ||= begin
+      raw = _data._raw if _data._raw.is_a?(Array)
+      raw ||= _data.access(input: _data._raw, record: _record)
+      Collection.new(raw, _data, _record)
+    end
   end
 
   def collection?
@@ -54,6 +56,7 @@ class LHS::Collection < LHS::Proxy
     if _collection.respond_to?(name)
       value = _collection.send(name, *args, &block)
       record = LHS::Record.for_url(value[:href]) if value.is_a?(Hash) && value[:href]
+      record ||= _record
       value = enclose_item_in_data(value) if value.is_a?(Hash)
       return value if METHOD_NAMES_EXLCUDED_FROM_WRAPPING.include?(name.to_s)
       wrap_return(value, record, name, args)
@@ -72,7 +75,7 @@ class LHS::Collection < LHS::Proxy
   # Encloses accessed collection item
   # by wrapping it in an LHS::Item
   def enclose_item_in_data(value)
-    data = LHS::Data.new(value, _data)
+    data = LHS::Data.new(value, _data, _record)
     item = LHS::Item.new(data)
     LHS::Data.new(item, _data)
   end

data/lib/lhs/concerns/collection/internal_collection.rb

@@ -11,7 +11,7 @@ class LHS::Collection < LHS::Proxy
       include Enumerable
 
       attr_accessor :raw
-      delegate :length, :size, :last, :sample, :[], :present?, :blank?, :empty?,
+      delegate :length, :size, :first, :last, :sample, :[], :present?, :blank?, :empty?,
                :<<, :push, :compact, to: :raw
 
       def initialize(raw, parent, record)

data/lib/lhs/concerns/data/becomes.rb

@@ -6,6 +6,7 @@ class LHS::Data
     extend ActiveSupport::Concern
 
     def becomes(klass)
+      return self if self.class == klass && !is_a?(LHS::Data)
       klass.new(LHS::Data.new(_raw, _parent, klass))
     end
   end

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

@@ -73,10 +73,10 @@ class LHS::Proxy
     def wrap_return(value, record, name, args = nil)
       name = args.first if name == :[]
       return value unless worth_wrapping?(value)
-      data = (value.is_a?(LHS::Data) || value.is_a?(LHS::Record)) ? value : LHS::Data.new(value, _data)
+      data = (value.is_a?(LHS::Data) || value.is_a?(LHS::Record)) ? value : LHS::Data.new(value, _data, _record, _request)
       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) 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/last.rb

@@ -0,0 +1,24 @@
+require 'active_support'
+
+class LHS::Record
+
+  module Last
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def last(options = nil)
+        first_batch = find_by({}, options).parent
+        if first_batch.paginated?
+          pagination = first_batch._pagination
+          find_by({ pagination_key => pagination.class.page_to_offset(pagination.last_page, pagination.limit) }, options)
+        else
+          first_batch.last
+        end
+      end
+
+      def last!(options = nil)
+        find_by!({}, options)
+      end
+    end
+  end
+end

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

@@ -7,6 +7,10 @@ class LHS::Record
     # Kaminari-Interface
     delegate :current_page, :first_page, :last_page, :prev_page, :next_page, :limit_value, :total_pages, to: :_pagination
 
+    def paginated?(raw = nil)
+      self.class.paginated?(raw || _raw)
+    end
+
     def _pagination
       self.class.pagination(_data)
     end
@@ -26,6 +30,11 @@ class LHS::Record
       def pagination(data)
         pagination_class.new(data)
       end
+
+      # Checks if given raw is paginated or not
+      def paginated?(raw)
+        !!(raw.is_a?(Hash) && raw.dig(*total_key))
+      end
     end
   end
 end

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

@@ -282,16 +282,22 @@ class LHS::Record
       end
 
       def load_and_merge_set_of_paginated_collections!(data, options)
-        options_for_this_batch = []
+        options_for_next_batch = []
         options.each_with_index do |element, index|
           next if element.nil?
           record = data[index]._record
           pagination = record.pagination(data[index])
           next if pagination.pages_left.zero?
-          options_for_this_batch.push(options_for_next_batch(record, pagination, options[index], data[index]))
+          options_for_next_batch.push(
+            options_for_next_batch(record, pagination, options[index]).tap do |options|
+              options.each do |option|
+                option[:merge_with_index] = index
+              end
+            end
+          )
         end
-        data._record.request(options_for_this_batch.flatten).each do |batch_data|
-          merge_batch_data_with_parent!(batch_data, batch_data._request.options[:parent_data])
+        data._record.request(options_for_next_batch.flatten).each do |batch_data|
+          merge_batch_data_with_parent!(batch_data, data[batch_data._request.options[:merge_with_index]])
         end
       end
 
@@ -338,11 +344,6 @@ class LHS::Record
         data
       end
 
-      # Checks if given raw is paginated or not
-      def paginated?(raw)
-        !!(raw.is_a?(Hash) && raw.dig(*total_key))
-      end
-
       def prepare_options_for_include_all_request!(options)
         if options.is_a?(Array)
           options.each do |option|
@@ -439,7 +440,7 @@ class LHS::Record
         end.flatten
       end
 
-      def options_for_next_batch(record, pagination, options, parent_data = nil)
+      def options_for_next_batch(record, pagination, options)
         batch_options = []
         pagination.pages_left.times do |index|
           page_options = {
@@ -448,7 +449,6 @@ class LHS::Record
               record.pagination_key(:parameter) => pagination.next_offset(index + 1)
             }
           }
-          page_options[:parent_data] = parent_data if parent_data
           batch_options.push(
             options.deep_dup.deep_merge(page_options)
           )

data/lib/lhs/record.rb

@@ -19,6 +19,8 @@ class LHS::Record
     'lhs/concerns/record/find_by'
   autoload :First,
     'lhs/concerns/record/first'
+  autoload :Last,
+    'lhs/concerns/record/last'
   autoload :Mapping,
     'lhs/concerns/record/mapping'
   autoload :Model,
@@ -49,6 +51,7 @@ class LHS::Record
   include Find
   include FindBy
   include First
+  include Last
   include LHS::Inspect
   include Mapping
   include Model

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '15.4.1'
+  VERSION = '15.5.0'
 end

data/spec/data/collection_spec.rb

@@ -33,8 +33,8 @@ describe LHS::Data do
   context 'collections' do
     it 'forwards calls to the collection' do
       expect(data.count).to be_kind_of Integer
-      expect(data[0]).to be_kind_of LHS::Data
-      expect(data.sample).to be_kind_of LHS::Data
+      expect(data[0]).to be_kind_of Record
+      expect(data.sample).to be_kind_of Record
     end
 
     it 'provides a total method to get the number of total records' do

data/spec/record/last_spec.rb

@@ -0,0 +1,66 @@
+require 'rails_helper'
+
+describe LHS::Record do
+
+  context 'last' do
+
+    context 'for not paginated endpoints' do
+
+      before do
+        class Sector < LHS::Record
+          endpoint 'http://services/sectors'
+        end
+
+        stub_request(:get, "http://services/sectors?limit=1")
+          .to_return(
+            body: [{ number: 1 }, { number: 2 }, { number: 3 }].to_json
+          )
+      end
+
+      it 'returns the last record from the already complete collection' do
+        sector = Sector.last
+        expect(sector).to be_kind_of Sector
+        expect(sector.number).to eq 3
+      end
+    end
+
+    context 'for paginated endpoints' do
+
+      before do
+        class Place < LHS::Record
+          endpoint 'http://datastore/places'
+        end
+
+        stub_request(:get, "http://datastore/places?limit=1")
+          .to_return(
+            body: {
+              items: [
+                { id: 'first-1', company_name: 'Localsearch AG' }
+              ],
+              total: 500,
+              limit: 1,
+              offset: 0
+            }.to_json
+          )
+
+        stub_request(:get, "http://datastore/places?limit=1&offset=499")
+          .to_return(
+            body: {
+              items: [
+                { id: 'last-500', company_name: 'Curious GmbH' }
+              ],
+              total: 500,
+              limit: 1,
+              offset: 0
+            }.to_json
+          )
+      end
+
+      it 'returns the last record from the already complete collection' do
+        place = Place.last
+        expect(place).to be_kind_of Place
+        expect(place.id).to eq 'last-500'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 15.4.1
+  version: 15.5.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -238,6 +238,7 @@ files:
 - lib/lhs/concerns/record/find.rb
 - lib/lhs/concerns/record/find_by.rb
 - lib/lhs/concerns/record/first.rb
+- lib/lhs/concerns/record/last.rb
 - lib/lhs/concerns/record/mapping.rb
 - lib/lhs/concerns/record/model.rb
 - lib/lhs/concerns/record/pagination.rb
@@ -400,6 +401,7 @@ files:
 - spec/record/includes_warning_spec.rb
 - spec/record/item_key_spec.rb
 - spec/record/items_created_key_configuration_spec.rb
+- spec/record/last_spec.rb
 - spec/record/loading_twice_spec.rb
 - spec/record/mapping_spec.rb
 - spec/record/model_name_spec.rb
@@ -455,7 +457,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.3.0
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface for http json services
@@ -592,6 +594,7 @@ test_files:
 - spec/record/includes_warning_spec.rb
 - spec/record/item_key_spec.rb
 - spec/record/items_created_key_configuration_spec.rb
+- spec/record/last_spec.rb
 - spec/record/loading_twice_spec.rb
 - spec/record/mapping_spec.rb
 - spec/record/model_name_spec.rb