shreddies 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f3a9878d5d25ca7eb02bc3d9f3e4e4dc6f71ab6f970312331ed01fe864923b4
-  data.tar.gz: bfba9356df3012c94527f1214d1862c5a507f91aab243f43fc85c8a30b0d50e3
+  metadata.gz: 994ca7a8e1be900a520c23fb51d1d3105ef7ed5354204840b3e4531f1b02bc35
+  data.tar.gz: 2bb7c93e959057b0d2f3af612bb53ce0bb0a93ca20c2338131971455b8deaa31
 SHA512:
-  metadata.gz: '069be646751138acce14f15960e417c18dcb2f57981a49b77d7d1a3a71ef4c2c079c49be4535c8ae193e752cb90298ddca0a72d5f51d12a9f2f2860c940a1e84'
-  data.tar.gz: 8cf4dd148fe6ab7a6989e52462bc3fd3b14cddf592d17b45bd6470ec60f7482fe21e64a12af1909181bf789981b64a964b30f241e746ff3150de7bb4edfa3245
+  metadata.gz: bfd06349411570a2794796d9c4dc9cb6aa5d578123f9b5013aa3882a0547684f27714832901bfc891b8d0a65ed75775156c17222317163dc3621a6191f95d5c3
+  data.tar.gz: 8c3e4fd74a2fca6c93c28db3ba0394fce74047b12f555d315061e949601bb3d69ae1a266dce3a617986da9f3b4de8592521e5b3783b79c6d48b84fc042acc3b9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shreddies (0.1.0)
+    shreddies (0.2.0)
       activerecord (>= 5)
       railties (>= 5)
 

data/README.md

@@ -65,6 +65,8 @@ Model collections and array's are also supported:
 User.all.as_json
 ```
 
+### Collection and Single Modules
+
 You may find that you don't want or need to return as much data in collections of objects, or may want to include differtent data. So if a serializer defines a `Collection` module, and a collection or array is being rendered, then that Collection module will automatically be included:
 
 ```ruby
@@ -89,6 +91,10 @@ ArticleSerializer < Shreddies::Json
 end
 ```
 
+### `before_render` callback
+
+You can define a `#before_render` private method in your serializers, which will act as a callback. It receives the object to be output, and expects you to return the object, which allows you to modify it before rendering.
+
 ### Options
 
 Both `#as_json` and `.render` accepts an `options` hash, which will be forwarded to the serializer class, and available as `options`. This allows you to pass arbitrary options and use them in your serializer.
@@ -123,6 +129,10 @@ end
 
 The `Collection` and `Single` modules can be defined and they will be automatically included. The Collection module will be included when rendering an array or ActiveRecord collection (`ActiveRecord::Relation`), and the Single module will be included when rendering a single obejct.
 
+#### `transform_keys` (default: true)
+
+If false, the returned keys will not be transformed. The default is to deeply transform all keys to camelCase.
+
 #### `index_by`
 
 Give this option a property of your serialized subject as a Symbol, and the returned collection will be a Hash keyed by that property.

data/lib/shreddies/json.rb

@@ -47,8 +47,8 @@ module Shreddies
     attr_reader :subject, :options, :from_collection
 
     def initialize(subject, options)
-      @subject = subject
-      @options = options
+      @subject = subject.is_a?(Hash) ? OpenStruct.new(subject) : subject
+      @options = { transform_keys: true }.merge(options)
 
       extend_with_modules
     end
@@ -56,7 +56,7 @@ module Shreddies
     # Travel through the ancestors that are serializers (class name ends with "Serializer"), and
     # call all public instance methods, returning a hash.
     def as_json
-      json = {}
+      output = {}.with_indifferent_access
       methods = Set.new(public_methods(false))
 
       self.class.ancestors.each do |ancestor|
@@ -66,14 +66,22 @@ module Shreddies
       end
 
       methods.map do |attr|
-        json[attr.to_s.camelize :lower] = public_send(attr)
+        output[attr] = public_send(attr)
       end
 
-      json.deep_transform_keys { |key| key.to_s.camelize :lower }
+      output = before_render(output)
+
+      return output unless options[:transform_keys]
+
+      output.deep_transform_keys { |key| key.to_s.camelize :lower }
     end
 
     private
 
+    def before_render(output)
+      output
+    end
+
     def extend_with_modules
       self.class.ancestors.reverse.each do |ancestor|
         next unless ancestor.to_s.end_with?('Serializer')

data/lib/shreddies/version.rb

@@ -1,3 +1,3 @@
 module Shreddies
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shreddies
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord