ializer 0.8.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a27b447fa68c06116dd6c47fee6b4b88d4a133b13918c3fef39128eb2b29bcd6
-  data.tar.gz: 5287b42771194bc862c4822fcff6ebd2f4468832bfeffd49bac56508f2a16b87
+  metadata.gz: c00a69cfd664143494407679066729ac9251cbf300d6168d1a6fa43dec1966c2
+  data.tar.gz: 0dc7bb3dcc2354ed6faf3d677297194aa730ea5a5f72547796eb786b09972722
 SHA512:
-  metadata.gz: daa4636e280f256663d9cfb84be204b0b42a5e588022a1c0fd5a5905c3502597a6b0fd49f8aa8196426f4e2a03dbfd62e0ec2234633f7c196a795c275bee3153
-  data.tar.gz: a4c0da31e4d8bac18f97382f514cd2cba48dfdded2d820e0926825d022fdda546019c6e3eda7d02f308a9a4bfdc28ee2af9d1c1a97a2a1babc48835ee2e1101f
+  metadata.gz: 7ccbcefea07e0df88dd2114fa53df0e98e27da13a2eaaeb54fff01663055f8a6304c9d39f0c691318cd5a54d7abaef6c9bb48f7b5068dfe8a6c33de0bcde67d5
+  data.tar.gz: d7cb6b38f6c6408131552a5dc93aa48bd70582ed6a0af1720cb326323bdf30db29b65e01d5b69f824f16f578a8961764371191eaf40ab9bcaa8cbf284655b875

data/README.md

@@ -292,7 +292,7 @@ class OrderDeSer < De::Ser::Ializer
 
   nested     :items,       deser: OrderItemDeSer,   model_class: OrderItem
   # OR
-  property   :items,       deser: OrderItemDeSer,   model_classx: OrderItem
+  property   :items,       deser: OrderItemDeSer,   model_class: OrderItem
 
   nested     :customer,    model_class: Customer do
     string     :name
@@ -458,6 +458,27 @@ end
 CustomerDeSer.serialize(order, current_user)
 ```
 
+#### Using the context to serialize a subset of attributes
+
+There are special keywords/method names on the Serialization Context that can be used to limit the attributes that are serialized.  This is different from conditional attributes below.  The conditions would still apply to the subset.
+
+If your serialization context is a `Hash`, you can use the hash keys `:attributes` or `:include` to define the limited subset of attributes for serialization.
+
+```ruby
+CustomerDeSer.serialize(order, attributes: [:name])
+```
+
+If your serialization context is a ruby object, a method named `attributes` that returns an array of attribute names can be used.
+
+```ruby
+class AttributeSubsetContext
+  attr_accessor :attributes
+end
+
+context = AttributeSubsetContext.new(attributes: [:name])
+CustomerDeSer.serialize(order, context)
+```
+
 ### Conditional Attributes
 
 Conditional attributes can be defined by passing a Proc to the `if` key on the `property` method. Return `truthy` if the attribute should be serialized, and `falsey` if not. The record and any params passed to the serializer are available inside the Proc as the first and second parameters, respectively.

data/ializer.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop', '~> 1.19'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.8'
   spec.add_development_dependency 'simplecov'
 end

data/lib/de/ser/ializer.rb

@@ -35,7 +35,7 @@ module De
         end
 
         def parse_attribute(object, key, value)
-          field = _attributes[key]
+          field = attributes[key]
 
           return unless field
 
@@ -77,7 +77,7 @@ module De
         end
 
         def parse_ostruct_field(object, key, value)
-          field = _attributes[key]
+          field = attributes[key]
 
           return unless field
 

data/lib/ializer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ializer
-  VERSION = '0.8.1'
+  VERSION = '0.10.2'
 end

data/lib/ser/ializer/field.rb

@@ -11,7 +11,7 @@ module Ser
         end
       end
 
-      attr_reader :name, :setter, :key, :deser, :model_class, :if_condition, :block
+      attr_reader :name, :setter, :key, :deser, :model_class, :if_condition, :block, :description, :documentation
 
       def initialize(name, options, config, &block)
         @name = name
@@ -20,6 +20,8 @@ module Ser
         @deser = options[:deser]
         @if_condition = options[:if]
         @model_class = options[:model_class]
+        @description = options[:desc]
+        @documentation = options[:documentation]
         @block = block
       end
 

data/lib/ser/ializer.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash'
+
 module Ser
   class Ializer # rubocop:disable Metrics/ClassLength
     @@method_registry = {} # rubocop:disable Style/ClassVars
@@ -44,7 +47,7 @@ module Ser
       end
 
       def with(deser)
-        deser._attributes.values.each do |field|
+        deser.attributes.each_value do |field|
           add_composed_attribute(field, deser)
         end
       end
@@ -73,6 +76,8 @@ module Ser
         matchers.each do |matcher|
           method_registry[matcher.to_s.to_sym] = method_name
         end
+
+        deser_types[deser.to_s] = method_name.capitalize
       end
 
       def register_default(deser)
@@ -86,8 +91,22 @@ module Ser
         end
       end
 
+      # Maps a registered deser to the value type that it serializes
+      def deser_types
+        @deser_types ||= {}
+      end
+
       def attribute_names
-        _attributes.values.map(&:name)
+        attributes.values.map(&:name)
+      end
+
+      def attributes
+        @attributes ||=
+          if equal? Ser::Ializer
+            ActiveSupport::HashWithIndifferentAccess.new
+          else
+            superclass.attributes.dup
+          end
       end
 
       protected
@@ -108,15 +127,6 @@ module Ser
         method(method_name)
       end
 
-      def _attributes
-        @attributes ||=
-          if equal? Ser::Ializer
-            {}
-          else
-            superclass._attributes.dup
-          end
-      end
-
       private
 
       def warning_message(name)
@@ -124,7 +134,7 @@ module Ser
       end
 
       def add_attribute(field)
-        _attributes[field.key] = field
+        attributes[field.key] = field
 
         define_singleton_method field.name do |object, context|
           value = field.get_value(object, context)
@@ -134,7 +144,7 @@ module Ser
       end
 
       def add_composed_attribute(field, deser)
-        _attributes[field.key] = field
+        attributes[field.key] = field
 
         define_singleton_method field.name do |object, context|
           deser.public_send(field.name, object, context)
@@ -152,7 +162,7 @@ module Ser
       end
 
       def serialize_one(object, context)
-        _attributes.values.each_with_object({}) do |field, data|
+        fields_for_serialization(context).each_with_object({}) do |field, data|
           next unless field.valid_for_context?(object, context)
 
           value = public_send(field.name, object, context)
@@ -163,6 +173,27 @@ module Ser
         end
       end
 
+      def fields_for_serialization(context)
+        field_names = fields_names_for_serialization(context)
+
+        return attributes.values unless field_names
+
+        attributes.values_at(*field_names).compact
+      end
+
+      def fields_names_for_serialization(context)
+        return nil unless context
+
+        if context.is_a?(Hash)
+          context = context.with_indifferent_access
+          return context[:attributes] || context[:include]
+        end
+
+        return context.attributes if context.respond_to?(:attributes)
+
+        nil
+      end
+
       def valid_enumerable?(object)
         return true if object.is_a? Array
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ializer
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Jeremy Steinberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,30 +98,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,8 +136,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables:
 - console
 - setup
@@ -178,7 +178,7 @@ homepage: https://github.com/jsteinberg/ializer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Simple (de)serializers for Ruby objects
 test_files: []