blue_button_parser 0.1.0

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'json'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'blue_button_parser'
+
+class Test::Unit::TestCase
+end

data/test/test_blue_button_parser.rb

@@ -0,0 +1,257 @@
+require 'helper'
+
+class BlueButtonParserTest < Test::Unit::TestCase
+  
+  def test_parse_section_breaks
+    str = <<-EOS
+----------------------------- SECTION 1 ----------------------------
+foo
+------------------------- SECTION 2 -------------------------
+Instructions: -- TAKE WITH FOOD --
+
+---------------------------------
+EOS
+    bbp = BlueButtonParser.new(str)
+    assert_equal ["SECTION 1", "SECTION 2"], bbp.data.keys, "parser should correctly construct sections in hash output"
+  end
+  
+  def test_parse_simple_key_value
+    str = <<-EOS
+------- SECTION ---------
+Zip/Post Code: 00001
+EOS
+    expected = {"SECTION" => {"Zip/Post Code" => "00001"}}
+    bbp = BlueButtonParser.new(str)
+    assert_equal(expected, bbp.data, "should handle simple case with one key-value pair")
+  end
+
+  def test_parse_multiple_key_values
+    str = <<-EOS
+------- SECTION ---------
+Name: MHVTESTVETERAN, ONE                       Date of Birth: 01 Mar 1948
+EOS
+    expected = {"SECTION" => {"Name" => "MHVTESTVETERAN, ONE", "Date of Birth" => "01 Mar 1948"}}
+    config = {"SECTION" => {:same_line_keys => ["Name", "Date of Birth"]}}
+    bbp = BlueButtonParser.new(str, config)
+    assert_equal(expected, bbp.data, "should handle two key-value pairs in single line")
+  end
+      
+  def test_parse_two_sets_of_multiple_key_values_in_same_section
+    str = <<-EOS
+------- SECTION ---------
+Name: MHVTESTVETERAN, ONE                       Date of Birth: 01 Mar 1948
+Gender: Male   Blood Type: AB+         Organ Donor: Yes
+EOS
+    expected = {"SECTION" => {"Name" => "MHVTESTVETERAN, ONE", "Date of Birth" => "01 Mar 1948", "Gender" => "Male", "Blood Type" => "AB+", "Organ Donor" => "Yes"}}
+    config = {"SECTION" => {:same_line_keys => [["Name", "Date of Birth"], ["Gender", "Blood Type", "Organ Donor"]]}}
+    bbp = BlueButtonParser.new(str, config)
+    assert_equal(expected, bbp.data, "should handle a section having two sets of key-value pairs in single lines")
+  end
+
+  def test_parse_line_wrap_value_with_empty_line_delimiter
+    str = <<-EOS
+------ SECTION ---------
+Comments: BP taken standing.  BP continues at goal.  Doctor says to continue BP 
+medications as directed
+
+EOS
+    expected = {"SECTION" => {"Comments" => "BP taken standing.  BP continues at goal.  Doctor says to continue BP \nmedications as directed"}}
+    bbp = BlueButtonParser.new(str)
+    assert_equal(expected, bbp.data, "should handle value that wraps lines")
+  end        
+  
+  def test_parse_line_wrap_value_without_empty_line_delimiter
+    str = <<-EOS
+------ SECTION ---------
+Results: BP taken standing.  BP continues at goal.  Doctor says to continue BP 
+medications as directed
+Status: pending
+EOS
+    expected = {"SECTION" => {"Results" => "BP taken standing.  BP continues at goal.  Doctor says to continue BP \nmedications as directed", "Status" => "pending"}}
+    bbp = BlueButtonParser.new(str)
+    assert_equal(expected, bbp.data, "should handle value that wraps lines but does not end with empty line")
+  end
+  
+  def test_parse_line_wrap_value_with_dashed_line
+    # As seen in IMMUNIZATIONS/Reactions
+    str = <<-EOS
+------ SECTION ---------
+Reactions:
+---------------------------------
+Pain
+
+EOS
+    expected = {"SECTION" => {"Reactions" => "Pain"}}
+    bbp = BlueButtonParser.new(str)
+    assert_equal(expected, bbp.data, "should handle value that wraps lines")
+  end
+    
+  def test_parse_line_wrap_value_with_keyish_item_in_value
+    str = <<-EOS
+------ SECTION ---------
+Note:           This appointment has pre-appointment activity scheduled:
+                Lab:    27 Jan 2012 @ 1000
+
+EOS
+    expected = {"SECTION" => {"Note" => "This appointment has pre-appointment activity scheduled: \n                Lab:    27 Jan 2012 @ 1000"}}
+    bbp = BlueButtonParser.new(str)
+    assert_equal(expected, bbp.data, "should handle value that wraps lines, but has a key-like element in the wrapped text")
+  end
+  
+  def test_parse_collections_with_empty_line_delimiter
+    str = <<-EOS
+------ SECTION ---------
+Contact Name: Foo
+Contact Email: Zip
+
+Contact Name: Bar
+Contact Email: Zap
+
+EOS
+    expected = {"SECTION" => {"Contacts" => [
+        {"Contact Name" => "Foo", "Contact Email" => "Zip"}, 
+        {"Contact Name" => "Bar", "Contact Email" => "Zap"}] }}
+    config = {"SECTION" => {:collection => {"Contacts" => {:item_starts_with => "Contact Name"}}}}
+    bbp = BlueButtonParser.new(str, config)
+    assert_equal(expected, bbp.data, "should find collections")    
+  end  
+  
+  def test_parse_collections_with_empty_line_not_a_delimiter
+    # As seen in the "MEDICATIONS AND SUPPLEMENTS" section
+    str = <<-EOS
+------ SECTION ---------
+Contact Name: Foo
+Contact Email: Zip
+
+Contact Location: MA
+
+Contact Name: Bar
+Contact Email: Zap
+
+Contact Location: CA
+
+EOS
+    expected = {"SECTION" => {"Contacts" => [
+        {"Contact Name" => "Foo", "Contact Email" => "Zip", "Contact Location" => "MA"}, 
+        {"Contact Name" => "Bar", "Contact Email" => "Zap", "Contact Location" => "CA"}] }}
+    config = {"SECTION" => {:collection => {"Contacts" => {:item_starts_with => "Contact Name"}}}}
+    bbp = BlueButtonParser.new(str, config)
+    assert_equal(expected, bbp.data, "should find collections where you can't assume empty line is a delimiter")    
+  end  
+  
+  def test_columns_widths
+    bbp = BlueButtonParser.new("")
+    line = "  Foo Bar Sup"
+    columns = ["Foo", "Bar", "Sup"]
+    expected_widths = [2, 6, 10]
+    assert_equal expected_widths, bbp.send(:column_widths, line, columns)
+  end
+  
+  def test_parse_table_line
+    bbp = BlueButtonParser.new("")
+    line = "  a   b   c  "
+    columns = ["Foo", "Bar", "Sup"]    
+    widths = [2, 6, 10]
+    expected_output = {"Foo" => "a", "Bar" => "b", "Sup" => "c"}
+    assert_equal expected_output, bbp.send(:parse_table_line, line, columns, widths)    
+  end
+  
+  def test_parse_tables
+    # Note that "Type" column header does not start at same character position as the row values!
+    str = <<-EOS
+--------------------- SECTION ---------------------
+
+    VA Treating Facility                     Type
+    ----------------------------            -----------  
+    AUSTIN MHV                              OTHER
+    PORTLAND, OREGON VA MEDICAL CENTER      VAMC
+
+EOS
+    expected = {"SECTION" => {"Facilities" => [
+      {"VA Treating Facility" => "AUSTIN MHV", " Type" => "OTHER"}, 
+      {"VA Treating Facility" => "PORTLAND, OREGON VA MEDICAL CENTER", " Type" => "VAMC"}] }}
+    config = {"SECTION" => {:collection => {"Facilities" => {:table_columns => ["VA Treating Facility", " Type"]}}}}
+    bbp = BlueButtonParser.new(str, config)
+    assert_equal(expected, bbp.data, "should parse simple table")    
+  end
+  
+  def test_parse_tables_with_missing_values  
+    str = <<-EOS
+---------------------------- SECTION -------------------------
+
+Wellness Reminder                  Due Date    Last Completed   Location
+----------------------------------------------------------------------------
+Control of Your Cholesterol        DUE NOW     UNKNOWN          PORTLAND, OR
+Pneumonia Vaccine                              06 Mar 2011      PORTLAND, OR
+
+EOS
+    expected = {"SECTION" => {"Reminders" => [
+      {"Wellness Reminder" => "Control of Your Cholesterol", "Due Date" => "DUE NOW", "Last Completed" => "UNKNOWN", "Location" => "PORTLAND, OR"}, 
+      {"Wellness Reminder" => "Pneumonia Vaccine", "Due Date" => nil, "Last Completed" => "06 Mar 2011", "Location" => "PORTLAND, OR"}
+    ]}}
+    config = {"SECTION" => {:collection => {"Reminders" => {:table_columns => ["Wellness Reminder", "Due Date", "Last Completed", "Location"]}}}}
+    bbp = BlueButtonParser.new(str, config)
+    assert_equal(expected, bbp.data, "should parse simple table with missing value")    
+  end
+
+  def test_parse_multiple_tables_with_same_columns
+    str = <<-EOS
+---------------------------- SECTION -------------------------
+
+-- Regular Active Service
+Service      Begin Date  End Date    Character of Service   Rank
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+Army         06/11/2005  03/26/2007  Honorable              COL
+
+-- Reserve/Guard Association Periods
+Service      Begin Date  End Date    Character of Service   Rank
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+Army Guard   01/11/1987  08/24/1993  Unknown                
+
+EOS
+    expected = {"SECTION" => {
+      "Regular Active Service"=> [{"Service" => "Army", "Begin Date" => "06/11/2005", "End Date" => "03/26/2007", "Character of Service" => "Honorable", "Rank" => "COL"}],
+      "Reserve/Guard Association Periods"=>  [{"Service" => "Army Guard", "Begin Date" => "01/11/1987", "End Date" => "08/24/1993", "Character of Service" => "Unknown", "Rank" => nil}]
+    }}
+    config = {"SECTION" => {:collection => {
+      "Regular Active Service" => {:table_starts_with => "-- Regular Active Service", :table_columns => ["Service", "Begin Date", "End Date", "Character of Service", "Rank"] },
+      "Reserve/Guard Association Periods" => {:table_starts_with => "-- Reserve/Guard Association Periods", :table_columns => ["Service", "Begin Date", "End Date", "Character of Service", "Rank"] },
+    }}}
+    bbp = BlueButtonParser.new(str, config)
+    assert_equal(expected, bbp.data)    
+  end      
+        
+  def test_parse_entire_sample_blue_button_document
+    bbp = BlueButtonParser.new(File.read(File.dirname(__FILE__) + "/data/blue_button_example_data.txt"))
+    parsed_data = bbp.data
+    expected_data = JSON.parse(File.read(File.dirname(__FILE__) + "/data/expected_json_output.js"))
+    
+    sections = [
+      "MY HEALTHEVET PERSONAL INFORMATION REPORT",
+      "DOWNLOAD REQUEST SUMMARY",
+      "MY HEALTHEVET ACCOUNT SUMMARY",
+      "DEMOGRAPHICS",
+      "HEALTH CARE PROVIDERS",
+      "TREATMENT FACILITIES",
+      "HEALTH INSURANCE",
+      "VA WELLNESS REMINDERS",
+      "VA APPOINTMENTS",
+      "VA MEDICATION HISTORY",
+      "MEDICATIONS AND SUPPLEMENTS",
+      "VA ALLERGIES",
+      "ALLERGIES/ADVERSE REACTIONS",
+      "MEDICAL EVENTS",
+      "IMMUNIZATIONS",
+      "VA LABORATORY RESULTS",
+      "LABS AND TESTS",
+      "VITALS AND READINGS",
+      "FAMILY HEALTH HISTORY",
+      "MILITARY HEALTH HISTORY",
+    ]
+                        
+    sections.each do |section|
+      assert_equal expected_data[section], parsed_data[section], "parsed section does not match expected JSON for section '#{section}'"            
+    end
+  end
+    
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: blue_button_parser
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- PatientsLikeMe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Converts a BlueButton free text data file to a structured data Hash
+email: open_source@patientslikeme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- blue_button_parser.gemspec
+- lib/blue_button_parser.rb
+- test/data/blue_button_example_data.txt
+- test/data/expected_json_output.js
+- test/helper.rb
+- test/test_blue_button_parser.rb
+has_rdoc: true
+homepage: http://github.com/patientslikeme/blue_button_parser
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Converts a BlueButton free text data file to a structured data Hash
+test_files: []
+