lhs 11.1.0 → 11.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abf5de2dde8813263d07b049e423c569bf0e187c
-  data.tar.gz: 2bf40b2701cfa58783ce975c260da734a8952b1c
+  metadata.gz: ec9e7eae2816a09a270575802d332cf27a0a4ae5
+  data.tar.gz: fee348a432bdace92a25a94a48efc319d0ed848d
 SHA512:
-  metadata.gz: e87e3813fd4afa5c1aa2a9053745e473936ce7262e3bcba83d75032a3261c9ecc045fa70d4a8350428a754baf1dcc3d5c0c5439ab1121ae37da30c447ead8cbd
-  data.tar.gz: 78c83def6fbe617c6d1c5c7bcb91d8ebe3ca3fdd1b092eb8e51166b8fec51699cbbbe6ffdf3297cb7ff7c364fe11191d6e7a02a98ad05f56b6e7819daa7bb217
+  metadata.gz: e7e1fd9491380f0bf1cf439d4e895e515160922bcf10df80c92b542b50b0eed85e6d78a5f3a78459db26ab098a252aad52f7f8e3f7b1a4c6d78e6bb66c1ab982
+  data.tar.gz: 75201af82683c6d58d8f7270f8b309ada0a6d81ea4c37bd9ebaebd445614813dcf82e9cbfa8f279291aa1bc64ad7f90eca9f61506163b223a6ef545cd87b176e

data/README.md

@@ -771,6 +771,19 @@ You can also access those nested errors like:
 @customer.address.street.errors
 ```
 
+### Translation of validation errors
+
+Just like Activerecord, LHS tries to translate validation error messages.
+If a translation exists for one of the following translation keys, LHS will take a translated error (also in the following order) rather than the plain error message/code:
+
+```ruby
+lhs.errors.records.customer.attributes.name.unsupported_property_value
+lhs.errors.records.customer.unsupported_property_value
+lhs.errors.messages.unsupported_property_value
+lhs.errors.attributes.name.unsupported_property_value
+lhs.errors.fallback_message
+```
+
 ### Know issue with `ActiveModel::Validations`
 If you are using `ActiveModel::Validations` and add errors to the LHS::Record instance - as described above - then those errors will be overwritten by the errors from `ActiveModel::Validations` when using `save`  or `valid?`. [Open issue](https://github.com/local-ch/lhs/issues/159)
 

data/lib/lhs/concerns/item/save.rb

@@ -20,7 +20,7 @@ class LHS::Item < LHS::Proxy
         apply_default_creation_options(options, url, data)
       )
     rescue LHC::Error => e
-      self.errors = LHS::Errors::Base.new(e.response)
+      self.errors = LHS::Errors::Base.new(e.response, record)
       raise e
     end
 
@@ -34,19 +34,18 @@ class LHS::Item < LHS::Proxy
     end
 
     def create_and_merge_data!(options)
-      direct_response_data = record_for_persistance.request(options)
+      direct_response_data = record.request(options)
       _data.merge_raw!(direct_response_data)
       response_headers = direct_response_data._request.response.headers
       if response_headers && response_headers['Location']
-        location_data = record_for_persistance.request(options.merge(url: response_headers['Location'], method: :get, body: nil))
+        location_data = record.request(options.merge(url: response_headers['Location'], method: :get, body: nil))
         _data.merge_raw!(location_data)
       end
       true
     end
 
     def endpoint_for_persistance(data, options)
-      record_for_persistance
-        .find_endpoint(merge_data_with_options(data, options))
+      record.find_endpoint(merge_data_with_options(data, options))
     end
 
     def merge_data_with_options(data, options)
@@ -57,10 +56,6 @@ class LHS::Item < LHS::Proxy
       end
     end
 
-    def record_for_persistance
-      _data.class
-    end
-
     def url_for_persistance!(options, data)
       return href if href.present?
       endpoint = endpoint_for_persistance(data, options)

data/lib/lhs/concerns/item/update.rb

@@ -9,14 +9,14 @@ class LHS::Item < LHS::Proxy
     def update(params, options = nil)
       update!(params, options)
     rescue LHC::Error => e
-      self.errors = LHS::Errors::Base.new(e.response)
+      self.errors = LHS::Errors::Base.new(e.response, record)
       false
     end
 
     def update!(params, options = {})
       options ||= {}
-      _data.merge_raw!(LHS::Data.new(params, _data.parent, _data.class))
-      response_data = _data.class.request(
+      _data.merge_raw!(LHS::Data.new(params, _data.parent, record))
+      response_data = record.request(
         options.merge(
           method: :post,
           url: href,

data/lib/lhs/concerns/item/validation.rb

@@ -16,7 +16,7 @@ class LHS::Item < LHS::Proxy
       run_validation!(record, options, url, params)
       true
     rescue LHC::Error => e
-      self.errors = LHS::Errors::Base.new(e.response)
+      self.errors = LHS::Errors::Base.new(e.response, record)
       false
     end
     alias validate valid?
@@ -51,7 +51,7 @@ class LHS::Item < LHS::Proxy
 
     def validation_endpoint
       endpoint = endpoint_from_link if _data.href # take embeded first
-      endpoint ||= _data._record.find_endpoint(_data._raw)
+      endpoint ||= record.find_endpoint(_data._raw)
       validates = endpoint.options && endpoint.options.fetch(:validates, false)
       raise 'Endpoint does not support validations!' unless validates
       endpoint

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

@@ -11,11 +11,11 @@ class LHS::Proxy
 
     def initialize(data)
       super(data)
-      self.errors = LHS::Errors::Base.new
+      self.errors = LHS::Errors::Base.new(nil, record)
     end
 
     def errors
-      @errors ||= LHS::Errors::Base.new
+      @errors ||= LHS::Errors::Base.new(nil, record)
     end
   end
 end

data/lib/lhs/errors/base.rb

@@ -3,10 +3,11 @@ module LHS::Errors
   class Base
     include Enumerable
 
-    attr_reader :messages, :message, :raw
+    attr_reader :messages, :message, :raw, :record
 
-    def initialize(response = nil)
+    def initialize(response = nil, record = nil)
       @raw = response.body if response
+      @record = record
       @messages = messages_from_response(response)
       @message = message_from_response(response)
     rescue JSON::ParserError
@@ -21,9 +22,9 @@ module LHS::Errors
     alias has_key? include?
     alias key? include?
 
-    def add(attribute, message = :invalid, _options = {})
+    def add(attribute, message = :invalid, options = {})
       self[attribute]
-      messages[attribute] << message
+      messages[attribute] << generate_message(attribute, message, options)
     end
 
     def get(key)
@@ -31,7 +32,7 @@ module LHS::Errors
     end
 
     def set(key, value)
-      messages[key] = value
+      messages[key] = generate_message(key, value)
     end
 
     delegate :delete, to: :messages
@@ -41,7 +42,7 @@ module LHS::Errors
     end
 
     def []=(attribute, error)
-      self[attribute] << error
+      self[attribute] << generate_message(attribute, error)
     end
 
     def each
@@ -76,7 +77,27 @@ module LHS::Errors
     def add_error(messages, key, value)
       key = key.to_sym
       messages[key] ||= []
-      messages[key].push(value)
+      messages[key].push(generate_message(key, value))
+    end
+
+    def generate_message(attribute, message, _options = {})
+      find_translated_error_message(attribute, message) || message
+    end
+
+    def find_translated_error_message(attribute, message)
+      record_name = record.model_name.name.underscore
+      normalized_attribute = attribute.to_s.underscore
+      normalized_message = message.to_s.underscore
+      [
+        ['lhs', 'errors', 'records', record_name, 'attributes', normalized_attribute, normalized_message],
+        ['lhs', 'errors', 'records', record_name, normalized_message],
+        ['lhs', 'errors', 'messages', normalized_message],
+        ['lhs', 'errors', 'attributes', normalized_attribute, normalized_message],
+        ['lhs', 'errors', 'fallback_message']
+      ].detect do |path|
+        key = path.join('.')
+        return I18n.translate(key) if I18n.exists?(key)
+      end
     end
 
     def parse_messages(json)

data/lib/lhs/proxy.rb

@@ -16,6 +16,10 @@ class LHS::Proxy
     self._loaded = false
   end
 
+  def record
+    _data.class
+  end
+
   def load!(options = nil)
     return self if _loaded
     reload!(options)

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "11.1.0"
+  VERSION = "11.2.0"
 end

data/spec/item/translate_errors_spec.rb

@@ -0,0 +1,197 @@
+require 'rails_helper'
+
+describe LHS::Item do
+  before(:each) do
+    class Record < LHS::Record
+      endpoint 'http://dataste/records'
+    end
+
+    stub_request(:post, "http://dataste/records")
+      .to_return(
+        status: 400,
+        body: {
+          field_errors: [{
+            "code" => "UNSUPPORTED_PROPERTY_VALUE",
+            "path" => ["name"]
+          }]
+        }.to_json
+      )
+
+    I18n.reload!
+    I18n.backend.store_translations(:en, YAML.safe_load(translation)) if translation.present?
+  end
+
+  let(:errors) { Record.create(name: 'Steve').errors }
+
+  context 'detailed error translation for record and attribute' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            records:
+              record:
+                attributes:
+                  name:
+                    unsupported_property_value: 'This value is not supported'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is not supported']
+    end
+  end
+
+  context 'error translation for record' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            records:
+              record:
+                unsupported_property_value: 'This value is unfortunately not supported'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is unfortunately not supported']
+    end
+  end
+
+  context 'error translation for message' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is sadly not supported']
+    end
+  end
+
+  context 'error translation for attributes' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is not supported – bummer']
+    end
+  end
+
+  context 'error translation for fallback message' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            fallback_message: 'This value is wrong'
+      }
+    end
+
+    it 'translates errors automatically when they are around' do
+      expect(errors[:name]).to eq ['This value is wrong']
+    end
+  end
+
+  context 'detailed record attribute over other translations' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+            records:
+              record:
+                unsupported_property_value: 'This value is unfortunately not supported'
+                attributes:
+                  name:
+                    unsupported_property_value: 'This value is not supported'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is not supported']
+    end
+  end
+
+  context 'record translations over global messages, attributes and fallback' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+            records:
+              record:
+                unsupported_property_value: 'This value is unfortunately not supported'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is unfortunately not supported']
+    end
+  end
+
+  context 'global message translation over attributes and fallback' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+            messages:
+              unsupported_property_value: 'This value is sadly not supported'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is sadly not supported']
+    end
+  end
+
+  context 'global attributes over fallback' do
+    let(:translation) do
+      %q{
+        lhs:
+          errors:
+            fallback_message: 'This value is wrong'
+            attributes:
+              name:
+                unsupported_property_value: 'This value is not supported – bummer'
+      }
+    end
+
+    it 'takes detailed record attribute over other translations' do
+      expect(errors[:name]).to eq ['This value is not supported – bummer']
+    end
+  end
+
+  context 'no translation' do
+    let(:translation) do
+      %q{}
+    end
+
+    it 'takes no translation but keeps on storing the error message/code' do
+      expect(errors[:name]).to eq ['UNSUPPORTED_PROPERTY_VALUE']
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 11.1.0
+  version: 11.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -307,6 +307,7 @@ files:
 - spec/item/respond_to_spec.rb
 - spec/item/save_spec.rb
 - spec/item/setter_spec.rb
+- spec/item/translate_errors_spec.rb
 - spec/item/update_spec.rb
 - spec/item/validation_spec.rb
 - spec/pagination/pages_left_spec.rb
@@ -471,6 +472,7 @@ test_files:
 - spec/item/respond_to_spec.rb
 - spec/item/save_spec.rb
 - spec/item/setter_spec.rb
+- spec/item/translate_errors_spec.rb
 - spec/item/update_spec.rb
 - spec/item/validation_spec.rb
 - spec/pagination/pages_left_spec.rb