panko_serializer 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d2e6523f47bf65ff0dca7931267fc0d0402ac68f4490ff643eeafa589b8249d
-  data.tar.gz: 9fd3025b410b6ed6a29206ae02d868300b7b4fcc458987aaaeadb2117466bad3
+  metadata.gz: 3a76c5943a2aa638978b5c044203810bbd993e66a9d18c584149ec0fab559a27
+  data.tar.gz: b7e7337631ba79c9226e5a1e95f2190f2598ca768056b98bf160159ac7b192b4
 SHA512:
-  metadata.gz: 64cb44e5e8b0dd3406eb720b34aff1eea7bd29f51e7f62a9b98d79690f76d4d4d1f645754f75b5efc880bca313a646cb52aeda667968f6917216bdb311ad8efd
-  data.tar.gz: 40ffe87725181f27edbeaf5e023c09b70ef836c20fdd8ab018c70ee59d0df42a5ae9c370d9eeb67e215be6404cb3c4c0f826f33ea6b6c6db0a162cac66c12c45
+  metadata.gz: c366b1a541ccc4575bef00ffacb06fe18693e0018f7f2c08bd6350dba7a39832f58cf1ba69f0bfcdd82e1b6bbd2b28274089382d521e070fb307a2b064ff1e1f
+  data.tar.gz: 02cec8e1f86cae29072071d52c0249400fbf73b6ffaa12a70653b0f6f18754269a31af6534ef36051e49ed3d83c5c61e094d7068c9c53ad6b19a28cfa20537d8

data/.clang-format

@@ -81,10 +81,9 @@ MacroBlockBegin: ''
 MacroBlockEnd:   ''
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
-ObjCBinPackProtocolList: Never
 ObjCBlockIndentWidth: 2
 ObjCSpaceAfterProperty: false
-ObjCSpaceBeforeProtocolList: true
+ObjCSpaceBeforeProtocolList: false
 PenaltyBreakAssignment: 2
 PenaltyBreakBeforeFirstCallParameter: 1
 PenaltyBreakComment: 300
@@ -94,13 +93,8 @@ PenaltyExcessCharacter: 1000000
 PenaltyReturnTypeOnItsOwnLine: 200
 PointerAlignment: Left
 RawStringFormats: 
-  - Language:        TextProto
-    Delimiters:      
-      - pb
-      - PB
-      - proto
-      - PROTO
-    CanonicalDelimiter: ''
+  - Delimiter:       pb
+    Language:        TextProto
     BasedOnStyle:    google
 ReflowComments:  true
 SortIncludes:    true
@@ -108,10 +102,7 @@ SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
 SpaceAfterTemplateKeyword: true
 SpaceBeforeAssignmentOperators: true
-SpaceBeforeCtorInitializerColon: true
-SpaceBeforeInheritanceColon: true
 SpaceBeforeParens: ControlStatements
-SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
 SpacesInAngles:  false

data/benchmarks/setup.rb

@@ -27,14 +27,6 @@ ActiveRecord::Schema.define do
     t.references :author
     t.timestamps(null: false)
   end
-
-  create_table :profiles, force: true do |t|
-    t.text :project_url
-    t.text :bio
-    t.date :birthday
-    t.references :author
-    t.timestamps(null: false)
-  end
 end
 
 class Author < ActiveRecord::Base
@@ -46,9 +38,8 @@ class Post < ActiveRecord::Base
   belongs_to :author
 end
 
-class Profile < ActiveRecord::Base
-  belongs_to :author
-end
+Post.destroy_all
+Author.destroy_all
 
 # Build out the data to serialize
 Post.transaction do

data/ext/panko_serializer/attributes_writer/active_record.c

@@ -9,19 +9,15 @@ static ID delegate_hash_id;
 static ID value_before_type_cast_id;
 static ID type_id;
 
-VALUE read_attributes(VALUE obj) {
-  return rb_ivar_get(obj, attributes_id);
-}
-
 VALUE panko_read_lazy_attributes_hash(VALUE object) {
   volatile VALUE attributes_set, lazy_attributes_hash;
 
-  attributes_set = read_attributes(object);
-  if (attributes_set == Qnil) {
+  attributes_set = rb_ivar_get(object, attributes_id);
+  if (NIL_P(attributes_set)) {
     return Qnil;
   }
 
-  lazy_attributes_hash = read_attributes(attributes_set);
+  lazy_attributes_hash = rb_ivar_get(attributes_set, attributes_id);
   return lazy_attributes_hash;
 }
 
@@ -34,14 +30,6 @@ void panko_read_types_and_value(VALUE attributes_hash,
   *values = rb_ivar_get(attributes_hash, values_id);
 }
 
-bool panko_is_empty_hash(VALUE hash) {
-  if (hash == Qnil || hash == Qundef) {
-    return true;
-  }
-
-  return RHASH_SIZE(hash) == 0;
-}
-
 void read_attribute_from_hash(VALUE attributes_hash,
                               VALUE member,
                               volatile VALUE* value,
@@ -50,7 +38,7 @@ void read_attribute_from_hash(VALUE attributes_hash,
   if (attribute_metadata != Qnil) {
     *value = rb_ivar_get(attribute_metadata, value_before_type_cast_id);
 
-    if (*type == Qnil) {
+    if (NIL_P(*type)) {
       *type = rb_ivar_get(attribute_metadata, type_id);
     }
   }
@@ -80,17 +68,13 @@ struct attributes init_context(VALUE obj) {
 
   volatile VALUE lazy_attribute_hash = panko_read_lazy_attributes_hash(obj);
 
-  if (lazy_attribute_hash == Qnil) {
-    // TODO: handle
-  }
-
   if (RB_TYPE_P(lazy_attribute_hash, T_HASH)) {
     attributes_ctx.attributes_hash = lazy_attribute_hash;
     attributes_ctx.shouldReadFromHash = true;
   } else {
     volatile VALUE delegate_hash =
         rb_ivar_get(lazy_attribute_hash, delegate_hash_id);
-    if (!panko_is_empty_hash(delegate_hash)) {
+    if (!PANKO_EMPTY_HASH(delegate_hash)) {
       attributes_ctx.attributes_hash = delegate_hash;
       attributes_ctx.shouldReadFromHash = true;
     }
@@ -100,7 +84,7 @@ struct attributes init_context(VALUE obj) {
                                &attributes_ctx.values);
 
     attributes_ctx.tryToReadFromAdditionalTypes =
-        !panko_is_empty_hash(attributes_ctx.additional_types);
+        !PANKO_EMPTY_HASH(attributes_ctx.additional_types);
   }
 
   return attributes_ctx;
@@ -110,9 +94,9 @@ VALUE read_attribute(struct attributes attributes_ctx, Attribute attribute) {
   VALUE member = attribute->name_str;
   volatile VALUE value = Qundef;
 
-  if (attributes_ctx.values != Qnil && value == Qundef) {
+  if (!NIL_P(attributes_ctx.values)) {
     value = rb_hash_aref(attributes_ctx.values, member);
-    if (value == Qnil) {
+    if (NIL_P(value)) {
       value = Qundef;
     }
   }
@@ -122,17 +106,17 @@ VALUE read_attribute(struct attributes attributes_ctx, Attribute attribute) {
                              &attribute->type);
   }
 
-  if (attribute->type == Qnil) {
+  if (NIL_P(attribute->type) && !NIL_P(value)) {
     if (attributes_ctx.tryToReadFromAdditionalTypes) {
       attribute->type = rb_hash_aref(attributes_ctx.additional_types, member);
     }
 
-    if (attributes_ctx.types != Qnil && attribute->type == Qnil) {
+    if (!NIL_P(attributes_ctx.types) && NIL_P(attribute->type)) {
       attribute->type = rb_hash_aref(attributes_ctx.types, member);
     }
   }
 
-  if (attribute->type != Qnil && value != Qnil) {
+  if (!NIL_P(attribute->type) && !NIL_P(value)) {
     return type_cast(attribute->type, value);
   }
 
@@ -149,7 +133,7 @@ VALUE active_record_attributes_writer(VALUE obj,
 
   for (i = 0; i < RARRAY_LEN(attributes); i++) {
     volatile VALUE raw_attribute = RARRAY_AREF(attributes, i);
-    Attribute attribute = attribute_read(raw_attribute);
+    Attribute attribute = PANKO_ATTRIBUTE_READ(raw_attribute);
     attribute_try_invalidate(attribute, record_class);
 
     volatile VALUE value = read_attribute(attributes_ctx, attribute);

data/ext/panko_serializer/attributes_writer/active_record.h

@@ -6,6 +6,7 @@
 #include "common.h"
 #include "serialization_descriptor/attribute.h"
 #include "type_cast/type_cast.h"
+#include "../common.h"
 
 extern VALUE active_record_attributes_writer(VALUE object,
                                              VALUE attributes,

data/ext/panko_serializer/common.h

@@ -0,0 +1,8 @@
+#pragma once
+
+#include <ruby.h>
+
+
+#define PANKO_EMPTY_HASH(hash) \
+  (hash == Qnil || hash == Qundef) ? 1 : (RHASH_SIZE(hash) == 0)
+

data/ext/panko_serializer/panko_serializer.c

@@ -19,23 +19,25 @@ void write_value(VALUE str_writer, VALUE key, VALUE value) {
 void serialize_method_fields(VALUE subject,
                              VALUE str_writer,
                              SerializationDescriptor descriptor) {
-  VALUE method_fields, serializer;
+  if (RARRAY_LEN(descriptor->method_fields) == 0) {
+    return;
+  }
+
+  volatile VALUE method_fields, serializer;
   long i;
 
   method_fields = descriptor->method_fields;
-  if (RARRAY_LEN(method_fields) == 0) {
-    return;
-  }
 
   serializer = descriptor->serializer;
   rb_ivar_set(serializer, object_id, subject);
 
   for (i = 0; i < RARRAY_LEN(method_fields); i++) {
-    volatile VALUE attribute_name = RARRAY_AREF(method_fields, i);
-    volatile VALUE result =
-        rb_funcall(serializer, rb_sym2id(attribute_name), 0);
+    volatile VALUE raw_attribute = RARRAY_AREF(method_fields, i);
+    Attribute attribute = PANKO_ATTRIBUTE_READ(raw_attribute);
+
+    volatile VALUE result = rb_funcall(serializer, attribute->name_id, 0);
 
-    write_value(str_writer, rb_sym2str(attribute_name), result);
+    write_value(str_writer, attribute->name_str, result);
   }
 
   rb_ivar_set(serializer, object_id, Qnil);
@@ -61,7 +63,7 @@ void serialize_has_one_associations(VALUE subject,
 
     volatile VALUE value = rb_funcall(subject, association->name_id, 0);
 
-    if (value == Qnil) {
+    if (NIL_P(value)) {
       write_value(str_writer, association->name_str, value);
     } else {
       serialize_subject(association->name_str, value, str_writer,
@@ -81,7 +83,7 @@ void serialize_has_many_associations(VALUE subject,
 
     volatile VALUE value = rb_funcall(subject, association->name_id, 0);
 
-    if (value == Qnil) {
+    if (NIL_P(value)) {
       write_value(str_writer, association->name_str, value);
     } else {
       serialize_subjects(association->name_str, value, str_writer,
@@ -100,12 +102,12 @@ VALUE serialize_subject(VALUE key,
 
   serialize_fields(subject, str_writer, descriptor);
 
-  if (RARRAY_LEN(descriptor->has_one_associations) >= 0) {
+  if (RARRAY_LEN(descriptor->has_one_associations) > 0) {
     serialize_has_one_associations(subject, str_writer, descriptor,
                                    descriptor->has_one_associations);
   }
 
-  if (RARRAY_LEN(descriptor->has_many_associations) >= 0) {
+  if (RARRAY_LEN(descriptor->has_many_associations) > 0) {
     serialize_has_many_associations(subject, str_writer, descriptor,
                                     descriptor->has_many_associations);
   }
@@ -163,7 +165,6 @@ void Init_panko_serializer() {
   object_id = rb_intern("@object");
   serialization_context_id = rb_intern("@serialization_context");
 
-
   VALUE mPanko = rb_define_module("Panko");
 
   rb_define_singleton_method(mPanko, "serialize_subject", serialize_subject_api,

data/ext/panko_serializer/serialization_descriptor/attribute.c

@@ -59,7 +59,7 @@ void attribute_try_invalidate(Attribute attribute, VALUE new_record_class) {
     volatile VALUE ar_aliases_hash =
         rb_funcall(new_record_class, attribute_aliases_id, 0);
 
-    if (!panko_is_empty_hash(ar_aliases_hash)) {
+    if (!PANKO_EMPTY_HASH(ar_aliases_hash)) {
       volatile VALUE aliasedValue =
           rb_hash_aref(ar_aliases_hash, attribute->name_str);
       if (aliasedValue != Qnil) {

data/ext/panko_serializer/serialization_descriptor/attribute.h

@@ -3,6 +3,8 @@
 #ifndef __ATTRIBUTE_H__
 #define __ATTRIBUTE_H__
 
+#include "../common.h"
+
 typedef struct _Attribute {
   VALUE name_str;
   ID name_id;
@@ -20,4 +22,6 @@ Attribute attribute_read(VALUE attribute);
 void attribute_try_invalidate(Attribute attribute, VALUE record);
 void panko_init_attribute(VALUE mPanko);
 
+#define PANKO_ATTRIBUTE_READ(attribute) (Attribute)DATA_PTR(attribute)
+
 #endif

data/ext/panko_serializer/serialization_descriptor/serialization_descriptor.c

@@ -140,12 +140,6 @@ VALUE sd_aliases_aref(VALUE self, VALUE aliases) {
   return sd->aliases;
 }
 
-// Exposing this for testing
-VALUE public_sd_build_serializer(VALUE self) {
-  SerializationDescriptor sd = (SerializationDescriptor)DATA_PTR(self);
-  return sd_build_serializer(sd);
-}
-
 void panko_init_serialization_descriptor(VALUE mPanko) {
   object_id = rb_intern("@object");
   sc_id = rb_intern("@sc");

data/lib/panko/array_serializer.rb

@@ -22,9 +22,7 @@ Please pass valid each_serializer to ArraySerializer, for example:
         scope: options[:scope]
       }
 
-      @serialization_context = if options.key?(:context) || options.key?(:scope)
-                                 SerializationContext.new(options[:context], options[:scope])
-                               end
+      @serialization_context = SerializationContext.create(options)
       @descriptor = Panko::SerializationDescriptor.build(@each_serializer, serializer_options, @serialization_context)
     end
 
@@ -43,7 +41,7 @@ Please pass valid each_serializer to ArraySerializer, for example:
     def serialize_to_json(subjects)
       writer = Oj::StringWriter.new(mode: :rails)
       Panko.serialize_subjects(subjects.to_a, writer, @descriptor)
-      @descriptor.set_serialization_context(nil) if @serialization_context.present?
+      @descriptor.set_serialization_context(nil) unless @serialization_context.is_a?(EmptySerializerContext)
       writer.to_s
     end
   end

data/lib/panko/serialization_descriptor.rb

@@ -39,7 +39,7 @@ module Panko
     end
 
     def set_serialization_context(context)
-      serializer.instance_variable_set :@serialization_context, context if !method_fields.empty? && serializer.present?
+      serializer.serialization_context = context if !method_fields.empty? && !serializer.nil?
 
       has_many_associations.each do |assoc|
         assoc.descriptor.set_serialization_context context
@@ -65,7 +65,7 @@ module Panko
         attributes_except_filters
       )
 
-      self.method_fields = apply_fields_filters(
+      self.method_fields = apply_attribute_filters(
         method_fields,
         attributes_only_filters,
         attributes_except_filters

data/lib/panko/serializer.rb

@@ -10,6 +10,24 @@ class SerializationContext
     @context = context
     @scope = scope
   end
+
+  def self.create(options)
+    if options.key?(:context) || options.key?(:scope)
+      SerializationContext.new(options[:context], options[:scope])
+    else
+      EmptySerializerContext.new
+    end
+  end
+end
+
+class EmptySerializerContext
+  def scope
+    nil
+  end
+
+  def context
+    nil
+  end
 end
 
 module Panko
@@ -47,7 +65,7 @@ module Panko
       def method_added(method)
         return if @_descriptor.nil?
         deleted_attr = @_descriptor.attributes.delete(method)
-        @_descriptor.method_fields << method unless deleted_attr.nil?
+        @_descriptor.method_fields << Attribute.create(method) unless deleted_attr.nil?
       end
 
       def has_one(name, options = {})
@@ -81,10 +99,7 @@ module Panko
       # this "_skip_init" trick is so I can create serializers from serialization descriptor
       return if options[:_skip_init]
 
-      @serialization_context = if options.key?(:context) || options.key?(:scope)
-                                 SerializationContext.new(options[:context], options[:scope])
-                               end
-
+      @serialization_context = SerializationContext.create(options)
       @descriptor = Panko::SerializationDescriptor.build(self.class, options, @serialization_context)
     end
 
@@ -96,6 +111,7 @@ module Panko
       @serialization_context.scope
     end
 
+    attr_writer :serialization_context
     attr_reader :object
 
     def serialize(object)
@@ -105,8 +121,7 @@ module Panko
     def serialize_to_json(object)
       writer = Oj::StringWriter.new(mode: :rails)
       Panko.serialize_subject(object, writer, @descriptor)
-
-      @descriptor.set_serialization_context(nil) if @serialization_context.present?
+      @descriptor.set_serialization_context(nil) unless @serialization_context.is_a?(EmptySerializerContext)
       writer.to_s
     end
   end

data/lib/panko/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Panko
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panko_serializer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Yosi Attias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-10 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -77,6 +77,7 @@ files:
 - ext/panko_serializer/attributes_writer/type_cast/type_cast.h
 - ext/panko_serializer/attributes_writer/writer.c
 - ext/panko_serializer/attributes_writer/writer.h
+- ext/panko_serializer/common.h
 - ext/panko_serializer/extconf.rb
 - ext/panko_serializer/panko_serializer.c
 - ext/panko_serializer/panko_serializer.h