edifact_rails 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecc255d266d797eed361491b7643a6ca1a4e03205d214da5c447d4966d0cfb10
-  data.tar.gz: e7aa5f7730944a6b1f6b5adf9809b5d097ae2daf0bef00cd4f84c7433515b122
+  metadata.gz: 617b14ce31edcecdb4d3c4a599f79612716680513a740a425f2bcd0cdb8f1d65
+  data.tar.gz: aa8d78ea8759f43a1465e2036c55ea704c1dce3f4c67c30f943324d32525787c
 SHA512:
-  metadata.gz: f0976e015521c0145fd8f4fcca85be2acd5206cf88a31a1bae6cc2d1b88068315930fadf37e1c189c04adab02720fe80b743b14e0818de33d9bbdba3b2d06d00
-  data.tar.gz: 8f234c0556584570683113037fd3289cad26615fe03e933de3c3618957d0b6142c0a787cefcafa4f913b89564daf7c87bec56d24b61706320c54ea6f3f0800b6
+  metadata.gz: a7531b90d3f9d84223e3176fd6ebd012a26076d3f029e30c344c2ab2a26964c069e8a387f5c73c02445cccbc140e3bdba81bbb832ac08c07af7625bc56a4f686
+  data.tar.gz: ccd019d6bd9beac78be1c07563357a4b6f616bdb538e9a66b5b816a2a6ceadcd7abb05749940a8bf6277cc2d9507da0a003e6f8954fa0d90ef6588ade5327f71

data/CHANGELOG.md

@@ -1,33 +1,45 @@
 # Changelog
 
-## 1.0.0 (26/04/2023)
+## 2.1.0 (18/06/2024)
 
-* Initial release
+* Added EDIFACT serialization. Contributed by [sallesma](https://github.com/sallesma)
 
-## 1.1.0 (27/04/2023)
+## 2.0.0 (18/06/2024)
 
-* Added support for TRADACOMS input
+* Added support for ANSIX12 format.
 
-## 1.1.1 (4/05/2023)
+##### Breaking changes:
+* `#una_special_characters` renamed to `#special_characters` (since it can now accept input of any supported format)
+* New `UnrecognizedFormat` Error will now be thrown if the format of the input can not be detected.
+    * In essence, input must begin now with `UNA` or `UNB` (EDIFACT), `STX` (TRADACOMS), or `ISA` (ANSIX12)
 
-* Fixed crash caused by running the gem in a production environment.
+## 1.2.1 (4/06/2024)
+
+* `#una_special_characters` method now also returns decimal notation character, default `.`.
+* `#una_special_characters` method can now take no arguments, and will return the default special characters if so.
 
 ## 1.2.0 (31/05/2024)
 
 * Added support for UNA segments. Special characters different from the defaults can now be used.
 * Added `#una_special_characters` method that returns just the special characters.
 
-## 1.2.1 (4/06/2024)
+## 1.1.1 (4/05/2023)
+
+* Fixed crash caused by running the gem in a production environment.
+
+## 1.1.0 (27/04/2023)
+
+* Added support for TRADACOMS input
+
+## 1.0.0 (26/04/2023)
+
+* Initial release
+
+
+
+
 
-* `#una_special_characters` method now also returns decimal notation character, default `.`.
-* `#una_special_characters` method can now take no arguments, and will return the default special characters if so.
 
-## 2.0.0 (18/06/2024)
 
-* Added support for ANSIX12 format.
 
-##### Breaking changes:
-* `#una_special_characters` renamed to `#special_characters` (since it can now accept input of any supported format)
-* New `UnrecognizedFormat` Error will now be thrown if the format of the input can not be detected.
-    * In essence, input must begin now with `UNA` or `UNB` (EDIFACT), `STX` (TRADACOMS), or `ISA` (ANSIX12)
 

data/README.md

@@ -2,7 +2,7 @@
 
 This gem parses EDIFACT, TRADACOMS, or ANSIX12 input, and converts it into a ruby array structure for whatever further processing or validation you desire.
 
-It does not handle validation itself.
+This gem can also take a ruby array input, and serialize it into EDIFACT.
 
 This gem is heavily inspired by [edifact_parser](https://github.com/pvdvreede/edifact_parser)
 
@@ -20,7 +20,7 @@ This gem has been tested on the following ruby versions:
 In your `Gemfile`:
 
 ```ruby
-gem 'edifact_rails', '~> 2.0.0'
+gem 'edifact_rails', '~> 2.1.0'
 ```
 
 Otherwise:
@@ -36,6 +36,7 @@ If you don't have the gem in your `Gemfile`, you will need to:
 ```ruby
 require 'edifact_rails'
 ```
+### Parsing
 
 You can parse a string input with `#parse`, or a file with `#parse_file`
 
@@ -47,6 +48,24 @@ ruby_array = EdifactRails.parse("UNB+UNOA:3+TESTPLACE:1+DEP1:1+20051107:1159+600
 ruby_array = EdifactRails.parse_file("your/file/path")
 ```
 
+### Serialization
+
+You can convert a ruby input into EDIFACT with `#serialize`. Use the `with_service` option to insert the UNA segment.
+
+```ruby
+edifact_output = Edifact.serialize(
+  [
+    ["LIN", [1], [1], ["0764569104", "IB"]],
+    ["QTY", [1, 25]]
+  ],
+  with_service: true
+)
+# edifact_output =>
+"UNA:+.? 'LIN+1+1+0764569104:IB'QTY+1:25'"
+```
+
+### Special Characters
+
 You can return the special characters of your input with `#special_characters`.
 ```ruby
 special_characters = EdifactRails.special_characters(example_edifact_input)
@@ -60,7 +79,7 @@ special_characters = EdifactRails.special_characters(example_edifact_input)
 }
 ```
 
-## Output
+## Parse Output
 
 ### EDIFACT
 

data/lib/edifact_rails/serializer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module EdifactRails
+  class Serializer
+    # with_service is used to force the service segment (UNA) at the beginning of the message
+    def serialize(segments, with_service:)
+      # Serialize and join the segments
+      output = segments.map { |segment| serialize_segment(segment) }
+                       .join(EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:segment_seperator])
+
+      # Add the UNA segment
+      output.insert(0, "UNA:+.? '") unless segments.first.first == "UNA" || !with_service
+      output + EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:segment_seperator]
+    end
+
+    private
+
+    # Serialize the data elements and join them to serialize the segment
+    def serialize_segment(segment)
+      return if segment.empty?
+
+      # Get the tag
+      tag = segment.first
+      data_elements = segment[1..]
+
+      # Serialize the data elements
+      serialized_elements = data_elements.map { |element| serialize_data_element(element) }
+
+      # Join tag and data elements
+      serialized_elements.prepend(tag).join(EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:data_element_seperator])
+    end
+
+    def serialize_data_element(element)
+      element.map { |component| treat_component(component) }
+             .join(EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:component_data_element_seperator])
+    end
+
+    # Strip, remove escape characters, convert to nil where needed, convert to integer where needed
+    def treat_component(component)
+      return component unless component.is_a? String
+
+      # Prepare regex
+      all_special_characters = [
+        EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:segment_seperator],
+        EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:data_element_seperator],
+        EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:component_data_element_seperator],
+        EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:escape_character]
+      ].join
+
+      # If the component has escaped characters in it, prepend the escape character "+" -> "?+", "?" -> "??"
+      component.gsub(/([#{Regexp.quote(all_special_characters)}])/) do |match|
+        EdifactRails::DEFAULT_SPECIAL_CHARACTERS[:escape_character] + match
+      end
+    end
+  end
+end

data/lib/edifact_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EdifactRails
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/edifact_rails.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "edifact_rails/parser"
+require "edifact_rails/serializer"
 require "edifact_rails/formats"
 require "edifact_rails/exceptions"
 
@@ -26,4 +27,9 @@ module EdifactRails
     parser = EdifactRails::Parser.new
     parser.special_characters(string)
   end
+
+  def self.serialize(array, with_service: true)
+    serializer = EdifactRails::Serializer.new
+    serializer.serialize array, with_service: with_service
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edifact_rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - David Blackwood
@@ -127,6 +127,7 @@ files:
 - lib/edifact_rails/exceptions.rb
 - lib/edifact_rails/formats.rb
 - lib/edifact_rails/parser.rb
+- lib/edifact_rails/serializer.rb
 - lib/edifact_rails/version.rb
 homepage: https://github.com/david-blackwood/edifact_rails
 licenses: