tablestakes 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d469293fdfb6e377ce2dbdc2eff758511d9e37c6
-  data.tar.gz: 4bc603714a7674830b9246232a7c878e81bc343c
+  metadata.gz: 8bd18629eb73a93ba19287533d8b493f524e0bd7
+  data.tar.gz: 0e18ca987924cc39fd4472a2b82f4c45b2b2c2d3
 SHA512:
-  metadata.gz: 48615113c3f2324ec8cf88d835ba8a480564b60c275c97ec6d83061cb007920db9e527a048fc8e4668072de1507e2cd82ffc9a7077d95dc1270c234ec2869b7e
-  data.tar.gz: 4bf01417604256a1ec73ae21ef8a2697534d3c6e7ef9a6a060d8611bbf0daaa38e6cce8f0f6bfa34e26f19311f296abdb9a0e1b3944bd17d17613ec840ffc1fc
+  metadata.gz: fbde53ed596e58e5e95d753b71a0ccb53214d362b152803703a72e154fe462c34d540b5a5f18be099357fa674593d9770dc18dd40e695b6a3d4c2cf5e7b05e17
+  data.tar.gz: 433d41010b0d2661d133cfdff0bf1b681f3927a43ef9b7dc0af0cc8d30e9ce6eb5ff724ebe643bfee9e629d0e14d63088f54cc09194c35fc0bd41cd298ba3950

data/README.md

@@ -165,9 +165,10 @@ the `Table#sub` method provides a way to eliminate common garbage from
 your data such as stray characters.
 
 ```ruby
-cities.sub("2012 land area", /.*sq mi/, '')     # deletes 'sq mi' from the 2012 land area field
+cities.sub("2012 land area", /(.*) sq mi/, '\1')     # deletes ' sq mi' from the end of the 2012 land area field
 ``` 
 
+
 `Table#sub` takes a regular expression and a substitute string, which 
 gives some flexibility in how data is updated.  Note that this is 
 a method which modifies the table object.

data/lib/tablestakes.rb

@@ -16,7 +16,6 @@
 # serving as the header names. 
 
 class Table
-  include Enumerable
 
   # The headers attribute contains the table headers used to reference
   # columns in the +Table+.  All headers are represented as +String+ types.
@@ -54,6 +53,7 @@ class Table
       # a string, then read_file
       read_file(input)
     elsif input.respond_to?(:headers)
+      @headers = input.headers.dup
       input.each {|row| add_row(row) }
     end
     # else create empty +Table+
@@ -63,13 +63,23 @@ class Table
   # for its calling block.
   #
   def each
-    @table[@headers.first].each_index do |index|
-      nextrow = []
-      @headers.each do |col|
-        nextrow << @table[col][index].clone
+
+    if block_given?
+      @table[@headers.first].each_index do |index|
+        nextrow = []
+        @headers.each do |col|
+          begin
+            nextrow << @table[col][index].clone 
+          rescue
+            nextrow << @table[col][index]
+          end
+        end
+        yield nextrow
       end
-      yield nextrow
+    else
+      self.to_enum(:each)
     end
+
   end
     
   # Return a copy of a column from the table, identified by column name.
@@ -78,12 +88,7 @@ class Table
   # ==== Attributes
   # +colname+:: +String+ to identify the name of the column
   def column(colname)
-    # return empty Array if column name not found
-    unless @table.has_key?(colname) 
-      Array.new()
-    else
-      Array(@table[colname])
-    end
+    Array(get_col(colname))
   end
   
   # Return a copy of a row from the table as an +Array+, given an index
@@ -116,8 +121,6 @@ class Table
       args.flatten!
       colname = args.shift
       column_vals = args
-    else
-      raise ArgumentError, "Invalid Arguments to add_column"
     end
     # check arguments
     raise ArgumentError, "Duplicate Column Name!" if @table.has_key?(colname)
@@ -186,8 +189,6 @@ class Table
   def add_row(*row)
     if row.kind_of? Array
       row = row.flatten
-    else
-      raise ArgumentError, "Invalid Arguments to add_row"
     end
     if @headers.empty?
         @headers = row
@@ -245,6 +246,10 @@ class Table
   # +orig_name+:: +String+ current header name
   # +new_name+:: +String+ indicating new header name
   def rename_header(orig_name, new_name)
+    raise ArgumentError, "Original Column name type invalid" unless orig_name.kind_of? String
+    raise ArgumentError, "New Column name type invalid" unless new_name.kind_of? String
+    raise ArgumentError, "Column Name does not exist!" unless @headers.include? orig_name
+
     update_header(orig_name, new_name)
     return self
   end
@@ -467,7 +472,6 @@ class Table
     raise ArgumentError, "Invalid table!" unless table2.is_a?(Table)
     raise ArgumentError, "Invalid column name" unless @table.has_key?(colname)
     raise ArgumentError, "Invalid column name" unless table2.headers.include?(col2name)
-    t2_col_index = table2.headers.index(col2name)
     
     dedupe_headers(table2, colname)
 
@@ -495,27 +499,28 @@ class Table
   # in the given column. Raises ArgumentError if the column is not found.
   # 
   # ==== Attributes
-  # +colname+:: +String+ to identify the column to join on
-  # +re+:: +Regexp+ to match the value in the selected column
-  # +replace+:: OPTIONAL +String+ or +Hash+ to specify the replacement text for the given +Regexp+
+  # +colname+:: +String+ to identify the column to substitute on
+  # +match+:: OPTIONAL +String+ or +Regexp+ to match the value in the selected column
+  # +replace+:: OPTIONAL +String+ or +Hash+ to specify the replacement text for the given match value
   # +&block+:: OPTIONAL block to execute against matching values
   #
   # ==== Examples
   #     cities.sub("Population", /(.*?),(.*?)/, '\1\2')  # eliminate commas
   #     capitals.sub("State", /NY/, "New York")  # replace acronym with full name
+  #     capitals.sub("State", /North|South/, {"North" => "South", "South" => "North"}) # Northern states for Southern and vice-versa
   #     capitals.sub("State") { |state| state.downcase } # Lowercase for all values
   #
-  def sub(colname, re=nil, replace=nil, &block)
+  def sub(colname, match=nil, replace=nil, &block)
     # check arguments
-    raise ArgumentError, "No regular expression to match against" unless re
+    raise ArgumentError, "No regular expression to match against" unless match || block_given?
     raise ArgumentError, "Invalid column name" unless @table.has_key?(colname)
-    replace_str = ""
-    if replace.respond_to?(:fetch)
-      replace_str = replace.fetch(re)
-    elsif replace.respond_to?(:to_str)
-      replace_str = replace.to_str
-    else
-      raise ArgumentError, "Replacement must be String or Hash"
+
+    if ! block_given?
+      if ! (String.try_convert(match) || Regexp.try_convert(match))
+    	   raise ArgumentError, "Match expression must be String or Regexp"
+      elsif ! (replace.respond_to?(:fetch) || replace.respond_to?(:to_str))
+         raise ArgumentError, "Replacement must be String or Hash"
+      end
     end
 
     result = Table.new([@headers])
@@ -525,7 +530,7 @@ class Table
       if block_given?
         row[col_index] = block.call row[col_index]
       else
-        row[col_index] = row[col_index].sub(re, replace_str)
+        row[col_index] = row[col_index].sub(match, replace)
       end  
       result.add_row(row)
     end
@@ -647,7 +652,8 @@ class Table
   
   def get_row(index)
     result = []
-    if index >= @table[@headers.first].length
+    if index >= @table[@headers.first].length || 
+          index < -(@table[@headers.first].length)
       return result
     end 
     @headers.each { |col| result << @table[col][index].to_s }
@@ -662,7 +668,12 @@ class Table
   end  
 
   def get_col(colname)
-    Array.new(@table[colname])
+    # return empty Array if column name not found
+    unless @table.has_key?(colname) 
+      Array.new()
+    else
+      Array(@table[colname])
+    end
   end
   
   def append_col(colname, column_vals)

data/spec/spec_helper.rb

@@ -4,10 +4,10 @@
 require 'simplecov'
 require 'coveralls'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
-]
+])
 SimpleCov.start
 
 require 'factory_girl'

data/spec/table_spec.rb

@@ -11,6 +11,7 @@ describe "Table" do
   describe ".new" do
     let(:t) { Table.new('test.tab') }
     let(:empty) { Table.new() }
+    let(:copy) { Table.new(Table.new('test.tab')) }
     
     it "reads a file and create a table" do
       expect(t).to be_a(Table)
@@ -18,12 +19,39 @@ describe "Table" do
     it "creates a table if no file was given" do
       expect(empty).to be_a(Table)
     end
+    it "creates a table from another table" do
+      expect(copy).to be_a(Table)
+      expect(copy.headers).to eq(t.headers)
+      expect(copy.count).to eq(t.count)
+    end
     it "errors when the file is not found" do
       expect{Table.new('sillyfile.txt')}.to raise_error(Errno::ENOENT)
     end
 
   end
+
+  describe ".column" do
+    let(:test) { FactoryGirl.build(:table) }
+
+    it "returns a column when given a valid header" do
+      expect(test.column('Name')).to be_a(Array)
+    end
+    it "returns an empty Array when given an invalid header" do
+      expect(test.column('NotName')).to eq(Array.new)
+    end
+  end
   
+  describe ".row" do
+    let(:test) { FactoryGirl.build(:table) }
+
+    it "returns a row when given a valid index" do
+      expect(test.row(2)).to be_a(Array)
+    end
+    it "returns an empty Array when given an invalid index" do
+      expect(test.row(4)).to eq(Array.new)
+    end
+  end
+
   describe ".empty?" do
     let(:test) { Table.new('test.tab') }
     let(:empty) { Table.new() }
@@ -36,6 +64,28 @@ describe "Table" do
     end
   end
 
+  describe ".each" do
+    let (:test) { FactoryGirl.build(:table) }
+    let (:test_fixnum) { 
+      Table.new('test.tab') << ["Phil", "567 Vine", "567-432-1234", 3 ]
+    }
+
+    it "returns an Enumerator if not given a block" do
+      expect(test.each).to be_a(Enumerator)
+    end
+    it "returns a clone of a row" do
+      h = test.each.first
+      expect(h).not_to equal(test.row 0)
+      expect(h).to eq(test.row 0)
+    end
+    it "returns a row that can't be cloned" do
+      a = test_fixnum.each
+      a.next
+      a.next
+      expect(a.next).to eq(test_fixnum.row(2))
+    end
+  end
+
   describe ".add_column" do
     let(:test) { FactoryGirl.build(:table) }
     let(:newcol) { ["A", "B", "C"] }
@@ -55,7 +105,7 @@ describe "Table" do
       expect { test.add_column("Name", newcol) }.to raise_error(ArgumentError)
     end
     it "raises an ArgumentError when given a column with the wrong length" do
-      expect { test.add_column("Name", newcol << "D") }.to raise_error(ArgumentError)
+      expect { test.add_column("NewName", newcol << "D") }.to raise_error(ArgumentError)
     end
     it "adds a column when given an Array" do
       expect(test.add_column(headercol).headers).to include("TestCol")      
@@ -96,6 +146,9 @@ describe "Table" do
     it "returns itself when appending an empty table" do
       expect(test1.append(empty).count).to eq(3)
     end
+    it "raises an ArgumentError when not given a table" do
+      expect { test1.append('') }.to raise_error(ArgumentError)
+    end
     it "raises an ArgumentError when given a table with the wrong headers" do
       expect { test1.append(cities) }.to raise_error(ArgumentError)
     end
@@ -150,6 +203,38 @@ describe "Table" do
     end
   end
 
+  describe ".rename_header" do
+    let (:test) { FactoryGirl.build(:table) }
+
+    it "raises an ArgumentError when given a column name with invalid type" do
+      expect { test.rename_header(:Name, "FirstName") }.to raise_error(ArgumentError) 
+    end
+    it "raises an ArgumentError when given a new name with invalid type" do
+      expect { test.rename_header("Name", :FirstName) }.to raise_error(ArgumentError)
+    end
+    it "raises an ArgumentError when given an invalid column name" do
+      expect { test.rename_header("NName", "FirstName") }.to raise_error(ArgumentError)
+    end
+    it "returns a table with an updated header" do
+      expect(test.rename_header("Name", "FirstName").headers).to include("FirstName")
+    end
+
+  end
+
+  describe ".to_s" do
+    let (:test) { FactoryGirl.build(:table) }
+
+    it "returns a String" do
+      expect(test.to_s).to be_a(String)
+    end
+    it "returns a String with the same number of rows" do
+      expect(test.to_s.split("\n").count).to eq(test.count + 1)
+    end
+    it "returns a String with the same number of columns" do
+      expect(test.to_s.split("\n")[0].split("\t").count).to eq(test.headers.count)
+    end
+  end
+
   describe ".count" do
     let(:t) { FactoryGirl.build(:table) }
     let(:empty) { Table.new() }
@@ -260,12 +345,23 @@ describe "Table" do
   
   describe ".sub" do
     let (:cities) { Table.new('cities.txt') }
+    let (:capitals) { Table.new('capitals.txt') }
     
     it "returns an instance of Table" do
       expect(cities.sub("State", /Jersey/, "York")).to be_a(Table)
     end
-    it "substitutes the values in a given field" do
-      expect(cities.sub("State", /Jersey/, "York").column("State")).to include("New York")
+    it "substitutes the values in a given field when matching Regexp" do
+      expect(cities.sub("State", /Jersey/, "York").column("State")).not_to include("New Jersey")
+    end
+    it "substitutes the values in a given field when matching String" do
+      expect(cities.sub("State", "Jersey", "York").column("State")).not_to include("New Jersey")
+    end
+    it "substitutes the values in a given field when provided with a block" do
+      expect(cities.sub("State") {|state| state.upcase}.column("State")).to include("NEW JERSEY")
+    end
+    it "substitutes the values in a given field when provided with a replacement Hash" do
+      expect(capitals.sub("State", /North|South|East|West/, {"North"=>"South", 
+                "South"=>"North", "West" => "East", "East"=>"West" }).column("State")).to include("East Virginia")
     end
     it "raises ArgumentError when the given arguments don't match a column" do
       expect {cities.sub("Silly", /NJ/, "NY") }.to raise_error(ArgumentError)
@@ -273,6 +369,9 @@ describe "Table" do
     it "raises ArgumentError when not given a Match string" do
       expect {cities.sub("State") }.to raise_error(ArgumentError)
     end
+    it "raises ArgumentError when Match expression is not a String or Regexp" do
+      expect {cities.sub("State",:New, "Old") }.to raise_error(ArgumentError)
+    end
     it "raises ArgumentError when replacement is not a String or Hash" do
       expect {cities.sub("State", /New/, 9)}.to raise_error(ArgumentError)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tablestakes
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - J.B. Folkerts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -44,70 +44,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.15
 description: A simple implementation of Tables, for use in summing, joining, slicing
   and dicing data tables
 email: jbf@pentambic.com
@@ -161,7 +161,7 @@ files:
 - spec/spec_helper.rb
 - spec/table_spec.rb
 - test.tab
-homepage: http://rubygems.org/gems/tablestakes
+homepage: https://rubygems.org/gems/tablestakes
 licenses:
 - MIT
 metadata: {}