pb_json_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ed2211bc248280019756fcfd8f74c8f5abe7d472ef5eaa5e38b72c35e96a633
+  data.tar.gz: 3609f021a03be07a3bac89c0ca1a1ddd77c1aa4748ff8ef81a605fbe2983afe7
+SHA512:
+  metadata.gz: 8ade920f219c29475036b0f60bc88cac02da438e9ddbd5ca95d8d4a14c830bb50ed9b9789365be5a692804274a967279e11d71430ecda5c0607a9e283fd7df77
+  data.tar.gz: 8a7b8d36cdf82c1fa895e3f44deba5d693f20ec07921a7144bb19aefe508c1a90ee9f85f50fa7373c299313f54a2cfe7616e26cc586e37848318192a7dec2a37

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

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 pb_json_parser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    pb_json_parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pb_json_parser!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.8)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nao Minami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# PbJsonParser
+
+PbJsonParser parses JSON dumps generated by [protoc-gen-json](https://github.com/sourcegraph/prototools/blob/master/README.json.md) and returns the information of fields and associations of each message types.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pb_json_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pb_json_parser
+
+## Usage
+First, prepare .proto file.
+
+```protobuf
+// resources.proto
+syntax = "proto3";
+package south37.users_prototype;
+
+import "google/protobuf/timestamp.proto";
+
+message User {
+  int32 id = 1;
+  Profile profile = 2;
+}
+
+message Profile {
+  int32 id = 1;
+  google.protobuf.Timestamp birthday = 2;
+}
+```
+
+Then, generate `.proto.json` by protoc with [protoc-gen-json](https://github.com/sourcegraph/prototools/blob/master/README.json.md) plugin.
+
+```bash
+$ REPOLIST=( \
+>   sourcegraph.com/sourcegraph/prototools/cmd/protoc-gen-json \
+> )
+> for REPO in ${REPOLIST[@]}; do
+>   if [ ! -d $GOPATH/src/$REPO ]; then
+>     go get -u $REPO
+>   fi
+> done
+
+$ protoc \
+>   -I ./protos \
+>   --json_out=out=resources.proto.json:./protos \
+>   ./protos/resources.proto
+```
+
+Finally you can parse the json by `PbJsonParser`.
+
+```ruby
+[6] pry(main)> PbJsonParser.parse(json: File.read('./protos/resources.proto.json'), filename: 'resources.proto').map(&:to_h)
+=> [
+ {:name=>"User", :fields=>["id"], :assocs=>[{:name=>"profile", :type=>"has_one", :class_name=>"Profile"}]},
+ {:name=>"Profile", :fields=>["id", "birthday"], :assocs=>[]}
+]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake true` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/south37/pb_json_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pb_json_parser"
+
+# 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.
+
+require "pry"
+Pry.start

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/pb_json_parser/ast/association.rb

@@ -0,0 +1,38 @@
+module PbJsonParser
+  module AST
+    class Association
+      Type = {
+        has_one:  "has_one".freeze,
+        has_many: "has_many".freeze,
+      }.freeze
+
+      attr_reader :name, :type, :class_name
+
+      # @param [String] name
+      # @param [String] type
+      # @param [String] class_name
+      def initialize(name:, type:, class_name:)
+        @name       = name
+        @type       = type
+        @class_name = class_name
+        validate!
+      end
+
+      def to_h
+        {
+          name:       @name,
+          type:       @type,
+          class_name: @class_name,
+        }
+      end
+
+    private
+
+      def validate!
+        if !Type.values.include?(@type)
+          raise "Invalid type: #{@type}"
+        end
+      end
+    end
+  end
+end

data/lib/pb_json_parser/ast/field.rb

@@ -0,0 +1,12 @@
+module PbJsonParser
+  module AST
+    class Field
+      attr_reader :name
+
+      # @param [String] name
+      def initialize(name:)
+        @name = name
+      end
+    end
+  end
+end

data/lib/pb_json_parser/ast/message.rb

@@ -0,0 +1,32 @@
+module PbJsonParser
+  module AST
+    class Message
+      attr_reader :name, :fields, :assocs
+
+      # @param [String] name
+      def initialize(name:)
+        @name   = name
+        @fields = []
+        @assocs = []
+      end
+
+      # @param [Field] f
+      def push_field(f)
+        @fields.push(f)
+      end
+
+      # @param [Association] a
+      def push_assoc(a)
+        @assocs.push(a)
+      end
+
+      def to_h
+        {
+          name:   @name,
+          fields: @fields.map(&:name),
+          assocs: @assocs.map(&:to_h),
+        }
+      end
+    end
+  end
+end

data/lib/pb_json_parser/ast.rb

@@ -0,0 +1,8 @@
+require "pb_json_parser/ast/association"
+require "pb_json_parser/ast/field"
+require "pb_json_parser/ast/message"
+
+module PbJsonParser
+  module AST
+  end
+end

data/lib/pb_json_parser/config.rb

@@ -0,0 +1,17 @@
+module PbJsonParser
+  class Config
+    attr_reader :skip_fields
+
+    def initialize
+      @skip_fields = []
+    end
+
+    # @param [<String>] fields
+    def skip_fields=(fields)
+      if !fields.is_a?(Array)
+        raise "invalid skip_fields: #{fields}"
+      end
+      @skip_fields = fields
+    end
+  end
+end

data/lib/pb_json_parser/parser.rb

@@ -0,0 +1,101 @@
+require 'json'
+
+module PbJsonParser
+  class Parser
+    # @param [String] json
+    # @param [String] filename
+    # @param [Config] config
+    def initialize(json:, filename:)
+      @data       = read_data(json, filename)
+      @config     = Config.new
+      @package    = @data["package"]
+    end
+
+    # @return [<AST::Message>]
+    def parse
+      r = []
+      @data["message_type"].each do |m_type|
+        m = parse_message(m_type)
+        r.push m
+      end
+      r
+    end
+
+    def configure(&block)
+      yield @config
+    end
+
+  private
+
+    # @param [{ String => Any }] message_type
+    # @return [<AST::Message>]
+    def parse_message(message_type)
+      m = AST::Message.new(name: message_type["name"])
+
+      message_type["field"].each do |f|
+        # NOTE: skip field when configured
+        next if @config.skip_fields.include?(f["name"])
+
+        case f["type"]
+        when 11  # type: TYPE_MESSAGE
+          if is_assoc?(f)
+            m.push_assoc(parse_assoc(f))
+          else
+            m.push_field(AST::Field.new(name: f["name"]))
+          end
+        else
+          m.push_field(AST::Field.new(name: f["name"]))
+        end
+      end
+
+      m
+    end
+
+    # @param [{ String => Any }] field
+    # @return [AST::Association]
+    def parse_assoc(field)
+      case field["label"]
+      when 3  # label: LABEL_REPEATED
+        type = AST::Association::Type[:has_many]
+      else
+        type = AST::Association::Type[:has_one]
+      end
+      class_name = field_message_type(field)
+
+      assoc = AST::Association.new(
+        name:       field["name"],
+        type:       type,
+        class_name: class_name,
+      )
+    end
+
+    # @param [{ string => Any }] field
+    # @return [bool]
+    def is_assoc?(field)
+      field_package(field) == @package
+    end
+
+    # @param [Hash] field
+    def field_package(field)
+      # NOTE: field["type_name"] is `.<package>.<message_type>`.
+      field["type_name"][1..@package.size]
+    end
+
+    # @param [Hash] field
+    def field_message_type(field)
+      # NOTE: field["type_name"] is `.<package>.<message_type>`.
+      field["type_name"][(@package.size + 2)..-1]
+    end
+
+    # @param [String] json
+    # @return [Hash]
+    def read_data(json, filename)
+      h = JSON.parse(json)
+      data = h["proto_file"].find { |f| f["name"] == filename }
+      if !data
+        raise "'#{filename}' does not exist in the json!"
+      end
+      data
+    end
+  end
+end

data/lib/pb_json_parser/version.rb

@@ -0,0 +1,3 @@
+module PbJsonParser
+  VERSION = "0.1.0"
+end

data/lib/pb_json_parser.rb

@@ -0,0 +1,19 @@
+require "pb_json_parser/version"
+require "pb_json_parser/ast"
+require "pb_json_parser/config"
+require "pb_json_parser/parser"
+
+module PbJsonParser
+  class << self
+    # @param [String] json
+    # @param [String] filename
+    # @return [<AST::Message>]
+    def parse(json:, filename:, skip_fields: [])
+      parser = Parser.new(json: json, filename: filename)
+      parser.configure do |c|
+        c.skip_fields = skip_fields
+      end
+      parser.parse
+    end
+  end
+end

data/pb_json_parser.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pb_json_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pb_json_parser"
+  spec.version       = PbJsonParser::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{Parser of JSON dumps generated by protoc-gen-json.}
+  spec.description   = %q{Parser of JSON dumps generated by protoc-gen-json.}
+  spec.homepage      = "https://github.com/south37/pb_json_parser"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: pb_json_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-11 00:00:00.000000000 Z
+dependencies:
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Parser of JSON dumps generated by protoc-gen-json.
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pb_json_parser.rb
+- lib/pb_json_parser/ast.rb
+- lib/pb_json_parser/ast/association.rb
+- lib/pb_json_parser/ast/field.rb
+- lib/pb_json_parser/ast/message.rb
+- lib/pb_json_parser/config.rb
+- lib/pb_json_parser/parser.rb
+- lib/pb_json_parser/version.rb
+- pb_json_parser.gemspec
+homepage: https://github.com/south37/pb_json_parser
+licenses:
+- MIT
+metadata: {}
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Parser of JSON dumps generated by protoc-gen-json.
+test_files: []