ncs_navigator_configuration 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 NCS Navigator Configuration gem history
 =======================================
 
+0.2.0
+-----
+
+- New mandatory study center attribute: recruitment_type_id.
+
+- Be more flexible about whitespace when parsing sampling unit CSV.
+
 0.1.0
 -----
 

data/lib/ncs_navigator/configuration.rb

@@ -165,6 +165,13 @@ module NcsNavigator
 
     alias :sc_id :study_center_id
 
+    ##
+    # The recruitment strategy for this study center. The acceptable
+    # values are those from the code list `recruit_type_cl1` in the
+    # MDES.
+    configuration_attribute :recruitment_type_id, 'Study Center', 'recruitment_type_id', String,
+      :required => true
+
     ##
     # The name for the institutional identity used in this deployment
     # of NCS Navigator. For instance, for the Greater Chicago Study
@@ -335,7 +342,12 @@ module NcsNavigator
         raise Error.new("Could not read sampling units CSV #{sampling_units_file}")
       end
 
-      faster_csv_class.foreach(sampling_units_file, :headers => true, :encoding => 'utf-8') do |row|
+      strip_ws = lambda { |h| h.nil? ? nil : h.strip }
+
+      faster_csv_class.foreach(sampling_units_file,
+        :headers => true, :encoding => 'utf-8',
+        :converters => [strip_ws], :header_converters => [strip_ws]
+      ) do |row|
         psu = (psus[row['PSU_ID']] ||= PrimarySamplingUnit.new(row['PSU_ID']))
         area = (areas[row['AREA']] ||= SamplingUnitArea.new(row['AREA'], psu))
         ssu = (ssus[row['SSU_ID']] ||= SecondarySamplingUnit.new(row['SSU_ID'], row['SSU_NAME'], area))

data/lib/ncs_navigator/configuration/version.rb

@@ -1,5 +1,5 @@
 module NcsNavigator
   class Configuration
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/sample_configuration.ini

@@ -13,6 +13,16 @@
 # The ID for the study center from the MDES
 sc_id = "20000000"
 
+# The recruitment strategy code for the center from the MDES.  The
+# acceptable values for this element are the values in the code list
+# recruit_type_cl1 in the MDES. In MDES 2.0, these are the values:
+#
+#  1 => Enhanced Household Enumeration
+#  2 => Provider-Based
+#  3 => Two-Tier
+#  4 => Original VC
+recruitment_type_id = "3"
+
 # A pointer to a CSV describing the sampling units for this study
 # center.  If the path is not absolute it will be resolved relative to
 # this file.

data/spec/ncs_navigator/configuration_spec.rb

@@ -22,6 +22,7 @@ describe NcsNavigator do
       File.open('/etc/nubic/ncs/navigator.ini', 'w') do |f|
         f.puts '[Study Center]'
         f.puts 'sc_id = 18'
+        f.puts 'recruitment_type_id = 2'
         f.puts 'sampling_units_file = foo.csv'
         f.puts '[Staff Portal]'
         f.puts 'uri = https://foo.example.com/sp'
@@ -57,6 +58,7 @@ module NcsNavigator
       {
         'Study Center' => {
           'sc_id' => '23000000',
+          'recruitment_type_id' => '3',
           'sampling_units_file' => 'foo.csv'
         },
         'Staff Portal' => {
@@ -112,6 +114,23 @@ module NcsNavigator
       end
     end
 
+    describe '#recruitment_type_id' do
+      it 'reflects the configured value' do
+        from_hash.recruitment_type_id.should == '3'
+      end
+
+      it 'is always a string' do
+        input_hash['Study Center']['recruitment_type_id'] = 234
+        from_hash.recruitment_type_id.should == '234'
+      end
+
+      it 'is mandatory' do
+        input_hash['Study Center'].delete 'recruitment_type_id'
+        lambda { from_hash }.
+          should raise_error("Please set a value for [Study Center]: recruitment_type_id")
+      end
+    end
+
     describe '#study_center_username' do
       it 'reflects the configured value' do
         everything.study_center_username.should == 'NetID'
@@ -254,6 +273,27 @@ module NcsNavigator
           end
         end
       end
+
+      context 'with extra whitespace' do
+        before do
+          input_hash['Study Center']['sampling_units_file'] =
+            File.expand_path('../spaces.csv', __FILE__)
+        end
+
+        subject { from_hash.secondary_sampling_units }
+
+        it 'has the right number' do
+          subject.size.should == 3
+        end
+
+        describe 'an individual SSU' do
+          let(:ssu) { subject.detect { |s| s.id == 'One' } }
+
+          it 'has the name' do
+            ssu.name.should == 'West Side'
+          end
+        end
+      end
     end
 
     describe 'footer' do

data/spec/ncs_navigator/everything.ini

@@ -2,6 +2,7 @@
 
 [Study Center]
 sc_id = "20000000"
+recruitment_type_id = "1"
 sampling_units_file = "every_su.csv"
 username = "NetID"
 footer_logo_left = "/etc/nubic/ncs/logos/sc_20000000L.png"

data/spec/ncs_navigator/spaces.csv

@@ -0,0 +1,4 @@
+PSU_ID,         AREA,SSU_ID ,SSU_NAME  ,TSU_ID, TSU_NAME
+204, Uptown ,One, West Side,,
+204,Uptown,Two,East Side,,
+204,Downtown,       Three,Downtown,,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ncs_navigator_configuration
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000Z
+date: 2011-11-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ncs_mdes
-  requirement: &2152457280 !ruby/object:Gem::Requirement
+  requirement: &2153498680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2152457280
+  version_requirements: *2153498680
 - !ruby/object:Gem::Dependency
   name: inifile
-  requirement: &2157337660 !ruby/object:Gem::Requirement
+  requirement: &2153498160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *2157337660
+  version_requirements: *2153498160
 - !ruby/object:Gem::Dependency
   name: fastercsv
-  requirement: &2157337200 !ruby/object:Gem::Requirement
+  requirement: &2153497680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2157337200
+  version_requirements: *2153497680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157336740 !ruby/object:Gem::Requirement
+  requirement: &2153497000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2157336740
+  version_requirements: *2153497000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157336280 !ruby/object:Gem::Requirement
+  requirement: &2153487960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2157336280
+  version_requirements: *2153487960
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157335820 !ruby/object:Gem::Requirement
+  requirement: &2153487480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *2157335820
+  version_requirements: *2153487480
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &2157335360 !ruby/object:Gem::Requirement
+  requirement: &2153486920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.3.2
   type: :development
   prerelease: false
-  version_requirements: *2157335360
+  version_requirements: *2153486920
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2157334900 !ruby/object:Gem::Requirement
+  requirement: &2153486340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *2157334900
+  version_requirements: *2153486340
 description: ! "\n    An internal component of the NCS Navigator suite, this gem provides
   a common view\n    onto shared configuration elements.\n  "
 email:
@@ -125,6 +125,7 @@ files:
 - spec/ncs_navigator/every_su.csv
 - spec/ncs_navigator/everything.ini
 - spec/ncs_navigator/no_tsus.csv
+- spec/ncs_navigator/spaces.csv
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Common configuration elements for the NCS Navigator suite
@@ -156,4 +157,6 @@ test_files:
 - spec/ncs_navigator/every_su.csv
 - spec/ncs_navigator/everything.ini
 - spec/ncs_navigator/no_tsus.csv
+- spec/ncs_navigator/spaces.csv
 - spec/spec_helper.rb
+has_rdoc: