ncs_mdes 0.4.1 → 0.4.2

data/.gitignore

@@ -8,3 +8,6 @@ spec/doc-base
 .yardoc
 docs
 *.dot
+doc
+
+reports

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.8.7-p334@ncs_mdes
+rvm @ncs_mdes --create

data/CHANGELOG.md

@@ -1,11 +1,17 @@
 NCS Navigator MDES Module history
 =================================
 
+0.4.2
+-----
+
+- Add `specification_version` to distinguish from the short version
+  names we use for easy reference. (#6)
+
 0.4.1
 -----
 
-- Add separate {#omittable?} and {#nillable?} subconditions of
-  {#required?} (#4).
+- Add separate `omittable?` and `nillable?` subconditions of
+  `required?` (#4).
 
 0.4.0
 -----

data/Rakefile

@@ -1,7 +1,15 @@
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
 
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
 end
+
+namespace :ci do
+  ENV["CI_REPORTS"] = "reports/spec-xml"
+
+  desc "Run specs for CI"
+  task :spec => ['ci:setup:rspec', 'rake:spec']
+end

data/bin/mdes-console

@@ -4,6 +4,16 @@
 # Provides a IRB session with a NcsNavigator::Mdes::Specification instance
 # for free-form prodding.
 
+# Allow this executable to be run directly from the source as well as
+# from an installed gem.
+begin
+  lib = File.expand_path('../../lib', __FILE__)
+  unless $LOAD_PATH.include?(lib)
+    $LOAD_PATH << lib
+    require 'rubygems'
+  end
+end
+
 require 'irb'
 require 'ncs_navigator/mdes'
 

data/ci-exec.sh

@@ -0,0 +1,43 @@
+#!/bin/bash -xe
+
+BUNDLER_VERSION=1.0.18
+GEMSET=ncs_mdes
+
+if [ -z $CI_RUBY ]; then
+    echo "CI_RUBY must be set"
+    exit 1
+fi
+
+set +xe
+echo "Initializing RVM"
+source ~/.rvm/scripts/rvm
+set -xe
+
+# On the overnight build, reinstall all gems
+if [ `date +%H` -lt 5 ]; then
+    set +xe
+    echo "Purging gemset to verify that all deps can still be installed"
+    rvm --force $CI_RUBY gemset delete $GEMSET
+    set -xe
+fi
+
+RVM_CONFIG="${CI_RUBY}@${GEMSET}"
+set +xe
+echo "Switching to ${RVM_CONFIG}"
+rvm use $RVM_CONFIG
+set -xe
+
+which ruby
+ruby -v
+
+set +e
+gem list -i bundler -v $BUNDLER_VERSION
+if [ $? -ne 0 ]; then
+  set -e
+  gem install bundler -v $BUNDLER_VERSION
+fi
+set -e
+
+bundle update
+
+bundle exec rake ci:spec --trace

data/lib/ncs_navigator/mdes/source_documents.rb

@@ -29,6 +29,11 @@ module NcsNavigator::Mdes
     # @return [String]
     attr_accessor :version
 
+    ##
+    # @return [String] The specification version that these documents
+    #   describe, if more specific than the overall version.
+    attr_accessor :specification_version
+
     ##
     # Instance-level alias for {.xmlns}.
     # @method xmlns
@@ -45,18 +50,19 @@ module NcsNavigator::Mdes
         when '1.2'
           create('1.2', '1.2/Data_Transmission_Schema_V1.2.xsd')
         when '2.0'
-          create('2.0', '2.0/NCS_Transmission_Schema_2.0.01.02.xml')
+          create('2.0', '2.0/NCS_Transmission_Schema_2.0.01.02.xml', '2.0.01.02')
         else
           raise "MDES #{version} is not supported by this version of ncs_mdes"
         end
       end
 
-      def create(version, schema)
+      def create(version, schema, specification_version=nil)
         self.new.tap do |sd|
           sd.version = version
           sd.schema = schema
           sd.heuristic_overrides = "#{version}/heuristic_overrides.yml"
           sd.disposition_codes = "#{version}/disposition_codes.yml"
+          sd.specification_version = specification_version
         end
       end
       private :create
@@ -82,6 +88,10 @@ module NcsNavigator::Mdes
         )
     end
 
+    def specification_version
+      @specification_version || self.version
+    end
+
     ##
     # The absolute path to the XML Schema describing the MDES
     # transmission structure for this instance.
@@ -126,20 +136,20 @@ 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 
+    # the disposition codes as found in the Master Data Element Specifications
     # spreadsheet.
     #
-    # This is path is optional; if one is not provided no disposition 
+    # 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

data/lib/ncs_navigator/mdes/specification.rb

@@ -19,6 +19,13 @@ module NcsNavigator::Mdes
     # @return [String] the version of the MDES to which this instance refers.
     def_delegator :@source_documents, :version
 
+    ##
+    # @method specification_version
+    # @return [String] the exact version this specification
+    #   matches. It may be more exact than the requested version due
+    #   to applied patches.
+    def_delegator :@source_documents, :specification_version
+
     ##
     # @param [String,SourceDocuments] version either the string
     #   version of the MDES metadata you would like to read, or a
@@ -143,7 +150,7 @@ module NcsNavigator::Mdes
           end
         end
     end
-    
+
     def empty_disposition_codes
       []
     end

data/lib/ncs_navigator/mdes/variable.rb

@@ -53,8 +53,8 @@ module NcsNavigator::Mdes
     attr_writer :required
 
     ##
-    # If this variable is a foreign key, this is the {table
-    # TransmissionTable} to which it refers.
+    # If this variable is a foreign key, this is the
+    # {TransmissionTable table} to which it refers.
     #
     # @return [TransmissionTable,nil] the parent table.
     attr_accessor :table_reference
@@ -153,9 +153,9 @@ module NcsNavigator::Mdes
     end
 
     ##
-    # Attempts to resolve this variable as a {reference to another
-    # table #table_reference}. There are two mechanisms for performing
-    # the resolution:
+    # Attempts to resolve this variable as a {#table_reference
+    # reference to another table}. There are two mechanisms for
+    # performing the resolution:
     #
     # 1. If an `override_name` is provided, that table will be looked
     #    up in the provided table list. If it exists, it will be used,

data/lib/ncs_navigator/mdes/version.rb

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

data/ncs_mdes.gemspec

@@ -24,4 +24,5 @@ National Children's Study's Master Data Element Specification.
   s.add_development_dependency 'rspec', '~> 2.6'
   s.add_development_dependency 'rake', '~> 0.9.2'
   s.add_development_dependency 'yard', '~> 0.7.2'
+  s.add_development_dependency 'ci_reporter', '~> 1.6'
 end

data/spec/ncs_navigator/mdes/source_documents_spec.rb

@@ -60,7 +60,7 @@ module NcsNavigator::Mdes
         SourceDocuments.new.heuristic_overrides.should be_nil
       end
     end
-    
+
     describe '#disposition_codes' do
       let(:property) { :disposition_codes }
 
@@ -82,7 +82,7 @@ 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
@@ -90,6 +90,10 @@ module NcsNavigator::Mdes
         it 'is of the specified version' do
           subject.version.should == '1.2'
         end
+
+        it 'has no more specific specification_version' do
+          subject.specification_version.should == '1.2'
+        end
       end
 
       describe '2.0' do
@@ -102,7 +106,7 @@ 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
@@ -110,6 +114,10 @@ module NcsNavigator::Mdes
         it 'is of the specified version' do
           subject.version.should == '2.0'
         end
+
+        it 'has a different specification_version' do
+          subject.specification_version.should == '2.0.01.02'
+        end
       end
 
       it 'fails for an unsupported version' do

data/spec/ncs_navigator/mdes/specification_spec.rb

@@ -63,8 +63,17 @@ module NcsNavigator::Mdes
         include_examples 'tables fully resolved'
       end
     end
-    
-    
+
+    describe '#specification_version' do
+      it 'is the named version by default' do
+        Specification.new('1.2').specification_version.should == '1.2'
+      end
+
+      it 'is the read-in version if the source has one' do
+        Specification.new('2.0').specification_version.should == '2.0.01.02'
+      end
+    end
+
     describe '#disposition codes' do
       it 'is composed of DispositionCode instances' do
         Specification.new('2.0', :log => logger).disposition_codes.first.
@@ -85,7 +94,7 @@ module NcsNavigator::Mdes
         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"

metadata

@@ -1,99 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ncs_mdes
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Rhett Sutphin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-31 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152825220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        version: "1.4"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152825220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152824560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152824560
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152823680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152823680
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2152822920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 7
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.7.2
   type: :development
-  version_requirements: *id004
-description: |
-  
+  prerelease: false
+  version_requirements: *2152822920
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: &2152822260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2152822260
+description: ! '
+
   Provides a consistent ruby interface to the project metainformation in the
-  National Children's Study's Master Data Element Specification.
 
-email: 
+  National Children''s Study''s Master Data Element Specification.
+
+'
+email:
 - r-sutphin@northwestern.edu
-executables: 
+executables:
 - mdes-console
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - .yardopts
@@ -102,6 +88,7 @@ files:
 - README.md
 - Rakefile
 - bin/mdes-console
+- ci-exec.sh
 - 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
@@ -124,41 +111,37 @@ files:
 - spec/ncs_navigator/mdes/version_spec.rb
 - spec/ncs_navigator/mdes_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1899662951154371602
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1899662951154371602
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A ruby API for various versions of the NCS MDES.
-test_files: 
+test_files:
 - spec/ncs_navigator/mdes/source_documents_spec.rb
 - spec/ncs_navigator/mdes/specification_spec.rb
 - spec/ncs_navigator/mdes/transmission_table_spec.rb