stats_package_syntax_file_generator 1.0.6 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTAyOGExOTg0NWVjNWRhNjc2N2M1NTkzMzdlY2QwMDc2NzY0NGNlYg==
+    NDEwN2YzOWY2ZjdjNDM3ZWQ0OWMwNmExZTgzOGM4NjYyNjI5OGRmMQ==
   data.tar.gz: !binary |-
-    MmE4N2Y0N2QxYzRhMDgyYTMxMzg0MTY2OGRjZDY3NjhlYzkyYTFhNA==
+    OWY2MDAwNjJkMTRkMjFkODY4MjU2MjFlNDhkYjNiNzdiOTQzYWFjMA==
 SHA512:
   metadata.gz: !binary |-
-    MGZjNTQ4NjlhNTQwNjE1NDlmYTM5MTc2NmViNzc1MTZiODY0YzQyYTllODQx
-    ODk3ZDE5ZGJjZTk5ZWU0MGVjZmFhZWFhMjc0NjdmNTZiOGQ0MTE2MjViYTY0
-    NWFjOTEzNzdjNDNjY2JmYjdiMjAxNmFjZWQxMWRiMDI1ZTdjMzg=
+    YzdmOTYxNGIzOGYyYzYyMjAwNmMyYzQ4Mzg5NmFmYTQ4OTAyNDVmMTI0ZDA2
+    OTUwOTY1YzczMTE1YTI1YzZkNjgyOTQ2YjdiZDU1M2RmODNmY2IxMzEwOTkx
+    MTY1OGFiNzJhMzM1NzkxMGU3ODM2MmFkZDE4YzY5MzczZDNhMTk=
   data.tar.gz: !binary |-
-    OWIxMjQwNGNlNzY1ODI5MjI0YmFkYWY1ZDQ3MzI3MzVmY2ExMjA0ZjNhMmVk
-    MmIxNGEwMTZhNjQ1MjcyZTc5YTFhMGE3NGU1YzRiMDA1Yzg0NDUyZGJjODE0
-    OWU2NjlmN2Y2MWNmMGVlYzRjMzEzNmNhZmJhOTFhYzZhMWMyOWQ=
+    MWJkZGMyYTNmY2JiMDBjOWRhNTdjZDgyMzFkYTllNmJiOTVjYzhmNDcyMWE3
+    NzNjMDY4MjFmYTQ4YTI4OWM5ZjM0M2Q5N2VkZDIxYzQ0MmQ5MTRiMzU4ZTUy
+    NDRmMTk0ZDE5MjllNmNjMzk4Njk2YWE0NGQ0OTFhMjNiZDNmYjU=

data/README

@@ -4,7 +4,7 @@ This gem produces statistical package syntax files for fixed-column data files.
     SPSS
     Stata
     Stat/Transfer STS metadata files
-
+    R (via the ipumsr package which depends on IPUMS DDIs)
 
 Metadata can be supplied to the Controller in two general ways:
 
@@ -89,6 +89,7 @@ Class overview:
     Maker_SPSS
     Maker_STATA
     Maker_STS
+    Maker_RDDI
 
         - Classes responsible for creating syntax.
 

data/lib/stats_package_syntax_file_generator.rb

@@ -14,6 +14,7 @@ require 'yaml'
     maker_spss
     maker_stata
     maker_sts
+	maker_rddi
 ).each do |f|
     require File.expand_path(File.join(File.dirname(__FILE__), 'syntax_file', f))
 end

data/lib/syntax_file/controller.rb

@@ -6,7 +6,7 @@
 module SyntaxFile
 class Controller
 
-VERSION = "1.0.6"
+VERSION = "1.1.0"
 
 ATTR = {
     :project                    => { :req => false, :rw => 'rw', :def => '',          :yaml => true  },
@@ -46,7 +46,8 @@ def initialize (args = {})
         'sas'   => '.sas',
         'spss'  => '.sps',
         'stata' => '.do',
-        'sts'   => '.sts'
+        'sts'   => '.sts',
+        'rddi'  => '.R'
     } if @output_file_ext.nil?
     @output_formats  = [] if @output_formats.nil?
     @record_types    = [] if @record_types.nil?

data/lib/syntax_file/maker.rb

@@ -106,7 +106,12 @@ def comments_start
         'NOTE: You need to set the Stata working directory to the path',
         'where the data file is located.',
     ] if @syntax_type == 'stata'
-
+    
+	return [
+        "NOTE: To load data, you must download both the extract's data and the DDI",
+        "and also set the working directory to the folder with these files (or change the path below).",
+    ] if @syntax_type == 'rddi'
+    
     cmd = (@syntax_type == 'sas') ? 'libname' : 'cd'
     result = [
         "NOTE: You need to edit the `#{cmd}` command to specify the path to the directory",

data/lib/syntax_file/maker_rddi.rb

@@ -0,0 +1,55 @@
+# This file is part of the Minnesota Population Center's stats_package_syntax_file_generator project.
+# For copyright and licensing information, see the NOTICE and LICENSE files
+# in this project's top-level directory, and also on-line at:
+#   https://github.com/mnpopcenter/stats_package_syntax_file_generator
+
+module SyntaxFile
+class MakerRDDI < Maker
+
+def initialize (sfc, syntax_type)
+    super
+end
+
+def syntax
+    r = [
+        comments_start,
+        check_pkg,
+        syn_df,
+        comments_end,
+    ]
+    r.flatten
+end
+
+def comments_start
+    convert_to_comments(super)
+end
+
+def comments_end
+    convert_to_comments(super)
+end
+
+def convert_to_comments (lines)
+    return [] if lines.empty?
+    [
+        lines.map { |ln| '# ' + ln },
+        blank,
+    ].flatten
+end
+
+def check_pkg 
+    [
+        'if (!require("ipumsr")) stop("Reading IPUMS data into R requires the ipumsr package. It can be installed using the following command: install.packages(\'ipumsr\')")',
+        ''
+    ]
+end
+
+def syn_df
+    ddi_file = @sfc.data_file_name.chomp[0...-3] + 'xml'
+    [
+        'ddi <- read_ipums_ddi(' + q(ddi_file) + ')',
+	    'data <- read_ipums_micro(ddi)',
+    ]
+end
+
+end
+end

data/tests/input_controller.yaml

@@ -4,7 +4,7 @@ project:               ipumsi
 caller:                test
 data_dir_name:         __
 data_file_name:        xx9999a.dat
-output_formats:        [sas, spss, stata, sts]
+output_formats:        [sas, spss, stata, sts, rddi]
 output_dir_name:       __
 output_file_stem:      '%s'
 output_overwrite:      true

data/tests/tc_controller.rb

@@ -231,7 +231,7 @@ def test_generate_syntax_files
 
     # Remove files generated during any previous test.
     stem = 'testing'
-    expected_files = %w(do sas sps sts).map { |e| stem + '.' + e }
+    expected_files = %w(R do sas sps sts).map { |e| stem + '.' + e }
     remove_file_from_dir(output_dir, expected_files)
 
     msg = 'Make sure the testing output directory is empty.'

data/tests/tc_maker_rddi.rb

@@ -0,0 +1,33 @@
+# This file is part of the Minnesota Population Center's stats_package_syntax_file_generator project.
+# For copyright and licensing information, see the NOTICE and LICENSE files
+# in this project's top-level directory, and also on-line at:
+#   https://github.com/mnpopcenter/stats_package_syntax_file_generator
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'setup.rb'))
+
+module StatsPackageSyntaxFileGeneratorTest
+class MakerRDDI < Test::Unit::TestCase
+
+include StatsPackageSyntaxFileGeneratorTestSetup
+
+def test_create_maker_rddi
+    msg = 'Try to create an object.'
+    mk = new_maker('rddi')
+    assert_instance_of SyntaxFile::MakerRDDI, mk, msg
+end
+
+def test_check_pkg
+    msg = 'Compare against hardcoded result.'
+    mk = new_maker('rddi')
+    expected = [
+        'if (!require("ipumsr")) stop("Reading IPUMS data into R requires the ipumsr package. It can be installed using the following command: install.packages(\'ipumsr\')")',
+		''
+    ]
+    actual = mk.check_pkg
+    assert_equal expected, actual, msg
+end
+
+
+
+end
+end

data/tests/ts_all.rb

@@ -15,6 +15,7 @@ require 'test/unit'
     tc_maker_spss
     tc_maker_stata
     tc_maker_sts
+	tc_maker_rddi
 ).each do |f|
     require File.expand_path(File.join(File.dirname(__FILE__), f))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stats_package_syntax_file_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Monty Hindman, Marcus Peterson, Colin Davis, Dan Elbert, Jayandra Pokharel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - lib/stats_package_syntax_file_generator.rb
 - lib/syntax_file/controller.rb
 - lib/syntax_file/maker.rb
+- lib/syntax_file/maker_rddi.rb
 - lib/syntax_file/maker_sas.rb
 - lib/syntax_file/maker_spss.rb
 - lib/syntax_file/maker_stata.rb
@@ -75,6 +76,7 @@ files:
 - tests/setup.rb
 - tests/tc_controller.rb
 - tests/tc_maker.rb
+- tests/tc_maker_rddi.rb
 - tests/tc_maker_sas.rb
 - tests/tc_maker_spss.rb
 - tests/tc_maker_stata.rb