attribeauty 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c705d3129b34e6dbc91c53163face634eafbc288a2b36b2768faf97a77a7f8a
-  data.tar.gz: 1553078b6ae388c7d75c367e9f70b2e1153b59b4999ce7fbe7da7bf078d64725
+  metadata.gz: 16789f41e6c0cfea21c44f2f71fc3fd0c9664791ed8d1c97648834be86db6e92
+  data.tar.gz: e8c5ac4397043090870ffeacc5f4b1ae0565f0b7e85237a47254a41e31258032
 SHA512:
-  metadata.gz: efb29ddb06c0c1391d661efcc43b4b1e122233a7c0a481f0fe5bb96a00fe190e0bd05e87640f8f16872ca32c9bd6aaf7120665a6f931b8d41d60109dc8ac49af
-  data.tar.gz: 9c10fb519ec0eaaffd5a31d02c5aea808917fd2ce0b3421ba4e4edf1c4b8dba796ac2fddda907e62e79ba9edf8c8c2355dc37a564346b7377979994ef57ea603
+  metadata.gz: 06c7ca8c0f104cc00ac9854fd4d5c31c043daf65c4d993c32da3dc0472ce4be296ebc2640e2b8b759fb6d99ba07d54e4a8b3c251c183da2048b22eb7da23af78
+  data.tar.gz: 13eb48b958c5cfd1da319a33326449e86683b90f9c89631964c4397d9447334a025b7b3647c87f40ad8c11465c51af7f73e32319ad0c9e344757d823f58e19a8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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
+
 ## [0.3.0] - 2024-06-21
 
 - Experimental params coercion

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,7 @@
 # Attribeauty
 
 I just wanted a quick, simple way to initialize mutable objects. This is it.
-There are so many of these, but none were what I wanted.
+There are so many of these (notably rails Attributes api), but none were what I wanted.
 
 ## Installation
 
@@ -13,7 +13,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install attribeauty
 
-## Usage
+## Base
 
 Inherit from `Attribeauty::Base` and then add attribute with the type you want.
 Initialize with these and they will be cast to that attribute.
@@ -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
@@ -111,7 +113,84 @@ class MyController
   end
 ```
 
-See `test/test_params.rb` for what is expected.
+If you have a "head" param, like in rails, you can exclude it like this:
+
+```
+class MyController
+  def update
+    MyRecord.update(update_params)
+   
+    redirect_to index_path
+  end
+
+  private
+
+  # your params look like this:
+  # { user: { title: "woo", email: { address: "hmm@yep.com" } } }
+  #
+  def params_filter
+    Attribeauty::Params.with(request.params)
+  end
+
+  # using container will exclude the value and yield:
+  # { title: "woo", email: { address: "hmm@yep.com" } } 
+  #
+  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
+
+```
+
+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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "forwardable"
-
 module Attribeauty
   class Params
     extend Forwardable
@@ -12,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)
@@ -23,15 +21,29 @@ 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)
       to_h[key]
     end
 
+    def container(name)
+      @request_params = request_params[name]
+
+      yield
+    end
+
     # rubocop:disable Naming::BlockForwarding
     def attribute(name, type = nil, **args, &block)
       value = request_params[name]
@@ -65,5 +77,9 @@ module Attribeauty
     def valid?
       errors.empty?
     end
+
+    def strict?
+      strict
+    end
   end
 end

data/lib/attribeauty/version.rb

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

data/lib/attribeauty.rb

@@ -2,10 +2,12 @@
 
 require "date"
 require "time"
+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.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Toby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-21 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: