ializer 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 497afd4a62c4b255b976501c69adf8de2a569376c25c7aefb4a94b7ed94200bc
-  data.tar.gz: '082946872d647c482b9044898b8e9069fec868339b33eac6f4c8996a446e47be'
+  metadata.gz: 94f2932d08df7f0236c889c447159ff88c2aebb3761f754cee5acaa31a49586d
+  data.tar.gz: a2b8e77a53cb3f38a619b616c48cdab480af0b7890952bb82632ea8fece8d1b3
 SHA512:
-  metadata.gz: 0d079821ef910ac423409b0af192fdf971236fc7cd39efb1b994f0817edebbe16285302fc14d34634f452b16af85195d8c522fd3677ad17a0c5b1a9100f1c35f
-  data.tar.gz: b2136f4515fbfe36d270f1c726dd45417f5759ea931f0f264a3709f324a88e1adcf82bf93db2173eb8df146d7ee52f35ed50ce3813e9bb989d00f78f200d0ab4
+  metadata.gz: 6fe88893e5ee61a1cef8b28f52add84a2d54da0a37e2556167dc8f1ee9ac9afd836104837a5c75cc4dc9a71208e0fe1d4f41664554ad8a93b816afd14f213c3b
+  data.tar.gz: 854229b905bedce44414a452e9fbf91b0cd44d88ce26ee6aebdc2fe809ed69056dcda0caa2b55766a02695a12e73855d742b5247f23e0abca1dc88b33dad321a

data/README.md

@@ -13,6 +13,7 @@ A fast serializer/deserializer for Ruby Objects.
   * [Model Definitions](#model-definitions)
   * [Serializer Definitions](#serializer-definitions)
   * [DeSerializer Definitions](#deserializer-definitions)
+  * [De/Serializer Configuration](#deserializer-configuration)
   * [Object Serialization](#object-serialization)
   * [Object Deserialization](#object-deserialization)
 * [Attributes](#attributes)
@@ -153,6 +154,26 @@ class CustomerDeSer < De::Ser::Ializer
 end
 ```
 
+### De/Ser::Ializer Configuration
+
+You can override the global config for a specific `Ser::Ializer` or `De::Ser::Ializer` by calling the setup command.
+
+**Note:** `setup` must be called at the beginning of the definition otherwise the default config will be used.
+
+```ruby
+class OrderDeSer < De::Ser::Ializer
+  setup do |config|
+    config.key_transform = :dasherize
+  end
+
+  integer    :id
+  timestamp  :created_at
+
+  nested     :items,       deser: OrderItemDeSer,   model_class: OrderItem
+  nested     :customer,    deser: CustomerDeSer,    model_class: Customer
+end
+```
+
 ### Sample Object
 
 ```ruby
@@ -183,17 +204,17 @@ json_string = OrderDeser.serialize_json(order)
 ```json
 {
   "id": 4,
-  "created-at": "2019-12-01T00:00:00.000-06:00",
+  "created_at": "2019-12-01T00:00:00.000-06:00",
   "items": [
     {
        "name": "Baseball",
        "decimal": "4.99",
-       "in-stock": true
+       "in_stock": true
      },
      {
        "name": "Football",
        "decimal": "14.99",
-       "in-stock": false
+       "in_stock": false
      }
   ],
   "customer": {
@@ -226,7 +247,7 @@ data = OrderDeSer.serialize([order, order2])
 
 ### Object Deserialization
 
-**Note:** Objects that are parsed must have a zero-argument initializer (ie: Object.new)
+**Note:** Objects that are parsed must have a zero argument initializer (ie: Object.new)
 
 #### Parsing a hash
 
@@ -271,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
@@ -437,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', '~> 0.78.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
 end

data/lib/de/ser/ializer.rb

@@ -53,6 +53,8 @@ module De
         private
 
         def parse_field(object, field, value)
+          return if value.nil?
+
           parsed_value = field.parse(value)
 
           return if parsed_value.nil?

data/lib/ializer/big_decimal_de_ser.rb

@@ -11,7 +11,11 @@ module Ializer
     end
 
     def self.parse(value)
+      return nil if value.nil?
+
       BigDecimal(value)
+    rescue ArgumentError
+      value
     end
   end
 end

data/lib/ializer/config.rb

@@ -10,7 +10,7 @@ module Ializer
     # :key_transform=: key_transform
     #
     # symbol of string transform to call on field keys
-    # default is +:dasherize+.
+    # default is nil
     def key_transform=(key_transform)
       self.key_transformer = key_transform&.to_proc
     end

data/lib/ializer/date_de_ser.rb

@@ -10,8 +10,8 @@ module Ializer
 
     def self.parse(value)
       Date.parse(value)
-    rescue ArgumentError
-      nil
+    rescue ArgumentError, TypeError
+      value
     end
   end
 end

data/lib/ializer/fix_num_de_ser.rb

@@ -9,6 +9,8 @@ module Ializer
     def self.parse(value)
       return value if value.is_a? Numeric
 
+      return nil if value.nil?
+
       value.to_i
     end
   end

data/lib/ializer/float_de_ser.rb

@@ -23,6 +23,8 @@ module Ializer
 
       return Float::INFINITY if value == INFINITY_STRING
 
+      return nil if value.nil?
+
       value.to_f
     end
   end

data/lib/ializer/millis_de_ser.rb

@@ -9,7 +9,11 @@ module Ializer
     end
 
     def self.parse(value)
+      return nil if value.nil?
+
       Time.at(value / 1000.0)
+    rescue NoMethodError
+      value
     end
   end
 end

data/lib/ializer/symbol_de_ser.rb

@@ -7,7 +7,11 @@ module Ializer
     end
 
     def self.parse(value)
+      return nil if value.nil?
+
       value.to_sym
+    rescue NoMethodError
+      value
     end
   end
 end

data/lib/ializer/time_de_ser.rb

@@ -10,6 +10,8 @@ module Ializer
 
     def self.parse(value)
       DateTime.iso8601 value
+    rescue ArgumentError
+      value
     end
   end
 end

data/lib/ializer/version.rb

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

data/lib/ser/ializer.rb

@@ -5,9 +5,24 @@ module Ser
     @@method_registry = {} # rubocop:disable Style/ClassVars
 
     class << self
+      def config
+        @config ||=
+          if equal? Ser::Ializer
+            ::Ializer.config
+          else
+            superclass.config
+          end
+      end
+
+      def setup
+        @config = config.dup
+
+        yield @config
+      end
+
       # Public DSL
       def property(name, options = {}, &block)
-        return add_attribute(Field.new(name, options, &block)) if options[:deser]
+        return add_attribute(Field.new(name, options, config, &block)) if options[:deser]
 
         return default(name, options, &block) unless options[:type]
 
@@ -25,7 +40,7 @@ module Ser
           options[:deser] = deser
         end
 
-        add_attribute(Field.new(name, options))
+        add_attribute(Field.new(name, options, config))
       end
 
       def with(deser)
@@ -52,7 +67,7 @@ module Ser
 
         define_singleton_method(method_name) do |name, options = {}, &block|
           options[:deser] = deser
-          add_attribute Field.new(name, options, &block)
+          add_attribute Field.new(name, options, config, &block)
         end
 
         matchers.each do |matcher|
@@ -62,12 +77,12 @@ module Ser
 
       def register_default(deser)
         define_singleton_method('default') do |name, options = {}, &block|
-          raise ArgumentError, warning_message(name) if ::Ializer.config.raise_on_default?
+          raise ArgumentError, warning_message(name) if config.raise_on_default?
 
-          puts warning_message(name) if ::Ializer.config.warn_on_default?
+          puts warning_message(name) if config.warn_on_default?
 
           options[:deser] = deser
-          add_attribute Field.new(name, options, &block)
+          add_attribute Field.new(name, options, config, &block)
         end
       end
 
@@ -137,7 +152,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)
@@ -148,6 +163,26 @@ 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)
+      end
+
+      def fields_names_for_serialization(context) # rubocop:disable Metrics/CyclomaticComplexity
+        return nil unless context
+
+        if context.is_a?(Hash)
+          return context[:attributes] || context[:include] || 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
 

data/lib/ser/ializer/field.rb

@@ -4,19 +4,19 @@ module Ser
   class Ializer
     class Field
       class << self
-        def transform(key)
-          return key unless ::Ializer.config.key_transformer
+        def transform(key, key_transformer)
+          return key unless key_transformer
 
-          ::Ializer.config.key_transformer.call(key)
+          key_transformer.call(key)
         end
       end
 
       attr_reader :name, :setter, :key, :deser, :model_class, :if_condition, :block
 
-      def initialize(name, options, &block)
+      def initialize(name, options, config, &block)
         @name = name
         @setter = options[:setter] || "#{name}="
-        @key = options[:key] || Field.transform(name.to_s)
+        @key = options[:key] || Field.transform(name.to_s, config.key_transformer)
         @deser = options[:deser]
         @if_condition = options[:if]
         @model_class = options[:model_class]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ializer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jeremy Steinberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,16 +98,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.78.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.78.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement