protostar 0.1.0.beta1

data/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,61 @@
+# Third-party notices
+
+protostar is MIT licensed (see `LICENSE.txt`). It carries material from Google's Protocol
+Buffers (https://github.com/protocolbuffers/protobuf, v36.2), which is under the BSD 3-Clause
+licence reproduced below.
+
+In the gem:
+
+- `lib/protostar/compiler/include/` holds Google's `.proto` files (`descriptor.proto`, the
+  well-known types, `plugin.proto`, the feature sets), unchanged, with their `LICENSE`.
+- `lib/protostar/google/protobuf/*_pb.rb` and `sig/protostar/google/protobuf/*_pb.rbs` are
+  generated from those files and carry their comments.
+- `shims/google-protobuf/lib/` is the google-protobuf shim, which
+  `require "protostar/google_protobuf_shim"` loads. Its `google/protobuf/*_pb.rb` are generated
+  from Google's `.proto` files and embed their serialized descriptors; `well_known_types.rb`,
+  `message_exts.rb` and `internal/well_known.rb` follow the behaviour, and in places the code,
+  of the `google-protobuf` gem's Ruby sources.
+
+In the repository only:
+
+- `test/corpus/protobuf/` is a vendored slice of the protobuf repository at v36.2 (see its
+  `PIN` and `LICENSE`); `test/corpus/goldens/` and `test/corpus/text_format/` were produced
+  from it by protoc, and `test/corpus/generated/` and `conformance/generated/` by protostar.
+- The rest of `shims/google-protobuf/` (its tests) is listed in its own `THIRD_PARTY_NOTICES.md`.
+
+## Protocol Buffers licence
+
+```
+Copyright 2008 Google Inc.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Code generated by the Protocol Buffer compiler is owned by the owner
+of the input file used when generating it.  This code is not
+standalone and requires a support library to be linked with it.  This
+support library is itself covered by the above license.
+```

data/exe/protoc-gen-protostar

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "protostar/plugin"
+
+exit Protostar::Plugin.run

data/exe/protostar

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "protostar/cli"
+
+exit Protostar::CLI.run(ARGV)

data/lib/protostar/builder/generator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Protostar
+  class Builder
+    # Makes the builder class for a message class. The builder writes
+    # nested messages with the same object, so it needs a method for every
+    # field name of every message reachable from the root; each method
+    # dispatches on the index of the message being written (`@k`) with a
+    # literal `case`, the way the codec's generated methods do, and is
+    # compiled from source so that it runs in any Ractor.
+    # @api private
+    module Generator
+      module_function
+
+      # @param root [Class] a message class
+      # @return [Class] a frozen subclass of {Builder}
+      def generate(root)
+        classes = reachable(root)
+        index = classes.each_with_index.to_h.compare_by_identity
+        by_name = Hash.new { |h, k| h[k] = [] }
+        classes.each_with_index do |klass, i|
+          klass.__fields.each { |f| by_name[f.name] << [i, f] }
+        end
+
+        builder = Class.new(Builder)
+        builder.const_set(:CLASSES, Ractor.make_shareable(classes))
+        builder.const_set(:INDEX, Ractor.make_shareable(index))
+        builder.const_set(:BY_NAME, Ractor.make_shareable(classes.map(&:__by_name)))
+        src = +"# frozen_string_literal: true\n"
+        by_name.each do |name, entries|
+          next if reserved?(name)
+          entries.each { |i, f| builder.const_set(:"F#{i}_#{f.index}", f) }
+          src << field_method(name, entries)
+        end
+        builder.class_eval(src, "(protostar builder #{root.descriptor.full_name})", 1)
+        builder.singleton_class.class_eval("def inspect = #{"#<Class Protostar::Builder(#{root.descriptor.full_name})>".inspect}", __FILE__, __LINE__)
+        builder.freeze
+      end
+
+      # Message classes reachable from `root` through message fields and map values, `root` first
+      def reachable(root)
+        seen = {}.compare_by_identity
+        queue = [root]
+        until queue.empty?
+          klass = queue.shift
+          next if seen.key?(klass)
+          seen[klass] = true
+          klass.__fields.each do |f|
+            child = f.map ? f.value.message_class : f.message_class
+            queue << child if child && !seen.key?(child)
+          end
+        end
+        seen.keys
+      end
+
+      # Names that would replace a method every object or every builder needs
+      def reserved?(name)
+        Builder.method_defined?(name) || Builder.private_method_defined?(name)
+      end
+
+      def field_method(name, entries)
+        src = "def #{name}(value = NONE, &block)\ncase @k\n"
+        entries.each do |i, f|
+          c = "F#{i}_#{f.index}"
+          src << "when #{i} then (block_given? || NONE.equal?(value)) ? __set(#{c}, value, EMPTY, &block) : __put(#{c}, value)\n"
+        end
+        src << "else __no_field(#{name.inspect})\nend\nself\nend\n"
+      end
+    end
+  end
+end

data/lib/protostar/builder/sink.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Protostar
+  class Builder
+    # The writer a builder streams into. What the sink raises is raised
+    # again with the field being written added to its message, keeping its
+    # class: a broken pipe stays an Errno::EPIPE.
+    # @api private
+    class Sink < Wire::Writer
+      def initialize(target, flush_at, builder)
+        super(target, flush_at: flush_at)
+        @builder = builder
+      end
+
+      # @return [Exception] `e` again, its message saying where the builder was
+      def annotate(e)
+        e.exception("#{e.message} (while writing #{@builder.__send__(:__where)})")
+      end
+
+      private
+
+      def deliver(bytes)
+        super
+      rescue => e
+        raise annotate(e)
+      end
+
+      def deliver_all(*chunks)
+        super
+      rescue => e
+        raise annotate(e)
+      end
+    end
+  end
+end