field_mask_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ceeb1f2018ddb48e63a37be9520164c55fdceec7ec9012648796994e71b21931
+  data.tar.gz: c89c2c36fc1de17edb857ad3f15f9cfe523ffa3c96bfb1a5880999340ac794d6
+SHA512:
+  metadata.gz: a18bb68410e57dfa63e7c066395f336754b512f47f21bf2326eb6b9ae9deaf0f9ca61c77ec4df9bd371d2e2127830269141f452c7b8544254183d4ce1da25dfd
+  data.tar.gz: ff3cd3f80ca759bd79ee890a1f836ea74a50a212ef65fd300b1d6196951f8d4297956843388567984db5ed5cea4c7c0a97a9c456f77504d841cc697fe64fd676

data/.gitignore

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

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

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    field_mask_parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    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)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  bundler (~> 1.16)
+  field_mask_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,85 @@
+# FieldMaskParser
+
+FieldMask parameter 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 'field_mask_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install field_mask_parser
+
+## Usage
+
+`FieldMaskParser.parse` parses FieldMask parameter and returns `FieldMaskParser::Node` object. It requires `paths` string and ActiveRecord class as `root`.
+
+```ruby
+# app/models/user.rb
+
+# == Schema Information
+#
+# Table name: users
+#
+#  id           :integer          not null, primary key
+#
+class User
+  has_one :profile
+end
+```
+
+```ruby
+
+# app/models/profile.rb
+
+# == Schema Information
+#
+# Table name: users
+#
+#  id           :integer          not null, primary key
+#  user_id      :string           not null, indexed
+#  name         :string           not null
+#
+class Profile
+  belongs_to :user
+end
+```
+
+```ruby
+[1] pry> FieldMaskParser.parse(paths: ["id", "profile.name"], root: User).to_h
+=>
+{
+  :name=>nil,
+  :attrs=>[:id],
+  :assocs=>[
+    {
+      :name=>:profile,
+      :attrs=>[:name],
+      :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/field_mask_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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "field_mask_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.
+
+# (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/field_mask_parser.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "field_mask_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "field_mask_parser"
+  spec.version       = FieldMaskParser::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{Parser for field_mask parameter.}
+  spec.description   = %q{Parser for field_mask parameter.}
+  spec.homepage      = "https://github.com/south37/field_mask_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 "activerecord", "~> 5.2"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

data/lib/field_mask_parser/dispatcher/active_record_dispatcher.rb

@@ -0,0 +1,18 @@
+module FieldMaskParser
+  module Dispatcher
+    class ActiveRecordDispatcher < Base
+      # @param [klass] inheriting ActiveRecord::Base
+      # @param [Symbol] name
+      # @return [Dispatcher::Type]
+      def dispatch(klass, name)
+        if klass.attribute_names.include?(name.to_s)
+          Type::ATTRIBUTE
+        elsif klass.reflect_on_association(name)
+          Type::ASSOCIATION
+        else
+          Type::UNKNOWN
+        end
+      end
+    end
+  end
+end

data/lib/field_mask_parser/dispatcher/base.rb

@@ -0,0 +1,12 @@
+module FieldMaskParser
+  module Dispatcher
+    class Base
+      # @param [klass] inheriting ActiveRecord::Base
+      # @param [name]
+      # @return [Dispatcher::Type]
+      def dispatch(klass, name)
+        raise NotImplementedError.new("#{self.class.name}#dispatch is an abstract method.")
+      end
+    end
+  end
+end

data/lib/field_mask_parser/dispatcher/type.rb

@@ -0,0 +1,14 @@
+module FieldMaskParser
+  module Dispatcher
+    class Type
+      # @param [String] type
+      def initialize(type)
+        @type = type
+      end
+
+      ATTRIBUTE   = self.new("Dispatcher::Type::ATTRIBUTE")
+      ASSOCIATION = self.new("Dispatcher::Type::ASSOCIATION")
+      UNKNOWN     = self.new("Dispatcher::Type::UNKNOWN")
+    end
+  end
+end

data/lib/field_mask_parser/dispatcher.rb

@@ -0,0 +1,8 @@
+require 'field_mask_parser/dispatcher/type'
+require 'field_mask_parser/dispatcher/base'
+require 'field_mask_parser/dispatcher/active_record_dispatcher'
+
+module FieldMaskParser
+  module Dispatcher
+  end
+end

data/lib/field_mask_parser/node.rb

@@ -0,0 +1,28 @@
+module FieldMaskParser
+  class Node
+    attr_reader :name, :attrs, :assocs
+
+    # @param [Symbol | NilClass] name nil when being top-level node
+    # @param [<Symbol>] attrs
+    # @param [Set<Node>] assocs
+    def initialize(name:)
+      @name   = name
+      @attrs  = []
+      @assocs = []
+    end
+
+    # @param [Symbol] f
+    def push_attr(f)
+      @attrs.push(f)
+    end
+
+    # @param [Node] n
+    def push_assoc(n)
+      @assocs.push(n)
+    end
+
+    def to_h
+      { name: @name, attrs: @attrs, assocs: @assocs.map(&:to_h) }
+    end
+  end
+end

data/lib/field_mask_parser/parser.rb

@@ -0,0 +1,83 @@
+module FieldMaskParser
+  class Parser
+    # HashBuilder build nested hash from paths (string array).
+    # ex.
+    # param: ["id", "facebook_uid", "detail.id", "detail.email"]
+    # return: {:id=>{}, :facebook_uid=>{}, :detail=>{:id=>{}, :email=>{}}}
+    class HashBuilder
+      class << self
+        # @param [<String>] paths
+        # @return [{ Symbol => Hash }]
+        def build(paths)
+          h = {}
+          paths.each do |path|
+            deep_push!(h, path.split('.').map(&:strip).map(&:to_sym))
+          end
+          h
+        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
+          if !h[f]
+            h[f] = {}
+          end
+          deep_push!(h[f], field_list[1..-1])
+        end
+      end
+    end
+
+    # @param [<String>] paths
+    def initialize(paths:, root:, dispatcher: nil)
+      @attrs_or_assocs = HashBuilder.build(paths)
+      @root            = root
+      @dispatcher      = dispatcher || Dispatcher::ActiveRecordDispatcher.new
+    end
+
+    # @reutrn [Node]
+    def parse
+      r = Node.new(name: nil)
+      set_attrs_and_assocs!(r, @attrs_or_assocs, @root)
+      r
+    end
+
+  private
+
+    # @param [Node] node
+    # @param [Hash] attrs_or_assocs
+    # @param [Class] klass inheriting ActiveRecord::Base
+    def set_attrs_and_assocs!(node, attrs_or_assocs, klass)
+      attrs_or_assocs.each do |name, _attrs_or_assocs|
+        case @dispatcher.dispatch(klass, name)
+        when Dispatcher::Type::ATTRIBUTE
+          node.push_attr(name)
+        when Dispatcher::Type::ASSOCIATION
+          n = Node.new(name: name)
+          node.push_assoc(n)
+          if _attrs_or_assocs.size > 0
+            _klass = get_assoc_klass(klass, name)
+            set_attrs_and_assocs!(n, _attrs_or_assocs, _klass)
+          end
+        when Dispatcher::Type::UNKNOWN
+          # Ignore invalid field
+        else
+          raise "invalid type (#{@dispatcher.dispatch(klass, name)}) with klass (#{klass}) and name (#{name})"
+        end
+      end
+    end
+
+    # @param [Class] parent
+    # @param [Symbol] name
+    # @return [Class]
+    def get_assoc_klass(parent, name)
+      parent.reflect_on_association(name).klass
+    end
+  end
+end

data/lib/field_mask_parser/version.rb

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

data/lib/field_mask_parser.rb

@@ -0,0 +1,14 @@
+require "field_mask_parser/dispatcher"
+require "field_mask_parser/node"
+require "field_mask_parser/parser"
+require "field_mask_parser/version"
+
+module FieldMaskParser
+  class << self
+    # @param [<String>] paths
+    # @return [Node]
+    def parse(paths:, root:, dispatcher: nil)
+      Parser.new(paths: paths, root: root, dispatcher: dispatcher).parse
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: field_mask_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-28 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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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 for field_mask parameter.
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- field_mask_parser.gemspec
+- lib/field_mask_parser.rb
+- lib/field_mask_parser/dispatcher.rb
+- lib/field_mask_parser/dispatcher/active_record_dispatcher.rb
+- lib/field_mask_parser/dispatcher/base.rb
+- lib/field_mask_parser/dispatcher/type.rb
+- lib/field_mask_parser/node.rb
+- lib/field_mask_parser/parser.rb
+- lib/field_mask_parser/version.rb
+homepage: https://github.com/south37/field_mask_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 for field_mask parameter.
+test_files: []