nodaire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9c70a78b831024d450ba7e9cc01ab5c9db7f9d3b70ad4dca16bb6634cc43364
+  data.tar.gz: 5ff998283f79e831fee47f4f8f4a987a85a53a18ba239c178d56a5d01def7c1c
+SHA512:
+  metadata.gz: 3bd4a7c1ca7584c970b1be353f3d82783c808c784d8408543dd6b7de024dce4fa7068e982aaf0dce5faa66f4860c0945ca9362fa473ca1501326143b1da7596c
+  data.tar.gz: be8a98f18ec3cbe88bf4b55eef958fb511b8938737c33b77cf81e71265000e5831147788d3796beb0017f1dd4d3859a8daec832e55f6bd574e0cd2525b09eaeb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Liam Cooke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Nodaire
+
+Ruby parsers for text file formats. Work in progress.
+
+## File formats
+
+- [Oscean](https://wiki.xxiivv.com/#oscean) by Devine Lu Linvega
+
+  - [Indental](https://wiki.xxiivv.com/#indental) (planned)
+
+  - [__Tablatal__](https://wiki.xxiivv.com/#tablatal)
+
+## Examples
+
+```ruby
+> input = <<~TBTL
+  NAME    AGE   COLOR
+  Erica   12    Opal
+  Alex    23    Cyan
+  Nike    34    Red
+  Ruca    45    Grey
+  TBTL
+
+> Nodaire::Tablatal.parse(input)
+# [
+#   { name: 'Erica', age: '12', color: 'Opal' },
+#   { name: 'Alex',  age: '23', color: 'Cyan' },
+#   { name: 'Nike',  age: '34', color: 'Red' },
+#   { name: 'Ruca',  age: '45', color: 'Grey' },
+# ]
+
+> Nodaire::Tablatal.parse(input, preserve_keys: true)
+# [
+#   { 'NAME' => 'Erica', 'AGE' => '12', 'COLOR' => 'Opal' },
+#   { 'NAME' => 'Alex',  'AGE' => '23', 'COLOR' => 'Cyan' },
+#   { 'NAME' => 'Nike',  'AGE' => '34', 'COLOR' => 'Red' },
+#   { 'NAME' => 'Ruca',  'AGE' => '45', 'COLOR' => 'Grey' },
+# ]
+
+> Nodaire::Tablatal.to_csv(input, preserve_keys: true)
+# NAME,AGE,COLOR
+# Erica,12,Opal
+# Alex,23,Cyan
+# Nike,34,Red
+# Ruca,45,Grey
+```
+
+## Testing
+
+```
+bundle install --with test
+bundle exec rspec
+```

data/lib/nodaire.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+##
+# Nodaire is a collection of text file parsers.
+#
+module Nodaire
+end
+
+require_relative 'nodaire/formats'
+
+require_relative 'nodaire/errors'
+require_relative 'nodaire/version'

data/lib/nodaire/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nodaire
+  class ParserError < StandardError; end
+end

data/lib/nodaire/formats.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'formats/tablatal'

data/lib/nodaire/formats/tablatal.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../parsers/tablatal_parser'
+
+##
+# Interface for the Tablatal file format.
+#
+# Tablatal is (c) Devine Lu Linvega (MIT License).
+#
+class Nodaire::Tablatal
+  ##
+  # Parse a string in Tablatal format and return an array of hashes.
+  #
+  def self.parse(string, preserve_keys: false)
+    Parser.new(string, preserve_keys: preserve_keys).rows
+  end
+
+  ##
+  # Parse a string in Tablatal format and return a string in CSV format.
+  #
+  def self.to_csv(string, preserve_keys: false)
+    Parser.new(string, preserve_keys: preserve_keys).to_csv
+  end
+end

data/lib/nodaire/parsers/tablatal_parser.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+require_relative '../errors'
+
+class Nodaire::Tablatal
+  class ParserError < Nodaire::ParserError; end
+
+  ##
+  # Parser for the Tablatal file format.
+  #
+  # Tablatal is (c) Devine Lu Linvega (MIT License).
+  #
+  class Parser
+    attr_reader :rows
+
+    def initialize(string, preserve_keys: false)
+      lines = (string || '').strip.split("\n")
+                            .reject { |line| line.match(/^\s*(;.*)?$/) }
+      return if lines.empty?
+
+      @keys = make_keys(lines.shift.scan(/(\S+\s*)/).flatten, preserve_keys)
+      @rows = lines.map { |line| make_line(line) }.compact
+    end
+
+    def to_csv
+      key_symbols = keys
+      CSV.generate do |csv|
+        csv << key_symbols
+        rows.each do |row|
+          csv << key_symbols.map { |key| row[key] }
+        end
+      end
+    end
+
+    def keys
+      @keys.map(&:name) if @keys
+    end
+
+    private
+
+    Key = Struct.new(:name, :range, keyword_init: true)
+
+    def make_keys(segs, preserve_keys)
+      [].tap do |keys|
+        segs.each_with_index do |seg, idx|
+          key = seg.strip
+          key = key.downcase.to_sym unless preserve_keys
+          raise ParserError, 'Duplicate keys' if keys.any? { |k| key == k.name }
+
+          len = seg.size if idx < segs.size - 1
+          start = keys.empty? ? 0 : keys.last.range.last
+          keys.push Key.new(name: key, range: start...(len && start + len))
+        end
+      end
+    end
+
+    def make_line(line)
+      @keys.map { |key| [key.name, (line[key.range] || '').strip] }.to_h
+    end
+  end
+end

data/lib/nodaire/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Nodaire
+  module Version
+    STRING = '0.1.0'
+    DATE = '2019-08-15'
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: nodaire
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Liam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-15 00:00:00.000000000 Z
+dependencies: []
+description: Nodaire is a collection of text file parsers.
+email: nodaire@liamcooke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/nodaire.rb
+- lib/nodaire/errors.rb
+- lib/nodaire/formats.rb
+- lib/nodaire/formats/tablatal.rb
+- lib/nodaire/parsers/tablatal_parser.rb
+- lib/nodaire/version.rb
+homepage: https://github.com/ljcooke/nodaire
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ljcooke/nodaire/issues
+  changelog_uri: https://github.com/ljcooke/nodaire/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/ljcooke/nodaire
+  homepage_uri: https://github.com/ljcooke/nodaire
+  source_code_uri: https://github.com/ljcooke/nodaire
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Text file parsers.
+test_files: []