media_types-serialization 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7c8556cbaffc26158c2b8b0cadef6e1544f532a47e03d6580b9518416240f2
-  data.tar.gz: 49a6897feba02f920cce9d32ee6b4ea4f5838446404ce2bdf1d08b52ba4f1ef5
+  metadata.gz: 5d52037ca66b6864b8f20026b58fef6053f12ad870d9e6c2557395244b820d2a
+  data.tar.gz: 0c01cedd3e14c127a791aeedd78e8674a9fefabd1e3d7768921bbb731ce93c85
 SHA512:
-  metadata.gz: 2400a94296b4f57e386b1a7b115511873ed449b58a8148b0bc64114942a5720db2270af8f1d7878e284aa6b2c58f713b0f7dd6ba297278132f7f496e18aaa2b7
-  data.tar.gz: d93e89709b0d19111b6d3e0cfc1608fc386611ae80132df228af8c27ed43b30f4a739963b5d492e24184e83db4f86baac001834b30a0297e53577ce662f42c7c
+  metadata.gz: 21aecc3516b00a3dcd9c02ac1389211858dedbb1e38876f0416c0fe03e69f76e213e20c282b564b52053fb6f81d71ee3af8091bdf0e371fd65efc01f958be762
+  data.tar.gz: 772be730a9c94e6ab4201f7ddc11daebfbae8a9368185d2ce5d5a0e6c2e43d13f368bcf2071c4b62ead4b714f4559986066455a7cab3b75eab2f4bbe7bdcaf0e

data/.idea/media_types-serialization.iml

@@ -37,7 +37,7 @@
     <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.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="i18n (v1.6.0, 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" />

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.5.1
+
+- Correctly expose `current_media_type` and `current_view`
+- Fix cyclic requires
+- Add documentation for overwriting wrappers
+
 ## 0.5.0
 
 - Change wrappers to extend from `SimpleDelegator`

data/Gemfile.lock

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

data/README.md

@@ -196,13 +196,27 @@ class Book::CoverHtmlSerializer < MediaTypes::Serialization::Base
 end
 ```
 
+You can change the default `wrapper` / `to_html` implementation by setting:
+```ruby
+::MediaTypes::Serialization.html_wrapper_layout = '/path/to/wrapper/layout'
+```
+
 ### Wrapping output
 
 By convention, `index` views are wrapped in `_index: [items]`, `collection` views are wrapped in `_embedded: [items]`
 and `create` / no views are wrapped in `[ROOT_KEY]: item`. This is currently only enabled for `to_json` serialization
 but planned for `xml` as well.
 
-This behaviour can not be turned of as of writing.
+This behaviour can not be turned of as of writing. However, you may _overwrite_ this behaviour via:
+
+- `self.root_key(view:)`: to define the root key for a specific `view`
+- `self.wrap(serializer, view: nil)`: to define the wrapper for a specific `view` and/or `serializer`. For example, if
+  you never want to wrap anything, you could define:
+  ```ruby
+  def self.wrap(serializer, view: nil)
+    serializer
+  end
+  ```
 
 ### Link header
 

data/lib/media_types/serialization/base.rb

@@ -16,7 +16,7 @@ module MediaTypes
       include MigrationsSupport
       include WrapperSupport
 
-      attr_accessor :serializable
+      attr_reader :current_media_type, :current_view, :serializable
 
       def initialize(serializable, media_type:, view: nil, context:)
         self.context = context
@@ -68,19 +68,20 @@ module MediaTypes
         extract_links(view: view)
       end
 
+      def set(serializable)
+        self.serializable = serializable
+        self
+      end
+
       protected
 
-      attr_accessor :context, :current_media_type, :current_view
+      attr_accessor :context
+      attr_writer :current_media_type, :current_view, :serializable
 
       def extract_links(view: current_view)
         {}
       end
 
-      def set(serializable)
-        self.serializable = serializable
-        self
-      end
-
       def extract(extractable, *keys)
         return {} unless keys.present?
         extractable.slice(*keys)

data/lib/media_types/serialization/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
   end
 end

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

@@ -4,8 +4,6 @@ require 'delegate'
 
 require 'action_controller'
 
-require 'media_types/serialization/base'
-
 module MediaTypes
   module Serialization
     module Wrapper

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

@@ -4,15 +4,13 @@ require 'delegate'
 
 require 'active_support/core_ext/string/inflections'
 
-require 'media_types/serialization/base'
-
 module MediaTypes
   module Serialization
     module Wrapper
       class MediaCollectionWrapper < SimpleDelegator
 
         delegate :to_json, to: :to_hash
-        delegate :class, to: :__getobj__
+        delegate :class, :set, :current_view, :current_media_type, to: :__getobj__
 
         def initialize(serializer)
           __setobj__ serializer
@@ -48,17 +46,13 @@ module MediaTypes
 
         def item_hash(item)
           __getobj__.instance_exec do
-            set(item).send(:to_hash)
+            set(item).to_hash
           end
         end
 
         def root_key(view: current_view)
           __getobj__.class.root_key(view: view)
         end
-
-        def current_view
-          __getobj__.send(:current_view)
-        end
       end
     end
   end

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

@@ -4,15 +4,13 @@ require 'delegate'
 
 require 'active_support/core_ext/string/inflections'
 
-require 'media_types/serialization/base'
-
 module MediaTypes
   module Serialization
     module Wrapper
       class MediaIndexWrapper < SimpleDelegator
 
         delegate :to_json, to: :to_hash
-        delegate :class, to: :__getobj__
+        delegate :class, :set, :current_view, :current_media_type, to: :__getobj__
 
         def initialize(serializer)
           __setobj__ serializer
@@ -55,10 +53,6 @@ module MediaTypes
         def root_key(view: current_view)
           __getobj__.class.root_key(view: view)
         end
-
-        def current_view
-          __getobj__.send(:current_view)
-        end
       end
     end
   end

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

@@ -4,15 +4,13 @@ require 'delegate'
 
 require 'active_support/core_ext/string/inflections'
 
-require 'media_types/serialization/base'
-
 module MediaTypes
   module Serialization
     module Wrapper
       class MediaObjectWrapper < SimpleDelegator
 
         delegate :to_json, to: :to_hash
-        delegate :class, to: :__getobj__
+        delegate :class, :set, :current_view, :current_media_type, to: :__getobj__
 
         mattr_accessor :auto_unwrap_klazzes
 
@@ -51,14 +49,6 @@ module MediaTypes
         def root_key(view: current_view)
           __getobj__.class.root_key(view: view)
         end
-
-        def set(new_serializable)
-          __getobj__.send(:set, new_serializable)
-        end
-
-        def current_view
-          __getobj__.send(:current_view)
-        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack