adf_builder 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a27353d159fc18c45473200eb92b6113479e81d0e1e510649bac29fcdcc54522
-  data.tar.gz: b5613f09c70d8e636f1c1698b7faf6fabe4841bb4dbd72d4f7077cdb880b86c2
+  metadata.gz: 838eda978e92f15cfa05a3da07e8a80ee1348f07fb4511abcf2ae79063e0917d
+  data.tar.gz: 205da1b11de1d2748107a0696477787ba0a8f5971ffaabf46f1c25a13fb8079c
 SHA512:
-  metadata.gz: 6fc9c5273a6ad3453284114c898108ed19395e87b9772ad67218b476725675a58e42781cc7e24860064e1bb4c7dd743ca8e39a9f2f7ac3f198e4df04010327df
-  data.tar.gz: 5536658b81a4f0d11c9cde8ddb666125d7a80f696ec74e98912d8c9e69bfaad930faf773d85ecbf55c3d39e8e8d68f7753e91d39868cb10656446c980c144b48
+  metadata.gz: f85f57a637fcdd0e71b84afda8ad59476a2ffe7ffed04ca521f306950469a87ce895eb71339d1ab48c1fa6d9b5ebab26699654ce9556c613deb39291e876ad72
+  data.tar.gz: bdade6f04b5a64dbb042202052c3ba174f8263b00d735e858a1f9627ce25e4524a53b41d42200108258914c2e582efbcd8f0bf449e17a0de2fd741cd37b489dd

data/.gitignore

@@ -10,4 +10,4 @@
 # rspec failure tracking
 .rspec_status
 
-build.txt
+deploy.txt

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 ## [Unreleased]
+
+## [0.4.0] - 2026-01-19
+- Modernized dependencies
+  - Updated `ox` to `~> 2.14.23` for better compatibility
+  - Added compatibility for Ruby 3.4.x
+  - Updated development dependencies (RSpec, Rubocop, Rake)
 - Vehicle Structure - Remaining Optional Tags that are not free text
   - option
   - finance
@@ -7,6 +13,12 @@
   - Contact
   - Vehicle
 
+## [0.3.0] - 2023-11-28
+- Completed Customer - timeframe and comments tags
+
+## [0.2.2] - 2021-11-02
+- Fixed bug where ADF and xml tags were flipped
+
 ## [0.2.1] - 2021-11-02
 - Add comments to the Vehicle nodes
 

data/Gemfile

@@ -4,10 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in adf_builder.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.7"
-gem 'ox', '~> 2.14'

data/Gemfile.lock

@@ -1,48 +1,60 @@
 PATH
   remote: .
   specs:
-    adf_builder (0.2.2)
+    adf_builder (0.4.0)
       ox (~> 2.14)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    diff-lcs (1.4.4)
-    ox (2.14.5)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    ast (2.4.3)
+    bigdecimal (4.0.1)
+    diff-lcs (1.6.2)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    ox (2.14.23)
+      bigdecimal (>= 3.0)
+    parallel (1.27.0)
+    parser (3.3.10.1)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+      racc
+    prism (1.8.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.18.4)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.8.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   arm64-darwin-20
@@ -50,10 +62,9 @@ PLATFORMS
 
 DEPENDENCIES
   adf_builder!
-  ox (~> 2.14)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.7)
+  rake (~> 13.2)
+  rspec (~> 3.13)
+  rubocop (~> 1.70)
 
 BUNDLED WITH
    2.4.4

data/adf_builder.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Easily create XML in ADF format to send by email."
   spec.homepage      = "https://github.com/jippylong12/adf_builder"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/jippylong12/adf_builder"
@@ -29,6 +29,9 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "ox", "~> 2.14"
+  spec.add_development_dependency "rake", "~> 13.2"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "rubocop", "~> 1.70"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/adf_builder/base/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Base
     # initialize the prospect, id, and requestdate node
@@ -6,8 +8,6 @@ module AdfBuilder
       @prospect = Prospect.new(@doc)
     end
 
-    def prospect
-      @prospect
-    end
+    attr_reader :prospect
   end
-end
+end

data/lib/adf_builder/base/prospect.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Prospect
     STATUSES = {
       new: :new,
       resend: :resend
-    }
+    }.freeze
 
     def initialize(doc)
       @doc = doc
@@ -11,7 +13,6 @@ module AdfBuilder
       @prospect = @doc.adf.prospect
       @prospect[:status] = STATUSES[:new]
 
-
       @request_date = RequestDate.new(@prospect)
       @vehicles = Vehicles.new(@prospect)
       @customer = Customer.new(@prospect)
@@ -19,33 +20,15 @@ module AdfBuilder
       @provider = Provider.new(@prospect)
     end
 
-    def request_date
-      @request_date
-    end
-
-    def vehicles
-      @vehicles
-    end
-
-    def customer
-      @customer
-    end
-
-    def vendor
-      @vendor
-    end
-
-    def provider
-      @provider
-    end
+    attr_reader :request_date, :vehicles, :customer, :vendor, :provider
 
     # set status to renew
     def set_renew
       @prospect[:status] = STATUSES[:resend]
     end
 
-    def add_id(value, source=nil, sequence=1)
+    def add_id(value, source = nil, sequence = 1)
       Id.new.add(@prospect, value, source, sequence)
     end
   end
-end
+end

data/lib/adf_builder/base/request_date.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class RequestDate
-    WITH_SYMBOLS = '%FT%T%:z'
-    WITHOUT_SYMBOLS = '%Y%m%dT%H%M%S%z'
+    WITH_SYMBOLS = "%FT%T%:z"
+    WITHOUT_SYMBOLS = "%Y%m%dT%H%M%S%z"
 
     def initialize(prospect_node)
-      @request_date_node = Ox::Element.new('requestdate')
-      @request_date_node << DateTime.now.strftime('%FT%T%:z')
+      @request_date_node = Ox::Element.new("requestdate")
+      @request_date_node << DateTime.now.strftime("%FT%T%:z")
       prospect_node << @request_date_node
     end
 
-    def update_val(datetime_value, format=1)
+    def update_val(datetime_value, format = 1)
       if format == 1
         @request_date_node.replace_text(datetime_value.strftime(WITH_SYMBOLS))
       elsif format == 2
@@ -17,4 +19,4 @@ module AdfBuilder
       end
     end
   end
-end
+end

data/lib/adf_builder/customer/customer.rb

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Customer
     def initialize(prospect)
-      @customer = Ox::Element.new('customer')
+      @customer = Ox::Element.new("customer")
       @contact = nil
+      @timeframe = nil
 
       prospect << @customer
     end
 
-    def contact
-      @contact
-    end
+    attr_reader :contact, :timeframe
 
-    def add(name, opts={})
+    def add(name, opts = {})
       @contact = Contact.new(@customer, name, opts)
     end
 
-    def add_id(index, value, source=nil, sequence=1)
+    def add_id(index, value, source = nil, sequence = 1)
       if @prospect.locate("customer").empty?
         false
       else
@@ -23,5 +24,27 @@ module AdfBuilder
       end
     end
 
+    # @param descriptin [String] - Description of customer’s timing intention.
+    # @param earliest_date [DateTime] - Earliest date customer is interested in. If timeframe tag
+    # is present, it is required to specify earliestdate and/or
+    # latestdate
+    # @param latest_date [DateTime] - Latest date customer is interested in. If timeframe tag
+    # is present, it is required to specify earliestdate and/or
+    # latestdate
+    def add_timeframe(description, earliest_date = nil, latest_date = nil)
+      return false if earliest_date.nil? && latest_date.nil?
+
+      return false if earliest_date && (earliest_date.class != DateTime)
+
+      return false if latest_date && (latest_date.class != DateTime)
+
+      @timeframe = Timeframe.new(@customer, description, earliest_date, latest_date) if @timeframe.nil?
+    end
+
+    def update_comments(comments)
+      return false if comments.class != String
+
+      AdfBuilder::Builder.update_node(@customer, :comments, comments)
+    end
   end
-end
+end

data/lib/adf_builder/customer/timeframe.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module AdfBuilder
+  class Timeframe
+    def initialize(customer, description, earliest_date, latest_date)
+      begin
+        earliest_date = earliest_date.strftime("%FT%T%:z") if earliest_date
+        latest_date = latest_date.strftime("%FT%T%:z") if latest_date
+      rescue StandardError
+        return nil
+      end
+
+      @timeframe = Ox::Element.new("timeframe")
+
+      @timeframe << (Ox::Element.new("description") << description)
+      @timeframe << (Ox::Element.new("earliestdate") << earliest_date) if earliest_date
+      @timeframe << (Ox::Element.new("latestdate") << latest_date) if latest_date
+      customer << @timeframe
+    end
+
+    def update_description(description)
+      AdfBuilder::Builder.update_node(@timeframe, :description, description)
+    end
+
+    def update_earliest_date(date)
+      begin
+        date = date.strftime("%FT%T%:z")
+      rescue StandardError
+        return false
+      end
+      AdfBuilder::Builder.update_node(@timeframe, :earliestdate, date)
+    end
+
+    def update_latest_date(date)
+      begin
+        date = date.strftime("%FT%T%:z")
+      rescue StandardError
+        return false
+      end
+
+      AdfBuilder::Builder.update_node(@timeframe, :latestdate, date)
+    end
+  end
+end

data/lib/adf_builder/provider/provider.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Provider
-
-
-    FREE_TEXT_OPTIONAL_TAGS = [:service, :url]
+    FREE_TEXT_OPTIONAL_TAGS = %i[service url].freeze
 
     def initialize(prospect)
       @prospect = prospect
@@ -10,41 +10,39 @@ module AdfBuilder
       @contact = nil
     end
 
-    def contact
-      @contact
-    end
-
+    attr_reader :contact
 
-    def add(name, params={})
-      @provider = Ox::Element.new('provider')
-      params.merge!({valid_values: AdfBuilder::Contact::VALID_VALUES, valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS})
-      AdfBuilder::Builder.update_node(@provider, :name, name,  params)
+    def add(name, params = {})
+      @provider = Ox::Element.new("provider")
+      params.merge!({ valid_values: AdfBuilder::Contact::VALID_VALUES,
+                      valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(@provider, :name, name, params)
       @prospect << @provider
     end
 
-    def add_contact(name, opts={})
+    def add_contact(name, opts = {})
       @contact = Contact.new(@provider, name, opts)
     end
 
-    def add_phone(phone, params={})
-      params.merge!({valid_values: AdfBuilder::Contact::VALID_VALUES, valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS})
-      AdfBuilder::Builder.update_node(@provider, :phone, phone,  params)
+    def add_phone(phone, params = {})
+      params.merge!({ valid_values: AdfBuilder::Contact::VALID_VALUES,
+                      valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(@provider, :phone, phone, params)
     end
 
-    def add_email(email, params={})
-      params.merge!({valid_values: AdfBuilder::Contact::VALID_VALUES, valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS})
-      AdfBuilder::Builder.update_node(@provider, :email, email,  params)
+    def add_email(email, params = {})
+      params.merge!({ valid_values: AdfBuilder::Contact::VALID_VALUES,
+                      valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(@provider, :email, email, params)
     end
 
     def update_tags_with_free_text(tags)
       tags.each do |key, value|
-        if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
-          AdfBuilder::Builder.update_node(@provider, key, value)
-        end
+        AdfBuilder::Builder.update_node(@provider, key, value) if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
       end
     end
 
-    def add_id(index, value, source=nil, sequence=1)
+    def add_id(index, value, source = nil, sequence = 1)
       if @prospect.locate("provider").empty?
         false
       else
@@ -52,4 +50,4 @@ module AdfBuilder
       end
     end
   end
-end
+end

data/lib/adf_builder/shared/contact.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Contact
     VALID_PARAMETERS = {
-      name: [:part, :type, :primarycontact],
+      name: %i[part type primarycontact],
       email: [:preferredcontact],
-      phone: [:type, :time, :preferredcontact]
-    }
+      phone: %i[type time preferredcontact]
+    }.freeze
 
     VALID_VALUES = {
       name: {
@@ -13,30 +15,30 @@ module AdfBuilder
         primarycontact: %w[0 1]
       },
       email: {
-        preferredcontact: %w[0 1],
+        preferredcontact: %w[0 1]
       },
       phone: {
         preferredcontact: %w[0 1],
         type: %w[phone fax cellphone pager],
         time: %w[morning afternoon evening nopreference day]
       }
-    }
+    }.freeze
 
-    def initialize(parent_node, name, params={})
-      @contact = Ox::Element.new('contact')
-      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
-      AdfBuilder::Builder.update_node(@contact, :name, name,  params)
+    def initialize(parent_node, name, params = {})
+      @contact = Ox::Element.new("contact")
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(@contact, :name, name, params)
       parent_node << @contact
     end
 
-    def add_phone(phone, params={})
-      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
-      AdfBuilder::Builder.update_node(@contact, :phone, phone,  params)
+    def add_phone(phone, params = {})
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(@contact, :phone, phone, params)
     end
 
-    def add_email(email, params={})
-      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
-      AdfBuilder::Builder.update_node(@contact, :email, email,  params)
+    def add_email(email, params = {})
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(@contact, :email, email, params)
     end
   end
-end
+end

data/lib/adf_builder/shared/id.rb

@@ -1,20 +1,18 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Id
-    def initialize
-
-    end
+    def initialize; end
 
     # add id tag to the form
-    def add(parent_node, value, source=nil, sequence=1)
-      id_node = Ox::Element.new('id')
+    def add(parent_node, value, source = nil, sequence = 1)
+      id_node = Ox::Element.new("id")
       id_node << value
       id_node[:sequence] = sequence
 
-      if source
-        id_node[:source] = source
-      end
+      id_node[:source] = source if source
 
       parent_node.prepend_child(id_node)
     end
   end
-end
+end

data/lib/adf_builder/vehicles/colorcombinations.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class ColorCombinations
-
-    FREE_TEXT_OPTIONAL_TAGS = [:interiorcolor, :exteriorcolor, :preference]
+    FREE_TEXT_OPTIONAL_TAGS = %i[interiorcolor exteriorcolor preference].freeze
 
     def initialize(vehicle)
       @vehicle = vehicle
@@ -9,23 +10,21 @@ module AdfBuilder
     end
 
     def add(interior_color, exterior_color, preference)
-      @color_combination = Ox::Element.new('colorcombination')
+      @color_combination = Ox::Element.new("colorcombination")
       @color_combination <<
-        (Ox::Element.new('interiorcolor') << interior_color) <<
-        (Ox::Element.new('exteriorcolor') << exterior_color) <<
-        (Ox::Element.new('preference') << preference.to_s)
-       @vehicle << @color_combination
+        (Ox::Element.new("interiorcolor") << interior_color) <<
+        (Ox::Element.new("exteriorcolor") << exterior_color) <<
+        (Ox::Element.new("preference") << preference.to_s)
+      @vehicle << @color_combination
     end
 
     def update_tags(index, tags)
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@vehicle,'colorcombination', index)
-      if valid
-        tags.each do |key, value|
-          if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
-            AdfBuilder::Builder.update_node(vehicle, key, value)
-          end
-        end
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@vehicle, "colorcombination", index)
+      return unless valid
+
+      tags.each do |key, value|
+        AdfBuilder::Builder.update_node(vehicle, key, value) if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
       end
     end
   end
-end
+end

data/lib/adf_builder/vehicles/price.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Price
-
     VALID_PARAMETERS = {
-      price: [:type, :currency, :delta, :relativeto, :source]
-    }
+      price: %i[type currency delta relativeto source]
+    }.freeze
 
     VALID_VALUES = {
       price: {
@@ -13,30 +14,30 @@ module AdfBuilder
         relativeto: %w[msrp invoice],
         source: true
       }
-    }
+    }.freeze
 
-    def initialize(parent_node, value, params={})
+    def initialize(parent_node, value, params = {})
       @parent_node = parent_node
-      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
       validate_currency(params)
-      AdfBuilder::Builder.update_node(@parent_node, :price, value,  params)
+      AdfBuilder::Builder.update_node(@parent_node, :price, value, params)
       @price = @parent_node.price
     end
 
-    def update(value, params={})
-      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
-      AdfBuilder::Builder.update_node(@parent_node, :price, value,  params)
+    def update(value, params = {})
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(@parent_node, :price, value, params)
     end
 
     def validate_currency(params)
       code = params[:currency]
-      if code
-        json = JSON.parse(File.read('./lib/adf_builder/data/iso-4217-currency-codes.json'))
-        codes = json.map{|j| j['Alphabetic_Code']}.reject{|j| j.nil?}
-        unless codes.include? code
-          params.delete(:currency)
-        end
-      end
+      return unless code
+
+      json = JSON.parse(File.read("./lib/adf_builder/data/iso-4217-currency-codes.json"))
+      codes = json.map { |j| j["Alphabetic_Code"] }.reject(&:nil?)
+      return if codes.include? code
+
+      params.delete(:currency)
     end
   end
-end
+end

data/lib/adf_builder/vehicles/vehicles.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Vehicles
     VALID_PARAMETERS = {
-      vehicle: [:interest, :status],
-      odometer: [:status, :units],
-      imagetag: [:width, :height, :alttext],
-    }
+      vehicle: %i[interest status],
+      odometer: %i[status units],
+      imagetag: %i[width height alttext]
+    }.freeze
 
     VALID_VALUES = {
       vehicle: {
@@ -20,12 +22,12 @@ module AdfBuilder
         height: true,
         alttext: true
       }
-    }
+    }.freeze
 
-    FREE_TEXT_OPTIONAL_TAGS = [:year, :make, :model, :vin, :stock,
-      :trim, :doors, :bodystyle, :transmission, :pricecomments, :comments]
+    FREE_TEXT_OPTIONAL_TAGS = %i[year make model vin stock
+                                 trim doors bodystyle transmission pricecomments comments].freeze
 
-    CONDITIONS = %w[excellent good fair poor unknown]
+    CONDITIONS = %w[excellent good fair poor unknown].freeze
 
     def initialize(prospect)
       @prospect = prospect
@@ -34,12 +36,12 @@ module AdfBuilder
     end
 
     def add_color_combination(v_index, interior_color, exterior_color, preference)
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', v_index)
-      if valid
-        cc = ColorCombinations.new(vehicle)
-        cc.add(interior_color, exterior_color, preference)
-        @color_combinations.push(cc)
-      end
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect, "vehicle", v_index)
+      return unless valid
+
+      cc = ColorCombinations.new(vehicle)
+      cc.add(interior_color, exterior_color, preference)
+      @color_combinations.push(cc)
     end
 
     def color_combination(index)
@@ -50,74 +52,72 @@ module AdfBuilder
       @prices[index]
     end
 
-    def add(year, make, model, params={})
-      vehicle = Ox::Element.new('vehicle')
+    def add(year, make, model, params = {})
+      vehicle = Ox::Element.new("vehicle")
 
-      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
       AdfBuilder::Builder.update_params(vehicle, :vehicle, params)
 
-      vehicle << (Ox::Element.new('year') << year.to_s)
-      vehicle << (Ox::Element.new('make') << make)
-      vehicle << (Ox::Element.new('model') << model)
+      vehicle << (Ox::Element.new("year") << year.to_s)
+      vehicle << (Ox::Element.new("make") << make)
+      vehicle << (Ox::Element.new("model") << model)
 
       @prospect << vehicle
     end
 
-    def update_odometer(index, value, params={})
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
-      if valid
-        params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
-        AdfBuilder::Builder.update_node(vehicle, 'odometer', value, params)
-      end
+    def update_odometer(index, value, params = {})
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect, "vehicle", index)
+      return unless valid
+
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(vehicle, "odometer", value, params)
     end
 
     def update_condition(index, value)
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
-      if valid and CONDITIONS.include? value
-        AdfBuilder::Builder.update_node(vehicle, 'condition', value)
-      end
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect, "vehicle", index)
+      return unless valid && CONDITIONS.include?(value)
+
+      AdfBuilder::Builder.update_node(vehicle, "condition", value)
     end
 
-    def update_imagetag(index, value, params={})
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
-      if valid
-        params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
-        AdfBuilder::Builder.update_node(vehicle, 'imagetag', value, params)
-      end
+    def update_imagetag(index, value, params = {})
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect, "vehicle", index)
+      return unless valid
+
+      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
+      AdfBuilder::Builder.update_node(vehicle, "imagetag", value, params)
     end
 
     def update_tags_with_free_text(index, tags)
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
-      if valid
-        tags.each do |key, value|
-          if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
-            AdfBuilder::Builder.update_node(vehicle, key, value)
-          end
-        end
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect, "vehicle", index)
+      return unless valid
+
+      tags.each do |key, value|
+        AdfBuilder::Builder.update_node(vehicle, key, value) if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
       end
     end
 
-    def add_id(index, value, source=nil, sequence=1)
-      if @prospect.locate("vehicle").empty? or @prospect.vehicle(index).nil?
+    def add_id(index, value, source = nil, sequence = 1)
+      if @prospect.locate("vehicle").empty? || @prospect.vehicle(index).nil?
         false
       else
         Id.new.add(@prospect.vehicle(index), value, source, sequence)
       end
     end
 
-    def add_price(index, value, params={})
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
-      if valid
-        price = Price.new(vehicle, value, params)
-        @prices.push(price)
-      end
+    def add_price(index, value, params = {})
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect, "vehicle", index)
+      return unless valid
+
+      price = Price.new(vehicle, value, params)
+      @prices.push(price)
     end
 
     def add_comments(index, value)
-      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
-      if valid
-        AdfBuilder::Builder.update_node(vehicle, 'comments', value)
-      end
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect, "vehicle", index)
+      return unless valid
+
+      AdfBuilder::Builder.update_node(vehicle, "comments", value)
     end
   end
-end
+end

data/lib/adf_builder/vendor/vendor.rb

@@ -1,34 +1,31 @@
+# frozen_string_literal: true
+
 module AdfBuilder
   class Vendor
     def initialize(prospect)
-      @vendor = Ox::Element.new('vendor')
+      @vendor = Ox::Element.new("vendor")
       @contact = nil
       prospect << @vendor
     end
 
-    def contact
-      @contact
-    end
+    attr_reader :contact
 
-    def add(name, contact_name, opts={})
-      @vendor << (Ox::Element.new('vendorname') << name)
+    def add(name, contact_name, opts = {})
+      @vendor << (Ox::Element.new("vendorname") << name)
       @contact = Contact.new(@vendor, contact_name, opts)
     end
 
     def add_url(url)
-      if @vendor.locate("url").size > 0
-        @vendor.remove_children(@vendor.url)
-      end
-      @vendor << (Ox::Element.new('url') << url)
+      @vendor.remove_children(@vendor.url) if @vendor.locate("url").size.positive?
+      @vendor << (Ox::Element.new("url") << url)
     end
 
-    def add_id(index, value, source=nil, sequence=1)
+    def add_id(index, value, source = nil, sequence = 1)
       if @prospect.locate("vendor").empty?
         false
       else
         Id.new.add(@prospect.vendor(index), value, source, sequence)
       end
     end
-
   end
-end
+end

data/lib/adf_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdfBuilder
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

data/lib/adf_builder.rb

@@ -1,38 +1,40 @@
 # frozen_string_literal: true
 
-require 'ox'
-require 'json'
+require "ox"
+require "json"
 
 require_relative "adf_builder/version"
 
 # CUSTOMER
-require_relative 'adf_builder/customer/customer'
+require_relative "adf_builder/customer/customer"
+require_relative "adf_builder/customer/timeframe"
 
 # BASE
-require_relative 'adf_builder/base/base'
-require_relative 'adf_builder/base/prospect'
-require_relative 'adf_builder/base/request_date'
+require_relative "adf_builder/base/base"
+require_relative "adf_builder/base/prospect"
+require_relative "adf_builder/base/request_date"
 
 # PROVIDER
-require_relative 'adf_builder/provider/provider'
+require_relative "adf_builder/provider/provider"
 
 # SHARED
-require_relative 'adf_builder/shared/id'
-require_relative 'adf_builder/shared/contact'
+require_relative "adf_builder/shared/id"
+require_relative "adf_builder/shared/contact"
 
 # VEHICLES
-require_relative 'adf_builder/vehicles/vehicles'
-require_relative 'adf_builder/vehicles/colorcombinations'
-require_relative 'adf_builder/vehicles/price'
+require_relative "adf_builder/vehicles/vehicles"
+require_relative "adf_builder/vehicles/colorcombinations"
+require_relative "adf_builder/vehicles/price"
 
 # VENDOR
-require_relative 'adf_builder/vendor/vendor'
+require_relative "adf_builder/vendor/vendor"
 
 module AdfBuilder
   class Error < StandardError; end
+
   class Builder
     def initialize
-      @doc = self.init_doc
+      @doc = init_doc
       @base = Base.new(@doc)
     end
 
@@ -50,17 +52,17 @@ module AdfBuilder
       prospect = Ox::Element.new("prospect")
 
       request_date = Ox::Element.new("requestdate")
-      request_date << '2000-03-30T15:30:20-08:00'
+      request_date << "2000-03-30T15:30:20-08:00"
 
-      vehicle = Ox::Element.new('vehicle')
+      vehicle = Ox::Element.new("vehicle")
       year = Ox::Element.new("year")
-      year << '1999'
+      year << "1999"
 
       make = Ox::Element.new("make")
-      make << 'Chevrolet'
+      make << "Chevrolet"
 
       model = Ox::Element.new("model")
-      model << 'Blazer'
+      model << "Blazer"
 
       vehicle << year << make << model
 
@@ -69,11 +71,11 @@ module AdfBuilder
       contact = Ox::Element.new("contact")
 
       name = Ox::Element.new("name")
-      name[:part] = 'full'
-      name << 'John Doe'
+      name[:part] = "full"
+      name << "John Doe"
 
       phone = Ox::Element.new("phone")
-      phone << '393-999-3922'
+      phone << "393-999-3922"
 
       contact << name << phone
       customer << contact
@@ -82,8 +84,8 @@ module AdfBuilder
 
       contact = Ox::Element.new("contact")
       name = Ox::Element.new("name")
-      name[:part] = 'full'
-      name << 'Acura of Bellevue'
+      name[:part] = "full"
+      name << "Acura of Bellevue"
 
       contact << name
       vendor << contact
@@ -103,11 +105,11 @@ module AdfBuilder
     def init_doc
       doc = Ox::Document.new
       instruct = Ox::Instruct.new(:xml)
-      instruct[:version] = '1.0'
+      instruct[:version] = "1.0"
       doc << instruct
       doc << Ox::Raw.new("")
-      instruct = Ox::Instruct.new('ADF')
-      instruct[:version] = '1.0'
+      instruct = Ox::Instruct.new("ADF")
+      instruct[:version] = "1.0"
       doc << instruct
       adf = Ox::Element.new("adf")
       doc << adf
@@ -115,10 +117,10 @@ module AdfBuilder
     end
 
     # we will either create a new node with the value or replace the one if it is available
-    def self.update_node(parent_node, key, value, params={})
+    def self.update_node(parent_node, key, value, params = {})
       key = key.to_s
       value = value.to_s
-      if parent_node.locate(key).size > 0
+      if parent_node.locate(key).size.positive?
         node = parent_node.locate(key).first
         node.replace_text(value)
       else
@@ -132,12 +134,13 @@ module AdfBuilder
     # update the params by first checking if they are valid params and then checking if the values are valid if necessary
     def self.update_params(node, key, params)
       return true if params.empty?
+
       key = key.to_sym
       valid_values = params[:valid_values]
       valid_parameters = params[:valid_parameters]
-      _params = AdfBuilder::Builder.whitelabel_params(params,valid_parameters, key)
-      _params.each do |k,v|
-        node[k] = v if valid_values[key][k] == true or valid_values[key][k].include? v.to_s
+      _params = AdfBuilder::Builder.whitelabel_params(params, valid_parameters, key)
+      _params.each do |k, v|
+        node[k] = v if (valid_values[key][k] == true) || valid_values[key][k].include?(v.to_s)
       end
     end
 
@@ -148,7 +151,7 @@ module AdfBuilder
 
     def self.valid_child?(parent, tag_name, index)
       child = parent.locate(tag_name)[index]
-      return !child.nil?,child
+      [!child.nil?, child]
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: adf_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - marcus.salinas
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -24,6 +23,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
 description: Easily create XML in ADF format to send by email.
 email:
 - 12.marcus.salinas@gmail.com
@@ -49,6 +90,7 @@ files:
 - lib/adf_builder/base/prospect.rb
 - lib/adf_builder/base/request_date.rb
 - lib/adf_builder/customer/customer.rb
+- lib/adf_builder/customer/timeframe.rb
 - lib/adf_builder/data/iso-4217-currency-codes.json
 - lib/adf_builder/provider/provider.rb
 - lib/adf_builder/shared/contact.rb
@@ -65,7 +107,6 @@ metadata:
   homepage_uri: https://github.com/jippylong12/adf_builder
   source_code_uri: https://github.com/jippylong12/adf_builder
   changelog_uri: https://github.com/jippylong12/adf_builder/blob/main/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -73,15 +114,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Create XML for the Auto-base Date Format
 test_files: []