nodaire 0.1.0 → 0.2.0

checksums.yaml

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

data/README.md

@@ -2,15 +2,47 @@
 
 Ruby parsers for text file formats. Work in progress.
 
+[![Gem Version](https://badge.fury.io/rb/nodaire.svg)](https://rubygems.org/gems/nodaire)
+
 ## File formats
 
-- [Oscean](https://wiki.xxiivv.com/#oscean) by Devine Lu Linvega
+- [Oscean](https://wiki.xxiivv.com/#oscean) file formats by Devine Lu Linvega:
+  - [__Indental__](https://wiki.xxiivv.com/#indental) (.ndtl)
+  - [__Tablatal__](https://wiki.xxiivv.com/#tablatal) (.tbtl)
 
-  - [Indental](https://wiki.xxiivv.com/#indental) (planned)
+## Examples
 
-  - [__Tablatal__](https://wiki.xxiivv.com/#tablatal)
+### Indental
 
-## Examples
+```ruby
+> input = <<~NDTL
+  NAME
+    KEY : VALUE
+    LIST
+      ITEM1
+      ITEM2
+  NDTL
+
+> indental = Nodaire::Indental.parse(input)
+
+> indental.data
+# {
+#   name: {
+#     key: 'VALUE',
+#     list: ['ITEM1', 'ITEM2'],
+#   },
+# }
+
+> indental.valid?
+# true
+
+> indental = Nodaire::Indental.parse(input, preserve_keys: true)
+
+> indental.to_json
+# {"NAME":{"KEY":"VALUE","LIST":["ITEM1","ITEM2"]}}
+```
+
+### Tablatal
 
 ```ruby
 > input = <<~TBTL
@@ -21,7 +53,9 @@ Ruby parsers for text file formats. Work in progress.
   Ruca    45    Grey
   TBTL
 
-> Nodaire::Tablatal.parse(input)
+> tablatal = Nodaire::Tablatal.parse(input)
+
+> tablatal.data
 # [
 #   { name: 'Erica', age: '12', color: 'Opal' },
 #   { name: 'Alex',  age: '23', color: 'Cyan' },
@@ -29,15 +63,12 @@ Ruby parsers for text file formats. Work in progress.
 #   { 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' },
-# ]
+> tablatal.valid?
+# true
+
+> tablatal = Nodaire::Tablatal.parse(input, preserve_keys: true)
 
-> Nodaire::Tablatal.to_csv(input, preserve_keys: true)
+> tablatal.to_csv
 # NAME,AGE,COLOR
 # Erica,12,Opal
 # Alex,23,Cyan

data/lib/nodaire/formats.rb

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

data/lib/nodaire/formats/indental.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative '../parsers/indental_parser'
+
+##
+# Interface for the Indental file format.
+#
+# Indental is (c) Devine Lu Linvega (MIT License).
+#
+class Nodaire::Indental
+  attr_reader :data, :errors
+  alias_method :to_h, :data
+
+  ##
+  # Parse a string in Indental format.
+  #
+  # Ignores or attempts to work around errors.
+  #
+  def self.parse(string, preserve_keys: false)
+    parser = Parser.new(string, false, preserve_keys: preserve_keys)
+
+    new(parser)
+  end
+
+  ##
+  # Parse a string in Indental format.
+  #
+  # Raises an exception if there are errors.
+  #
+  def self.parse!(string, preserve_keys: false)
+    parser = Parser.new(string, true, preserve_keys: preserve_keys)
+
+    new(parser)
+  end
+
+  ##
+  # Returns whether the input was parsed without errors.
+  #
+  def valid?
+    @errors.empty?
+  end
+
+  ##
+  # Return a string in JSON format.
+  #
+  def to_json
+    JSON.generate(data)
+  end
+
+  private
+
+  def initialize(parser)
+    @data = parser.data
+    @errors = parser.errors
+  end
+end

data/lib/nodaire/formats/tablatal.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 require_relative '../parsers/tablatal_parser'
 
 ##
@@ -8,17 +10,55 @@ require_relative '../parsers/tablatal_parser'
 # Tablatal is (c) Devine Lu Linvega (MIT License).
 #
 class Nodaire::Tablatal
+  attr_reader :data, :keys, :errors
+  alias_method :to_a, :data
+
   ##
-  # Parse a string in Tablatal format and return an array of hashes.
+  # Parse a string in Tablatal format.
+  #
+  # Ignores or attempts to work around errors.
   #
   def self.parse(string, preserve_keys: false)
-    Parser.new(string, preserve_keys: preserve_keys).rows
+    parser = Parser.new(string, false, preserve_keys: preserve_keys)
+
+    new(parser)
   end
 
   ##
-  # Parse a string in Tablatal format and return a string in CSV format.
+  # Parse a string in Tablatal format.
+  #
+  # Raises an exception if there are errors.
   #
-  def self.to_csv(string, preserve_keys: false)
-    Parser.new(string, preserve_keys: preserve_keys).to_csv
+  def self.parse!(string, preserve_keys: false)
+    parser = Parser.new(string, true, preserve_keys: preserve_keys)
+
+    new(parser)
+  end
+
+  ##
+  # Returns whether the input was parsed without errors.
+  #
+  def valid?
+    @errors.empty?
+  end
+
+  ##
+  # Return a string in CSV format.
+  #
+  def to_csv
+    CSV.generate do |csv|
+      csv << keys
+      data.each do |row|
+        csv << keys.map { |key| row[key] }
+      end
+    end
+  end
+
+  private
+
+  def initialize(parser)
+    @data = parser.data
+    @keys = parser.keys
+    @errors = parser.errors
   end
 end

data/lib/nodaire/parsers/indental_parser.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+class Nodaire::Indental
+  class ParserError < Nodaire::ParserError; end
+
+  class Parser
+    attr_reader :data, :errors
+
+    def initialize(string, strict, options = {})
+      @strict = strict
+      @preserve_keys = options.fetch(:preserve_keys, false)
+
+      @data = {}
+      @errors = []
+
+      parse! string
+    end
+
+    private
+
+    def parse!(string)
+      (string || '')
+        .split("\n").each_with_index
+        .reject { |line, _| line.match(/^\s*(;.*)?$/) }
+        .each { |line, idx| parse_line! line, idx + 1 }
+    end
+
+    def parse_line!(line, num)
+      case line.match(/^\s*/)[0].size
+      when 0 then parse_category! line.strip, num
+      when 2 then parse_key_or_list! line.strip, num
+      when 4 then parse_list_item! line.strip, num
+      else oops! 'Unexpected indent', num
+      end
+    end
+
+    def parse_category!(cat, num)
+      cat = symbolize_key(cat)
+      if data.include?(cat)
+        @cat_id = nil
+        @list_id = nil
+        oops! 'Duplicate category', num
+      else
+        @data[cat] = {}
+        @cat_id = cat
+        @list_id = nil
+      end
+    end
+
+    def parse_key_or_list!(line, num)
+      return oops!('No category specified', num) unless @cat_id
+
+      if line.include?(' : ')
+        key, value = line.split(' : ', 2)
+        parse_key_value!(key.strip, value.strip, num)
+      else
+        parse_list!(line, num)
+      end
+    end
+
+    def parse_key_value!(key, value, num)
+      key = symbolize_key(key)
+      if @data[@cat_id].include?(key)
+        @list_id = nil
+        oops! 'Duplicate key', num
+      else
+        @data[@cat_id][key] = value.strip
+        @list_id = nil
+      end
+    end
+
+    def parse_list!(key, num)
+      key = symbolize_key(key)
+      if @data[@cat_id].include?(key)
+        @list_id = nil
+        oops! 'Duplicate key', num
+      else
+        @data[@cat_id][key] = []
+        @list_id = key
+      end
+    end
+
+    def parse_list_item!(item, num)
+      if @list_id.nil?
+        oops! 'No list specified', num
+      else
+        @data[@cat_id][@list_id] << item
+      end
+    end
+
+    def oops!(message, line_num)
+      message = "#{message} on line #{line_num}"
+      @errors << message
+      raise ParserError, message if @strict
+    end
+
+    def symbolize_key(key)
+      @preserve_keys ? key : key.downcase.split.join('_').to_sym
+    end
+  end
+end

data/lib/nodaire/parsers/tablatal_parser.rb

@@ -1,37 +1,20 @@
 # 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
+    attr_reader :data, :errors
 
-    def initialize(string, preserve_keys: false)
-      lines = (string || '').strip.split("\n")
-                            .reject { |line| line.match(/^\s*(;.*)?$/) }
-      return if lines.empty?
+    def initialize(string, strict, options = {})
+      @strict = strict
+      @preserve_keys = options.fetch(:preserve_keys, false)
 
-      @keys = make_keys(lines.shift.scan(/(\S+\s*)/).flatten, preserve_keys)
-      @rows = lines.map { |line| make_line(line) }.compact
-    end
+      @errors = []
 
-    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
+      parse! string
     end
 
     def keys
@@ -42,22 +25,45 @@ class Nodaire::Tablatal
 
     Key = Struct.new(:name, :range, keyword_init: true)
 
-    def make_keys(segs, preserve_keys)
+    def parse!(string)
+      lines = (string || '').strip.split("\n")
+                            .reject { |line| line.match(/^\s*(;.*)?$/) }
+      return if lines.empty?
+
+      @keys = make_keys(lines.shift.scan(/(\S+\s*)/).flatten)
+      @data = lines.map { |line, num| make_line(line, num) }.compact
+    end
+
+    def make_keys(segs)
       [].tap do |keys|
+        start = 0
         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 }
-
+          key = symbolize_key(seg.strip)
           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))
+
+          if keys.any? { |k| key == k.name }
+            oops! "Duplicate key #{key}", 1
+          else
+            keys << Key.new(name: key, range: start...(len && start + len))
+          end
+
+          start += len if len
         end
       end
     end
 
-    def make_line(line)
+    def make_line(line, num)
       @keys.map { |key| [key.name, (line[key.range] || '').strip] }.to_h
     end
+
+    def oops!(message, line_num)
+      message = "#{message} on line #{line_num}"
+      @errors << message
+      raise ParserError, message if @strict
+    end
+
+    def symbolize_key(key)
+      @preserve_keys ? key : key.downcase.to_sym
+    end
   end
 end

data/lib/nodaire/version.rb

@@ -2,7 +2,7 @@
 
 module Nodaire
   module Version
-    STRING = '0.1.0'
-    DATE = '2019-08-15'
+    STRING = '0.2.0'
+    DATE = '2019-08-17'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nodaire
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Liam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Nodaire is a collection of text file parsers.
 email: nodaire@liamcooke.com
@@ -21,7 +21,9 @@ files:
 - lib/nodaire.rb
 - lib/nodaire/errors.rb
 - lib/nodaire/formats.rb
+- lib/nodaire/formats/indental.rb
 - lib/nodaire/formats/tablatal.rb
+- lib/nodaire/parsers/indental_parser.rb
 - lib/nodaire/parsers/tablatal_parser.rb
 - lib/nodaire/version.rb
 homepage: https://github.com/ljcooke/nodaire