true_table 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c778d54af435cbd53a4dfc45df1026d954dd79fda06c12ca7de9c5203054bd5
-  data.tar.gz: ecb8c574d6f53b7936cf7c668e55050f4effee32063922b92605200f48569d94
+  metadata.gz: 53e26ebda846b40d7f2399e318b3be09ce49c71ddebbab97bfc34fbd64d664b4
+  data.tar.gz: 1427d9de17b647d15469522ea5483b268ca41ef82a325b286617dc72ada93ad9
 SHA512:
-  metadata.gz: 9cc7983ee8202a8ce1c1e4414dc5e5a2c34f5ed4e70c2789e2c940c325431cb1034d99ddaaae6c11e7771b993b8f0f747c3e3a7a792445b22f6376573e02b638
-  data.tar.gz: 3f2e42e7b50716d0e93e0676fd7c161a8e6bab1962c50358b734fb301d7b967785acaa7db79382a1b70fffce28c54d6ed9e1e27a88e45c237db717c2ddca6ed5
+  metadata.gz: b2aa85ebfd3c93611bcd499fa1c551dfac70b552353e89e60e0a68362763c9e8e5663d9557d310d36fb488409aaf3fac46234dc95fe18644422fc7654ec05155
+  data.tar.gz: 9c8d9423738e0724c3bbcac5fc93187c8bd8c2e68cd5cb8a481324bd0b2080b3087ff9dad498b024ec41f0784a061afc0988c5654f177073c2a1334ec9cb78e1

data/README.md

