active_record_compose 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff1c2fd72a225a89ada1c0cab86b6d32f31c0052d8857e665eb2796f4a40883
-  data.tar.gz: 307e8ecf50282b9a19e224870796944de47d37f8802d0ffe63cca465eb663cc4
+  metadata.gz: 6693618ddc81944ece9c991f800ba8ce1ef5b7f462b13bfe0c9f4b03b04bdc6f
+  data.tar.gz: 36cc7ec0a5852c409dab736d21058f2538c3a656e893d37a7ec8bf2ae499f2cb
 SHA512:
-  metadata.gz: 12f503a644d60932a095a587e8152d37af25b8eccfb0cc5cd32dc5941eb896104880328ff6e3ed2b7fd53ee78fad9f7962e23b5ffc1070bbaa00518e482dccf4
-  data.tar.gz: 91d912f794a250e44e8ad5fea2694f00a52eb98df3f217364e8eb637a6971692998526e86c2d908dc28ce7b0ff99ada394ca287b39342714377af63a1869c4be
+  metadata.gz: 2780e3749043f5667bcd1a693c248f0c3f2378f7cb8d221f636ada171ab4c5b03c7baa2c479e381ab73570352fabd5c1fb623d9d3ca79b8718919bbe77f5fffe
+  data.tar.gz: 4f6eec237d85851c0eb6041dacb2ea8c2000c431bfe4c632e11647e3009a0d9745bcb572b492ff71e07baa03c298faecb9406d76b939468f0d21cb4315c3eb04

data/.rubocop.yml

@@ -3,6 +3,9 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
 
+Style/ArgumentsForwarding:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-01-21
+
+- add i18n doc.
+- add sig/
+- add typecheck for ci.
+
+## [0.1.8] - 2024-01-16
+
+- avoid executing `#save!` from `Model#save`
+- on save, ignore nil elements from models.
+
 ## [0.1.7] - 2024-01-15
 
 - remove `add_development_dependency` from gemspec

data/README.md

@@ -271,6 +271,30 @@ model.update
 # after_save called!
 ```
 
+### I18n
+
+When the `#save!` operation raises an `ActiveRecord::RecordInvalid` exception, it is necessary to have pre-existing locale definitions in order to construct i18n information correctly.
+The specific keys required are `activemodel.errors.messages.record_invalid` or `errors.messages.record_invalid`.
+
+(Replace `en` as appropriate in the context.)
+
+```yaml
+en:
+  activemodel:
+    errors:
+      messages:
+        record_invalid: 'Validation failed: %{errors}'
+```
+
+Alternatively, the following definition is also acceptable:
+
+```yaml
+en:
+  errors:
+    messages:
+      record_invalid: 'Validation failed: %{errors}'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/active_record_compose/delegate_attribute.rb

@@ -63,7 +63,11 @@ module ActiveRecordCompose
     #
     # @return [Hash] hash with the attribute name as key and the attribute value as value.
     def attributes
-      (defined?(super) ? super : {}).merge(delegated_attributes.to_h { [_1, public_send(_1)] })
+      # steep:ignore all
+      attrs = defined?(super) ? super : {}
+      # steep:ignore end
+      # @type var attrs: Hash[String, untyped]
+      attrs.merge(delegated_attributes.to_h { [_1, public_send(_1)] })
     end
   end
 end

data/lib/active_record_compose/inner_model.rb

@@ -16,7 +16,8 @@ module ActiveRecordCompose
 
     # @return [Symbol] :save or :destroy
     def context
-      ret = @context.respond_to?(:call) ? @context.call(model) : @context
+      c = @context
+      ret = c.is_a?(Proc) ? c.call(model) : c
       ret.presence_in(%i[save destroy]) || :save
     end
 

data/lib/active_record_compose/inner_model_collection.rb

@@ -73,7 +73,7 @@ module ActiveRecordCompose
     def __each_by_wrapped
       return enum_for(:__each_by_wrapped) unless block_given?
 
-      models.each { yield _1 }
+      models.each { yield _1 if _1.__raw_model }
       self
     end
 

data/lib/active_record_compose/model.rb

@@ -19,7 +19,9 @@ module ActiveRecordCompose
     validate :validate_models
 
     def initialize(attributes = {})
+      # steep:ignore all
       super(attributes)
+      # steep:ignore end
     end
 
     # Save the models that exist in models.
@@ -31,7 +33,7 @@ module ActiveRecordCompose
     def save
       return false if invalid?
 
-      save_in_transaction { save_models }
+      save_in_transaction { save_models(bang: false) }
     end
 
     # Save the models that exist in models.
@@ -42,7 +44,7 @@ module ActiveRecordCompose
     def save!
       valid? || raise_validation_error
 
-      save_in_transaction { save_models } || raise_on_save_error
+      save_in_transaction { save_models(bang: true) } || raise_on_save_error
     end
 
     # Behavior is same to `#save`, but `before_create` and `after_create` hooks fires.
@@ -74,7 +76,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       return false if invalid?
 
-      save_in_transaction { run_callbacks(:create) { save_models } }
+      save_in_transaction { run_callbacks(:create) { save_models(bang: false) } }
     end
 
     # Behavior is same to `#create`, but raises an exception prematurely on failure.
@@ -83,7 +85,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       valid? || raise_validation_error
 
-      save_in_transaction { run_callbacks(:create) { save_models } } || raise_on_save_error
+      save_in_transaction { run_callbacks(:create) { save_models(bang: true) } } || raise_on_save_error
     end
 
     # Behavior is same to `#save`, but `before_update` and `after_update` hooks fires.
