media_types-serialization 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f668e10a02f800afc30da2c1438f99e4a50fb2b726cc829d490998f2f1997933
-  data.tar.gz: f0d711b09c45a03c7cfbac9238ac6f1e6f6f24b701d631f236b1986f19d80ca2
+  metadata.gz: d53689a0c81861b7305fc606a2b73b7866e4b46915284a716951735926b5bb73
+  data.tar.gz: 29add50810aa2bf8b3792d38eebd50eca96570c716a33be6ef58a2f64813be81
 SHA512:
-  metadata.gz: 9f6e2dec7c6409279f226dc0c6b3dff609273bd72330f055397c0e2f7be54eab5b032d33192590486f898d9cca3f8cedd69c6c1a519e104a56942a40ae4b2565
-  data.tar.gz: bda722326eca550e19cc8ab656896423f092a8b8c14436a37b4e51c88f0c5191b85a3b682dc3ead1c9e38b277e5a233c4741eb6cddeff5af68b89c3ed0a22230
+  metadata.gz: 56db0c8b8f39b108e80d028459b0fc7e788bc9cbfd3b7a1e26dfbab993883d7b19735f2d638e8f17edfbcfb9837f610f30ea46ec61bf84c4c141f45000ae0c36
+  data.tar.gz: 2985c51bc0f5b59df56d11fe665dc5be479fa5cf494dbd8edf5e57961464bb5e413f82af8e9e867557bb15dd715542aa5f6f10cd9cd9fb12028899fa00d11bf8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.3.6
+
+- 🐛 Fix issue with `override_detail` of `Problem`
+
 ## 1.3.5
 
 - 🐛 Upgrade media-types library so Ruby 2.5 and 2.6 work again

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (1.3.5)
+    media_types-serialization (1.3.6)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
       media_types (>= 2.1.1, < 3.0.0)
@@ -75,7 +75,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.12.3-x86_64-linux)
       racc (~> 1.4)
-    oj (3.13.2)
+    oj (3.13.4)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)

data/README.md

@@ -1,6 +1,6 @@
 # MediaTypes::Serialization
 
-[![Build Status: master](https://travis-ci.com/XPBytes/media_types-serialization.svg)](https://travis-ci.com/XPBytes/media_types-serialization)
+[![Build Status](https://github.com/XPBytes/media_types-serialization/actions/workflows/ci.yml/badge.svg)](https://github.com/XPBytes/media_types-serialization/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/media_types-serialization.svg)](https://badge.fury.io/rb/media_types-serialization)
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
@@ -16,11 +16,15 @@ gem 'media_types-serialization'
 
 And then execute:
 
-    $ bundle
+```shell
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install media_types-serialization
+```shell
+gem install media_types-serialization
+```
 
 ## Usage
 
@@ -221,7 +225,7 @@ BookSerializer.serialize(book, BookValidator.version(3), context: controller)
 
 There are convenience methods for serializing arrays of objects based on a template.
 
-#### Indexes
+#### Indexes (index based collections)
 
 An index is a collection of urls that point to members of the array.
 The index method automatically generates it based on the `self` links defined in the default view (`view: nil`) of the given version.
@@ -266,7 +270,8 @@ BookSerializer.serialize([book], BookValidator.view(:index).version(3), context:
 
 ##### How to validate?
 
-The `index` dsl does _not_ exist in the validation gem. This is how you validate indices:
+The `index` dsl does _not_ exist in the validation gem.
+This is how you validate indices:
 
 ```ruby
 class BookValidator
@@ -283,7 +288,7 @@ class BookValidator
       version 3 do
         attribute :books do
           link :self
-          
+
           collection :_index, allow_empty: true do
             attribute :href, String
           end
@@ -334,7 +339,7 @@ class BookValidator
       version 3 do
         attribute :books do
           link :self
-          
+
           collection :_index, allow_empty: true do
             attribute :href, String
             attribute :isbn, AllowNil(String)
@@ -346,7 +351,7 @@ class BookValidator
 end
 ```
 
-#### Collections
+#### Collections (embedding collections)
 
 A collection inlines the member objects.
 The collection method automatically generates it based on the default view of the same version.
@@ -403,7 +408,8 @@ BookSerializer.serialize([book], BookValidator.view(:collection).version(3), con
 #    }
 ```
 
-The `collection` dsl is _not_ the same as the one in the validation gem. This is how you could validate collections:
+The `collection` dsl is _not_ the same as the one in the validation gem.
+This is how you could validate collections:
 
 ```ruby
 class BookValidator
@@ -420,7 +426,7 @@ class BookValidator
       version 3 do
         attribute :books do
           link :self
-          
+
           collection :_embedded, allow_empty: true do
             link :self
 
@@ -567,7 +573,7 @@ end
 ### Remapping media type identifiers
 
 Sometimes you already have old clients using an `application/json` media type identifier when they do requests.
-While this is not a good practise as this makes it hard to add new fields or remove old ones, this library has support for migrating away:
+While this is not a good practice as this makes it hard to add new fields or remove old ones, this library has support for migrating away:
 
 ```ruby
 class BookSerializer < MediaTypes::Serialization::Base
@@ -584,7 +590,7 @@ class BookSerializer < MediaTypes::Serialization::Base
       attribute :description, obj.description if version >= 2
     end
   end
-  
+
   # applicaton/vnd.acme.book+json
   output version: nil do |obj, version, context|
     attribute :book do
@@ -605,7 +611,7 @@ class BookSerializer < MediaTypes::Serialization::Base
     # Make sure not to save here but only save in the controller
     book
   end
-  
+
   # applicaton/vnd.acme.book.create+json
   input view: :create, version: nil do |json, version, context|
     book = Book.new
@@ -618,7 +624,8 @@ class BookSerializer < MediaTypes::Serialization::Base
   input_alias 'application/json', view: :create # maps application/json to to applicaton/vnd.acme.book.create+json
 ```
 
-Validation will be done using the remapped validator. Aliasses map to version `nil`. It is not possible to configure this version.
+Validation will be done using the remapped validator. Aliasses map to version `nil`.
+It is not possible to configure this version.
 
 ### HTML
 
@@ -699,12 +706,13 @@ class BookController < ActionController::API
 end
 ```
 
-The exception you specified will be rescued by the controller and will be displayed to the user along with a link to the shared wiki page for that error type. Feel free to add instructions there on how clients should solve this problem.
+The exception you specified will be rescued by the controller and will be displayed to the user along with a link to the shared wiki page for that error type.
+Feel free to add instructions there on how clients should solve this problem.
 You can find more information at: [https://docs.delftsolutions.nl/wiki/Error](https://docs.delftsolutions.nl/wiki/Error)
 If you want to override this url you can use the `problem_output.url(href)` function.
 
 By default the `message` property of the error is used to fill the `details` field.
-You can override this by using the `problem_output.override_details(description, lang:)` function.
+You can override this by using the `problem_output.override_detail(description, lang:)` function.
 
 Custom attributes can be added using the `problem_output.attribute(name, value)` function.
 

data/lib/media_types/problem.rb

@@ -31,7 +31,7 @@ module MediaTypes
 
     def override_detail(detail, lang:)
       raise 'Unable to override detail message without having a title in the same language.' unless translations[lang]
-      translations[lang][:detail] = title
+      translations[lang][:detail] = detail
     end
 
     def attribute(name, value)

data/lib/media_types/serialization/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '1.3.5'.freeze
+    VERSION = '1.3.6'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack