field_masked_model 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 979adcce46c3f04897e9803e28edb1d99cd13f39c8a56379265efe21b0d31644
+  data.tar.gz: 15d382af15602a920594796633d03405cc371d0919e4f7b09c2201c6677fb5ae
+SHA512:
+  metadata.gz: 9d79eb5b69069e03773ffd32eaf056a41f1357487c9605524095e1afd2666076487a1e8b7fc297c9e8a7aa02134c301259964a35764a2f0eb2ed3f9471d826c3
+  data.tar.gz: 19ad31fba8d2f4c3cec3da298c496071d12b2f3f70ff5d59f2447a4eb934bc559c57e46d875f300e36cb132d390e9a7e73c0c09eb14e1773b11dca1b266a36cd

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

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    field_masked_model (0.2.1)
+      fmparser (= 0.1.0)
+      google-protobuf (~> 3.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    fmparser (0.1.0)
+    google-protobuf (3.8.0-universal-darwin)
+    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)
+  field_masked_model!
+  pry (~> 0.11)
+  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,111 @@
+# FieldMaskedModel
+
+FieldMaskedModel provides masked accessor methods to model classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'field_masked_model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install field_masked_model
+
+## Usage
+
+For example, you have .proto file shown below.
+
+```proto
+// proto
+syntax = "proto3";
+package organization.service;
+
+option ruby_package = "UsersPb";
+
+message User {
+  int64 id = 1;
+  string name = 2;
+  int32 age = 3;
+  Profile profile = 4;
+}
+
+message Profile {
+  int64 id = 1;
+  string introduction = 2;
+}
+```
+
+By using `FieldMaskedModel::Base`, you can get model classes with masked accessor methods.
+
+```ruby
+# user.rb
+class User < FieldMaskedModel::Base
+  msgclass UsersPb::User
+end
+
+# profile.rb
+class Profile < FieldMaskedModel::Base
+  msgclass UsersPb::Profile
+end
+```
+
+```ruby
+$ u = User.new(
+*   field_mask: Google::Protobuf::FieldMask.new(
+*     paths: [
+*       "id",
+*       "name",
+*       "profile.id",
+*       "profile.introduction"
+*     ]
+*   ),
+*   message: UsersPb::User.new(
+*     id: 3,
+*     name: "Taro",
+*     profile: UsersPb::Profile.new(
+*       id: 4,
+*       introduction: "My name is Taro"
+*     )
+*   ),
+* )
+=> <User
+ id: 3,
+ name: "Taro",
+ age: -,
+ profile: Profile>
+
+$ u.id
+=> 3
+
+$ u.name
+=> "Taro"
+
+$ u.age
+=> FieldMaskedModel::InaccessibleError: age is not specified as paths in field_mask!
+
+$ u.profile
+=> <Profile
+ id: 4,
+ introduction: "My name is Taro">
+```
+
+## 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_masked_model.
+
+## 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_masked_model"
+
+# 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/examples/main.rb

@@ -0,0 +1,25 @@
+require "field_masked_model"
+require File.join(__dir__, "protos", "lib", "users_pb")
+
+class User < FieldMaskedModel::Base
+  msgclass UsersPb::User
+end
+
+class Profile < FieldMaskedModel::Base
+  msgclass UsersPb::Profile
+end
+
+u = User.new(
+  field_mask: Google::Protobuf::FieldMask.new(paths: ["id", "name", "profile.id", "profile.introduction"]),
+  message:    UsersPb::User.new(id: 3, name: "Taro", profile: UsersPb::Profile.new(id: 4, introduction: "My name is Taro")),
+)
+
+p u
+p u.id
+p u.name
+begin
+  u.age
+rescue => e
+  p e
+end
+p u.profile

data/examples/protos/lib/users_pb.rb

@@ -0,0 +1,24 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: users.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("users.proto", :syntax => :proto3) do
+    add_message "organization.service.User" do
+      optional :id, :int64, 1
+      optional :name, :string, 2
+      optional :age, :int32, 3
+      optional :profile, :message, 4, "organization.service.Profile"
+    end
+    add_message "organization.service.Profile" do
+      optional :id, :int64, 1
+      optional :introduction, :string, 2
+    end
+  end
+end
+
+module UsersPb
+  User = Google::Protobuf::DescriptorPool.generated_pool.lookup("organization.service.User").msgclass
+  Profile = Google::Protobuf::DescriptorPool.generated_pool.lookup("organization.service.Profile").msgclass
+end

data/examples/protos/users.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package organization.service;
+
+option ruby_package = "UsersPb";
+
+message User {
+  int64 id = 1;
+  string name = 2;
+  int32 age = 3;
+  Profile profile = 4;
+}
+
+message Profile {
+  int64 id = 1;
+  string introduction = 2;
+}

data/field_masked_model.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "field_masked_model/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "field_masked_model"
+  spec.version       = FieldMaskedModel::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{FieldMaskedModel provides masked accessor methods to models}
+  spec.description   = %q{FieldMaskedModel provides masked accessor methods to models}
+  spec.homepage      = "https://github.com/south37/field_masked_model"
+  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.11"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_runtime_dependency "fmparser", "0.1.0"
+  spec.add_runtime_dependency "google-protobuf", "~> 3.7"
+end

data/lib/field_masked_model.rb

@@ -0,0 +1,6 @@
+require "field_masked_model/base"
+require "field_masked_model/error"
+require "field_masked_model/version"
+
+module FieldMaskedModel
+end

data/lib/field_masked_model/attribute_converter.rb

@@ -0,0 +1,30 @@
+require "google/protobuf/timestamp_pb"
+
+module FieldMaskedModel
+  module AttributeConverter
+    class << self
+      def convert(value)
+        case value
+        when Google::Protobuf::Timestamp
+          timestamp_to_time(value)
+        else
+          # TODO(south37) Add conversion logic of other classes
+          value
+        end
+      end
+
+      # @param [Google::Protobuf::Timestamp] timestamp
+      # @return [Time, ActiveSupport::TimeWithZone]
+      def timestamp_to_time(timestamp)
+        v = timestamp.nanos * (10 ** -9) + timestamp.seconds
+
+        if Time.respond_to?(:zone) && Time.zone.respond_to?(:at)
+          # Use ActiveSupport::TimeWithZone when it is available.
+          Time.zone.at(v)
+        else
+          Time.at(v)
+        end
+      end
+    end
+  end
+end

data/lib/field_masked_model/base.rb

@@ -0,0 +1,240 @@
+require "fmparser"
+require "google/protobuf"
+require "google/protobuf/field_mask_pb"
+
+require "field_masked_model/attribute_converter"
+require "field_masked_model/model_pool"
+
+module FieldMaskedModel
+  class Base
+    class << self
+      attr_reader :msg, :model_pool, :inaccessible_error_callback
+
+      # @param [Class] klass A class represents the protobuf message class
+      # @param [<Symbol, String>] exclude_fields
+      # @param [FieldMaskedModel::ModelPool] model_pool
+      def msgclass(klass, exclude_fields: [], model_pool: ModelPool.generated_pool)
+        if defined?(@msg)
+          raise "msgclass is already registered!"
+        end
+
+        @model_pool = model_pool
+        @model_pool.add(klass, self)
+
+        exclude_fields.each do |field|
+          exclude_field field
+        end
+
+        @msg = klass
+        define_accessors!
+      end
+
+      # @param [Symbol, String] name
+      def exclude_field(name)
+        if defined?(@msg)
+          Kernel.warn("exclude_field must be called before msgclass", uplevel: 1)
+        end
+        _excluded_fields << name.to_s
+      end
+
+      # @param [Proc] callback
+      def set_inaccessible_error_callback(callback)
+        @inaccessible_error_callback = callback
+      end
+
+      # @return [<Symbol, { Symbol => Array }>]
+      def fields
+        r = []
+        children = {}
+        self.entries.each do |entry|
+          n = entry.name.to_sym
+          type = self.dispatch(entry)
+          case type
+          when :attribute
+            r << n
+          when :association
+            modelclass = @model_pool.lookup(entry.subtype.msgclass)
+            children[n] = modelclass.fields
+          when :repeated_association
+            modelclass = @model_pool.lookup(entry.subtype.msgclass)
+            children[n] = modelclass.fields
+          end
+        end
+        r << children if children.size > 0
+        r
+      end
+
+      # @return [<Google::Protobuf::FieldDescriptor>]
+      def entries
+        @msg.descriptor.entries.select do |e|
+          !_excluded_fields.include?(e.name)
+        end
+      end
+
+      # @param [Google::Protobuf::FieldDescriptor] entry
+      # @return [Symbol]
+      def dispatch(entry)
+        case entry.type
+        when :message
+          m = @model_pool.lookup(entry.subtype.msgclass)
+          # NOTE: If msgclass is not registered in ModelPool, we treat it
+          # as a one of attribute classes.
+          if m.nil?
+            return :attribute
+          end
+
+          case entry.label
+          when :repeated
+            :repeated_association
+          else
+            :association
+          end
+        else # eum or scalar
+          :attribute
+        end
+      end
+
+     private
+
+      def define_accessors!
+        self.entries.each do |entry|
+          n = entry.name.to_sym
+          define_accessor!(name: n, entry: entry)
+        end
+      end
+
+      def define_accessor!(name:, entry:)
+        define_method(name) do
+          validate!(name)
+
+          ivar = :"@_#{name}"
+          if instance_variable_defined?(ivar)
+            next instance_variable_get(ivar)
+          end
+
+          v = @message.send(name)
+          type = self.class.dispatch(entry)
+          r =
+            case type
+            when :attribute
+              AttributeConverter.convert(v)
+            when :association
+              if v.nil?
+                nil
+              else
+                modelclass = self.class.model_pool.lookup(entry.subtype.msgclass)
+                modelclass.new(field_mask_node: @fm_node.get_child(name), message: v)
+              end
+            when :repeated_association
+              modelclass = self.class.model_pool.lookup(entry.subtype.msgclass)
+              v.map do |vv|
+                if vv.nil?
+                  nil
+                else
+                  modelclass.new(field_mask_node: @fm_node.get_child(name), message: vv)
+                end
+              end
+            end
+
+          instance_variable_set(ivar, r)
+        end
+      end
+
+      def _excluded_fields
+        @_excluded_fields ||= Set.new
+      end
+    end
+
+    # @param [Google::Protobuf::FieldMask, nil] field_mask_node
+    # @param [FMParser::MessageNode, nil] field_mask_node
+    # @param [Object] message represents the protobuf message object
+    def initialize(field_mask: nil, field_mask_node: nil, message:)
+      if field_mask.nil? && field_mask_node.nil?
+        raise ArgumentError.new("missing keyword: field_mask or field_mask_node")
+      end
+      @fm_node = field_mask_node || FMParser.parse(paths: field_mask.paths, root: self.class.msg)
+      @message = message
+
+      @accessible_fields ||= Set.new(@fm_node.field_names)
+    end
+
+    # @return [Hash]
+    def to_h
+      r = {}
+      self.class.entries.each do |entry|
+        n = entry.name.to_sym
+        next if !@accessible_fields.include?(n)
+
+        v = self.send(n)
+        type = self.class.dispatch(entry)
+        case type
+        when :attribute
+          r[n] = v
+        when :association
+          if v.nil?
+            r[n] = nil
+          else
+            r[n] = v.to_h
+          end
+        when :repeated_association
+          r[n] = v.map(&:to_h)
+        end
+      end
+      r
+    end
+
+    # @return [String]
+    def inspect
+      h = {}
+      self.class.entries.each do |entry|
+        n = entry.name.to_sym
+        if !@accessible_fields.include?(n)
+          h[n] = "-"
+          next
+        end
+
+        v = self.send(n)
+        type = self.class.dispatch(entry)
+        case type
+        when :attribute
+          case v
+          when NilClass
+            h[n] = "nil"
+          when String
+            h[n] = "\"#{v}\""
+          else
+            h[n] = v
+          end
+        when :association
+          case v
+          when NilClass
+            h[n] = "nil"
+          else
+            h[n] = v.class.name.split("::").last
+          end
+        when :repeated_association
+          if v.size > 0
+            h[n] = "[#{v[0].class.name.split("::").last}]"
+          else
+            h[n] = "[]"
+          end
+        end
+      end
+      "<#{self.class.name}#{h.map { |k, v| "\n #{k}: #{v}" }.join(',')}>"
+    end
+
+  private
+
+    # @param [Symbol] field
+    # @raise [FieldMaskedModel::InaccessibleError]
+    def validate!(field)
+      if !@accessible_fields.include?(field)
+        if self.class.inaccessible_error_callback
+          self.class.inaccessible_error_callback.call(field)
+        else
+          raise FieldMaskedModel::InaccessibleError.new("`#{field}` is not specified as paths in field_mask!")
+        end
+      end
+    end
+  end
+end

data/lib/field_masked_model/error.rb

@@ -0,0 +1,4 @@
+module FieldMaskedModel
+  class Error < StandardError; end
+  class InaccessibleError < Error; end
+end

data/lib/field_masked_model/model_pool.rb

@@ -0,0 +1,25 @@
+module FieldMaskedModel
+  class ModelPool
+    class << self
+      def generated_pool
+        @generated_pool ||= self.new
+      end
+    end
+
+    def initialize
+      @table = {}
+    end
+
+    # @param [Class] msgclass A class represents the protobuf message class
+    # @return [Class] A class inheriting Models::Base
+    def lookup(msgclass)
+      @table[msgclass]
+    end
+
+    # @param [Class] msgclass A class represents the protobuf message class
+    # @param [Class] modelclass A class inheriting Models::Base
+    def add(msgclass, modelclass)
+      @table[msgclass] = modelclass
+    end
+  end
+end

data/lib/field_masked_model/version.rb

@@ -0,0 +1,3 @@
+module FieldMaskedModel
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: field_masked_model
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-24 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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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: fmparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: FieldMaskedModel provides masked accessor methods to models
+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
+- examples/main.rb
+- examples/protos/lib/users_pb.rb
+- examples/protos/users.proto
+- field_masked_model.gemspec
+- lib/field_masked_model.rb
+- lib/field_masked_model/attribute_converter.rb
+- lib/field_masked_model/base.rb
+- lib/field_masked_model/error.rb
+- lib/field_masked_model/model_pool.rb
+- lib/field_masked_model/version.rb
+homepage: https://github.com/south37/field_masked_model
+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: FieldMaskedModel provides masked accessor methods to models
+test_files: []