panko_serializer 0.5.10 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ec2a5cbfc062d6b8e272f038638645e3289b94dc9aa730f2317082d1ff2d9c4
-  data.tar.gz: e2d04c62d3b1fcf2f292170181e3a4f689367af7d3cc53719bbbcfc6a7eea9af
+  metadata.gz: c49d12e1be46851f1fdb226b37d1c09673a586d053edb8b084f6345bf74b1637
+  data.tar.gz: e9895a4a74b16c83904ee77961c70259cb84a1d739b46d7203f7bdf2a06d3392
 SHA512:
-  metadata.gz: 80ec461198ad3a7fd1db51a692686b1a90874444a1f6c2c9cde22aef40cf5a79b597804d6ba6aa77b5f7f8e765e5e2dd5b95401b9817b3a8dd5136a1e849fa36
-  data.tar.gz: 7637de2f896f9c6a6b788da226fda929ca28f944eaa1b2b0a4f00f3dd95a771350b6fe0975459502669dadbccc565008708a38263c4baa71f892c95bd8531242
+  metadata.gz: 063cf79e3a6580a71a8b4e6f098cdb1514e7997cd22130a5189c4db7030b39ebada570f721cbfc36e4024141b30da7a40ed6c6d364c39465101f25e5a91baf61
+  data.tar.gz: 73987f5d252b7c2a4f0d901c941901f748536b7e16e017aede986899d1a1471246f7541b6c0aa35a1958b3c18e41bfdcb1795dfa7752296729991d5b0d1455ea

data/.travis.yml

@@ -2,9 +2,9 @@ sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - 2.3.8
   - 2.5.5
   - 2.6.3
+  - 2.7.0-preview1
 
 env:
   global:
@@ -26,8 +26,8 @@ env:
   matrix:
   - "RAILS_VERSION=4.2.0"
   - "RAILS_VERSION=5.2.0"
-  - "RAILS_VERSION=6.0.0.beta3"
+  - "RAILS_VERSION=6.0.0.rc1"
 
 matrix:
   allow_failures:
-    - "RAILS_VERSION=6.0.0.beta3"
+    - "RAILS_VERSION=6.0.0.rc1"

data/Gemfile

@@ -10,8 +10,13 @@ gem "activesupport", rails_version
 gem "activemodel", rails_version
 gem "activerecord", rails_version, group: :test
 
+
 group :benchmarks do
-  gem "sqlite3", "~> 1.3.6"
+  if raw_rails_version.include? "4.2"
+    gem 'sqlite3', '~> 1.3.6'
+  else
+    gem "sqlite3", "~> 1.4"
+  end
 
   if raw_rails_version.include? "4.2"
     gem "pg", "~> 0.15"
@@ -37,4 +42,5 @@ group :development do
   gem "rake"
   gem "rspec", "~> 3.0"
   gem "rake-compiler"
+  gem "rubocop"
 end

data/Rakefile

@@ -19,6 +19,7 @@ end
 
 RSpec::Core::RakeTask.new(:spec)
 Rake::Task[:spec].prerequisites << :compile
+Rake::Task[:compile].prerequisites << :clean
 
 task default: :spec
 

data/benchmarks/bm_object_writer.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require_relative "./benchmarking_support"
+require_relative "./app"
+
+Benchmark.run("ObjectWriter_OneProperty_PushValue") do
+  writer = Panko::ObjectWriter.new
+
+  writer.push_object
+  writer.push_value "value1", "key1"
+  writer.pop
+
+  writer.output
+end
+
+Benchmark.run("ObjectWriter_TwoProperty_PushValue") do
+  writer = Panko::ObjectWriter.new
+
+  writer.push_object
+  writer.push_value "value1", "key1"
+  writer.push_value "value2", "key2"
+  writer.pop
+
+  writer.output
+end
+
+Benchmark.run("ObjectWriter_OneProperty_PushValuePushKey") do
+  writer = Panko::ObjectWriter.new
+
+  writer.push_object
+  writer.push_key "key1"
+  writer.push_value "value1"
+  writer.pop
+
+  writer.output
+end
+
+Benchmark.run("ObjectWriter_TwoProperty_PushValuePushKey") do
+  writer = Panko::ObjectWriter.new
+
+  writer.push_object
+  writer.push_key "key1"
+  writer.push_value "value1"
+
+  writer.push_key "key2"
+  writer.push_value "value2"
+  writer.pop
+
+  writer.output
+end
+
+Benchmark.run("ObjectWriter_NestedObject") do
+  writer = Panko::ObjectWriter.new
+
+  writer.push_object
+  writer.push_value "value1", "key1"
+
+  writer.push_object "key2"
+  writer.push_value "value2", "key2"
+  writer.pop
+
+  writer.pop
+
+  writer.output
+end

data/benchmarks/bm_to_object.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+require_relative "./benchmarking_support"
+require_relative "./app"
+require_relative "./setup"
+
+class PostWithAliasModel < ActiveRecord::Base
+  self.table_name = 'posts'
+
+  alias_attribute :new_id, :id
+  alias_attribute :new_body, :body
+  alias_attribute :new_title, :title
+  alias_attribute :new_author_id, :author_id
+  alias_attribute :new_created_at, :created_at
+end
+
+class PostWithAliasFastSerializer < Panko::Serializer
+  attributes :new_id, :new_body, :new_title, :new_author_id, :new_created_at
+end
+
+def benchmark_aliased(prefix, serializer, options = {})
+  posts = PostWithAliasModel.all.to_a
+  posts_50 = posts.first(50).to_a
+  data = { all: posts, small: posts_50 }
+
+  merged_options = options.merge(each_serializer: serializer)
+
+  Benchmark.run("Panko_#{prefix}_PostWithAliasModels_#{posts.count}") do
+    Panko::ArraySerializer.new(posts, merged_options).to_json
+  end
+
+  posts = PostWithAliasModel.all.to_a
+  posts_50 = posts.first(50).to_a
+  data = { all: posts, small: posts_50 }
+
+  Benchmark.run("Panko_#{prefix}_Posts_50") do
+    Panko::ArraySerializer.new(posts_50, merged_options).to_json
+  end
+end
+
+class AuthorFastSerializer < Panko::Serializer
+  attributes :id, :name
+end
+
+
+class PostFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id, :created_at
+end
+
+class PostFastWithMethodCallSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id, :created_at, :method_call
+
+  def method_call
+    object.id
+  end
+end
+
+class PostWithHasOneFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id, :created_at
+
+  has_one :author, serializer: AuthorFastSerializer
+end
+
+class AuthorWithHasManyFastSerializer < Panko::Serializer
+  attributes :id, :name
+
+  has_many :posts, serializer: PostFastSerializer
+end
+
+
+def benchmark(prefix, serializer, options = {})
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  merged_options = options.merge(each_serializer: serializer)
+
+  Benchmark.run("Panko_#{prefix}_Posts_#{posts.count}") do
+    Panko::ArraySerializer.new(posts, merged_options).to_a
+  end
+
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  Benchmark.run("Panko_#{prefix}_Posts_50") do
+    Panko::ArraySerializer.new(posts_50, merged_options).to_a
+  end
+end
+
+
+
+benchmark "Simple", PostFastSerializer
+benchmark "HasOne", PostWithHasOneFastSerializer

data/docs/attributes.md

@@ -86,7 +86,7 @@ Sometimes you find yourself have the same filtering logic in actions in order to
 class UserSerializer < Panko::Serializer
   attributes :id, :name, :email
 
-  def self.filters_for(context)
+  def self.filters_for(context, scope)
     {
       only: [:name]
     }

data/ext/panko_serializer/attributes_writer/active_record.c

@@ -29,7 +29,6 @@ struct attributes {
   VALUE values;
 
   // heuristicts
-  bool shouldReadFromHash;
   bool tryToReadFromAdditionalTypes;
 };
 
@@ -40,21 +39,18 @@ struct attributes init_context(VALUE obj) {
   attributes_ctx.types = Qnil;
   attributes_ctx.additional_types = Qnil;
 
-  attributes_ctx.shouldReadFromHash = false;
   attributes_ctx.tryToReadFromAdditionalTypes = false;
 
   volatile VALUE lazy_attributes_hash = panko_read_lazy_attributes_hash(obj);
 
   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_attributes_hash, delegate_hash_id);
 
     if (PANKO_EMPTY_HASH(delegate_hash) == false) {
       attributes_ctx.attributes_hash = delegate_hash;
-      attributes_ctx.shouldReadFromHash = true;
     }
 
     attributes_ctx.types = rb_ivar_get(lazy_attributes_hash, types_id);
@@ -73,11 +69,13 @@ VALUE read_attribute(struct attributes attributes_ctx, Attribute attribute) {
   volatile VALUE member, value;
 
   member = attribute->name_str;
-  value = Qundef;
+  value = Qnil;
 
-  if (attributes_ctx.shouldReadFromHash == true) {
+
+  if (!NIL_P(attributes_ctx.attributes_hash)) {
     volatile VALUE attribute_metadata =
         rb_hash_aref(attributes_ctx.attributes_hash, member);
+
     if (attribute_metadata != Qnil) {
       value = rb_ivar_get(attribute_metadata, value_before_type_cast_id);
 
@@ -87,13 +85,11 @@ VALUE read_attribute(struct attributes attributes_ctx, Attribute attribute) {
     }
   }
 
-  if (value == Qundef && !NIL_P(attributes_ctx.values)) {
+  if (NIL_P(value) && !NIL_P(attributes_ctx.values)) {
     value = rb_hash_aref(attributes_ctx.values, member);
-    if (NIL_P(value)) {
-      value = Qundef;
-    }
   }
 
+
   if (NIL_P(attribute->type) && !NIL_P(value)) {
     if (attributes_ctx.tryToReadFromAdditionalTypes == true) {
       attribute->type = rb_hash_aref(attributes_ctx.additional_types, member);

data/ext/panko_serializer/common.h

@@ -3,6 +3,9 @@
 #include <ruby.h>
 
 
+#define PANKO_SAFE_HASH_SIZE(hash) \
+  (hash == Qnil || hash == Qundef) ? 0 : RHASH_SIZE(hash)
+
 #define PANKO_EMPTY_HASH(hash) \
   (hash == Qnil || hash == Qundef) ? 1 : (RHASH_SIZE(hash) == 0)
 

data/ext/panko_serializer/serialization_descriptor/attribute.c

@@ -48,7 +48,7 @@ Attribute attribute_read(VALUE attribute) {
 }
 
 void attribute_try_invalidate(Attribute attribute, VALUE new_record_class) {
-  if (rb_equal(attribute->record_class, new_record_class) == Qfalse) {
+  if (attribute->record_class != new_record_class) {
     attribute->type = Qnil;
     attribute->record_class = new_record_class;
 

data/lib/panko/array_serializer.rb

@@ -2,10 +2,10 @@
 
 module Panko
   class ArraySerializer
-    attr_accessor :objects
+    attr_accessor :subjects
 
-    def initialize(objects, options = {})
-      @objects = objects
+    def initialize(subjects, options = {})
+      @subjects = subjects
       @each_serializer = options[:each_serializer]
 
       if @each_serializer.nil?
@@ -27,22 +27,26 @@ Please pass valid each_serializer to ArraySerializer, for example:
     end
 
     def to_json
-      serialize_to_json @objects
+      serialize_to_json @subjects
     end
 
-    def serialize(objects)
-      Oj.load(serialize_to_json(objects))
+    def serialize(subjects)
+      serialize_with_writer(subjects, Panko::ObjectWriter.new).output
     end
 
     def to_a
-      Oj.load(serialize_to_json(@objects))
+      serialize_with_writer(@subjects, Panko::ObjectWriter.new).output
     end
 
-    def serialize_to_json(objects)
-      writer = Oj::StringWriter.new(mode: :rails)
-      Panko.serialize_objects(objects.to_a, writer, @descriptor)
-      @descriptor.set_serialization_context(nil) unless @serialization_context.is_a?(EmptySerializerContext)
-      writer.to_s
+    def serialize_to_json(subjects)
+      serialize_with_writer(subjects, Oj::StringWriter.new(mode: :rails)).to_s
+    end
+
+    private
+
+    def serialize_with_writer(subjects, writer)
+      Panko.serialize_objects(subjects.to_a, writer, @descriptor)
+      writer
     end
   end
 end

data/lib/panko/attribute.rb

@@ -10,6 +10,7 @@ module Panko
     def ==(attr)
       return name.to_sym == attr if attr.is_a? Symbol
       return name == attr.name && alias_name == attr.alias_name if attr.is_a? Panko::Attribute
+
       super
     end
 

data/lib/panko/object_writer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class Panko::ObjectWriter
+  def initialize
+    @values = []
+    @keys = []
+
+    @next_key = nil
+    @output = nil
+  end
+
+  def push_object(key = nil)
+    @values << {}
+    @keys << key
+  end
+
+  def push_array(key = nil)
+    @values << []
+    @keys << key
+  end
+
+  def push_key(key)
+    @next_key = key
+  end
+
+  def push_value(value, key = nil)
+    unless @next_key.nil?
+      raise "push_value is called with key after push_key is called" unless key.nil?
+      key = @next_key
+      @next_key = nil
+    end
+
+    @values.last[key] = value.as_json
+  end
+
+  def pop
+    result = @values.pop
+
+    if @values.empty?
+      @output = result
+      return
+    end
+
+    scope_key = @keys.pop
+    if scope_key.nil?
+      @values.last << result
+    else
+      @values.last[scope_key] = result
+    end
+  end
+
+  def output
+    raise "Output is called before poping all" unless @values.empty?
+    @output
+  end
+end

data/lib/panko/serializer.rb

@@ -64,6 +64,7 @@ module Panko
 
       def method_added(method)
         return if @_descriptor.nil?
+
         deleted_attr = @_descriptor.attributes.delete(method)
         @_descriptor.method_fields << Attribute.create(method) unless deleted_attr.nil?
       end
@@ -115,14 +116,18 @@ module Panko
     attr_reader :object
 
     def serialize(object)
-      Oj.load(serialize_to_json(object))
+      serialize_with_writer(object, Panko::ObjectWriter.new).output
     end
 
     def serialize_to_json(object)
-      writer = Oj::StringWriter.new(mode: :rails)
+      serialize_with_writer(object, Oj::StringWriter.new(mode: :rails)).to_s
+    end
+
+    private
+
+    def serialize_with_writer(object, writer)
       Panko.serialize_object(object, writer, @descriptor)
-      @descriptor.set_serialization_context(nil) unless @serialization_context.is_a?(EmptySerializerContext)
-      writer.to_s
+      writer
     end
   end
 end

data/lib/panko/version.rb

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

data/lib/panko_serializer.rb

@@ -7,6 +7,7 @@ require "panko/serializer"
 require "panko/array_serializer"
 require "panko/response"
 require "panko/serializer_resolver"
+require "panko/object_writer"
 
 # C Extension
 require "oj"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panko_serializer
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.6.0
 platform: ruby
 authors:
 - Yosi Attias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-20 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -46,11 +46,13 @@ files:
 - benchmarks/app.rb
 - benchmarks/benchmarking_support.rb
 - benchmarks/bm_ams_0_10.rb
+- benchmarks/bm_object_writer.rb
 - benchmarks/bm_panko_json.rb
 - benchmarks/bm_panko_object.rb
 - benchmarks/bm_plain_object.rb
 - benchmarks/bm_serialization_descriptor.rb
 - benchmarks/bm_serializer_resolver.rb
+- benchmarks/bm_to_object.rb
 - benchmarks/profile.rb
 - benchmarks/sanity.rb
 - benchmarks/setup.rb
@@ -90,6 +92,7 @@ files:
 - lib/panko/array_serializer.rb
 - lib/panko/association.rb
 - lib/panko/attribute.rb
+- lib/panko/object_writer.rb
 - lib/panko/response.rb
 - lib/panko/serialization_descriptor.rb
 - lib/panko/serializer.rb