@@ -115,7 +117,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       return false if invalid?
 
-      save_in_transaction { run_callbacks(:update) { save_models } }
+      save_in_transaction { run_callbacks(:update) { save_models(bang: false) } }
     end
 
     # Behavior is same to `#update`, but raises an exception prematurely on failure.
@@ -124,7 +126,7 @@ module ActiveRecordCompose
       assign_attributes(attributes)
       valid? || raise_validation_error
 
-      save_in_transaction { run_callbacks(:update) { save_models } } || raise_on_save_error
+      save_in_transaction { run_callbacks(:update) { save_models(bang: true) } } || raise_on_save_error
     end
 
     private
@@ -149,7 +151,7 @@ module ActiveRecordCompose
       end.present?
     end
 
-    def save_models = wrapped_models.all? { _1.save! }
+    def save_models(bang:) = wrapped_models.all? { bang ? _1.save! : _1.save }
 
     def raise_validation_error = raise ActiveRecord::RecordInvalid, self
 

data/lib/active_record_compose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordCompose
-  VERSION = '0.1.7'
+  VERSION = '0.2.0'
 end

data/sig/active_record_compose.rbs

@@ -0,0 +1,100 @@
+# TypeProf 0.21.9
+
+# Classes
+module ActiveRecordCompose
+  VERSION: String
+
+  interface _ARLike
+    def is_a?: (untyped) -> bool
+    def save: -> bool
+    def save!: -> untyped
+    def destroy: -> bool
+    def destroy!: -> untyped
+    def invalid?: -> bool
+    def valid?: -> bool
+    def errors: -> untyped
+    def ==: (untyped) -> bool
+  end
+
+  type attribute_name = (String | Symbol)
+  type context_types = (:save | :destroy)
+  type context_proc = ^(_ARLike) -> context_types
+  type context = context_types | context_proc
+
+  module DelegateAttribute
+    extend ActiveSupport::Concern
+
+    def delegated_attribute: -> Array[untyped]
+    def attributes: -> Hash[String, untyped]
+    def delegated_attributes: -> Array[untyped]
+    def delegated_attributes=: (Array[untyped]) -> void
+
+    def self.class_attribute: (untyped, ?untyped) -> untyped
+    def delegate: (*untyped) -> untyped
+  end
+
+  class InnerModelCollection
+    include ::Enumerable[_ARLike]
+    @models: Array[InnerModel]
+
+    def each: () { (_ARLike) -> void } -> InnerModelCollection | () -> Enumerator[_ARLike, self]
+    def <<: (_ARLike) -> self
+    def push: (_ARLike, ?context: context) -> self
+    def empty?: -> bool
+    def clear: -> self
+    def delete: (_ARLike | InnerModel, ?context: context_types) -> InnerModelCollection?
+    def __each_by_wrapped: () { (InnerModel) -> void } -> InnerModelCollection | () -> Enumerator[InnerModel, self]
+
+    private
+    def models: -> Array[InnerModel]
+    def wrap: (_ARLike | InnerModel, context: context) -> InnerModel
+  end
+
+  class InnerModel
+    @context: context
+
+    def initialize: (_ARLike, ?context: context) -> void
+    def context: -> context
+    def save: -> bool
+    def save!: -> untyped
+    def invalid?: -> bool
+    def valid?: -> bool
+    def ==: (untyped) -> bool
+    def __raw_model: -> _ARLike
+
+    private
+    attr_reader model: _ARLike
+  end
+
+  class Model
+    extend ActiveModel::Callbacks
+    include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
+    include ActiveModel::Attributes
+    include ActiveRecord::Transactions
+    include DelegateAttribute
+
+    @__models: InnerModelCollection
+
+    def initialize: (?Hash[attribute_name, untyped]) -> void
+    def save: -> bool
+    def save!: -> untyped
+    def create: (?Hash[attribute_name, untyped]) -> bool
+    def create!: (?Hash[attribute_name, untyped]) -> untyped
+    def update: (?Hash[attribute_name, untyped]) -> bool
+    def update!: (?Hash[attribute_name, untyped]) -> untyped
+
+    private
+    def models: -> InnerModelCollection
+    def wrapped_models: -> Enumerator[InnerModel, InnerModelCollection]
+    def validate_models: -> void
+    def save_in_transaction: { -> bool } -> untyped
+    def save_models: (bang: bool) -> bool
+    def raise_validation_error: -> bot
+    def raise_on_save_error: -> bot
+    def raise_on_save_error_message: -> String
+
+    def self.validate: (*untyped) -> untyped
+    def run_callbacks: (untyped kind) ?{ () -> untyped } -> untyped
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_compose
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - hamajyotan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-14 00:00:00.000000000 Z
+date: 2024-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -37,13 +37,13 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/active_record_compose.rb
 - lib/active_record_compose/delegate_attribute.rb
 - lib/active_record_compose/inner_model.rb
 - lib/active_record_compose/inner_model_collection.rb
 - lib/active_record_compose/model.rb
 - lib/active_record_compose/version.rb
+- sig/active_record_compose.rbs
 homepage: https://github.com/hamajyotan/active_record_compose
 licenses:
 - MIT
@@ -51,7 +51,7 @@ metadata:
   homepage_uri: https://github.com/hamajyotan/active_record_compose
   source_code_uri: https://github.com/hamajyotan/active_record_compose
   changelog_uri: https://github.com/hamajyotan/active_record_compose/blob/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.1.7
+  documentation_uri: https://www.rubydoc.info/gems/active_record_compose/0.2.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: activemodel form object pattern

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]