lib/eddy/models/segment.rb in eddy-0.5.1 vs lib/eddy/models/segment.rb in eddy-0.6.0

- old
+ new

@@ -1,35 +1,37 @@ module Eddy - # Base class for EDI Segments. - class Segment + module Models + # Base class for EDI Segments. + class Segment - # An alphanumeric code unique to each Segment type. - # @return [String] - attr_reader :id - # Short name of the Segment. - # @return [String] - attr_reader :name - # @return [Array<Element>] - attr_accessor :elements - # @return [Eddy::Data::Store] Data passed down from a Transaction Set. - attr_accessor :store + # An alphanumeric code unique to each Segment type. + # @return [String] + attr_reader :id + # Short name of the Segment. + # @return [String] + attr_reader :name + # @return [Array<Element>] + attr_accessor :elements + # @return [Eddy::Data::Store] Data passed down from a Transaction Set. + attr_accessor :store - # All of a Segment's elements need to be declared in its constructor. - # - # @param store [Eddy::Data::Store] - # @param elements [Eddy::Element::Base] - # @return [void] - def initialize(store, *elements) - self.store = store - elements.flatten! - self.elements = elements || [] - end + # All of a Segment's elements need to be declared in its constructor. + # + # @param store [Eddy::Data::Store] + # @param elements [Eddy::Models::Element::Base] + # @return [void] + def initialize(store, *elements) + self.store = store + elements.flatten! + self.elements = elements || [] + end - # @param separator [String] (self.store.element_separator) String used to delimit elements within a segment. - # @return [String] - def render(separator = self.store.element_separator) - segment = [self.id, self.elements.map(&:value)].join(separator) - return Eddy::Util.trim_delims_from_segment(segment, separator: separator) - end + # @param separator [String] (self.store.element_separator) String used to delimit elements within a segment. + # @return [String] + def render(separator = self.store.element_separator) + segment = [self.id, self.elements.map(&:value)].join(separator) + return Eddy::Util.trim_delims_from_segment(segment, separator: separator) + end + end end end