ncs_mdes 0.3.1 → 0.4.0

data/lib/ncs_navigator/mdes/disposition_code.rb

@@ -0,0 +1,34 @@
+require 'ncs_navigator/mdes'
+
+module NcsNavigator::Mdes
+  ##
+  # One dispostion code in the MDES.
+  class DispositionCode
+
+    attr_accessor :event
+    attr_accessor :final_category
+    attr_accessor :sub_category
+    attr_accessor :disposition
+    attr_accessor :interim_code
+    attr_accessor :final_code
+
+    ##
+    # Given attributes (presumably loaded from a YAML file) create
+    # a new instance of a DispositionCode
+    # 
+    # @return [DispositionCode] the created instance.
+    def initialize(attrs)
+      [:event, :final_category, :sub_category, :disposition, :interim_code, :final_code].each do |a|
+        self.send("#{a}=", attrs[a.to_s])
+      end
+    end
+
+    ##
+    # Provides a briefer inspection for cleaner IRB use.
+    #
+    # @return [String]
+    def inspect
+      "\#<#{self.class} event=#{event.inspect} disposition=#{disposition.inspect} status_code=#{interim_code.inspect}/#{final_code.inspect}>"
+    end
+  end
+end

data/lib/ncs_navigator/mdes/source_documents.rb

@@ -56,6 +56,7 @@ module NcsNavigator::Mdes
           sd.version = version
           sd.schema = schema
           sd.heuristic_overrides = "#{version}/heuristic_overrides.yml"
+          sd.disposition_codes = "#{version}/disposition_codes.yml"
         end
       end
       private :create
@@ -125,6 +126,30 @@ module NcsNavigator::Mdes
     def heuristic_overrides=(path)
       @heuristic_overrides = path
     end
+    
+    ##
+    # The absolute path to a YAML-formatted document defining
+    # the disposition codes as found in the Master Data Element Specifications 
+    # spreadsheet.
+    #
+    # This is path is optional; if one is not provided no disposition 
+    # codes will be loaded.
+    #
+    # @return [String]
+    def disposition_codes
+      absolutize(@disposition_codes)
+    end
+    
+    ##
+    # Set the path to the disposition codes document.
+    # If the path is relative (i.e., it does not begin with `/`), it
+    # will be interpreted relative to {#base}.
+    #
+    # @param [String] path
+    # @return [String] the provided path
+    def disposition_codes=(path)
+      @disposition_codes = path
+    end
 
     private
 

data/lib/ncs_navigator/mdes/specification.rb

@@ -129,6 +129,26 @@ module NcsNavigator::Mdes
     end
     private :read_types
 
+    ##
+    # @return [Array<DispositionCode>] all the named disposition codes in the MDES.
+    def disposition_codes
+      @disposition_codes ||=
+        begin
+          if File.exist?(source_documents.disposition_codes)
+            YAML.load(File.read source_documents.disposition_codes).collect do |dc|
+              DispositionCode.new(dc)
+            end
+          else
+            empty_disposition_codes
+          end
+        end
+    end
+    
+    def empty_disposition_codes
+      []
+    end
+    private :empty_disposition_codes
+
     ##
     # A briefer inspection for nicer IRB sessions.
     #

data/lib/ncs_navigator/mdes/variable.rb

@@ -57,7 +57,12 @@ module NcsNavigator::Mdes
         log = options[:log] || NcsNavigator::Mdes.default_logger
 
         new(element['name']).tap do |var|
-          var.required = (element['nillable'] == 'false')
+          var.required =
+            if element['minOccurs']
+              element['minOccurs'] != '0'
+            else
+              element['nillable'] == 'false'
+            end
           var.pii =
             case element['pii']
             when 'Y'; true;

data/lib/ncs_navigator/mdes/version.rb

@@ -1,5 +1,5 @@
 module NcsNavigator
   module Mdes
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/ncs_navigator/mdes.rb

@@ -10,6 +10,8 @@ module NcsNavigator
     autoload :Variable,          'ncs_navigator/mdes/variable'
     autoload :VariableType,      'ncs_navigator/mdes/variable_type'
 
+    autoload :DispositionCode,   'ncs_navigator/mdes/disposition_code'
+
     ##
     # @return the default logger for this module when no other one is
     #   specified. It logs to standard error.

data/spec/ncs_navigator/mdes/source_documents_spec.rb

@@ -60,6 +60,16 @@ module NcsNavigator::Mdes
         SourceDocuments.new.heuristic_overrides.should be_nil
       end
     end
+    
+    describe '#disposition_codes' do
+      let(:property) { :disposition_codes }
+
+      it_behaves_like 'an absolutizing path accessor'
+
+      it 'is optional' do
+        SourceDocuments.new.disposition_codes.should be_nil
+      end
+    end
 
     describe '.get' do
       describe '1.2' do
@@ -72,6 +82,10 @@ module NcsNavigator::Mdes
         it 'has the correct path for the overrides' do
           subject.heuristic_overrides.should =~ %r{1.2/heuristic_overrides.yml$}
         end
+        
+        it 'has the correct path for the disposition codes' do
+          subject.disposition_codes.should =~ %r{1.2/disposition_codes.yml$}
+        end
 
         it 'is of the specified version' do
           subject.version.should == '1.2'
@@ -88,6 +102,10 @@ module NcsNavigator::Mdes
         it 'has the correct path for the overrides' do
           subject.heuristic_overrides.should =~ %r{2.0/heuristic_overrides.yml$}
         end
+        
+        it 'has the correct path for the disposition codes' do
+          subject.disposition_codes.should =~ %r{2.0/disposition_codes.yml$}
+        end
 
         it 'is of the specified version' do
           subject.version.should == '2.0'

data/spec/ncs_navigator/mdes/specification_spec.rb

@@ -63,6 +63,41 @@ module NcsNavigator::Mdes
         include_examples 'tables fully resolved'
       end
     end
+    
+    
+    describe '#disposition codes' do
+      it 'is composed of DispositionCode instances' do
+        Specification.new('2.0', :log => logger).disposition_codes.first.
+          should be_a DispositionCode
+      end
+
+      context 'in version 1.2' do
+        let(:disposition_codes) { Specification.new('1.2', :log => logger).disposition_codes }
+
+        it 'has 0 codes' do
+          disposition_codes.size.should == 0
+        end
+      end
+
+      context 'in version 2.0' do
+        let(:disposition_codes) { Specification.new('2.0', :log => logger).disposition_codes }
+
+        it 'has 251 codes' do
+          disposition_codes.size.should == 251
+        end
+        
+        it 'creates valid codes' do
+          code = disposition_codes.first
+          code.event.should          == "Household Enumeration Event"
+          code.final_category.should == "Unknown Eligibility"
+          code.sub_category.should   == "Unknown if Dwelling Unit"
+          code.disposition.should    == "Not attempted"
+          code.interim_code.should   == "010"
+          code.final_code.should     == "510"
+        end
+
+      end
+    end
 
     describe '#[]' do
       let(:spec) { Specification.new('2.0') }

data/spec/ncs_navigator/mdes/variable_spec.rb

@@ -97,6 +97,14 @@ XSD
         it 'is false when nillable' do
           comments.should_not be_required
         end
+
+        it 'is false when not nillable but minOccurs is 0' do
+          variable('<xs:element nillable="false" minOccurs="0"/>').should_not be_required
+        end
+
+        it 'is true when nillable omitted but minOccurs is > 0' do
+          variable('<xs:element minOccurs="1"/>').should be_required
+        end
       end
 
       describe '#pii' do

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ncs_mdes
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
+  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors: 
 - Rhett Sutphin
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-27 00:00:00 -05:00
+date: 2011-07-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
         version: "1.4"
   type: :runtime
   version_requirements: *id001
@@ -41,10 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
         version: "2.6"
   type: :development
   version_requirements: *id002
@@ -56,11 +43,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
         version: 0.9.2
   type: :development
   version_requirements: *id003
@@ -72,19 +54,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 7
-        - 2
         version: 0.7.2
   type: :development
   version_requirements: *id004
-description: |
-  
-  Provides a consistent ruby interface to the project metainformation in the
-  National Children's Study's Master Data Element Specification.
-
+description: "\n\
+  Provides a consistent ruby interface to the project metainformation in the\n\
+  National Children's Study's Master Data Element Specification.\n"
 email: 
 - r-sutphin@northwestern.edu
 executables: 
@@ -105,8 +80,10 @@ files:
 - documents/1.2/Data_Transmission_Schema_V1.2.xsd
 - documents/1.2/heuristic_overrides.yml
 - documents/2.0/NCS_Transmission_Schema_2.0.01.02.xml
+- documents/2.0/disposition_codes.yml
 - documents/2.0/heuristic_overrides.yml
 - lib/ncs_navigator/mdes.rb
+- lib/ncs_navigator/mdes/disposition_code.rb
 - lib/ncs_navigator/mdes/source_documents.rb
 - lib/ncs_navigator/mdes/specification.rb
 - lib/ncs_navigator/mdes/transmission_table.rb
@@ -136,23 +113,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A ruby API for various versions of the NCS MDES.