lhs 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb3fe085cc83710039d972594c9f7f8d85adbe23
-  data.tar.gz: dd26184f622e4ac0cf4ed64caf80ba767604cb83
+  metadata.gz: 42f49d74b6cae3f84139b46895b5defb5454c184
+  data.tar.gz: 9232b8df9672d9caa11e3f0a3a36f2474ba3386e
 SHA512:
-  metadata.gz: ad8fcbb562a7401d884ebc8104b8b7354466b075245a164623c391ef63a37e8d855dafc30a26b906a9d36820e1edc228d815b1daefb730016f41630bd8c75de4
-  data.tar.gz: b9d6c74ea6abc94fe4dbab55531fc3285a1b76cefc04d6152e29bc3498f93dadffd7e16be4fd921d6073c1918d45c6d7c7b02dc9a45bea4837a67e0aa4cecb2f
+  metadata.gz: 7fbeecfceee4e4c6ebb5f125d427d98cbc1ece337469fb3ae8070de018616e33e5c8923df319863c835367cfcbda6581cc24f22512d3d3b11899bd8531aa801a
+  data.tar.gz: 36520b86b942ac32f0c01191a7e6f418100122f18724b760a0d7f4c7ef630b8c32c3974fa49c714bf6631dc044b5e8448bf8a87ef6be26e7a6f1bb552537d059

data/README.md

@@ -156,6 +156,18 @@ If no record is found, `nil` is returned.
 
 `first!` raises LHC::NotFound if nothing was found.
 
+## Navigate data
+
+After fetching [single](#find-single-records) or [multiple](#find-multiple-records) records you can navigate the received data with ease.
+
+```ruby
+  records = Record.where(color: 'blue')
+  records.collection? # true
+  record = records.first
+  record.item? # true
+  record.parent == records # 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.

data/lib/lhs/collection.rb

@@ -24,6 +24,10 @@ class LHS::Collection < LHS::Proxy
     Collection.new(raw, _data, _record)
   end
 
+  def collection?
+    true
+  end
+
   protected
 
   def method_missing(name, *args, &block)

data/lib/lhs/concerns/data/equality.rb

@@ -0,0 +1,12 @@
+require 'active_support'
+
+class LHS::Data
+
+  module Equality
+    extend ActiveSupport::Concern
+
+    def ==(other)
+      _raw == other.try(:_raw)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require 'active_support'
+
+class LHS::Record
+
+  module Equality
+    extend ActiveSupport::Concern
+
+    def ==(other)
+      _raw == other.try(:_raw)
+    end
+  end
+end

data/lib/lhs/data.rb

@@ -3,6 +3,7 @@ Dir[File.dirname(__FILE__) + '/concerns/data/*.rb'].each { |file| require file }
 
 # Data provides functionalities to accesses information
 class LHS::Data
+  include Equality
   include Json
 
   delegate :instance_methods, :items_key, :limit_key, :total_key, :pagination_key, to: :class
@@ -32,6 +33,14 @@ class LHS::Data
     root
   end
 
+  def parent
+    if _parent && _parent._record
+      _parent._record.new(_parent)
+    else
+      _parent
+    end
+  end
+
   def class
     _root._record
   end
@@ -46,6 +55,14 @@ class LHS::Data
     root_item == self
   end
 
+  def collection?
+    _proxy.is_a? LHS::Collection
+  end
+
+  def item?
+    _proxy.is_a? LHS::Item
+  end
+
   protected
 
   def method_missing(name, *args, &block)

data/lib/lhs/item.rb

@@ -16,6 +16,10 @@ class LHS::Item < LHS::Proxy
 
   delegate :_raw, to: :_data
 
+  def item?
+    true
+  end
+
   protected
 
   def method_missing(name, *args, &_block)

data/lib/lhs/record.rb

@@ -6,6 +6,7 @@ class LHS::Record
   include Chainable
   include Configuration
   include Create
+  include Equality
   include Endpoints
   include Find
   include FindBy
@@ -19,6 +20,7 @@ class LHS::Record
 
   delegate :_proxy, to: :_data
   delegate :_endpoint, to: :_data
+  delegate :select, to: :_data
 
   def initialize(data = nil)
     data = LHS::Data.new({}, nil, self.class) unless data
@@ -42,7 +44,7 @@ class LHS::Record
   protected
 
   def method_missing(name, *args, &block)
-    _data._proxy.send(name, *args, &block)
+    _data.send(name, *args, &block)
   end
 
   def respond_to_missing?(name, include_all = false)

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "5.1.0"
+  VERSION = "5.2.0"
 end

data/spec/data/equality_spec.rb

@@ -0,0 +1,21 @@
+require 'rails_helper'
+
+describe LHS::Data do
+  context 'equality' do
+    before(:each) do
+      class Record < LHS::Record
+        endpoint 'http://local.ch/records'
+      end
+    end
+
+    let(:raw) do
+      { name: 'Steve' }
+    end
+
+    it 'is equal when two data objects share the same raw data' do
+      expect(
+        LHS::Data.new(raw, nil, Record)
+      ).to eq LHS::Data.new(raw, nil, Record)
+    end
+  end
+end

data/spec/data/is_item_or_collection_spec.rb

@@ -0,0 +1,37 @@
+require 'rails_helper'
+
+describe LHS::Data do
+  before(:each) do
+    class Record < LHS::Record
+      endpoint 'http://local.ch/records'
+    end
+  end
+
+  let(:item) do
+    {
+      customer: {
+        addresses: [
+          {
+            first_line: 'Bachstr. 6'
+          }
+        ]
+      }
+    }
+  end
+
+  let(:data) do
+    LHS::Data.new(
+      {
+        href: 'http://local.ch/records',
+        items: [item]
+      }, nil, Record)
+  end
+
+  it 'provides the information which type of proxy data ist' do
+    expect(data.collection?).to eq true
+    expect(data.first.item?).to eq true
+    expect(data.first.customer.item?).to eq true
+    expect(data.first.customer.addresses.collection?).to eq true
+    expect(data.first.customer.addresses.first.item?).to eq true
+  end
+end

data/spec/data/parent_spec.rb

@@ -0,0 +1,36 @@
+require 'rails_helper'
+
+describe LHS::Data do
+  before(:each) do
+    class Record < LHS::Record
+      endpoint 'http://local.ch/records'
+    end
+  end
+
+  let(:item) do
+    {
+      customer: {
+        address: {
+          first_line: 'Bachstr. 6'
+        }
+      }
+    }
+  end
+
+  let(:data) do
+    LHS::Data.new(
+      {
+        href: 'http://local.ch/records',
+        items: [item]
+      }, nil, Record)
+  end
+
+  it 'possible to navigate the parent' do
+    expect(
+      data.first.customer.address.parent
+    ).to eq data.first.customer
+    expect(
+      data.first.customer.address.parent.parent
+    ).to eq data.first
+  end
+end

data/spec/record/equality_spec.rb

@@ -0,0 +1,25 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'equality' do
+    before(:each) do
+      class Record < LHS::Record
+        endpoint 'http://local.ch/records'
+      end
+    end
+
+    let(:raw) do
+      { name: 'Steve' }
+    end
+
+    def record
+      LHS::Record.new LHS::Data.new(raw, nil, Record)
+    end
+
+    it 'is equal when two data objects share the same raw data' do
+      expect(
+        record
+      ).to eq record
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -179,6 +179,7 @@ files:
 - lib/lhs.rb
 - lib/lhs/collection.rb
 - lib/lhs/concerns/collection/internal_collection.rb
+- lib/lhs/concerns/data/equality.rb
 - lib/lhs/concerns/data/json.rb
 - lib/lhs/concerns/item/destroy.rb
 - lib/lhs/concerns/item/save.rb
@@ -190,6 +191,7 @@ files:
 - lib/lhs/concerns/record/configuration.rb
 - lib/lhs/concerns/record/create.rb
 - lib/lhs/concerns/record/endpoints.rb
+- lib/lhs/concerns/record/equality.rb
 - lib/lhs/concerns/record/find.rb
 - lib/lhs/concerns/record/find_by.rb
 - lib/lhs/concerns/record/first.rb
@@ -217,8 +219,11 @@ files:
 - spec/collection/respond_to_spec.rb
 - spec/collection/without_object_items_spec.rb
 - spec/data/collection_spec.rb
+- spec/data/equality_spec.rb
+- spec/data/is_item_or_collection_spec.rb
 - spec/data/item_spec.rb
 - spec/data/merge_spec.rb
+- spec/data/parent_spec.rb
 - spec/data/raw_spec.rb
 - spec/data/respond_to_spec.rb
 - spec/data/root_spec.rb
@@ -286,6 +291,7 @@ files:
 - spec/record/endpoint_misconfiguration_spec.rb
 - spec/record/endpoint_options_spec.rb
 - spec/record/endpoints_spec.rb
+- spec/record/equality_spec.rb
 - spec/record/find_by_spec.rb
 - spec/record/find_each_spec.rb
 - spec/record/find_in_batches_spec.rb
@@ -350,8 +356,11 @@ test_files:
 - spec/collection/respond_to_spec.rb
 - spec/collection/without_object_items_spec.rb
 - spec/data/collection_spec.rb
+- spec/data/equality_spec.rb
+- spec/data/is_item_or_collection_spec.rb
 - spec/data/item_spec.rb
 - spec/data/merge_spec.rb
+- spec/data/parent_spec.rb
 - spec/data/raw_spec.rb
 - spec/data/respond_to_spec.rb
 - spec/data/root_spec.rb
@@ -419,6 +428,7 @@ test_files:
 - spec/record/endpoint_misconfiguration_spec.rb
 - spec/record/endpoint_options_spec.rb
 - spec/record/endpoints_spec.rb
+- spec/record/equality_spec.rb
 - spec/record/find_by_spec.rb
 - spec/record/find_each_spec.rb
 - spec/record/find_in_batches_spec.rb