tramway 0.4 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68a5dd780d7427b0c2075f140c891af3a4c33210c88a00d86e33279dc27e6c28
-  data.tar.gz: 63701d608f5545ea95e98fac522624cc34092199fe839b16ba579d9c461c0383
+  metadata.gz: 9c08642e343cc49c4a282e4b8ae7741c9ecce0aa1aeaf2c345cfe1bd4c1770e4
+  data.tar.gz: 5e077f0ddad19fad81e7b575a473958d0ecbadf48914a37ee6885775538a7880
 SHA512:
-  metadata.gz: 8e6c295607acc32db6b7a0bea211ddb9ba2d8e2ca141804bce78b7b51fb74a08478c38ead05962f56ecd226a57b2e7398b97c86ac6dcc7aa46c3862bd8a49f30
-  data.tar.gz: bd89050c6d5b3391f457eea7a277cdaaa53c3fbe1f20a0567c39b659ab8a3187d2f161bed38a6b9226782191b884fe94eb63d7e7f8aa292e8ff121dcf149c521
+  metadata.gz: 0106dd32bbd48209be6aae488811d589266b5c485bb05bd4da483bf757bc9469933820472445c0fdd807d9c7cde21edf5e36db5a83f9f61dbbc38fbe5d523855
+  data.tar.gz: 1f534e4b5bc44dd6f532897042cd53d6385c1e55578281fe10172235ca5695dfa5f5acb2b5dc14849946f47256e5eda69f375f6d0e54163e7d2f291aa9f4f83c

data/README.md

@@ -134,9 +134,7 @@ Tramway provides **convenient** form objects for Rails applications. List proper
 class UserForm < Tramway::BaseForm
   properties :email, :password, :first_name, :last_name, :phone
 
-  def password=(value)
-    object.password = value if value.present?
-  end
+  normalizes :email, ->(value) { value.strip.downcase }
 end
 ```
 
@@ -249,6 +247,45 @@ class Admin::UsersController < Admin::ApplicationController
 end
 ```
 
+### Normalizes
+
+Tramway Form supports `normalizes` method. It's almost the same [as in Rails](https://edgeapi.rubyonrails.org/classes/ActiveRecord/Normalization.html)
+
+```ruby
+class UserForm < Tramway::BaseForme
+  properties :email, :first_name, :last_name
+  
+  normalizes :email, with: ->(value) { value.strip.downcase }
+  normalizes :first_name, :last_name, with: ->(value) { value.strip }
+end
+```
+
+`normalizes` method arguments:
+* `*properties` - collection of properties that will be normalized
+* `with:` - a proc with a normalization
+* `apply_on_nil` - by default is `false`. When `true` Tramway Form applies normalization on `nil` values
+
+### Form inheritance
+
+Tramway Form supports inheritance of `properties` and `normalizations`
+
+**Example**
+
+```ruby
+class UserForm < TramwayForm
+  properties :email, :password
+
+  normalizes :email, with: ->(value) { value.strip.downcase }
+end
+
+class AdminForm < UserForm
+  properties :permissions
+end
+
+AdminForm.properties # returns [:email, :password, :permissions]
+AdminForm.normalizations # contains the normalization of :email 
+```
+
 ### Make flexible and extendable forms
 
 Tramway Form properties are not mapped to a model. You're able to make extended forms.
@@ -256,12 +293,7 @@ Tramway Form properties are not mapped to a model. You're able to make extended
 *app/forms/user_form.rb*
 ```ruby
 class UserForm < Tramway::BaseForm
-  properties :email, :password, :full_name
-
-  # RULE: in case password is empty, don't save
-  def password=(value)
-    object.password = value if value.present?
-  end
+  properties :email, :full_name
 
   # EXTENDED FIELD: full name
   def full_name=(value)

data/lib/tramway/base_form.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
+require 'tramway/forms/properties'
+require 'tramway/forms/normalizations'
+
 module Tramway
   # Provides form object for Tramway
   #
   class BaseForm
+    include Tramway::Forms::Properties
+    include Tramway::Forms::Normalizations
+
     attr_reader :object
 
     %i[model_name to_key to_model errors attributes].each do |method_name|
@@ -17,21 +23,11 @@ module Tramway
     end
 
     class << self
-      def property(attribute, _proc_obj = nil)
-        @properties ||= []
-        @properties << attribute
-
-        delegate attribute, to: :object
-      end
+      def inherited(subclass)
+        __initialize_properties subclass
+        __initialize_normalizations subclass
 
-      def properties(*attributes)
-        if attributes.any?
-          attributes.each do |attribute|
-            property(attribute)
-          end
-        else
-          @properties || []
-        end
+        super
       end
     end
 
@@ -66,9 +62,7 @@ module Tramway
     private
 
     def __submit(params)
-      self.class.properties.each do |attribute|
-        public_send("#{attribute}=", params[attribute]) if params.keys.include? attribute.to_s
-      end
+      __apply_properties __apply_normalizations params
     end
 
     def __object

data/lib/tramway/forms/normalizations.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Forms
+    # This is the same `normalizes` feature like in Rails
+    # https://api.rubyonrails.org/v7.1/classes/ActiveRecord/Normalization/ClassMethods.html#method-i-normalizes
+    module Normalizations
+      # A collection of methods that would be using in users forms
+      module ClassMethods
+        # :reek:BooleanParameter { enabled: false }
+        def normalizes(*attributes, with:, apply_to_nil: false)
+          attributes.each do |attribute|
+            @normalizations.merge!(attribute => { proc: with, apply_to_nil: })
+          end
+        end
+
+        def normalizations
+          __ancestor_normalizations.merge(@normalizations)
+        end
+
+        # :reek:ManualDispatch { enabled: false }
+        def __ancestor_normalizations(klass = superclass)
+          superklass = klass.superclass
+
+          return {} unless superklass.respond_to?(:normalizations)
+
+          klass.normalizations.merge!(__ancestor_normalizations(superklass))
+        end
+
+        # :reek:UtilityFunction { enabled: false }
+        def __initialize_normalizations(subclass)
+          subclass.instance_variable_set(:@normalizations, {})
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      def __apply_normalizations(params)
+        self.class.normalizations.reduce(params) do |hash, (attribute, normalization)|
+          if hash.key?(attribute) || normalization[:apply_to_nil]
+            hash.merge(attribute => instance_exec(hash[attribute], &normalization[:proc]))
+          else
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tramway/forms/properties.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Forms
+    # This is `properties`. The main feature of Tramway Form
+    module Properties
+      # A collection of methods that would be using in users forms
+      module ClassMethods
+        def property(attribute)
+          @properties << attribute
+
+          delegate attribute, to: :object
+        end
+
+        def properties(*attributes)
+          attributes.any? ? __set_properties(attributes) : __properties
+        end
+
+        def __set_properties(attributes)
+          attributes.each do |attribute|
+            property(attribute)
+          end
+        end
+
+        def __properties
+          (__ancestor_properties + @properties).uniq
+        end
+
+        # :reek:ManualDispatch { enabled: false }
+        def __ancestor_properties(klass = superclass)
+          superklass = klass.superclass
+
+          return [] unless superklass.respond_to?(:properties)
+
+          klass.properties + __ancestor_properties(superklass)
+        end
+
+        # :reek:UtilityFunction { enabled: false }
+        def __initialize_properties(subclass)
+          subclass.instance_variable_set(:@properties, [])
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      def __apply_properties(params)
+        self.class.properties.each do |attribute|
+          public_send("#{attribute}=", params[attribute]) if params.key?(attribute)
+        end
+      end
+    end
+  end
+end

data/lib/tramway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tramway
-  VERSION = '0.4'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.2
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-20 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -126,6 +126,8 @@ files:
 - lib/tramway/decorators/collection_decorator.rb
 - lib/tramway/engine.rb
 - lib/tramway/forms/class_helper.rb
+- lib/tramway/forms/normalizations.rb
+- lib/tramway/forms/properties.rb
 - lib/tramway/helpers/decorate_helper.rb
 - lib/tramway/helpers/form_helper.rb
 - lib/tramway/helpers/navbar_helper.rb