shreddies 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994ca7a8e1be900a520c23fb51d1d3105ef7ed5354204840b3e4531f1b02bc35
-  data.tar.gz: 2bb7c93e959057b0d2f3af612bb53ce0bb0a93ca20c2338131971455b8deaa31
+  metadata.gz: b512a5aaa15bead3897d186b72c0232b806d21ec1b884689e7fac2b1f6c7db7b
+  data.tar.gz: 45c0d21700671b9ecb9c0ef6a19d0c29c1e45172f9567513b12182a6819d7b55
 SHA512:
-  metadata.gz: bfd06349411570a2794796d9c4dc9cb6aa5d578123f9b5013aa3882a0547684f27714832901bfc891b8d0a65ed75775156c17222317163dc3621a6191f95d5c3
-  data.tar.gz: 8c3e4fd74a2fca6c93c28db3ba0394fce74047b12f555d315061e949601bb3d69ae1a266dce3a617986da9f3b4de8592521e5b3783b79c6d48b84fc042acc3b9
+  metadata.gz: 5c4aa3c08206be63b44798b22a644220fc536506810ad756f7a73b913bf9e8fd23b8f94014b2b1c6e00eaa1d590473b9786ea6dbb8585e52f16d0b465c528f0b
+  data.tar.gz: fa170d48d3d9e4f512bc3fdc06de984fc4370af74ee69a5e01a112b9e0ffb80ef05b75f52f5a9b0feaec643677a90f442120984a4c4c3587481fcdafec7676e6

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,54 +1,54 @@
 PATH
   remote: .
   specs:
-    shreddies (0.2.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)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.1)
+      actionview (= 6.1.1)
+      activesupport (= 6.1.1)
+      rack (~> 2.0, >= 2.0.9)
       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.1.1)
+      activesupport (= 6.1.1)
       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.1.1)
+      activesupport (= 6.1.1)
+    activerecord (6.1.1)
+      activemodel (= 6.1.1)
+      activesupport (= 6.1.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     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.8)
     crass (1.0.6)
-    erubi (1.9.0)
-    i18n (1.8.3)
+    erubi (1.10.0)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
     minitest-autotest (1.1.1)
       minitest-server (~> 1.0)
       path_expander (~> 1.0)
@@ -56,9 +56,11 @@ GEM
       minitest (>= 4, < 6)
     minitest-server (1.0.6)
       minitest (~> 5.0)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     path_expander (1.1.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -67,19 +69,18 @@ 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.1.1)
+      actionpack (= 6.1.1)
+      activesupport (= 6.1.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rake (12.3.3)
+      thor (~> 1.0)
+    rake (13.0.3)
     sqlite3 (1.4.2)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -90,7 +91,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:
@@ -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.
@@ -133,6 +165,24 @@ The `Collection` and `Single` modules can be defined and they will be automatica
 
 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/as_json.rb

@@ -8,6 +8,8 @@ module Shreddies
 
         if serializer.is_a?(String) || serializer.is_a?(Symbol)
           serializer = serializer.to_s.safe_constantize
+        elsif serializer.is_a?(Proc)
+          return serializer.call
         end
 
         serializer ? serializer.render_as_json(self, options) : super
@@ -20,6 +22,8 @@ module Shreddies
 
         if serializer.is_a?(String) || serializer.is_a?(Symbol)
           serializer = serializer.to_s.safe_constantize
+        elsif serializer.is_a?(Proc)
+          return serializer.call
         end
 
         serializer ? serializer.render_as_json(self, options) : super

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)
+    def initialize(subject, opts = {})
       @subject = subject.is_a?(Hash) ? OpenStruct.new(subject) : subject
-      @options = { transform_keys: true }.merge(options)
+      @options = { transform_keys: true }.merge(opts).with_indifferent_access
 
       extend_with_modules
     end
@@ -65,13 +65,26 @@ 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|
-        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)
 
-      return output unless options[:transform_keys]
+      return output unless @options[:transform_keys]
 
       output.deep_transform_keys { |key| key.to_s.camelize :lower }
     end
@@ -88,7 +101,7 @@ module Shreddies
 
         # 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)
@@ -96,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.3.0"
+  VERSION = "0.7.0"
 end

data/shreddies.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Stupid simple Rails model and object serializer'
   spec.homepage      = 'https://github.com/joelmoss/shreddies'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shreddies
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -77,14 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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