edifact_rails 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1343d4c915c6df4b716c31560cf58d5b350dc18ad074c12c3c562b13b0ce3717
+  data.tar.gz: 6067a62e4bdf24f2be92306a6aa4d4e21b9aa3b69ac6eff3eba8a8ae97229627
+SHA512:
+  metadata.gz: 8e1ce36c70da1e16fce1596fd43b345f5a284a77b82645b901d6eb88f25ae45c45d152aae760477526bd1c0230f59890f602c40fbded3cd3be61a80a8926e1c7
+  data.tar.gz: 2feffb89e9df203d37eb0f8aab6bcb673630dd637092a5fe406de9eff0d244d074fd964b1d10e7c68a75a48b9f75f58168240d42e7c2d900f469468be0a049d5

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@lokalise.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/.github/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Don't forget to add specs and make sure they pass by running `rspec .`.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you.
+6. If necessary, add documentation for your feature or bug fix.
+7. Commit and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
+[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request. Were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. 

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 1.0.0 (26/04/2023)
+
+* Initial release
+
+## 1.1.0 (27/04/2023)
+
+* Added support for TRADACOMS input

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 David Blackwood
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,169 @@
+# EdifactRails
+
+This gem parses EDIFACT or TRADACOMS 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 is heavily inspired by and attempts to output similar results as [edifact_parser](https://github.com/pvdvreede/edifact_parser), credits to [pvdvreede](https://github.com/pvdvreede)
+
+## Requirements
+
+This gem requires Ruby 3.0+.
+
+This gem has been tested on the following ruby versions:
+* 3.0.6
+* 3.1.2
+* 3.2.2
+
+## Getting started 
+
+In your `Gemfile`:
+
+```ruby
+gem 'edifact_rails', '~> 1.0'
+```
+
+Otherwise:
+
+```
+gem install edifact_rails
+```
+
+## Usage
+
+If you don't have the gem in your `Gemfile`, you will need to:
+
+```ruby
+require 'edifact_rails'
+```
+
+You can pass either the path to your EDIFACT (or TRADACOMS) file, or a document (or snippet) as a string:
+
+```ruby
+ruby_array = EdifactRails.parse_file("your/file/path")
+```
+
+```ruby
+ruby_array = EdifactRails.parse("LIN+1+1+0764569104:IB'QTY+1:25'")
+```
+
+## Output
+
+### EDIFACT
+
+This example EDIFACT file:
+
+```
+UNA:+.? '
+UNB+UNOA:3+TESTPLACE:1+DEP1:1+20051107:1159+6002'
+UNH+SSDD1+ORDERS:D:03B:UN:EAN008'
+BGM+220+BKOD99+9'
+DTM+137:20051107:102'
+NAD+BY+5412345000176::9'
+NAD+SU+4012345000094::9'
+LIN+1+1+0764569104:IB'
+QTY+1:25'
+FTX+AFM+1++XPath 2.0 Programmer?'s Reference'
+LIN+2+1+0764569090:IB'
+QTY+1:25'
+FTX+AFM+1++XSLT 2.0 Programmer?'s Reference'
+LIN+3+1+1861004656:IB'
+QTY+1:16'
+FTX+AFM+1++Java Server Programming'
+LIN+4+1+0596006756:IB'
+QTY+1:10'
+FTX+AFM+1++Enterprise Service Bus'
+UNS+S'
+CNT+2:4'
+UNT+22+SSDD1'
+UNZ+1+6002'
+```
+
+Will be returned as:
+
+```ruby
+[
+  ["UNB", ["UNOA", 3], ["TESTPLACE", 1], ["DEP1", 1], [20051107, 1159], [6002]],
+  ["UNH", ["SSDD1"], ["ORDERS", "D", "03B", "UN", "EAN008"]],
+  ["BGM", [220], ["BKOD99"], [9]],
+  ["DTM", [137, 20051107, 102]],
+  ["NAD", ["BY"], [5412345000176, nil, 9]],
+  ["NAD", ["SU"], [4012345000094, nil, 9]],
+  ["LIN", [1], [1], ["0764569104", "IB"]],
+  ["QTY", [1, 25]],
+  ["FTX", ["AFM"], [1], [], ["XPath 2.0 Programmer's Reference"]],
+  ["LIN", [2], [1], ["0764569090", "IB"]],
+  ["QTY", [1, 25]],
+  ["FTX", ["AFM"], [1], [], ["XSLT 2.0 Programmer's Reference"]],
+  ["LIN", [3], [1], [1861004656, "IB"]],
+  ["QTY", [1, 16]],
+  ["FTX", ["AFM"], [1], [], ["Java Server Programming"]],
+  ["LIN", [4], [1], ["0596006756", "IB"]],
+  ["QTY", [1, 10]],
+  ["FTX", ["AFM"], [1], [], ["Enterprise Service Bus"]],
+  ["UNS", ["S"]],
+  ["CNT", [2, 4]],
+  ["UNT", [22], ["SSDD1"]],
+  ["UNZ", [1], [6002]]
+]
+```
+
+### TRADACOMS
+
+This TRADACOMS file:
+
+```
+STX=ANA:1+5000169000001:DAVEY PLC+5060073022052:Blackwood Limited+230102:050903+3800++ORDHDR'
+MHD=1+ORDHDR:9'
+TYP=0430+NEW-ORDERS'
+SDT=5060073022052:005096+BLACKWOOD LTD'
+CDT=5000169000001:WINDRAKER LTD'
+FIL=3800+1+230102'
+MTR=14'
+MHD=4+ORDERS:9'
+CLO=:777:BLACKWOOD D'
+ORD=B1102300::230102++N'
+DIN=230103+++PM'
+OLD=1+:5000169475119+5000169847442+:047836+12+68++++WR TStem Broccoli Spears'
+DNB=1+1++::128:KENYA/JOR/UK:142::202:060123'
+OLD=2+:5000169073643+5000169159491+:085482+16+15++++WR Asparagus:IFCO 410'
+DNB=2+1++108:200:128:?+?+?+:142::202:080123'
+OLD=3+:5000169073629+5000169048726+:085486+12+28++++WR Fine Asparagus'
+DNB=3+1++108:225:128:THAI/peru:142::202:070123'
+OTR=3'
+MTR=12'
+MHD=5+ORDTLR:9'
+OFT=3'
+MTR=3'
+END=5
+```
+
+Will be returned as:
+
+```ruby
+[
+  ['STX', ['ANA', 1], [5000169000001, 'DAVEY PLC'], [5060073022052, 'Blackwood Limited'], [230102, '050903'], [3800], [], ['ORDHDR']],
+  ['MHD', [1], ['ORDHDR', 9]],
+  ['TYP', ['0430'], ['NEW-ORDERS']],
+  ['SDT', [5060073022052, '005096'], ['BLACKWOOD LTD']],
+  ['CDT', [5000169000001, 'WINDRAKER LTD']],
+  ['FIL', [3800], [1], [230102]],
+  ['MTR', [14]],
+  ['MHD', [4], ['ORDERS', 9]],
+  ['CLO', [nil, 777, 'BLACKWOOD D']],
+  ['ORD', ['B1102300', nil, 230102], [], ['N']],
+  ['DIN', [230103], [], [], ['PM']],
+  ['OLD', [1], [nil, 5000169475119], [5000169847442], [nil, '047836'], [12], [68], [], [], [], ['WR TStem Broccoli Spears']],
+  ['DNB', [1], [1], [], [nil, nil, 128, 'KENYA/JOR/UK', 142, nil, 202, '060123']],
+  ['OLD', [2], [nil, 5000169073643], [5000169159491], [nil, '085482'], [16], [15], [], [], [], ['WR Asparagus', 'IFCO 410']],
+  ['DNB', [2], [1], [], [108, 200, 128, '+++', 142, nil, 202, '080123']],
+  ['OLD', [3], [nil, 5000169073629], [5000169048726], [nil, '085486'], [12], [28], [], [], [], ['WR Fine Asparagus']],
+  ['DNB', [3], [1], [], [108, 225, 128, 'THAI/peru', 142, nil, 202, '070123']],
+  ['OTR', [3]],
+  ['MTR', [12]],
+  ['MHD', [5], ['ORDTLR', 9]],
+  ['OFT', [3]],
+  ['MTR', [3]],
+  ['END', [5]]
+]
+```

data/lib/edifact_rails/parser.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module EdifactRails
+  class Parser
+    ESCAPE_CHARACTER = "?"
+    SEGMENT_SEPARATOR = "'"
+    DATA_ELEMENT_SEPARATOR = "+"
+    COMPONENT_DATA_ELEMENT_SEPARATOR = ":"
+
+    def initialize
+      # Escape the special characters for use in regex later on
+      @escape_char_rx = Regexp.quote(EdifactRails::Parser::ESCAPE_CHARACTER)
+      @segment_separator_rx = Regexp.quote(EdifactRails::Parser::SEGMENT_SEPARATOR)
+      @data_element_separator_rx = Regexp.quote(EdifactRails::Parser::DATA_ELEMENT_SEPARATOR)
+      @component_data_element_separator_rx = Regexp.quote(EdifactRails::Parser::COMPONENT_DATA_ELEMENT_SEPARATOR)
+    end
+
+    # Treat the input a little, split the input string into segments, parse them
+    def parse(string)
+      string = treat_input(string)
+
+      # Split the input string into segments
+      segments = string.split(/(?<!#{@escape_char_rx})#{@segment_separator_rx}/)
+
+      # Detect if the input is a tradacoms file
+      @is_tradacoms = segments.map { |s| s[3] }.uniq == ["="]
+
+      # Drop the UNA segment, if present
+      segments.reject! { |s| s[0..2] == "UNA" }
+
+      # Parse the segments
+      segments.map { |segment| parse_segment(segment) }
+    end
+
+    private
+
+    def treat_input(string)
+      # Trim newlines and excess spaces around those newlines
+      string = string.gsub(/\s*\n\s*/, "")
+
+      # Prepare regex
+      other_specials_rx = Regexp.quote(
+        [
+          EdifactRails::Parser::SEGMENT_SEPARATOR,
+          EdifactRails::Parser::DATA_ELEMENT_SEPARATOR,
+          EdifactRails::Parser::COMPONENT_DATA_ELEMENT_SEPARATOR
+        ].join
+      )
+
+      # If there is an EVEN number of escape characters before a special character,
+      # the special character is therefore unescaped.
+      # Add a space between these even number of escapes, and the special character
+      #
+      # This means the regex logic for #splitting on special characters is now consistent, since there will only ever
+      # be either 0 or 1 escape characters before every special character.
+      #
+      # We have to do this because we can't negative lookbehind for 'an even number of escape characters' since
+      # lookbehinds have to be fixed length.
+      #
+      # The added space, which is now at the boundry of a component,
+      # will get cut by the #strip! in #treat_component eventually
+      #
+      # I must admit this kind of thing is why you should use an actual parser instead of regex for, you know, parsing
+      #
+      # "LIN+even????+123" => '+' is not escaped, gsub'ed => "even???? +123" => parsed => ['LIN', ['even??'], [123]]
+      # "LIN+odd???+123" => '+' is escaped, not gsub'ed => "odd???+123" => parsed => ['LIN', ['odd?+123']]
+      string.gsub(/(?<!#{@escape_char_rx})((#{@escape_char_rx}{2})+)([#{other_specials_rx}])/, '\1 \3')
+    end
+
+    # Split the segment into data elements, take the first as the tag, then parse the rest
+    def parse_segment(segment)
+      # If the input is a tradacoms file, the segment tag will be proceeded by '=' instead of '+'
+      # 'QTY=1+A:B' instead of 'QTY+1+A:B'
+      # Fortunately, this is easily handled by simply changing these "="s into "+"s before the split
+      segment[3] = EdifactRails::Parser::DATA_ELEMENT_SEPARATOR if @is_tradacoms && segment.length >= 4
+
+      # Segments are made up of data elements
+      data_elements = segment.split(/(?<!#{@escape_char_rx})#{@data_element_separator_rx}/)
+
+      # The first element is the tag, pop it off
+      parsed_segment = []
+      parsed_segment.push(data_elements.shift) if data_elements.any?
+
+      # Parse the data elements
+      parsed_segment.concat(data_elements.map { |element| parse_data_element(element) })
+    end
+
+    # Split the data elements into component data elements, and treat them
+    def parse_data_element(element)
+      # Split data element into components
+      components = element.split(/(?<!#{@escape_char_rx})#{@component_data_element_separator_rx}/)
+
+      components.map { |component| treat_component(component) }
+    end
+
+    # Strip, remove escape characters, convert to nil where needed, convert to integer where needed
+    def treat_component(component)
+      # Remove surrounding whitespace
+      component.strip!
+
+      # Prepare regex
+      all_special_characters = [
+        EdifactRails::Parser::SEGMENT_SEPARATOR,
+        EdifactRails::Parser::DATA_ELEMENT_SEPARATOR,
+        EdifactRails::Parser::COMPONENT_DATA_ELEMENT_SEPARATOR,
+        EdifactRails::Parser::ESCAPE_CHARACTER
+      ].join
+
+      # If the component has escaped characters in it, remove the escape character and return the character as is
+      # "?+" -> "+", "??" -> "?"
+      component.gsub!(/#{@escape_char_rx}([#{Regexp.quote(all_special_characters)}])/, '\1')
+
+      # Convert empty strings to nils
+      component = nil if component.empty?
+
+      # Convert the component to integer if it is one
+      # "1" -> 1
+      # "-123" -> -123
+      # "0350" -> "0350"
+      component = component.to_i if component.to_i.to_s == component
+
+      component
+    end
+  end
+end

data/lib/edifact_rails/version.rb

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

data/lib/edifact_rails.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "edifact_rails/parser"
+
+module EdifactRails
+  def self.parse(string)
+    parser = EdifactRails::Parser.new
+    parser.parse string
+  end
+
+  def self.parse_file(file_path)
+    parse(File.read(file_path).split("\n").join)
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: edifact_rails
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- David Blackwood
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: This gem allows you to pass in a EDIFACT string or file, and returns
+  an array structure, to enable additional processing and validation
+email: david.blackwood.94@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/edifact_rails.rb
+- lib/edifact_rails/parser.rb
+- lib/edifact_rails/version.rb
+homepage: https://github.com/david-blackwood/edifact_rails
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Ruby gem that parses an EDIFACT input into a ruby array structure
+test_files: []