pb-serializer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f67d4a17784718471b0092c70c74d8ad19c3c7dcd7d0003268d0b52ee1cff8b5
-  data.tar.gz: 970526e14d3bacab347a57fb1a556ea041529cca3e2d9ad0e5aaf4482f4808bb
+  metadata.gz: 3d65ab2cd7830751ed61e5cd72eca1d688fac910b544167994780d065e55fa3b
+  data.tar.gz: e991534beffa6fb92b4c23f05bf59b5ba0ef6872cd34dc801148e08ec3f2c075
 SHA512:
-  metadata.gz: 922d74b4ca48c70e6fc37358a994630fceb3244acb8af39523dc60b8288a25c8f4f44f45c67e663743b01800fb8ec7a60b5f6804598d698ea42531947d5cb81d
-  data.tar.gz: 87fb4dec4bb9e073d6b461fd1b0d80803e8f1763a021e33746b9e789dfe71566dc9ccdf45ae9ca3834c4aeeb152b53660ee4bb4fedbd1525d4d81304b7f6c233
+  metadata.gz: 0a138f78df718b226cbf65cef851380a941c34306ed80bdc2fb65093f0dec804515d0187d3f0b11e4fcd36bbc339dfca08f2beef49989d6417ccf157ddf9da97
+  data.tar.gz: bf343a1d3f7f055370f652616fc6914dc682f2fdc6840c6975614537d5ecf02241974b8df986505f96a517401b676e0756aa2040d181898e8dc866ee76ab305c

data/README.md

@@ -6,24 +6,29 @@ class UserSerializer < Pb::Serializer::Base
 
   attribute :id,    required: true
   attribute :name,  required: true
-  attribute :posts, required: true, serializer: PostSerializer
+  attribute :posts, required: true
 
-  define_loader :posts do |users, subdeps, **|
-    posts = Post.where(user_id: users.map(&:id)).index_by(&:user_id)
-    users.each do |user|
-      user.posts = posts[user.id]
-    end
+  define_primary_loader :user do |subdeps, ids:, **|
+    User.where(id: ids).preload(subdeps).map { |u| new(u) }
+  end
+
+  define_loader :posts, key: -> { id } do |user_ids, subdeps, **|
+    PostSerializer.bulk_load(user_id: user_ids, with: subdeps).group_by { |s| s.post.user_id }
   end
 
   dependency :posts
   computed def post_count
-    object.posts.size
+    posts.count
   end
 end
 
 class PostSerializer < Pb::Serializer::Base
   message YourApp::Post
 
+  define_primary_loader :post do |subdeps, user_ids:, **|
+    Post.where(user_id: user_ids).preload(subdeps).map { |p| new(p) }
+  end
+
   attribute :id,    required: true
   attribute :title, required: true
   attribute :body,  required: true
@@ -34,22 +39,23 @@ class UserGrpcService < YourApp::UserService::Service
   # @param call [GRPC::ActiveCall::SingleReqView]
   # @return [YourApp::User]
   def get_users(req, call)
-    user = User.find(id: req.user_id)
-    UserSerializer.serialize(user, with: req.field_mask)
+    UserSerializer.bulk_load_and_serialize(ids: [req.user_id], with: req.field_mask)[0]
   end
 
   # @param req [YourApp::ListFriendUsersRequest]
   # @param call [GRPC::ActiveCall::SingleReqView]
   # @return [YourApp::ListFriendUsersResponse]
   def list_friend_users(req, call)
-    friends = User.find(current_user_id).friends
+    current_user = User.find(current_user_id)
     YourApp::ListFriendUsersResponse.new(
-      users: UserSerializer.serialize_repeated(friends, with: req.field_mask),
+      users: UserSerializer.bulk_load_and_serialize(ids: current_user.friend_ids, with: req.field_mask)
     )
   end
 end
 ```
 
+More examples are available under [./spec/examples](./spec/examples).
+
 
 ## Installation
 

data/lib/pb/serializable.rb

@@ -3,14 +3,11 @@ module Pb
     def self.included(base)
       base.extend ClassMethods
       base.include ComputedModel
+      base.singleton_class.prepend Hook
     end
 
     def to_pb(with: nil)
-      if with.nil?
-        with = ::Pb::Serializer.build_default_mask(self.class.message_class.descriptor)
-      end
-
-      self.class.bulk_load_and_compute(Array(self), with)
+      # TODO: apply masks
 
       oneof_set = []
 
@@ -26,14 +23,14 @@ module Pb
         v = attr.convert_to_pb(v)
 
         if attr.required && attr.field_descriptor.default == v
-          raise ::Pb::Serializer::ValidationError, "#{object.class.name}##{attr.name} is required"
+          raise ::Pb::Serializer::ValidationError, "#{primary_object.class.name}##{attr.name} is required"
         end
 
         next if v.nil?
 
         if attr.oneof?
           if oneof_set.include?(attr.oneof)
-            raise ::Pb::Serializer::ConflictOneofError, "#{object.class.name}##{attr.name} is oneof attribute"
+            raise ::Pb::Serializer::ConflictOneofError, "#{primary_object.class.name}##{attr.name} is oneof attribute"
           end
           oneof_set << attr.oneof
         end
@@ -48,14 +45,47 @@ module Pb
       self.class.oneofs.each do |oneof|
         next if oneof_set.include?(oneof.name)
         next unless oneof.required?
-        raise ::Pb::Serializer::ValidationError, "#{object.class.name}##{oneof.name} is required"
+        raise ::Pb::Serializer::ValidationError, "#{primary_object.class.name}##{oneof.name} is required"
       end
 
       o
     end
 
+    private def primary_object
+      primary_object_name = self.class.__pb_serializer_primary_model_name
+      if primary_object_name
+        send(primary_object_name)
+      elsif kind_of?(Serializer::Base)
+        send(:object)
+      else
+        self
+      end
+    end
+
+    module Hook
+      def define_primary_loader(name)
+        self.__pb_serializer_primary_model_name = name
+
+        super
+      end
+
+      def computed(name)
+        __pb_serializer_attrs << name
+
+        super
+      end
+
+      def define_loader(name, **)
+        __pb_serializer_attrs << name
+
+        super
+      end
+    end
+
     module ClassMethods
       attr_reader :message_class
+      attr_accessor :__pb_serializer_primary_model_name
+
       def message(klass)
         @message_class = klass
       end
@@ -79,21 +109,21 @@ module Pb
         @attr_by_name[name] = attr
 
         define_method attr.name do
-          object.public_send(attr.name) # FIXME: This does not work without ::Pb::Serializer::Base
+          primary_object.public_send(attr.name)
         end
+      end
 
-        dependency # FIXME
-        computed attr.name
+      # @param with [Array, Google::Protobuf::FieldMask, nil]
+      # @return [Array]
+      def bulk_load_and_serialize(with: nil, **args)
+        bulk_load(with: with, **args).map { |s| s.to_pb(with: with) }
       end
 
-      # @param object [Object, Array]
-      # @param message_class [Class]
-      def serialize(object, with: nil)
-        if self < ::Pb::Serializer::Base
-          new(object).to_pb
-        else
-          object.to_pb
-        end
+      def bulk_load(with: nil, **args)
+        with ||= ::Pb::Serializer.build_default_mask(message_class.descriptor)
+        with = with.reject { |c| (__pb_serializer_attrs & (c.kind_of?(Hash) ? c.keys : [c])).empty? }
+
+        bulk_load_and_compute(with, **args)
       end
 
       def oneof(name, required: true)
@@ -108,6 +138,10 @@ module Pb
         @current_oneof = nil
       end
 
+      private def __pb_serializer_attrs
+        @__pb_serializer_attrs ||= Set.new
+      end
+
       # @param fd [Google::Protobuf::FieldDescriptor] a field descriptor
       # @return [Pb::Serializer::Attribute, nil]
       def find_attribute_by_field_descriptor(fd)

data/lib/pb/serializer/attribute.rb

@@ -42,7 +42,7 @@ module Pb
           when "google.protobuf.BytesValue"  then Pb.to_bytesval(v)
           else
             return nil if v.nil?
-            return serializer_class.serialize(v) if serializer_class
+            return serializer_class.new(v).to_pb if serializer_class
             return v.to_pb if v.kind_of?(::Pb::Serializable)
 
             raise "serializer was not found for #{field_descriptor.submsg_name}"

data/lib/pb/serializer/base.rb

@@ -3,6 +3,7 @@ module Pb
     class Base
       def self.inherited(base)
         base.include ::Pb::Serializable
+        base.singleton_class.prepend Hook
       end
 
       attr_reader :object
@@ -10,6 +11,18 @@ module Pb
       def initialize(object)
         @object = object
       end
+
+      module Hook
+        def define_primary_loader(name, &block)
+          class_eval <<~RUBY
+            def initialize(object)
+              @#{name} = object
+            end
+          RUBY
+
+          super
+        end
+      end
     end
   end
 end

data/lib/pb/serializer/version.rb

@@ -1,5 +1,5 @@
 module Pb
   module Serializer
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

data/pb-serializer.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   rails_versions = [">= 5.2", "< 6.1"]
   spec.add_runtime_dependency "google-protobuf", "~> 3.0"
   spec.add_runtime_dependency "the_pb", "~> 0.0.1"
-  spec.add_runtime_dependency "computed_model", "~> 0.1.0"
+  spec.add_runtime_dependency "computed_model", "~> 0.2.1"
 
   spec.add_development_dependency "activerecord", rails_versions
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pb-serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - izumin5210
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Serialize objects into Protocol Buffers messages