protojson 0.1.0 → 0.2.0

data/Gemfile

@@ -3,7 +3,5 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in protojson.gemspec
 gemspec
 
-gem 'ruby_protobuf', '~>0.4.10'
-gem 'activesupport', '~>3.0.5'
-gem 'i18n', '~>0.5.0'
+gem "rake", "~>0.8.7"
 

data/README.md

@@ -12,7 +12,7 @@ This gem extends the *ruby_protobuf* gem [1] to allow these new encodings in a p
 
 # Installation
 
-    gem install protojson
+    gem install protojson -v0.2.0
 
 # Supported formats
 
@@ -30,32 +30,37 @@ as a string, where each character represents a tag, and placing it as the first
 
 ## Serialize a message
 
-    require 'addressbook.pb'
-    require 'protojson'
-    person = Tutorial::Person.new
-    person.parse_from_file ARGV[0]
-
-    Protobuf::Message::encoding = Protobuf::Message::EncodingType::INDEXED
 
-    value = person.serialize_to_string
+    require 'protojson'
+    require 'examples/addressbook.rb'
 
-    puts value
+    book = Examples::AddressBook.new
 
-## Parse a message
+    person = Examples::Person.new
+    person.name = 'Juan de Bravo'
+    person.id = 21
+    book.person << person
 
-    require 'addressbook.pb'
-    require 'protojson'
+### Serialize using the default codec (binary)
 
-    person = Tutorial::Person.new
-    person.parse_from_file ARGV[0]
+    data = Protojson.encode(book)
 
-    Protobuf::Message::encoding = Protobuf::Message::EncodingType::INDEXED
+### Serialize using a specific codec
 
-    value = person.serialize_to_string
+    [:json, :tagmap, :indexed].each{|codec|
+        Protojson.encode(book, codec)
+    }
 
-    person = Tutorial::Person.new
+## Unserialize a message
 
-    person.parse_from_string(value)
+### Unserialize using a specific codec
+    data = Protojson.encode(book, :json)
+    value = Protojson.decode(Examples::AddressBook, data, :json)
+    puts value.person[0].name # "Juan de Bravo"
 
-    p person
+### Unserialize using the default codec
+    Protojson.set_default_codec(:json)
+    data = Protojson.encode(book)
+    value = Protojson.decode(Examples::AddressBook, data)
+    puts value.person[0].name # "Juan de Bravo"
 

data/Rakefile

@@ -1,20 +1,22 @@
 require 'bundler'
-require 'rake/rdoctask'
+require 'rspec/core/rake_task'
 require 'rake/clean'
 
 Bundler::GemHelper.install_tasks
 
+task :default => [:test]
+
+RSpec::Core::RakeTask.new(:test) do |spec|
+    spec.skip_bundler = true
+    spec.pattern = 'spec/*_spec.rb'
+    spec.rspec_opts = '--color --format doc'
+end
+
 desc "Show the different encodings using a test file"
 namespace :test do
   task :person do
-    sh "ruby spec/main.rb spec/person"
+    sh "ruby examples/main.rb examples/person"
   end
 end
 
 
-Rake::RDocTask.new do |rd|
-  rd.main = "README.md"
-  rd.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb")
-  rd.title = 'ProtoJson'
-end
-

data/examples/addressbook.pb.rb

@@ -0,0 +1,70 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: addressbook.proto>
+# package examples;
+# 
+# /**
+#  * Defines a Person in the addressbook
+#  */
+# message Person {
+#   /* The full name of the person */
+#   required string name = 1;
+#   /* The person Id in the database */
+#   required int32 id = 2;
+#   /* The person email */
+#   optional string email = 3;
+# 
+#   /* Different types of phones */
+#   enum PhoneType {
+#     MOBILE = 0;
+#     HOME = 1;
+#     WORK = 2;
+#   }
+# 
+#   /* A phone number record */
+#   message PhoneNumber {
+#     required string number = 1;
+#     optional PhoneType type = 2 [default = HOME];
+#   }
+# 
+#   /* The different phone numbers associated to a person */
+#   repeated PhoneNumber phone = 4;
+# }
+# 
+# 
+# /* A collection of persons contact details */
+# message AddressBook {
+#   repeated Person person = 1;
+# 
+#   extensions 1000 to max;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module Examples
+  class Person < ::Protobuf::Message
+    defined_in __FILE__
+    required :string, :name, 1
+    required :int32, :id, 2
+    optional :string, :email, 3
+    class PhoneType < ::Protobuf::Enum
+      defined_in __FILE__
+      MOBILE = value(:MOBILE, 0)
+      HOME = value(:HOME, 1)
+      WORK = value(:WORK, 2)
+    end
+    class PhoneNumber < ::Protobuf::Message
+      defined_in __FILE__
+      required :string, :number, 1
+      optional :PhoneType, :type, 2, :default => :HOME
+    end
+    repeated :PhoneNumber, :phone, 4
+  end
+  class AddressBook < ::Protobuf::Message
+    defined_in __FILE__
+    repeated :Person, :person, 1
+    extensions 1000..::Protobuf::Extend::MAX
+  end
+end

data/examples/addressbook.proto

@@ -0,0 +1,37 @@
+package examples;
+
+/**
+ * Defines a Person in the addressbook
+ */
+message Person {
+  /* The full name of the person */
+  required string name = 1;
+  /* The person Id in the database */
+  required int32 id = 2;
+  /* The person email */
+  optional string email = 3;
+
+  /* Different types of phones */
+  enum PhoneType {
+    MOBILE = 0;
+    HOME = 1;
+    WORK = 2;
+  }
+
+  /* A phone number record */
+  message PhoneNumber {
+    required string number = 1;
+    optional PhoneType type = 2 [default = HOME];
+  }
+
+  /* The different phone numbers associated to a person */
+  repeated PhoneNumber phone = 4;
+}
+
+
+/* A collection of persons contact details */
+message AddressBook {
+  repeated Person person = 1;
+
+  extensions 1000 to max;
+}

data/examples/addressbook2.pb.rb

@@ -0,0 +1,56 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: examples/addressbook.proto>
+# package tutorial;
+# 
+# message Person {
+#   required string name = 1;
+#   required int32 id = 2;
+#   optional string email = 3;
+# 
+#   enum PhoneType {
+#     MOBILE = 0;
+#     HOME = 1;
+#     WORK = 2;
+#   }
+# 
+#   message PhoneNumber {
+#     required string number = 1;
+#     optional PhoneType type = 2 [default = HOME];
+#   }
+# 
+#   repeated PhoneNumber phone = 4;
+# }
+# 
+# message AddressBook {
+#   repeated Person person = 1;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module Tutorial
+  class Person < ::Protobuf::Message
+    defined_in __FILE__
+    required :string, :name, 1
+    required :int32, :id, 2
+    optional :string, :email, 3
+    class PhoneType < ::Protobuf::Enum
+      defined_in __FILE__
+      MOBILE = 0
+      HOME = 1
+      WORK = 2
+    end
+    class PhoneNumber < ::Protobuf::Message
+      defined_in __FILE__
+      required :string, :number, 1
+      optional :PhoneType, :type, 2, :default => :HOME
+    end
+    repeated :PhoneNumber, :phone, 4
+  end
+  class AddressBook < ::Protobuf::Message
+    defined_in __FILE__
+    repeated :Person, :person, 1
+  end
+end

data/examples/example.rb

