media_types-serialization 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a38d269c583007ef55081c452341cf6a6f57403ed698102f5757afa18e2841e
-  data.tar.gz: 70bc3b062800391332e97aefae2f95c5dae789a88e9ec6005f217401b2804f57
+  metadata.gz: d00191a59e5d1c2df575e66ade4f41fcf525cb4c1ea5878eeeb8a8cc2b86b3a5
+  data.tar.gz: 27c6b628de9e717955a1d3f9fcc548ac5f3d253cc392ea7cf5d1ed50a1b851fe
 SHA512:
-  metadata.gz: f8a4358361d693f6397d156c9f1466b729a3bac48b00d5b395afade20e9463d0cdcd8a4db660742110bca2320a36a0be3866330c4a7de20c18fd9c3cfc1482f3
-  data.tar.gz: f91169a81c5527068576bd0f200a6178795a3e818951c7fee5748f4cee8374d5e5a3516bb1b9cbbe252f2727856b2ee8eab6889258bb0e9e8d3576f641a74a5a
+  metadata.gz: 7486b226c973e8e2aba5b3ed4c1b0054530717dec192fecd17412a10def1436718337d851dac0defeaae58cd95e1f494811b4bd42faa967c8fba1f8ce27984ee
+  data.tar.gz: 0c88f619c963cc0feb0a8dea38cc567bbd2c541211b245a06fa48a55f6aac221e0d8885ab7253a227f0f90d9f29e9d0791e2d285b0afb7799164416098c30d4a

data/.idea/media_types-serialization.iml

@@ -36,14 +36,14 @@
     <orderEntry type="library" scope="PROVIDED" name="erubi (v1.8.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http_headers-accept (v0.2.1, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http_headers-link (v0.2.1, ruby-2.5.3-p105) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="http_headers-utils (v0.1.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="http_headers-utils (v0.2.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="i18n (v1.5.3, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="loofah (v2.2.3, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="media_types (v0.6.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mini_portile2 (v2.4.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.11.3, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.10.1, ruby-2.5.3-p105) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="oj (v3.7.8, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="oj (v3.7.9, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rack (v2.0.6, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rack-test (v1.1.0, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rails-dom-testing (v2.0.3, ruby-2.5.3-p105) [gem]" level="application" />

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.3.0
+
+- Change `to_link_header` to return a string ready to be used as header
+- Change `header_links` to actually return the links for the header in object form
+
 ## 0.2.0
 
 - Change `method_missing` and base methods for `Base`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (0.2.0)
+    media_types-serialization (0.3.0)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
       http_headers-accept (< 1.0.0)
@@ -49,7 +49,7 @@ GEM
     minitest (5.11.3)
     nokogiri (1.10.1-x64-mingw32)
       mini_portile2 (~> 2.4.0)
-    oj (3.7.8)
+    oj (3.7.9)
     rack (2.0.6)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)

data/README.md

@@ -81,11 +81,12 @@ By default, the media renderer will automatically detect and inject the followin
 - suffix `+xml` if you define `to_xml`
 - type `text/html` if you define `to_html`
 
-The only limitation is that these methods need to be defined on the serializer class directly, and not in a super class.
-
 If you do _not_ define these methods, only the `default` suffix / type will be used, `accepts_html` for the `text/html` 
 content-type.
 
+If you don't define `to_html`, but try to make a serializer output `html`, it will be rendered in the layout at: 
+`serializers/wrapper/html_wrapper.html.erb` (or any other templating extension).
+
 #### Migrations (versions)
 If the serializer can serialize multiple _versions_, you can supply them through `additional_versions: [2, 3]`. A way to
 handle this is via backward migrations, meaning you'll migrate from the current version back to an older version.
@@ -205,6 +206,17 @@ but planned for `xml` as well.
 
 This behaviour can not be turned of as of writing.
 
+### Link header
+
+You can use `to_link_header` to generate a header value for the `Link` header.
+
+```ruby
+entries = @last_media_serializer.to_link_header
+if entries.present?
+  response.header[HEADER_LINK] = entries
+end
+```
+
 ### Related
 
 - [`MediaTypes`](https://github.com/SleeplessByte/media-types-ruby): :gem: Library to create media type definitions, schemes and validations

data/lib/media_types/serialization/base.rb

@@ -5,6 +5,9 @@ require 'uri'
 require 'media_types/serialization/mime_type_support'
 require 'media_types/serialization/migrations_support'
 
+require 'http_headers/link'
+require 'http_headers/utils/list'
+
 module MediaTypes
   module Serialization
     class Base
@@ -22,7 +25,14 @@ module MediaTypes
       end
 
       def to_link_header
-        {}
+        entries = header_links.each_with_index.map do |(rel, opts), index|
+          href = opts.is_a?(String) ? opts : opts.delete(:href)
+          parameters =  { rel: rel }.merge(opts.is_a?(String) ? {} : opts)
+          HttpHeaders::Link::Entry.new("<#{href}>", index: index, parameters: parameters)
+        end
+        return nil unless entries.present?
+
+        HttpHeaders::Utils::List.to_header(entries)
       end
 
       COMMON_DERIVED_CALLERS = [:to_h, :to_hash, :to_json, :to_text, :to_xml, :to_html, :to_body, :extract_self].freeze

data/lib/media_types/serialization/renderer.rb

@@ -12,11 +12,11 @@ module MediaTypes
       self.content_type ||= content_type
 
       if content_type.ends_with?('+json') || Mime::Type.lookup(content_type) == Mime[:json]
-        obj.class.instance_methods(false).include?(:to_json) ? obj.to_json(options) : obj.to_hash.to_json(options)
+        obj.respond_to?(:to_json) ? obj.to_json(options) : obj.to_hash.to_json(options)
       elsif content_type.ends_with?('+xml') || Mime::Type.lookup(content_type) == Mime[:xml]
-        obj.class.instance_methods(false).include?(:to_xml) ? obj.to_xml(options) : obj.to_hash.to_xml(options)
+        obj.respond_to?(:to_xml) ? obj.to_xml(options) : obj.to_hash.to_xml(options)
       elsif Mime::Type.lookup(content_type) == Mime[:html]
-        obj.class.instance_methods(false).include?(:to_html) ? obj.to_html : obj.to_s
+        obj.respond_to?(:to_html) ? obj.to_html : obj.to_s
       else
         obj.to_body(content_type: options.delete(:content_type) || content_type, **options)
       end

data/lib/media_types/serialization/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld