protobuf 2.0.0.rc2 → 2.0.0.rc3

data/.gitignore

@@ -14,3 +14,4 @@ Gemfile.lock
 tmp/*
 ext/defs
 ext/out
+ext/ruby_generator/protoc-ruby

data/ext/ruby_generator/Makefile

@@ -0,0 +1,10 @@
+all: \
+	RubyGenerator.h \
+	RubyGenerator.cpp
+	g++ -Wall -I/code/src/utilities/protobuf-2.4.1/src -lprotoc -lprotobuf -lpthread -o protoc-ruby RubyGenerator.cpp
+
+test:
+	rm -rf test/out/*
+	./protoc-ruby --proto_path=../defs --ruby_out=../out ../defs/atlas/util.proto ../defs/atlas/newman/*.proto
+
+.PHONY: all test

data/ext/ruby_generator/RubyGenerator.cpp

@@ -42,9 +42,7 @@ bool RubyGenerator::Generate(const FileDescriptor* file,
   PrintNewLine();
 
   PrintEnumsForFileDescriptor(file_, true);
-  PrintNewLine();
   PrintMessagesForFileDescriptor(file_, true);
-  PrintNewLine();
 
   PrintServices();
 
@@ -100,60 +98,42 @@ void RubyGenerator::PrintMessagesForFileDescriptor(const FileDescriptor* descrip
     }
 
     for (int i = 0; i < descriptor->message_type_count(); i++) {
-      if (print_fields) {
-        PrintMessageFields(descriptor->message_type(i));
-      }
-      else {
-        PrintMessageClass(descriptor->message_type(i));
-      }
+      PrintMessage(descriptor->message_type(i), print_fields);
     }
   }
 }
 
 void RubyGenerator::PrintMessagesForDescriptor(const Descriptor* descriptor, bool print_fields) const {
   for (int i = 0; i < descriptor->nested_type_count(); i++) {
-    if (print_fields) {
-      PrintMessageFields(descriptor->nested_type(i));
-    }
-    else {
-      PrintMessageClass(descriptor->nested_type(i));
-    }
+    PrintMessage(descriptor->nested_type(i), print_fields);
   }
 }
 //
 // Print out the given descriptor message as a Ruby class.
-void RubyGenerator::PrintMessageClass(const Descriptor* descriptor) const {
+void RubyGenerator::PrintMessage(const Descriptor* descriptor, bool print_fields) const {
   map<string,string> data;
   data["class_name"] = descriptor->name();
 
-  printer_->Print(data, "class $class_name$ < ::Protobuf::Message; end");
-  PrintNewLine();
+  if (print_fields) {
+    printer_->Print(data, "class $class_name$");
+    PrintNewLine();
+    printer_->Indent();
 
-  PrintEnumsForDescriptor(descriptor, false);
-  PrintMessagesForDescriptor(descriptor, false);
-}
+    if (descriptor->enum_type_count() > 0) {
+      PrintEnumsForDescriptor(descriptor, true);
+    }
 
-void RubyGenerator::PrintExtensionRangesForDescriptor(const Descriptor* descriptor) const {
-  if (descriptor->extension_range_count() > 0) {
-    for (int i = 0; i < descriptor->extension_range_count(); i++) {
-      const Descriptor::ExtensionRange* range = descriptor->extension_range(i);
-      map<string,string> data;
-      data["message_class"] = Constantize(descriptor->full_name());
-      data["start"] = SimpleItoa(range->start);
-      data["end"] = SimpleItoa(range->end);
-      printer_->Print(data, "$message_class$.extensions $start$...$end$");
-      PrintNewLine();
+    if (descriptor->nested_type_count() > 0) {
+      PrintMessagesForDescriptor(descriptor, true);
     }
-  }
-}
 
-// Print out the given descriptor message as a Ruby class.
-void RubyGenerator::PrintMessageFields(const Descriptor* descriptor) const {
-  PrintExtensionRangesForDescriptor(descriptor);
+    PrintExtensionRangesForDescriptor(descriptor);
 
-  if (descriptor->field_count() > 0) {
-    for (int i = 0; i < descriptor->field_count(); i++) {
-      PrintMessageField(descriptor->field(i));
+    // Print Fields
+    if (descriptor->field_count() > 0) {
+      for (int i = 0; i < descriptor->field_count(); i++) {
+        PrintMessageField(descriptor->field(i));
+      }
     }
 
     // Print Extension Fields
@@ -162,17 +142,53 @@ void RubyGenerator::PrintMessageFields(const Descriptor* descriptor) const {
         PrintMessageField(descriptor->extension(i));
       }
     }
+
+    printer_->Outdent();
+    printer_->Print(data, "end");
     PrintNewLine();
   }
+  else if (DescriptorHasNestedTypes(descriptor)) {
+    printer_->Print(data, "class $class_name$ < ::Protobuf::Message");
+    PrintNewLine();
+    printer_->Indent();
+
+    if (descriptor->enum_type_count() > 0) {
+      PrintEnumsForDescriptor(descriptor, false);
+    }
+
+    if (descriptor->nested_type_count() > 0) {
+      PrintMessagesForDescriptor(descriptor, false);
+    }
 
-  PrintEnumsForDescriptor(descriptor, true);
-  PrintMessagesForDescriptor(descriptor, true);
+    printer_->Outdent();
+    printer_->Print(data, "end");
+    PrintNewLine();
+  }
+  else {
+    printer_->Print(data, "class $class_name$ < ::Protobuf::Message; end");
+  }
+
+  PrintNewLine();
+}
+
+void RubyGenerator::PrintExtensionRangesForDescriptor(const Descriptor* descriptor) const {
+  if (descriptor->extension_range_count() > 0) {
+    for (int i = 0; i < descriptor->extension_range_count(); i++) {
+      const Descriptor::ExtensionRange* range = descriptor->extension_range(i);
+      map<string,string> data;
+      data["message_class"] = Constantize(descriptor->full_name());
+      data["start"] = SimpleItoa(range->start);
+      data["end"] = SimpleItoa(range->end);
+      printer_->Print(data, "extensions $start$...$end$");
+      PrintNewLine();
+    }
+  }
 }
 
 // Print the given FieldDescriptor to the Message DSL methods.
 void RubyGenerator::PrintMessageField(const FieldDescriptor* descriptor) const {
   map<string,string> data;
-  data["message_class"] = Constantize(descriptor->containing_type()->full_name());
+  data["field_presence"] = "";
   data["field_name"] = descriptor->lowercase_name();
   data["tag_number"] = SimpleItoa(descriptor->number());
   data["data_type"] = "";
@@ -182,13 +198,13 @@ void RubyGenerator::PrintMessageField(const FieldDescriptor* descriptor) const {
   data["extension_opt"] = "";
 
   if (descriptor->is_required()) {
-    data["field_label"] = "required";
+    data["field_presence"] = "required";
   }
   else if (descriptor->is_optional()) {
-    data["field_label"] = "optional";
+    data["field_presence"] = "optional";
   }
   else if (descriptor->is_repeated()) {
-    data["field_label"] = "repeated";
+    data["field_presence"] = "repeated";
   }
 
   switch (descriptor->type()) {
@@ -232,7 +248,7 @@ void RubyGenerator::PrintMessageField(const FieldDescriptor* descriptor) const {
       case FieldDescriptor::CPPTYPE_DOUBLE: value = SimpleDtoa(descriptor->default_value_double()); break;
       case FieldDescriptor::CPPTYPE_FLOAT:  value = SimpleFtoa(descriptor->default_value_float()); break;
       case FieldDescriptor::CPPTYPE_BOOL:   value = descriptor->default_value_bool() ? "true" : "false"; break;
-      case FieldDescriptor::CPPTYPE_ENUM:   value = Constantize(descriptor->default_value_enum()->full_name()); break;
+      case FieldDescriptor::CPPTYPE_ENUM:   value = FullEnumNamespace(descriptor->default_value_enum()); break;
       case FieldDescriptor::CPPTYPE_STRING: value = "\"" + descriptor->default_value_string() + "\""; break;
       default: break;
     }
@@ -254,15 +270,15 @@ void RubyGenerator::PrintMessageField(const FieldDescriptor* descriptor) const {
   }
 
   printer_->Print(data,
-    "$message_class$.$field_label$("
+    "$field_presence$ "
     "$data_type$, "
     ":$field_name$, "
     "$tag_number$"
     "$default_opt$"
     "$packed_opt$"
     "$deprecated_opt$"
-    "$extension_opt$"
-    ")\n");
+    "$extension_opt$");
+  PrintNewLine();
 }
 
 
@@ -272,12 +288,7 @@ void RubyGenerator::PrintMessageField(const FieldDescriptor* descriptor) const {
 
 void RubyGenerator::PrintEnumsForDescriptor(const Descriptor* descriptor, bool print_values) const {
   for (int i = 0; i < descriptor->enum_type_count(); i++) {
-    if (print_values) {
-      PrintEnumValues(descriptor->enum_type(i));
-    }
-    else {
-      PrintEnumClass(descriptor->enum_type(i));
-    }
+    PrintEnum(descriptor->enum_type(i), print_values);
   }
 }
 
@@ -291,39 +302,43 @@ void RubyGenerator::PrintEnumsForFileDescriptor(const FileDescriptor* descriptor
     }
 
     for (int i = 0; i < descriptor->enum_type_count(); i++) {
-      if (print_values) {
-        PrintEnumValues(descriptor->enum_type(i));
-      }
-      else {
-        PrintEnumClass(descriptor->enum_type(i));
-      }
+      PrintEnum(descriptor->enum_type(i), print_values);
     }
   }
 }
 
 // Print the given enum descriptor as a Ruby class.
-void RubyGenerator::PrintEnumClass(const EnumDescriptor* descriptor) const {
+void RubyGenerator::PrintEnum(const EnumDescriptor* descriptor, bool print_values) const {
   map<string,string> data;
   data["class_name"] = descriptor->name();
-  printer_->Print(data, "class $class_name$ < ::Protobuf::Enum; end");
-  PrintNewLine();
-}
 
-// Print the given enum descriptor as a Ruby class.
-void RubyGenerator::PrintEnumValues(const EnumDescriptor* descriptor) const {
-  for (int i = 0; i < descriptor->value_count(); i++) {
-    PrintEnumValue(descriptor->value(i));
+  if (print_values) {
+    printer_->Print(data, "class $class_name$");
+    printer_->Indent();
+    PrintNewLine();
+
+    for (int i = 0; i < descriptor->value_count(); i++) {
+      PrintEnumValue(descriptor->value(i));
+    }
+
+    printer_->Outdent();
+    printer_->Print(data, "end");
+    PrintNewLine();
   }
+  else {
+    printer_->Print(data, "class $class_name$ < ::Protobuf::Enum; end");
+  }
+
   PrintNewLine();
 }
 
 // Print the given enum value to the Enum class DSL methods.
 void RubyGenerator::PrintEnumValue(const EnumValueDescriptor* descriptor) const {
   map<string,string> data;
-  data["enum_class"] = Constantize(descriptor->type()->full_name());
   data["name"] = descriptor->name();
   data["number"] = ConvertIntToString(descriptor->number());
-  printer_->Print(data, "$enum_class$.define :$name$, $number$\n");
+  printer_->Print(data, "define :$name$, $number$");
+  PrintNewLine();
 }
 
 //

data/ext/ruby_generator/RubyGenerator.h

@@ -46,15 +46,13 @@ class LIBPROTOC_EXPORT RubyGenerator : public CodeGenerator {
 
 		void PrintMessagesForDescriptor(const Descriptor* descriptor, bool print_fields) const;
 		void PrintMessagesForFileDescriptor(const FileDescriptor* descriptor, bool print_fields) const;
-		void PrintMessageClass(const Descriptor* descriptor) const;
+		void PrintMessage(const Descriptor* descriptor, bool print_fields) const;
 		void PrintExtensionRangesForDescriptor(const Descriptor* descriptor) const;
-		void PrintMessageFields(const Descriptor* descriptor) const;
 		void PrintMessageField(const FieldDescriptor* descriptor) const;
 
 		void PrintEnumsForDescriptor(const Descriptor* descriptor, bool print_values) const;
 		void PrintEnumsForFileDescriptor(const FileDescriptor* descriptor, bool print_values) const;
-		void PrintEnumClass(const EnumDescriptor* descriptor) const;
-		void PrintEnumValues(const EnumDescriptor* descriptor) const;
+		void PrintEnum(const EnumDescriptor* descriptor, bool print_values) const;
 		void PrintEnumValue(const EnumValueDescriptor* descriptor) const;
 
 		void PrintServices() const;
@@ -152,6 +150,17 @@ class LIBPROTOC_EXPORT RubyGenerator : public CodeGenerator {
 			return underscored.str();
 		}
 
+    static string FullEnumNamespace(const EnumValueDescriptor* descriptor) {
+      string parent_enum_type = Constantize(descriptor->type()->full_name());
+      string enum_name = descriptor->name();
+
+      return strings::Substitute("$0::$1", parent_enum_type, enum_name);
+    }
+
+    static bool DescriptorHasNestedTypes(const Descriptor* descriptor) {
+      return (descriptor->enum_type_count() > 0 || descriptor->nested_type_count() > 0);
+    }
+
 }; // class RubyGenerator
 
 } // namespace ruby
@@ -173,6 +182,16 @@ int _rprotoc_extern(int argc, char* argv[]) {
   return cli.Run(argc, argv);
 }
 
+/*
+
+Use for testing:
+
+int main(int argc, char* argv[]) {
+  return _rprotoc_extern(argc, argv);
+}
+
+*/
+
 #ifdef __cplusplus
 }
 #endif

data/lib/protobuf.rb

@@ -14,13 +14,31 @@ module Protobuf
 
 	module_function
 
+  # Connector Type
+  #
+  # Default: socket
+  #
+  # Symbol value which denotes the type of connector to use
+  # during client requests to an RPC server.
+  def self.connector_type
+    @_connector_type ||= DEFAULT_CONNECTOR_TYPE
+  end
+
+  def self.connector_type=(type)
+    raise ArgumentError, 'Invalid connector type given' unless VALID_CONNECTOR_TYPES.include?(type)
+    @_connector_type = type
+  end
+
+
   # GC Pause during server requests
   #
+  # Default: false
+  #
   # Boolean value to tell the server to disable
   # the Garbage Collector when handling an rpc request.
   # Once the request is completed, the GC is enabled again.
   # This optomization provides a huge boost in speed to rpc requests.
-	def self.gc_pause_server_request
+	def self.gc_pause_server_request?
 		return @_gc_pause_server_request unless @_gc_pause_server_request.nil?
 		gc_pause_server_request = false
 	end
@@ -29,36 +47,25 @@ module Protobuf
 		@_gc_pause_server_request = !!value
 	end
 
-  # GC Pause during serializations (server-side only)
+  # Print Deprecation Warnings
   #
-  # Boolean value to tell the server to disable
-  # the Garbage Collector when serializing a response proto.
-  # Once the serialization is completed, the GC is enabled again.
-  # This optomization provides a large boost in speed to rpc requests.
-  # Note that this option is ignored if gc_pause_server_request is
-  # enabled since serialization is during the request cycle.
-	def self.gc_pause_server_serialization
-		return @_gc_pause_server_serialization unless @_gc_pause_server_serialization.nil?
-		gc_pause_server_serialization = false
+  # Default: true
+  #
+  # Simple boolean to define whether we want field deprecation warnings to
+  # be printed to stderr or not. The rpc_server has an option to set this value
+  # explicitly, or you can turn this option off by setting
+  # ENV['PB_IGNORE_DEPRECATIONS'] to a non-empty value.
+  #
+  # The rpc_server option will override the ENV setting.
+	def self.print_deprecation_warnings?
+		return @_print_deprecation_warnings unless @_print_deprecation_warnings.nil?
+		print_deprecation_warnings = ENV.key?('PB_IGNORE_DEPRECATIONS') ? false : true
 	end
 
-	def self.gc_pause_server_serialization=(value)
-		@_gc_pause_server_serialization = !!value
+	def self.print_deprecation_warnings=(value)
+		@_print_deprecation_warnings = !!value
 	end
 
-  # Connector Type
-  #
-  # Symbol value which denotes the type of connector to use
-  # during client requests to an RPC server.
-  def self.connector_type
-    @_connector_type ||= DEFAULT_CONNECTOR_TYPE
-  end
-
-  def self.connector_type=(type)
-    raise 'Invalid connector type given' unless VALID_CONNECTOR_TYPES.include?(type)
-    @_connector_type = type
-  end
-
 end
 
 require 'protobuf/rpc/client'

data/lib/protobuf/cli.rb

@@ -16,22 +16,22 @@ module Protobuf
 
     desc 'start APP_FILE', 'Run the RPC server in the given mode, preloading the given APP_FILE. This is the default task.'
 
-    option :host,                   :type => :string, :default => '127.0.0.1', :aliases => %w(-o), :desc => 'Host to bind.'
-    option :port,                   :type => :numeric, :default => 9595, :aliases => %w(-p), :desc => 'Port to bind.'
+    option :host,                       :type => :string, :default => '127.0.0.1', :aliases => %w(-o), :desc => 'Host to bind.'
+    option :port,                       :type => :numeric, :default => 9595, :aliases => %w(-p), :desc => 'Port to bind.'
 
-    option :backlog,                :type => :numeric, :default => 100, :aliases => %w(-b), :desc => 'Backlog for listening socket when using Socket Server.'
-    option :threshold,              :type => :numeric, :default => 100, :aliases => %w(-t), :desc => 'Multi-threaded Socket Server cleanup threshold.'
+    option :backlog,                    :type => :numeric, :default => 100, :aliases => %w(-b), :desc => 'Backlog for listening socket when using Socket Server.'
+    option :threshold,                  :type => :numeric, :default => 100, :aliases => %w(-t), :desc => 'Multi-threaded Socket Server cleanup threshold.'
 
-    option :log,                    :type => :string, :aliases => %w(-l), :desc => 'Log file or device. Default is STDOUT.'
-    option :level,                  :type => :numeric, :default => ::Logger::INFO, :aliases => %w(-v), :desc => 'Log level to use, 0-5 (see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/)'
+    option :log,                        :type => :string, :aliases => %w(-l), :desc => 'Log file or device. Default is STDOUT.'
+    option :level,                      :type => :numeric, :default => ::Logger::INFO, :aliases => %w(-v), :desc => 'Log level to use, 0-5 (see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/)'
 
-    option :socket,                 :type => :boolean, :aliases => %w(-s), :desc => 'Socket Mode for server and client connections.'
-    option :evented,                :type => :boolean, :aliases => %w(-m), :desc => 'Evented Mode for server and client connections (uses EventMachine).'
-    option :zmq,                    :type => :boolean, :aliases => %w(-z), :desc => 'ZeroMQ Socket Mode for server and client connections.'
+    option :socket,                     :type => :boolean, :aliases => %w(-s), :desc => 'Socket Mode for server and client connections.'
+    option :evented,                    :type => :boolean, :aliases => %w(-m), :desc => 'Evented Mode for server and client connections (uses EventMachine).'
+    option :zmq,                        :type => :boolean, :aliases => %w(-z), :desc => 'ZeroMQ Socket Mode for server and client connections.'
 
-    option :debug,                  :type => :boolean, :default => false, :aliases => %w(-d), :desc => 'Debug Mode. Override log level to DEBUG.'
-    option :gc_pause_request,       :type => :boolean, :default => false, :desc => 'Enable/Disable GC pause during request.'
-    option :gc_pause_serialization, :type => :boolean, :default => false, :desc => 'Enable/Disable GC pause during serialization.'
+    option :debug,                      :type => :boolean, :default => false, :aliases => %w(-d), :desc => 'Debug Mode. Override log level to DEBUG.'
+    option :gc_pause_request,           :type => :boolean, :default => false, :desc => 'Enable/Disable GC pause during request.'
+    option :print_deprecation_warnings, :type => :boolean, :default => true, :desc => 'Cause use of deprecated fields to be printed or ignored.'
 
     def start(app_file)
       debug_say 'Configuring the rpc_server process'
@@ -42,6 +42,7 @@ module Protobuf
       configure_server_mode
       require_protobuf!
       configure_gc
+      configure_deprecation_warnings
 
       run_if_no_abort { require_application!(app_file) }
       run_if_no_abort { configure_process_name(app_file) }
@@ -58,11 +59,15 @@ module Protobuf
 
     no_tasks do
 
+      # Tell protobuf how to handle the printing of deprecated field usage.
+      def configure_deprecation_warnings
+        ::Protobuf.print_deprecation_warnings = options.print_deprecation_warnings?
+      end
+
       # If we pause during request we don't need to pause in serialization
       def configure_gc
         debug_say 'Configuring gc'
         ::Protobuf.gc_pause_server_request = options.gc_pause_request?
-        ::Protobuf.gc_pause_server_serialization = (!options.gc_pause_request? && options.gc_pause_serialization?)
       end
 
       # Setup the protobuf logger.