panko_serializer 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c23ba8ef7190648e7834b7e62ac9a247dff9811cf3beeb707d84180057183cf
-  data.tar.gz: 07aeacaf51eb75a786062c25d2693c8a6e0aa79f124e07b7fa0a61cb33dc4ece
+  metadata.gz: b5c1f172b419c50aea9cc47c6f5dbc52972856f08aef2afc1be72da7d051a167
+  data.tar.gz: 73ca52128f528f7d6b2c76ae34fe765a224ee0e8494a502c7550e873b6a50eaf
 SHA512:
-  metadata.gz: 6532cd66f7066bf4caf1ef839cccf5beae1f883b075521b81e8f991e335156188385dec21e48029927b6e8636bdcffc76b40893fbc10485eb1b74672531fdffc
-  data.tar.gz: cc616b33a30f1b8df44a87276f588f5697978edcdef2349797b9b05a10781eeaf1410af143666df2f87a4d670a7be2e913e99a2c3e0339b44d082428089ae366
+  metadata.gz: 9867ec56395cca5bb634385e362074f38b23eba16e81d2145128be32cb09224643be8ba998e46b8b940797e4c4599b3c8da6edb36dc81deeb78ae6e4dcb1b39c
+  data.tar.gz: e10796a79f2a049da21a9895bff29191182989a06b9b31a81aec09f86a4899794c2b49a163069d8fcadcc85d47d86489ed6d97fc643fdaf7a4eece22b71f9058

data/.clang-format

@@ -17,7 +17,7 @@ AllowShortLoopsOnASingleLine: false
 AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
 AlwaysBreakBeforeMultilineStrings: true
-AlwaysBreakTemplateDeclarations: true
+AlwaysBreakTemplateDeclarations: Yes
 BinPackArguments: true
 BinPackParameters: false
 BraceWrapping:   
@@ -39,6 +39,7 @@ BraceWrapping:
 BreakBeforeBinaryOperators: None
 BreakBeforeBraces: Attach
 BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializersBeforeComma: false
 BreakConstructorInitializers: BeforeColon
@@ -81,20 +82,46 @@ MacroBlockBegin: ''
 MacroBlockEnd:   ''
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
 ObjCBlockIndentWidth: 2
 ObjCSpaceAfterProperty: false
-ObjCSpaceBeforeProtocolList: false
+ObjCSpaceBeforeProtocolList: true
 PenaltyBreakAssignment: 2
 PenaltyBreakBeforeFirstCallParameter: 1
 PenaltyBreakComment: 300
 PenaltyBreakFirstLessLess: 120
 PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
 PenaltyExcessCharacter: 1000000
 PenaltyReturnTypeOnItsOwnLine: 200
 PointerAlignment: Left
 RawStringFormats: 
-  - Delimiter:       pb
-    Language:        TextProto
+  - Language:        Cpp
+    Delimiters:      
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - 'c++'
+      - 'C++'
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+  - Language:        TextProto
+    Delimiters:      
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions: 
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+    CanonicalDelimiter: ''
     BasedOnStyle:    google
 ReflowComments:  true
 SortIncludes:    true
@@ -102,7 +129,11 @@ SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
 SpaceAfterTemplateKeyword: true
 SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
 SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
 SpacesInAngles:  false

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 
 gemspec
 
-raw_rails_version = ENV.fetch("RAILS_VERSION", "4.2")
+raw_rails_version = ENV.fetch("RAILS_VERSION", "5.2")
 rails_version = "~> #{raw_rails_version}"
 
 gem "activesupport", rails_version

data/benchmarks/bm_ams_0_10.rb

@@ -48,9 +48,3 @@ benchmark_ams "Attributes_HasOne", AmsPostWithHasOneFastSerializer
 benchmark_ams "Attributes_Except", AmsPostWithHasOneFastSerializer, except: [:title]
 benchmark_ams "Attributes_Only", AmsPostWithHasOneFastSerializer, only: [:id, :body, :author_id, :author]
 
-ActiveModel::Serializer.config.adapter = :json_api
-
-benchmark_ams "JsonAPI_Simple", AmsPostFastSerializer
-benchmark_ams "JsonAPI_HasOne", AmsPostWithHasOneFastSerializer
-benchmark_ams "JsonAPI_Except", AmsPostWithHasOneFastSerializer, except: [:title]
-benchmark_ams "JsonAPI_Only", AmsPostWithHasOneFastSerializer, only: [:id, :body, :author_id, :author]

data/docs/performance.md

@@ -4,32 +4,26 @@ The performance of Panko is measured using microbenchmarks and load testing.
 
 ## Microbenchmarks
 
-The following microbenchmarks are run on MacBook Pro (Retina, 15-inch, Mid 2015), Ruby 2.4 with Rails 4.2
-demonstrating the performance of ActiveModelSerializers 0.9 and Panko 0.3.3
-
-
- Benchmark                             | AMS ip/s     | Panko ip/s
----------------------------------------|----------|-----------------
-| Simple_Posts_2300               | 25.81   | 135.29         |
-| Simple_Posts_50                 | 1,248.39 | 6,518.68          |
-| HasOne_Posts_2300               | 11.33     | 73.42         |
-| HasOne_Posts_50                 | 523.14  | 4,985.41           |
-
-> The corresponding benchmarks are `benchmarks/bm_active_model_serializers.rb` and `benchmarks/bm_panko_json.rb`
+The following microbenchmarks are run on MacBook Pro (Retina, 15-inch, 2017), Ruby 2.5.1 with Rails 5.2.1
+demonstrating the performance of ActiveModelSerializers 0.10.7 and Panko 0.5.6
 
+| Benchmark         | AMS ip/s | Panko ip/s |
+| ----------------- | -------- | ---------- |
+| Simple_Posts_2300 | 9.47     | 185.9      |
+| Simple_Posts_50   | 450.49   | 9,237.66   |
+| HasOne_Posts_2300 | 4.27     | 104.39     |
+| HasOne_Posts_50   | 219.67   | 4,901.09   |
 
 ## Real-world benchmark
 
 The real-world benchmark here is endpoint which serializes 7,884 entries with 48 attributes and no associations.
 The benchmark took place in environment that simulates production environment and run using `wrk` from machine on the same cluster.
 
+| Metric             | AMS   | Panko |
+| ------------------ | ----- | ----- |
+| Avg Response Time  | 4.89s | 1.48s |
+| Max Response Time  | 5.42s | 1.83s |
+| 99th Response Time | 5.42s | 1.74s |
+| Total Requests     | 61    | 202   |
 
