ncs_navigator_configuration 0.0.1 → 0.1.0

data/.gitignore

@@ -5,3 +5,5 @@ pkg/*
 
 .yardoc
 doc
+
+reports

data/.rvmrc

@@ -0,0 +1 @@
+rvm @ncs_config

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 NCS Navigator Configuration gem history
 =======================================
 
+0.1.0
+-----
+
+- Ruby 1.9 compatibility.
+
 0.0.1
 -----
 

data/README.md

@@ -33,8 +33,10 @@ file's sections and the second level the keys.
 
 In addition to the typed configuration properties available on
 `NcsNavigator::Configuration`, there are also three
-application-specific accessors: {#staff_portal, #core, and
-#psc}. These provide untyped direct access to the configuration
-properties in the respective sections of the INI file, allowing
-applications to define their own additional configuration properties
-without modifying this library.
+application-specific accessors:
+{NcsNavigator::Configuration#staff_portal #staff_portal},
+{NcsNavigator::Configuration#core #core}, and
+{NcsNavigator::Configuration#psc #psc}. These provide untyped direct
+access to the configuration properties in the respective sections of
+the INI file, allowing applications to define their own additional
+configuration properties without modifying this library.

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/ci-exec.sh

@@ -0,0 +1,43 @@
+#!/bin/bash -xe
+
+BUNDLER_VERSION=1.0.18
+GEMSET=ncs_config
+
+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/configuration.rb

@@ -1,6 +1,5 @@
 require 'inifile'
 require 'pathname'
-require 'fastercsv'
 require 'uri'
 
 module NcsNavigator
@@ -75,6 +74,21 @@ module NcsNavigator
         attr_accessor name
       end
 
+      ##
+      # Defines an attribute that exposes the raw contents of a
+      # section.
+      #
+      # @param [#to_s] section_name the name of the section in the INI
+      #   file.
+      # @param [#to_sym] accessor_name the name for the generated accessor.
+      #
+      # @return [void]
+      def section_accessor(section_name, accessor_name)
+        define_method accessor_name.to_sym do
+          @application_sections[section_name.to_s] ||= {}
+        end
+      end
+
       ##
       # @private used by instances, but not intended to be public.
       def configuration_attributes
@@ -232,6 +246,23 @@ module NcsNavigator
     # it. Defaults to false.
     configuration_attribute :smtp_starttls, 'SMTP', 'starttls', 'Boolean', :default => false
 
+    # While the following could be generated metaprogrammatically
+    # using APPLICATION_SECTIONS, they are unrolled for the benefit of
+    # YARD.
+
+    ##
+    # @macro [attach] section_accessor
+    # @method $2
+    #
+    # Exposes all the values from the [$1] section. This allows for
+    # flexibility in adding new options. The downside is that they are
+    # not automatically coerced or documented.
+    #
+    # @return [Hash<String, String>] the raw values from the [$1] section
+    section_accessor 'Staff Portal', :staff_portal
+    section_accessor 'Core', :core
+    section_accessor 'PSC', :psc
+
     ##
     # Creates a new Configuration.
     #
@@ -253,7 +284,7 @@ module NcsNavigator
     def init_from_ini(filename)
       if File.readable?(filename)
         @ini_filename = Pathname.new(filename)
-        init_from_hash(IniFile.new(filename).to_h)
+        init_from_hash(IniFile.new(filename, :encoding => 'UTF-8').to_h)
       else
         raise Error.new("NCS Navigator configuration file #{filename.inspect} does not exist or is not readable.")
       end
@@ -304,7 +335,7 @@ module NcsNavigator
         raise Error.new("Could not read sampling units CSV #{sampling_units_file}")
       end
 
-      FasterCSV.foreach(sampling_units_file, :headers => true) do |row|
+      faster_csv_class.foreach(sampling_units_file, :headers => true, :encoding => 'utf-8') 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))
@@ -345,18 +376,6 @@ module NcsNavigator
       end
     end
 
-    APPLICATION_SECTIONS.each do |section|
-      ##
-      # Exposes all the values from the [#{section}] section. This
-      # allows for flexibility in adding new options, with the downside
-      # that they are not automatically coerced or documented.
-      #
-      # @return [Hash<String, String>]
-      define_method section.downcase.gsub(' ', '_').to_sym do
-        @application_sections[section] ||= {}
-      end
-    end
-
     ##
     # Provides a configuration hash suitable for passing to
     # `ActionMailer::Base.smtp_settings`.
@@ -376,6 +395,21 @@ module NcsNavigator
       ]
     end
 
+    ##
+    # @return [Class] the main class for FasterCSV-like behavior. On
+    #   1.9+, this is the built-in CSV lib.
+    def faster_csv_class
+      @faster_csv_class ||=
+        if RUBY_VERSION < '1.9'
+          require 'fastercsv'
+          FasterCSV
+        else
+          require 'csv'
+          CSV
+        end
+    end
+    private :faster_csv_class
+
     class Error < StandardError; end
   end
 end

data/lib/ncs_navigator/configuration/version.rb

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

data/ncs_navigator_configuration.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 0.9.2'
   s.add_development_dependency 'rspec', '~> 2.6'
   s.add_development_dependency 'yard', '~> 0.7.2'
-  s.add_development_dependency 'fakefs', '~> 0.3'
+  s.add_development_dependency 'fakefs', '~> 0.3.2'
+  s.add_development_dependency 'ci_reporter', '~> 1.6'
 end

data/sample_configuration.ini

@@ -49,7 +49,7 @@ sampling_units_file = "sample_ssus.csv"
 
 # The text that should appear in the center of the footer in Staff
 # Portal and Core. Line breaks in this text will be preserved.
-footer_text = "National Children’s Study - Greater Chicago Study Center
+footer_text = "National Children's Study - Greater Chicago Study Center
 Institute for Healthcare Studies, Feinberg School of Medicine
 Northwestern University
 420 East Superior, 10th Floor

data/spec/ncs_navigator/configuration_spec.rb

@@ -1,9 +1,13 @@
+# -*- coding: utf-8 -*-
 require File.expand_path('../../spec_helper', __FILE__)
 
 describe NcsNavigator do
   # Load the test INI into memory so it can be put into FakeFS
   let(:everything_file) { File.expand_path('../everything.ini', __FILE__) }
-  let!(:everything_contents) { File.read(everything_file) }
+  let!(:everything_contents) {
+    opts = ({ :external_encoding => 'UTF-8' } if RUBY_VERSION > '1.9')
+    File.read(everything_file, opts)
+  }
 
   after do
     NcsNavigator.configuration = nil
@@ -13,6 +17,8 @@ describe NcsNavigator do
     include FakeFS::SpecHelpers
 
     before do
+      pending "FakeFS issue #93" if RUBY_VERSION > '1.9'
+
       File.open('/etc/nubic/ncs/navigator.ini', 'w') do |f|
         f.puts '[Study Center]'
         f.puts 'sc_id = 18'
@@ -25,7 +31,9 @@ describe NcsNavigator do
         f.puts 'uri = https://foo.example.com/psc'
       end
 
-      File.open(everything_file, 'w') { |f| f.write everything_contents }
+      File.open(everything_file, RUBY_VERSION > '1.9' ? 'w:UTF-8' : 'w') { |f|
+        f.write everything_contents
+      }
     end
 
     it 'is read from /etc/nubic/ncs/navigator.ini' do
@@ -275,6 +283,12 @@ module NcsNavigator
         it 'preserves newlines' do
           subject.split(/\n/).size.should == 5
         end
+
+        if RUBY_VERSION > '1.9'
+          it 'can contain non-ASCII characters' do
+            subject.should =~ /’/
+          end
+        end
       end
 
       describe '#footer_center_html' do

metadata

@@ -1,147 +1,120 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ncs_navigator_configuration
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Rhett Sutphin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-24 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ncs_mdes
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152457280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: inifile
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152457280
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: &2157337660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 4
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.4.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: fastercsv
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157337660
+- !ruby/object:Gem::Dependency
+  name: fastercsv
+  requirement: &2157337200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
-        version: "1.5"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2157337200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157336740 !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: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2157336740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157336280 !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: *id005
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2157336280
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2157335820 !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: *id006
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2157335820
+- !ruby/object:Gem::Dependency
   name: fakefs
+  requirement: &2157335360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2157335360
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: &2157334900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 3
-        version: "0.3"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :development
-  version_requirements: *id007
-description: "\n    An internal component of the NCS Navigator suite, this gem provides a common view\n    onto shared configuration elements.\n  "
-email: 
+  prerelease: false
+  version_requirements: *2157334900
+description: ! "\n    An internal component of the NCS Navigator suite, this gem provides
+  a common view\n    onto shared configuration elements.\n  "
+email:
 - r-sutphin@northwestern.edu
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rvmrc
 - .yardopts
 - CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
+- ci-exec.sh
 - lib/ncs_navigator/configuration.rb
 - lib/ncs_navigator/configuration/sampling_units.rb
 - lib/ncs_navigator/configuration/version.rb
@@ -153,41 +126,31 @@ files:
 - spec/ncs_navigator/everything.ini
 - spec/ncs_navigator/no_tsus.csv
 - 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: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Common configuration elements for the NCS Navigator suite
-test_files: 
+test_files:
 - spec/ncs_navigator/configuration/version_spec.rb
 - spec/ncs_navigator/configuration_spec.rb
 - spec/ncs_navigator/every_su.csv