attribeauty 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0635b380b4cb80f46aa693faef308dd93acf646950c8a592efe9ee56f3f019d1
-  data.tar.gz: f47043d7784f3068f3f82575bc71a5cdf7006cc73e8a8b4f481381a55091cb84
+  metadata.gz: 812191110b6c7f397737c3a9b1cceab66819c07d549c02c31687b8260342f404
+  data.tar.gz: 2ce7d61531ba7dcb7a896994ef94a2fa970bd821eb62d0901cc2b1df5e70947b
 SHA512:
-  metadata.gz: 90040026bba413f4390d1c8141140dc90d7547b47e1af3ec737d23a6ec79c7a9ca9677086318b4d44107acdaf39b8587711e41231074ad80854c619eb3a02883
-  data.tar.gz: 747703281202de16748413ecee1703ad15a6353a31caa289bf77b68e41d6ca820cf2d0bce5087af54ab7c39a237b398492701fa964a02af707dc00c4131fd487
+  metadata.gz: dbe0d664e43e995eb4caf66f66fe2a242d2f40b9effda38f511775451c666c82e1596a9116197e5cc84848f0f63ab11f2bb0f537f2214e0d38c6f9b3ddba2e1f
+  data.tar.gz: 66fb433c37a8986c4f5cf3bec0dae55246360fb6f65d82e2e25d1f507b3f4526d5476c99fa7f3e5244d6d255cdb9f429c51e7a7c7c84504e61fe2083e864bf0b

data/.rubocop.yml

@@ -29,3 +29,6 @@ Metrics/PerceivedComplexity:
 
 Metrics/CyclomaticComplexity:
   Enabled: false
+
+Naming::BlockForwarding:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.3] - 2024-06-24
+
+- handle nil in types. Big refactor
+
+## [0.3.2] - 2024-06-24
+
+- added accept! method to raise error if "required's" are missing
+
 ## [0.3.1] - 2024-06-22
 
 - added container to exclude the "head" param

data/Gemfile.lock

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

data/README.md

@@ -84,6 +84,8 @@ end
 
 Experimental params sanitizer is now available. This will cast your params, and remove elements you want to exclude if `nil` or `empty`
 
+Why is this needed? Params arrive into the controller in a messy state. Booleans are not ready for caparison, integers are often strings, empty strings, and nils abound. Rails does the casting of params at the model, which is simple and elegant, but in many cases, these params are used for a multitude of things before hitting the database. I truly believe we need to cast them before they do anything.
+
 ```
 # app/controllers/my_controller.rb
 class MyController
@@ -149,7 +151,46 @@ end
 
 ```
 
-See `test/test_params.rb` for what is expected.
+If you want to raise an error, rather than just return the errors in an array, use the `accept!` method. Will raise `Attribeauty::MissingAttributeError` with the required elements:
+
+
+```
+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
+
+  # This following with the accept! method
+  # will raise: Attribeauty::MissingAttributeError, "title required, email required"
+  #
+  def update_params
+    params_filter.accept! do
+      container :user do
+        attribute :title, :string, allow_nil: false, required: true
+        attribute :email do
+          attribute :address, :string, allow_empty: false
+          attribute :valid, :boolean, allow_nil: false
+          attribute :ip_address, :string, allow_blank: true
+        end
+      end
+    end
+  end
+end
+
+```
+
+See `test/test_params.rb` for more examples
 
 
 ## Development

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
+    attr_reader :allow_nil, :prefix, :request_params, :acceptables, :to_h, :errors, :strict
 
     def initialize(request_params)
       @request_params = request_params.transform_keys(&:to_sym)
@@ -21,9 +21,17 @@ module Attribeauty
     def accept(&)
       instance_eval(&)
 
+      raise MissingAttributeError, errors.join(", ") if errors.any? && strict?
+
       self
     end
 
+    def accept!(&)
+      @strict = true
+
+      accept(&)
+    end
+
     def to_hash = to_h
 
     def [](key)
@@ -36,31 +44,18 @@ module Attribeauty
       yield
     end
 
-    # rubocop:disable Naming::BlockForwarding
     def attribute(name, type = nil, **args, &block)
       value = request_params[name]
       return if value.nil? && args[:required].nil?
 
       if block_given?
-        @to_h[name] =
-          if value.is_a?(Array)
-            value.map do |val|
-              params = self.class.with(val).accept(&block)
-              @errors.push(*params.errors)
-              params
-            end.reject(&:empty?)
-          else
-            params = self.class.with(value).accept(&block)
-            @errors.push(*params.errors)
-            params
-          end
+        @to_h[name.to_sym] = vals_from_nested(value, &block)
       else
-        validator = Validator.run(name, type, value, **args)
-        @to_h[name.to_sym] = validator.value if validator.valid?
+        validator = Validator.run(name, value, type, **args)
         @errors.push(*validator.errors)
+        @to_h[name.to_sym] = validator.value if validator.valid?
       end
     end
-    # rubocop:enable Naming::BlockForwarding
 
     def inspect
       to_h.inspect
@@ -69,5 +64,25 @@ module Attribeauty
     def valid?
       errors.empty?
     end
+
+    def strict?
+      strict
+    end
+
+    private
+
+    def vals_from_nested(value, &block)
+      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
+    end
   end
 end

data/lib/attribeauty/types/boolean.rb

@@ -16,6 +16,8 @@ module Attribeauty
       ].to_set.freeze
 
       def cast(value)
+        return false if value.nil?
+
         !FALSE_VALUES.include?(value)
       end
     end

data/lib/attribeauty/types/float.rb

@@ -5,6 +5,8 @@ module Attribeauty
     # custom float type
     class Float
       def cast(value)
+        return if value.nil?
+
         Float(value)
       end
     end

data/lib/attribeauty/types/integer.rb

@@ -5,6 +5,8 @@ module Attribeauty
     # custom integer type
     class Integer
       def cast(value)
+        return if value.nil?
+
         Integer(value)
       end
     end

data/lib/attribeauty/types/string.rb

@@ -5,6 +5,8 @@ module Attribeauty
     # custom string type
     class String
       def cast(value)
+        return if value.nil?
+
         String(value)
       end
     end

data/lib/attribeauty/types/time.rb

@@ -5,6 +5,8 @@ module Attribeauty
     # custom Time type
     class Time
       def cast(value)
+        return if value.nil?
+
         case value
         when Time
           value

data/lib/attribeauty/validator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "forwardable"
-
 module Attribeauty
   class Validator
     ALLOWS_HASH = {
@@ -9,55 +7,82 @@ module Attribeauty
       allow_empty: :empty?
     }.freeze
 
-    def self.run(name, type, original_value, **args)
-      new(name, type, original_value, **args).run
+    def self.run(name, type, original_val, **args)
+      new(name, type, original_val, **args).run
     end
 
-    attr_reader :original_value, :errors, :name, :type, :required, :default, :predicate, :value
+    attr_reader :original_val, :errors, :name, :type, :required, :default, :allows, :value, :valid
 
-    def initialize(name, type, original_value, **args)
+    def initialize(name, original_val, type = nil, **args)
       @name = name
       @type = type
-      @original_value = original_value
-      @errors = []
+      @original_val = original_val
       @default = args[:default]
-      @required = args[:required] if [true, false].include?(args[:required])
-      allows = args.slice(*allows_array)
-      return if allows.empty?
+      @required = args[:required] if args[:required] == true
+      @allows = args.slice(*allows_array).delete_if { |_key, value| value == true }
 
-      predicate_array = allows.first
-      predicate_array[0] = :"#{ALLOWS_HASH[predicate_array[0]]}"
-      @predicate = predicate_array
+      @valid = true
+      @errors = []
     end
 
     def run
-      @original_value = default if original_value.nil? && !default.nil?
-      @value = TypeCaster.run(original_value, type)
+      if type.nil?
+        @value = original_val
+      else
+        set_default
+        cast_value
+        handle_missing_required
+        handle_predicates
+      end
 
       self
     end
 
     def valid?
-      if required? && original_value.nil?
-        errors << "#{name} required"
-        return false
-      end
-      return true if predicate.nil?
+      valid
+    end
 
-      method, bool = predicate
-      return true if bool
+    private
 
-      !value.public_send(method)
+    def set_default
+      return unless original_val.nil? && !default.nil?
+
+      @original_val = default
     end
 
-    private
+    def cast_value
+      @value = TypeCaster.run(original_val, type)
+    end
+
+    # only returning errors if required is missing, not if nil?, or :empty?
+    def handle_missing_required
+      return unless required? && original_val.nil?
+
+      errors << "#{name} required"
+      @valid = false
+    end
+
+    def handle_predicates
+      return if predicate.nil? || !valid?
 
-    def set_args; end
+      @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?
+
+      key = allows.keys.first
+      ALLOWS_HASH[key]
+    end
+
     def required?
       required
     end

data/lib/attribeauty/version.rb

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

data/lib/attribeauty.rb

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

metadata

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