yahl7 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c586c2e423bb527f55c9a9a8de87ed9f56f7dafc608ed21edd31de75cbfbb89
-  data.tar.gz: 463f80691d9e7d2c16a110f3e38c98121612eb235d06ab07eca1703ef7251e4c
+  metadata.gz: ef377a8697c788223e781fce4c91d1885ed32b1e3445f918d2e9cbe2871080ba
+  data.tar.gz: 3dbb403452617207d14c78f446d4eea3db98dad27c2768bd8918a2ef2125be13
 SHA512:
-  metadata.gz: 0c96c60d8199d07163e7a19b165530a32c947bb18e624aeac963955667910dae9076f6557c2dbb5bb1f7ca19f56a680448a652027b266cf5278138b3169d7ee3
-  data.tar.gz: 1fb3d07cfe8f1b635bc6342c752ac22caa54eafaf0d928f531e53af54493c42bda4e31335df1d80597ebc1a3bb5d292c720cabae25bc2df16b6e5636afa3b8e9
+  metadata.gz: 72961481942d814ce6c3719106b4daa74534f68115a1fd2ab5b953f08b1860d2f9d82529183e1924919f7980078c8407f066d3395e7d947782ad2d2c60a30d34
+  data.tar.gz: 61a0ad074ae8814f61b87e3a890d67ae11fda0b531b4e51d49b58bb24235563e15f6b67d907f25a371dba1bf2d300e15748d7fd98a52cd916d032c61ecceb86d

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,47 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+<!--
+
+Have you read our Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/mylanconnolly/yahl7/blob/main/CODE_OF_CONDUCT.md
+
+-->
+
+### Prerequisites
+
+* [ ] Put an X between the brackets on this line if you have done all of the following:
+    * Checked for a known issue here: <https://github.com/mylanconnolly/yahl7/blob/main/ERRATA.md>
+    * Checked that your issue isn't already filed: <https://github.com/mylanconnolly/yahl7/issues>
+
+### Description
+
+<!-- Description of the issue -->
+
+### Steps to Reproduce
+
+1. <!-- First Step -->
+2. <!-- Second Step -->
+3. <!-- and so on… -->
+
+**Expected behavior:**
+
+<!-- What you expect to happen -->
+
+**Actual behavior:**
+
+<!-- What actually happens -->
+
+**Reproduces how often:**
+
+<!-- What percentage of the time does it reproduce? -->
+
+### Versions
+
+<!-- Which version of the gem are you using? -->
+
+### Additional Information
+
+<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. -->

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+<!--
+
+Have you read our Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/mylanconnolly/yahl7/blob/main/CODE_OF_CONDUCT.md
+
+-->
+
+## Summary
+
+<!-- One paragraph explanation of the feature. -->
+
+## Motivation
+
+<!-- Why are we doing this? What use cases does it support? What is the expected outcome? -->
+
+## Describe alternatives you've considered
+
+<!-- A clear and concise description of the alternative solutions you've considered. Be sure to explain why the existing functionality isn't suitable for this feature. -->
+
+## Additional context
+
+<!-- Add any other context or information about the feature request here. -->

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

data/CHANGELOG.md

@@ -5,6 +5,70 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.2] - 2021-09-01
+
+0.3.1 introduced a bug that is fixed in this release.
+
+### Fixed
+
+- A bug in 0.3.1. We should have returned `YAHL7::V2::Message` but `nil` was
+  returned instead, resulting in an inconsistent API. This release fixed that
+  behavior and makes the API consistent again.
+
+## [0.3.1] - 2021-09-01
+
+This release fixes a bug under certain circumstances. More details are listed
+below.
+
+### Fixed
+
+- A bug that could be encountered where messages that do not contain a message
+  type field caused a crash. This crash should now be fixed. When calling
+  `YAHL7::V2::Message.message_type` on a message body that does not contain the
+  type field, `nil` should now be returned rather than crashing.
+
+## [0.3.0] - 2021-08-31
+
+The most significant part of this release is the addition of HL7 data types,
+which should allow us to access data within the messages in a much more
+convenient fashion.
+
+### Added
+
+- `YAHL7::V2::Error::InvalidFormatError` error class for when invalid input was
+  encountered during parsing.
+- HL7 segments:
+  - `AL1` for patient allergy information
+  - `DG1` for patient diagnosis information
+  - `EVN` to describe event triggers
+- HL7 data types:
+  - `CNN` for composite ID number and name fields
+  - `DT` for dates
+  - `FT` for formatted text
+  - `NDL` for name, date, and location
+  - `TS` for timestamps
+  - `XAD` for extended addresses
+  - `XPN` for extended person names
+  - `XTN` for extended telephone numbers
+
+### Changed
+
+- `DateTime::parse` now raises `YAHL7::V2::Error::InvalidFormatError` on an
+  unknown format rather than the default `RuntimeError`.
+- Rename `YAHL7::V2::SegmentFieldNames` to `YAHL7::V2::AliasFieldNames` because
+  it is useful in custom data types as well as segments.
+- Map created HL7 data types to applicable fields in segments.
+
+## [0.2.0] - 2021-08-31
+
+### Added
+
+- `YAHL7::V2::Message` now has a `#to_s` method, which returns the original HL7
+  message string. Useful for persisting the original message somewhere after
+  processing
+- `IN1` segment type
+- `PD1` segment type
+
 ## [0.1.0] - 2021-08-31
 
 Initial release

data/CODE_OF_CONDUCT.md

@@ -1,20 +1,30 @@
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
 
 Examples of unacceptable behavior include:
 
@@ -29,56 +39,95 @@ Examples of unacceptable behavior include:
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mylan@mylan.io. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+mylan@mylan.io. All complaints will be reviewed and investigated promptly and
+fairly.
 
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series of actions.
+**Community Impact**: A violation through a single incident or series
+of actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within the community.
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
-[homepage]: https://www.contributor-covenant.org
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to YAHL7
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+The following are guidelines for contributing to the YAHL7 gem.
+
+## Code of Conduct
+
+Please familiarize yourself with the
+[code of conduct](https://github.com/mylanconnolly/yahl7/blob/main/CODE_OF_CONDUCT.md).
+It is based on the [Contributor Covenant](https://www.contributor-covenant.org/)
+and will be enforced.
+
+## What Should I Know?
+
+Some familiarity with Ruby and the HL7 standard will likely be necessary here.
+
+## Reporting Bugs
+
+When filing a bug report, please use the
+[issue template](https://github.com/mylanconnolly/yahl7/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
+This template contains items that are useful for us to resolve issues more
+efficiently.
+
+## Suggesting Enhancements
+
+Is there some functionality missing that you'd like to see added? There is an
+[issue template](https://github.com/mylanconnolly/yahl7/blob/main/.github/ISSUE_TEMPLATE/feature_request.md)
+for that! In short, I'll be happy to consider any feature request, but there
+should be some justification for it.
+
+## Code Contribution
+
+Contributing code is relatively easy. Create a pull request with the proposed
+changes and I'll review it as soon as I'm able to. It's possible I'll request
+some changes or ask for some justification, so if it's a large change, opening
+an issue first to discuss specifics might save some effort all around.
+
+Any new code should be tested where possible, in order to ensure the code is as
+robust as possible.
+
+All Ruby code should be run through [RuboCop](https://rubocop.org/) prior to
+creating the pull request. This can be accomplished by running the command:
+
+```bash
+bundle exec rubocop -A
+```

data/README.md

@@ -1,6 +1,12 @@
 # YAHL7 (yet another HL7 client)
 
 [![Ruby](https://github.com/mylanconnolly/yahl7/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/mylanconnolly/yahl7/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/yahl7.svg)](https://badge.fury.io/rb/yahl7)
+
+> **NOTE** Until this gem reaches version 1.0, you should consider the API to be
+> unstable and minor or major changes may occur with any release. Once version
+> 1.0 has been released, the API will be stable for all 1.x release in keeping
+> with [Semantic Versioning](https://semver.org/).
 
 This gem is used to parse HL7 data from strings or IO sources in Ruby. We
 currently support any version of HL7 >= 2 and < 3 (which came with a change to
@@ -33,7 +39,17 @@ This should ensure that the code is reasonably cross-platform.
 
 ## Installation
 
-**TODO**
+Install the gem globally:
+
+```bash
+gem install 'yahl7'
+```
+
+Or add the following to your Gemfile:
+
+```ruby
+gem 'yahl7'
+```
 
 ## Usage
 
@@ -156,7 +172,7 @@ Bug reports and pull requests are welcome on GitHub at
 https://github.com/mylanconnolly/yahl7. This project is intended to be a
 safe, welcoming space for collaboration, and contributors are expected to adhere
 to the
-[code of conduct](https://github.com/mylanconnolly/yahl7/blob/master/CODE_OF_CONDUCT.md).
+[code of conduct](https://github.com/mylanconnolly/yahl7/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -167,4 +183,4 @@ The gem is available as open source under the terms of the
 
 Everyone interacting in the HL7 project's codebases, issue trackers, chat rooms
 and mailing lists is expected to follow the
-[code of conduct](https://github.com/mylanconnolly/yahl7/blob/master/CODE_OF_CONDUCT.md).
+[code of conduct](https://github.com/mylanconnolly/yahl7/blob/main/CODE_OF_CONDUCT.md).

data/lib/yahl7/v2/{segment_field_names.rb → alias_field_names.rb}

@@ -2,13 +2,13 @@
 
 module YAHL7
   module V2
-    # This module can be included into a segment class to make the
-    # `define_field_names` macro available. This macro allows you to define
-    # repetitive field name aliases in a quick and easy fashion.
+    # This module can be included into a class to make the `define_field_names`
+    # macro available. This macro allows you to define repetitive field name
+    # aliases in a quick and easy fashion.
     #
     # For example:
     #
-    #     include YAHL7::V2::SegmentFieldNames
+    #     include YAHL7::V2::AliasFieldNames
     #
     #      define_field_names({ patient_identifier_list: 3 })
     #
@@ -17,7 +17,7 @@ module YAHL7
     #
     # If you want to define more complex methods, you can exclude them from this
     # hash and define them manually.
-    module SegmentFieldNames
+    module AliasFieldNames
       def self.included(base)
         base.extend(ClassMethods)
       end
@@ -25,8 +25,15 @@ module YAHL7
       # This is the module that actually extends the segment.
       module ClassMethods
         def define_field_names(mappings)
-          mappings.each do |name, index|
-            define_method(name) { self[index] }
+          mappings.each do |name, mapping|
+            case mapping
+            when Integer then define_method(name) { self[mapping] }
+            when Hash
+              define_method(name) do
+                value = self[mapping[:index]]
+                value.nil? || value == '' ? nil : mapping[:class].new(value)
+              end
+            end
           end
         end
       end