protobuffy 3.1.0

data/lib/protobuf/generators/group_generator.rb

@@ -0,0 +1,113 @@
+require 'protobuf/generators/enum_generator'
+require 'protobuf/generators/extension_generator'
+require 'protobuf/generators/field_generator'
+require 'protobuf/generators/message_generator'
+require 'protobuf/generators/service_generator'
+
+module Protobuf
+  module Generators
+    class GroupGenerator
+      include ::Protobuf::Generators::Printable
+
+      attr_reader :groups, :indent_level
+      attr_writer :order
+
+      def initialize(indent_level = 0)
+        @groups = Hash.new { |h, k| h[k] = [] }
+        @headers = {}
+        @comments = {}
+        @handlers = {}
+        @indent_level = indent_level
+        @order = [ :enum, :message_declaration, :message, :extended_message, :service ]
+        init_printer(indent_level)
+      end
+
+      def add_enums(enum_descriptors, options)
+        enum_descriptors.each do |enum_descriptor|
+          @groups[:enum] << EnumGenerator.new(enum_descriptor, indent_level, options)
+        end
+      end
+
+      def add_comment(type, message)
+        @comments[type] = message
+      end
+
+      def add_extended_messages(extended_messages)
+        extended_messages.each do |message_type, field_descriptors|
+          @groups[:extended_message] << ExtensionGenerator.new(message_type, field_descriptors, indent_level)
+        end
+      end
+
+      def add_extension_fields(field_descriptors)
+        field_descriptors.each do |field_descriptor|
+          @groups[:extension_field] << FieldGenerator.new(field_descriptor, indent_level)
+        end
+      end
+
+      def add_extension_ranges(extension_ranges, &item_handler)
+        @groups[:extension_range] = extension_ranges
+        @handlers[:extension_range] = item_handler
+      end
+
+      def add_header(type, message)
+        @headers[type] = message
+      end
+
+      def add_message_declarations(descriptors)
+        descriptors.each do |descriptor|
+          @groups[:message_declaration] << MessageGenerator.new(descriptor, indent_level, :declaration => true)
+        end
+      end
+
+      def add_message_fields(field_descriptors)
+        field_descriptors.each do |field_descriptor|
+          @groups[:field] << FieldGenerator.new(field_descriptor, indent_level)
+        end
+      end
+
+      def add_messages(descriptors, options = {})
+        descriptors.each do |descriptor|
+          @groups[:message] << MessageGenerator.new(descriptor, indent_level, options)
+        end
+      end
+
+      def add_services(service_descriptors)
+        service_descriptors.each do |service_descriptor|
+          @groups[:service] << ServiceGenerator.new(service_descriptor, indent_level)
+        end
+      end
+
+      def compile
+        @order.each do |type|
+          items = @groups[type]
+          if items.count > 0
+            item_handler = @handlers[type]
+
+            item_header = @headers[type]
+            header(item_header) if item_header
+
+            item_comment = @comments[type]
+            comment(item_comment) if item_comment
+
+            items.each do |item|
+              if item_handler
+                puts item_handler.call(item)
+              else
+                print item.to_s
+              end
+            end
+
+            puts if type == :message_declaration
+          end
+        end
+      end
+
+      def to_s
+        compile
+        print_contents
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/generators/message_generator.rb

@@ -0,0 +1,99 @@
+require 'protobuf/generators/base'
+require 'protobuf/generators/group_generator'
+
+module Protobuf
+  module Generators
+    class MessageGenerator < Base
+
+      def initialize(descriptor, indent_level, options = {})
+        super
+        @only_declarations = options.fetch(:declaration) { false }
+        @extension_fields = options.fetch(:extension_fields) { {} }
+      end
+
+      def compile
+        run_once(:compile) do
+          if @only_declarations
+            compile_declaration
+          else
+            compile_message
+          end
+        end
+      end
+
+      def compile_declaration
+        run_once(:compile_declaration) do
+          if is_printable?
+            print_class(descriptor.name, :message) do
+              group = GroupGenerator.new(current_indent)
+              group.add_enums(descriptor.enum_type, :namespace => type_namespace)
+              group.add_message_declarations(descriptor.nested_type)
+              print group.to_s
+            end
+          else
+            print_class(descriptor.name, :message)
+          end
+        end
+      end
+
+      def compile_message
+        run_once(:compile_message) do
+          if is_printable?
+            print_class(descriptor.name, nil) do
+              group = GroupGenerator.new(current_indent)
+              group.add_messages(descriptor.nested_type, :extension_fields => @extension_fields, :namespace => type_namespace)
+              group.add_message_fields(descriptor.field)
+              self.class.validate_tags(fully_qualified_type_namespace, descriptor.field.map(&:number))
+
+              group.add_comment(:extension_range, 'Extension Fields')
+              group.add_extension_ranges(descriptor.extension_range) do |extension_range|
+                "extensions #{extension_range.start}...#{extension_range.end}"
+              end
+
+              group.add_extension_fields(message_extension_fields)
+
+              group.order = [ :message, :field, :extension_range, :extension_field ]
+              print group.to_s
+            end
+          end
+        end
+      end
+
+      private
+
+      def has_extensions?
+        ! message_extension_fields.empty?
+      end
+
+      def has_fields?
+        descriptor.field.count > 0
+      end
+
+      def has_nested_enums?
+        descriptor.enum_type.count > 0
+      end
+
+      def has_nested_messages?
+        descriptor.nested_type.count > 0
+      end
+
+      def has_nested_types?
+        has_nested_enums? || has_nested_messages?
+      end
+
+      def is_printable?
+        if @only_declarations
+          has_nested_types?
+        else
+          has_fields? || has_nested_messages? || has_extensions?
+        end
+      end
+
+      def message_extension_fields
+        @extension_fields.fetch(fully_qualified_type_namespace) { [] }
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/generators/printable.rb

@@ -0,0 +1,161 @@
+module Protobuf
+  module Generators
+    module Printable
+
+      PARENT_CLASS_MESSAGE = "::Protobuf::Message".freeze
+      PARENT_CLASS_ENUM    = "::Protobuf::Enum".freeze
+      PARENT_CLASS_SERVICE = "::Protobuf::Rpc::Service".freeze
+
+      # Initialize the printer.
+      # Must be called by any class/module that includes the Printable module.
+      #
+      def init_printer(indent_level)
+        @io = ::StringIO.new
+        @_indent_level = indent_level.to_i || 0
+      end
+
+      private
+
+      # Print a one-line comment.
+      #
+      def comment(message)
+        puts "# #{message}"
+      end
+
+      def current_indent
+        @_indent_level
+      end
+
+      # Print a "header" comment.
+      #
+      #   header("Lorem ipsum dolor")
+      #   ##
+      #   # Lorem ipsum dolor
+      #   #
+      def header(message)
+        puts
+        puts "##"
+        puts "# #{message}"
+        puts "#"
+      end
+
+      # Increase the indent level. An outdent will only occur if given a block
+      # (after the block is finished).
+      #
+      def indent
+        @_indent_level += 1
+        yield
+        outdent
+      end
+
+      # Take a string and upcase the first character of each namespace.
+      # Due to the nature of varying standards about how class/modules are named
+      # (e.g. CamelCase, Underscore_Case, SCREAMING_SNAKE_CASE), we only want
+      # to capitalize the first character to ensure ruby will treat the value
+      # as a constant. Otherwise we do not attempt to change the
+      # token's definition.
+      #
+      #   modulize("foo.bar.Baz") -> "::Foo::Bar::Baz"
+      #   modulize("foo.bar.baz") -> "::Foo::Bar::Baz"
+      #   modulize("foo.bar.BAZ") -> "::Foo::Bar::BAZ"
+      #
+      def modulize(name)
+        name = name.gsub(/\./, '::')
+        name = name.gsub(/(^(?:::)?[a-z]|::[a-z])/) { |match| match.upcase }
+        name
+      end
+
+      # Decrease the indent level. Cannot be negative.
+      #
+      def outdent
+        @_indent_level -= 1 unless @_indent_level == 0
+      end
+
+      # Return the parent class for a given type.
+      # Valid types are :message, :enum, and :service, otherwise an error
+      # will be thrown.
+      #
+      def parent_class(type)
+        case type
+        when :message then
+          PARENT_CLASS_MESSAGE
+        when :enum then
+          PARENT_CLASS_ENUM
+        when :service then
+          PARENT_CLASS_SERVICE
+        else
+          raise "Unknown parent class type #{type}: #{caller[0..5].join("\n")}"
+        end
+      end
+
+      # Print a class or module block, indicated by type.
+      # If a class, can be given a parent class to inherit from.
+      # If a block is given, call the block from within an indent block.
+      # Otherwise, end the block on the same line.
+      #
+      def print_block(name, parent_klass, type, &block)
+        name = modulize(name)
+        block_def = "#{type} #{name}"
+        block_def += " < #{parent_class(parent_klass)}" if parent_klass
+
+        if block_given?
+          puts block_def
+          indent { block.call }
+          puts "end"
+          puts
+        else
+          block_def += "; end"
+          puts block_def
+        end
+      end
+
+      # Use print_block to print a class, with optional parent class
+      # to inherit from. Accepts a block for use with print_block.
+      #
+      def print_class(name, parent_klass, &block)
+        print_block(name, parent_klass, :class, &block)
+      end
+
+      # Use print_block to print a module.
+      # Accepts a block for use with print_block.
+      #
+      def print_module(name, &block)
+        print_block(name, nil, :module, &block)
+      end
+
+      # Print a file require.
+      #
+      #   print_require('foo/bar/baz') -> "require 'foo/bar/baz'"
+      #
+      def print_require(file)
+        puts "require '#{file}'"
+      end
+
+      # Puts the given message prefixed by the indent level.
+      # If no message is given print a newline.
+      #
+      def puts(message = nil)
+        if message
+          @io.puts(("  " * @_indent_level) + message)
+        else
+          @io.puts
+        end
+      end
+
+      # Print the given message raw, no indent.
+      #
+      def print(contents)
+        @io.print(contents)
+      end
+
+      # Returns the contents of the underlying StringIO object.
+      #
+      def print_contents
+        @io.rewind
+        @io.read
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/generators/service_generator.rb

