Add TaxId value object and :tax_id flex_attribute (#74)

- Add TaxId custom type that extends string type
- Add :tax_id flex attribute
- Test flex_attribute :tax_id in TestRecord

## Context

Implement TaxId attribute with validation for the format XXX-XX-XXXX,
following a similar approach to the MemorableDate attribute which
extends ActiveRecord::Type::Date.

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Loren Yu <[email protected]>

Author: devin-ai-integration[bot]

app/lib/flex/attributes.rb

@@ -4,6 +4,7 @@ module Attributes
     include Flex::Attributes::AddressAttribute
     include Flex::Attributes::MemorableDateAttribute
     include Flex::Attributes::NameAttribute
+    include Flex::Attributes::TaxIdAttribute
 
     class_methods do
       def flex_attribute(name, type, options = {})
@@ -14,6 +15,8 @@ def flex_attribute(name, type, options = {})
           name_attribute name, options
         when :address
           address_attribute name, options
+        when :tax_id
+          tax_id_attribute name, options
         else
           raise ArgumentError, "Unsupported attribute type: #{type}"
         end

app/lib/flex/attributes/memorable_date_attribute.rb

@@ -31,10 +31,6 @@ def memorable_date_attribute(name, options)
 
           validate :"validate_#{name}"
 
-          if options[:presence]
-            validates name, presence: true
-          end
-
           # Create a validation method that checks if the value is a valid date
           define_method "validate_#{name}" do
             value = send(name)

app/lib/flex/attributes/tax_id_attribute.rb

@@ -0,0 +1,33 @@
+module Flex
+  module Attributes
+    module TaxIdAttribute
+      extend ActiveSupport::Concern
+
+      # A custom ActiveRecord type that allows storing a Tax ID (such as SSN).
+      # It uses the Flex::TaxId value object for storage and formatting.
+      class TaxIdType < ActiveRecord::Type::String
+        # Override cast to ensure proper Tax ID format
+        def cast(value)
+          return nil if value.nil?
+
+          # If it's already a TaxId, return it
+          return value if value.is_a?(Flex::TaxId)
+
+          # Otherwise create a new TaxId object
+          Flex::TaxId.new(value)
+        end
+
+        def type
+          :tax_id
+        end
+      end
+
+      class_methods do
+        def tax_id_attribute(name, options = {})
+          attribute name, TaxIdType.new
+          validates name, format: { with: Flex::TaxId::TAX_ID_FORMAT_NO_DASHES, message: :invalid_tax_id }, allow_nil: true
+        end
+      end
+    end
+  end
+end

app/models/flex/tax_id.rb

@@ -0,0 +1,26 @@
+module Flex
+  class TaxId < String
+    include Comparable
+
+    TAX_ID_FORMAT_NO_DASHES = /\A\d{9}\z/
+
+    def initialize(value)
+      # Store only the digits, stripping any non-numeric characters
+      super(value.to_s.gsub(/\D/, ""))
+    end
+
+    # Returns the Tax ID with dashes in XXX-XX-XXXX format
+    def formatted
+      if length == 9
+        "#{self[0..2]}-#{self[3..4]}-#{self[5..8]}"
+      else
+        self
+      end
+    end
+
+    def <=>(other)
+      other_tax_id = other.is_a?(TaxId) ? other : TaxId.new(other.to_s)
+      super(other_tax_id)
+    end
+  end
+end

config/locales/flex/en.yml

@@ -1,4 +1,10 @@
 en:
+  attributes:
+    tax_id: "Tax ID"    
+  errors:
+    messages:
+      invalid_date: "is an invalid date"
+      invalid_tax_id: "is not a valid Taxpayer Identification Number (TIN). Use the format (XXX-XX-XXXX)"
   flex:
     application_forms:
       index:
@@ -56,9 +62,6 @@ en:
             all: "All tasks"
         no_tasks_alert:
           message: "No tasks available!"
-  errors:
-    messages:
-      invalid_date: "is an invalid date"
   tasks:
     statuses:
       pending: "Pending"

config/locales/flex/es-US.yml

@@ -59,6 +59,7 @@ es-US:
   errors:
     messages:
       invalid_date: "Fecha inválida"
+      invalid_tax_id: "no es un número de identificación fiscal válido. Use el formato: (XXX-XX-XXXX)"
   tasks:
     statuses:
       pending: "Pendiente"

spec/dummy/app/models/test_record.rb

@@ -4,4 +4,5 @@ class TestRecord < ApplicationRecord
   flex_attribute :address, :address
   flex_attribute :date_of_birth, :memorable_date
   flex_attribute :name, :name
+  flex_attribute :tax_id, :tax_id
 end

spec/dummy/db/migrate/20250518000000_add_tax_id_to_test_records.rb

@@ -0,0 +1,5 @@
+class AddTaxIdToTestRecords < ActiveRecord::Migration[8.0]
+  def change
+    add_column :test_records, :tax_id, :string
+  end
+end

spec/dummy/db/schema.rb

@@ -10,13 +10,13 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[8.0].define(version: 2025_05_17_053839) do
+ActiveRecord::Schema[8.0].define(version: 2025_05_18_000000) do
   create_table "flex_tasks", force: :cascade do |t|
     t.string "type"
     t.text "description"
     t.integer "status", default: 0
-    t.integer "assignee_id"
-    t.integer "case_id"
+    t.string "assignee_id"
+    t.string "case_id"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.date "due_on"
@@ -73,6 +73,7 @@
     t.string "address_city"
     t.string "address_state"
     t.string "address_zip_code"
+    t.string "tax_id"
   end
 
   create_table "users", force: :cascade do |t|

spec/dummy/spec/lib/flex/attributes_spec.rb

@@ -139,4 +139,169 @@
       expect(object.address_zip_code).to eq("10003")
     end
   end
+
+  describe "tax_id attribute" do
+    it "allows setting a tax_id as a TaxId object" do
+      tax_id = Flex::TaxId.new("123456789")
+      object.tax_id = tax_id
+
+      expect(object.tax_id).to be_a(Flex::TaxId)
+      expect(object.tax_id.formatted).to eq("123-45-6789")
+    end
+
+    it "allows setting a tax_id as a string" do
+      object.tax_id = "123456789"
+
+      expect(object.tax_id).to be_a(Flex::TaxId)
+      expect(object.tax_id.formatted).to eq("123-45-6789")
+    end
+
+    [
+      [ "123456789", "123-45-6789" ],
+      [ "123-45-6789", "123-45-6789" ],
+      [ "123 45 6789", "123-45-6789" ]
+    ].each do |input_string, expected|
+      it "formats tax_id correctly [#{input_string}]" do
+        object.tax_id = input_string
+        expect(object.tax_id.formatted).to eq(expected)
+      end
+    end
+
+    it "preserves invalid values for validation" do
+      object.tax_id = "12345"
+
+      expect(object.tax_id).to be_a(Flex::TaxId)
+      expect(object.tax_id.formatted).to eq("12345") # Raw value since not 9 digits
+      expect(object).not_to be_valid
+      expect(object.errors.full_messages_for("tax_id")).to eq([ "Tax ID is not a valid Taxpayer Identification Number (TIN). Use the format (XXX-XX-XXXX)" ])
+    end
+
+    describe "TaxId.<=>" do
+      it "allows sorting tax ids" do
+        tax_ids = [
+          Flex::TaxId.new("987654321"),
+          Flex::TaxId.new("123456789"),
+          Flex::TaxId.new("456789123")
+        ]
+
+        sorted_tax_ids = tax_ids.sort
+        expect(sorted_tax_ids.map(&:formatted)).to eq([
+          "123-45-6789",
+          "456-78-9123",
+          "987-65-4321"
+        ])
+      end
+
+      it "compares tax ids numerically" do
+        lower = Flex::TaxId.new("123456789")
+        higher = Flex::TaxId.new("987654321")
+
+        expect(lower <=> higher).to eq(-1)
+        expect(higher <=> lower).to eq(1)
+        expect(lower <=> lower).to eq(0)
+      end
+
+      it "handles comparison with different formats" do
+        tax_id1 = Flex::TaxId.new("123-45-6789")
+        tax_id2 = Flex::TaxId.new("123456789")
+
+        expect(tax_id1 <=> tax_id2).to eq(0)
+      end
+
+      it "handles comparison with string values" do
+        tax_id = Flex::TaxId.new("123-45-6789")
+        string_value = "123456789"
+
+        expect(tax_id <=> string_value).to eq(0)
+        expect(tax_id <=> "987654321").to eq(-1)
+        expect(tax_id <=> "000456789").to eq(1)
+      end
+    end
+  end
+
+  describe "persisting and loading from database" do
+    let(:record) { TestRecord.new }
+
+    it "persists and loads name object correctly" do
+      name = Flex::Name.new("John", "Middle", "Doe")
+      record.name = name
+      record.save!
+
+      loaded_record = TestRecord.find(record.id)
+      expect(loaded_record.name).to be_a(Flex::Name)
+      expect(loaded_record.name).to eq(name)
+      expect(loaded_record.name_first).to eq("John")
+      expect(loaded_record.name_middle).to eq("Middle")
+      expect(loaded_record.name_last).to eq("Doe")
+    end
+
+    it "persists and loads address object correctly" do
+      address = Flex::Address.new("123 Main St", "Apt 4B", "Boston", "MA", "02108")
+      record.address = address
+      record.save!
+
+      loaded_record = TestRecord.find(record.id)
+      expect(loaded_record.address).to be_a(Flex::Address)
+      expect(loaded_record.address).to eq(address)
+      expect(loaded_record.address_street_line_1).to eq("123 Main St")
+      expect(loaded_record.address_street_line_2).to eq("Apt 4B")
+      expect(loaded_record.address_city).to eq("Boston")
+      expect(loaded_record.address_state).to eq("MA")
+      expect(loaded_record.address_zip_code).to eq("02108")
+    end
+
+    it "persists and loads tax_id object correctly" do
+      tax_id = Flex::TaxId.new("123-45-6789")
+      record.tax_id = tax_id
+      record.save!
+
+      loaded_record = TestRecord.find(record.id)
+      expect(loaded_record.tax_id).to be_a(Flex::TaxId)
+      expect(loaded_record.tax_id).to eq(tax_id)
+      expect(loaded_record.tax_id.formatted).to eq("123-45-6789")
+    end
+
+    it "persists and loads memorable date correctly" do
+      date = Date.new(2020, 1, 2)
+      record.date_of_birth = date
+      record.save!
+
+      loaded_record = TestRecord.find(record.id)
+      expect(loaded_record.date_of_birth).to eq(date)
+      expect(loaded_record.date_of_birth.year).to eq(2020)
+      expect(loaded_record.date_of_birth.month).to eq(1)
+      expect(loaded_record.date_of_birth.day).to eq(2)
+    end
+
+    it "preserves all attributes when saving and loading multiple value objects" do
+      record.name = Flex::Name.new("Jane", "Marie", "Smith")
+      record.address = Flex::Address.new("456 Oak St", "Unit 7", "Chicago", "IL", "60601")
+      record.tax_id = Flex::TaxId.new("987-65-4321")
+      record.date_of_birth = Date.new(1990, 3, 15)
+      record.save!
+
+      loaded_record = TestRecord.find(record.id)
+
+      # Verify name
+      expect(loaded_record.name).to eq(Flex::Name.new("Jane", "Marie", "Smith"))
+      expect(loaded_record.name_first).to eq("Jane")
+      expect(loaded_record.name_middle).to eq("Marie")
+      expect(loaded_record.name_last).to eq("Smith")
+
+      # Verify address
+      expect(loaded_record.address).to eq(Flex::Address.new("456 Oak St", "Unit 7", "Chicago", "IL", "60601"))
+      expect(loaded_record.address_street_line_1).to eq("456 Oak St")
+      expect(loaded_record.address_street_line_2).to eq("Unit 7")
+      expect(loaded_record.address_city).to eq("Chicago")
+      expect(loaded_record.address_state).to eq("IL")
+      expect(loaded_record.address_zip_code).to eq("60601")
+
+      # Verify tax_id
+      expect(loaded_record.tax_id).to eq(Flex::TaxId.new("987-65-4321"))
+      expect(loaded_record.tax_id.formatted).to eq("987-65-4321")
+
+      # Verify date_of_birth
+      expect(loaded_record.date_of_birth).to eq(Date.new(1990, 3, 15))
+    end
+  end
 end