@@ -16,6 +16,9 @@ each row is a `Hash`.
 $ gem install true_table
 ```
 
-## Usage
+## Documentation
 
-TODO
+[Documentation on RubyDoc][docs]
+
+
+[docs]: https://rubydoc.info/gems/true_table

data/lib/true_table.rb

@@ -1,2 +1,236 @@
-require 'true_table/table'
-require 'byebug' if ENV['BYEBUG']
+require 'csv'
+
+class TrueTable < Array
+  class << self
+    # Loads a CSV string
+    #
+    # @example
+    #   csv = "id,name\n1,Harry\n2,Lloyd"
+    #   table = TrueTable.load_csv csv, converters: [:date, :numeric]
+    #
+    # @param [String] csv_string CSV string.
+    # @param [Hash] options options to forward to the CSV class.
+    #
+    # @return [TrueTable] the new table object
+    def from_csv(csv_string, options = {})
+      default_options = { headers: true, converters: :numeric, header_converters: :symbol }
+      csv = CSV.new csv_string, **default_options.merge(options)
+      new.tap do |table|
+        csv.each { |row| table << row.to_h }
+      end
+    end
+
+    # Loads a CSV file
+    #
+    # @example
+    #   table = TrueTable.from_csv "sample.csv", converters: [:date, :numeric]
+    #
+    # @param [String] path the path to the CSV file.
+    # @param [Hash] options options to forward to the CSV class.
+    #
+    # @return [TrueTable] the new table object
+    def load_csv(path, options = {})
+      from_csv File.read(path), options
+    end
+  end
+
+  # Combines table with other and returns a new one
+  def +(other)
+    result = self.class.new
+    each_row { |row, i| result << row.merge(other[i]) }
+    result
+  end
+
+  # Returns a new table without the specified columns
+  def -(cols)
+    keep_keys = headers - cols
+    result = self.class.new
+    each_row { |row, i| result << row.slice(*keep_keys) }
+    result
+  end
+
+  # Returns a row or a column
+  def [](key)
+    key.is_a?(Symbol) ? col(key) : super
+  end
+
+  # Adds or updates a row or a column
+  def []=(key, value)
+    key.is_a?(Symbol) ? add_col(key.to_sym, value) : super
+  end
+
+  # Returns a deep copy of self
+  def clone
+    self.class.new map(&:clone)
+  end
+
+  # Returns a column as Array
+  def col(key)
+    map { |row| row[key] }
+  end
+
+  # Returns a hash of columns
+  def cols
+    result = {}
+    each_col { |col, header| result[header] = col }
+    result
+  end
+
+  # Returns a copy of self without rows that contain nil in any column
+  def compact
+    dup.compact!
+  end
+
+  # Removes rows with nil in any column
+  def compact!
+    delete_if { |row| row.values.include? nil }
+  end
+
+  # Delete a row or a column in place and returns the deleted row/column
+  def delete_at(index)
+    if index.is_a?(Symbol) || index.is_a?(String)
+      result = self[index]
+      return nil unless result
+      each_row { |row, i| row.delete index }
+      result
+    else
+      super
+    end
+  end
+  alias delete_col delete_at
+  alias delete_row delete_at
+
+  # Returns a table with different rows
+  def difference(*others)
+    self.class.new super
+  end
+
+  # Extracts nested value. Accepts row, column or column, row
+  def dig(*indexes)
+    key = indexes.shift
+    if key.is_a?(Symbol)
+      col(key.to_sym).dig *indexes
+    else
+      row(key).dig *indexes
+    end
+  end
+
+  # Iterates over columns
+  def each_col
+    headers.each { |header| yield col(header), header }
+  end
+
+  # Iterates over rows
+  alias each_row each_with_index
+
+  def fetch(key, *default)
+    if key.is_a?(Symbol)
+      if headers.include? key
+        col(key.to_sym)
+      elsif default.any?
+        default.first
+      elsif block_given?
+        yield key
+      else
+        raise IndexError, "row :#{key} does not exist"
+      end
+    else
+      super
+    end
+  end
+
+  # Returns an array of column headers
+  def headers
+    first.keys
+  end
+
+  # Returns a new table with intersecting rows
+  def intersection(*others)
+    self.class.new super
+  end
+
+  # Returns a string with joined rows and columns
+  def join(row_separator = $,, col_separator = nil, with_headers: false)
+    if col_separator
+      result = map { |row| row.values.join col_separator }.join(row_separator)
+      with_headers ? headers.join(col_separator) + row_separator + result : result
+    else
+      super row_separator
+    end
+  end
+
+  # Returns the last row or a new table with the last N rows
+  def last(*args)
+    args.empty? ? super : self.class.new(super)
+  end
+
+  # Returns a new table without rejected rows
+  def reject
+    self.class.new super
+  end
+
+  # Returns a reversed copy
+  def reverse
+    self.class.new super
+  end
+
+  # Returns a new table with the element at `count` as the first element
+  def rotate(count = 1)
+    self.class.new super
+  end
+
+  # Returns a row
+  alias row []
+
+  # Saves the table as a CSV file
+  def save_csv(path)
+    File.write path, to_csv
+  end
+
+  # Returns a new table with selected rows
+  def select
+    self.class.new super
+  end
+  alias filter select
+
+  # Returns a new shuffled tables
+  def shuffle(*args)
+    self.class.new super
+  end
+
+  # Returns a new sorted table
+  def sort
+    self.class.new super
+  end
+
+  # Returns a new sorted table
+  def sort_by
+    self.class.new super
+  end
+
+  # Returns a CSV string
+  def to_csv(row_separator = "\n", col_separator = ",")
+    join(row_separator, col_separator, with_headers: true)
+  end
+
+  # Returns a hash representation of the table using the values of the
+  # first column as hash keys
+  def to_h
+    map { |row| [row.values.first, row] }.to_h
+  end
+
+  # Returns only values, without any headers (array of arrays)
+  def values
+    map { |row| row.values }
+  end
+
+protected
+
+  def add_col(key, values)
+    values.each_with_index do |value, i|
+      self[i] ||= {}
+      self[i][key] = value
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: true_table
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies: []
 description: Simple and intuitive tabular data type
 email: db@dannyben.com
@@ -18,8 +18,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/true_table.rb
-- lib/true_table/table.rb
-- lib/true_table/version.rb
 homepage: https://github.com/dannyben/true_table
 licenses:
 - MIT

data/lib/true_table/table.rb

@@ -1,198 +0,0 @@
-module TrueTable
-  class Table < Array
-    # Combines table with other and returns a new one
-    def +(other)
-      result = self.class.new
-      each_row { |row, i| result << row.merge(other[i]) }
-      result
-    end
-
-    # Returns a new table without the specified columns
-    def -(cols)
-      keep_keys = headers - cols
-      result = self.class.new
-      each_row { |row, i| result << row.slice(*keep_keys) }
-      result
-    end
-
-    # Returns a row or a column
-    def [](key)
-      key.is_a?(Symbol) ? col(key) : super
-    end
-
-    # Adds or updates a row or a column
-    def []=(key, value)
-      key.is_a?(Symbol) ? add_col(key.to_sym, value) : super
-    end
-
-    # Returns a deep copy of self
-    def clone
-      self.class.new map(&:clone)
-    end
-
-    # Returns a column as Array
-    def col(key)
-      map { |row| row[key] }
-    end
-
-    # Returns a hash of columns
-    def cols
-      result = {}
-      each_col { |col, header| result[header] = col }
-      result
-    end
-
-    # Returns a copy of self without rows that contain nil in any column
-    def compact
-      dup.compact!
-    end
-
-    # Removes rows with nil in any column
-    def compact!
-      delete_if { |row| row.values.include? nil }
-    end
-
-    # Delete a row or a column in place and returns the deleted row/column
-    def delete_at(index)
-      if index.is_a?(Symbol) || index.is_a?(String)
-        result = self[index]
-        return nil unless result
-        each_row { |row, i| row.delete index }
-        result
-      else
-        super
-      end
-    end
-    alias delete_col delete_at
-    alias delete_row delete_at
-
-    # Returns a table with different rows
-    def difference(*others)
-      self.class.new super
-    end
-
-    # Extracts nested value. Accepts row, column or column, row
-    def dig(*indexes)
-      key = indexes.shift
-      if key.is_a?(Symbol)
-        col(key.to_sym).dig *indexes
-      else
-        row(key).dig *indexes
-      end
-    end
-
-    # Iterates over columns
-    def each_col
-      headers.each { |header| yield col(header), header }
-    end
-
-    # Iterates over rows
-    alias each_row each_with_index
-
-    def fetch(key, *default)
-      if key.is_a?(Symbol)
-        if headers.include? key
-          col(key.to_sym)
-        elsif default.any?
-          default.first
-        elsif block_given?
-          yield key
-        else
-          raise IndexError, "row :#{key} does not exist"
-        end
-      else
-        super
-      end
-    end
-
-    # Returns an array of column headers
-    def headers
-      first.keys
-    end
-
-    # Returns a new table with intersecting rows
-    def intersection(*others)
-      self.class.new super
-    end
-
-    # Returns a string with joined rows and columns
-    def join(row_separator = $,, col_separator = nil, with_headers: false)
-      if col_separator
-        result = map { |row| row.values.join col_separator }.join(row_separator)
-        with_headers ? headers.join(col_separator) + row_separator + result : result
-      else
-        super row_separator
-      end
-    end
-
-    # Returns the last row or a new table with the last N rows
-    def last(*args)
-      args.empty? ? super : self.class.new(super)
-    end
-
-    # Returns a new table without rejected rows
-    def reject
-      self.class.new super
-    end
-
-    # Returns a reversed copy
-    def reverse
-      self.class.new super
-    end
-
-    # Returns a new table with the element at `count` as the first element
-    def rotate(count = 1)
-      self.class.new super
-    end
-
-    # Returns a row
-    alias row []
-
-    # Returns a new table with selected rows
-    def select
-      self.class.new super
-    end
-    alias filter select
-
-    # Returns a new shuffled tables
-    def shuffle(*args)
-      self.class.new super
-    end
-
-    # Returns a new sorted table
-    def sort
-      self.class.new super
-    end
-
-    # Returns a new sorted table
-    def sort_by
-      self.class.new super
-    end
-
-    # Returns a CSV string
-    def to_csv(row_separator = "\n", col_separator = ",")
-      join(row_separator, col_separator, with_headers: true)
-    end
-
-    # Returns a hash representation of the table using the values of the
-    # first column as hash keys
-    def to_h
-      map { |row| [row.values.first, row] }.to_h
-    end
-
-    # Returns only values, without any headers (array of arrays)
-    def values
-      map { |row| row.values }
-    end
-
-  protected
-
-    def add_col(key, values)
-      values.each_with_index do |value, i|
-        self[i] ||= {}
-        self[i][key] = value
-      end
-    end
-
-  end
-end

data/lib/true_table/version.rb

@@ -1,3 +0,0 @@
-module TrueTable
-  VERSION = "0.1.2"
-end