voids 2.0.0

data/spec/voids/nested_attributes_spec.rb

@@ -0,0 +1,377 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Voids::NestedAttributes do
+  describe 'nested attributes for has_one' do
+    it 'assigns attributes to existing association' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo
+      end
+
+      form = form_class.new
+      form.build_photo
+      form.photo_attributes = { url: 'https://example.com' }
+
+      expect(form.photo.url).to eq('https://example.com')
+    end
+
+    it 'creates association if not present' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo
+      end
+
+      form = form_class.new
+      form.photo_attributes = { url: 'https://example.com' }
+
+      expect(form.photo.url).to eq('https://example.com')
+    end
+
+    it 'works through initialization' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo
+        attribute :title, :string
+      end
+
+      form = form_class.new(
+        title: 'test',
+        photo_attributes: { url: 'https://example.com' }
+      )
+
+      expect(form.photo.url).to eq('https://example.com')
+    end
+
+    it 'handles blank attributes' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo
+      end
+
+      form = form_class.new
+      form.photo_attributes = nil
+
+      expect(form.photo).to be_nil
+    end
+  end
+
+  describe 'nested attributes for has_many' do
+    it 'creates multiple associated forms from array' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images
+      end
+
+      form = form_class.new
+      form.images_attributes = [
+        { url: 'https://example.com/1.jpg' },
+        { url: 'https://example.com/2.jpg' }
+      ]
+
+      expect(form.images.count).to eq(2)
+    end
+
+    it 'creates multiple associated forms from hash' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images
+      end
+
+      form = form_class.new
+      form.images_attributes = {
+        '0' => { url: 'https://example.com/1.jpg' },
+        '1' => { url: 'https://example.com/2.jpg' }
+      }
+
+      expect(form.images.count).to eq(2)
+    end
+
+    it 'works through initialization' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images
+        attribute :title, :string
+      end
+
+      form = form_class.new(
+        title: 'test',
+        images_attributes: [
+          { url: 'https://example.com/1.jpg' },
+          { url: 'https://example.com/2.jpg' }
+        ]
+      )
+
+      expect(form.images.count).to eq(2)
+    end
+
+    it 'handles blank attributes' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images
+      end
+
+      form = form_class.new
+      form.images_attributes = nil
+
+      expect(form.images.count).to eq(0)
+    end
+
+    it 'supports reject_if option' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images, reject_if: ->(attrs) { attrs[:url].blank? }
+      end
+
+      form = form_class.new
+      form.images_attributes = [
+        { url: 'https://example.com/1.jpg' },
+        { url: '' },
+        { url: 'https://example.com/2.jpg' }
+      ]
+
+      expect(form.images.count).to eq(2)
+    end
+
+    it 'supports reject_if with symbol' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images, reject_if: :reject_blank_url
+
+        def reject_blank_url(attrs)
+          attrs[:url].blank?
+        end
+      end
+
+      form = form_class.new
+      form.images_attributes = [
+        { url: 'https://example.com/1.jpg' },
+        { url: '' }
+      ]
+
+      expect(form.images.count).to eq(1)
+    end
+  end
+
+  describe 'allow_destroy for has_one' do
+    it 'marks association for destruction when allow_destroy is true' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo, allow_destroy: true
+      end
+
+      form = form_class.new
+      form.build_photo(url: 'https://example.com')
+      form.photo_attributes = { _destroy: true }
+
+      expect(form.photo.marked_for_destruction?).to be true
+    end
+
+    it 'does not mark for destruction when allow_destroy is false' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo
+      end
+
+      form = form_class.new
+      form.build_photo(url: 'https://example.com')
+      form.photo_attributes = { _destroy: true }
+
+      expect(form.photo.marked_for_destruction?).to be false
+    end
+
+    it 'handles string values for _destroy' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo, allow_destroy: true
+      end
+
+      form = form_class.new
+      form.build_photo(url: 'https://example.com')
+      form.photo_attributes = { _destroy: '1' }
+
+      expect(form.photo.marked_for_destruction?).to be true
+    end
+
+    it 'includes _destroy in attributes when marked for destruction' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('PhotoForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_one :photo, allow_destroy: true
+      end
+
+      form = form_class.new
+      form.build_photo(url: 'https://example.com')
+      form.photo.mark_for_destruction
+
+      expect(form.attributes['photo_attributes']['_destroy']).to be true
+    end
+  end
+
+  describe 'allow_destroy for has_many' do
+    it 'marks existing record for destruction when allow_destroy is true' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :id, :integer
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images, allow_destroy: true
+      end
+
+      form = form_class.new
+      form.images.new(id: 1, url: 'https://example.com/1.jpg')
+      form.images.new(id: 2, url: 'https://example.com/2.jpg')
+
+      form.images_attributes = [
+        { id: 1, _destroy: true },
+        { id: 2, url: 'updated.jpg' }
+      ]
+
+      expect(form.images[0].marked_for_destruction?).to be true
+      expect(form.images[1].marked_for_destruction?).to be false
+    end
+
+    it 'does not mark for destruction when allow_destroy is false' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :id, :integer
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images
+      end
+
+      form = form_class.new
+      form.images.new(id: 1, url: 'https://example.com/1.jpg')
+      form.images_attributes = [{ id: 1, _destroy: true }]
+
+      expect(form.images[0].marked_for_destruction?).to be false
+    end
+
+    it 'ignores _destroy for new records without id' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images, allow_destroy: true
+      end
+
+      form = form_class.new
+      form.images_attributes = [
+        { url: 'https://example.com/1.jpg', _destroy: true }
+      ]
+
+      expect(form.images.count).to eq(0)
+    end
+
+    it 'includes _destroy in attributes for marked records' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :id, :integer
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images, allow_destroy: true
+      end
+
+      form = form_class.new
+      form.images.new(id: 1, url: 'https://example.com/1.jpg')
+      form.images[0].mark_for_destruction
+
+      attrs = form.attributes['images_attributes']
+      expect(attrs[0]['_destroy']).to be true
+    end
+
+    it 'handles mixed destroy and update operations' do
+      nested_class = Class.new(Voids::Base) do
+        attribute :id, :integer
+        attribute :url, :string
+      end
+      stub_const('ImageForm', nested_class)
+
+      form_class = Class.new(Voids::Base) do
+        has_many :images, allow_destroy: true
+      end
+
+      form = form_class.new
+      form.images.new(id: 1, url: 'keep.jpg')
+      form.images.new(id: 2, url: 'delete.jpg')
+      form.images.new(id: 3, url: 'update.jpg')
+
+      form.images_attributes = [
+        { id: 1, url: 'keep.jpg' },
+        { id: 2, _destroy: '1' },
+        { id: 3, url: 'updated.jpg' },
+        { url: 'new.jpg' }
+      ]
+
+      expect(form.images.count).to eq(4)
+      expect(form.images[0].marked_for_destruction?).to be false
+      expect(form.images[1].marked_for_destruction?).to be true
+      expect(form.images[2].url).to eq('updated.jpg')
+      expect(form.images[3].url).to eq('new.jpg')
+    end
+  end
+end

data/spec/voids/normalization_spec.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Voids::Normalization do
+  let(:form_class) do
+    Class.new(Voids::Base) do
+      attribute :email, :string
+      attribute :phone, :string
+      attribute :name, :string
+    end
+  end
+
+  describe '.normalizes' do
+    describe 'with proc normalizer' do
+      it 'applies normalization on assignment' do
+        form_class.normalizes :email, with: ->(email) { email.strip.downcase }
+        form = form_class.new(email: ' TEST@EXAMPLE.COM ')
+
+        expect(form.email).to eq('test@example.com')
+      end
+
+      it 'is idempotent when applied multiple times' do
+        form_class.normalizes :email, with: ->(email) { email.strip.downcase }
+        form = form_class.new(email: ' TEST@EXAMPLE.COM ')
+
+        form.email = form.email
+        form.email = form.email
+
+        expect(form.email).to eq('test@example.com')
+      end
+
+      it 'applies normalization on re-assignment' do
+        form_class.normalizes :email, with: ->(email) { email.strip.downcase }
+        form = form_class.new(email: 'test@example.com')
+
+        form.email = ' UPDATED@EXAMPLE.COM '
+
+        expect(form.email).to eq('updated@example.com')
+      end
+    end
+
+    describe 'with symbol normalizer' do
+      it 'calls the method on the value' do
+        form_class.normalizes :email, with: :downcase
+        form = form_class.new(email: 'TEST@EXAMPLE.COM')
+
+        expect(form.email).to eq('test@example.com')
+      end
+    end
+
+    describe 'with multiple attributes' do
+      it 'applies normalization to all specified attributes' do
+        form_class.normalizes :email, :name, with: ->(value) { value.strip.downcase }
+        form = form_class.new(email: ' TEST@EXAMPLE.COM ', name: ' JOHN DOE ')
+
+        expect(form.email).to eq('test@example.com')
+        expect(form.name).to eq('john doe')
+      end
+    end
+
+    describe 'with apply_to_nil: false' do
+      it 'does not apply normalization to nil values' do
+        form_class.normalizes :email, with: ->(email) { email.strip.downcase }
+        form = form_class.new(email: nil)
+
+        expect(form.email).to be_nil
+      end
+    end
+
+    describe 'with apply_to_nil: true' do
+      it 'applies normalization to nil values' do
+        form_class.normalizes :email, with: ->(email) { email || 'default@example.com' }, apply_to_nil: true
+        form = form_class.new(email: nil)
+
+        expect(form.email).to eq('default@example.com')
+      end
+    end
+
+    describe 'complex normalization' do
+      it 'handles chained operations' do
+        form_class.normalizes :phone, with: ->(phone) { phone.delete('^0-9').delete_prefix('1') }
+        form = form_class.new(phone: '1-555-123-4567')
+
+        expect(form.phone).to eq('5551234567')
+      end
+
+      it 'is idempotent for complex normalizations' do
+        form_class.normalizes :phone, with: ->(phone) { phone.delete('^0-9').delete_prefix('1') }
+        form = form_class.new(phone: '1-555-123-4567')
+
+        form.phone = form.phone
+        form.phone = form.phone
+
+        expect(form.phone).to eq('5551234567')
+      end
+    end
+
+    describe 'integration with assign_attributes' do
+      it 'applies normalization when using assign_attributes' do
+        form_class.normalizes :email, with: ->(email) { email.strip.downcase }
+        form = form_class.new
+
+        form.assign_attributes(email: ' TEST@EXAMPLE.COM ')
+
+        expect(form.email).to eq('test@example.com')
+      end
+    end
+
+    describe 'integration with from_model' do
+      it 'applies normalization when loading from model' do
+        model = Struct.new(:email).new(' TEST@EXAMPLE.COM ')
+        form_class.normalizes :email, with: ->(email) { email.strip.downcase }
+        form = form_class.new
+
+        form.from_model(model)
+
+        expect(form.email).to eq('test@example.com')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: voids
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Josh Brody
+- Michael J. Giarlo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby form objects that make sense
+email:
+- gems@josh.mn
+- mjgiarlo@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/advanced_features_example.rb
+- examples/assign_from_model_example.rb
+- examples/model_name_example.rb
+- examples/normalization_example.rb
+- examples/post_form_example.rb
+- lib/voids.rb
+- lib/voids/association_proxy.rb
+- lib/voids/associations.rb
+- lib/voids/base.rb
+- lib/voids/model_naming.rb
+- lib/voids/nested_attributes.rb
+- lib/voids/normalization.rb
+- lib/voids/version.rb
+- spec/spec_helper.rb
+- spec/voids/association_proxy_spec.rb
+- spec/voids/associations_spec.rb
+- spec/voids/attributes_extraction_spec.rb
+- spec/voids/base_spec.rb
+- spec/voids/callbacks_spec.rb
+- spec/voids/custom_primary_key_spec.rb
+- spec/voids/dirty_tracking_spec.rb
+- spec/voids/i18n_spec.rb
+- spec/voids/id_tracking_spec.rb
+- spec/voids/inherit_attributes_from_spec.rb
+- spec/voids/inherit_validations_from_spec.rb
+- spec/voids/model_naming_spec.rb
+- spec/voids/nested_attributes_spec.rb
+- spec/voids/normalization_spec.rb
+homepage: https://github.com/sul-dlss/voids
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sul-dlss/voids
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Ruby form objects that make sense
+test_files: []