attribeauty 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ff07e0947450ca0181b92fbed9438ffa4d4e063cd905dcc5148fc47e8640318
-  data.tar.gz: df35a5f68e745e8ab9decd67c891ca73aa4cd074cdd6695e10ec5313644d4b2c
+  metadata.gz: 0635b380b4cb80f46aa693faef308dd93acf646950c8a592efe9ee56f3f019d1
+  data.tar.gz: f47043d7784f3068f3f82575bc71a5cdf7006cc73e8a8b4f481381a55091cb84
 SHA512:
-  metadata.gz: 4566885478384847bdbe5965fddf3fcf2eb8bccd82782ed0da412cd77c3b89cec6f18965d4777b944313f40350e40a2a00b457af03c088aa4b33f5afc6906c91
-  data.tar.gz: aca7be5f1af5279ff400ea9f0220146b48b51c74e6d03e8246d13cc300a5794391e8fd3c4f7bcb2197aa0b7f3b3e091fb91a4669f3d5b33089b1fd2ef6b3f387
+  metadata.gz: 90040026bba413f4390d1c8141140dc90d7547b47e1af3ec737d23a6ec79c7a9ca9677086318b4d44107acdaf39b8587711e41231074ad80854c619eb3a02883
+  data.tar.gz: 747703281202de16748413ecee1703ad15a6353a31caa289bf77b68e41d6ca820cf2d0bce5087af54ab7c39a237b398492701fa964a02af707dc00c4131fd487

data/.bin/bundle

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../Gemfile", __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/.bin/racc

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'racc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("racc", "racc")

data/.bin/rake

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/.bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/.bin/ruby-parse

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-parse' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("parser", "ruby-parse")

data/.bin/ruby-rewrite

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-rewrite' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("parser", "ruby-rewrite")

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +11,21 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.1] - 2024-06-22
+
+- added container to exclude the "head" param
+
+## [0.3.0] - 2024-06-21
+
+- Experimental params coercion
+- No documentation yet, but tests passing
+
 ## [0.1.0] - 2023-08-09
 
 - Initial release

data/Gemfile

@@ -5,8 +5,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in attribeauty.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "minitest"
+gem "rake"
+gem "rubocop"
 
-gem "minitest", "~> 5.0"
-
-gem "rubocop", "~> 1.21"
+group :development, :test do
+  gem "zeitwerk"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attribeauty (0.1.0)
+    attribeauty (0.3.1)
 
 GEM
   remote: https://rubygems.org/
@@ -34,15 +34,18 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     unicode-display_width (2.4.2)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-22
 
 DEPENDENCIES
   attribeauty!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  rubocop (~> 1.21)
+  minitest
+  rake
+  rubocop
+  zeitwerk
 
 BUNDLED WITH
-   2.4.10
+   2.5.3

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.
@@ -62,7 +62,95 @@ instance.wild_animal # => "the_wildest_animals_are_koalas"
 
 ```
 
-Note, failing to call `inspect` on the value when casting is likely to raise an error.
+To use rails types add to your config:
+```
+# config/initializers/attribeauty.rb
+
+Rails.application.reloader.to_prepare do
+  Attribeauty.configure do |config|
+    config.types[:string] = ActiveModel::Type::String
+    config.types[:boolean] = ActiveModel::Type::Boolean
+    config.types[:date] = ActiveModel::Type::Date
+    config.types[:time] = ActiveModel::Type::Time
+    config.types[:datetime] = ActiveModel::Type::DateTime
+    config.types[:float] = ActiveModel::Type::Float
+    config.types[:integer] = ActiveModel::Type::Integer
+  end
+end
+
+```
+
+## Params
+
+Experimental params sanitizer is now available. This will cast your params, and remove elements you want to exclude if `nil` or `empty`
+
+```
+# app/controllers/my_controller.rb
+class MyController
+  def update
+    MyRecord.update(update_params)
+   
+    redirect_to index_path
+  end
+
+  private
+
+  def params_filter
+    Attribeauty::Params.with(request.params)
+  end
+
+  def update_params
+    params_filter.accept 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
+```
+
+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
+
+```
+
+See `test/test_params.rb` for what is expected.
+
 
 ## Development
 

