rails_ops 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1937c4aa90d37d096b10168ebffa90a755be0e1c7a52dc250f95d66c2b6b7f0
-  data.tar.gz: 5cc13627f981463d58248762486a724cc3ae84a3e36a3ce0bf4f6edc72af7096
+  metadata.gz: 545583c613d3f9b9c7599f93af3351790cc5b223ab3c2a8ec3a7962eb4143e2c
+  data.tar.gz: 9bc1a949fd81b6e05744561f76550ae72ddb8c18795de7dce47a6220ba9622a1
 SHA512:
-  metadata.gz: f40e55561302426eea0c42554d9b2b9db3ed3806db11bc821cf14598244c1f0921343f3db138e7be366370d9d5011c3a1bf95f8a3868919dfe7bf96517e0e8a9
-  data.tar.gz: 9028d762c7ee9a9c6a515aaec868cea270bb970450c982038573ce83ff0f689f86e4721fe9b6487c7ad69560ec08bbfc879b2e19a97fd7a7c97eabf7e3c71d52
+  metadata.gz: 23c48dbf356b7aa7032d2be737a93e405bd7fd1e63148d28f8c05036cf709a7c20e4951ec76dcfa72e55a71bdcbb5361bb67a29fcd3f13aba45c6b1e52592aec
+  data.tar.gz: 5e9d9889e87a6a98450aa97d0b24487cfe3526376b1cb05dc0ec90d899b0372a93ca3675485a7491cb23a02fb80644e579355f545ffb5ce23e343af61a8a7e96

data/.rubocop.yml

@@ -1,79 +1,151 @@
 AllCops:
   TargetRubyVersion: 2.3
-
+  DisplayCopNames: true
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
-    - 'vendor/**/*'
-    - 'tmp/**/*'
-    - 'log/**/*'
-    - '*.gemspec'
+    - 'test/dummy/**/*'
     - 'test/tmp/**/*'
+    - 'vendor/**/*'
+    - 'rails_ops.gemspec'
 
-  DisplayCopNames: true
+# Make sure accessors are on separate lines for diff readability.
+Style/AccessorGrouping:
+  EnforcedStyle: separated
 
-Style/SafeNavigation:
+# Cop would break a lot of existing code.
+Style/OptionalBooleanParameter:
   Enabled: false
 
+# Multiline hashes should be aligned cleanly as a table to improve readability.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Template style is easier on the eyes.
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+# file. This will be addressed when approaching the first ruby 3 application.
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+# Double negation is very useful to make sure you have a boolean in hand. Use it
+# wisely though and know what you're doing.
 Style/DoubleNegation:
   Enabled: false
 
+# Depending on the case, [].include? can be a lot harder to read and less
+# expressive than multiple comparisons.
+Style/MultipleComparison:
+  Enabled: false
+
+# Over time, the ruby guide changed from raise to fail back to raise. Both fail
+# and raise are programatically exactly the same and our decision fell to "fail"
+# for all kinds of exceptions.
 Style/SignalException:
   EnforcedStyle: only_fail
 
+# Enforced styles can sometimes be hard to read.
 Style/ConditionalAssignment:
   Enabled: false
 
-Style/IndentArray:
+# Enforce consistent array indentation.
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
+# Disable layout cop because methods just consisting of a number of returns
+# would look very odd with an extra empty line between each return.
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
 Metrics/MethodLength:
   Enabled: false
 
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
 Metrics/ClassLength:
   Enabled: false
 
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
 Metrics/ModuleLength:
   Enabled: false
 
+# While you should try to keep your code as expressive and short as possible,
+# limitting lengths hardly is over the top.
+Metrics/BlockLength:
+  Enabled: false
+
+# While not always desirable, it can be useful to have a lot of keyword
+# arguments on certain methods. Try to avoid it though.
 Metrics/ParameterLists:
   Max: 5
   CountKeywordArgs: false
 
+# The results of this cop sometimes seemed arbitrary and can signifficantly
+# restrict certain styles of coding.
 Metrics/AbcSize:
   Enabled: False
 
+# The results of this cop sometimes seemed arbitrary and can signifficantly
+# restrict certain styles of coding.
 Metrics/CyclomaticComplexity:
   Enabled: False
 
+# The results of this cop sometimes seemed arbitrary and can signifficantly
+# restrict certain styles of coding.
 Metrics/PerceivedComplexity:
   Enabled: False
 
-Metrics/LineLength:
+# In certain cases, "excessive" block nesting might just be useful. Try to keep
+# this down as much as possible though.
+Metrics/BlockNesting:
+  Enabled: false
+
+# A line length of 80 is not considered to be temporary anymore. That's why line
+# length is doubled to 160. If absolutely necessary, create a temporary rubocop
+# exclusion for the lines in question.
+Layout/LineLength:
   Max: 160
 
-Metrics/BlockNesting:
+# Disable variable number naming convention.
+Naming/VariableNumber:
   Enabled: false
 
-Metrics/BlockLength:
+# Disable method parameter naming convention.
+Naming/MethodParameterName:
   Enabled: false
 
+# Depending on the surrounding code, even simple if/unless clauses may be more
+# descriptive when on multiple lines.
 Style/IfUnlessModifier:
   Enabled: false
 
+# In most cases, timing does not allow documenting each and every bit of source
+# code. Do not hesitate to enable this cop otherwise.
 Style/Documentation:
   Enabled: false
 
+# Return should be used whenever there is more than one statement or line in a
+# method. This helps avoiding programming mistakes. This is not enforced yet as
+# this would require a custom cop. However, to allow this style of programming,
+# the RedundantReturn cop needs to be disabled.
 Style/RedundantReturn:
   Enabled: false
 
+# Non-ascii comments can be useful sometimes.
 Style/AsciiComments:
   Enabled: false
 
+# Depending on the case, if/unless can be more descriptive than guard clauses.
 Style/GuardClause:
   Enabled: false
 
+# For technical reasons, nested and compact styles must be mixed in certain
+# applications.
 Style/ClassAndModuleChildren:
   Enabled: false
   EnforcedStyle: compact
@@ -81,8 +153,27 @@ Style/ClassAndModuleChildren:
     - nested
     - compact
 
+# Depending on the case, it may be more descriptive to use i.e. == 0 instead of
+# .zero?, especially when testing against multiple numbers.
 Style/NumericPredicate:
   Enabled: false
 
+# Detection is not implemented in a reliable manner for all cases which can lead
+# to false positives and negatives.
 Style/FormatString:
   Enabled: false
+
+# Do not require MFA, as gems checked with sitrox_standards are only pushed to the
+# internal repo
+Gemspec/RequireMFA:
+  Enabled: false
+
+# Use explicit style
+Naming/BlockForwarding:
+  Enabled: true
+  EnforcedStyle: explicit
+
+# Don't require gemspec dependencies to be versioned. While it's generally a good
+# idea to require specifying versions of dependencies, we don't want to enforce it.
+Gemspec/DependencyVersion:
+  Enabled: false

data/Appraisals

@@ -1,19 +1,19 @@
-appraise "rails-7.0" do
-  gem "rails", "~> 7.0.1"
+appraise 'rails-7.0' do
+  gem 'rails', '~> 7.0.1'
 end
 
-appraise "rails-6.1" do
-  gem "rails", "~> 6.1.4"
+appraise 'rails-6.1' do
+  gem 'rails', '~> 6.1.4'
 end
 
-appraise "rails-6.0" do
-  gem "rails", "~> 6.0.4"
+appraise 'rails-6.0' do
+  gem 'rails', '~> 6.0.4'
 end
 
-appraise "rails-5.2" do
-  gem "rails", "~> 5.2.6"
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.6'
 end
 
-appraise "rails-5.1" do
-  gem "rails", "~> 5.1.7"
-end
+appraise 'rails-5.1' do
+  gem 'rails', '~> 5.1.7'
+end

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 1.4.2 (2023-03-20)
+
+* Update the `operation` generator such that it complies with the naming
+  conventions laid out in [Placing and naming
+  operations](https://github.com/sitrox/rails_ops#placing-and-naming-operations).
+  The path were the operations reside and the validation schema key are now
+  generated in singular.
+
+  Internal reference: `#111055`.
+
+## 1.4.1 (2023-02-21)
+
+* Fix specifying custom [param_key](README.md#param-key) when nesting model
+  operations
+
 ## 1.4.0 (2023-02-21)
 
 ### Changes

data/Rakefile

@@ -7,7 +7,7 @@ task default: :test
 task :gemspec do
   gemspec = Gem::Specification.new do |spec|
     spec.name          = 'rails_ops'
-    spec.version       = IO.read('VERSION').chomp
+    spec.version       = File.read('VERSION').chomp
     spec.authors       = ['Sitrox']
     spec.summary       = 'An operations service layer for rails projects.'
     spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -22,7 +22,7 @@ task :gemspec do
     spec.add_development_dependency 'cancancan'
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'colorize'
-    spec.add_development_dependency 'rubocop', '0.47.1'
+    spec.add_development_dependency 'rubocop', '1.45.1'
     spec.add_development_dependency 'sprockets-rails'
     spec.add_dependency 'active_type', '>= 1.3.0'
     spec.add_dependency 'minitest'
@@ -31,11 +31,9 @@ task :gemspec do
     spec.add_dependency 'schemacop', '>= 2.4.2', '<= 3.1'
   end
 
-  File.open('rails_ops.gemspec', 'w') { |f| f.write(gemspec.to_ruby.strip) }
+  File.write('rails_ops.gemspec', gemspec.to_ruby.strip)
 end
 
-require 'rake/testtask'
-
 Rake::TestTask.new do |t|
   t.pattern = 'test/unit/**/*_test.rb'
   t.verbose = false

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.2

data/gemfiles/rails_6.0.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "~> 6.0.4"
+gem 'rails', '~> 6.0.4'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_6.1.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "~> 6.1.4"
+gem 'rails', '~> 6.1.4'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_7.0.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "~> 7.0.1"
+gem 'rails', '~> 7.0.1'
 
-gemspec path: "../"
+gemspec path: '../'

data/lib/generators/operation/operation_generator.rb

@@ -9,8 +9,8 @@ class OperationGenerator < Rails::Generators::NamedBase
 
   def add_operations
     @class_name = name.classify
-    @underscored_name = name.underscore
-    @underscored_pluralized_name = name.underscore.pluralize
+    @underscored_name = @class_name.underscore
+    @underscored_pluralized_name = @class_name.underscore.pluralize
 
     operations_path = 'app/operations/'
 
@@ -51,7 +51,7 @@ class OperationGenerator < Rails::Generators::NamedBase
     end
     views_folder += @underscored_pluralized_name.to_s
 
-    %w(index show new edit).each do |view|
+    %w[index show new edit].each do |view|
       template 'view.erb', "#{views_folder}/#{view}.html.haml"
     end
   end

data/lib/rails_ops/authorization_backend/abstract.rb

@@ -7,7 +7,7 @@ module RailsOps::AuthorizationBackend
     def exception_class
       @exception_class ||= self.class::EXCEPTION_CLASS.constantize
     rescue NameError
-      fail "Unable to constantize exception class #{self.class::EXCEPTION_CLASS.inspect} "\
+      fail "Unable to constantize exception class #{self.class::EXCEPTION_CLASS.inspect} " \
            "for authorization backend #{self.class.name}. Is the library loaded?"
     end
   end

data/lib/rails_ops/authorization_backend/can_can_can.rb

@@ -5,8 +5,10 @@ module RailsOps::AuthorizationBackend
     EXCEPTION_CLASS = 'CanCan::AccessDenied'.freeze
 
     def initialize
+      super
+
       unless defined?(CanCanCan)
-        fail 'RailsOps is configured to use CanCanCan authorization'\
+        fail 'RailsOps is configured to use CanCanCan authorization' \
              "backend, but the Gem 'cancancan' does not appear to be installed."
       end
     end

data/lib/rails_ops/controller_mixin.rb

@@ -100,7 +100,7 @@ module RailsOps
     end
 
     def model?
-      !!(@model || op? && op.respond_to?(:model) && op.model)
+      !!(@model || (op? && op.respond_to?(:model) && op.model))
     end
 
     # Filters the `params` hash for use with RailsOps. This removes certain

data/lib/rails_ops/hookup/dsl_validator.rb

@@ -1,5 +1,6 @@
 class RailsOps::Hookup::DSLValidator
-  attr_reader :error, :trace
+  attr_reader :error
+  attr_reader :trace
 
   def initialize(hooks)
     @hooks = hooks

data/lib/rails_ops/hookup.rb

@@ -55,7 +55,7 @@ class RailsOps::Hookup
 
     hooks = []
 
-    @hooks.slice('*', operation.class.name).values.each do |hooks_by_event|
+    @hooks.slice('*', operation.class.name).each_value do |hooks_by_event|
       hooks += hooks_by_event.slice('*', event).values.flatten || []
     end
 

data/lib/rails_ops/mixins/authorization.rb

@@ -48,12 +48,12 @@ module RailsOps::Mixins::Authorization
 
   # Determines whether authorize has been called for this operation.
   def authorize_called?
-    @_authorize_called ||= false
+    @authorize_called ||= false
   end
 
   # Manually marks the authorization as called for this operation.
   def authorize_called!
-    @_authorize_called = true
+    @authorize_called = true
   end
 
   # Operations within the given block will have disabled authorization.

data/lib/rails_ops/mixins/model/nesting.rb

@@ -31,15 +31,15 @@ module RailsOps::Mixins::Model::Nesting
       if reflection.nil?
         fail "Association #{attribute} could not be found for #{model.model_name}."
       elsif !reflection.belongs_to?
-        fail 'Method nest_model_op only supports :belongs_to associations, '\
-             "but association #{attribute} of model #{model.model_name} is a "\
+        fail 'Method nest_model_op only supports :belongs_to associations, ' \
+             "but association #{attribute} of model #{model.model_name} is a " \
              "#{reflection.macro} association."
       elsif reflection.options[:autosave] != false
-        fail "Association #{attribute} of #{model.model_name} has :autosave turned on. "\
+        fail "Association #{attribute} of #{model.model_name} has :autosave turned on. " \
              'This is not supported by nest_model_op.'
       elsif !reflection.options[:validate]
-        fail "Association #{attribute} of #{model.model_name} has :validate turned off. "\
-        'This is not supported by nest_model_op.'
+        fail "Association #{attribute} of #{model.model_name} has :validate turned off. " \
+             'This is not supported by nest_model_op.'
       end
 
       # ---------------------------------------------------------------
@@ -61,11 +61,9 @@ module RailsOps::Mixins::Model::Nesting
       # ---------------------------------------------------------------
       # Validate inverse association reflection if given
       # ---------------------------------------------------------------
-      if (inverse_reflection = reflection.inverse_of)
-        if inverse_reflection.options[:autosave] != false
-          fail "Association #{inverse_reflection.name} of #{inverse_reflection.active_record} has :autosave turned on. "\
-               'This is not supported by nest_model_op.'
-        end
+      if (inverse_reflection = reflection.inverse_of) && (inverse_reflection.options[:autosave] != false)
+        fail "Association #{inverse_reflection.name} of #{inverse_reflection.active_record} has :autosave turned on. " \
+             'This is not supported by nest_model_op.'
       end
 
       # ---------------------------------------------------------------
@@ -73,11 +71,12 @@ module RailsOps::Mixins::Model::Nesting
       # ---------------------------------------------------------------
       self._nested_model_ops = _nested_model_ops.merge(
         attribute => {
-          klass: klass,
-          attribute_name: reflection.class_name.underscore,
-          params_proc: params_block,
+          klass:                   klass,
+          param_key:               param_key,
+          attribute_name:          reflection.class_name.underscore,
+          params_proc:             params_block,
           lookup_via_id_on_update: lookup_via_id_on_update,
-          allow_id: allow_id
+          allow_id:                allow_id
         }
       )
     end
@@ -103,7 +102,7 @@ module RailsOps::Mixins::Model::Nesting
 
   def build_nested_model_ops(action)
     # Validate action
-    fail 'Unsupported action.' unless %i(create update).include?(action)
+    fail 'Unsupported action.' unless %i[create update].include?(action)
 
     # Make sure that this method can only be run once per operation
     fail 'Nested model operations can only be built once.' if @nested_model_ops
@@ -123,13 +122,14 @@ module RailsOps::Mixins::Model::Nesting
       end
 
       # Wrap parameters for nested model operation
-      param_key ||= config[:klass].model.model_name.param_key
+      param_key = config[:param_key] || config[:klass].model.model_name.param_key
 
-      if action == :create
+      case action
+      when :create
         wrapped_params = {
           param_key => op_params
         }
-      elsif action == :update
+      when :update
         if config[:lookup_via_id_on_update]
           foreign_key = model.class.reflect_on_association(attribute).foreign_key
           id = model.send(foreign_key)
@@ -138,7 +138,7 @@ module RailsOps::Mixins::Model::Nesting
         end
 
         wrapped_params = {
-          :id => id,
+          :id       => id,
           param_key => op_params
         }
       else
@@ -172,15 +172,15 @@ module RailsOps::Mixins::Model::Nesting
     # line also makes sure a model is built.
     model.validate!
 
+    # Make sure nested model operations are built
+    fail 'Nested model operations are not built yet. Make sure the model is built.' unless @nested_model_ops
+
     # Validate all unchanged nested models as the above call to "validate!" only validates
     # associations that are changed.
-    @nested_model_ops.keys.each do |attribute|
+    @nested_model_ops.each_key do |attribute|
       model.send(attribute).validate!
     end
 
-    # Make sure nested model operations are build
-    fail 'Nested model operations are not built yet. Make sure the model is built.' unless @nested_model_ops
-
     @nested_model_ops.each do |attribute, op|
       # Run the nested model operation and fail hard if a validation error
       # arises. This should generally not happen as the whole hierarchy has been

data/lib/rails_ops/mixins/policies.rb

@@ -5,17 +5,17 @@
 module RailsOps::Mixins::Policies
   extend ActiveSupport::Concern
 
-  POLICY_CHAIN_KEYS = [
-    :on_init,
-    :before_perform,
-    :after_perform,
-    :before_nested_model_ops,
-    :before_model_save
+  POLICY_CHAIN_KEYS = %i[
+    on_init
+    before_perform
+    after_perform
+    before_nested_model_ops
+    before_model_save
   ].freeze
 
   included do
     class_attribute :_policy_chains
-    self._policy_chains = Hash[POLICY_CHAIN_KEYS.map { |key| [key, [].freeze] }]
+    self._policy_chains = POLICY_CHAIN_KEYS.map { |key| [key, [].freeze] }.to_h
   end
 
   module ClassMethods

data/lib/rails_ops/mixins/routes.rb

@@ -6,7 +6,7 @@ module RailsOps::Mixins::Routes
   # this class on the first call. This is not thread-safe, but the worst case is
   # that this is performed more than once.
   def self.container_class
-    @container ||= Class.new do
+    @container_class ||= Class.new do
       include Rails.application.routes.url_helpers
 
       attr_reader :url_options

data/lib/rails_ops/model_mixins/marshalling.rb

@@ -5,7 +5,7 @@ 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
 

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

@@ -45,7 +45,7 @@ class RailsOps::Operation::Model::Load < RailsOps::Operation::Model
   # 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)
+    fail "Unknown lock mode #{lock_mode}" unless %i[shared exclusive].include?(lock_mode)
 
     self._lock_mode = lock_mode
   end
@@ -108,12 +108,10 @@ class RailsOps::Operation::Model::Load < RailsOps::Operation::Model
     adapter_type = ActiveRecord::Base.connection.adapter_name.downcase.to_sym
 
     case adapter_type
-    when :mysql, :mysql2
+    when :mysql, :mysql2, :oracleenhanced
       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

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

@@ -20,8 +20,8 @@ class RailsOps::Operation::Model::Update < RailsOps::Operation::Model::Load
     if self.class._model_authorization_lazy
       if load_model_authorization_action.nil?
         fail RailsOps::Exceptions::NoAuthorizationPerformed,
-             "Operation #{self.class.name} must specify a "\
-             'load_model_authorization_action because model '\
+             "Operation #{self.class.name} must specify a " \
+             'load_model_authorization_action because model ' \
              'authorization is configured to be lazy.'
       else
         authorize_model! load_model_authorization_action, model

data/lib/rails_ops/operation/model.rb

@@ -70,7 +70,7 @@ class RailsOps::Operation::Model < RailsOps::Operation
         end
 
         # Set virtual STI name if given.
-        if model_class && model_class.name
+        if model_class&.name
           _model_class.virtual_sti_name = model_class.name
         end
 

data/lib/rails_ops/operation.rb

@@ -39,9 +39,10 @@ class RailsOps::Operation
   # @param params [Hash] Optional parameters hash
   def initialize(context_or_params = {}, params = {})
     # Handle parameter signature
-    if context_or_params.is_a?(RailsOps::Context)
+    case context_or_params
+    when RailsOps::Context
       context = context_or_params
-    elsif context_or_params.is_a?(Hash) || context_or_params.is_a?(ActionController::Parameters)
+    when Hash, ActionController::Parameters
       context = nil
       params = context_or_params
     end
@@ -80,7 +81,9 @@ class RailsOps::Operation
 
   # Returns a copy of the operation's params, wrapped in an OpenStruct object.
   def osparams
+    # rubocop: disable Style/OpenStructUse
     @osparams ||= OpenStruct.new(params)
+    # rubocop: enable Style/OpenStructUse
   end
 
   # Return a hash of parameters with all sensitive data replaced.
@@ -131,7 +134,7 @@ class RailsOps::Operation
     if params
       begin
         inspected_params = inspect_params(filtered_params)
-      rescue
+      rescue StandardError
         inspected_params = '<could not inspect params>'
       end
       inspection += " (#{inspected_params})"
@@ -222,7 +225,7 @@ class RailsOps::Operation
   # elegant and transparent approach as explained in the issue.
   def with_rollback_on_exception(&_block)
     yield
-  rescue => e
+  rescue StandardError => e
     fail RailsOps::Exceptions::RollbackRequired, e, e.backtrace
   end