shreddies 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994ca7a8e1be900a520c23fb51d1d3105ef7ed5354204840b3e4531f1b02bc35
-  data.tar.gz: 2bb7c93e959057b0d2f3af612bb53ce0bb0a93ca20c2338131971455b8deaa31
+  metadata.gz: 362313f00cf053782a4cce7d2ce46b83e8ae078e6812c7c8bb485440f967c3a5
+  data.tar.gz: e1f3f78c27fc4def477bfc1f3adb13fb101a57fbc6870add99dbac9f8efb0db4
 SHA512:
-  metadata.gz: bfd06349411570a2794796d9c4dc9cb6aa5d578123f9b5013aa3882a0547684f27714832901bfc891b8d0a65ed75775156c17222317163dc3621a6191f95d5c3
-  data.tar.gz: 8c3e4fd74a2fca6c93c28db3ba0394fce74047b12f555d315061e949601bb3d69ae1a266dce3a617986da9f3b4de8592521e5b3783b79c6d48b84fc042acc3b9
+  metadata.gz: 67d80f7708e475b54d8e99a5b24d4198091d0ccfef45a84c131539985bdc682bad234e3df12eb4e8351b3648296a2adffc71e796cd8b149a8336a85495d3acb3
+  data.tar.gz: 62e767958dd0b0cd314204a2a7cd573ae7d4df0dd27bdf23a528e64eb4574c2b3e45a5aa9879674a9264c7b57c462f784741a8926e0a82108043396a6caded9e

data/Gemfile.lock

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

data/README.md

@@ -2,6 +2,8 @@
 
 Shreddies is a JSON serialization library for Rails that focuses on simplicity and speed. No more "magic" DSL's - just plain old Ruby objects! It's primarily intended to serialize Rails models as JSON, but will also work with pretty much anything at all.
 
+Shreddies primary principle is to be explicit. So a serializer will return nothing until you define some methods. This gives you complete control and everything is a known quantity - no surprises.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -91,6 +93,36 @@ ArticleSerializer < Shreddies::Json
 end
 ```
 
+### ActiveRecord Associations
+
+ActiveRecord associations are supported with no additional work on your part. Shreddies will simply call `#as_json` on any method that returns an ActiveRecord model or relation.
+
+```ruby
+# app/serializers/user_serializer.rb
+class UserSerializer < Shreddies::Json
+  delegate :articles
+
+  def latest_article
+    articles.latest
+  end
+end
+```
+
+And if you need to be specific about what you render, just call the serializer or `#as_json` directly:
+
+```ruby
+# app/serializers/user_serializer.rb
+class UserSerializer < Shreddies::Json
+  def articles
+    subject.articles.as_json index_by: :slug
+  end
+
+  def latest_article
+    LatestArticleSerializer.render articles.latest
+  end
+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.

data/lib/shreddies/json.rb

@@ -66,7 +66,12 @@ module Shreddies
       end
 
       methods.map do |attr|
-        output[attr] = public_send(attr)
+        res = public_send(attr)
+        if res.is_a?(ActiveRecord::Relation) || res.is_a?(ActiveRecord::Base)
+          res = res.as_json(transform_keys: options[:transform_keys])
+        end
+
+        output[attr] = res
       end
 
       output = before_render(output)
@@ -98,9 +103,7 @@ module Shreddies
       # Extend with the :module option if given.
       if options[:module]
         Array(options[:module]).each do |m|
-          mod = m.is_a?(Module) ? m : "#{self.class}::#{m}".constantize
-
-          extend mod
+          extend m.is_a?(Module) ? m : "#{self.class}::#{m}".constantize
         end
       end
     end

data/lib/shreddies/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shreddies
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joel Moss