iostreams 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849ceda63eb30f95762a7c985cd215d424e62afd68ab20776e8d16c188dd6aed
-  data.tar.gz: 8e26af86c40bb673ce36855a7fb30d1c4b401edc3eac0b27a71b9760cfe865dd
+  metadata.gz: b84445b48ac6697a255b5fdacd16783b8573e2cdb75ad395c3b4167ffdd6e01b
+  data.tar.gz: a37969afc9635fdac60ea45717d64b9bdd8fbb7c6d853a04c0a02cd798274606
 SHA512:
-  metadata.gz: 99318c4c64e0133df57b84429b1c2f9caa064abb1405ace5d55208e41b6bf8bb8fa83a75db8ae46d53753f10d566bab53971d95871ed4011bab4571d31bebe8a
-  data.tar.gz: bfba3a033c753e3fe05f798177b8f3c7ee8f566eabaf9223984fa902b288cb3515154f621a4e97f75b6c5bc31da88f284390c2d82c5015d7682ecf08c2a671d3
+  metadata.gz: 685d6a23dfc176f3abe922fab1879c76572b73dc878864af3e38dfa5824e0eb8c115f855537dcf3c3f2d181b3381512a2c9a20c065beb62cfd91642913c84b30
+  data.tar.gz: db6e6fcb72c07fe502e64f9ab4d18c79334cde6c1622d1b2ac2a22361ed1f38967adc19bb83959e56fc2039ee595f078c1a92d6277a5b8d39d3802e020df0a1a

data/lib/io_streams/tabular/header.rb

@@ -2,6 +2,9 @@ module IOStreams
   class Tabular
     # Process files / streams that start with a header.
     class Header
+      # Column names that begin with this prefix have been rejected and should be ignored.
+      IGNORE_PREFIX = "__rejected__".freeze
+
       attr_accessor :columns, :allowed_columns, :required_columns, :skip_unknown
 
       # Header
@@ -17,8 +20,8 @@ module IOStreams
       #     List of columns to allow.
       #     Default: nil ( Allow all columns )
       #     Note:
-      #       When supplied any columns that are rejected will be returned in the cleansed columns
-      #       as nil so that they can be ignored during processing.
+      #     * So that rejected columns can be identified in subsequent steps, they will be prefixed with `__rejected__`.
+      #       For example, `Unknown Column` would be cleansed as `__rejected__Unknown Column`.
       #
       #   required_columns [Array<String>]
       #     List of columns that must be present, otherwise an Exception is raised.
@@ -44,8 +47,10 @@ module IOStreams
       # - Spaces and '-' are converted to '_'.
       # - All characters except for letters, digits, and '_' are stripped.
       #
-      # Notes
-      # * Raises Tabular::InvalidHeader when there are no non-nil columns left after cleansing.
+      # Notes:
+      # * So that rejected columns can be identified in subsequent steps, they will be prefixed with `__rejected__`.
+      #   For example, `Unknown Column` would be cleansed as `__rejected__Unknown Column`.
+      # * Raises Tabular::InvalidHeader when there are no rejected columns left after cleansing.
       def cleanse!
         return [] if columns.nil? || columns.empty?
 
@@ -56,7 +61,7 @@ module IOStreams
             cleansed
           else
             ignored_columns << column
-            nil
+            "#{IGNORE_PREFIX}#{column}"
           end
         end
 
@@ -122,7 +127,7 @@ module IOStreams
 
       def array_to_hash(row)
         h = {}
-        columns.each_with_index { |col, i| h[col] = row[i] unless IOStreams::Utils.blank?(col) }
+        columns.each_with_index { |col, i| h[col] = row[i] unless IOStreams::Utils.blank?(col) || col.start_with?(IGNORE_PREFIX) }
         h
       end
 
@@ -134,12 +139,7 @@ module IOStreams
           hash = hash.dup
           unmatched.each { |name| hash[cleanse_column(name)] = hash.delete(name) }
         end
-        # Hash#slice as of Ruby 2.5
-        if hash.respond_to?(:slice)
-          hash.slice(*columns)
-        else
-          columns.each_with_object({}) { |column, new_hash| new_hash[column] = hash[column] }
-        end
+        hash.slice(*columns)
       end
 
       def cleanse_column(name)

data/lib/io_streams/version.rb

@@ -1,3 +1,3 @@
 module IOStreams
-  VERSION = "1.7.0".freeze
+  VERSION = "1.8.0".freeze
 end

data/test/tabular_test.rb

@@ -58,12 +58,12 @@ class TabularTest < Minitest::Test
           assert_equal header, tabular.header.columns
         end
 
-        it "white listed snake cased alphanumeric columns" do
+        it "allowed list snake cased alphanumeric columns" do
           tabular = IOStreams::Tabular.new(
-            columns:         ["Ard Vark", "password", "robot version", "$$$"],
+            columns:         ["Ard Vark", "Password", "robot version", "$$$"],
             allowed_columns: %w[ard_vark robot_version]
           )
-          expected_header = ["ard_vark", nil, "robot_version", nil]
+          expected_header = ["ard_vark", "__rejected__Password", "robot_version", "__rejected__$$$"]
           cleansed_header = tabular.cleanse_header!
           assert_equal(expected_header, cleansed_header)
         end
@@ -82,13 +82,13 @@ class TabularTest < Minitest::Test
           assert_equal @allowed_columns, tabular.header.allowed_columns
         end
 
-        it "nils columns not in the whitelist" do
+        it "nils columns not in the allowed list" do
           tabular = IOStreams::Tabular.new(columns: ["   first ", "Unknown Column", "thirD   "], allowed_columns: @allowed_columns)
           header  = tabular.cleanse_header!
-          assert_equal ["first", nil, "third"], header
+          assert_equal ["first", "__rejected__Unknown Column", "third"], header
         end
 
-        it "raises exception for columns not in the whitelist" do
+        it "raises exception for columns not in the allowed list" do
           tabular = IOStreams::Tabular.new(columns: ["   first ", "Unknown Column", "thirD   "], allowed_columns: @allowed_columns, skip_unknown: false)
           exc     = assert_raises IOStreams::Errors::InvalidHeader do
             tabular.cleanse_header!
@@ -218,7 +218,7 @@ class TabularTest < Minitest::Test
         end
       end
 
-      it "skips columns not in the whitelist" do
+      it "skips columns not in the allowed list" do
         tabular.header.allowed_columns = %w[first second third fourth fifth]
         tabular.cleanse_header!
         assert hash = tabular.record_parse("1,2,3")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Input and Output streaming for Ruby.