deimos-ruby 1.16.3 → 1.16.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ee238a0bcc822c984f19d5a58d1bea52025407d931654371831b0104fcb5aed
-  data.tar.gz: 5b767073027dae54910c69be504ac2da023d540557ef592417f1f60254f9e3f3
+  metadata.gz: 021fca59477fbfa890fa77ae867cd3a006b65e2c0235d1bb47ccdd1780e51d9c
+  data.tar.gz: 8330ba3d8f90567c7abbfd91298dd04d80f9507f702a0d4ac45300f68e5d224a
 SHA512:
-  metadata.gz: 904066c010866aaa6ca1173bbdf4e4044c578ac28df8a0ebcf846c25c73cd484fbeb15dea827c3b64935a8f7588f4a62b65d1bdf6f28604d0f1e588cdb8cb15a
-  data.tar.gz: 3cec3d2ae05d855fb9835252646b6cdef16034f600b0c1b7ed169fc8b7969bb0d6a9847fd5b35092e29ca910daa91cad6b3d838425a3b577dc484d7937af1339
+  metadata.gz: ab861eb37e8590664f47e0e11082ed5aac344a730c009c5261edcbdcbfcd00a39bc8e1f44bf2be5c05b1eb587ba15ad32e77edfd80ca0789da05049c91dd20e9
+  data.tar.gz: 851b9b844d11be5d90d3b4e652a648e7ce1e8e90e1ddd96f25a34d690cb89e2503302a80ad9cb891cbaa30949a0394e68337b34de86cf848a6815730d1548ca0

data/.github/workflows/ci.yml

@@ -25,18 +25,18 @@ jobs:
           ruby-version: 2.7
           bundler-cache: true
 
+      - name: Bundle install
+        run: bundle install --with development
+
       - name: Rubocop
         run: bundle exec rubocop --format progress
 
   build:
     runs-on: ubuntu-latest
-    env:
-      BUNDLE_GEMFILE: ${{ github.workspace }}/.gemfiles/${{ matrix.gemfile }}.gemfile
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.7', '3.0', '3.1' ]
-        gemfile: [ 'avro_turf-0', 'avro_turf-1' ]
 
     steps:
       - uses: actions/checkout@v2

data/.gitignore

@@ -40,3 +40,4 @@ Gemfile.lock
 test.sqlite3
 
 .idea
+/.gem_rbs_collection/

data/.rubocop.yml

@@ -1,7 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   Exclude:
     - lib/deimos/monkey_patches/*.rb
     - vendor/**/*
@@ -39,8 +41,9 @@ Layout/EmptyLinesAroundBlockBody:
 Layout/LineLength:
   Max: 120
   Severity: refactor
-  Exclude:
-  - 'spec/**/*'
+#  TODO: uncomment the files below once rubocop is fixed
+#  Exclude:
+#  - 'spec/**/*'
 
 # foo = if expression
 #         'bar'
@@ -149,18 +152,20 @@ Style/CollectionMethods:
 Style/DateTime:
   AllowCoercion: true
 
-Style/Documentation:
-  Exclude:
-  - 'app/controllers/**/*'
-  - 'app/helpers/**/*'
-  - 'db/**/*'
+# TODO: uncomment the lines below once rubocop is fixed
+#Style/Documentation:
+#  Exclude:
+#  - 'app/controllers/**/*'
+#  - 'app/helpers/**/*'
+#  - 'db/**/*'
 
 # Force documentation for public methods and classes
 Style/DocumentationMethod:
   Enabled: true
-  Exclude:
-  - 'app/controllers/**/*'
-  - 'db/**/*'
+# TODO: uncomment the file below once rubocop is fixed
+#  Exclude:
+#  - 'app/controllers/**/*'
+#  - 'db/**/*'
 
 # Allow else with just nil in it
 Style/EmptyElse:
@@ -231,9 +236,10 @@ Style/MethodCallWithArgsParentheses:
     - before_destroy
     - after_destroy
     - queue_as
-  Exclude:
-    - 'bin/**/*'
-    - 'Gemfile'
+# TODO: uncomment the file below once rubocop is fixed
+#  Exclude:
+#    - 'bin/**/*'
+#    - 'Gemfile'
 
 # Do not allow "end.something"
 Style/MethodCalledOnDoEndBlock:

data/.rubocop_todo.yml

@@ -0,0 +1,364 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude`
+# on 2022-09-08 19:46:52 UTC using RuboCop version 0.90.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'deimos-ruby.gemspec'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'spec/schemas/my_namespace/generated.rb'
+    - 'spec/schemas/my_namespace/my_nested_schema.rb'
+    - 'spec/schemas/my_namespace/my_schema_with_circular_reference.rb'
+    - 'spec/schemas/my_namespace/my_schema_with_complex_type.rb'
+
+# Offense count: 32
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'lib/generators/deimos/schema_class_generator.rb'
+
+# Offense count: 42
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_braces
+Layout/FirstHashElementIndentation:
+  Exclude:
+    - 'spec/producer_spec.rb'
+
+# Offense count: 19
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'spec/consumer_spec.rb'
+    - 'spec/generators/schema_class/my_schema_with_circular_reference_spec.rb'
+
+# Offense count: 21
+# Cop supports --auto-correct.
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'spec/generators/schema_class/my_schema_with_circular_reference_spec.rb'
+    - 'spec/generators/schema_class_generator_spec.rb'
+    - 'spec/schemas/my_namespace/my_schema_with_complex_type.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'spec/generators/schema_class_generator_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'spec/active_record_producer_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceInsideParens:
+  Exclude:
+    - 'lib/deimos.rb'
+
+# Offense count: 23
+# Cop supports --auto-correct.
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'spec/schemas/my_namespace/generated.rb'
+    - 'spec/schemas/my_namespace/my_nested_schema.rb'
+    - 'spec/schemas/my_namespace/my_schema_with_circular_reference.rb'
+    - 'spec/schemas/my_namespace/my_schema_with_complex_type.rb'
+
+# Offense count: 5
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/deimos/active_record_consumer.rb'
+    - 'lib/deimos/metrics/datadog.rb'
+    - 'lib/deimos/schema_class/enum.rb'
+    - 'lib/deimos/tracing/datadog.rb'
+    - 'lib/deimos/tracing/mock.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/deimos/tracing/mock.rb'
+    - 'spec/schemas/my_namespace/my_schema_with_circular_reference.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'spec/generators/schema_class_generator_spec.rb'
+
+# Offense count: 19
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/deimos/active_record_consume/message_consumption.rb'
+    - 'lib/deimos/config/phobos_config.rb'
+    - 'lib/deimos/instrumentation.rb'
+    - 'lib/deimos/kafka_source.rb'
+    - 'lib/deimos/kafka_topic_info.rb'
+    - 'lib/deimos/producer.rb'
+    - 'lib/deimos/schema_backends/avro_schema_coercer.rb'
+    - 'lib/deimos/test_helpers.rb'
+    - 'lib/deimos/utils/db_poller.rb'
+    - 'lib/deimos/utils/db_producer.rb'
+    - 'lib/deimos/utils/inline_consumer.rb'
+    - 'lib/deimos/utils/schema_controller_mixin.rb'
+    - 'lib/generators/deimos/schema_class_generator.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/deimos/config/phobos_config.rb'
+
+# Offense count: 5
+# Configuration parameters: CountComments, Max, CountAsOne.
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/deimos/test_helpers.rb'
+    - 'spec/active_record_batch_consumer_spec.rb'
+    - 'spec/batch_consumer_spec.rb'
+    - 'spec/kafka_source_spec.rb'
+    - 'spec/producer_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/deimos/config/phobos_config.rb'
+    - 'lib/deimos/consume/batch_consumption.rb'
+    - 'lib/deimos/kafka_source.rb'
+    - 'lib/deimos/schema_backends/avro_schema_coercer.rb'
+    - 'lib/deimos/test_helpers.rb'
+
+# Offense count: 12
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/generators/schema_class_generator_spec.rb'
+
+# Offense count: 4
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/config/configuration_spec.rb'
+    - 'spec/utils/db_producer_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: Max.
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/active_record_consumer_spec.rb'
+    - 'spec/config/configuration_spec.rb'
+    - 'spec/kafka_topic_info_spec.rb'
+    - 'spec/utils/db_poller_spec.rb'
+    - 'spec/utils/db_producer_spec.rb'
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'regenerate_test_schema_classes.rb'
+
+# Offense count: 1
+# Configuration parameters: RequireForNonPublicMethods.
+Style/DocumentationMethod:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'regenerate_test_schema_classes.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: compact, expanded
+Style/EmptyMethod:
+  Exclude:
+    - 'regenerate_test_schema_classes.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExplicitBlockArgument:
+  Exclude:
+    - 'lib/deimos/metrics/datadog.rb'
+    - 'lib/deimos/utils/deadlock_retry.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'regenerate_test_schema_classes.rb'
+    - 'spec/generators/schema_class/my_schema_spec.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+Style/GlobalStdStream:
+  Exclude:
+    - 'lib/deimos/config/configuration.rb'
+    - 'lib/deimos/config/phobos_config.rb'
+    - 'lib/deimos/metrics/mock.rb'
+    - 'lib/deimos/test_helpers.rb'
+    - 'lib/deimos/tracing/mock.rb'
+    - 'lib/deimos/utils/db_producer.rb'
+    - 'lib/tasks/deimos.rake'
+    - 'spec/rake_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/HashEachMethods:
+  Exclude:
+    - 'lib/generators/deimos/schema_class_generator.rb'
+
+# Offense count: 31
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreMacros, IgnoredMethods, IgnoredPatterns, IncludedMacros, AllowParenthesesInMultilineCall, AllowParenthesesInChaining, AllowParenthesesInCamelCaseMethod, EnforcedStyle.
+# SupportedStyles: require_parentheses, omit_parentheses
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - 'lib/deimos/utils/db_poller.rb'
+    - 'lib/deimos/utils/inline_consumer.rb'
+    - 'spec/config/configuration_spec.rb'
+    - 'spec/deimos_spec.rb'
+    - 'spec/generators/schema_class_generator_spec.rb'
+
+# Offense count: 1
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/deimos/test_helpers.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantAssignment:
+  Exclude:
+    - 'spec/schemas/my_namespace/my_schema_with_circular_reference.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/deimos.rb'
+    - 'lib/deimos/utils/db_producer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SingleArgumentDig:
+  Exclude:
+    - 'lib/deimos/active_record_consume/batch_slicer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowIfMethodIsEmpty.
+Style/SingleLineMethods:
+  Exclude:
+    - 'regenerate_test_schema_classes.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Style/StringConcatenation:
+  Exclude:
+    - 'spec/producer_spec.rb'
+    - 'spec/utils/schema_controller_mixin_spec.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/generators/deimos/schema_class_generator.rb'
+    - 'lib/tasks/deimos.rake'
+    - 'regenerate_test_schema_classes.rb'
+    - 'spec/schemas/my_namespace/my_schema_with_complex_type.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
+# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
+Style/TernaryParentheses:
+  Exclude:
+    - 'lib/deimos/config/phobos_config.rb'
+
+# Offense count: 21
+# Cop supports --auto-correct.
+Style/TrailingBodyOnModule:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'spec/config/configuration_spec.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/deimos/producer.rb'
+    - 'lib/deimos/utils/db_poller.rb'
+    - 'lib/deimos/utils/db_producer.rb'
+    - 'spec/active_record_batch_consumer_spec.rb'
+    - 'spec/generators/schema_class/my_schema_with_circular_reference_spec.rb'
+    - 'spec/generators/schema_class/my_schema_with_complex_types_spec.rb'

data/.ruby-version

@@ -1 +1,2 @@
-2.5.3
+3.1.0
+

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.16.5 - 2022-09-30
+
+- Fix the linting step in the CI
+
+# 1.16.4 - 2022-09-09
+
+- Now generates RBS types.
+- Use `allocate` instead of `new` in `tombstone` to avoid issues with required fields in `initialize`.
+
 # 1.16.3 - 2022-09-08
 
 - Add the `tombstone` method to schema classes.

data/Gemfile

@@ -4,3 +4,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in boilerplate.gemspec
 gemspec
+
+if !ENV['CI'] || ENV['CI'] == ''
+  # TODO: once all PRs are merged, add this to gemspec as a development dependency
+  gem 'sord', git: 'git@github.com:dorner/sord.git', ref: 'local-develop'
+end
+

data/README.md

@@ -1198,10 +1198,16 @@ decoded = Deimos.decode(schema: 'MySchema', namespace: 'com.my-namespace', paylo
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-oss/deimos .
 
+You can/should re-generate RBS types when methods or classes change by running the following:
+
+    rbs collection install # if you haven't done it 
+    rbs collection update
+    bundle exec sord --hide-private --no-sord-comments sig/defs.rbs --tags 'override:Override'
+
 ### Linting
 
 Deimos uses Rubocop to lint the code. Please run Rubocop on your code 
-before submitting a PR.
+before submitting a PR. The GitHub CI will also run rubocop on your pull request.
 
 ---
 <p align="center">

data/Steepfile

@@ -0,0 +1,6 @@
+target :app do
+  check "lib"
+  signature "sig"
+
+  library "set", "pathname"
+end

data/deimos-ruby.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency('avro_turf', '>= 0.11', '< 2')
+  spec.add_runtime_dependency('avro_turf', '>= 1.4', '< 2')
+  spec.add_runtime_dependency('fig_tree', '~> 0.0.2')
   spec.add_runtime_dependency('phobos', '>= 1.9', '< 3.0')
   spec.add_runtime_dependency('ruby-kafka', '< 2')
   spec.add_runtime_dependency('sigurd', '>= 0.1.0', '< 1.0')
-  spec.add_runtime_dependency('fig_tree', '~> 0.0.2')
 
   spec.add_development_dependency('activerecord-import')
   spec.add_development_dependency('avro', '~> 1.9')
@@ -43,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('rubocop', '0.89.0')
   spec.add_development_dependency('rubocop-rspec', '1.42.0')
   spec.add_development_dependency('sqlite3', '~> 1.3')
+  spec.add_development_dependency('steep', '~> 1.0')
 end

data/lib/deimos/active_record_consume/batch_consumption.rb

@@ -15,8 +15,9 @@ module Deimos
       # If two messages in a batch have the same key, we cannot process them
       # in the same operation as they would interfere with each other. Thus
       # they are split
-      # @param payloads [Array<Hash|Deimos::SchemaClass::Record>] Decoded payloads
+      # @param payloads [Array<Hash,Deimos::SchemaClass::Record>] Decoded payloads
       # @param metadata [Hash] Information about batch, including keys.
+      # @return [void]
       def consume_batch(payloads, metadata)
         messages = payloads.
           zip(metadata[:keys]).
@@ -59,6 +60,7 @@ module Deimos
       # All messages are split into slices containing only unique keys, and
       # each slice is handles as its own batch.
       # @param messages [Array<Message>] List of messages.
+      # @return [void]
       def uncompacted_update(messages)
         BatchSlicer.
           slice(messages).
@@ -69,6 +71,7 @@ module Deimos
       # All messages with payloads are passed to upsert_records.
       # All tombstones messages are passed to remove_records.
       # @param messages [Array<Message>] List of messages.
+      # @return [void]
       def update_database(messages)
         # Find all upserted records (i.e. that have a payload) and all
         # deleted record (no payload)
@@ -81,6 +84,7 @@ module Deimos
       # Upsert any non-deleted records
       # @param messages [Array<Message>] List of messages for a group of
       # records to either be updated or inserted.
+      # @return [void]
       def upsert_records(messages)
         key_cols = key_columns(messages)
 
@@ -119,6 +123,7 @@ module Deimos
       # Delete any records with a tombstone.
       # @param messages [Array<Message>] List of messages for a group of
       # deleted records.
+      # @return [void]
       def remove_records(messages)
         clause = deleted_query(messages)
 
@@ -128,7 +133,7 @@ module Deimos
       # Create an ActiveRecord relation that matches all of the passed
       # records. Used for bulk deletion.
       # @param records [Array<Message>] List of messages.
-      # @return ActiveRecord::Relation Matching relation.
+      # @return [ActiveRecord::Relation] Matching relation.
       def deleted_query(records)
         keys = records.
           map { |m| record_key(m.key)[@klass.primary_key] }.

data/lib/deimos/active_record_consume/batch_slicer.rb

@@ -11,6 +11,8 @@ module Deimos
       # slices that maintain the correct order.
       # E.g. Given messages A1, A2, B1, C1, C2, C3, they will be sliced as:
       # [[A1, B1, C1], [A2, C2], [C3]]
+      # @param messages [Array<Message>]
+      # @return [Array<Array<Message>>]
       def self.slice(messages)
         ops = messages.group_by(&:key)
 

data/lib/deimos/active_record_consume/message_consumption.rb

@@ -8,8 +8,8 @@ module Deimos
       # Find the record specified by the given payload and key.
       # Default is to use the primary key column and the value of the first
       # field in the key.
-      # @param klass [Class < ActiveRecord::Base]
-      # @param _payload [Hash|Deimos::SchemaClass::Record]
+      # @param klass [Class<ActiveRecord::Base>]
+      # @param _payload [Hash,Deimos::SchemaClass::Record]
       # @param key [Object]
       # @return [ActiveRecord::Base]
       def fetch_record(klass, _payload, key)
@@ -19,14 +19,16 @@ module Deimos
 
       # Assign a key to a new record.
       # @param record [ActiveRecord::Base]
-      # @param _payload [Hash|Deimos::SchemaClass::Record]
+      # @param _payload [Hash,Deimos::SchemaClass::Record]
       # @param key [Object]
+      # @return [void]
       def assign_key(record, _payload, key)
         record[record.class.primary_key] = key
       end
 
-      # @param payload [Hash|Deimos::SchemaClass::Record] Decoded payloads
+      # @param payload [Hash,Deimos::SchemaClass::Record] Decoded payloads
       # @param metadata [Hash] Information about batch, including keys.
+      # @return [void]
       def consume(payload, metadata)
         unless self.process_message?(payload)
           Deimos.config.logger.debug(
@@ -64,6 +66,7 @@ module Deimos
       end
 
       # @param record [ActiveRecord::Base]
+      # @return [void]
       def save_record(record)
         record.created_at ||= Time.zone.now if record.respond_to?(:created_at)
         record.updated_at = Time.zone.now if record.respond_to?(:updated_at)
@@ -73,6 +76,7 @@ module Deimos
       # Destroy a record that received a null payload. Override if you need
       # to do something other than a straight destroy (e.g. mark as archived).
       # @param record [ActiveRecord::Base]
+      # @return [void]
       def destroy_record(record)
         record&.destroy
       end