cached_serializer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf526cbee1a252e2821fab724ba9a1edd00aa3c85beeb52846b9cc25dc2648de
-  data.tar.gz: 263aad0b673d71ff631f6d0cbe0ae27db278009df9ae8b3835943847d523bd9a
+  metadata.gz: f63d5286fa23eef6901c0699183d6afc16f3d7133ccf9cc510aa663a6e20d2af
+  data.tar.gz: 6617de397b071edd94246cf968872f3a633cad40f07f986bc980f5ce4a778ff6
 SHA512:
-  metadata.gz: '059c0ebf3794f4de80a3a3b6c66a54617e96350002951730fd867f7668ac4a27f17e0a91368c8e34beb80a0afdddf1bda71f3d698bc1a7785e27e9bfb0c3f6b3'
-  data.tar.gz: 38f0b76d94df50ce19f56a326c34fe3ad757ac0f80d1f39ebb68bd881622ead577690cc6da32fea21e8f2473551c5ce1924653ce3360adcfb27820bfb6afe9ec
+  metadata.gz: 60ede69361a0f192248bf914b6e2f24b9145674bc5c4c328143dc7131386520a3118c6a4c8848ab7ca4624956eedded633f26a703a5a83617fac7793ea9ba9f5
+  data.tar.gz: 866f839d237847c1ca0feaff3d3cc51fe27d7756cc284fc5a673d0c0fe2928aa90005e036debc5a2a5310747723d6b1b5707f8de826da0a063d4934a627b6f05

data/README.md

@@ -12,7 +12,21 @@ every attribute. This can be desirable when some of the serialized data involves
 long-running queries, relationship-heavy calculations, etc.
 
 ```rb
-class UserSerializer < CachedSerializer::Base
+class Admin::UserSerializer < CachedSerializer::Base
+  # Use the `::subject_class` macro (optional) to specify the class of the model
+  # this serializer will be operating on. By default, it will serialize (and
+  # cache for) the model class named (and nested) the same as the serializer,
+  # short "`Serializer`" at the end of the name. For example, `UserSerializer`
+  # will serialize `User` models by default. `Admin::UserSerializer` will
+  # serialize `Admin::User` models by default.
+  #
+  # If you want to name the serializer something other than "`TheModelName` +
+  # `Serializer`" (e.g., `AuthorSerializer` to serialize `User` records), or to
+  # put it in a module (e.g., `Admin::UserSerializer` to differentiate it from
+  # an existing `UserSerializer`) use `::subject_class` to specify the class of
+  # the subject you will be serializing.
+  subject_class User
+
   # Properties specified by `::columns` are called as-is on the model, and
   # invalidated automatically when the model is saved with new values for these
   # properties, by checking Rails' built-in `#email_changed?`/`#phone_changed?`

data/lib/cached_serializer/base.rb

@@ -3,10 +3,48 @@ require_relative "./attr_serializer"
 require_relative "./attr_serializer_collection"
 
 module CachedSerializer
+  class Error < StandardError; end
+
   class Base
     attr_accessor :subject
 
     class << self
+      # Examples:
+      #
+      #   module Admin
+      #     class UserSerializer < CachedSerializer::Base
+      #       subject_class User
+      #
+      #       # ...
+      #     end
+      #   end
+      #
+      #   class AuthorSerializer < CachedSerializer::Base
+      #     subject_class User
+      #
+      #     # ...
+      #   end
+      #
+      # If you want to serialize a model and name the serializer something other
+      # than "`ModelName` + `Serializer`" (e.g., `AuthorSerializer` to serialize
+      # `User` records), or to put it in a module (e.g., `Admin::UserSerializer`
+      # to differentiate it from an existing `UserSerializer`) use
+      # `::subject_class` to specify the class of the model you will be
+      # serializing.
+      def subject_class(subject_class = nil)
+        return @subject_class if @subject_class && !subject_class
+
+        subject_class_name = case subject_class.class.to_s
+        when 'Class' then subject_class.to_s
+        when 'String' then subject_class.classify
+        else self.to_s.gsub(/[Ss]erializer\z/, '')
+        end
+
+        @subject_class = subject_class_name.constantize
+      rescue NameError
+        raise CachedSerializer::Error, "Cannot find a #{subject_class_name} model class for serialization (use the `subject_class TheModelName` in #{self.to_s} to specify which model to serialize)"
+      end
+
       def serializers
         @serializers ||= AttrSerializerCollection.new
       end
@@ -118,10 +156,6 @@ module CachedSerializer
 
       private
 
-      def subject_class
-        @subject_class ||= self.to_s.gsub(/[Ss]erializer\z/, '').constantize
-      end
-
       def add_column_changed_cache_invalidator_callback(attr_name, dependent_attr_name)
         @already_added_callback ||= {}
         @already_added_callback[attr_name.to_sym] ||= {}
@@ -140,6 +174,10 @@ module CachedSerializer
     end
 
     def initialize(subject)
+      unless subject.is_a?(self.class.subject_class)
+        raise CachedSerializer::Error, "Subject is not a #{self.class.subject_class} (use `subject_class #{subject.class}` in your serializer to serialize #{subject.class} records)"
+      end
+
       self.subject = subject
     end
 

data/lib/cached_serializer/version.rb

@@ -1,3 +1,3 @@
 module CachedSerializer
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cached_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Keegan Leitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails