operations 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41842fbe905d259c1c39bd2922caa0dc50583cdfceac0c0b78ce7e4e8e1d26f4
-  data.tar.gz: 37e703dca9a9db80167e2750e77af20e59494a3fb1c0f208720e08ae2bb83a8e
+  metadata.gz: affb68a66ecbc1ee0e687ab13efb202037d10054adb114e684e775224957b65e
+  data.tar.gz: 255180d0be3704a73c0bf6e148658df8b662e33a4508dff3ae3fee819e73caba
 SHA512:
-  metadata.gz: 33ebaee09aff4d2cd32742566e1c3959c5f43558b6e3c57760936a31f8431af2806a8b6b8807da10588fbf2916de5e34857cc9ce5378b93d70099dd09b049d78
-  data.tar.gz: 1f733f0567064105528b480d47f766aa6acd9b2dd2766d011e11edeb542f3eea6233f2e30cb810d10f4e9412ab9548a186643072dd80414cf07b9aecc7189570
+  metadata.gz: 9f639386ccb6d003909737a4606b44f21cf49dc90b36fe0c854ea1e8c824049b2de7a70c480b44b2f4713558f21417c755361b6fccad4ed2f2af1068bc7cd135
+  data.tar.gz: a24d378627511c1198728a9aebe38c7f39cb057756e957906df29bf059804eef94d1188146b845842be42d94c559ebccd84b3d4d6a613b95a2a31d427771fe09

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-05-05 08:51:48 UTC using RuboCop version 1.59.0.
+# on 2024-08-07 02:24:58 UTC using RuboCop version 1.65.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
@@ -22,14 +22,14 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 145
+  Max: 149
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 142
+  Max: 141
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 7

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.7.2](https://github.com/BookingSync/operations/tree/v0.7.2)
+
+### Added
+
+- Allow referencing and arbitrary model attrbiute from form object attribute with `model_name: "Post#title"` [\#50](https://github.com/BookingSync/operations/pull/50) ([pyromaniac](https://github.com/pyromaniac))
+- Allow passing multiple `hydrators:` to Operations::Form [\#49](https://github.com/BookingSync/operations/pull/49) ([pyromaniac](https://github.com/pyromaniac))
+
+### Improvements
+
+- Change default form hydration behavior - it is now deep merging params after hydration, so no need to do it in the hydrator. Controlled with `hydration_merge_params:` option. [\#49](https://github.com/BookingSync/operations/pull/49) ([pyromaniac](https://github.com/pyromaniac))
+
 ## [0.7.1](https://github.com/BookingSync/operations/tree/v0.7.1)
 
 ### Added

data/README.md

@@ -312,7 +312,7 @@ class ActiveRecordRepository
   include Dry::Monads[:result]
   extend Dry::Initializer
 
-  param :model, type: Types.Instance(Class).constrained(lt: ActiveRecord::Base)
+  param :model, type: Types::Class.constrained(lt: ActiveRecord::Base)
 
   def create(**attributes)
     record = model.new(**attributes)
@@ -904,7 +904,7 @@ class Post::Update
   def self.default_form
     @default_form ||= Operations::Form.new(
       default,
-      hydrator: Post::Update::Hydrator.new
+      hydrators: [Post::Update::Hydrator.new]
     )
   end
 end
@@ -912,9 +912,7 @@ end
 class Post::Update::Hydrator
   def call(form_class, params, post:, **_context)
     value_attributes = form_class.attributes.keys - %i[post_id]
-    data = value_attributes.index_with { |name| post.public_send(name) }
-
-    data.merge!(params)
+    value_attributes.index_with { |name| post.public_send(name) }
   end
 end
 ```
@@ -929,14 +927,20 @@ class Post::Update
     @default_form ||= Operations::Form.new(
       default,
       model_map: Post::Update::ModelMap.new,
-      hydrator: Post::Update::Hydrator.new
+      hydrators: [Post::Update::Hydrator.new]
     )
   end
 end
 
 class Post::Update::ModelMap
-  def call(_path)
-    Post
+  MAPPING = {
+    %w[published_at] => Post, # a model can be passed but beware of circular dependencies, better use strings
+    %w[title] => "Post", # or a model name - safer option
+    %w[content] => "Post#body" # referencing different attribute is possible, useful for naming migration or translations
+  }.freeze
+
+  def call(path)
+    MAPPING[path] # returns the mapping for a single path
   end
 end
 ```

data/UPGRADING_FORMS.md

@@ -31,7 +31,7 @@ class Post::Update
   def self.default_form
     @default_form ||= Operations::Form.new(
       default,
-      hydrator: Post::Update::Hydrator.new,
+      hydrators: [Post::Update::Hydrator.new],
       model_map: Post::Update::ModelMap.new,
       params_transformations: [
         ParamsMap.new(id: :post_id)

data/lib/operations/command.rb

@@ -197,6 +197,11 @@ class Operations::Command
     result_policies = policies_sum - [Undefined] unless policies_sum == [Undefined, Undefined]
     options[:policies] = result_policies if result_policies
 
+    if after.present?
+      ActiveSupport::Deprecation.new.warn("Operations::Command `after:` option is deprecated and will be " \
+        "removed in 1.0.0. Please use `on_success:` instead")
+    end
+
     preconditions.push(precondition) if precondition.present?
     super(operation, preconditions: preconditions, on_success: after, **options)
   end

data/lib/operations/form/attribute.rb

@@ -5,39 +5,35 @@
 # legacy UI.
 class Operations::Form::Attribute
   extend Dry::Initializer
-  include Dry::Equalizer(:name, :collection, :model_name, :form)
-  include Operations::Inspect.new(:name, :collection, :model_name, :form)
+  include Dry::Equalizer(:name, :collection, :model_class, :model_attribute, :form)
+  include Operations::Inspect.new(:name, :collection, :model_class, :model_attribute, :form)
 
   param :name, type: Operations::Types::Coercible::Symbol
   option :collection, type: Operations::Types::Bool, default: proc { false }
-  option :model_name,
-    type: (Operations::Types::String | Operations::Types.Instance(Class).constrained(lt: ActiveRecord::Base)).optional,
-    default: proc {}
+  option :model_name, type: (Operations::Types::String | Operations::Types::Class).optional, default: proc {}
   option :form, type: Operations::Types::Class.optional, default: proc {}
 
-  def model_type
-    @model_type ||= owning_model.type_for_attribute(string_name) if model_name
-  end
+  def model_class
+    return @model_class if defined?(@model_class)
 
-  def model_human_name(options = {})
-    owning_model.human_attribute_name(string_name, options) if model_name
+    @model_class = model_name.is_a?(String) ? model_name.split("#").first.constantize : model_name
   end
 
-  def model_validators
-    @model_validators ||= model_name ? owning_model.validators_on(string_name) : []
-  end
+  def model_attribute
+    return @model_attribute if defined?(@model_attribute)
 
-  def model_localized_attr_name(locale)
-    owning_model.localized_attr_name_for(string_name, locale) if model_name
+    @model_attribute = model_class && (model_name.to_s.split("#").second.presence || name.to_s)
   end
 
-  private
+  def model_type
+    model_class.type_for_attribute(model_attribute) if model_name
+  end
 
-  def owning_model
-    @owning_model ||= model_name.is_a?(String) ? model_name.constantize : model_name
+  def model_human_name(options = {})
+    model_class.human_attribute_name(model_attribute, options) if model_name
   end
 
-  def string_name
-    @string_name ||= name.to_s
+  def model_validators
+    model_name ? model_class.validators_on(model_attribute) : []
   end
 end

data/lib/operations/form/base.rb

@@ -50,7 +50,13 @@ class Operations::Form::Base
       base.class_attribute :persisted, instance_accessor: false, default: nil
 
       base.define_method :initialize do |*args, **kwargs|
-        args.empty? && kwargs.present? ? super(kwargs, **{}) : super(*args, **kwargs)
+        if args.empty?
+          # Initializing Operations::Form::Base instance
+          super(kwargs, **{})
+        else
+          # Initializing Operations::Form instance as form object (deprecated)
+          super(*args, **kwargs)
+        end
       end
     end
 
@@ -83,12 +89,13 @@ class Operations::Form::Base
 
   # :nodoc:
   module InstanceMethods
-    def type_for_attribute(name)
-      self.class.attributes[name.to_sym].model_type
+    # Copied from globalize-accessors, should be deprecated and removed as it is not a core method
+    def localized_attr_name_for(attr_name, locale)
+      "#{attr_name}_#{locale.to_s.underscore}"
     end
 
-    def localized_attr_name_for(name, locale)
-      self.class.attributes[name.to_sym].model_localized_attr_name(locale)
+    def type_for_attribute(name)
+      self.class.attributes[name.to_sym].model_type
     end
 
     def has_attribute?(name) # rubocop:disable Naming/PredicateName

data/lib/operations/form.rb

@@ -21,8 +21,10 @@
 #
 class Operations::Form
   include Dry::Core::Constants
-  include Dry::Equalizer(:command, :model_map, :persisted, :params_transformations, :hydrator, :form_class)
-  include Operations::Inspect.new(:model_name, :model_map, :persisted, :params_transformations, :hydrator, :form_class)
+  include Dry::Equalizer(:command, :model_map, :persisted,
+    :params_transformations, :hydrators, :hydration_merge_params, :form_class)
+  include Operations::Inspect.new(:model_name, :model_map, :persisted,
+    :params_transformations, :hydrators, :hydration_merge_params, :form_class)
 
   # We need to make deprecated inheritance from Operations::Form act exactly the
   # same way as from Operations::Form::Base. In order to do this, we are encapsulating all the
@@ -51,10 +53,17 @@ class Operations::Form
     option :persisted, type: Operations::Types::Bool, default: proc { true }
     option :params_transformations, type: Operations::Types::Coercible::Array.of(Operations::Types.Interface(:call)),
       default: proc { [] }
-    option :hydrator, type: Operations::Types.Interface(:call).optional, default: proc {}
+    option :hydrators, type: Operations::Types::Array.of(Operations::Types.Interface(:call)), default: proc { [] }
+    option :hydration_merge_params, type: Operations::Types::Bool, default: proc { true }
     option :base_class, type: Operations::Types::Class, default: proc { ::Operations::Form::Base }
   end)
 
+  def initialize(command, hydrator: nil, hydrators: [], **options)
+    hydrators.push(hydrator) if hydrator.present?
+
+    super(command, hydrators: hydrators, **options)
+  end
+
   def build(params = EMPTY_HASH, **context)
     instantiate_form(command.callable(transform_params(params, **context), **context))
   end
@@ -81,12 +90,20 @@ class Operations::Form
 
   def instantiate_form(operation_result)
     form_class.new(
-      hydrator&.call(form_class, operation_result.params, **operation_result.context) || {},
+      hydrate_params(form_class, operation_result.params, **operation_result.context),
       messages: operation_result.errors.to_h,
       operation_result: operation_result
     )
   end
 
+  def hydrate_params(form_class, params, **context)
+    hydrated_params = hydrators.inject({}) do |value, hydrator|
+      value.merge(hydrator.call(form_class, params, **context).deep_symbolize_keys)
+    end
+    hydrated_params.deep_merge!(params) if hydration_merge_params
+    hydrated_params
+  end
+
   def key_map
     @key_map ||= command.contract.schema.key_map
   end

data/lib/operations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Operations
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operations
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Arkadiy Zabazhanov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal