ncs_mdes 0.4.0 → 0.4.1

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 NCS Navigator MDES Module history
 =================================
 
+0.4.1
+-----
+
+- Add separate {#omittable?} and {#nillable?} subconditions of
+  {#required?} (#4).
+
 0.4.0
 -----
 

data/lib/ncs_navigator/mdes/variable.rb

@@ -31,11 +31,26 @@ module NcsNavigator::Mdes
     attr_accessor :type
 
     ##
-    # Is the variable mandatory for a valid submission?
+    # If the variable does not have a value, should it be completely
+    # omitted when submitting to the VDR?
     #
     # @return [Boolean]
-    attr_accessor :required
-    alias :required? :required
+    attr_accessor :omittable
+    alias :omittable? :omittable
+
+    ##
+    # May the variable be submitted as a null value?
+    #
+    # @return [Boolean]
+    attr_accessor :nillable
+    alias :nillable? :nillable
+
+    ##
+    # Allows for an override of the default logic. Mostly intended for
+    # testing. Set to `nil` to restore default logic.
+    #
+    # @return [Boolean,nil]
+    attr_writer :required
 
     ##
     # If this variable is a foreign key, this is the {table
@@ -57,12 +72,8 @@ module NcsNavigator::Mdes
         log = options[:log] || NcsNavigator::Mdes.default_logger
 
         new(element['name']).tap do |var|
-          var.required =
-            if element['minOccurs']
-              element['minOccurs'] != '0'
-            else
-              element['nillable'] == 'false'
-            end
+          var.nillable = element['nillable'] == 'true'
+          var.omittable = element['minOccurs'] == '0'
           var.pii =
             case element['pii']
             when 'Y'; true;
@@ -104,6 +115,19 @@ module NcsNavigator::Mdes
       @constraints ||= []
     end
 
+    ##
+    # Is a value for the variable mandatory for a valid submission?
+    #
+    # @return [Boolean]
+    def required?
+      if @required.nil?
+        !(omittable? || nillable?)
+      else
+        @required
+      end
+    end
+    alias :required :required?
+
     ##
     # If the {#type} of this instance is a reference to an NCS type,
     # attempts to replace it with the full version from the given list

data/lib/ncs_navigator/mdes/version.rb

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

data/spec/ncs_navigator/mdes/variable_spec.rb

@@ -107,6 +107,34 @@ XSD
         end
       end
 
+      describe '#omittable?' do
+        it 'is true when minOccurs is 0' do
+          variable('<xs:element minOccurs="0"/>').should be_omittable
+        end
+
+        it 'is false when minOccurs is not present' do
+          comments.should_not be_omittable
+        end
+
+        it 'is false when minOccurs is > 0' do
+          variable('<xs:element minOccurs="1"/>').should_not be_omittable
+        end
+      end
+
+      describe '#nillable?' do
+        it 'is true when nillable is true' do
+          variable('<xs:element nillable="true"/>').should be_nillable
+        end
+
+        it 'is false when nillable is not present' do
+          variable('<xs:element/>').should_not be_nillable
+        end
+
+        it 'is false when nillable is false' do
+          variable('<xs:element nillable="false"/>').should_not be_nillable
+        end
+      end
+
       describe '#pii' do
         it 'is false when blank' do
           variable('<xs:element ncsdoc:pii=""/>').pii.should == false
@@ -156,6 +184,52 @@ XSD
       end
     end
 
+    describe '#required?' do
+      subject { Variable.new('foo') }
+
+      it 'is true when not omittable or nillable' do
+        subject.should be_required
+      end
+
+      it 'is false when omittable only' do
+        subject.omittable = true
+        subject.should_not be_required
+      end
+
+      it 'is false when nillable only' do
+        subject.nillable = true
+        subject.should_not be_required
+      end
+
+      it 'is false both nillable and omittable' do
+        subject.nillable = true
+        subject.omittable = true
+        subject.should_not be_required
+      end
+
+      describe 'when explicitly set' do
+        it 'preserves trueness even when would be false' do
+          subject.nillable = true
+          subject.required = true
+          subject.should be_required
+        end
+
+        it 'preserves falseness even when should be true' do
+          subject.required = false
+          subject.should_not be_required
+        end
+
+        it 'can be cleared by setting to nil' do
+          subject.nillable = true
+          subject.required = true
+          subject.should be_required
+
+          subject.required = nil
+          subject.should_not be_required
+        end
+      end
+    end
+
     describe '#resolve_type!' do
       let(:reference_type) { VariableType.reference('ncs:color_cl3') }
       let(:actual_type)    { VariableType.new('color_cl3') }

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ncs_mdes
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.4.0
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Rhett Sutphin
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-28 00:00:00 -05:00
+date: 2011-07-31 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,6 +26,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
         version: "1.4"
   type: :runtime
   version_requirements: *id001
@@ -32,6 +41,10 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
         version: "2.6"
   type: :development
   version_requirements: *id002
@@ -43,6 +56,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
         version: 0.9.2
   type: :development
   version_requirements: *id003
@@ -54,12 +72,19 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 7
+        - 2
         version: 0.7.2
   type: :development
   version_requirements: *id004
-description: "\n\
-  Provides a consistent ruby interface to the project metainformation in the\n\
-  National Children's Study's Master Data Element Specification.\n"
+description: |
+  
+  Provides a consistent ruby interface to the project metainformation in the
+  National Children's Study's Master Data Element Specification.
+
 email: 
 - r-sutphin@northwestern.edu
 executables: 
@@ -113,17 +138,23 @@ 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.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A ruby API for various versions of the NCS MDES.