attribeauty 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d41ac9aebcbb1c28b939ef7c8da19280dac7135655bc9b8fdab6758aad4a76e8
-  data.tar.gz: eaabafa87e2315bb7ea25debb7b915dfcc7e200c07b556274ee1aa73c4b4fbc3
+  metadata.gz: a594dd2b01526d1b89bea9ceeea3217bf0cb311b236981be2e77bd03dc1b5b2f
+  data.tar.gz: 4f79df9cca230c2c0c29c34746f381818535095383c54902e8a7b90f8ea205de
 SHA512:
-  metadata.gz: 844f5020c04d41dc2d9ce9fc67e678b66a2cfb1722e98ac9dbee57a01d0bfd7269ac4f939194661e6fa87646cc363358f4e791efedfc04b40036bc447837a804
-  data.tar.gz: fcaf05b3f5f450862d664d5419e4375b3419d6d2e6b9ce625aa71517bc314f466eee3b713a7f931d93f5c5dbbb18998351059acd03ba90138f4d71161d1910cf
+  metadata.gz: 4ab16692f1f34715726b3777889c5ee4f1797eeff0431ce73a116c7e02c5faac34d0453188f2469938b1c98076e172dd37e5b18a5a2c1bff009bb483c067a984
+  data.tar.gz: 78f5e064bc51b85fbb57877ce9bd9a7d3894f7798fdfd7dcfe0dc7989fad2618f3d0358e22467d02351745710b92e81227f6b243a74254e90d377be474b1655a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.4.1] - 2024-06-25
+
+- Global default_args in accept, to apply your conditions to all attributes
+
 ## [0.4.0] - 2024-06-25
 
 - Breaking change:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attribeauty (0.4.0)
+    attribeauty (0.4.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -191,6 +191,43 @@ end
 
 ```
 
+what if you want to require all attributes? If you pass the `required: true` or `exclude_if: :nil?` with the `accept`, it will be applied to all attributes. 
+
+```
+class MyController
+  def update
+    MyRecord.update(update_params)
+   
+    redirect_to index_path
+  end
+
+  private
+
+  # your params look like this:
+  # { user: { profile: [{ address: { street_name: "Main St" } }] } }
+  #
+  def params_filter
+    Attribeauty::Params.with(request.params)
+  end
+
+  # exclude_if and required will be passed onto all attributes
+  #
+  def update_params
+    params_filter.accept exclude_if: :nil?, required: true do
+      container :user do
+        attribute :title, :string, 
+        attribute :email do
+          attribute :address, :string
+          attribute :valid, :boolean
+          attribute :ip_address, :string
+        end
+      end
+    end
+  end
+end
+
+```
+
 See `test/test_params.rb` for more examples
 
 

data/lib/attribeauty/params.rb

@@ -10,15 +10,16 @@ module Attribeauty
       new(request_params)
     end
 
-    attr_reader :prefix, :request_params, :acceptables, :to_h, :errors, :strict
+    attr_reader :prefix, :request_params, :acceptables, :to_h, :errors, :strict, :default_args
 
     def initialize(request_params)
-      @request_params = request_params.transform_keys(&:to_sym)
+      @request_params = (request_params || {}).transform_keys(&:to_sym)
       @to_h = {}
       @errors = []
     end
 
-    def accept(&)
+    def accept(**args, &)
+      @default_args = args
       instance_eval(&)
 
       raise MissingAttributeError, errors.join(", ") if errors.any? && strict?
@@ -26,10 +27,10 @@ module Attribeauty
       self
     end
 
-    def accept!(&)
+    def accept!(**args, &)
       @strict = true
 
-      accept(&)
+      accept(**args, &)
     end
 
     def to_hash = to_h
@@ -47,7 +48,6 @@ module Attribeauty
     # 
     def attribute(name, type = nil, **args, &block)
       value = request_params[name]
-      return if required?(value, **args)
       return hash_from_nested(name, value, &block) if block_given?
 
       value_from_validator(name, value, type, **args)
@@ -67,29 +67,28 @@ module Attribeauty
 
     private
 
-    def required?(value, **args)
-      value.nil? && args[:required].nil?
-    end
-
     def value_from_validator(name, value, type, **args)
-      validator = Validator.run(name, value, type, **args)
+      merged_args = args.merge(default_args || {})
+      validator = Validator.run(name, value, type, **merged_args)
       @errors.push(*validator.errors)
       @to_h[name.to_sym] = validator.value if validator.valid?
     end
 
     def hash_from_nested(name, value, &block)
-      @to_h[name.to_sym] = 
+      result = 
         if value.is_a?(Array)
           value.map do |val|
-            params = self.class.with(val).accept(&block)
+            params = self.class.with(val).accept(**default_args, &block)
             @errors.push(*params.errors)
             params.to_h
           end.reject(&:empty?)
         else
-          params = self.class.with(value).accept(&block)
+          params = self.class.with(value).accept(**default_args, &block)
           @errors.push(*params.errors)
           params.to_h
       end
+
+      @to_h[name.to_sym] = result unless result.empty?
     end
   end
 end

data/lib/attribeauty/validator.rb

@@ -13,7 +13,8 @@ module Attribeauty
       @type = type
       @original_val = original_val
       @default = args[:default]
-      @required = args[:required] if args[:required] == true
+      args.delete_if { |key, value| key == :required && value == false }
+      @required = args[:required]
       @excludes = args[:exclude_if]
 
       @valid = true
@@ -21,15 +22,16 @@ module Attribeauty
     end
 
     def run
-      if type.nil?
-        @value = original_val
-      else
-        set_default
-        cast_value
-        handle_missing_required
-        handle_excludes
-      end
+      handle_missing_original_val!
+      handle_missing_required!
+      handle_missing_type
 
+      set_default
+      cast_value
+      handle_excludes
+
+      self
+    rescue ValueInvalidError
       self
     end
 
@@ -37,24 +39,40 @@ module Attribeauty
       valid
     end
 
-    private
+    def required?
+      required
+    end
 
-    def set_default
-      return unless original_val.nil? && !default.nil?
+    private
 
-      @original_val = default
-    end
+    def handle_missing_original_val!
+      return unless !required? && original_val.nil?
 
-    def cast_value
-      @value = TypeCaster.run(original_val, type)
+      @valid = false 
+      raise ValueInvalidError
     end
 
     # only returning errors if required is missing, not if nil?, or :empty?
-    def handle_missing_required
+    def handle_missing_required!
       return unless required? && original_val.nil?
 
       errors << "#{name} required"
       @valid = false
+      raise ValueInvalidError
+    end
+
+    def handle_missing_type
+      @value = original_val if type.nil?
+    end
+
+    def set_default
+      return unless original_val.nil? && !default.nil?
+
+      @original_val = default
+    end
+
+    def cast_value
+      @value ||= TypeCaster.run(original_val, type)
     end
 
     def handle_excludes
@@ -62,9 +80,5 @@ module Attribeauty
 
       @valid = ![*excludes].flatten.any? { |exclude| value.public_send(exclude) }
     end
-
-    def required?
-      required
-    end
   end
 end

data/lib/attribeauty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Attribeauty
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/attribeauty.rb

@@ -8,6 +8,7 @@ require "forwardable"
 module Attribeauty
   class Error < StandardError; end
   class MissingAttributeError < StandardError; end
+  class ValueInvalidError < StandardError; end
 
   class << self
     def configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attribeauty
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Toby