protobuf-closure-library 0.1.5 → 0.1.6

data/README.rst

@@ -10,9 +10,9 @@ Installation
 
 `Protobuf <http://code.google.com/p/protobuf/>`_ runtime compiler and development header and libraries must be present at gem installation time.
 
-* Under linux, user the right development package, eg ``libprotobuf-dev`` for ubuntu.
+* Under linux, user the right development package, eg ``libprotoc-dev`` for ubuntu.
 * Under osx, use ``brew install protobuf``.
-* under windows, use the `official protobuf binaries <http://code.google.com/p/protobuf/downloads/list>`_.
+* Under windows, use the `official protobuf binaries <http://code.google.com/p/protobuf/downloads/list>`_.
 
 Then, install the gem:
 
@@ -27,6 +27,13 @@ Usage
   
   require 'protobuf-closure-library'
   ProtobufClosureLibrary::ProtocJs.compile input_proto_file,
-                                           output_dir, optional_protoc_arg, ...
+                                           output_dir, {
+                                             generator_options: {key: value},
+                                             protoc_options: []
+                                           }
 
 This generated a ``.pb.js`` file correponded to ``input_proto_file`` in ``output_dir``. The output file contains a subclass of  `goog.proto2.Message <http://closure-library.googlecode.com/svn/docs/class_goog_proto2_Message.html>`_.
+
+By default, the generated message classes are subclasses of ``goog.proto2.Message``. This can be overriden by using ``generator_options: {js_superclass: 'cusom_package.CustomClass'}`` which generates message classes with ``cusom_package.CustomClass`` as the superclass.
+
+Other protoc options can be passed to the compiler by ``protoc_options`` key.

data/ext/protoc_js_core/code_generator.cc

@@ -17,6 +17,7 @@
 #include "code_generator.h"
 
 #include <string>
+#include <vector>
 #include <iostream>  // NOLINT
 #include <sstream>  // NOLINT
 
@@ -37,12 +38,29 @@ CodeGenerator::CodeGenerator(const std::string &name)
 
 CodeGenerator::~CodeGenerator() {}
 
+std::string CodeGenerator::js_superclass_ = "goog.proto2.Message";
+bool CodeGenerator::advanced_ = false;
+
 bool CodeGenerator::Generate(
     const google::protobuf::FileDescriptor *file,
-    const std::string &/* parameter */,
+    const std::string & parameter ,
     google::protobuf::compiler::OutputDirectory *output_directory,
     std::string *error) const {
 
+  std::vector<std::pair<std::string, std::string> > options;
+  google::protobuf::compiler::ParseGeneratorParameter(parameter, &options);
+  
+  for (unsigned int i = 0; i < options.size(); i++) {
+    if (options[i].first == "js_superclass") {
+      CodeGenerator::js_superclass_ = options[i].second;
+    } else if (options[i].first == "advanced" && options[i].second == "true") {
+      CodeGenerator::advanced_ = true;
+    } else {
+      *error = "Unknown generator option: " + options[i].first;
+      return false;
+    }
+  }
+
   const std::string file_name = file->name();
   std::string output_file_name = file->name();
   std::size_t loc = output_file_name.rfind(".");
@@ -76,8 +94,8 @@ bool CodeGenerator::Generate(
   }
 
   printer.Print("\n");
-  printer.Print("goog.require('goog.proto2.Message');\n"
-                "\n");
+  printer.Print("goog.require('$js_superclass$');\n"
+                "\n", "js_superclass", CodeGenerator::js_superclass_);
   for (int i = 0; i < file->dependency_count(); ++i) {
     for (int j = 0; j < file->dependency(i)->message_type_count(); j++) {
       printer.Print(
@@ -172,30 +190,33 @@ void CodeGenerator::GenDescriptor(
                  "/**\n"
                  " * Message $name$.\n"
                  " * @constructor\n"
-                 " * @extends {goog.proto2.Message}\n"
+                 " * @extends {$js_superclass$}\n"
                  " */\n",
-                 "name", message->name());
+                 "name", message->name(),
+                 "js_superclass", CodeGenerator::js_superclass_);
   printer->Print("$name$ = function() {\n",
                  "name", JsFullName(message->file(),
                                     message->full_name()));
   printer->Indent();
-  printer->Print("goog.proto2.Message.apply(this);\n");
+  printer->Print("$js_superclass$.apply(this);\n", "js_superclass", CodeGenerator::js_superclass_);
   printer->Outdent();
   printer->Print("};\n"
-                 "goog.inherits($name$, goog.proto2.Message);\n"
+                 "goog.inherits($name$, $js_superclass$);\n"
                  "\n"
                  "\n",
                  "name", JsFullName(message->file(),
-                                    message->full_name()));
+                                    message->full_name()),
+                  "js_superclass", CodeGenerator::js_superclass_);
 
   printer->Print(
       "/**\n"
-      " * Overrides {@link goog.proto2.Message#clone} to specify its exact "
+      " * Overrides {@link $js_superclass$#clone} to specify its exact "
       "return type.\n"
       " * @return {!$name$} The cloned message.\n"
       " * @override\n"
       " */\n"
       "$name$.prototype.clone;\n",
+      "js_superclass", CodeGenerator::js_superclass_,
       "name", JsFullName(message->file(),
                          message->full_name()));
 
@@ -393,16 +414,17 @@ void CodeGenerator::GenFieldDescriptor(
                    " * Sets the value of the $name$ field.\n",
                    "name", field->name());
     printer->Print(" * @param {$opt$$type$} value The value.\n"
+                   " * @param {Object} opt_options Options.\n"
                    " */\n",
                    "opt", type_is_primitive ? "" : "!",
                    "type", type);
-    printer->Print("$prefix$.prototype.set$field$ = function(value) {\n",
+    printer->Print("$prefix$.prototype.set$field$ = function(value, opt_options) {\n",
                    "prefix", JsFullName(field->containing_type()->file(),
                                         field->containing_type()->full_name()),
                    "field", upper_name);
     printer->Indent();
     printer->Print(
-        "this.set$$Value($number$, value);\n",
+        "this.set$$Value($number$, value, opt_options);\n",
         "number", number.str());
     printer->Outdent();
     printer->Print("};\n"
@@ -508,6 +530,61 @@ void CodeGenerator::GenFieldDescriptor(
                  "number", number.str());
   printer->Outdent();
   printer->Print("};\n");
+
+  if (CodeGenerator::advanced_) {
+    // update events
+    printer->Print("\n"
+                   "/**\n"
+                   " * Listens to update event on $name$ field.\n"
+                   " * @param {function} callback The callback to invoke.\n"
+                   " * @param {Object} context The 'this' sent to callback..\n"
+                   " */\n",
+                   "name", field->name());
+    printer->Print("$prefix$.prototype.onUpdate$field$ = function(callback, context) {\n",
+                   "prefix", JsFullName(field->containing_type()->file(),
+                                        field->containing_type()->full_name()),
+                   "field", upper_name);
+    printer->Indent();
+    printer->Print("this.listen('update:$number$', callback, context);\n",
+                   "number", number.str());
+    printer->Outdent();
+    printer->Print("};\n");
+    printer->Print("\n"
+                   "/**\n"
+                   " * Clears update event on $name$ field.\n"
+                   " */\n",
+                   "name", field->name());
+    printer->Print("$prefix$.prototype.forgetUpdate$field$ = function() {\n",
+                   "prefix", JsFullName(field->containing_type()->file(),
+                                        field->containing_type()->full_name()),
+                   "field", upper_name);
+    printer->Indent();
+    printer->Print("this.forget('update:$number$');\n",
+                   "number", number.str());
+    printer->Outdent();
+    printer->Print("};\n");
+
+    // collections
+    printer->Print("\n"
+                   "/**\n"
+                   " * Returns the collection in the $name$ field.\n",
+                   "name", field->name());
+    printer->Print(
+        " * @return {Object} The values in the field.\n"
+        " */\n");
+    printer->Print("$prefix$.prototype.$field$Collection = function() {\n",
+                   "prefix", JsFullName(field->containing_type()->file(),
+                                        field->containing_type()->full_name()),
+                   "field", field->camelcase_name());
+    printer->Indent();
+    printer->Print(
+        "return (this.collection$$Values($number$));"
+        "\n",
+        "number", number.str());
+    printer->Outdent();
+    printer->Print("};\n"
+                   "\n");
+  } // if (CodeGenerator::advanced_)
 }
 
 void CodeGenerator::GenEnumDescriptor(
@@ -546,7 +623,8 @@ void CodeGenerator::GenDescriptorMetadata(
       google::protobuf::io::Printer *printer) {
   printer->Print("\n"
                  "\n"
-                 "goog.proto2.Message.set$$Metadata($name$, {\n",
+                 "$js_superclass$.set$$Metadata($name$, {\n",
+                 "js_superclass", CodeGenerator::js_superclass_,
                  "name", JsFullName(message->file(),
                                     message->full_name()));
   printer->Indent();
@@ -714,7 +792,8 @@ void CodeGenerator::GenFieldDescriptorMetadata(
   if (field->is_repeated()) {
     printer->Print("repeated: true,\n");
   }
-  printer->Print("fieldType: goog.proto2.Message.FieldType.$js_type$,\n",
+  printer->Print("fieldType: $js_superclass$.FieldType.$js_type$,\n",
+                 "js_superclass", CodeGenerator::js_superclass_,
                  "js_type", js_type);
   if (field->has_default_value() ||
       field->type() == google::protobuf::FieldDescriptor::TYPE_ENUM) {

data/ext/protoc_js_core/code_generator.h

@@ -40,6 +40,8 @@ class CodeGenerator : public ::google::protobuf::compiler::CodeGenerator {
 
  private:
   std::string name_;
+  static std::string js_superclass_;
+  static bool advanced_;
 
   static std::string JsFullName(
       const google::protobuf::FileDescriptor *file,

data/lib/protobuf-closure-library/protoc_js.rb

@@ -1,12 +1,24 @@
 module ProtobufClosureLibrary
 
 class ProtocJs
-  def self.compile proto_file, out_dir, *args
+  def self.compile proto_file, out_dir, options
+    options = {
+      generator_options: {},
+      protoc_options: []
+    }.merge options
+
+    if !File.exist? out_dir
+      FileUtils.mkdir_p out_dir
+    end
+
+    generator_options = options[:generator_options].map{|k, v| "#{k}=#{v}" }.join(',')
+    js_out_options = generator_options.empty? ? out_dir : "#{generator_options}:#{out_dir}"
+
     ProtocJsCore.compile RUBY_BIN, proto_file, 
       @@static_proto_path | [
-        "--js_out=#{out_dir}",
+        "--js_out=#{js_out_options}",
         "--proto_path=#{File.dirname proto_file}"
-      ] | args
+      ] | options[:protoc_options]
   end
 
 private

data/lib/protobuf-closure-library/version.rb

@@ -1,3 +1,3 @@
 module ProtobufClosureLibrary
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-closure-library
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-13 00:00:00.000000000 Z
+date: 2012-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
-  requirement: &2169520160 !ruby/object:Gem::Requirement
+  requirement: &2157106240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2169520160
+  version_requirements: *2157106240
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2169519740 !ruby/object:Gem::Requirement
+  requirement: &2157105620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169519740
+  version_requirements: *2157105620
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &2169519320 !ruby/object:Gem::Requirement
+  requirement: &2157105140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169519320
+  version_requirements: *2157105140
 description: ! "      A wrapper for native protocol buffer javascript compiler\n      which
   generates closure library proto2 messages.\n"
 email:
@@ -85,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1293859870650302432
+      hash: 3792040639640788879
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1293859870650302432
+      hash: 3792040639640788879
 requirements: []
 rubyforge_project: protobuf-closure-library
 rubygems_version: 1.8.10