shreddies 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f3a9878d5d25ca7eb02bc3d9f3e4e4dc6f71ab6f970312331ed01fe864923b4
-  data.tar.gz: bfba9356df3012c94527f1214d1862c5a507f91aab243f43fc85c8a30b0d50e3
+  metadata.gz: 5d29eb71728861282bd3c4a7e04ee829c4d647962951dfc494b311146142a84b
+  data.tar.gz: 9281b757f6ac85f5d17879b54b4554a7cf4ea5853c04420f52a4755080157092
 SHA512:
-  metadata.gz: '069be646751138acce14f15960e417c18dcb2f57981a49b77d7d1a3a71ef4c2c079c49be4535c8ae193e752cb90298ddca0a72d5f51d12a9f2f2860c940a1e84'
-  data.tar.gz: 8cf4dd148fe6ab7a6989e52462bc3fd3b14cddf592d17b45bd6470ec60f7482fe21e64a12af1909181bf789981b64a964b30f241e746ff3150de7bb4edfa3245
+  metadata.gz: 70f1959dbd3cd6a7e134c3fb4404a8d75ea55e219ba8e01eaba675bcfbbdc597fc0e85a12df4574e73617cb5aec946f67fcb3a077d73ccbf068d5ec158e82996
+  data.tar.gz: b8618164e87ad5d94279a5e9294ec7d975d2b96ec3966fe8b074f4733296b9c047348b718002942911442f9f4511a61909045baeccfb9d9705975c749ffa7fb7

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in shreddies.gemspec
 gemspec
 
-gem 'rake', '~> 12.0'
+gem 'rake', '~> 13.0'
 gem 'minitest', '~> 5.0'
 gem 'autotest-suffix'
 gem 'minitest-autotest'

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    shreddies (0.1.0)
+    shreddies (0.6.0)
       activerecord (>= 5)
       railties (>= 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -34,21 +34,21 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     autotest-suffix (1.1.0)
     builder (3.2.4)
-    combustion (1.3.0)
+    combustion (1.3.1)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     crass (1.0.6)
     erubi (1.9.0)
-    i18n (1.8.3)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    minitest (5.14.2)
     minitest-autotest (1.1.1)
       minitest-server (~> 1.0)
       path_expander (~> 1.0)
@@ -56,7 +56,7 @@ GEM
       minitest (>= 4, < 6)
     minitest-server (1.0.6)
       minitest (~> 5.0)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     path_expander (1.1.0)
     rack (2.2.3)
@@ -67,19 +67,19 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
-    rake (12.3.3)
+    rake (13.0.1)
     sqlite3 (1.4.2)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
-    zeitwerk (2.3.1)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
@@ -90,7 +90,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   minitest-autotest
   minitest-focus
-  rake (~> 12.0)
+  rake (~> 13.0)
   shreddies!
   sqlite3
 

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:
@@ -65,6 +67,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 +93,40 @@ 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.
+
 ### 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 +161,28 @@ 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.
+
+#### `except`
+
+Pass one or more attribute names as a Symbol or Array of Symbols, and these will be excluded from the results:
+
+```ruby
+User.all.as_json(except: [:first_name, :age])
+```
+
+#### `only`
+
+Pass one or more attribute names as a Symbol or Array of Symbols, and _ONLY_ these will be included in the results:
+
+```ruby
+User.all.as_json(only: :first_name)
+```
+
+> Attributes must still be defined within the Serializer.
+
 #### `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

@@ -44,11 +44,11 @@ module Shreddies
       super(*methods, to: to, prefix: prefix, allow_nil: allow_nil, private: private)
     end
 
-    attr_reader :subject, :options, :from_collection
+    attr_reader :subject, :options
 
-    def initialize(subject, options)
-      @subject = subject
-      @options = options
+    def initialize(subject, opts = {})
+      @subject = subject.is_a?(Hash) ? OpenStruct.new(subject) : subject
+      @options = { transform_keys: true }.merge(opts).with_indifferent_access
 
       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|
@@ -65,22 +65,43 @@ module Shreddies
         end
       end
 
+      # Filter out methods using the `only` or `except` options.
+      if @options[:only]
+        @options[:only] = Array(@options[:only])
+        methods = methods.select { |x| @options[:only].include? x }
+      elsif @options[:except]
+        methods = methods.excluding(@options[:except])
+      end
+
       methods.map do |attr|
-        json[attr.to_s.camelize :lower] = 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
 
-      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')
 
         # Extend with Collection module if it exists, and a collection is being rendered. Otherwise,
         # extend with the Single module if that exists.
-        if options[:from_collection]
+        if @options[:from_collection]
           (collection_mod = "#{ancestor}::Collection".safe_constantize) && extend(collection_mod)
         else
           (single_mod = "#{ancestor}::Single".safe_constantize) && extend(single_mod)
@@ -88,11 +109,9 @@ module Shreddies
       end
 
       # 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
+      if @options[:module]
+        Array(@options[:module]).each do |m|
+          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.2.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shreddies
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Stupid simple Rails model and object serializer