ncs_mdes 0.2.0

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+spec/doc-base
+
+.yardoc
+docs
+*.dot

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.8.7-p334@ncs_mdes

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--markup markdown
+--hide-void-return
+--files CHANGELOG.md
+--readme README.md

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+0.2.0
+=====
+
+- Rename gem to ncs_mdes (from ncs-mdes).
+- Embed the VDR transmission XSD since we now have permission to
+  distribute the MDES structure.
+- Update version 2.0 to be based on 2.0.01.02.
+
+0.1.0
+=====
+
+- Add mdes-console executable.
+
+0.0.1
+=====
+
+- First version. Reads data from VDR transmission schema for MDES 1.2
+  and 2.0.

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  # For yard's markdown support
+  platforms :jruby             do gem 'maruku' end
+  platforms :ruby_18, :ruby_19 do gem 'rdiscount' end
+end

data/README.md

@@ -0,0 +1,59 @@
+NCS Navigator MDES Module
+=========================
+
+This gem provides a consistent computable interface to the National
+Children's Study Master Data Element Specification. All of the data it
+exposes is derived at runtime from the documents provided by the
+National Children's Study Program Office, which must be available on
+the system where it is running.
+
+Use
+---
+
+    require 'ncs_navigator/mdes'
+    require 'pp'
+
+    mdes = NcsNavigator::Mdes('1.2')
+    pp mdes.transmission_tables.collect(&:name)
+
+For more details see the API documentation, starting with {NcsNavigator::Mdes::Specification}.
+
+### Examine
+
+This gem includes a console for interactively analyzing and randomly
+poking at the MDES. It is called `mdes-console`:
+
+    $ mdes-console
+    Documents are expected to be in the default location.
+    $mdes12 is a Specification for 1.2
+    $mdes20 is a Specification for 2.0
+    ruby-1.8.7-p334 :001 >
+
+It is based on ruby's IRB. Use it to examine the loaded MDES data
+without a lot of edit-save-run cycles:
+
+    ruby-1.8.7-p334 :001 > $mdes20.transmission_tables.first.name
+     => "study_center"
+
+E.g., find all the variables of a particular XML schema type:
+
+    ruby-1.8.7-p334 :002 > $mdes20.transmission_tables.collect { |t| t.variables }.flatten.select { |v| v.type.base_type == :decimal }.collect(&:name)
+      => ["correction_factor_temp", "current_temp", "maximum_temp", "minimum_temp", "precision_term_temp", "trh_temp", "salts_moist", "s_33rh_reading", "s_75rh_reading", "s_33rh_reading_calib", "s_75rh_reading_calib", "precision_term_temp", "rf_temp", "correction_factor_temp", "sample_receipt_temp"]
+
+Or the labels for a particular code list:
+
+    ruby-1.8.7-p334 :003 > $mdes20.types.find { |t| t.name == 'confirm_type_cl7' }.code_list.collect(&:label)
+     => ["Yes", "No", "Refused", "Don't Know", "Legitimate Skip", "Missing in Error"]
+
+Or the number of code lists that include "Yes" as an option:
+
+    ruby-1.8.7-p334 :004 > $mdes20.types.select { |t| t.code_list && t.code_list.collect(&:label).include?('Yes') }.size
+     => 23
+
+Develop
+-------
+
+### Writing API docs
+
+Run `bundle exec yard server --reload` to get a dynamically-refreshing
+view of the API docs on localhost:8808.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/bin/mdes-console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+##
+# Provides a IRB session with a NcsNavigator::Mdes::Specification instance
+# for free-form prodding.
+
+require 'irb'
+require 'ncs_navigator/mdes'
+
+$mdes12 = NcsNavigator::Mdes::Specification.new('1.2')
+$mdes20 = NcsNavigator::Mdes::Specification.new('2.0')
+
+expected_loc = ENV[NcsNavigator::Mdes::SourceDocuments::BASE_ENV_VAR] ?
+  ENV[NcsNavigator::Mdes::SourceDocuments::BASE_ENV_VAR].inspect :
+  'the default location'
+
+puts "Documents are expected to be in #{expected_loc}."
+puts "$mdes12 is a Specification for 1.2"
+puts "$mdes20 is a Specification for 2.0"
+
+IRB.start(__FILE__)