panko_serializer 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c49d12e1be46851f1fdb226b37d1c09673a586d053edb8b084f6345bf74b1637
-  data.tar.gz: e9895a4a74b16c83904ee77961c70259cb84a1d739b46d7203f7bdf2a06d3392
+  metadata.gz: c4f169a6a48bba339628ae84995ec2ee3bf66ef059e941be74a89dbe6ec4e983
+  data.tar.gz: dff287d42fe253ef3647f0555e47be7fea55ecc2cf1025cb6b0e55a734ca7806
 SHA512:
-  metadata.gz: 063cf79e3a6580a71a8b4e6f098cdb1514e7997cd22130a5189c4db7030b39ebada570f721cbfc36e4024141b30da7a40ed6c6d364c39465101f25e5a91baf61
-  data.tar.gz: 73987f5d252b7c2a4f0d901c941901f748536b7e16e017aede986899d1a1471246f7541b6c0aa35a1958b3c18e41bfdcb1795dfa7752296729991d5b0d1455ea
+  metadata.gz: 6e7507ee84bf00be48b9a5e35c9f06aacf083216242925889e2f1f0dfb24d87ba1a3ddbdd77bbf580f3000c5671873344dd32e98eea77f84bf175b4cf7c746be
+  data.tar.gz: 0cb0515ccd98c7f260f81d7e1ecb1f684d70d03609b849fd2141d4a4630946622cbc34a6ae1666f6ca5a226066f959280b08bde5ad81f6c02e7d59cf9da6f466

data/.travis.yml

@@ -26,8 +26,4 @@ env:
   matrix:
   - "RAILS_VERSION=4.2.0"
   - "RAILS_VERSION=5.2.0"
-  - "RAILS_VERSION=6.0.0.rc1"
-
-matrix:
-  allow_failures:
-    - "RAILS_VERSION=6.0.0.rc1"
+  - "RAILS_VERSION=6.0.0"

data/benchmarks/app.rb

@@ -3,6 +3,7 @@ require "bundler/setup"
 
 
 require "active_model"
+require "active_record"
 require "active_support"
 require "active_support/json"
 

data/docs/associations.md

@@ -5,7 +5,7 @@ A serializer can define it's own associations - both `has_many` and `has_one` to
 For example:
 
 ```ruby
-class PostSerializer < Panko::Serailizer
+class PostSerializer < Panko::Serializer
   attributes :title, :body
 
   has_one :author, serializer: AuthorSerializer
@@ -13,13 +13,27 @@ class PostSerializer < Panko::Serailizer
 end
 ```
 
+# Associations with aliases
+
+An association key name can be aliased with the `name` option.
+
+For example:
+the `actual_author` property will be converted to `alias_author`.
+```ruby
+class PostSerializer < Panko::Serializer
+  attributes :title, :body
+
+  has_one :actual_author, serializer: AuthorSerializer, name: :alias_author
+  has_many :comments, each_serializer: CommentSerializer
+end
+```
 ### Inference
 
 Panko can find the type of the serializer by looking at the realtionship name, so instead specifying
 the serializer at the above example, we can -
 
 ```ruby
-class PostSerializer < Panko::Serailizer
+class PostSerializer < Panko::Serializer
   attributes :title, :body
 
   has_one :author

data/ext/panko_serializer/attributes_writer/attributes_writer.c

@@ -2,6 +2,7 @@
 
 static bool types_initialized = false;
 static VALUE ar_base_type = Qundef;
+static VALUE hash_type = Qundef;
 
 VALUE init_types(VALUE v) {
   if (types_initialized == true) {
@@ -14,6 +15,8 @@ VALUE init_types(VALUE v) {
       rb_const_get_at(rb_cObject, rb_intern("ActiveRecord"));
   ar_base_type = rb_const_get_at(ar_type, rb_intern("Base"));
 
+  hash_type = rb_const_get_at(rb_cObject, rb_intern("Hash"));
+
   return Qundef;
 }
 
@@ -28,6 +31,12 @@ AttributesWriter create_attributes_writer(VALUE object) {
         .object_type = ActiveRecord,
         .write_attributes = active_record_attributes_writer};
   }
+
+  if (rb_obj_is_kind_of(object, hash_type) == Qtrue) {
+    return (AttributesWriter){.object_type = Hash,
+                            .write_attributes = hash_attributes_writer};
+  }
+
   return (AttributesWriter){.object_type = Plain,
                             .write_attributes = plain_attributes_writer};
 

data/ext/panko_serializer/attributes_writer/attributes_writer.h

@@ -5,8 +5,9 @@
 #include "active_record.h"
 #include "common.h"
 #include "plain.h"
+#include "hash.h"
 
-enum ObjectType { Unknown = 0, ActiveRecord = 1, Plain = 2 };
+enum ObjectType { Unknown = 0, ActiveRecord = 1, Plain = 2, Hash = 3 };
 
 typedef struct _AttributesWriter {
   enum ObjectType object_type;

data/ext/panko_serializer/attributes_writer/hash.c

@@ -0,0 +1,14 @@
+#include "hash.h"
+
+void hash_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);
+    Attribute attribute = attribute_read(raw_attribute);
+
+    volatile VALUE value = rb_hash_aref(obj, attribute->name_str);
+
+    func(writer, attr_name_for_serialization(attribute), value);
+  }
+}

data/ext/panko_serializer/attributes_writer/hash.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include "common.h"
+#include "ruby.h"
+
+void hash_attributes_writer(VALUE obj,
+                             VALUE attributes,
+                             EachAttributeFunc func,
+                             VALUE writer);

data/lib/panko/serializer.rb

@@ -102,6 +102,7 @@ module Panko
 
       @serialization_context = SerializationContext.create(options)
       @descriptor = Panko::SerializationDescriptor.build(self.class, options, @serialization_context)
+      @used = false
     end
 
     def context
@@ -126,7 +127,9 @@ module Panko
     private
 
     def serialize_with_writer(object, writer)
+      raise ArgumentError.new("Panko::Serializer instances are single-use") if @used
       Panko.serialize_object(object, writer, @descriptor)
+      @used = true
       writer
     end
   end

data/lib/panko/version.rb

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

data/panko_serializer.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
 
   spec.extensions << "ext/panko_serializer/extconf.rb"
 
-  spec.add_dependency "oj", "~> 3.7.0"
+  spec.add_dependency "oj", "~> 3.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panko_serializer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Yosi Attias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-01 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
 description: 
 email:
 - yosy101@gmail.com
@@ -73,6 +73,8 @@ files:
 - 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/hash.c
+- ext/panko_serializer/attributes_writer/hash.h
 - ext/panko_serializer/attributes_writer/plain.c
 - ext/panko_serializer/attributes_writer/plain.h
 - ext/panko_serializer/attributes_writer/type_cast/time_conversion.c
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: High Performance JSON Serialization for ActiveRecord & Ruby Objects