lhs 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3104a36287bf44989ceded81a998fd803298b14c
-  data.tar.gz: 48c62d18f012d593731a5ec8f0ed3c69992a8512
+  metadata.gz: f547564cf8d74f5da48573a93611abfce3435c33
+  data.tar.gz: 6e2fa4f9d0e7fb231398c9e6fb316af72f247fb1
 SHA512:
-  metadata.gz: bc6ac276747f1c18059f7ae120aa7672af03dec3976886175883ac8dbd4faea963b5029ac427eb5a80e9887f64d9c994fcca9210e4e829d5e13af5124d2e01be
-  data.tar.gz: 4cf2de0d3f4965de5c236a48e3a5fc89b033df6cebb88d1de1f23aa3c7cd9f38480afc2091df6d9fe4e90562b83ff16d561da89ddd338599c0bcb73676e3cf61
+  metadata.gz: 128895810bed258280baca8b81c9c3d38f99b5f150e921852272ee053abff994396d45ee0cff617bc4678fcd4144b10612790e879f22cfcf6aedb631345ff656
+  data.tar.gz: dab3d9af9b8d4806ac443c7f2fc55f1f5a8b5692d34233275bb4a6c3750902ee4f0a1d92fac5219dc1f753d6d61c8da5044f7dc2d1abd7abe7e08e3f0b65acb9

data/README.md

@@ -73,7 +73,7 @@ Uses the `:datastore/v2/content-ads/:campaign_id/feedbacks` endpoint.
 If no record is found an error is raised.
 
 ## Proxy
-Instead of mapping data when it arrives from the backend, the proxy makes data accessible when you access it, not when you fetch it. The proxy is used to access data and it is divided in `Collection` and `Item`. 
+Instead of mapping data when it arrives from the backend, the proxy makes data accessible when you access it, not when you fetch it. The proxy is used to access data and it is divided in `Collection` and `Item`.
 
 `find` can also be used to find a single uniqe record with parameters:
 
@@ -104,7 +104,7 @@ If no record is found, `nil` is returned.
 
 ## Batch processing
 
-**Be carefull using methods for batch processing. They could result in a lot of HTTP requests!**
+**Be careful using methods for batch processing. They could result in a lot of HTTP requests!**
 
 `all` fetches all records from the backend by doing multiple requests if necessary.
 
@@ -119,7 +119,7 @@ data.total # 998
 ```ruby
 Feedback.find_each(start: 50, batch_size: 20, params: { has_reviews: true }) do |feedback|
   # Iterates over each record. Starts with record nr. 50 and fetches 20 records each batch.
-  feedback 
+  feedback
   break if feedback.some_attribute == some_value
 end
 ```
@@ -162,6 +162,40 @@ Build and persist new items from scratch are done either with `new` or it's alia
   feedback.save
 ```
 
+## Custom setters and getters
+
+Sometimes it is the case that you want to have your custom getters and setters and convert the data to backend processable format behind the scenes. The initializer will now use custom setter if one is defined
+
+```ruby
+class Feedback < LHS::Record
+  def ratings=(ratings)
+    _raw[:ratings] = ratings.map { |k, v| { name: k, value: v } }
+  end
+end
+
+feedback = Feedback.new(ratings: { quality: 3 }) # <Feedback{:ratings=>[{:name=>:quality, :value=>3}]}>
+feedback.ratings # #<LHS::Data:0x007fc8fa6d4050 ... @_raw=[{:name=>:quality, :value=>3}]>
+
+```
+
+If you have an accompanying getter the whole data manipulation would be internal only.
+
+```ruby
+class Feedback < LHS::Record
+  def ratings=(ratings)
+    _raw[:ratings] = ratings.map { |k, v| { name: k, value: v } }
+  end
+
+  def ratings
+    Hash[_raw[:ratings].map { |r| [r[:name], r[:value]] }]
+  end
+end
+
+feedback = Feedback.new(ratings: { quality: 3 }) # <Feedback{:ratings=>[{:name=>:quality, :value=>3}]}>
+feedback.ratings # {:quality=>3}
+
+```
+
 ## Include linked resources
 
 When fetching records, you can specify in advance all the linked resources that you want to include in the results. With `includes`, LHS ensures that all matching and explicitly linked resources are loaded and merged.
@@ -191,17 +225,17 @@ The implementation is heavily influenced by [http://guides.rubyonrails.org/activ
 ```ruby
   # list of includes
   claims = Claims.includes(:localch_account, :entry).where(place_id: 'huU90mB_6vAfUdVz_uDoyA')
-  
+
   # array of includes
   claims = Claims.includes([:localch_account, :entry]).where(place_id: 'huU90mB_6vAfUdVz_uDoyA')
-  
+
   # Two-level with array of includes
   feedbacks = Feedback.includes(campaign: [:entry, :user]).where(has_reviews: true)
 ```
 
 ### Known LHS::Records are used to request linked resources
 
-When including linked resources with `includes`, known/defined services and endpoints are used to make those requests. 
+When including linked resources with `includes`, known/defined services and endpoints are used to make those requests.
 That also means that options for endpoints of linked resources are applied when requesting those in addition.
 This allows you to include protected resources (e.g. OAuth) as endpoint options for oauth authentication get applied.
 
@@ -222,7 +256,7 @@ class Place < LHS::Record
 
 end
 
-Favorite.includes(:place).where(user_id: current_user.id) 
+Favorite.includes(:place).where(user_id: current_user.id)
 # Will include places and applies endpoint options to authenticate the request.
 ```
 

data/lib/lhs/record.rb

@@ -21,15 +21,7 @@ class LHS::Record
     data = LHS::Data.new({}, nil, self.class) unless data
     data = LHS::Data.new(data, nil, self.class) unless data.is_a?(LHS::Data)
     define_singleton_method(:_data) { data }
-    instance_data =
-      if data._proxy.is_a?(LHS::Item) && data._raw.is_a?(Hash)
-        data._raw
-      elsif data._proxy.is_a?(LHS::Collection) && data._raw.is_a?(Hash)
-        data._raw.fetch(:items, [])
-      else
-        data._raw
-      end
-    instance_variable_set('@data', instance_data)
+    consider_custom_setters
   end
 
   def as_json(options = nil)
@@ -40,6 +32,10 @@ class LHS::Record
     new(data)
   end
 
+  def inspect
+    "<#{self.class}#{_data._raw}>"
+  end
+
   protected
 
   def method_missing(name, *args, &block)
@@ -49,4 +45,23 @@ class LHS::Record
   def respond_to_missing?(name, include_all = false)
     _data.respond_to_missing?(name, include_all)
   end
+
+  private
+
+  def consider_custom_setters
+    return if !instance_data.is_a?(Hash)
+    instance_data.each do |k, v|
+      if public_methods.include?("#{k}=".to_sym)
+        send("#{k}=", v)
+      end
+    end
+  end
+
+  def instance_data
+    if _data._proxy.is_a?(LHS::Collection) && _data._raw.is_a?(Hash)
+      _data._raw.fetch(:items, [])
+    else
+      _data._raw
+    end
+  end
 end

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/spec/record/new_spec.rb

@@ -22,7 +22,44 @@ describe LHS::Record do
     end
 
     it 'builds new items also with keys containing dashes' do
-      Feedback.new('some-key' => [])
+      feedback = Feedback.new('some-key' => [])
+      expect(feedback._raw[:'some-key']).to eq([])
+    end
+
+    context 'custom setters' do
+      before(:each) do
+        class Feedback
+          def ratings=(ratings)
+            _raw[:ratings] = ratings.map { |k, v| { name: k, value: v } }
+          end
+        end
+      end
+
+      it 'are used by initializer' do
+        feedback = Feedback.new(ratings: { a: 1, b: 2 })
+        expect(feedback.ratings.raw).to eq([{ name: :a, value: 1 }, { name: :b, value: 2 }])
+      end
+
+      it 'can be used directly to change raw data' do
+        feedback = Feedback.new(ratings: { a: 1 })
+        feedback.ratings = { z: 3 }
+        expect(feedback.ratings.first.name).to eq :z
+      end
+
+      context 'and custom getters' do
+        before(:each) do
+          class Feedback
+            def ratings
+              Hash[_raw[:ratings].map { |r| [r[:name], r[:value]] }]
+            end
+          end
+        end
+
+        it 'uses custom getters to show data for exploration' do
+          feedback = Feedback.new(ratings: { a: 1, b: 2 })
+          expect(feedback.ratings).to eq(a: 1, b: 2)
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -310,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 1.9.2
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface to use http backend