attribeauty 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04be2abe193a7faca2c172bb90713086e2a656bada649e0356ada8a444f54993
-  data.tar.gz: e86ca7fb0fbc2d8e20679be174a98eced95c6facf3d98d2b3d1983961e99a9c8
+  metadata.gz: d41ac9aebcbb1c28b939ef7c8da19280dac7135655bc9b8fdab6758aad4a76e8
+  data.tar.gz: eaabafa87e2315bb7ea25debb7b915dfcc7e200c07b556274ee1aa73c4b4fbc3
 SHA512:
-  metadata.gz: 1fe0d80aca7c85b8a34bf233f8b72133f16b75eea1a1800e8046efe5df1b19612a060662dc4c80bbbcffd0462d8cf2dee229a1c36228bba155dcff1058d814a7
-  data.tar.gz: 42ab8159a2117c43956b84699f7ba9025a156e854e355f389424b810ecdfa90ee83f2fbdbdf71b43b650f723d1310288c18dc0f1e03f0f4765f193a8d58a1cc0
+  metadata.gz: 844f5020c04d41dc2d9ce9fc67e678b66a2cfb1722e98ac9dbee57a01d0bfd7269ac4f939194661e6fa87646cc363358f4e791efedfc04b40036bc447837a804
+  data.tar.gz: fcaf05b3f5f450862d664d5419e4375b3419d6d2e6b9ce625aa71517bc314f466eee3b713a7f931d93f5c5dbbb18998351059acd03ba90138f4d71161d1910cf

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [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.0)
 
 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,11 @@ 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

data/lib/attribeauty/params.rb

@@ -10,7 +10,7 @@ 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
 
     def initialize(request_params)
       @request_params = request_params.transform_keys(&:to_sym)

data/lib/attribeauty/validator.rb

@@ -2,16 +2,11 @@
 
 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
@@ -19,7 +14,7 @@ module Attribeauty
       @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 }
+      @excludes = args[:exclude_if]
 
       @valid = true
       @errors = []
@@ -32,7 +27,7 @@ module Attribeauty
         set_default
         cast_value
         handle_missing_required
-        handle_predicates
+        handle_excludes
       end
 
       self
@@ -62,25 +57,10 @@ module Attribeauty
       @valid = false
     end
 
-    def handle_predicates
-      return if predicate.nil? || !valid?
-
-      @valid = !value.public_send(predicate)
-    end
-
-    def allows_array
-      ALLOWS_HASH.keys
-    end
-
-    # 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?
+    def handle_excludes
+      return if excludes.nil? || !valid?
 
-      key = allows.keys.first
-      ALLOWS_HASH[key]
+      @valid = ![*excludes].flatten.any? { |exclude| value.public_send(exclude) }
     end
 
     def required?

data/lib/attribeauty/version.rb

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

metadata

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