-Metric | AMS | Panko
------------- |------------ | -------------
-Avg Response Time| 4.89s| 1.48s|
-Max Response Time| 5.42s| 1.83s|
-99th Response Time| 5.42s| 1.74s|
-Total Requests| 61| 202|
-
-
-*Thanks to [Bringg](https://www.bringg.com) for providing the infrastructrue for the benchmarks*
+_Thanks to [Bringg](https://www.bringg.com) for providing the infrastructure for the benchmarks_

data/ext/panko_serializer/attributes_writer/active_record.c

@@ -21,15 +21,6 @@ VALUE panko_read_lazy_attributes_hash(VALUE object) {
   return lazy_attributes_hash;
 }
 
-void panko_read_types_and_value(VALUE attributes_hash,
-                                VALUE* types,
-                                VALUE* additional_types,
-                                VALUE* values) {
-  *types = rb_ivar_get(attributes_hash, types_id);
-  *additional_types = rb_ivar_get(attributes_hash, additional_types_id);
-  *values = rb_ivar_get(attributes_hash, values_id);
-}
-
 void read_attribute_from_hash(VALUE attributes_hash,
                               VALUE member,
                               volatile VALUE* value,
@@ -66,25 +57,27 @@ struct attributes init_context(VALUE obj) {
   attributes_ctx.shouldReadFromHash = false;
   attributes_ctx.tryToReadFromAdditionalTypes = false;
 
-  volatile VALUE lazy_attribute_hash = panko_read_lazy_attributes_hash(obj);
+  volatile VALUE lazy_attributes_hash = panko_read_lazy_attributes_hash(obj);
 
-  if (RB_TYPE_P(lazy_attribute_hash, T_HASH)) {
-    attributes_ctx.attributes_hash = lazy_attribute_hash;
+  if (RB_TYPE_P(lazy_attributes_hash, T_HASH)) {
+    attributes_ctx.attributes_hash = lazy_attributes_hash;
     attributes_ctx.shouldReadFromHash = true;
   } else {
     volatile VALUE delegate_hash =
-        rb_ivar_get(lazy_attribute_hash, delegate_hash_id);
-    if (!PANKO_EMPTY_HASH(delegate_hash)) {
+        rb_ivar_get(lazy_attributes_hash, delegate_hash_id);
+
+    if (PANKO_EMPTY_HASH(delegate_hash) == false) {
       attributes_ctx.attributes_hash = delegate_hash;
       attributes_ctx.shouldReadFromHash = true;
     }
 
-    panko_read_types_and_value(lazy_attribute_hash, &attributes_ctx.types,
-                               &attributes_ctx.additional_types,
-                               &attributes_ctx.values);
+    attributes_ctx.types = rb_ivar_get(lazy_attributes_hash, types_id);
+    attributes_ctx.values = rb_ivar_get(lazy_attributes_hash, values_id);
 
+    attributes_ctx.additional_types =
+        rb_ivar_get(lazy_attributes_hash, additional_types_id);
     attributes_ctx.tryToReadFromAdditionalTypes =
-        !PANKO_EMPTY_HASH(attributes_ctx.additional_types);
+        PANKO_EMPTY_HASH(attributes_ctx.additional_types) == false;
   }
 
   return attributes_ctx;
@@ -101,13 +94,13 @@ VALUE read_attribute(struct attributes attributes_ctx, Attribute attribute) {
     }
   }
 
-  if (value == Qundef && attributes_ctx.shouldReadFromHash) {
+  if (value == Qundef && attributes_ctx.shouldReadFromHash == true) {
     read_attribute_from_hash(attributes_ctx.attributes_hash, member, &value,
                              &attribute->type);
   }
 
   if (NIL_P(attribute->type) && !NIL_P(value)) {
-    if (attributes_ctx.tryToReadFromAdditionalTypes) {
+    if (attributes_ctx.tryToReadFromAdditionalTypes == true) {
       attribute->type = rb_hash_aref(attributes_ctx.additional_types, member);
     }
 
@@ -123,10 +116,10 @@ VALUE read_attribute(struct attributes attributes_ctx, Attribute attribute) {
   return value;
 }
 
-VALUE active_record_attributes_writer(VALUE obj,
-                                      VALUE attributes,
-                                      EachAttributeFunc func,
-                                      VALUE writer) {
+void active_record_attributes_writer(VALUE obj,
+                                     VALUE attributes,
+                                     EachAttributeFunc func,
+                                     VALUE writer) {
   long i;
   struct attributes attributes_ctx = init_context(obj);
   volatile VALUE record_class = CLASS_OF(obj);
@@ -140,8 +133,6 @@ VALUE active_record_attributes_writer(VALUE obj,
 
     func(writer, attr_name_for_serialization(attribute), value);
   }
-
-  return Qnil;
 }
 
 void init_active_record_attributes_writer(VALUE mPanko) {

data/ext/panko_serializer/attributes_writer/active_record.h

@@ -3,14 +3,14 @@
 #include <ruby.h>
 #include <stdbool.h>
 
+#include "../common.h"
 #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,
-                                             EachAttributeFunc func,
-                                             VALUE context);
+extern void active_record_attributes_writer(VALUE object,
+                                            VALUE attributes,
+                                            EachAttributeFunc func,
+                                            VALUE context);
 
 void init_active_record_attributes_writer(VALUE mPanko);

data/ext/panko_serializer/attributes_writer/{writer.c → attributes_writer.c}

@@ -1,11 +1,11 @@
-#include "writer.h"
+#include "attributes_writer.h"
 
 static bool types_initialized = false;
 static VALUE ar_base_type = Qundef;
 
-void init_types(VALUE v) {
+VALUE init_types(VALUE v) {
   if (types_initialized == true) {
-    return;
+    return Qundef;
   }
 
   types_initialized = true;
@@ -13,6 +13,8 @@ void init_types(VALUE v) {
   volatile VALUE ar_type =
       rb_const_get_at(rb_cObject, rb_intern("ActiveRecord"));
   ar_base_type = rb_const_get_at(ar_type, rb_intern("Base"));
+
+  return Qundef;
 }
 
 AttributesWriter create_attributes_writer(VALUE subject) {
@@ -33,12 +35,10 @@ AttributesWriter create_attributes_writer(VALUE subject) {
   return create_empty_attributes_writer();
 }
 
-VALUE empty_write_attributes(VALUE obj,
-                             VALUE attributes,
-                             EachAttributeFunc func,
-                             VALUE writer) {
-  return Qnil;
-}
+void empty_write_attributes(VALUE obj,
+                            VALUE attributes,
+                            EachAttributeFunc func,
+                            VALUE writer) {}
 
 AttributesWriter create_empty_attributes_writer() {
   return (AttributesWriter){.object_type = Unknown,

data/ext/panko_serializer/attributes_writer/{writer.h → attributes_writer.h}

@@ -11,10 +11,10 @@ enum ObjectType { Unknown = 0, ActiveRecord = 1, Plain = 2 };
 typedef struct _AttributesWriter {
   enum ObjectType object_type;
 
-  int (*write_attributes)(VALUE object,
-                          VALUE attributes,
-                          EachAttributeFunc func,
-                          VALUE context);
+  void (*write_attributes)(VALUE object,
+                           VALUE attributes,
+                           EachAttributeFunc func,
+                           VALUE context);
 } AttributesWriter;
 
 /**

data/ext/panko_serializer/attributes_writer/plain.c

@@ -1,9 +1,9 @@
 #include "plain.h"
 
-VALUE plain_attributes_writer(VALUE obj,
-                              VALUE attributes,
-                              EachAttributeFunc func,
-                              VALUE writer) {
+void plain_attributes_writer(VALUE obj,
+                             VALUE attributes,
+                             EachAttributeFunc func,
+                             VALUE writer) {
   long i;
   for (i = 0; i < RARRAY_LEN(attributes); i++) {
     volatile VALUE raw_attribute = RARRAY_AREF(attributes, i);
@@ -12,6 +12,4 @@ VALUE plain_attributes_writer(VALUE obj,
 
     func(writer, attr_name_for_serialization(attribute), value);
   }
-
-  return Qnil;
 }

data/ext/panko_serializer/attributes_writer/plain.h

@@ -3,7 +3,7 @@
 #include "common.h"
 #include "ruby.h"
 
-VALUE plain_attributes_writer(VALUE obj,
-                              VALUE attributes,
-                              EachAttributeFunc func,
-                              VALUE writer);
+void plain_attributes_writer(VALUE obj,
+                             VALUE attributes,
+                             EachAttributeFunc func,
+                             VALUE writer);

data/ext/panko_serializer/panko_serializer.h

@@ -1,6 +1,6 @@
 #include <ruby.h>
 
-#include "attributes_writer/writer.h"
+#include "attributes_writer/attributes_writer.h"
 #include "serialization_descriptor/association.h"
 #include "serialization_descriptor/attribute.h"
 #include "serialization_descriptor/serialization_descriptor.h"

data/ext/panko_serializer/serialization_descriptor/serialization_descriptor.c

@@ -2,7 +2,6 @@
 
 VALUE cSerializationDescriptor;
 
-static ID context_id;
 static ID object_id;
 static ID sc_id;
 
@@ -59,7 +58,6 @@ void sd_set_writer(SerializationDescriptor sd, VALUE subject) {
   sd->attributes_writer = create_attributes_writer(subject);
 }
 
-
 VALUE sd_serializer_set(VALUE self, VALUE serializer) {
   SerializationDescriptor sd = (SerializationDescriptor)DATA_PTR(self);
 

data/ext/panko_serializer/serialization_descriptor/serialization_descriptor.h

@@ -3,7 +3,7 @@
 #include <ruby.h>
 #include <stdbool.h>
 
-#include "attributes_writer/writer.h"
+#include "attributes_writer/attributes_writer.h"
 
 typedef struct _SerializationDescriptor {
   // type of the serializer, so we can create it later

data/lib/panko/response.rb

@@ -51,7 +51,7 @@ module Panko
     def write(writer, data, key = nil)
       return write_array(writer, data, key) if data.is_a?(Array)
 
-      return write_object(writer, data) if data.is_a?(Hash)
+      return write_object(writer, data, key) if data.is_a?(Hash)
 
       write_value(writer, data, key)
     end

data/lib/panko/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panko_serializer
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Yosi Attias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -67,6 +67,8 @@ files:
 - docs/response-bag.md
 - ext/panko_serializer/attributes_writer/active_record.c
 - ext/panko_serializer/attributes_writer/active_record.h
+- ext/panko_serializer/attributes_writer/attributes_writer.c
+- ext/panko_serializer/attributes_writer/attributes_writer.h
 - ext/panko_serializer/attributes_writer/common.c
 - ext/panko_serializer/attributes_writer/common.h
 - ext/panko_serializer/attributes_writer/plain.c
@@ -75,8 +77,6 @@ files:
 - ext/panko_serializer/attributes_writer/type_cast/time_conversion.h
 - ext/panko_serializer/attributes_writer/type_cast/type_cast.c
 - 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