attribeauty 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 812191110b6c7f397737c3a9b1cceab66819c07d549c02c31687b8260342f404
-  data.tar.gz: 2ce7d61531ba7dcb7a896994ef94a2fa970bd821eb62d0901cc2b1df5e70947b
+  metadata.gz: d41ac9aebcbb1c28b939ef7c8da19280dac7135655bc9b8fdab6758aad4a76e8
+  data.tar.gz: eaabafa87e2315bb7ea25debb7b915dfcc7e200c07b556274ee1aa73c4b4fbc3
 SHA512:
-  metadata.gz: dbe0d664e43e995eb4caf66f66fe2a242d2f40b9effda38f511775451c666c82e1596a9116197e5cc84848f0f63ab11f2bb0f537f2214e0d38c6f9b3ddba2e1f
-  data.tar.gz: 66fb433c37a8986c4f5cf3bec0dae55246360fb6f65d82e2e25d1f507b3f4526d5476c99fa7f3e5244d6d255cdb9f429c51e7a7c7c84504e61fe2083e864bf0b
+  metadata.gz: 844f5020c04d41dc2d9ce9fc67e678b66a2cfb1722e98ac9dbee57a01d0bfd7269ac4f939194661e6fa87646cc363358f4e791efedfc04b40036bc447837a804
+  data.tar.gz: fcaf05b3f5f450862d664d5419e4375b3419d6d2e6b9ce625aa71517bc314f466eee3b713a7f931d93f5c5dbbb18998351059acd03ba90138f4d71161d1910cf

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [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
+
 ## [0.3.3] - 2024-06-24
 
 - handle nil in types. Big refactor

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attribeauty (0.3.3)
+    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)
@@ -44,17 +44,13 @@ module Attribeauty
       yield
     end
 
+    # 
     def attribute(name, type = nil, **args, &block)
       value = request_params[name]
-      return if value.nil? && args[:required].nil?
-
-      if block_given?
-        @to_h[name.to_sym] = vals_from_nested(value, &block)
-      else
-        validator = Validator.run(name, value, type, **args)
-        @errors.push(*validator.errors)
-        @to_h[name.to_sym] = validator.value if validator.valid?
-      end
+      return if required?(value, **args)
+      return hash_from_nested(name, value, &block) if block_given?
+
+      value_from_validator(name, value, type, **args)
     end
 
     def inspect
@@ -71,17 +67,28 @@ module Attribeauty
 
     private
 
-    def vals_from_nested(value, &block)
-      if value.is_a?(Array)
-        value.map do |val|
-          params = self.class.with(val).accept(&block)
+    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)
+      @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] = 
+        if value.is_a?(Array)
+          value.map do |val|
+            params = self.class.with(val).accept(&block)
+            @errors.push(*params.errors)
+            params.to_h
+          end.reject(&:empty?)
+        else
+          params = self.class.with(value).accept(&block)
           @errors.push(*params.errors)
           params.to_h
-        end.reject(&:empty?)
-      else
-        params = self.class.with(value).accept(&block)
-        @errors.push(*params.errors)
-        params.to_h
       end
     end
   end

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.3"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribeauty
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Toby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies: []
 description: There are so many of these, I just needed this one.
 email: