fmparser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb00fbdf6c704fdc22b51cf0fc27a0463d26f6b3a1a745de77891fe220e313f5
+  data.tar.gz: d760ccf65c0cdbac53ebbc2a2276b108290a16261f23d3a7423a069c4fb55c8e
+SHA512:
+  metadata.gz: b4b51eaaf3b39b16d1f4bda9e8575173ef8b1745ac059d8fe8f9bd6b347fe712ed63cca75d599534fc535f1a4eeeb9f1316281437add83f9af4f1359a8ce8626
+  data.tar.gz: 02c1285491a06748426929d56f22d1562d59c7aa0aef5ea68883f58b3032e2ae652ccf6c1dc4d5d7c8c928a638695fe5026874791c319b69811dcedfd52dc24d

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.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 fmparser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    fmparser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    google-protobuf (3.8.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      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.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  fmparser!
+  google-protobuf (~> 3.8)
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.8)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,121 @@
+# FMParser
+
+**F**ield**M**ask **Parser**. If you want to know more about FieldMask, please see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask .
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fmparser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fmparser
+
+## Usage
+
+`FMParser.parse` parses FieldMask parameter and returns a `FMParser::MessageNode` object.
+
+For example, suppose you have the protobuf message classes shown below:
+
+```proto
+syntax = "proto3";
+package msg;
+
+message User {
+  Operation op = 1;
+  int64 id = 2;
+  repeated Name names =3;
+  Job job = 4;
+}
+
+message Name {
+  Operation op = 1;
+  int64 id = 2;
+  string first_name = 3;
+  string middle_name = 4;
+  string last_name = 5;
+  string language = 6;
+}
+
+message Job {
+  Operation op = 1;
+  int64 id = 2;
+  string company = 3;
+}
+
+enum Operation {
+  OPERATION_UNSPECIFIED = 0;
+  CREATE = 1;
+  UPDATE = 2;
+  DELETE = 3;
+}
+```
+
+Then, you can parse `paths` array of strings with `root` protobuf message class.
+
+```ruby
+[1] pry(main)> f = FMParser.parse(paths: ["op", "id", "names.first_name", "names.last_name"], root: Msg::User)
+=> #<FMParser::MessageNode:0x00007f7fc9848168
+ @enums=[#<FMParser::EnumNode:0x00007f7fc98489b0 @label=:optional, @name=:op, @type=Msg::Operation>],
+ @label=nil,
+ @messages=
+  [#<FMParser::MessageNode:0x00007f7fc9848208
+    @enums=[],
+    @label=:repeated,
+    @messages=[],
+    @name=:names,
+    @scalars=
+     [#<FMParser::ScalarNode:0x00007f7fc98484b0 @label=:optional, @name=:first_name, @type=:string>,
+      #<FMParser::ScalarNode:0x00007f7fc98482a8 @label=:optional, @name=:last_name, @type=:string>],
+    @type=Msg::Name>],
+ @name=nil,
+ @scalars=[#<FMParser::ScalarNode:0x00007f7fc9848820 @label=:optional, @name=:id, @type=:int64>],
+ @type=Msg::User>
+
+[2] pry(main)> f.field_names
+=> [:id, :op, :names]
+
+[3] pry(main)> f.has?(:id)
+=> true
+
+[4] pry(main)> f.has?(:names)
+=> true
+
+[5] pry(main)> f.has?(:job)
+=> false
+
+[6] pry(main)> f.get_child(:names)
+=> #<FMParser::MessageNode:0x00007f7fc9848208
+ @enums=[],
+ @label=:repeated,
+ @messages=[],
+ @name=:names,
+ @scalars=
+  [#<FMParser::ScalarNode:0x00007f7fc98484b0 @label=:optional, @name=:first_name, @type=:string>,
+   #<FMParser::ScalarNode:0x00007f7fc98482a8 @label=:optional, @name=:last_name, @type=:string>],
+ @type=Msg::Name>
+
+[7] pry(main)> f.get_child(:names).field_names
+=> [:first_name, :last_name]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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/fmparser.
+
+## 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 "fmparser"
+
+# 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/fmparser.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fmparser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fmparser"
+  spec.version       = FMParser::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{FieldMask parameter parser}
+  spec.description   = %q{FieldMask parameter parser}
+  spec.homepage      = "https://github.com/south37/fmparser"
+  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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "google-protobuf", "~> 3.8"
+end

data/lib/fmparser.rb

@@ -0,0 +1,13 @@
+require "fmparser/parser"
+require "fmparser/version"
+
+module FMParser
+  class << self
+    # @param [<String>] paths
+    # @param [Class] root Google::Protobuf message class
+    def parse(paths:, root:)
+      parser = Parser.new
+      parser.parse(paths: paths, root: root)
+    end
+  end
+end

data/lib/fmparser/error.rb

@@ -0,0 +1,8 @@
+module FMParser
+  class Error < StandardError; end
+
+  class ParseError < Error; end
+  class InvalidPathError < ParseError; end
+
+  class InvalidParameterError < Error; end
+end

data/lib/fmparser/node.rb

@@ -0,0 +1,118 @@
+module FMParser
+  class Node
+  end
+
+  class ScalarNode < Node
+    # @param [String | Symbol] name
+    # @param [String | Symbol] type represents the scalar type of protobuf
+    # @param [String | Symbol] label
+    def initialize(name:, type:, label:)
+      @name  = name.to_sym
+      @type  = type.to_sym
+      @label = label.to_sym
+    end
+
+    attr_reader :name, :type, :label
+
+    def ==(other)
+      self.class == other.class &&
+        self.name == other.name &&
+        self.type == other.type &&
+        self.label == other.label
+    end
+  end
+
+  class EnumNode < Node
+    # @param [String | Symbol] name
+    # @param [Module] type represents the enum type of protobuf
+    # @param [String | Symbol] label
+    def initialize(name:, type:, label:)
+      @name  = name.to_sym
+      @type  = type
+      @label = label.to_sym
+    end
+
+    attr_reader :name, :type, :label
+
+    def ==(other)
+      self.class == other.class &&
+        self.name == other.name &&
+        self.type == other.type &&
+        self.label == other.label
+    end
+  end
+
+  class MessageNode < Node
+    # @param [String | Symbol | nil] name
+    # @param [Class] type represents the message type of protobuf
+    # @param [String | Symbol | nil] label
+    def initialize(name:, type:, label:, scalars: [], enums: [], messages: [])
+      @name  = name ? name.to_sym : name
+      @type  = type
+      @label = label ? label.to_sym : label
+
+      @scalars  = scalars
+      @enums    = enums
+      @messages = messages
+    end
+
+    attr_reader :name, :type, :label, :scalars, :enums, :messages
+
+    # @return [<FMParser::Node>]
+    def fields
+      scalars + enums + messages
+    end
+
+    # @return [<Symbol>]
+    def field_names
+      fields.map(&:name)
+    end
+
+    # @param [String | Symbol] field
+    # @return [Boolean]
+    def has?(field)
+      f = field.to_sym
+      validate!(f)
+      field_names.include?(f)
+    end
+
+    # @param [String | Symbol] field
+    # @return [FMParser::MessageNode | nil]
+    def get_child(field)
+      f = field.to_sym
+      validate!(f)
+      children[f]
+    end
+
+    def children
+      @children ||=
+        @messages.map { |m| [m.name, m] }.to_h
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        self.name == other.name &&
+        self.type == other.type &&
+        self.label == other.label &&
+        self.scalars == other.scalars &&
+        self.enums == other.enums &&
+        self.messages == other.messages
+    end
+
+  private
+
+    # @param [Symbol]
+    # @raise [InvalidFieldError]
+    def validate!(field)
+      if !valid_fields.include?(field)
+        raise InvalidParameterError.new("There is no \"#{field}\" field in the #{@type} class")
+      end
+    end
+
+    # @return [<Symbol>]
+    def valid_fields
+      @valid_fields ||=
+        @type.descriptor.entries.map(&:name).map(&:to_sym)
+    end
+  end
+end

data/lib/fmparser/parser.rb

@@ -0,0 +1,79 @@
+require "fmparser/error"
+require "fmparser/node"
+require "fmparser/parser/deep_hash_parser"
+
+module FMParser
+  class Parser
+    # @param [<String>] paths
+    # @param [Class] root Google::Protobuf message class
+    def parse(paths:, root:)
+      deep_hash = DeepHashParser.parse(paths)
+
+      scalars, enums, messages = build_nodes(
+        descriptor: root.descriptor,
+        deep_hash:  deep_hash,
+      )
+
+      MessageNode.new(
+        name:     nil,
+        type:     root,
+        label:    nil,
+        scalars:  scalars,
+        enums:    enums,
+        messages: messages,
+      )
+    end
+
+  private
+
+    # @param [Google::Protobuf::Descriptor] descriptor
+    # @param [FMParser::Parser::DeepHashNode] deep_hash
+    # @return [<<ScalarNode>, <EnumNode>, <MessageNode>>]
+    def build_nodes(descriptor:, deep_hash:)
+      scalars  = []
+      enums    = []
+      messages = []
+
+      deep_hash.children.each do |name, dh|
+        entry = descriptor.entries.find { |e| e.name == name }
+
+        if entry.nil?
+          raise InvalidPathError.new("\"#{name}\" does not exist in the fields of #{descriptor.msgclass}!")
+        end
+
+        case entry.type
+        when :message
+          d = entry.subtype  # Google::Protobuf::Descriptor
+          s, e, m = build_nodes(
+            descriptor: d,
+            deep_hash:  dh,
+          )
+          n = MessageNode.new(
+            name:     name,
+            type:     d.msgclass,
+            label:    entry.label,
+            scalars:  s,
+            enums:    e,
+            messages: m,
+          )
+          messages << n
+        when :enum
+          # NOTE: If dh.is_leaf is false, it is invalid. But ignore it now.
+          d = entry.subtype  # Google::Protobuf::EnumDescriptor
+          n = EnumNode.new(name: name, type: d.enummodule, label: entry.label)
+          enums << n
+        else  # We treat this case as scalar
+          # NOTE: If dh.is_leaf is false, it is invalid. But ignore it now.
+          n = ScalarNode.new(name: name, type: entry.type, label: entry.label)
+          scalars << n
+        end
+      end
+
+      [
+        scalars,
+        enums,
+        messages,
+      ]
+    end
+  end
+end

data/lib/fmparser/parser/deep_hash_node.rb

@@ -0,0 +1,34 @@
+module FMParser
+  class Parser
+    class DeepHashNode
+      attr_accessor :is_leaf
+      attr_reader :children
+
+      def initialize
+        @is_leaf  = false
+        @children = {}
+      end
+
+      # @param [String] field
+      # @param [DeepHashNode] n
+      def push_child(field, n)
+        if !field.is_a?(String)
+          raise "Invalid field type: #{field.class}"
+        end
+        @children[field] = n
+      end
+
+      # @param [DeepHashNode] other
+      # @reutrn [bool]
+      def ==(other)
+        is_leaf == other.is_leaf && children == other.children
+      end
+
+      def to_h
+        @children.map do |field, child|
+          [field, child.to_h]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/fmparser/parser/deep_hash_parser.rb

@@ -0,0 +1,55 @@
+require "fmparser/parser/deep_hash_node"
+
+module FMParser
+  class Parser
+    # DeepHashParser parses paths (string array) to a deep hash.
+    # ex.
+    # param: ["id", "facebook_uid", "detail", "detail.id", "profile.name"]
+    # return: <is_leaf: false, children: {
+    #   "id" => <is_leaf: true, children: {}>,
+    #   "facebook_uid" => <is_leaf: true, children: {}>,
+    #   "detail" => <is_leaf: true, children: {
+    #     "id" => <is_leaf: true, children: {}>
+    #   }>,
+    #   "profile" => <is_leaf: false, children: {
+    #     "name" => <is_leaf: true, children: {}>
+    #   }>
+    # }>
+    class DeepHashParser
+      class << self
+        # @param [<String>] paths
+        # @return [DeepHashNode]
+        def parse(paths)
+          node = DeepHashNode.new
+          paths.each do |path|
+            deep_push!(node.children, path.split('.').map(&:strip))
+          end
+          node
+        end
+
+      private
+
+        # @param [Hash] h
+        # @param [<String>] field_list
+        def deep_push!(h, field_list)
+          if field_list.size < 1
+            # Do nothing
+            return
+          end
+
+          f      = field_list.first
+          f_rest = field_list[1..-1]
+
+          if !h[f]
+            h[f] = DeepHashNode.new
+          end
+          if f_rest.size == 0
+            h[f].is_leaf = true
+          end
+
+          deep_push!(h[f].children, f_rest)
+        end
+      end
+    end
+  end
+end

data/lib/fmparser/version.rb

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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: fmparser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !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: google-protobuf
+  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'
+description: FieldMask parameter parser
+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
+- fmparser.gemspec
+- lib/fmparser.rb
+- lib/fmparser/error.rb
+- lib/fmparser/node.rb
+- lib/fmparser/parser.rb
+- lib/fmparser/parser/deep_hash_node.rb
+- lib/fmparser/parser/deep_hash_parser.rb
+- lib/fmparser/version.rb
+homepage: https://github.com/south37/fmparser
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: FieldMask parameter parser
+test_files: []