protobuf_nested_struct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bae6c6d57359ec2a06c717c132da705bec0f569e
+  data.tar.gz: 0d11b7bc9dc5ef4a4a10808c33bfc56ba7405e91
+SHA512:
+  metadata.gz: 9d506d70254b800a612076f2f5bfd12b12980bd58f479963fe51315e321b1e6e31177a372fe358ea291339900b85f8147f5dc76d46eb75e5bcf9141b9f4eabaf
+  data.tar.gz: 817930eb2167b5d9f37c1e205b59292cc18b199383ecd0006aa1135ac064b56db27229fec5c33ca8264931ed86b813cf0ae3bc18b1301d8279a4e6327a54f7fb

data/.circleci/config.yml

@@ -0,0 +1,12 @@
+version: 2
+jobs:
+  build:
+    macos:
+      xcode: "9.3.0"
+    steps:
+      - checkout
+      - run:
+          name: install+mutate
+          command: bundle install && bundle exec mutant --include lib --require protobuf_nested_struct --use rspec ProtobufNestedStruct*
+          environment:
+            ARCHFLAGS: "-arch x86_64"

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.3
+  - 2.3.7
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in protobuf-nested-struct.gemspec
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+# ProtobufNestedStruct
+
+Serialize your primitives, arrays and hashes using protobuf. Supports nested arrays and hashes.
+
+Supported types:
+
+* nil
+* integer
+* float
+* boolean
+* string
+* date
+* time
+* hash (keys must be strings, values' types must be on this list)
+* array (elements' types must be on this list)
+
+Inspired by `google/protobuf/struct.proto` but it can additionally handle Date, Time and Integer values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'protobuf_nested_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install protobuf_nested_struct
+
+## Usage
+
+```ruby
+# store the serialized binary string in DB or send over network
+serialized = ProtobufNestedStruct.dump(v)
+
+
+# receive de-serialized binary string from DB or network 
+copy = ProtobufNestedStruct.load(serialized)
+
+expect(copy).to eql(obj)
+```
+
+where `obj` can be an instance of one of the supported types.
+
+## Development
+
+* `bundle install`
+* `bundle exec rspec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arkency/protobuf-nested-struct 
+
+## Credits
+
+* https://github.com/google/protobuf/blob/07b9238a1c03ef0351bcb4ca57d773eb7b7c5824/src/google/protobuf/struct.proto
+* https://github.com/google/protobuf/blob/9497a657d577ebda0272711651c3dcdda3a4ac35/ruby/lib/google/protobuf/well_known_types.rb#L149
+* https://github.com/google/protobuf/blob/9497a657d577ebda0272711651c3dcdda3a4ac35/ruby/tests/well_known_types_test.rb#L35
+
+## About
+
+<img src="https://arkency.com/images/arkency.png" alt="Arkency" width="60px" align="left" />
+
+This repository is funded and maintained by [Arkency](https://arkency.com). Check out our other [open-source projects](https://github.com/arkency), especially [Rails Event Store](https://github.com/RailsEventStore).
+
+Consider [hiring us](https://arkency.com/hire-us) to grow your Ruby/Rails apps and business. Make sure to check out [our blog](https://blog.arkency.com).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "protobuf_nested_struct"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/google/type/date.proto

@@ -0,0 +1,45 @@
+// Copyright 2016 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.type;
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/genproto/googleapis/type/date;date";
+option java_multiple_files = true;
+option java_outer_classname = "DateProto";
+option java_package = "com.google.type";
+option objc_class_prefix = "GTP";
+
+
+// Represents a whole calendar date, e.g. date of birth. The time of day and
+// time zone are either specified elsewhere or are not significant. The date
+// is relative to the Proleptic Gregorian Calendar. The day may be 0 to
+// represent a year and month where the day is not significant, e.g. credit card
+// expiration date. The year may be 0 to represent a month and day independent
+// of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay]
+// and `google.protobuf.Timestamp`.
+message Date {
+  // Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+  // a year.
+  int32 year = 1;
+
+  // Month of year. Must be from 1 to 12.
+  int32 month = 2;
+
+  // Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+  // if specifying a year/month where the day is not significant.
+  int32 day = 3;
+}

data/lib/google/type/date_pb.rb

@@ -0,0 +1,18 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: date.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.type.Date" do
+    optional :year, :int32, 1
+    optional :month, :int32, 2
+    optional :day, :int32, 3
+  end
+end
+
+module Google
+  module Type
+    Date = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.type.Date").msgclass
+  end
+end

data/lib/protobuf_nested_struct.rb

@@ -0,0 +1,102 @@
+require 'date'
+require 'google/protobuf'
+require 'google/protobuf/well_known_types'
+
+require 'protobuf_nested_struct/version'
+require 'protobuf_nested_struct/struct_pb'
+
+module ProtobufNestedStruct
+  class Value
+    def from_ruby(obj)
+      case obj
+        when nil
+          self.null_value = 0
+        when Integer
+          self.int_value = obj
+        when Float
+          self.double_value = obj
+        when String
+          self.string_value = obj
+        when TrueClass, FalseClass
+          self.bool_value = obj
+        when Date
+          self.date_value = Google::Type::Date.new(day: obj.day, month: obj.month, year: obj.year)
+        when Time
+          self.timestamp_value = Google::Protobuf::Timestamp.new.tap{|gpt| gpt.from_time(obj) }
+        when Hash
+          self.string_map_value = HashMapStringValue.new.tap{|ps| ps.from_ruby(obj) }
+        when Array
+          self.list_value = ListValue.new.tap{|ps| ps.from_ruby(obj) }
+        else
+          raise ArgumentError, "not allowed: #{obj.inspect}"
+      end
+    end
+
+    def to_ruby
+      case kind
+        when :null_value
+          nil
+        when :int_value
+          int_value
+        when :double_value
+          double_value
+        when :string_value
+          string_value
+        when :bool_value
+          bool_value
+        when :date_value
+          Date.new(date_value.year, date_value.month, date_value.day)
+        when :timestamp_value
+          timestamp_value.to_time
+        when :string_map_value
+          string_map_value.to_ruby
+        when :list_value
+          list_value.to_ruby
+        else
+          raise ArgumentError
+      end
+    end
+
+  end
+
+  class HashMapStringValue
+    def from_ruby(obj)
+      Hash === obj or raise ArgumentError
+      obj.each do |key, value|
+        fields[key] ||= Value.new
+        fields[key].from_ruby(value)
+      end
+    end
+
+    def to_ruby
+      fields.each_with_object({}) do |(key, value), hash|
+        hash[key] = value.to_ruby
+      end
+    end
+  end
+
+  class ListValue
+    def from_ruby(obj)
+      Array === obj or raise ArgumentError
+      values.clear
+      obj.each do |value|
+        values << Value.new.tap{|v| v.from_ruby(value) }
+      end
+    end
+
+    def to_ruby
+      values.map{|v| v.to_ruby }
+    end
+  end
+
+  def self.dump(obj)
+    v = Value.new
+    v.from_ruby(obj)
+    Value.encode(v)
+  end
+
+  def self.load(string)
+    v = Value.decode(string)
+    v.to_ruby
+  end
+end

data/lib/protobuf_nested_struct/struct.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+import "google/protobuf/timestamp.proto";
+import "google/type/date.proto";
+package protobuf_nested_struct;
+
+message HashMapStringValue {
+  map<string, Value> fields = 1;
+}
+
+message Value {
+  oneof kind {
+    NullValue null_value = 1;
+    double double_value = 2;
+    int64 int_value = 3;
+    string string_value = 4;
+    bool bool_value = 5;
+
+    google.type.Date date_value = 6;
+    google.protobuf.Timestamp timestamp_value = 7;
+
+    HashMapStringValue string_map_value = 20;
+    ListValue list_value = 21;
+  }
+}
+
+enum NullValue {
+  NULL_VALUE = 0;
+}
+
+message ListValue {
+  repeated Value values = 1;
+}

data/lib/protobuf_nested_struct/struct_pb.rb

@@ -0,0 +1,38 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: struct.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+require 'google/type/date_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "protobuf_nested_struct.HashMapStringValue" do
+    map :fields, :string, :message, 1, "protobuf_nested_struct.Value"
+  end
+  add_message "protobuf_nested_struct.Value" do
+    oneof :kind do
+      optional :null_value, :enum, 1, "protobuf_nested_struct.NullValue"
+      optional :double_value, :double, 2
+      optional :int_value, :int64, 3
+      optional :string_value, :string, 4
+      optional :bool_value, :bool, 5
+      optional :date_value, :message, 6, "google.type.Date"
+      optional :timestamp_value, :message, 7, "google.protobuf.Timestamp"
+      optional :string_map_value, :message, 20, "protobuf_nested_struct.HashMapStringValue"
+      optional :list_value, :message, 21, "protobuf_nested_struct.ListValue"
+    end
+  end
+  add_message "protobuf_nested_struct.ListValue" do
+    repeated :values, :message, 1, "protobuf_nested_struct.Value"
+  end
+  add_enum "protobuf_nested_struct.NullValue" do
+    value :NULL_VALUE, 0
+  end
+end
+
+module ProtobufNestedStruct
+  HashMapStringValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("protobuf_nested_struct.HashMapStringValue").msgclass
+  Value = Google::Protobuf::DescriptorPool.generated_pool.lookup("protobuf_nested_struct.Value").msgclass
+  ListValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("protobuf_nested_struct.ListValue").msgclass
+  NullValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("protobuf_nested_struct.NullValue").enummodule
+end

data/lib/protobuf_nested_struct/version.rb

@@ -0,0 +1,3 @@
+module ProtobufNestedStruct
+  VERSION = "1.0.0"
+end

data/protobuf_nested_struct.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "protobuf_nested_struct/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "protobuf_nested_struct"
+  spec.version       = ProtobufNestedStruct::VERSION
+  spec.authors       = ["Robert Pankowecki", "Arkency"]
+  spec.email         = ["dev@arkency.com"]
+
+  spec.summary       = %q{Serialize primitives and deep structures (array, hash) to protobuf}
+  spec.description   = %q{Serialize primitives and deep structures (array, hash) to protobuf}
+  spec.homepage      = "https://github.com/arkency/protobuf-nested-struct"
+  spec.metadata      = {
+    "homepage_uri"    => "https://github.com/arkency/protobuf-nested-struct",
+    "changelog_uri"   => "https://github.com/arkency/protobuf-nested-struct/releases",
+    "source_code_uri" => "https://github.com/arkency/protobuf-nested-struct",
+    "bug_tracker_uri" => "https://github.com/arkency/protobuf-nested-struct/issues",
+  }
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "google-protobuf"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "mutant-rspec"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: protobuf_nested_struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert Pankowecki
+- Arkency
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Serialize primitives and deep structures (array, hash) to protobuf
+email:
+- dev@arkency.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/google/type/date.proto
+- lib/google/type/date_pb.rb
+- lib/protobuf_nested_struct.rb
+- lib/protobuf_nested_struct/struct.proto
+- lib/protobuf_nested_struct/struct_pb.rb
+- lib/protobuf_nested_struct/version.rb
+- protobuf_nested_struct.gemspec
+homepage: https://github.com/arkency/protobuf-nested-struct
+licenses: []
+metadata:
+  homepage_uri: https://github.com/arkency/protobuf-nested-struct
+  changelog_uri: https://github.com/arkency/protobuf-nested-struct/releases
+  source_code_uri: https://github.com/arkency/protobuf-nested-struct
+  bug_tracker_uri: https://github.com/arkency/protobuf-nested-struct/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Serialize primitives and deep structures (array, hash) to protobuf
+test_files: []