Module: Eddy

Defined in:
lib/eddy.rb,
lib/eddy/cli.rb,
lib/eddy/data.rb,
lib/eddy/util.rb,
lib/eddy/build.rb,
lib/eddy/parse.rb,
lib/eddy/config.rb,
lib/eddy/errors.rb,
lib/eddy/models.rb,
lib/eddy/summary.rb,
lib/eddy/version.rb,
lib/eddy/util/read.rb,
lib/eddy/util/time.rb,
lib/eddy/util/trim.rb,
lib/eddy/data/store.rb,
lib/eddy/util/paths.rb,
lib/eddy/summary/loop.rb,
lib/eddy/util/edi_data.rb,
lib/eddy/models/element.rb,
lib/eddy/models/segment.rb,
lib/eddy/util/normalize.rb,
lib/eddy/util/timestamp.rb,
lib/eddy/build/loop/base.rb,
lib/eddy/summary/element.rb,
lib/eddy/summary/segment.rb,
lib/eddy/util/new_number.rb,
lib/eddy/build/elements/n.rb,
lib/eddy/models/element/b.rb,
lib/eddy/models/element/n.rb,
lib/eddy/models/element/r.rb,
lib/eddy/models/loop/base.rb,
lib/eddy/summary/validate.rb,
lib/eddy/build/elements/id.rb,
lib/eddy/build/loop/render.rb,
lib/eddy/build/loop/repeat.rb,
lib/eddy/models/element/an.rb,
lib/eddy/models/element/dt.rb,
lib/eddy/models/element/id.rb,
lib/eddy/models/element/tm.rb,
lib/eddy/parse/interchange.rb,
lib/eddy/util/clean_folder.rb,
lib/eddy/models/interchange.rb,
lib/eddy/models/loop/repeat.rb,
lib/eddy/models/element/base.rb,
lib/eddy/build/segment_builder.rb,
lib/eddy/data/persistence/base.rb,
lib/eddy/data/persistence/file.rb,
lib/eddy/build/elements/element.rb,
lib/eddy/models/transaction_set.rb,
lib/eddy/build/elements/elements.rb,
lib/eddy/data/persistence/memory.rb,
lib/eddy/models/functional_group.rb,
lib/eddy/summary/transaction_set.rb,
lib/eddy/models/element/composite.rb,
lib/definitions/segments/manual/hl.rb,
lib/definitions/segments/manual/n2.rb,
lib/definitions/segments/generated/hl.rb,
lib/definitions/segments/generated/n1.rb,
lib/definitions/segments/generated/n2.rb,
lib/definitions/segments/generated/n3.rb,
lib/definitions/segments/generated/n4.rb,
lib/definitions/segments/generated/n9.rb,
lib/definitions/segments/generated/ack.rb,
lib/definitions/segments/generated/amt.rb,
lib/definitions/segments/generated/bak.rb,
lib/definitions/segments/generated/beg.rb,
lib/definitions/segments/generated/bia.rb,
lib/definitions/segments/generated/big.rb,
lib/definitions/segments/generated/bsn.rb,
lib/definitions/segments/generated/cad.rb,
lib/definitions/segments/generated/ctp.rb,
lib/definitions/segments/generated/ctt.rb,
lib/definitions/segments/generated/cur.rb,
lib/definitions/segments/generated/dtm.rb,
lib/definitions/segments/generated/fob.rb,
lib/definitions/segments/generated/it1.rb,
lib/definitions/segments/generated/itd.rb,
lib/definitions/segments/generated/lin.rb,
lib/definitions/segments/generated/man.rb,
lib/definitions/segments/generated/mtx.rb,
lib/definitions/segments/generated/per.rb,
lib/definitions/segments/generated/pid.rb,
lib/definitions/segments/generated/po1.rb,
lib/definitions/segments/generated/po3.rb,
lib/definitions/segments/generated/prf.rb,
lib/definitions/segments/generated/qty.rb,
lib/definitions/segments/generated/ref.rb,
lib/definitions/segments/generated/sac.rb,
lib/definitions/segments/generated/sch.rb,
lib/definitions/segments/generated/sdq.rb,
lib/definitions/segments/generated/sln.rb,
lib/definitions/segments/generated/sn1.rb,
lib/definitions/segments/generated/td1.rb,
lib/definitions/segments/generated/td5.rb,
lib/definitions/segments/generated/tds.rb,
lib/definitions/segments/generated/txi.rb,
lib/eddy/build/transaction_set_builder.rb,
lib/definitions/elements/manual/337.time.rb,
lib/definitions/elements/manual/373.date.rb,
lib/definitions/elements/manual/misc/93.name.rb,
lib/definitions/segments/manual/envelopes/ge.rb,
lib/definitions/segments/manual/envelopes/gs.rb,
lib/definitions/segments/manual/envelopes/se.rb,
lib/definitions/segments/manual/envelopes/st.rb,
lib/definitions/elements/generated/183.volume.rb,
lib/definitions/elements/generated/610.amount.rb,
lib/definitions/segments/manual/envelopes/iea.rb,
lib/definitions/segments/manual/envelopes/isa.rb,
lib/definitions/elements/generated/387.routing.rb,
lib/definitions/elements/generated/954.percent.rb,
lib/definitions/elements/manual/misc/81.weight.rb,
lib/definitions/elements/generated/19.city_name.rb,
lib/definitions/elements/generated/380.quantity.rb,
lib/definitions/elements/manual/116.postal_code.rb,
lib/definitions/elements/manual/785.binary_data.rb,
lib/definitions/transaction_sets/manual/810/810.rb,
lib/definitions/transaction_sets/manual/846/846.rb,
lib/definitions/transaction_sets/manual/850/850.rb,
lib/definitions/transaction_sets/manual/855/855.rb,
lib/definitions/transaction_sets/manual/856/856.rb,
lib/definitions/elements/generated/212.unit_price.rb,
lib/definitions/elements/generated/347.hash_total.rb,
lib/definitions/elements/generated/649.multiplier.rb,
lib/definitions/elements/generated/26.country_code.rb,
lib/definitions/elements/generated/352.description.rb,
lib/definitions/elements/generated/100.currency_code.rb,
lib/definitions/elements/generated/1551.message_text.rb,
lib/definitions/elements/generated/22.commodity_code.rb,
lib/definitions/elements/generated/280.exchange_rate.rb,
lib/definitions/elements/generated/76.invoice_number.rb,
lib/definitions/elements/generated/963.tax_type_code.rb,
lib/definitions/transaction_sets/manual/810/loops/n1.rb,
lib/definitions/transaction_sets/manual/846/loops/n1.rb,
lib/definitions/transaction_sets/manual/850/loops/n1.rb,
lib/definitions/transaction_sets/manual/850/loops/n9.rb,
lib/definitions/transaction_sets/manual/855/loops/n1.rb,
lib/definitions/transaction_sets/manual/856/loops/n1.rb,
lib/definitions/elements/generated/103.packaging_code.rb,
lib/definitions/elements/generated/328.release_number.rb,
lib/definitions/elements/generated/386.terms_net_days.rb,
lib/definitions/elements/generated/80.lading_quantity.rb,
lib/definitions/elements/manual/i/I14.usage_indicator.rb,
lib/definitions/transaction_sets/manual/810/loops/it1.rb,
lib/definitions/transaction_sets/manual/810/loops/pid.rb,
lib/definitions/transaction_sets/manual/810/loops/sac.rb,
lib/definitions/transaction_sets/manual/846/loops/lin.rb,
lib/definitions/transaction_sets/manual/846/loops/qty.rb,
lib/definitions/transaction_sets/manual/846/loops/sch.rb,
lib/definitions/transaction_sets/manual/846/loops/sln.rb,
lib/definitions/transaction_sets/manual/850/loops/ctp.rb,
lib/definitions/transaction_sets/manual/850/loops/pid.rb,
lib/definitions/transaction_sets/manual/850/loops/po1.rb,
lib/definitions/transaction_sets/manual/850/loops/sac.rb,
lib/definitions/transaction_sets/manual/855/loops/ack.rb,
lib/definitions/transaction_sets/manual/855/loops/pid.rb,
lib/definitions/transaction_sets/manual/855/loops/po1.rb,
lib/definitions/transaction_sets/manual/856/loops/sln.rb,
lib/definitions/elements/generated/336.terms_type_code.rb,
lib/definitions/elements/generated/367.contract_number.rb,
lib/definitions/elements/generated/782.monetary_amount.rb,
lib/definitions/elements/manual/i/I08.interchange_date.rb,
lib/definitions/elements/manual/i/I09.interchange_time.rb,
lib/definitions/elements/generated/187.weight_qualifier.rb,
lib/definitions/elements/generated/207.equipment_number.rb,
lib/definitions/elements/generated/330.quantity_ordered.rb,
lib/definitions/elements/generated/755.report_type_code.rb,
lib/definitions/elements/generated/87.marks_and_numbers.rb,
lib/definitions/elements/manual/28.group_control_number.rb,
lib/definitions/elements/generated/206.equipment_initial.rb,
lib/definitions/elements/generated/358.quantity_invoiced.rb,
lib/definitions/elements/generated/662.relationship_code.rb,
lib/definitions/elements/generated/79.lading_description.rb,
lib/definitions/elements/generated/1019.invoice_type_code.rb,
lib/definitions/elements/generated/1232.purchase_category.rb,
lib/definitions/elements/generated/234.product_service_id.rb,
lib/definitions/elements/generated/284.service_level_code.rb,
lib/definitions/elements/generated/309.location_qualifier.rb,
lib/definitions/elements/generated/311.shipment_type_code.rb,
lib/definitions/elements/generated/371.change_reason_code.rb,
lib/definitions/elements/generated/446.terms_net_due_date.rb,
lib/definitions/elements/generated/67.identification_code.rb,
lib/definitions/elements/generated/673.quantity_qualifier.rb,
lib/definitions/elements/manual/784.length_of_binary_data.rb,
lib/definitions/transaction_sets/manual/856/loops/hl_item.rb,
lib/definitions/transaction_sets/manual/856/loops/hl_tare.rb,
lib/definitions/elements/generated/1166.contract_type_code.rb,
lib/definitions/elements/generated/166.address_information.rb,
lib/definitions/elements/generated/310.location_identifier.rb,
lib/definitions/elements/generated/363.note_reference_code.rb,
lib/definitions/elements/generated/374.date_time_qualifier.rb,
lib/definitions/elements/generated/587.acknowledgment_type.rb,
lib/definitions/elements/generated/687.class_of_trade_code.rb,
lib/definitions/elements/generated/786.security_level_code.rb,
lib/definitions/elements/manual/156.state_or_province_code.rb,
lib/definitions/elements/manual/i/I04.security_information.rb,
lib/definitions/transaction_sets/manual/856/loops/hl_order.rb,
lib/definitions/elements/generated/354.number_of_line_items.rb,
lib/definitions/elements/generated/364.communication_number.rb,
lib/definitions/elements/manual/350.assigned_identification.rb,
lib/definitions/elements/manual/455.responsible_agency_code.rb,
lib/definitions/elements/manual/i/I06.interchange_sender_id.rb,
lib/definitions/elements/generated/133.routing_sequence_code.rb,
lib/definitions/elements/generated/236.price_identifier_code.rb,
lib/definitions/elements/generated/324.purchase_order_number.rb,
lib/definitions/elements/generated/333.terms_basis_date_code.rb,
lib/definitions/elements/generated/349.item_description_type.rb,
lib/definitions/elements/generated/366.contact_function_code.rb,
lib/definitions/elements/generated/369.free_form_description.rb,
lib/definitions/elements/generated/522.amount_qualifier_code.rb,
lib/definitions/elements/generated/559.agency_qualifier_code.rb,
lib/definitions/elements/generated/640.transaction_type_code.rb,
lib/definitions/elements/generated/668.line_item_status_code.rb,
lib/definitions/elements/generated/98.entity_identifier_code.rb,
lib/definitions/elements/manual/142.application_senders_code.rb,
lib/definitions/elements/generated/322.load_empty_status_code.rb,
lib/definitions/elements/generated/338.terms_discount_percent.rb,
lib/definitions/elements/manual/hl/628.hierarchical_id_number.rb,
lib/definitions/elements/manual/i/I07.interchange_receiver_id.rb,
lib/definitions/transaction_sets/manual/856/loops/hl_shipment.rb,
lib/definitions/elements/generated/23.commodity_code_qualifier.rb,
lib/definitions/elements/generated/351.terms_discount_days_due.rb,
lib/definitions/elements/generated/370.terms_discount_due_date.rb,
lib/definitions/elements/generated/382.number_of_units_shipped.rb,
lib/definitions/elements/generated/396.shipment_identification.rb,
lib/definitions/elements/generated/92.purchase_order_type_code.rb,
lib/definitions/elements/manual/124.application_receivers_code.rb,
lib/definitions/elements/manual/479.functional_identifier_code.rb,
lib/definitions/elements/manual/96.number_of_included_segments.rb,
lib/definitions/elements/manual/hl/735.hierarchical_level_code.rb,
lib/definitions/elements/manual/hl/736.hierarchical_child_code.rb,
lib/definitions/elements/manual/i/I05.interchange_id_qualifier.rb,
lib/definitions/elements/manual/i/I13.acknowledgment_requested.rb,
lib/definitions/elements/generated/127.reference_identification.rb,
lib/definitions/elements/generated/326.request_reference_number.rb,
lib/definitions/elements/generated/639.basis_of_unit_price_code.rb,
lib/definitions/elements/generated/646.quantity_shipped_to_date.rb,
lib/definitions/elements/generated/751.product_description_code.rb,
lib/definitions/elements/manual/140.standard_carrier_alpha_code.rb,
lib/definitions/elements/manual/i/I02.authorization_information.rb,
lib/definitions/elements/generated/325.tax_identification_number.rb,
lib/definitions/elements/manual/i/I12.interchange_control_number.rb,
lib/definitions/elements/generated/146.shipment_method_of_payment.rb,
lib/definitions/elements/generated/368.shipment_order_status_code.rb,
lib/definitions/elements/generated/648.price_multiplier_qualifier.rb,
lib/definitions/elements/generated/88.marks_and_numbers_qualifier.rb,
lib/definitions/elements/manual/i/I15.component_element_separator.rb,
lib/definitions/elements/generated/1005.hierarchical_structure_code.rb,
lib/definitions/elements/generated/235.product_service_id_qualifier.rb,
lib/definitions/elements/generated/327.change_order_sequence_number.rb,
lib/definitions/elements/generated/353.transaction_set_purpose_code.rb,
lib/definitions/elements/generated/66.identification_code_qualifier.rb,
lib/definitions/elements/manual/143.transaction_set_identifier_code.rb,
lib/definitions/elements/generated/248.allowance_or_charge_indicator.rb,
lib/definitions/elements/manual/329.transactional_set_control_number.rb,
lib/definitions/elements/manual/hl/734.hierarchical_parent_id_number.rb,
lib/definitions/elements/manual/i/I03.security_information_qualifier.rb,
lib/definitions/elements/generated/365.communication_number_qualifier.rb,
lib/definitions/elements/generated/91.transportation_method_type_code.rb,
lib/definitions/elements/manual/97.number_of_transaction_sets_included.rb,
lib/definitions/elements/manual/i/I11.interchange_control_version_number.rb,
lib/definitions/elements/generated/128.reference_identification_qualifier.rb,
lib/definitions/elements/generated/355.unit_or_basis_for_measurement_code.rb,
lib/definitions/elements/generated/378.allowance_charge_percent_qualifier.rb,
lib/definitions/elements/manual/i/I01.authorization_information_qualifier.rb,
lib/definitions/elements/generated/750.product_process_characteristic_code.rb,
lib/definitions/elements/manual/i/I16.number_of_included_functional_groups.rb,
lib/definitions/elements/manual/480.version_release_industry_identifier_code.rb,
lib/definitions/elements/manual/i/I10.interchange_control_standards_identifier.rb,
lib/definitions/elements/generated/1300.service_promotion_allowance_or_charge_code.rb,
lib/definitions/elements/generated/1301.agency_service_promotion_allowance_or_charge_code.rb

Overview

EDI Toolkit.

Defined Under Namespace

Modules: Build, Data, Elements, Errors, Models, Parse, Segments, Summary, TransactionSets, Util Classes: CLI, Config

Constant Summary collapse

VERSION = 
"0.10.0".freeze()

Class Method Summary collapse

Class Method Details

.clear_data ⇒ void

This method returns an undefined value.

Set @data to nil so that a new persistence_method can be set up.



61
62
63
 
# File 'lib/eddy.rb', line 61

def self.clear_data()
  @data = nil
end

.config ⇒ Eddy::Config

Configuration for Eddy.

Returns:



22
23
24
 
# File 'lib/eddy.rb', line 22

def self.config()
  @config ||= Config.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Modify Eddy's current config.

Examples:

Eddy.configure do |config|
  config.persistence_method = :file
end

Yield Parameters:



35
36
37
 
# File 'lib/eddy.rb', line 35

def self.configure()
  yield self.config()
end

.data ⇒ Eddy::Data::Persistence::Base

Persistent data used by Eddy.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/eddy.rb', line 42

def self.data
  return @data if defined?(@data) && !@data.nil?
  case Eddy.config.persistence_method
  when :memory then @data = Eddy::Data::Persistence::Memory.new()
  when :file   then raise NotImplementedError
  when :active_record
    if defined?(Rails) && defined?(Eddy::Rails)
      @data = Eddy::Data::Persistence::ActiveRecord.new()
    else
      raise Eddy::Errors::Error, "ActiveRecord persistence method can currently only be used with Ruby on Rails"
    end
  else raise Eddy::Errors::Error, "Unsupported persistence method: #{Eddy.config.persistence_method}"
  end
  return @data
end