protobuf-activerecord 6.1.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec09901cba008bbf89ef4ea81401c104661359dc974a8aa4b8413da0e2744c6d
-  data.tar.gz: 6665b1360ce3d1df807a0322af6e87e2bac403157b168149395659d955b7c1a9
+  metadata.gz: 7bc4240e3a09e5096128e31fa18dbd04aae1f3a053e1b77928a446c74ffa97c9
+  data.tar.gz: 1f27900848c3d25372398cf6faa872056f528ec2c871cf8cc1e9da460cc0b895
 SHA512:
-  metadata.gz: 7f4269f4137ee3aea4be82a6cac317e60a379f2e346eb503148434b9642a7d8e903b83d23a4cad92344d36f6efbd77c5b088363079904712c70516946e93202d
-  data.tar.gz: b611acfd204df5d73772ce5d95b6b19afe4a301456f426693aa7467fc791b7c48d6c7e1d04a9c5b80431426f819b9a5c7ff3ac19f09807244877c9fc4a922a70
+  metadata.gz: b72e52b18db91e69b455418fe3063cd073b988b89832077cba73fc6fce72e860cd4b5e8f3034e1276ef495669a1b2128060457416719b69301e928cf56106214
+  data.tar.gz: d299f498ef5d6cea450d0e4e0bbfdb48c4d755f6edfd9536b3f6823823817921a9db70c000b07e1a5ee283e489800c49a118c550ac9047d2443351e992f1cc3c

data/.rubocop.yml

@@ -1,28 +1,3 @@
-# Styles are inherited from Mad Rubocop
-
+---
 inherit_gem:
-  mad_rubocop: .rubocop.yml
-
-# Styles that are modified from the defaults
-AllCops:
-  TargetRubyVersion: 2.5
-  Exclude:
-    - "**/*.pb.rb"
-
-Style/BlockDelimiters:
-  Description: >-
-                Avoid using {...} for multi-line blocks (multiline chaining is always ugly).
-                Prefer {...} over do...end for single-line blocks.
-  Exclude:
-    - "spec/**/*"
-
-Style/HashSyntax:
-  Description: >-
-                 Prefer Ruby 1.8 hash syntax { :a => 1, :b => 2 } over 1.9 syntax { a: 1, b: 2 }.
-  EnforcedStyle: hash_rockets
-  Exclude:
-    - "Gemfile"
-
-Layout/SpaceAroundOperators:
-  Exclude:
-    - "*.gemspec"
+  standard: config/ruby-2.7.yml

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+format: progress # default: Standard::Formatter

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+Protobuf Active Record adheres to a shifted version of [semver](https://semver.org/spec/v2.0.0.html)
+(a la Rails): major/minor versions shadow Rails [versions](https://guides.rubyonrails.org/maintenance_policy.html#versioning)
+since it depends on specific Rails versions.
+
+## [Unreleased]
+
+## [7.0.0] – 2024-03-03
+
+- Added Rails 7.0 support

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2012 Adam Hutchison
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2024 Adam Hutchison
 
-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:
+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 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.
+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

@@ -1,5 +1,6 @@
+[![Build](https://github.com/liveh2o/protobuf-activerecord/actions/workflows/main.yml/badge.svg)](https://github.com/liveh2o/protobuf-activerecord/actions)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
 [![Gem Version](https://badge.fury.io/rb/protobuf-activerecord.svg)](http://badge.fury.io/rb/protobuf-activerecord)
-[![Build Status](https://travis-ci.org/liveh2o/protobuf-activerecord.svg?branch=master)](https://travis-ci.org/liveh2o/protobuf-activerecord)
 
 # Protobuf ActiveRecord
 
@@ -170,11 +171,12 @@ end
 
 ### Setting attributes to nil
 
-The protocol buffers specification does not allow for the transport of 'null' or 'nil' values for a field.  In fact, in order to keep messages small and lightweight this is desireable behavior.  Fields are that are not set to a value will not be sent over the wire, but we cannot assume given a message has an absent value for a field that we should set the our attributes to nil.
+The protocol buffers specification does not allow for the transport of 'null' or 'nil' values for a field. In fact, in order to keep messages small and lightweight this is desireable behavior. Fields are that are not set to a value will not be sent over the wire, but we cannot assume given a message has an absent value for a field that we should set the our attributes to nil.
 
-In order to solve this problem, Protobuf::ActiveRecord has a convention that tells it when to set an attribute to nil.  A message must define a repeated string field named 'nullify'.  If an attribute has the same name as an element in the 'nullify' field, this attribute will be set to nil.
+In order to solve this problem, Protobuf::ActiveRecord has a convention that tells it when to set an attribute to nil. A message must define a repeated string field named 'nullify'. If an attribute has the same name as an element in the 'nullify' field, this attribute will be set to nil.
 
 Example:
+
 ```
 message UserMessage {
   optional string name = 1;
@@ -182,14 +184,16 @@ message UserMessage {
 }
 
 ```
+
 ```ruby
 m = UserMessage.new(:nullify => [:name])
 # When Protobuf::ActiveRecord maps this message, it will set the name attribute to nil overwriting any value that is set.
 ```
 
-For attribute transformers, the field name will not match the attribute name so we need to give the attribute transformer a hint to instruct it on how to nullify a given attribute.  When declaring an attribute transformer, you can specify a :nullify_on option.  This indicates for the given attribute, if the value of 'nullify_on' is present in the nullify field, set this attribute to nil.
+For attribute transformers, the field name will not match the attribute name so we need to give the attribute transformer a hint to instruct it on how to nullify a given attribute. When declaring an attribute transformer, you can specify a :nullify_on option. This indicates for the given attribute, if the value of 'nullify_on' is present in the nullify field, set this attribute to nil.
 
 Example:
+
 ```Ruby
 class User < ActiveRecord::Base
   # When 'account_guid' is present in the nullify array, our 'account_id' attribute will be set to nil

data/Rakefile

@@ -1,24 +1,28 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require "protobuf/tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
 
-desc "Run cops"
-::RuboCop::RakeTask.new(:rubocop)
+require "rspec/core/rake_task"
 
 desc "Run specs"
-::RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w[-w]
+end
+
+require "standard/rake"
 
 desc "Run cops and specs (default)"
-task :default => [:rubocop, :spec]
+task default: %i[spec standard:fix]
 
 desc "Remove protobuf definitions that have been compiled"
 task :clean do
-  ::FileUtils.rm(Dir.glob("spec/support/protobuf/**/*.proto"))
+  FileUtils.rm(Dir.glob("spec/support/protobuf/**/*.proto"))
   puts "Cleaned"
 end
 
+require "protobuf/tasks"
+
 desc "Compile spec/support protobuf definitions"
 task :compile, [] => :clean do
-  ::Rake::Task["protobuf:compile"].invoke("", "spec/support/definitions", "spec/support/protobuf")
+  Rake::Task["protobuf:compile"].invoke("", "spec/support/definitions", "spec/support/protobuf")
 end

data/lib/protobuf/active_record/attribute_methods.rb

@@ -18,7 +18,7 @@ module Protobuf
             value = proto.__send__(:"#{field_alias}!")
             value ||= proto.__send__(:"#{attribute}!") if proto.respond_to?(attribute)
 
-            self._protobuf_convert_fields_to_attributes(attribute, value)
+            _protobuf_convert_fields_to_attributes(attribute, value)
           end
         end
 
@@ -26,7 +26,7 @@ module Protobuf
           lambda do |record|
             value = record.__send__(field_alias)
 
-            self._protobuf_convert_attributes_to_fields(attribute, value)
+            _protobuf_convert_attributes_to_fields(attribute, value)
           end
         end
       end

data/lib/protobuf/active_record/columns.rb

@@ -1,6 +1,4 @@
-require "set"
 require "active_support/concern"
-require "thread"
 
 module Protobuf
   module ActiveRecord
@@ -14,9 +12,9 @@ module Protobuf
         include ::Heredity
 
         inheritable_attributes :_protobuf_columns,
-                               :_protobuf_column_types,
-                               :_protobuf_date_datetime_time_or_timestamp_column,
-                               :_protobuf_mapped_columns
+          :_protobuf_column_types,
+          :_protobuf_date_datetime_time_or_timestamp_column,
+          :_protobuf_mapped_columns
       end
 
       module ClassMethods

data/lib/protobuf/active_record/middleware/connection_management_async.rb

@@ -1,5 +1,4 @@
 require "concurrent"
-require "thread"
 
 module Protobuf
   module ActiveRecord
@@ -13,8 +12,8 @@ module Protobuf
               return if timed_task_started.true?
 
               args = {
-                :execution_interval => ::Protobuf::ActiveRecord.config.connection_reaping_interval,
-                :timeout_interval => ::Protobuf::ActiveRecord.config.connection_reaping_timeout_interval
+                execution_interval: ::Protobuf::ActiveRecord.config.connection_reaping_interval,
+                timeout_interval: ::Protobuf::ActiveRecord.config.connection_reaping_timeout_interval
               }
               timed_task = ::Concurrent::TimerTask.new(args) do
                 ::ActiveRecord::Base.clear_active_connections!

data/lib/protobuf/active_record/middleware/query_cache.rb

@@ -1,5 +1,3 @@
-require "thread"
-
 module Protobuf
   module ActiveRecord
     module Middleware
@@ -20,7 +18,7 @@ module Protobuf
           restore_query_cache_settings(enabled)
         end
 
-      private
+        private
 
         def restore_query_cache_settings(enabled)
           ::Thread.current[CURRENT_CONNECTION].clear_query_cache

data/lib/protobuf/active_record/nested_attributes.rb

@@ -37,7 +37,7 @@ module Protobuf
           end
         end
 
-        super(association_name, attributes_collection)
+        super
       end
 
       # :nodoc:
@@ -47,7 +47,7 @@ module Protobuf
           attributes = reflection.klass.attributes_from_proto(attributes)
         end
 
-        super(association_name, attributes)
+        super
       end
     end
   end

data/lib/protobuf/active_record/persistence.rb

@@ -10,14 +10,14 @@ module Protobuf
         def create(attributes = {}, &block)
           attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
-          super(attributes, &block)
+          super
         end
 
         # :nodoc:
         def create!(attributes = {}, &block)
           attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
-          super(attributes, &block)
+          super
         end
       end
 
@@ -27,28 +27,28 @@ module Protobuf
       def initialize(*args, &block)
         args[0] = attributes_from_proto(args.first) if args.first.is_a?(::Protobuf::Message)
 
-        super(*args, &block)
+        super
       end
 
       # :nodoc:
       def assign_attributes(attributes)
         attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
-        super(attributes)
+        super
       end
 
       # :nodoc:
       def update(attributes)
         attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
-        super(attributes)
+        super
       end
 
       # :nodoc:
       def update!(attributes)
         attributes = attributes_from_proto(attributes) if attributes.is_a?(::Protobuf::Message)
 
-        super(attributes)
+        super
       end
     end
   end

data/lib/protobuf/active_record/scope.rb

@@ -42,11 +42,11 @@ module Protobuf
         #
         def field_scope(field, options = {})
           scope_name = if options.include?(:scope)
-                         options[:scope]
-                       else
-                         # When no scope is defined, assume the scope is the field, prefixed with `by_`
-                         :"by_#{field}"
-                       end
+            options[:scope]
+          else
+            # When no scope is defined, assume the scope is the field, prefixed with `by_`
+            :"by_#{field}"
+          end
           searchable_fields[field] = scope_name
 
           searchable_field_parsers[field] = options[:parser] if options[:parser]
@@ -56,7 +56,7 @@ module Protobuf
         # use `all` instead of `scoped`.
         # :noapi:
         def model_scope
-          ::ActiveRecord::VERSION::MAJOR >= 4 ? all : scoped
+          (::ActiveRecord::VERSION::MAJOR >= 4) ? all : scoped
         end
 
         # :noapi:
@@ -66,10 +66,10 @@ module Protobuf
           if searchable_field_parsers[field]
             parser = searchable_field_parsers[field]
 
-            if parser.respond_to?(:to_sym)
-              value = self.__send__(parser.to_sym, value)
+            value = if parser.respond_to?(:to_sym)
+              __send__(parser.to_sym, value)
             else
-              value = parser.call(value)
+              parser.call(value)
             end
           end
 
@@ -99,7 +99,7 @@ module Protobuf
             search_relation = search_relation.__send__(scope_name, *search_values)
           end
 
-          return search_relation
+          search_relation
         end
 
         # :noapi:

data/lib/protobuf/active_record/serialization.rb

@@ -1,4 +1,3 @@
-require "set"
 require "active_support/concern"
 
 module Protobuf
@@ -9,9 +8,9 @@ module Protobuf
       included do
         class << self
           attr_writer :_protobuf_field_symbol_transformers,
-                      :_protobuf_field_transformers,
-                      :_protobuf_field_options,
-                      :protobuf_message
+            :_protobuf_field_transformers,
+            :_protobuf_field_options,
+            :protobuf_message
         end
       end
 
@@ -33,24 +32,20 @@ module Protobuf
         end
 
         def _protobuf_message_deprecated_fields
-          @_protobuf_message_deprecated_fields ||= begin
-            self.protobuf_message.all_fields.map do |field|
-              next if field.nil?
-              next unless field.deprecated?
+          @_protobuf_message_deprecated_fields ||= protobuf_message.all_fields.map do |field|
+            next if field.nil?
+            next unless field.deprecated?
 
-              field.name.to_sym
-            end
+            field.name.to_sym
           end
         end
 
         def _protobuf_message_non_deprecated_fields
-          @_protobuf_message_non_deprecated_fields ||= begin
-            self.protobuf_message.all_fields.map do |field|
-              next if field.nil?
-              next if field.deprecated?
+          @_protobuf_message_non_deprecated_fields ||= protobuf_message.all_fields.map do |field|
+            next if field.nil?
+            next if field.deprecated?
 
-              field.name.to_sym
-            end
+            field.name.to_sym
           end
         end
 
@@ -147,7 +142,7 @@ module Protobuf
           def call(selph)
             selph.__send__(@method_name).to_a
           rescue NameError # Has happened when field is not on model or ignored from db
-            return nil
+            nil
           end
         end
 
@@ -167,7 +162,7 @@ module Protobuf
               value.to_time(:utc).to_i
             end
           rescue NameError # Has happened when field is not on model or ignored from db
-            return nil
+            nil
           end
         end
 
@@ -181,7 +176,7 @@ module Protobuf
 
             value&.to_i
           rescue NameError # Has happened when field is not on model or ignored from db
-            return nil
+            nil
           end
         end
 
@@ -193,7 +188,7 @@ module Protobuf
           def call(selph)
             selph.__send__(@field)
           rescue NameError # Has happened when field is not on model or ignored from db
-            return nil
+            nil
           end
         end
 
@@ -325,21 +320,21 @@ module Protobuf
 
       # :nodoc:
       def _protobuf_field_objects(field)
-        self.class._protobuf_field_objects[field] ||= begin
-          case
-          when _protobuf_field_symbol_transformers.key?(field) then
-            self.class._protobuf_symbol_transformer_object(field)
-          when _protobuf_field_transformers.key?(field) then
-            self.class._protobuf_field_transformer_object(field)
-          when respond_to?(field) then
-            if _is_collection_association?(field)
-              self.class._protobuf_collection_association_object(field)
-            else
-              self.class._protobuf_convert_to_fields_object(field)
-            end
+        self.class._protobuf_field_objects[field] ||= if _protobuf_field_symbol_transformers.key?(field)
+
+          self.class._protobuf_symbol_transformer_object(field)
+        elsif _protobuf_field_transformers.key?(field)
+
+          self.class._protobuf_field_transformer_object(field)
+        elsif respond_to?(field)
+
+          if _is_collection_association?(field)
+            self.class._protobuf_collection_association_object(field)
           else
-            self.class._protobuf_nil_object(field)
+            self.class._protobuf_convert_to_fields_object(field)
           end
+        else
+          self.class._protobuf_nil_object(field)
         end
       end
 
@@ -362,7 +357,7 @@ module Protobuf
       def to_proto(options = {})
         raise MessageNotDefined, self.class if _protobuf_message.nil?
 
-        fields = self.fields_from_record(options)
+        fields = fields_from_record(options)
         _protobuf_message.new(fields)
       end
     end