@@ -0,0 +1,54 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$:.unshift File.join(File.dirname(__FILE__), '.')
+
+require 'addressbook.pb'
+require 'protojson'
+
+book = Examples::AddressBook.new
+person = Examples::Person.new
+person.name = 'John Doe'
+person.id = 2051
+person.email = "john.doe@gmail.com"
+phone = Examples::Person::PhoneNumber.new
+phone.number = '1231231212'
+phone.type = Examples::Person::PhoneType::HOME
+person.phone << phone
+phone = Examples::Person::PhoneNumber.new
+phone.number = '55512321312'
+phone.type = Examples::Person::PhoneType::MOBILE
+person.phone << phone
+book.person << person
+
+person = Examples::Person.new
+person.name = "Ivan Montes"
+person.id = 23
+person.email = "drslump@pollinimini.net"
+phone = Examples::Person::PhoneNumber.new
+phone.number = '3493123123'
+phone.type = Examples::Person::PhoneType::WORK
+person.phone << phone
+book.person << person
+
+person = Examples::Person.new
+person.name = "Juan de Bravo"
+person.id = 24
+person.email = "juan@pollinimini.net"
+phone = Examples::Person::PhoneNumber.new
+phone.number = '3493123124'
+phone.type = Examples::Person::PhoneType::WORK
+person.phone << phone
+book.person << person
+
+puts "\nAddressbook info:\n"
+
+p book
+
+puts "\nJSON encoding: \n"
+puts Protojson.encode(book, :json)
+
+puts "\nTAGMAP encoding: \n"
+puts Protojson.encode(book, :tag_map)
+
+puts "\nINDEXED encoding: \n"
+puts Protojson.encode(book, :indexed).to_s
+

data/examples/main.rb

@@ -0,0 +1,50 @@
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+$:.unshift File.join(File.dirname(__FILE__),'.')
+
+require 'rubygems'
+require 'addressbook2.pb'
+require 'protojson'
+
+unless ARGV.size == 1
+  puts "Usage: #{$0} ADDRESS_BOOK_FILE"
+  exit
+end
+
+person = Tutorial::Person.new
+person.parse_from_file ARGV[0]
+
+puts ""
+puts "Person data"
+puts "..........."
+
+p person
+
+puts ""
+puts "Json encoding"
+puts "................"
+value = Protojson.encode(person, Protojson::Codec::Json)
+puts value
+person = Protojson.decode(Tutorial::Person, value, :json)
+
+puts ""
+puts "Indexed encoding"
+puts "................"
+value = Protojson.encode(person, Protojson::Codec::JsonIndexed)
+p value
+person = Protojson.decode(Tutorial::Person, value, :indexed)
+
+puts ""
+puts "Tagmap encoding"
+puts "..............."
+value = Protojson.encode(person, Protojson::Codec::JsonTagMap)
+puts value
+person = Protojson.decode(Tutorial::Person, value, :tag_map)
+
+puts ""
+puts "Hashmap encoding"
+puts "................"
+value = Protojson.encode(person, Protojson::Codec::Hash)
+puts value
+person = Protojson.decode(Tutorial::Person, value, :hash)
+

data/examples/repeated.pb.rb

@@ -0,0 +1,32 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: repeated.proto>
+# package examples;
+# 
+# message Repeated {
+# 
+#   message Nested {
+#     optional int32 id = 1;
+#   }
+# 
+#   repeated string string = 1;
+#   repeated int32 int = 2;
+#   repeated Nested nested = 3;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module Examples
+  class Repeated < ::Protobuf::Message
+    defined_in __FILE__
+    class Nested < ::Protobuf::Message
+      defined_in __FILE__
+      optional :int32, :id, 1
+    end
+    repeated :string, :string, 1
+    repeated :int32, :int, 2
+    repeated :Nested, :nested, 3
+  end
+end

data/examples/repeated.proto

@@ -0,0 +1,12 @@
+package examples;
+
+message Repeated {
+
+  message Nested {
+    optional int32 id = 1;
+  }
+
+  repeated string string = 1;
+  repeated int32 int = 2;
+  repeated Nested nested = 3;
+}

data/examples/simple.pb.rb

@@ -0,0 +1,23 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: simple.proto>
+# package examples;
+# 
+# message Simple {
+#   required string foo = 1;
+#   required int32 bar = 2;
+#   optional string baz = 3;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module Examples
+  class Simple < ::Protobuf::Message
+    defined_in __FILE__
+    required :string, :foo, 1
+    required :int32, :bar, 2
+    optional :string, :baz, 3
+  end
+end