adf_builder 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efabe67ca191eb4a8d3cb985d6fa47869b2d719989337213d691734c07263cd0
-  data.tar.gz: 9b83a052a0198a37a8942bbdf39400681e0268a034ec05a0c5663d038ffbb378
+  metadata.gz: 24b99369efbb491a84bd7a472de00624914228c6de3334e806ab46c7adbb9fa9
+  data.tar.gz: c9b0e631fa1118938a976d80e3be092d958c7fc35b7d2fe547bb291c4d4bbff9
 SHA512:
-  metadata.gz: 61da2f959f608ea29bbd29a0c3a63591ec3ef4d5a94dd0df50b8c7ea9f0eec4a254e696e05fe2f58d229d01081a837870a337852801afcb57a3090122036aefc
-  data.tar.gz: e219d9a2b74c562295a72464042cec57160e3f9ec8b99cc2b90f7bd4deb96fd956dad7c9632f74741470467443a10d2c4472e87468b299af2e50c381347a0087
+  metadata.gz: 8e46cdda771a5c61882464d1e21a4e1117d156c13603877a7cb35e50bc0cd45ef480236a8aa2add261b983e5ed11142f655e9611e6f97cf04c7944305b6c3640
+  data.tar.gz: 4560e7057db7c62d8a6bdc90e3b5413c99ae273c5f70a1fd66d621e3a8c3d574ee80e619797c0faf32ce6a6c6fbfd33976fadc3cbda26d66c1a24e673b911447

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 
 deploy.txt
+*.gem

data/CHANGELOG.md

@@ -1,4 +1,26 @@
-## [Unreleased]
+## [1.2.1] - 2026-01-19
+- **Strict Validations**: Added `presence` validation for `Vehicle` (year, make, model required).
+
+## [1.2.0] - 2026-01-19
+- **Strict Validations**: Added validation for `Vehicle` condition, `Option` weighting (range), `Finance` method, and required `ID` source.
+
+## [1.1.0] - 2026-01-19
+- **Feature Complete**: Implemented all ADF 1.0 nodes and attributes including `Vendor`, `Provider`, and complex `Vehicle` tags (`Finance`, `Option`, `Odometer`, `ColorCombination`, `ImageTag`, `Price`).
+- **Singular Field logic**: Methods for singular fields (e.g. `vehicle.year`) now correctly replace existing values instead of appending.
+- **Removed Legacy Code**: Cleaned up deprecated legacy implementation directories.
+
+## [1.0.0] - 2026-01-19
+- **MAJOR OVERHAUL**: Complete rewrtie of the library architecture.
+- **New Block-based DSL**: Intuitive API for building ADF documents (`AdfBuilder.build { vehicle { ... } }`).
+- **Validation**: Strict enforcement of ADF enumerations and structure (e.g. `vehicle status: :new`).
+- **Editing**: New `AdfBuilder.tree` method for programmatic modifications after construction.
+- **Robustness**: Complete rewrite of XML generation using robust heuristics and strict `Ox` serialization.
+- **Compatibility**: Verified for Ruby 3.4.x.
+- **Features**:
+  - Support for multiple vehicles/customers.
+  - Support for singular vs multiple item logic.
+  - Dynamic support for arbitrary/custom tags (`method_missing`).
+  - Automatic handling of XML attributes vs simple elements.
 
 ## [0.4.0] - 2026-01-19
 - Modernized dependencies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adf_builder (1.0.0)
+    adf_builder (1.2.0)
       ox (~> 2.14)
 
 GEM

data/lib/adf_builder/nodes/customer.rb

@@ -3,56 +3,56 @@
 module AdfBuilder
   module Nodes
     class Customer < Node
+      def initialize
+        super
+        @tag_name = :customer
+      end
+
       def contact(&block)
+        remove_children(:contact)
         contact = Contact.new
         contact.instance_eval(&block) if block_given?
         add_child(contact)
       end
-    end
 
-    class Contact < Node
-      def name(value, part: nil, type: nil)
-        name_node = Name.new(value, part: part, type: type)
-        add_child(name_node)
+      def id(value, sequence: nil, source: nil)
+        # id* is multiple
+        add_child(Id.new(value, sequence: sequence, source: source))
       end
 
-      def email(value)
-        add_child(SimpleElement.new(:email, value))
+      def timeframe(&block)
+        remove_children(:timeframe)
+        tf = Timeframe.new
+        tf.instance_eval(&block) if block_given?
+        add_child(tf)
       end
 
-      def phone(value, type: nil)
-        phone_node = Phone.new(value, type: type)
-        add_child(phone_node)
+      def comments(value)
+        remove_children(:comments)
+        add_child(GenericNode.new(:comments, {}, value))
       end
     end
 
-    class Name < Node
-      def initialize(value, part: nil, type: nil)
-        super()
-        @value = value
-        @attributes[:part] = part if part
-        @attributes[:type] = type if type
+    class Timeframe < Node
+      def initialize
+        super
+        @tag_name = :timeframe
       end
-      attr_reader :value
-    end
 
-    class Phone < Node
-      def initialize(value, type: nil)
-        super()
-        @value = value
-        @attributes[:type] = type if type
+      def description(value)
+        remove_children(:description)
+        add_child(GenericNode.new(:description, {}, value))
+      end
+
+      def earliestdate(value)
+        remove_children(:earliestdate)
+        add_child(GenericNode.new(:earliestdate, {}, value))
       end
-      attr_reader :value
-    end
 
-    # Simple Helper for tags like <email>foo</email>
-    class SimpleElement < Node
-      def initialize(tag_name, value)
-        super()
-        @tag_name = tag_name
-        @value = value
+      def latestdate(value)
+        remove_children(:latestdate)
+        add_child(GenericNode.new(:latestdate, {}, value))
       end
-      attr_reader :value, :tag_name
     end
   end
 end

data/lib/adf_builder/nodes/node.rb

@@ -5,17 +5,23 @@ module AdfBuilder
     class Node
       include AdfBuilder::Validations
 
-      attr_reader :children, :attributes
+      attr_reader :children, :attributes, :value, :tag_name
 
       def initialize
         @children = []
         @attributes = {}
+        @value = nil
+        @tag_name = nil
       end
 
       def add_child(node)
         @children << node
       end
 
+      def remove_children(tag_name)
+        @children.reject! { |c| c.tag_name == tag_name }
+      end
+
       def to_xml
         Serializer.to_xml(self)
       end
@@ -57,7 +63,6 @@ module AdfBuilder
         @attributes = attributes
         @value = value
       end
-      attr_reader :tag_name, :value
     end
 
     class Root < Node

data/lib/adf_builder/nodes/prospect.rb

@@ -19,6 +19,18 @@ module AdfBuilder
         add_child(customer)
       end
 
+      def vendor(&block)
+        vendor = Vendor.new
+        vendor.instance_eval(&block) if block_given?
+        add_child(vendor)
+      end
+
+      def provider(&block)
+        provider = Provider.new
+        provider.instance_eval(&block) if block_given?
+        add_child(provider)
+      end
+
       # Helpers for Editing
       def vehicles
         @children.select { |c| c.is_a?(Vehicle) }

data/lib/adf_builder/nodes/provider.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AdfBuilder
+  module Nodes
+    class Provider < Node
+      def initialize
+        super
+        @tag_name = :provider
+      end
+
+      def id(value, sequence: nil, source: nil)
+        add_child(Id.new(value, sequence: sequence, source: source))
+      end
+
+      def name(value, part: nil, type: nil)
+        remove_children(:name)
+        add_child(Name.new(value, part: part, type: type))
+      end
+
+      def service(value)
+        remove_children(:service)
+        add_child(GenericNode.new(:service, {}, value))
+      end
+
+      def url(value)
+        remove_children(:url)
+        add_child(GenericNode.new(:url, {}, value))
+      end
+
+      def email(value, preferredcontact: nil)
+        remove_children(:email)
+        add_child(Email.new(value, preferredcontact: preferredcontact))
+      end
+
+      def phone(value, type: nil, time: nil, preferredcontact: nil)
+        remove_children(:phone)
+        add_child(Phone.new(value, type: type, time: time, preferredcontact: preferredcontact))
+      end
+
+      def contact(primary_contact: false, &block)
+        remove_children(:contact)
+        contact = Contact.new(primary_contact: primary_contact)
+        contact.instance_eval(&block) if block_given?
+        add_child(contact)
+      end
+    end
+  end
+end

data/lib/adf_builder/nodes/shared.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module AdfBuilder
+  module Nodes
+    class Id < Node
+      def initialize(value, source:, sequence: nil)
+        super()
+        raise ArgumentError, "Source is required" if source.nil?
+
+        @tag_name = :id
+        @value = value
+        @attributes[:sequence] = sequence if sequence
+        @attributes[:source] = source
+      end
+    end
+
+    class Phone < Node
+      def initialize(value, type: nil, time: nil, preferredcontact: nil)
+        super()
+        @tag_name = :phone
+        @value = value
+        @attributes[:type] = type if type
+        @attributes[:time] = time if time
+        @attributes[:preferredcontact] = preferredcontact if preferredcontact
+      end
+    end
+
+    class Email < Node
+      def initialize(value, preferredcontact: nil)
+        super()
+        @tag_name = :email
+        @value = value
+        @attributes[:preferredcontact] = preferredcontact if preferredcontact
+      end
+    end
+
+    class Name < Node
+      def initialize(value, part: nil, type: nil)
+        super()
+        @tag_name = :name
+        @value = value
+        @attributes[:part] = part if part
+        @attributes[:type] = type if type
+      end
+    end
+
+    class Address < Node
+      def initialize(type: nil)
+        super()
+        @tag_name = :address
+        @attributes[:type] = type if type
+      end
+
+      def street(value, line: nil)
+        node = GenericNode.new(:street, { line: line }.compact, value)
+        add_child(node)
+      end
+
+      # Simple elements
+      %i[apartment city regioncode postalcode country].each do |tag|
+        define_method(tag) do |value|
+          add_child(GenericNode.new(tag, {}, value))
+        end
+      end
+    end
+
+    class Contact < Node
+      def initialize(primary_contact: false)
+        super()
+        @tag_name = :contact
+        # primary_contact might be useful for logic but not an attribute
+      end
+
+      def name(value, part: nil, type: nil)
+        add_child(Name.new(value, part: part, type: type))
+      end
+
+      def email(value, preferredcontact: nil)
+        add_child(Email.new(value, preferredcontact: preferredcontact))
+      end
+
+      def phone(value, type: nil, time: nil, preferredcontact: nil)
+        add_child(Phone.new(value, type: type, time: time, preferredcontact: preferredcontact))
+      end
+
+      def address(type: nil, &block)
+        addr = Address.new(type: type)
+        addr.instance_eval(&block) if block_given?
+        add_child(addr)
+      end
+    end
+  end
+end

data/lib/adf_builder/nodes/vehicle.rb

@@ -4,22 +4,79 @@ module AdfBuilder
   module Nodes
     class Vehicle < Node
       validates_inclusion_of :status, in: %i[new used]
+      validates_inclusion_of :interest, in: %i[buy lease sell trade-in test-drive]
+      validates_presence_of :year, :make, :model
 
-      def year(value)
-        @attributes[:year] = value
+      def initialize
+        super
+        @tag_name = :vehicle
+        @attributes[:status] = :new
+        @attributes[:interest] = :buy
       end
 
-      def make(value)
-        @attributes[:make] = value
+      # Simple Text Elements (Singular)
+      # Simple Text Elements (Singular)
+      %i[year make model vin stock trim doors bodystyle transmission pricecomments comments].each do |tag|
+        define_method(tag) do |value|
+          remove_children(tag)
+          add_child(GenericNode.new(tag, {}, value))
+        end
       end
 
-      def model(value)
-        @attributes[:model] = value
+      def condition(value)
+        remove_children(:condition)
+        add_child(Condition.new(value))
+      end
+
+      def interest(value)
+        @attributes[:interest] = value
       end
 
       def status(value)
         @attributes[:status] = value
       end
+
+      # Complex Elements
+      def id(value, sequence: nil, source: nil)
+        # id* is multiple, so just add
+        add_child(Id.new(value, sequence: sequence, source: source))
+      end
+
+      def odometer(value, status: nil, units: nil)
+        remove_children(:odometer)
+        add_child(Odometer.new(value, status: status, units: units))
+      end
+
+      def imagetag(value, width: nil, height: nil, alttext: nil)
+        remove_children(:imagetag)
+        add_child(ImageTag.new(value, width: width, height: height, alttext: alttext))
+      end
+
+      def price(value, **attrs)
+        remove_children(:price)
+        add_child(Price.new(value, **attrs))
+      end
+
+      def option(&block)
+        # option* is multiple
+        opt = Option.new
+        opt.instance_eval(&block) if block_given?
+        add_child(opt)
+      end
+
+      def finance(&block)
+        remove_children(:finance)
+        fin = Finance.new
+        fin.instance_eval(&block) if block_given?
+        add_child(fin)
+      end
+
+      def colorcombination(&block)
+        # colorcombination* is multiple
+        cc = ColorCombination.new
+        cc.instance_eval(&block) if block_given?
+        add_child(cc)
+      end
     end
   end
 end

data/lib/adf_builder/nodes/vehicle_nodes.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module AdfBuilder
+  module Nodes
+    class Odometer < Node
+      validates_inclusion_of :status, in: %i[unknown rolledover replaced original]
+      validates_inclusion_of :units, in: %i[km mi]
+
+      def initialize(value, status: nil, units: nil)
+        super()
+        @tag_name = :odometer
+        @value = value
+        @attributes[:status] = status if status
+        @attributes[:units] = units if units
+      end
+    end
+
+    class ImageTag < Node
+      def initialize(value, width: nil, height: nil, alttext: nil)
+        super()
+        @tag_name = :imagetag
+        @value = value
+        @attributes[:width] = width if width
+        @attributes[:height] = height if height
+        @attributes[:alttext] = alttext if alttext
+      end
+    end
+
+    class Condition < Node
+      VALID_VALUES = %w[excellent good fair poor unknown].freeze
+
+      def initialize(value)
+        super()
+        @tag_name = :condition
+        unless VALID_VALUES.include?(value.to_s.downcase)
+          raise AdfBuilder::Error, "Invalid condition: #{value}. Must be one of: #{VALID_VALUES.join(", ")}"
+        end
+
+        @value = value
+      end
+    end
+
+    class Weighting < Node
+      def initialize(value)
+        super()
+        @tag_name = :weighting
+        int_val = value.to_i
+        unless int_val.between?(-100, 100)
+          raise AdfBuilder::Error, "Weighting must be between -100 and 100. Got: #{value}"
+        end
+
+        @value = value
+      end
+    end
+
+    class FinanceMethod < Node
+      VALID_VALUES = %w[cash finance lease].freeze
+
+      def initialize(value)
+        super()
+        @tag_name = :method
+        unless VALID_VALUES.include?(value.to_s.downcase)
+          raise AdfBuilder::Error, "Invalid finance method: #{value}. Must be one of: #{VALID_VALUES.join(", ")}"
+        end
+
+        @value = value
+      end
+    end
+
+    class Price < Node
+      validates_inclusion_of :type, in: %i[quote offer msrp invoice call appraisal asking]
+      validates_inclusion_of :delta, in: %i[absolute relative percentage]
+      validates_inclusion_of :relativeto, in: %i[msrp invoice]
+
+      def initialize(value, type: :quote, currency: nil, delta: nil, relativeto: nil, source: nil)
+        super()
+        @tag_name = :price
+        @value = value
+        @attributes[:type] = type
+        @attributes[:currency] = currency if currency
+        @attributes[:delta] = delta if delta
+        @attributes[:relativeto] = relativeto if relativeto
+        @attributes[:source] = source if source
+      end
+    end
+
+    class Amount < Node
+      validates_inclusion_of :type, in: %i[downpayment monthly total]
+      validates_inclusion_of :limit, in: %i[maximum minimum exact]
+
+      def initialize(value, type: :total, limit: :maximum, currency: nil)
+        super()
+        @tag_name = :amount
+        @value = value
+        @attributes[:type] = type
+        @attributes[:limit] = limit
+        @attributes[:currency] = currency if currency
+      end
+    end
+
+    class Balance < Node
+      validates_inclusion_of :type, in: %i[finance residual]
+
+      def initialize(value, type: :finance, currency: nil)
+        super()
+        @tag_name = :balance
+        @value = value
+        @attributes[:type] = type
+        @attributes[:currency] = currency if currency
+      end
+    end
+
+    class Finance < Node
+      def initialize
+        super
+        @tag_name = :finance
+      end
+
+      def method(value)
+        remove_children(:method)
+        add_child(FinanceMethod.new(value))
+      end
+
+      def amount(value, type: :total, limit: :maximum, currency: nil)
+        add_child(Amount.new(value, type: type, limit: limit, currency: currency))
+      end
+
+      def balance(value, type: :finance, currency: nil)
+        add_child(Balance.new(value, type: type, currency: currency))
+      end
+    end
+
+    class Option < Node
+      def initialize
+        super
+        @tag_name = :option
+      end
+
+      def optionname(value)
+        add_child(GenericNode.new(:optionname, {}, value))
+      end
+
+      def manufacturercode(value)
+        add_child(GenericNode.new(:manufacturercode, {}, value))
+      end
+
+      def stock(value)
+        add_child(GenericNode.new(:stock, {}, value))
+      end
+
+      def weighting(value)
+        add_child(Weighting.new(value))
+      end
+
+      def price(value, **attrs)
+        add_child(Price.new(value, **attrs))
+      end
+    end
+
+    class ColorCombination < Node
+      def initialize
+        super
+        @tag_name = :colorcombination
+      end
+
+      def interiorcolor(value)
+        add_child(GenericNode.new(:interiorcolor, {}, value))
+      end
+
+      def exteriorcolor(value)
+        add_child(GenericNode.new(:exteriorcolor, {}, value))
+      end
+
+      def preference(value)
+        add_child(GenericNode.new(:preference, {}, value))
+      end
+    end
+  end
+end

data/lib/adf_builder/nodes/vendor.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module AdfBuilder
+  module Nodes
+    class Vendor < Node
+      def initialize
+        super
+        @tag_name = :vendor
+      end
+
+      def id(value, sequence: nil, source: nil)
+        add_child(Id.new(value, sequence: sequence, source: source))
+      end
+
+      def vendorname(value)
+        remove_children(:vendorname)
+        add_child(GenericNode.new(:vendorname, {}, value))
+      end
+
+      def url(value)
+        remove_children(:url)
+        add_child(GenericNode.new(:url, {}, value))
+      end
+
+      def contact(primary_contact: false, &block)
+        remove_children(:contact)
+        contact = Contact.new(primary_contact: primary_contact)
+        contact.instance_eval(&block) if block_given?
+        add_child(contact)
+      end
+    end
+  end
+end

data/lib/adf_builder/serializer.rb

@@ -4,8 +4,10 @@ require "ox"
 
 module AdfBuilder
   class Serializer
-    def self.to_xml(node)
-      new(node).to_xml
+    class << self
+      def to_xml(root_node)
+        new(root_node).to_xml
+      end
     end
 
     def initialize(root_node)
@@ -13,7 +15,10 @@ module AdfBuilder
     end
 
     def to_xml
-      doc = Ox::Document.new
+      # Validate the entire tree before serializing to ensure data integrity
+      @root_node.validate!
+
+      doc = Ox::Document.new(version: "1.0")
 
       # XML Instruction
       instruct = Ox::Instruct.new(:xml)
@@ -41,7 +46,7 @@ module AdfBuilder
     def serialize_node(node, parent_element)
       # Determine element name using tag_name to avoid conflict with DSL methods like 'name'
       # Safest check: Does it have the instance variable set?
-      element_name = if node.instance_variable_defined?(:@tag_name)
+      element_name = if node.instance_variable_defined?(:@tag_name) && node.instance_variable_get(:@tag_name)
                        node.instance_variable_get(:@tag_name).to_s
                      else
                        node.class.name.split("::").last.downcase
@@ -75,7 +80,10 @@ module AdfBuilder
     end
 
     def attribute?(key)
-      %i[part type status sequence source id valid preferredcontact time].include?(key)
+      %i[
+        part type status sequence source id valid preferredcontact time
+        interest units width height alttext limit currency delta relativeto line
+      ].include?(key)
     end
   end
 end