media_types-serialization 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad21aa89e0b5f448619f80f72462476021515c16c95d50dc269b2a8aa889ca45
-  data.tar.gz: d723be10de6a6eecdb3b5b7e540db46b02ca0b5f338961bd0973ffaa957e7fe8
+  metadata.gz: d8bff701e51e128e250514cb3b951409907496d54ac1c9bbfdcea02c269d0c09
+  data.tar.gz: 519cf91eb85882e2f37b4a7f500025f96ce6551bda4798e2c4d9f8ca7d9813b4
 SHA512:
-  metadata.gz: 612498a254d26d0288fcd035fbf18e6a84c9522069885fc30edba8898a3abc300716a2fd371d840fa65a688a9a089823d93b3aadc109e93ca052aa86d8299525
-  data.tar.gz: cffa94a6a3de91e71f75bd84eb7c30b8090dfdf45e179302ed2d479dea99038deee36c002af48d1a7ad7a9eeaf070a16171a92dfe6b0eb9cbf804ee6f9562f32
+  metadata.gz: f69cb4908449138b1c0f6aa080df5ed9401d2ee344356199843ca92543c2c5b2539dbb2b7e4a342a8d583d7a6ac054f2e45c345a4a663178473cdc2a2bd25d1e
+  data.tar.gz: 95345bbf3f598c613926b2531496ee89a99c6bc16199bb025e033d9d065b4d34ab97efc63d03f43a12cf63e55ce8acb760f4ace0d8587e889ce2f5375d5ef060

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.4.0
+
+- Change `extract_links` to `extract_links(view:)` and mimic `header_links(view:)`
+- Use `extract_links` in `index` and `collection` wrapper output
+
 ## 0.3.2
 
 - Rename `collect_links` to `header_links` to actually expose the links

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (0.3.2)
+    media_types-serialization (0.4.0)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
       http_headers-accept (< 1.0.0)

data/README.md

@@ -60,9 +60,7 @@ class Book < ApplicationRecord
       { href: context.api_book_url(serializable) }
     end
 
-    private
-
-    def extract_links
+    def extract_links(view:)
       { 
         'self': extract_self,
         'signatures': { href: context.api_book_signatures_url(serializable) }
@@ -217,6 +215,9 @@ if entries.present?
 end
 ```
 
+If you want the link header to be different from the `_links`, you can implement `header_links(view:)` next to 
+`extract_links(view:)`. This will be called by the `to_link_header` function.
+
 ### 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

@@ -60,19 +60,18 @@ module MediaTypes
         super
       end
 
+      def header_links(view: current_view)
+        extract_links(view: view)
+      end
+
       protected
 
       attr_accessor :context, :current_media_type, :current_view
 
-      def extract_links
+      def extract_links(view: current_view)
         {}
       end
 
-      # noinspection RubyUnusedLocalVariable
-      def header_links(view: current_view)
-        extract_links
-      end
-
       def set(serializable)
         self.serializable = serializable
         self

data/lib/media_types/serialization/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
   end
 end

data/lib/media_types/serialization/wrapper/media_collection_wrapper.rb

@@ -22,7 +22,7 @@ module MediaTypes
         def to_hash
           { Wrapper::RootKey.new(__getobj__.class).pluralize => {
             '_embedded': auto_wrap_serializable.map(&method(:item_hash)),
-            '_links': {}
+            '_links': extract_links
           } }
         end
         alias to_h to_hash
@@ -32,6 +32,13 @@ module MediaTypes
           {}
         end
 
+        protected
+
+        def extract_links(view: current_view)
+          return __getobj__.send(:extract_links, view: view) if serializable && ::MediaTypes::Serialization.collect_links_for_collection
+          {}
+        end
+
         private
 
         def auto_wrap_serializable

data/lib/media_types/serialization/wrapper/media_index_wrapper.rb

@@ -22,7 +22,7 @@ module MediaTypes
         def to_hash
           { Wrapper::RootKey.new(__getobj__.class).pluralize => {
             '_index': auto_wrap_serializable.map(&method(:item_hash)),
-            '_links': {}
+            '_links': extract_links
           } }
         end
         alias to_h to_hash
@@ -32,6 +32,13 @@ module MediaTypes
           {}
         end
 
+        protected
+
+        def extract_links(view: current_view)
+          return __getobj__.send(:extract_links, view: view) if serializable && ::MediaTypes::Serialization.collect_links_for_index
+          {}
+        end
+
         private
 
         def auto_wrap_serializable

data/lib/media_types/serialization/wrapper/media_object_wrapper.rb

@@ -30,6 +30,13 @@ module MediaTypes
           {}
         end
 
+        protected
+
+        def extract_links(view: current_view)
+          return __getobj__.send(:extract_links, view: view) if serializable
+          {}
+        end
+
         private
 
         AUTO_UNWRAP_KLAZZES = [Array, defined?(ActiveRecord) ? ActiveRecord::Relation : nil].compact.freeze

metadata

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