stats_package_syntax_file_generator 1.0.4 → 1.1.3

data/lib/syntax_file/maker_sts.rb

@@ -4,178 +4,171 @@
 #   https://github.com/mnpopcenter/stats_package_syntax_file_generator
 
 module SyntaxFile
-class MakerSTS < Maker
+  class MakerSTS < Maker
 
-def initialize (sfc, syntax_type)
-    super
+    def initialize(sfc, syntax_type)
+      super
 
-    m = @sfc.max_var_name_length
-    @var_lab_format   = "  %-#{m}s  %s"
-    @var_loc_format   = "  %-#{m}s  %s  %s"
-    
-    @vars_with_values = get_vars_with_sts_supported_values     # cache
-end
+      m = @sfc.max_var_name_length
+      @var_lab_format = "  %-#{m}s  %s"
+      @var_loc_format = "  %-#{m}s  %s  %s"
+
+      @vars_with_values = get_vars_with_sts_supported_values # cache
+    end
 
-def syntax
-    r = [
+    def syntax
+      r = [
         syn_df,
         syn_var_labs,
         syn_val_labs,
-    ]
-    r.flatten
-end
+      ]
+      r.flatten
+    end
 
-def convert_to_comments (lines)
-    return [] if lines.empty?
-    [
+    def convert_to_comments(lines)
+      return [] if lines.empty?
+      [
         lines.map { |ln| '// ' + ln },
         blank,
-    ].flatten
-end
+      ].flatten
+    end
 
-def syn_df
-    r = [
+    def syn_df
+      r = [
         syn_df_start,
         syn_var_locations(@sfc.variables),
         syntax_end,
-    ]
-    r.flatten
-end
+      ]
+      r.flatten
+    end
 
-def syn_df_start
-    ['FORMAT fixed', '', (@sfc.data_structure == 'hier') ? hier_fyi : '']
-end
+    def syn_df_start
+      ['FORMAT fixed', '', (@sfc.data_structure == 'hier') ? hier_fyi : '']
+    end
 
-def hier_fyi
-  convert_to_comments([ '',
-    'Hierarchical data structures are not directly supported by Stat/Transfer.',
-    'Please see the README for the stats_package_syntax_file_generator gem for more information.', ''
-  ])
-end
+    def hier_fyi
+      convert_to_comments(['',
+        'Hierarchical data structures are not directly supported by Stat/Transfer.',
+        'Please see the README for the stats_package_syntax_file_generator gem for more information.', ''
+      ])
+    end
 
-def syn_var_locations (var_list)
-    r = [
+    def syn_var_locations(var_list)
+      r = [
         'VARIABLES',
         var_list.map { |v| sprintf @var_loc_format, v.name, var_loc_with_fmt(v), var_val_lbl_id(v) }
-    ]
-    r.flatten
-end
+      ]
+      r.flatten
+    end
 
-def var_val_lbl_id (var)
-    return '' unless @vars_with_values.include?(var)
-    '\\' + var.name
-end
+    def var_val_lbl_id(var)
+      return '' unless @vars_with_values.include?(var)
+      '\\' + var.name
+    end
 
-def syn_var_labs (var_list = [])
-    var_list = @sfc.get_vars_with_var_labels if var_list.empty?
-    var_list = var_list.reject { |var| !supported_var_label?(var) }
-    return [] if var_list.empty?
-    r = [
+    def syn_var_labs(var_list = [])
+      var_list = @sfc.get_vars_with_var_labels if var_list.empty?
+      var_list = var_list.reject { |var| !supported_var_label?(var) }
+      return [] if var_list.empty?
+      r = [
         'VARIABLE LABELS',
         var_list.map { |var| syn_var_lab_for_var(var) },
         syntax_end,
-    ]
-    r.flatten
-end
+      ]
+      r.flatten
+    end
 
-def syn_var_lab_for_var (var)
-    sprintf @var_lab_format, var.name, esc(q(var.label))
-end
+    def syn_var_lab_for_var(var)
+      sprintf @var_lab_format, var.name, esc(q(var.label))
+    end
 
-def syn_val_labs
-    var_list = @vars_with_values
-    return [] if var_list.empty?
-    r = [
+    def syn_val_labs
+      var_list = @vars_with_values
+      return [] if var_list.empty?
+      r = [
         'VALUE LABELS',
         syn_val_labs_for_var_list(var_list),
         syntax_end,
-    ]
-    r.flatten
-end
+      ]
+      r.flatten
+    end
 
-def syn_val_labs_for_var_list (var_list)
-    var_list.map { |var| syn_val_labs_for_var(var) }
-end
+    def syn_val_labs_for_var_list(var_list)
+      var_list.map { |var| syn_val_labs_for_var(var) }
+    end
 
-def syn_val_labs_for_var (var)
-    val_list = labelable_values(var)
-    return [] if val_list.empty?
-    
-    m = max_value_length(var, val_list.select {|x| supported_val?(x)})  
-    value_format = "    %-#{m}s %s"
-    r = [
-        syn_val_labs_for_var_start(var),
-        val_list.map { |val| syn_val_lab_for_val(var, val, value_format) }
-    ]
-    r.flatten
-end
+    def syn_val_labs_for_var(var)
+      val_list = labelable_values(var)
+      return [] if val_list.empty?
 
-def syn_val_labs_for_var_start (var)
-    '  \\' + var.name
-end
+      m = max_value_length(var, val_list.select { |x| supported_val?(x) })
+      value_format = "    %-#{m}s %s"
+      r = [
+        syn_val_labs_for_var_start(var),
+        val_list.reject { |val| !supported_val?(val) }.map { |val| syn_val_lab_for_val(var, val, value_format) }
+      ]
+      r.flatten
+    end
 
-def syn_val_lab_for_val (var, val, fmt)
-    return explain_skipped_value(val) if !supported_val?(val)      
-    sprintf fmt, sts_val_q(var, val_as_s(var, val.value.to_s)), esc(q(val.label))
-end
+    def syn_val_labs_for_var_start(var)
+      '  \\' + var.name
+    end
 
-# value codes (aka value values) need to be quoted with single quotes if they are strings
-def sts_val_q (var, v)
-    var.is_string_var ? "'#{v}'" : v.to_s
-end
+    def syn_val_lab_for_val(var, val, fmt)
+      sprintf fmt, sts_val_q(var, val_as_s(var, val.value.to_s)), esc(q(val.label))
+    end
 
-def var_loc_with_fmt (var)
-    return var.column_locations_as_s + var_fmt(var) unless var.implied_decimals > 0
-    var.start_column.to_s + var_fmt(var)
-end
+    # value codes (aka value values) need to be quoted with single quotes if they are strings
+    def sts_val_q(var, v)
+      var.is_string_var ? "'#{v}'" : v.to_s
+    end
 
-def var_fmt (var)
-    return ' (A)' if var.is_string_var
-    return '' unless var.implied_decimals > 0
-    ' (F' + var.width.to_s + '.' + var.implied_decimals.to_s + ')'
-end
+    def var_loc_with_fmt(var)
+      return var.column_locations_as_s + var_fmt(var) unless var.implied_decimals > 0
+      var.start_column.to_s + var_fmt(var)
+    end
 
-def q (s)
-    '"' + s.to_s.gsub('"', '\'\'') + '"'
-end
+    def var_fmt(var)
+      return ' (A)' if var.is_string_var
+      return '' unless var.implied_decimals > 0
+      ' (F' + var.width.to_s + '.' + var.implied_decimals.to_s + ')'
+    end
 
-def esc (s)
-    s.gsub(/\n/, " [New line.] ")
-end
+    def q(s)
+      '"' + s.to_s.gsub('"', '\'\'') + '"'
+    end
 
-def explain_skipped_value(val)
-    return "// Value label for '#{val.value}' is not STS compatible -- skipping" if !supported_val_label?(val)
-    "// Value '#{val.value}' is not STS compatible -- skipping" if !supported_val_value?(val)
-    "// Skipping"
-end
+    def esc(s)
+      s.gsub(/\n/, " [New line.] ")
+    end
 
-# Stat/Transfer does not like blank value labels
-def get_vars_with_sts_supported_values()
-    @sfc.get_vars_with_values.select do |var|
+    # Stat/Transfer does not like blank value labels
+    def get_vars_with_sts_supported_values()
+      @sfc.get_vars_with_values.select do |var|
         sts_supported_values(var).size > 0
+      end
     end
-end
 
-def sts_supported_values(var)
-    return [] if (var.nil? || var.values.nil?)
-    var.values.select { |val| supported_val?(val) }
-end
+    def sts_supported_values(var)
+      return [] if (var.nil? || var.values.nil?)
+      var.values.select { |val| supported_val?(val) }
+    end
 
-def supported_val?(val)
-    supported_val_label?(val) && supported_val_value?(val)
-end
+    def supported_val?(val)
+      supported_val_label?(val) && supported_val_value?(val)
+    end
 
-def supported_val_label?(val)
-    !(val.nil?) && !(val.label.nil?) && !(val.label.strip.empty?)
-end
+    def supported_val_label?(val)
+      !(val.nil?) && !(val.label.nil?) && !(val.label.strip.empty?)
+    end
 
-def supported_val_value?(val)
-    !(val.nil?) && !(val.value.nil?) && !!(val.value.to_s =~ /^[A-Za-z0-9\-\_\.]+$/)
-end
+    def supported_val_value?(val)
+      !(val.nil?) && !(val.value.nil?) && !!(val.value.to_s =~ /^[A-Za-z0-9\-\_\.]+$/)
+    end
 
-def supported_var_label?(var)
-    !(var.nil?) && !(var.label.nil?) && !(var.label.strip.empty?)
-end
+    def supported_var_label?(var)
+      !(var.nil?) && !(var.label.nil?) && !(var.label.strip.empty?)
+    end
 
-end
+  end
 end

data/lib/syntax_file/value.rb

@@ -4,26 +4,25 @@
 #   https://github.com/mnpopcenter/stats_package_syntax_file_generator
 
 module SyntaxFile
-class Value
+  class Value
 
-ATTR = {
-    :value => { :req => true,  :rw => 'rw', :def =>  nil   },
-    :label => { :req => false, :rw => 'rw', :def =>  ''    },
-}
+    ATTR = {
+      :value => { :req => true, :rw => 'rw', :def => nil },
+      :label => { :req => false, :rw => 'rw', :def => '' },
+    }
 
-ATTR.each_key do |k|
-    attr_reader k if ATTR[k][:rw].include? 'r'
-    attr_writer k if ATTR[k][:rw].include? 'w'
-end
+    ATTR.each_key do |k|
+      attr_reader k if ATTR[k][:rw].include? 'r'
+      attr_writer k if ATTR[k][:rw].include? 'w'
+    end
 
-def initialize (args = {})
-    ATTR.each_key { |k|
-        raise(ArgumentError, "Missing required parameter: '#{k}'.") if
-            ATTR[k][:req] and not args.has_key?(k)
+    def initialize(args = {})
+      ATTR.each_key { |k|
+        raise(ArgumentError, "Missing required parameter: '#{k}'.") if ATTR[k][:req] and not args.has_key?(k)
         v = args.has_key?(k) ? args[k] : ATTR[k][:def]
         instance_variable_set("@#{k}".to_sym, v)
-    }
-end
+      }
+    end
 
-end
+  end
 end

data/lib/syntax_file/variable.rb

@@ -4,53 +4,52 @@
 #   https://github.com/mnpopcenter/stats_package_syntax_file_generator
 
 module SyntaxFile
-class Variable
-
-ATTR = {
-    :name              => { :req => true,  :rw => 'rw', :def =>  ''    },
-    :label             => { :req => false, :rw => 'rw', :def =>  ''    },
-    :start_column      => { :req => true,  :rw => 'rw', :def =>  nil   },
-    :width             => { :req => true,  :rw => 'rw', :def =>  nil   },
-    :is_string_var     => { :req => false, :rw => 'rw', :def =>  false },
-    :is_double_var     => { :req => false, :rw => 'rw', :def =>  false },
-    :is_common_var     => { :req => false, :rw => 'rw', :def =>  false },
-    :record_type       => { :req => false, :rw => 'rw', :def =>  ''    },
-    :implied_decimals  => { :req => false, :rw => 'rw', :def =>  0     },
-    :suppress_labels   => { :req => false, :rw => 'rw', :def =>  false },
-    :values            => { :req => false, :rw => 'r',  :def =>  nil   },
-}
-
-ATTR.each_key do |k|
-    attr_reader k if ATTR[k][:rw].include? 'r'
-    attr_writer k if ATTR[k][:rw].include? 'w'
-end
+  class Variable
+
+    ATTR = {
+      :name              => { :req => true,  :rw => 'rw', :def =>  ''    },
+      :label             => { :req => false, :rw => 'rw', :def =>  ''    },
+      :start_column      => { :req => true,  :rw => 'rw', :def =>  nil   },
+      :width             => { :req => true,  :rw => 'rw', :def =>  nil   },
+      :is_string_var     => { :req => false, :rw => 'rw', :def =>  false },
+      :is_double_var     => { :req => false, :rw => 'rw', :def =>  false },
+      :is_common_var     => { :req => false, :rw => 'rw', :def =>  false },
+      :record_type       => { :req => false, :rw => 'rw', :def =>  ''    },
+      :implied_decimals  => { :req => false, :rw => 'rw', :def =>  0     },
+      :suppress_labels   => { :req => false, :rw => 'rw', :def =>  false },
+      :values            => { :req => false, :rw => 'r',  :def =>  nil   },
+    }
+
+    ATTR.each_key do |k|
+      attr_reader k if ATTR[k][:rw].include? 'r'
+      attr_writer k if ATTR[k][:rw].include? 'w'
+    end
 
-def initialize (args = {})
-    ATTR.each_key { |k|
-        raise(ArgumentError, "Missing required parameter: '#{k}'.") if
-            ATTR[k][:req] and not args.has_key?(k)
+    def initialize(args = {})
+      ATTR.each_key { |k|
+        raise(ArgumentError, "Missing required parameter: '#{k}'.") if ATTR[k][:req] and not args.has_key?(k)
         v = args.has_key?(k) ? args[k] : ATTR[k][:def]
         instance_variable_set("@#{k}".to_sym, v)
-    }
-    @values = [] if @values.nil?
-end
+      }
+      @values = [] if @values.nil?
+    end
 
-def column_locations_as_s
-    @start_column.to_s + '-' + end_column.to_s
-end
+    def column_locations_as_s
+      @start_column.to_s + '-' + end_column.to_s
+    end
 
-def end_column
-    @start_column + @width - 1
-end
+    def end_column
+      @start_column + @width - 1
+    end
 
-def add_value (args)
-    @values.push Value.new(args)
-    @values[-1]
-end
+    def add_value(args)
+      @values.push Value.new(args)
+      @values[-1]
+    end
 
-def clear_values
-    @values = []
-end
+    def clear_values
+      @values = []
+    end
 
-end
+  end
 end

data/tests/input_all_vars.yaml

@@ -591,7 +591,7 @@ variables:
     is_missing_value: false
   -
     value: "50"
-    label: "[no label]"
+    label: # empty label, should be a invalid value label for STS
     is_missing_value: false
   -
     value: "70"

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