application_form 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05c6c488f4f25253c2fb3889eda3776207218a8a1bfb7101b18e9fc38fc5e663
-  data.tar.gz: e8c073b39558f58391202b6d7353cc4be57e7c4df01987f31b1b624012fd010f
+  metadata.gz: b81f5d6a05cf8fcfabc3714481407e04d5ee752c6dced927000764de369b7172
+  data.tar.gz: e72b208fadad3073246fd8feb0819af6efefa87738930d7cab21e65913da423f
 SHA512:
-  metadata.gz: e174c55c53544fd420808519c705f546fe166a44965c279a09ac25ccbd52c47e09329c06031aa3f1e143987400678322f870fa5736717f68c7397f7579097b86
-  data.tar.gz: d1f64700776c503711dc40a6ee4530963058cac534bfd49473a5567c01b2bda117b375f223eeedb434196ee3fb2275ca35db7ad6c165f7ee3da14138383f6552
+  metadata.gz: 0cff5090a0feb65b5d2f243262f8679b47478a3407e8a957690f7d182ff45ecbe71292be1fd7d27af0558cb8a79182dd938c161697f1002095f5d3dbd99263ae
+  data.tar.gz: 290f830403a64539fc3f0bf7c9119ae3c0c9aca4627d4aa2bb363179064f2330d61de204a9feaf7071fca1b3e7f980fc32dfb01ed3423cfb4b70de271c56e2d5

data/Makefile

@@ -16,4 +16,7 @@ release:
 build:
 	bundle exec rake build
 
+push:
+	git push origin master
+
 .PHONY: test

data/README.md

@@ -41,7 +41,7 @@ or with namespace model
 
     $ rails g application_form:form admin_post --model=blog/post
 
-### Example
+### Basic usage
 
 ```ruby
 # app/forms/user_sign_up_form.rb
@@ -66,13 +66,63 @@ class UserSignUpForm < User
 end
 ```
 
-In some cases it is necessary to use ActiveRecord object directly without form. For such cases conveniently to use method `become()` (built-in ActiveRecord):
+```
+form = UserSignUpForm.new(user_params)
+form.valid?
+```
+
+### Usage with `becomes`
+
+In some cases it is necessary to use ActiveRecord object directly without form. For such cases conveniently to use method `becomes()` (built-in ActiveRecord):
 
 ```ruby
 user = User.find(params[:id])
 form = user.becomes(UserSignUpForm)
 ```
 
+### Checks
+
+Checks are build on top of Rails validations. They are semantically separated from validations, because we treat them as business logic checks, not as data validation.
+
+```ruby
+class ReservationCreateForm < Reservation
+  include ApplicationForm
+
+  permit :user_id, :vehicle_id, :start_at, :end_at, :pickup_location_id, :return_location_id
+
+  check :max_number_of_reservations_reached, ->(form) { !form.user&.reservations_limit_reached? }
+  check :car_is_on_maintenance, ->(form) { form.vehicle&.reservable? }
+end
+
+# In controller:
+form = ReservationCreateForm.new(prepared_params)
+
+if form.checks_passed?
+  # ...
+else
+  render_error!(form.first_failed_check) # form.first_failed_check returns "reservation.error.max_number_of_reservations_reached"
+end
+```
+
+You can also assign check to a specific field:
+
+```ruby
+check :end_at_must_be_greater_then_start_at, ->(form) { form.end_at > form.start_at }, :end_at
+```
+
+In this case it will work as a regular validation.
+
+### `assign_attrs`
+
+It works as regular `assign_attributes` but it also returns the object, so that you can chain it:
+
+```ruby
+form = current_user.becomes(UserApplyReferralProgramForm)
+                   .assign_attrs(registration_referral_code: referral_code)
+```
+
+It is a usual pattern when you use for in `#update` action.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/application_form.rb

@@ -24,9 +24,8 @@ module ApplicationForm
   module ClassMethods
     delegate :sti_name, to: :superclass
     delegate :human_attribute_name, to: :superclass
-    # NOTE: too many side effects if it is enabled
-    # examples: form names, translations
-    # delegate :name, to: :superclass
+    # NOTE: Controvertial thing. More details: https://github.com/Hexlet/active_form_model/issues/10
+    delegate :name, to: :superclass
 
     def permit(*args)
       @_permitted_args = args
@@ -35,6 +34,16 @@ module ApplicationForm
     def _permitted_args
       @_permitted_args || (superclass.respond_to?(:_permitted_args) && superclass._permitted_args) || []
     end
+
+    def check(key, block, field = :base)
+      validate do |form|
+        if !block.call(form)
+          entity_name = self.class.superclass.to_s.tableize.split('/').last.singularize
+          full_key = "#{entity_name}.errors.#{key}"
+          form.add_error_key(field, full_key)
+        end
+      end
+    end
   end
 
   def update(attrs = {})
@@ -55,4 +64,22 @@ module ApplicationForm
   def permit_attrs(attrs)
     attrs.respond_to?(:permit) ? attrs.send(:permit, self.class._permitted_args) : attrs
   end
+
+  def first_error_message
+    errors&.full_messages&.first
+  end
+
+  def checks_passed?
+    valid?
+  end
+
+  def first_failed_check
+    errors.details[:base].first[:error].to_s
+  end
+
+  def assign_attrs(attrsibutes)
+    attrs = ActiveSupport::HashWithIndifferentAccess.new(attributes)
+    assign_attributes(attrs)
+    self
+  end
 end

data/lib/application_form/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApplicationForm
-  VERSION = '0.4.0'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: application_form
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Kirill Mokevnin