data/lib/attribeauty/params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  class Params
+    extend Forwardable
+
+    def_delegators :to_h, :each_pair, :each, :empty?, :keys
+
+    def self.with(request_params)
+      new(request_params)
+    end
+
+    attr_reader :allow_nil, :prefix, :request_params, :acceptables, :to_h, :errors
+
+    def initialize(request_params)
+      @request_params = request_params.transform_keys(&:to_sym)
+      @to_h = {}
+      @errors = []
+    end
+
+    def accept(&)
+      instance_eval(&)
+
+      self
+    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]
+      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
+      else
+        validator = Validator.run(name, type, value, **args)
+        @to_h[name.to_sym] = validator.value if validator.valid?
+        @errors.push(*validator.errors)
+      end
+    end
+    # rubocop:enable Naming::BlockForwarding
+
+    def inspect
+      to_h.inspect
+    end
+
+    def valid?
+      errors.empty?
+    end
+  end
+end

data/lib/attribeauty/type_caster.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "types/string"
-require_relative "types/integer"
-require_relative "types/float"
-require_relative "types/boolean"
-require_relative "types/time"
-
 module Attribeauty
   # base cast for types
   class TypeCaster

data/lib/attribeauty/types/boolean.rb

@@ -9,7 +9,7 @@ module Attribeauty
         "0", :"0",
         "f", :f,
         "F", :F,
-        "false", :false,
+        "false", false,
         "FALSE", :FALSE,
         "off", :off,
         "OFF", :OFF

data/lib/attribeauty/validator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Attribeauty
+  class Validator
+    ALLOWS_HASH = {
+      allow_nil: :nil?,
+      allow_empty: :empty?
+    }.freeze
+
+    def self.run(name, type, original_value, **args)
+      new(name, type, original_value, **args).run
+    end
+
+    attr_reader :original_value, :errors, :name, :type, :required, :default, :predicate, :value
+
+    def initialize(name, type, original_value, **args)
+      @name = name
+      @type = type
+      @original_value = original_value
+      @errors = []
+      @default = args[:default]
+      @required = args[:required] if [true, false].include?(args[:required])
+      allows = args.slice(*allows_array)
+      return if allows.empty?
+
+      predicate_array = allows.first
+      predicate_array[0] = :"#{ALLOWS_HASH[predicate_array[0]]}"
+      @predicate = predicate_array
+    end
+
+    def run
+      @original_value = default if original_value.nil? && !default.nil?
+      @value = TypeCaster.run(original_value, type)
+
+      self
+    end
+
+    def valid?
+      if required? && original_value.nil?
+        errors << "#{name} required"
+        return false
+      end
+      return true if predicate.nil?
+
+      method, bool = predicate
+      return true if bool
+
+      !value.public_send(method)
+    end
+
+    private
+
+    def set_args; end
+
+    def allows_array
+      ALLOWS_HASH.keys
+    end
+
+    def required?
+      required
+    end
+  end
+end

data/lib/attribeauty/version.rb

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

data/lib/attribeauty.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "attribeauty/version"
-require_relative "attribeauty/base"
-require_relative "attribeauty/type_caster"
-require_relative "attribeauty/configuration"
 require "date"
 require "time"
+require "forwardable"
 
 # Module
 module Attribeauty
@@ -21,3 +18,10 @@ module Attribeauty
     end
   end
 end
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/kamal/sshkit_with_ext.rb")
+loader.setup
+loader.eager_load # We need all commands loaded.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribeauty
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Toby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2024-06-22 00:00:00.000000000 Z
 dependencies: []
 description: There are so many of these, I just needed this one.
 email:
@@ -17,6 +17,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bin/bundle"
+- ".bin/racc"
+- ".bin/rake"
+- ".bin/rubocop"
+- ".bin/ruby-parse"
+- ".bin/ruby-rewrite"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
@@ -27,14 +33,15 @@ files:
 - lib/attribeauty.rb
 - lib/attribeauty/base.rb
 - lib/attribeauty/configuration.rb
+- lib/attribeauty/params.rb
 - lib/attribeauty/type_caster.rb
 - lib/attribeauty/types/boolean.rb
 - lib/attribeauty/types/float.rb
 - lib/attribeauty/types/integer.rb
 - lib/attribeauty/types/string.rb
 - lib/attribeauty/types/time.rb
+- lib/attribeauty/validator.rb
 - lib/attribeauty/version.rb
-- sig/attribeauty.rbs
 homepage: https://github.com/tobyond/attribeauty
 licenses:
 - MIT
@@ -49,14 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Attributes simply done

data/sig/attribeauty.rbs

@@ -1,4 +0,0 @@
-module Attribeauty
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end