rails_ops 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aebb67a89b1cc32ee09838441c6fd5739fb40f44662d9f09519ffbb09a63066
-  data.tar.gz: 16dde2b894f56aef4f774a8d7b421b4928ee566b058d54c5d4aa7446ee877270
+  metadata.gz: 365397242478d0f5dd89c5eadf97871c2e5d9a6a2f5b59dbfdbdb5a060bf56e0
+  data.tar.gz: 45f57e7a2abfe574b2c7caeaa135fb4896c364bdc9e36c5adc673640e6be1351
 SHA512:
-  metadata.gz: 6bc197031923788967f7f972bef74c2f7d122d6aa23287911c9bcde5ed95434ac7612a3366a99641c2fca30acc069c8591a62af5c0edf603fb77fc5609799297
-  data.tar.gz: 11a35f00a823959e1e0dd8859f32d404ca7a2b7c38c9f17695332e5a0bea40b0452be88f57a50e58d695264e3bae5f8ca7d88d2fc98f4649de28038705518a49
+  metadata.gz: c58cba8d71ca052e676323d98a0dbdd58d39db4f3c1c9a15ed95d4f8714ae3377bbd4e7a45c5b83bccf74dba34ac573a690cd839174a3600ea03d0c3abab5514
+  data.tar.gz: f3eebf9294ec8a7a84be52329964b6ee5a717099d52b10dcf408d2a7eaf92d19072b3b85b84affe33348117ed113a2cfeb10beed412c371270920ecbe86370a4

data/.github/workflows/ruby.yml

@@ -29,6 +29,8 @@ jobs:
             ruby-version: '3.0.1'
           - rails-version: '7.0'
             ruby-version: '3.1.0'
+          - rails-version: '7.0'
+            ruby-version: '3.2.0'
     name: Test against Ruby ${{ matrix.ruby-version }} / Rails ${{ matrix.rails-version }}
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails_${{ matrix.rails-version }}.gemfile

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.3.0 (2023-01-23)
+
+* Add `lock_mode` DSL method
+* Set `Load` operations to use shared locking, and `Update` and `Destroy`
+  operations to use exclusive locking. Please make sure your operations
+  inherit from the correct parent operation, and change the locking mode
+  if it is not the correct one for your operation. More info can be found
+  in the section "Locking" in the Readme
+
 ## 1.2.3 (2023-01-04)
 
 * Fix marshalling of operation models. This is especially useful for use in

data/README.md

@@ -1133,6 +1133,32 @@ class Operations::User::Update < RailsOps::Operation::Model::Update
 end
 ```
 
+Please note that for performance reasons, the `Load` operation (and any
+operations inheriting from it) use a shared lock, i.e. it issues
+an `LOCK IN SHARE MODE` / `FOR SHARE` statement. The `Update` and `Destroy`
+operations (as well as operations inheriting from it) however use the default
+`lock` method of ActiveRecord, which will issue an exclusive lock.
+
+If you want to change the mode, you can use the `lock_mode` DSL method, which
+has two possible modes:
+
+* `:shared` for the shared lock mode
+* `:exclusive` for the exclusive lock mode
+
+For example, if you have an operation loading a record which you'd want to
+lock exclusively, you'd need to write the following:
+
+```ruby
+class Operations::User::Update < RailsOps::Operation::Model::Load
+  model ::User
+  lock_mode :exclusive
+end
+```
+
+One caveat is, that shared locking is only supported for MySQl (MariaDB),
+Postgresql and Oracle DB databases, any other database will always use an
+exlusive lock.
+
 ### Creating models
 
 For creating models, you can use the base class

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.3.0

data/lib/rails_ops/model_mixins/marshalling.rb

@@ -5,14 +5,13 @@ module RailsOps
     #  with default procs which is not supported by `Marshal.dump`. This mixin
     #  therefore excludes this instance variable from being dumped and loaded.
     module Marshalling
-      UNMARSHALED_VARIABLES = %i[@parent_op].freeze
+      UNMARSHALED_VARIABLES = %i(@parent_op).freeze
 
       extend ActiveSupport::Concern
 
       def marshal_dump
-        instance_variables.reject{|m| UNMARSHALED_VARIABLES.include? m}.inject({}) do |vars, attr|
+        instance_variables.reject { |m| UNMARSHALED_VARIABLES.include? m }.each_with_object({}) do |attr, vars|
           vars[attr] = instance_variable_get(attr)
-          vars
         end
       end
 

data/lib/rails_ops/operation/model/destroy.rb

@@ -1,5 +1,6 @@
 class RailsOps::Operation::Model::Destroy < RailsOps::Operation::Model::Load
   model_authorization_action :destroy
+  lock_mode :exclusive
 
   def model_authorization
     return unless authorization_enabled?

data/lib/rails_ops/operation/model/load.rb

@@ -1,6 +1,7 @@
 class RailsOps::Operation::Model::Load < RailsOps::Operation::Model
   class_attribute :_lock_model_at_build
   class_attribute :_load_model_authorization_action
+  class_attribute :_lock_mode
 
   policy :on_init do
     model_authorization
@@ -39,6 +40,24 @@ class RailsOps::Operation::Model::Load < RailsOps::Operation::Model
     _lock_model_at_build.nil? ? RailsOps.config.lock_models_at_build? : _lock_model_at_build
   end
 
+  # Method to set the lock mode, which can either be :exclusive to use
+  # an exclusive write lock, or :shared to use a shared lock. Please note
+  # that currently, :shared only works for MySql, Postgresql and Oracle DB,
+  # other adapters always use the exclusive lock.
+  def self.lock_mode(lock_mode)
+    fail "Unknown lock mode #{lock_mode}" unless %i(shared exclusive).include?(lock_mode)
+
+    self._lock_mode = lock_mode
+  end
+
+  # Get the lock_mode or the default of :exclusive
+  def self.lock_mode_or_default
+    _lock_mode.presence || :exclusive
+  end
+
+  # Set the lock mode for load operations (and it's children) to :shared
+  lock_mode :shared
+
   def model_id_field
     :id
   end
@@ -52,7 +71,7 @@ class RailsOps::Operation::Model::Load < RailsOps::Operation::Model
     relation = self.class.model
 
     # Express intention to lock if required
-    relation = relation.lock if self.class.lock_model_at_build?
+    relation = lock_relation(relation)
 
     # Fetch (and possibly lock) model
     return relation.find_by!(model_id_field => params[model_id_field])
@@ -69,4 +88,38 @@ class RailsOps::Operation::Model::Load < RailsOps::Operation::Model
   def extract_id_from_params
     params[model_id_field]
   end
+
+  private
+
+  def lock_relation(relation)
+    # Directly return the relation if we don't want to lock the relation
+    return relation unless self.class.lock_model_at_build?
+
+    if self.class.lock_mode_or_default == :shared
+      # Lock the relation in shared mode
+      return relation.lock(shared_lock_statement)
+    else
+      # Lock the relation in exclusive mode
+      return relation.lock
+    end
+  end
+
+  def shared_lock_statement
+    adapter_type = ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+
+    case adapter_type
+    when :mysql, :mysql2
+      return 'LOCK IN SHARE MODE'
+    when :postgresql
+      return 'FOR SHARE'
+    when :oracleenhanced
+      return 'LOCK IN SHARE MODE'
+    end
+
+    # Don't return anything, which will make the `lock` statement
+    # use the normal, exclusive lock. This might be suboptimal for other
+    # database adapters, but we'd rather lock too restrictive, such that
+    # no race-conditions may occur.
+    return nil
+  end
 end

data/lib/rails_ops/operation/model/update.rb

@@ -1,5 +1,6 @@
 class RailsOps::Operation::Model::Update < RailsOps::Operation::Model::Load
   model_authorization_action :update
+  lock_mode :exclusive
 
   # As this operation might extend the model class, we need to make sure that
   # the operation works using an extended 'copy' of the given model class.

data/rails_ops.gemspec

@@ -1,16 +1,16 @@
 # -*- encoding: utf-8 -*-
-# stub: rails_ops 1.2.3 ruby lib
+# stub: rails_ops 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails_ops".freeze
-  s.version = "1.2.3"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2023-01-04"
+  s.date = "2023-01-23"
   s.files = [".github/workflows/rubocop.yml".freeze, ".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, "Appraisals".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "gemfiles/rails_6.0.gemfile".freeze, "gemfiles/rails_6.1.gemfile".freeze, "gemfiles/rails_7.0.gemfile".freeze, "lib/generators/operation/USAGE".freeze, "lib/generators/operation/operation_generator.rb".freeze, "lib/generators/operation/templates/controller.erb".freeze, "lib/generators/operation/templates/create.erb".freeze, "lib/generators/operation/templates/destroy.erb".freeze, "lib/generators/operation/templates/load.erb".freeze, "lib/generators/operation/templates/update.erb".freeze, "lib/generators/operation/templates/view.erb".freeze, "lib/rails_ops.rb".freeze, "lib/rails_ops/authorization_backend/abstract.rb".freeze, "lib/rails_ops/authorization_backend/can_can_can.rb".freeze, "lib/rails_ops/configuration.rb".freeze, "lib/rails_ops/context.rb".freeze, "lib/rails_ops/controller_mixin.rb".freeze, "lib/rails_ops/exceptions.rb".freeze, "lib/rails_ops/hooked_job.rb".freeze, "lib/rails_ops/hookup.rb".freeze, "lib/rails_ops/hookup/dsl.rb".freeze, "lib/rails_ops/hookup/dsl_validator.rb".freeze, "lib/rails_ops/hookup/hook.rb".freeze, "lib/rails_ops/log_subscriber.rb".freeze, "lib/rails_ops/mixins.rb".freeze, "lib/rails_ops/mixins/authorization.rb".freeze, "lib/rails_ops/mixins/log_settings.rb".freeze, "lib/rails_ops/mixins/model.rb".freeze, "lib/rails_ops/mixins/model/authorization.rb".freeze, "lib/rails_ops/mixins/model/nesting.rb".freeze, "lib/rails_ops/mixins/param_authorization.rb".freeze, "lib/rails_ops/mixins/policies.rb".freeze, "lib/rails_ops/mixins/require_context.rb".freeze, "lib/rails_ops/mixins/routes.rb".freeze, "lib/rails_ops/mixins/schema_validation.rb".freeze, "lib/rails_ops/mixins/sub_ops.rb".freeze, "lib/rails_ops/model_mixins.rb".freeze, "lib/rails_ops/model_mixins/ar_extension.rb".freeze, "lib/rails_ops/model_mixins/marshalling.rb".freeze, "lib/rails_ops/model_mixins/parent_op.rb".freeze, "lib/rails_ops/model_mixins/sti_fixes.rb".freeze, "lib/rails_ops/model_mixins/virtual_attributes.rb".freeze, "lib/rails_ops/model_mixins/virtual_attributes/virtual_column_wrapper.rb".freeze, "lib/rails_ops/model_mixins/virtual_has_one.rb".freeze, "lib/rails_ops/model_mixins/virtual_model_name.rb".freeze, "lib/rails_ops/operation.rb".freeze, "lib/rails_ops/operation/model.rb".freeze, "lib/rails_ops/operation/model/create.rb".freeze, "lib/rails_ops/operation/model/destroy.rb".freeze, "lib/rails_ops/operation/model/load.rb".freeze, "lib/rails_ops/operation/model/update.rb".freeze, "lib/rails_ops/profiler.rb".freeze, "lib/rails_ops/profiler/node.rb".freeze, "lib/rails_ops/railtie.rb".freeze, "lib/rails_ops/scoped_env.rb".freeze, "lib/rails_ops/virtual_model.rb".freeze, "rails_ops.gemspec".freeze, "test/db/models.rb".freeze, "test/db/schema.rb".freeze, "test/dummy/Rakefile".freeze, "test/dummy/app/assets/config/manifest.js".freeze, "test/dummy/app/assets/images/.keep".freeze, "test/dummy/app/assets/javascripts/application.js".freeze, "test/dummy/app/assets/javascripts/cable.js".freeze, "test/dummy/app/assets/javascripts/channels/.keep".freeze, "test/dummy/app/assets/stylesheets/application.css".freeze, "test/dummy/app/channels/application_cable/channel.rb".freeze, "test/dummy/app/channels/application_cable/connection.rb".freeze, "test/dummy/app/controllers/application_controller.rb".freeze, "test/dummy/app/controllers/concerns/.keep".freeze, "test/dummy/app/helpers/application_helper.rb".freeze, "test/dummy/app/jobs/application_job.rb".freeze, "test/dummy/app/mailers/application_mailer.rb".freeze, "test/dummy/app/models/animal.rb".freeze, "test/dummy/app/models/application_record.rb".freeze, "test/dummy/app/models/bird.rb".freeze, "test/dummy/app/models/cat.rb".freeze, "test/dummy/app/models/concerns/.keep".freeze, "test/dummy/app/models/dog.rb".freeze, "test/dummy/app/models/flower.rb".freeze, "test/dummy/app/models/group.rb".freeze, "test/dummy/app/models/nightingale.rb".freeze, "test/dummy/app/models/phoenix.rb".freeze, "test/dummy/app/models/user.rb".freeze, "test/dummy/app/views/layouts/application.html.erb".freeze, "test/dummy/app/views/layouts/mailer.html.erb".freeze, "test/dummy/app/views/layouts/mailer.text.erb".freeze, "test/dummy/bin/bundle".freeze, "test/dummy/bin/rails".freeze, "test/dummy/bin/rake".freeze, "test/dummy/bin/setup".freeze, "test/dummy/bin/update".freeze, "test/dummy/bin/yarn".freeze, "test/dummy/config.ru".freeze, "test/dummy/config/application.rb".freeze, "test/dummy/config/boot.rb".freeze, "test/dummy/config/cable.yml".freeze, "test/dummy/config/database.yml".freeze, "test/dummy/config/environment.rb".freeze, "test/dummy/config/environments/development.rb".freeze, "test/dummy/config/environments/production.rb".freeze, "test/dummy/config/environments/test.rb".freeze, "test/dummy/config/initializers/application_controller_renderer.rb".freeze, "test/dummy/config/initializers/assets.rb".freeze, "test/dummy/config/initializers/backtrace_silencers.rb".freeze, "test/dummy/config/initializers/cookies_serializer.rb".freeze, "test/dummy/config/initializers/filter_parameter_logging.rb".freeze, "test/dummy/config/initializers/inflections.rb".freeze, "test/dummy/config/initializers/mime_types.rb".freeze, "test/dummy/config/initializers/rails_ops.rb".freeze, "test/dummy/config/initializers/wrap_parameters.rb".freeze, "test/dummy/config/locales/en.yml".freeze, "test/dummy/config/puma.rb".freeze, "test/dummy/config/routes.rb".freeze, "test/dummy/config/secrets.yml".freeze, "test/dummy/config/spring.rb".freeze, "test/dummy/db/schema.rb".freeze, "test/dummy/lib/assets/.keep".freeze, "test/dummy/log/.keep".freeze, "test/dummy/package.json".freeze, "test/dummy/public/404.html".freeze, "test/dummy/public/422.html".freeze, "test/dummy/public/500.html".freeze, "test/dummy/public/apple-touch-icon-precomposed.png".freeze, "test/dummy/public/apple-touch-icon.png".freeze, "test/dummy/public/favicon.ico".freeze, "test/dummy/tmp/.keep".freeze, "test/test_helper.rb".freeze, "test/unit/rails_ops/generators/operation_generator_test.rb".freeze, "test/unit/rails_ops/mixins/model/nesting.rb".freeze, "test/unit/rails_ops/mixins/param_authorization_test.rb".freeze, "test/unit/rails_ops/mixins/policies_test.rb".freeze, "test/unit/rails_ops/operation/model/create_test.rb".freeze, "test/unit/rails_ops/operation/model/load_test.rb".freeze, "test/unit/rails_ops/operation/model/sti_test.rb".freeze, "test/unit/rails_ops/operation/model/update_test.rb".freeze, "test/unit/rails_ops/operation/model_test.rb".freeze, "test/unit/rails_ops/operation/update_auth_test.rb".freeze, "test/unit/rails_ops/operation/update_lazy_auth_test.rb".freeze, "test/unit/rails_ops/operation_test.rb".freeze]
-  s.rubygems_version = "3.3.11".freeze
+  s.rubygems_version = "3.2.15".freeze
   s.summary = "An operations service layer for rails projects.".freeze
   s.test_files = ["test/db/models.rb".freeze, "test/db/schema.rb".freeze, "test/dummy/Rakefile".freeze, "test/dummy/app/assets/config/manifest.js".freeze, "test/dummy/app/assets/images/.keep".freeze, "test/dummy/app/assets/javascripts/application.js".freeze, "test/dummy/app/assets/javascripts/cable.js".freeze, "test/dummy/app/assets/javascripts/channels/.keep".freeze, "test/dummy/app/assets/stylesheets/application.css".freeze, "test/dummy/app/channels/application_cable/channel.rb".freeze, "test/dummy/app/channels/application_cable/connection.rb".freeze, "test/dummy/app/controllers/application_controller.rb".freeze, "test/dummy/app/controllers/concerns/.keep".freeze, "test/dummy/app/helpers/application_helper.rb".freeze, "test/dummy/app/jobs/application_job.rb".freeze, "test/dummy/app/mailers/application_mailer.rb".freeze, "test/dummy/app/models/animal.rb".freeze, "test/dummy/app/models/application_record.rb".freeze, "test/dummy/app/models/bird.rb".freeze, "test/dummy/app/models/cat.rb".freeze, "test/dummy/app/models/concerns/.keep".freeze, "test/dummy/app/models/dog.rb".freeze, "test/dummy/app/models/flower.rb".freeze, "test/dummy/app/models/group.rb".freeze, "test/dummy/app/models/nightingale.rb".freeze, "test/dummy/app/models/phoenix.rb".freeze, "test/dummy/app/models/user.rb".freeze, "test/dummy/app/views/layouts/application.html.erb".freeze, "test/dummy/app/views/layouts/mailer.html.erb".freeze, "test/dummy/app/views/layouts/mailer.text.erb".freeze, "test/dummy/bin/bundle".freeze, "test/dummy/bin/rails".freeze, "test/dummy/bin/rake".freeze, "test/dummy/bin/setup".freeze, "test/dummy/bin/update".freeze, "test/dummy/bin/yarn".freeze, "test/dummy/config.ru".freeze, "test/dummy/config/application.rb".freeze, "test/dummy/config/boot.rb".freeze, "test/dummy/config/cable.yml".freeze, "test/dummy/config/database.yml".freeze, "test/dummy/config/environment.rb".freeze, "test/dummy/config/environments/development.rb".freeze, "test/dummy/config/environments/production.rb".freeze, "test/dummy/config/environments/test.rb".freeze, "test/dummy/config/initializers/application_controller_renderer.rb".freeze, "test/dummy/config/initializers/assets.rb".freeze, "test/dummy/config/initializers/backtrace_silencers.rb".freeze, "test/dummy/config/initializers/cookies_serializer.rb".freeze, "test/dummy/config/initializers/filter_parameter_logging.rb".freeze, "test/dummy/config/initializers/inflections.rb".freeze, "test/dummy/config/initializers/mime_types.rb".freeze, "test/dummy/config/initializers/rails_ops.rb".freeze, "test/dummy/config/initializers/wrap_parameters.rb".freeze, "test/dummy/config/locales/en.yml".freeze, "test/dummy/config/puma.rb".freeze, "test/dummy/config/routes.rb".freeze, "test/dummy/config/secrets.yml".freeze, "test/dummy/config/spring.rb".freeze, "test/dummy/db/schema.rb".freeze, "test/dummy/lib/assets/.keep".freeze, "test/dummy/log/.keep".freeze, "test/dummy/package.json".freeze, "test/dummy/public/404.html".freeze, "test/dummy/public/422.html".freeze, "test/dummy/public/500.html".freeze, "test/dummy/public/apple-touch-icon-precomposed.png".freeze, "test/dummy/public/apple-touch-icon.png".freeze, "test/dummy/public/favicon.ico".freeze, "test/dummy/tmp/.keep".freeze, "test/test_helper.rb".freeze, "test/unit/rails_ops/generators/operation_generator_test.rb".freeze, "test/unit/rails_ops/mixins/model/nesting.rb".freeze, "test/unit/rails_ops/mixins/param_authorization_test.rb".freeze, "test/unit/rails_ops/mixins/policies_test.rb".freeze, "test/unit/rails_ops/operation/model/create_test.rb".freeze, "test/unit/rails_ops/operation/model/load_test.rb".freeze, "test/unit/rails_ops/operation/model/sti_test.rb".freeze, "test/unit/rails_ops/operation/model/update_test.rb".freeze, "test/unit/rails_ops/operation/model_test.rb".freeze, "test/unit/rails_ops/operation/update_auth_test.rb".freeze, "test/unit/rails_ops/operation/update_lazy_auth_test.rb".freeze, "test/unit/rails_ops/operation_test.rb".freeze]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_ops
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Sitrox
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -212,8 +212,8 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '3.1'
-description:
-email:
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -370,10 +370,10 @@ files:
 - test/unit/rails_ops/operation/update_auth_test.rb
 - test/unit/rails_ops/operation/update_lazy_auth_test.rb
 - test/unit/rails_ops/operation_test.rb
-homepage:
+homepage: 
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -388,8 +388,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
-signing_key:
+rubygems_version: 3.2.15
+signing_key: 
 specification_version: 4
 summary: An operations service layer for rails projects.
 test_files: