attribeauty 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04be2abe193a7faca2c172bb90713086e2a656bada649e0356ada8a444f54993
-  data.tar.gz: e86ca7fb0fbc2d8e20679be174a98eced95c6facf3d98d2b3d1983961e99a9c8
+  metadata.gz: a594dd2b01526d1b89bea9ceeea3217bf0cb311b236981be2e77bd03dc1b5b2f
+  data.tar.gz: 4f79df9cca230c2c0c29c34746f381818535095383c54902e8a7b90f8ea205de
 SHA512:
-  metadata.gz: 1fe0d80aca7c85b8a34bf233f8b72133f16b75eea1a1800e8046efe5df1b19612a060662dc4c80bbbcffd0462d8cf2dee229a1c36228bba155dcff1058d814a7
-  data.tar.gz: 42ab8159a2117c43956b84699f7ba9025a156e854e355f389424b810ecdfa90ee83f2fbdbdf71b43b650f723d1310288c18dc0f1e03f0f4765f193a8d58a1cc0
+  metadata.gz: 4ab16692f1f34715726b3777889c5ee4f1797eeff0431ce73a116c7e02c5faac34d0453188f2469938b1c98076e172dd37e5b18a5a2c1bff009bb483c067a984
+  data.tar.gz: 78f5e064bc51b85fbb57877ce9bd9a7d3894f7798fdfd7dcfe0dc7989fad2618f3d0358e22467d02351745710b92e81227f6b243a74254e90d377be474b1655a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [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:
+- `:allow_nil`, and `:allow_empty` have been replaced with `:exclude_if`
+- see readme for details
+
 ## [0.3.4] - 2024-06-24
 
 - tiny refactor

data/Gemfile.lock

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

data/README.md

@@ -103,17 +103,18 @@ class MyController
 
   def update_params
     params_filter.accept do
-      attribute :title, :string, allow_nil: false, required: true
+      attribute :title, :string, required: true
       attribute :email do
-        attribute :address, :string, allow_empty: false
-        attribute :valid, :boolean, allow_nil: false
-        attribute :ip_address, :string, allow_blank: true
+        attribute :address, :string
+        attribute :valid, :boolean
+        attribute :ip_address, :string, exclude_if: :empty?
       end
     end
   end
 ```
 
-If you have a "head" param, like in rails, you can exclude it like this:
+If you have a "head" param, like in rails, you can exclude it, also note the `exclude_if` option, this will exclude the value completely, if it evaluates to true.
+`exclude_if` will accept a single method call (`:nil?`) or an array (`[:nil?, :empty?]`)
 
 ```
 class MyController
@@ -126,7 +127,7 @@ class MyController
   private
 
   # your params look like this:
-  # { user: { title: "woo", email: { address: "hmm@yep.com" } } }
+  # { user: { title: "woo", email: { address: "hmm@yep.com", ip_address: "" } } }
   #
   def params_filter
     Attribeauty::Params.with(request.params)
@@ -138,11 +139,11 @@ class MyController
   def update_params
     params_filter.accept do
       container :user do
-        attribute :title, :string, allow_nil: false, required: true
+        attribute :title, :string, required: true
         attribute :email do
-          attribute :address, :string, allow_empty: false
-          attribute :valid, :boolean, allow_nil: false
-          attribute :ip_address, :string, allow_blank: true
+          attribute :address, :string, exclude_if: [:empty?, :nil?]
+          attribute :valid, :boolean
+          attribute :ip_address, :string, exclude_if: :empty?
         end
       end
     end
@@ -177,11 +178,48 @@ class MyController
   def update_params
     params_filter.accept! do
       container :user do
-        attribute :title, :string, allow_nil: false, required: true
+        attribute :title, :string, exclude_if: :nil?, required: true
         attribute :email do
-          attribute :address, :string, allow_empty: false
-          attribute :valid, :boolean, allow_nil: false
-          attribute :ip_address, :string, allow_blank: true
+          attribute :address, :string
+          attribute :valid, :boolean
+          attribute :ip_address, :string
+        end
+      end
+    end
+  end
+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

data/lib/attribeauty/params.rb

@@ -10,15 +10,16 @@ module Attribeauty
       new(request_params)
     end
 
-    attr_reader :allow_nil, :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

@@ -2,39 +2,36 @@
 
 module Attribeauty
   class Validator
-    ALLOWS_HASH = {
-      allow_nil: :nil?,
-      allow_empty: :empty?
-    }.freeze
-
     def self.run(name, type, original_val, **args)
       new(name, type, original_val, **args).run
     end
 
-    attr_reader :original_val, :errors, :name, :type, :required, :default, :allows, :value, :valid
+    attr_reader :original_val, :errors, :name, :type, :required, :default, :excludes, :value, :valid
 
     def initialize(name, original_val, type = nil, **args)
       @name = name
       @type = type
       @original_val = original_val
       @default = args[:default]
-      @required = args[:required] if args[:required] == true
-      @allows = args.slice(*allows_array).delete_if { |_key, value| value == true }
+      args.delete_if { |key, value| key == :required && value == false }
+      @required = args[:required]
+      @excludes = args[:exclude_if]
 
       @valid = true
       @errors = []
     end
 
     def run
-      if type.nil?
-        @value = original_val
-      else
-        set_default
-        cast_value
-        handle_missing_required
-        handle_predicates
-      end
+      handle_missing_original_val!
+      handle_missing_required!
+      handle_missing_type
+
+      set_default
+      cast_value
+      handle_excludes
 
+      self
+    rescue ValueInvalidError
       self
     end
 
@@ -42,49 +39,46 @@ module Attribeauty
       valid
     end
 
+    def required?
+      required
+    end
+
     private
 
-    def set_default
-      return unless original_val.nil? && !default.nil?
+    def handle_missing_original_val!
+      return unless !required? && original_val.nil?
 
-      @original_val = default
-    end
-
-    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_predicates
-      return if predicate.nil? || !valid?
-
-      @valid = !value.public_send(predicate)
+    def handle_missing_type
+      @value = original_val if type.nil?
     end
 
-    def allows_array
-      ALLOWS_HASH.keys
-    end
+    def set_default
+      return unless original_val.nil? && !default.nil?
 
-    # convert allow_nil -> :nil? or allow_empty -> :empty?
-    # this will be used to public_send
-    # NOTE: only one will be checked, if you pass both:
-    # allow_nil and allow_empty, one will be ignored
-    def predicate
-      return if allows.empty?
+      @original_val = default
+    end
 
-      key = allows.keys.first
-      ALLOWS_HASH[key]
+    def cast_value
+      @value ||= TypeCaster.run(original_val, type)
     end
 
-    def required?
-      required
+    def handle_excludes
+      return if excludes.nil? || !valid?
+
+      @valid = ![*excludes].flatten.any? { |exclude| value.public_send(exclude) }
     end
   end
 end

data/lib/attribeauty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Attribeauty
-  VERSION = "0.3.4"
+  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.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Toby