tabla 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f565b51ba83b71107f138f2d76c34d9a2de0b37019832ee6734ba40b3446df52
+  data.tar.gz: cc35102fa5b92b7b9e5bbbf6e512de2163701514c8dc67a2d079f7af5bd218a8
+SHA512:
+  metadata.gz: b2a5cee36bb38558c4a4ef5ed62c9d555ceaf23edc2ca5de145602cfc6756faaf757023c6909e4f9b52fcf37cf268c363916ed8981989e799bd45200eb51c256
+  data.tar.gz: 99b48345d98d12f332d5f217da2f63a8849bb8219723e10ab52ad6afb8956dafecd2bbe071f5d6f4f54aec1b3203b41b6b4fa206a5ec547b2e0c77d74d5934b1

data/README.md

@@ -0,0 +1,21 @@
+# Tabla
+
+A plain text human-readable tabular data format inspired in tablatal (https://wiki.xxiivv.com/#tablatal)"
+
+## Usage
+
+a file looks like:
+
+```
+date       | desc                                 | amount | notes
+2019-01-01 | Something that worths a lot storing  | 20     | reference: 1237987
+2019-01-01 | Something that worths a lot          | 10     | reference: 1237987
+2019-01-01 | Something that worths                | 5      | reference: 1237987
+2019-01-01 | Something that                       | 2.5    | reference: 1237987
+2019-01-01 | Something                            | 1.25   | reference: 1237987
+2019-01-01 |                                      |        | reference: 1237987
+```
+
+the separator
+
+Implements the `Enumerable` interface

data/lib/tabla.rb

@@ -0,0 +1,49 @@
+class Tabla
+  include Enumerable
+
+  attr_reader :data, :fields, :mapper
+
+  class << self
+    attr_accessor :separator
+  end
+
+  self.separator ||= "|"
+
+  def self.dump(hashes)
+    lines = [hashes.first.keys.join(" #{Tabla.separator} ")]
+    lines += hashes.map { |i| i.values.join " #{Tabla.separator} " }
+    lines.join("\n") << "\n"
+  end
+
+  def self.load(string)
+    new(string).parse
+  end
+
+  def self.load_file(path)
+    load File.read path
+  end
+
+  def initialize(data, &block)
+    @lines = data.split("\n")
+    @fields = split @lines.shift
+    @mapper = block
+  end
+
+  def parse
+    @data = @lines.map do |line|
+      item = fields.zip(split(line)).to_h
+      item = mapper.call(item) if mapper
+      item
+    end
+  end
+
+  def each(&block)
+    block ? data.each(&block) : data.each
+  end
+
+  private
+
+  def split(line)
+    line.split(self.class.separator).map(&:strip)
+  end
+end

data/tabla.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'tabla'
+  s.version     = "0.0.1"
+  s.date        = '2019-05-16'
+  s.summary     = "A plain text human-readable tabular data format inspired in @neauorie's tablatal (https://wiki.xxiivv.com/#tablatal)"
+  s.description = "A plain text human-readable tabular data format inspired in @neauorie's tablatal (https://wiki.xxiivv.com/#tablatal)"
+  s.authors     = ["F-3r"]
+  s.email       = "fernando@templ.co"
+  s.files       = Dir["lib/**/*.rb", "LICENSE", "README.md", "*.gemspec"]
+  s.test_files  = Dir["test/**/*.rb"]
+  s.homepage    = 'https://rubygems.org/gems/tabla'
+  s.license     = 'AGPLv3'
+end

data/test/tabla_test.rb

@@ -0,0 +1,114 @@
+require "minitest/autorun"
+require "pp"
+require "byebug"
+
+require_relative "../lib/tabla"
+
+TABLA = <<-TABLA
+date       | desc                                 | amount | notes
+2019-01-01 | Something that worths a lot storing  | 20     | reference: 1237987
+2019-01-01 | Something that worths a lot          | 10     | reference: 1237987
+2019-01-01 | Something that worths                | 5      | reference: 1237987
+2019-01-01 | Something that                       | 2.5    | reference: 1237987
+2019-01-01 | Something                            | 1.25   | reference: 1237987
+2019-01-01 |                                      |        | reference: 1237987
+TABLA
+
+class ValidString < Minitest::Test
+  def setup
+    @tabla = Tabla.new TABLA
+    @tabla.parse
+  end
+
+  def test_that_each_items_has_correct_keys
+    @tabla.data.each { |row| assert_equal ["date", "desc", "amount", "notes"], row.keys }
+  end
+
+  def test_that_each_item_has_correct_value
+    result = @tabla.data
+
+    result.each { |row| assert_equal row["date"], "2019-01-01" }
+    result.each { |row| assert_equal row["notes"], "reference: 1237987" }
+    assert_equal ["20", "10", "5", "2.5", "1.25", ""], result.map { |row| row["amount"] }
+    assert_empty result.last["desc"]
+  end
+end
+
+class InvalidFieldCountInRow < Minitest::Test
+  def setup
+    @tabla = Tabla.new <<-EOF
+date       | name
+2019-01-01 | Something | | | | |
+    EOF
+    @tabla.parse
+  end
+
+  def test_it_ignores_extra_elements
+    assert_equal({ "date" => "2019-01-01", "name" => "Something"}, @tabla.parse.first)
+  end
+end
+
+class DumpTest < Minitest::Test
+  def setup
+    @data = <<-EOF
+date | name | number
+2019-01-01 | Something | 1234
+2019-01-02 | Other | 5678
+    EOF
+    @parsed_data = [
+                    {
+                     "date" => "2019-01-01",
+                     "name" => "Something",
+                     "number" => "1234",
+                    },
+                    {
+                     "date" => "2019-01-02",
+                     "name" => "Other",
+                     "number" => "5678",
+                    },
+                    ]
+  end
+
+  def test_it_ignores_extra_elements
+    assert_equal @data, Tabla.dump(@parsed_data)
+  end
+
+  def test_it_can_load_what_it_dumps
+    assert_equal @parsed_data, Tabla.load(Tabla.dump(@parsed_data))
+  end
+
+  def test_it_can_dump_what_it_loads
+    assert_equal @data, Tabla.dump(Tabla.load(@data))
+  end
+end
+
+class EnumerableAPIImplementation < Minitest::Test
+  def setup
+    @tabla = Tabla.new TABLA
+    @tabla.parse
+  end
+
+  def test_it_returns_an_enumerator_if_no_block_given
+    assert_equal Enumerator, @tabla.each.class
+  end
+
+  def test_it_evaluates_the_block_for_each_element
+    @tabla.each { |item| assert_equal "2019-01-01", item["date"] }
+  end
+
+  def test_it_selects
+    expected = [{"date"=>"2019-01-01", "desc"=>"Something", "amount"=>"1.25", "notes"=>"reference: 1237987"}]
+    assert_equal expected, @tabla.select { |i| i["desc"] == "Something"}
+  end
+end
+
+class MapperBlockTest < Minitest::Test
+  def setup
+    @tabla = Tabla.new(TABLA) { |item| 1 }
+    @tabla.parse
+  end
+
+  def test_it_maps_all_the_items_through_the_mapper_block
+    @tabla.data.each { |item| assert_equal 1, item }
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: tabla
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- F-3r
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-16 00:00:00.000000000 Z
+dependencies: []
+description: A plain text human-readable tabular data format inspired in @neauorie's
+  tablatal (https://wiki.xxiivv.com/#tablatal)
+email: fernando@templ.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/tabla.rb
+- tabla.gemspec
+- test/tabla_test.rb
+homepage: https://rubygems.org/gems/tabla
+licenses:
+- AGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A plain text human-readable tabular data format inspired in @neauorie's tablatal
+  (https://wiki.xxiivv.com/#tablatal)
+test_files:
+- test/tabla_test.rb