media_types-serialization 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f81671e23c69f1315a0bd9d07ad55ddf0d5e9f2a2c46f1597a905525bcb19bef
-  data.tar.gz: 3dc428be52dafa3a00538b947f4126cb884dd1a6ae1613fe0e6e2dd1e307177e
+  metadata.gz: 8a38d269c583007ef55081c452341cf6a6f57403ed698102f5757afa18e2841e
+  data.tar.gz: 70bc3b062800391332e97aefae2f95c5dae789a88e9ec6005f217401b2804f57
 SHA512:
-  metadata.gz: 276c8eed325348f3fd7b270e363349698d1ca94fd68b3804e74ff0c1f52791dc6215f92be8837588eca805fe7437ebac312e636df6e8c014bd86739334054572
-  data.tar.gz: 1cd405531bba571c8f78626444bfb239f5d112ce2f19726319c8eda7ce87b5865043096a3146be5ed045dc0287ca038ebe5b86f1b9b9029833133d3eb59165ac
+  metadata.gz: f8a4358361d693f6397d156c9f1466b729a3bac48b00d5b395afade20e9463d0cdcd8a4db660742110bca2320a36a0be3866330c4a7de20c18fd9c3cfc1482f3
+  data.tar.gz: f91169a81c5527068576bd0f200a6178795a3e818951c7fee5748f4cee8374d5e5a3516bb1b9cbbe252f2727856b2ee8eab6889258bb0e9e8d3576f641a74a5a

data/.idea/media_types-serialization.iml

@@ -34,8 +34,8 @@
     <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.4, ruby-2.5.3-p105) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crass (v1.0.4, ruby-2.5.3-p105) [gem]" level="application" />
     <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.1.0, ruby-2.5.3-p105) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="http_headers-link (v0.1.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="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" />

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.2.0
+
+- Change `method_missing` and base methods for `Base`
+- Add test for `HtmlWrapper` 
+
 ## 0.1.0
 
 :baby: initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (0.1.0)
+    media_types-serialization (0.2.0)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
       http_headers-accept (< 1.0.0)
@@ -34,11 +34,11 @@ GEM
     concurrent-ruby (1.1.4)
     crass (1.0.4)
     erubi (1.8.0)
-    http_headers-accept (0.1.0)
-      http_headers-utils (< 1.0.0)
-    http_headers-link (0.1.0)
-      http_headers-utils (< 1.0.0)
-    http_headers-utils (0.1.1)
+    http_headers-accept (0.2.1)
+      http_headers-utils (>= 0.2.0, < 1.0.0)
+    http_headers-link (0.2.1)
+      http_headers-utils (>= 0.2.0, < 1.0.0)
+    http_headers-utils (0.2.0)
     i18n (1.5.3)
       concurrent-ruby (~> 1.0)
     loofah (2.2.3)

data/README.md

@@ -147,11 +147,27 @@ class BookController < ApiController
   freeze_accepted_media!
       
   def show 
-    render media: serialize_media(@book)
+    # If you do NOT pass in the content_type, it will re-use the current content_type of the response if set or
+    # use the default content type of the serializer. This is fine if you only output one Content-Type in the
+    # action, but not if you are relying on content-negotiation. 
+    
+    render media: serialize_media(@book), content_type: request.format.to_s
   end
 end
 ```
 
+If you have normalized your resources (e.g. into `@resource`), you may render resources like so:
+
+```ruby
+class ApiController < ActionController::API
+  def render_media(**opts)
+    render media: serialize_media(@resource), content_type: request.format.to_s, **opts
+  end
+end
+```
+
+And then call `render_media` whenever you're ready to render
+
 ### HTML output
 
 You can define HTML outputs for example by creating a serializer that accepts `text/html`. At this moment, there may

data/lib/media_types/serialization/base.rb

@@ -25,58 +25,27 @@ module MediaTypes
         {}
       end
 
-      def to_html
-        raise NotImplementedError, format(
-          'In %<class>s, to_html is not implemented.',
-          class: self.class.name
-        )
-      end
-
-      def to_xml
-        raise NotImplementedError, format(
-          'In %<class>s, to_xml is not implemented.',
-          class: self.class.name
-        )
-      end
-
-      def to_hash
-        raise NotImplementedError, format(
-          'In %<class>s, to_hash is not implemented.',
-          class: self.class.name
-        )
-      end
-
-      def to_text
-        raise NotImplementedError, format(
-          'In %<class>s, to_text is not implemented/',
-          class: self.class.name
-        )
-      end
+      COMMON_DERIVED_CALLERS = [:to_h, :to_hash, :to_json, :to_text, :to_xml, :to_html, :to_body, :extract_self].freeze
+
+      def method_missing(symbol, *args, &block)
+        if COMMON_DERIVED_CALLERS.include?(symbol)
+          raise NotImplementedError, format(
+            'In %<class>s, %<symbol>s is not implemented. ' \
+            'Implement it or deny the MediaType[s] %<media_types>s for %<model>s',
+            symbol: symbol,
+            class: self.class.name,
+            model: serializable.class.name,
+            media_types: self.class.media_types(view: '[view]').to_s
+          )
+        end
 
-      def to_json
-        raise NotImplementedError, format(
-          'In %<class>s, to_json is not implemented/',
-          class: self.class.name
-        )
-      end
-
-      def to_h
-        raise NotImplementedError, format(
-          'In %<class>s, to_h is not implemented. Missing alias to_h to_hash.',
-          class: self.class.name
-        )
-      end
-
-      def to_body
-        raise NotImplementedError, format(
-          'In %<class>s, to_body is not implemented. This is a general purpose catch all renderer',
-          class: self.class.name
-        )
+        super
       end
 
-      def respond_to?(sym, include_all = false)
-        return false if [:to_h, :to_hash, :to_json, :to_text, :to_xml, :to_html, :to_body, :extract_self].include?(sym)
-        return true if sym == :to_link_header
+      def respond_to_missing?(method_name, include_private = false)
+        if COMMON_DERIVED_CALLERS.include?(method_name)
+          return false
+        end
 
         super
       end
@@ -85,16 +54,6 @@ module MediaTypes
 
       attr_accessor :context, :current_media_type, :current_view
 
-      def extract_self
-        raise NotImplementedError, format(
-          'In %<class>s, extract_self is not implemented, thus a self link for %<model>s can not be generated. ' \
-          'Implement extract_self on %<class>s or deny the MediaType[s] %<media_types>s for this request.',
-          class: self.class.name,
-          model: serializable.class.name,
-          media_types: self.class.media_types(view: '[view]').to_s
-        )
-      end
-
       def extract_links
         {}
       end

data/lib/media_types/serialization/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack