REX12 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cc9b4181ab6eef0202f152e4439f0f8e910a2b4
+  data.tar.gz: 7a24fe67b66a65ecf873f66c8b5d679f634c7572
+SHA512:
+  metadata.gz: bef125ee1434d128bdf29dbef47690f08e56dc49f059ff60ab8efa626f51aa6f66613ccc01cd03438c380ba7812d28b1cf5b0ba51daa867eea4828572f317940
+  data.tar.gz: fa887dbd357176382fc73bffc59b001aa572eca3b8e2724d5558960f2ad57cc7c99bb037e56f58fb92b4f8174758a84449e923ff2834f8d0f56a16dcc764db09

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 brian@brian-glick.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rex12.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brian Glick
+
+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,41 @@
+[![CircleCI](https://circleci.com/gh/Vandegrift/rex12.svg?style=shield&circle-token=43575a1d75c0a4b93cfdde39ec725d1c47974036)](https://circleci.com/gh/Vandegrift/rex12)
+
+# REX12
+
+This gem helps read files or text in the ASNI X.12 format.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rex12'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rex12
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Vandegrift/rex12. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rex12"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rex12/document.rb

@@ -0,0 +1,64 @@
+# methods for reading a full EDI file
+#
+# currently, the full text of the file is read into memory,
+# but if you use the block form of the methods, then the subsequent ruby objects
+# are created within the block loops so they can be garbage collected
+module REX12; class Document
+  # Parse the EDI document from file
+  #
+  # @return (see #parse)
+  def self.read path
+    if block_given?
+      parse(IO.read(path)) {|s| yield s}
+      return nil
+    else
+      return parse(IO.read(path))
+    end
+  end
+  # Parse the EDI document from text
+  #
+  # @return [Enumerator<REX12::Segment>,nil] all segments or nil for block form
+  def self.parse text
+    validate_isa(text)
+    element_separator = text[3]
+    segment_terminator = determine_segment_terminator(text)
+    sub_element_separator = text[104]
+    r = []
+    text.split(segment_terminator).each_with_index do |seg_text,pos|
+      next if seg_text.length == 0
+      seg = REX12::Segment.new(seg_text,element_separator,sub_element_separator,pos)
+      if block_given?
+        yield seg
+      else
+        r << seg
+      end
+    end
+    if block_given?
+      return nil
+    else
+      return r
+    end
+  end
+
+  def self.determine_segment_terminator text
+    # no segement terminator, just CRLF
+    return "\r\n" if text[105..106]=="\r\n"
+    # no segement terminator, just CR or LF
+    return text[105] if ["\r","\n"].include?(text[105])
+    # segment terminator without CR or LF
+    return text[105] if text[106]=='G'
+    # segment terminator with CRLF
+    return text[105..107] if text[106..107]=="\r\n"
+    return text[105..106] if ["\r","\n"].include?(text[106]) && text[107]=="G"
+    raise REX12::ParseError, "Cannot determine segment terminator, invalid ISA / GS."
+  end
+  private_class_method :determine_segment_terminator
+
+  def self.validate_isa text
+    raise REX12::ParseError, "EDI file must be at least 191 characters to include a valid envelope." unless text.length > 191
+    str = text[0..2]
+    raise REX12::ParseError, "First 3 characters must be ISA, they were #{str}" unless str=='ISA'
+    return
+  end
+  private_class_method :validate_isa
+end; end

data/lib/rex12/element.rb

@@ -0,0 +1,33 @@
+# Represents an ANSI X.12 Element
+module REX12; class Element
+  # @return [String] base text value of the element (does not break up sub elements)
+  attr_reader :value
+
+  # @return [Integer] zero based location of this element in its parent segment
+  attr_reader :position
+
+  # @param value [String] base text value of the element
+  # @param sub_element_separator [String] character that should be used to split sub elements
+  # @param position [Integer] zero based position of this element in its parent segment
+  def initialize value, sub_element_separator, position
+    @value = value
+    @sub_element_separator = sub_element_separator
+    @position = position
+  end
+
+  # @return [true, false] does the element have sub elements
+  def sub_elements?
+    @value.index(@sub_element_separator) ? true : false
+  end
+
+  # Get all sub elements as an array or yield them to a block
+  # @return [Array<String>, nil]
+  def sub_elements
+    r = @value.split(@sub_element_separator)
+    if block_given?
+      r.each {|se| yield se}
+      return nil
+    end
+    return r
+  end
+end; end

data/lib/rex12/parse_error.rb

@@ -0,0 +1,11 @@
+# Raised when there is an error parsing the syntax of the document
+module REX12; class ParseError < StandardError
+  # REX12::Segment that was being parsed when error was generated (may be nil)
+  attr_reader :segment
+  # REX12::Element that was being parsed when error was generated (may be nil)
+  attr_reader :element
+  def initialize message, segment=nil, element=nil
+    @segment = segment
+    @element = element
+  end
+end; end

data/lib/rex12/segment.rb

@@ -0,0 +1,36 @@
+module REX12; class Segment
+  # @return [String] raw text of segment
+  attr_reader :value
+
+  # @return [Integer] zero based position in file
+  attr_reader :position
+
+  def initialize value, element_separator, sub_element_separator, position
+    @value = value
+    @position = position
+    make_elements(value,element_separator,sub_element_separator)
+  end
+
+  # @return [Array<REX12::Element>, nil] get all elements as array or yield to block
+  def elements
+    if block_given?
+      @elements.each {|el| yield el}
+      return nil
+    end
+    # making a fresh array so nobody can screw with the internals of the class
+    @elements.clone
+  end
+
+  # @return [String] text representation of first element (like: ISA or REF)
+  def segment_type
+    @elements.first.value
+  end
+
+  def make_elements value, element_separator, sub_element_separator
+    @elements = []
+    value.split(element_separator).each_with_index do |str,pos|
+      @elements << REX12::Element.new(str,sub_element_separator,pos)
+    end
+  end
+  private :make_elements
+end; end

data/lib/rex12/version.rb

@@ -0,0 +1,3 @@
+module REX12
+  VERSION = "0.1.0"
+end

data/lib/rex12.rb

@@ -0,0 +1,9 @@
+require "rex12/version"
+require "rex12/parse_error"
+require "rex12/element"
+require "rex12/segment"
+require "rex12/document"
+
+module REX12
+  # Your code goes here...
+end

data/rex12.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rex12/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "REX12"
+  spec.version       = REX12::VERSION
+  spec.authors       = ["Brian Glick"]
+  spec.email         = ["brian@brian-glick.com"]
+
+  spec.summary       = "Simple ANSI X.12 reading"
+  spec.description   = "Read ANSI X.12 files"
+  spec.homepage      = "https://github.com/Vandegrift/rex12"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: REX12
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Glick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Read ANSI X.12 files
+email:
+- brian@brian-glick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rex12.rb
+- lib/rex12/document.rb
+- lib/rex12/element.rb
+- lib/rex12/parse_error.rb
+- lib/rex12/segment.rb
+- lib/rex12/version.rb
+- rex12.gemspec
+homepage: https://github.com/Vandegrift/rex12
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple ANSI X.12 reading
+test_files: []