adf_builder 0.3.0 → 1.0.0

data/lib/adf_builder/validations.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AdfBuilder
+  module Validations
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def validates_inclusion_of(attribute, in:)
+        @validations ||= []
+        @validations << { type: :inclusion, attribute: attribute, in: binding.local_variable_get(:in) }
+      end
+
+      def validations
+        @validations || []
+      end
+    end
+
+    def validate!
+      self.class.validations.each do |validation|
+        value = @attributes[validation[:attribute]]
+        next if value.nil? # Allow nil unless presence validation is added
+
+        next unless validation[:type] == :inclusion
+
+        allowed = validation[:in]
+        unless allowed.include?(value)
+          raise AdfBuilder::Error,
+                "Invalid value for #{validation[:attribute]}: #{value}. Allowed: #{allowed.join(", ")}"
+        end
+      end
+
+      # Recursively validate children
+      @children.each(&:validate!)
+    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.3.0"
+  VERSION = "1.0.0"
 end

data/lib/adf_builder.rb

@@ -1,39 +1,50 @@
 # 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/timeframe'
+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"
+
+# v1.0 DSL
+# v1.0 DSL
+require_relative "adf_builder/validations"
+require_relative "adf_builder/nodes/node"
+require_relative "adf_builder/nodes/prospect"
+require_relative "adf_builder/nodes/vehicle"
+require_relative "adf_builder/nodes/customer"
+require_relative "adf_builder/serializer"
+require_relative "adf_builder/dsl"
 
 module AdfBuilder
   class Error < StandardError; end
+
   class Builder
     def initialize
-      @doc = self.init_doc
+      @doc = init_doc
       @base = Base.new(@doc)
     end
 
@@ -51,17 +62,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
 
@@ -70,11 +81,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
@@ -83,8 +94,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
@@ -104,11 +115,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
@@ -116,10 +127,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
@@ -133,12 +144,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
 
@@ -149,7 +161,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.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - marcus.salinas
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -24,6 +23,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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
@@ -51,9 +106,16 @@ files:
 - lib/adf_builder/customer/customer.rb
 - lib/adf_builder/customer/timeframe.rb
 - lib/adf_builder/data/iso-4217-currency-codes.json
+- lib/adf_builder/dsl.rb
+- lib/adf_builder/nodes/customer.rb
+- lib/adf_builder/nodes/node.rb
+- lib/adf_builder/nodes/prospect.rb
+- lib/adf_builder/nodes/vehicle.rb
 - lib/adf_builder/provider/provider.rb
+- lib/adf_builder/serializer.rb
 - lib/adf_builder/shared/contact.rb
 - lib/adf_builder/shared/id.rb
+- lib/adf_builder/validations.rb
 - lib/adf_builder/vehicles/colorcombinations.rb
 - lib/adf_builder/vehicles/price.rb
 - lib/adf_builder/vehicles/vehicles.rb
@@ -66,7 +128,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
@@ -74,15 +135,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: []