@@ -0,0 +1,27 @@
+require 'protobuf/generators/base'
+
+module Protobuf
+  module Generators
+    class ServiceGenerator < Base
+
+      def compile
+        run_once(:compile) do
+          print_class(descriptor.name, :service) do
+            descriptor.method.each do |method_descriptor|
+              puts build_method(method_descriptor)
+            end
+          end
+        end
+      end
+
+      def build_method(method_descriptor)
+        name = method_descriptor.name
+        request_klass = modulize(method_descriptor.input_type)
+        response_klass = modulize(method_descriptor.output_type)
+        return "rpc :#{name.underscore}, #{request_klass}, #{response_klass}"
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/http.rb

@@ -0,0 +1,20 @@
+##
+## HTTP Mode
+##
+#
+# Require this file if you wish to run your server and/or client RPC
+# with the HTTP handlers.
+#
+# To run with rpc_server specify the switch `http`:
+#
+#   rpc_server --http myapp.rb
+#
+# To run for client-side only override the require in your Gemfile:
+#
+#   gem 'protobuf', :require => 'protobuf/http'
+#
+require 'protobuf'
+Protobuf.connector_type = :http
+
+require 'protobuf/rpc/servers/http/server'
+require 'protobuf/rpc/connectors/http'

data/lib/protobuf/lifecycle.rb

@@ -0,0 +1,46 @@
+module Protobuf
+  class Lifecycle
+    include ::Protobuf::Logger::LogMethods
+
+    def self.register(event_name, &blk)
+      raise "Lifecycle register must have a block" unless block_given?
+      event_name = normalized_event_name(event_name)
+
+      if ::Protobuf.print_deprecation_warnings?
+        $stderr.puts <<-ERROR
+            [DEPRECATED] ::Protobuf::Lifecycle has been deprecated and will be removed in a future version.
+                         Use ::ActiveSupport::Notifications.subscribe('#{event_name}')
+        ERROR
+      end
+
+      ::ActiveSupport::Notifications.subscribe(event_name) do |name, start, finish, id, args|
+        blk.call(*args)
+      end
+    end
+
+    def self.trigger( event_name, *args )
+      if ::Protobuf.print_deprecation_warnings?
+        $stderr.puts <<-ERROR
+            [DEPRECATED] ::Protobuf::Lifecycle has been deprecated and will be removed in a future version.
+                         Use ::ActiveSupport::Notifications.instrument(...)
+        ERROR
+      end
+
+      event_name = normalized_event_name( event_name )
+
+      ::ActiveSupport::Notifications.instrument(event_name, args)
+    end
+
+    def self.normalized_event_name(event_name)
+      return "#{event_name}".downcase
+    end
+
+    class << self
+      attr_accessor :lifecycle_events
+
+      alias_method :on, :register
+    end
+
+    @lifecycle_events ||= {}
+  end
+end