mork-parser 0.1.1

data/lib/mork/raw/id.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "mork/resolved/id"
+
+module Mork
+  class Raw; end # rubocop:disable Lint/EmptyClass
+
+  # A raw Mork ID
+  class Raw::Id
+    attr_reader :raw
+
+    ACTIONS = {
+      "-" => :delete,
+      nil => :add
+    }.freeze
+
+    def initialize(raw:)
+      @raw = raw
+    end
+
+    def resolve(dictionaries:)
+      namespace = resolve_namespace(dictionaries)
+      Resolved::Id.new(action: action, namespace: namespace, id: id)
+    end
+
+    private
+
+    def action
+      ACTIONS[parts[:action]]
+    end
+
+    def id
+      parts[:id]
+    end
+
+    def raw_namespace
+      parts[:raw_namespace]
+    end
+
+    def resolve_namespace(dictionaries)
+      case
+      when raw_namespace.nil?
+        nil
+      when raw_namespace.start_with?("^")
+        value = raw_namespace[1..]
+        dictionary = dictionaries.fetch("c")
+        dictionary.fetch(value)
+      else
+        raw_namespace
+      end
+    end
+
+    # rubocop:disable Lint/MixedRegexpCaptureTypes
+    # Rubocop gives a false positive here
+    RAW_ID_MATCH = /
+    \A
+    \{?                # The lexer captures the table delimiter
+    (?<action>-)?      # The optional action can indicate deletion
+    (?<id>[0-9]+)      # Tables are numbered
+    (
+      :
+      (?<raw_namespace>
+        \^?            # The raw namespace may be a reference
+        \S+            # The name is everything but trailing whitespace
+      )
+    )?                 # The namespace is optional
+    /x.freeze
+    # rubocop:enable Lint/MixedRegexpCaptureTypes
+
+    def parts
+      @parts ||= RAW_ID_MATCH.match(raw)
+    end
+  end
+end

data/lib/mork/raw/meta_alias.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mork
+  class Raw; end # rubocop:disable Lint/EmptyClass
+
+  # An alias indicating a Dictionary's scope
+  class Raw::MetaAlias
+    attr_reader :raw
+
+    def initialize(raw:)
+      @raw = raw
+    end
+
+    def scope
+      _from, to = raw.split("=")
+      to
+    end
+  end
+end

data/lib/mork/raw/meta_table.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mork
+  class Raw; end # rubocop:disable Lint/EmptyClass
+
+  # A meta table
+  class Raw::MetaTable
+    attr_reader :raw
+
+    def initialize(raw:)
+      @raw = raw
+    end
+  end
+end

data/lib/mork/raw/row.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "mork/raw/id"
+require "mork/resolved/row"
+
+module Mork
+  class Raw; end # rubocop:disable Lint/EmptyClass
+
+  # A row of cells
+  class Raw::Row
+    attr_reader :raw_id
+    attr_reader :cells
+
+    def initialize(raw_id:, cells:)
+      @raw_id = raw_id
+      @cells = cells
+    end
+
+    def resolve(dictionaries:)
+      resolved_id = raw_id_resolver.resolve(dictionaries: dictionaries)
+      Resolved::Row.new(
+        action: resolved_id.action,
+        namespace: resolved_id.namespace,
+        id: resolved_id.id,
+        cells: resolved_cells(dictionaries)
+      )
+    end
+
+    private
+
+    def raw_id_resolver
+      @raw_id_resolver ||= Raw::Id.new(raw: raw_id)
+    end
+
+    def resolved_cells(dictionaries)
+      cells.map { |c| c.resolve(dictionaries: dictionaries) }
+    end
+  end
+end

data/lib/mork/raw/table.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "mork/raw/id"
+require "mork/raw/row"
+require "mork/resolved/table"
+
+module Mork
+  class Raw; end # rubocop:disable Lint/EmptyClass
+
+  # A table of rows
+  class Raw::Table
+    attr_reader :raw_id
+    attr_reader :values
+
+    def initialize(raw_id:, values:)
+      @raw_id = raw_id
+      @values = values
+    end
+
+    def rows
+      values.filter { |c| c.is_a?(Raw::Row) }
+    end
+
+    def resolve(dictionaries:)
+      resolved_id = resolve_id(dictionaries)
+      Resolved::Table.new(
+        action: resolved_id.action, namespace: resolved_id.namespace, id: resolved_id.id,
+        rows: resolved_rows(dictionaries)
+      )
+    end
+
+    private
+
+    def raw_id_resolver
+      @raw_id_resolver ||= Raw::Id.new(raw: raw_id)
+    end
+
+    def resolve_id(dictionaries)
+      raw_id_resolver.resolve(dictionaries: dictionaries)
+    end
+
+    def resolved_rows(dictionaries)
+      rows.map { |r| r.resolve(dictionaries: dictionaries) }
+    end
+  end
+end

data/lib/mork/raw.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "mork/data"
+require "mork/raw/dictionary"
+require "mork/raw/group"
+
+module Mork
+  # Raw data returned by the Parser
+  class Raw
+    attr_reader :values
+
+    def initialize(values:)
+      @values = values
+    end
+
+    # build a Hash of scopes (usually "a" and "c")
+    # each value being a Hash of key-value entries
+    def dictionaries
+      @dictionaries ||=
+        raw_dictionaries.each.with_object({}) do |d, scopes|
+          scope = d.scope
+          scopes[scope] ||= {}
+          scopes[scope].merge!(d.to_h)
+        end
+    end
+
+    def data
+      Data.new(
+        rows: resolved_rows(dictionaries),
+        tables: resolved_tables(dictionaries)
+      )
+    end
+
+    private
+
+    def raw_dictionaries
+      @raw_dictionaries ||= top_level_dictionaries + group_dictionaries
+    end
+
+    def top_level_dictionaries
+      @top_level_dictionaries ||= values.filter { |v| v.is_a?(Raw::Dictionary) }
+    end
+
+    def group_dictionaries
+      @group_dictionaries ||= raw_groups.flat_map(&:dictionaries)
+    end
+
+    def raw_groups
+      @raw_groups ||= values.filter { |v| v.is_a?(Raw::Group) }
+    end
+
+    def resolved_groups(dictionaries)
+      raw_groups.
+        map { |g| g.resolve(dictionaries: dictionaries) }
+    end
+
+    ####################
+    # rows
+
+    def raw_rows
+      @raw_rows ||= values.filter { |v| v.is_a?(Raw::Row) }
+    end
+
+    def raw_tables
+      @raw_tables ||= values.filter { |v| v.is_a?(Raw::Table) }
+    end
+
+    def unmerged_rows(dictionaries)
+      top_level_rows = raw_rows.map { |r| r.resolve(dictionaries: dictionaries) }
+      group_rows =
+        resolved_groups(dictionaries).
+        map { |g| g[:rows] }.
+        flatten
+      (top_level_rows + group_rows).group_by(&:namespace)
+    end
+
+    def resolved_rows(dictionaries)
+      unmerged_rows(dictionaries).
+        each.with_object({}) do |(namespace, rows), acc|
+          merged = reduce_rows(rows)
+          acc[namespace] = merged if merged.any?
+        end
+    end
+
+    def reduce_rows(rows)
+      rows.each.with_object({}) do |row, acc|
+        case row.action
+        when :add
+          acc[row.id] = row.to_h
+        when :delete
+          acc.delete(row.id)
+        end
+      end
+    end
+
+    ####################
+    # tables
+
+    def resolved_tables(dictionaries)
+      unmerged = unmerged_tables(dictionaries)
+      merged = merge_tables(unmerged)
+      reduce_tables(merged)
+    end
+
+    def reduce_tables(tables)
+      tables.
+        each.with_object({}) do |(namespace, namespace_tables), acc1|
+          acc1[namespace] =
+            namespace_tables.each.with_object({}) do |(id, rows), acc2|
+              acc2[id] = reduce_rows(rows)
+            end
+        end
+    end
+
+    def merge_tables(tables)
+      tables.
+        each.with_object({}) do |(namespace, namespace_tables), acc|
+          merged = merge_namespace_tables(namespace_tables)
+          acc[namespace] = merged if merged.any?
+        end
+    end
+
+    def unmerged_tables(dictionaries)
+      top_level_tables = unmerged_resolved_tables(dictionaries)
+      group_tables =
+        resolved_groups(dictionaries).
+        map { |g| g[:tables] }.
+        flatten
+      (top_level_tables + group_tables).group_by(&:namespace)
+    end
+
+    def merge_namespace_tables(tables)
+      tables.each.with_object({}) do |table, acc|
+        case table.action
+        when :add
+          acc[table.id] ||= []
+          acc[table.id] += table.rows
+        when :delete
+          acc.delete(table.id)
+        end
+      end
+    end
+
+    def unmerged_resolved_tables(dictionaries)
+      raw_tables.map { |t| t.resolve(dictionaries: dictionaries) }
+    end
+  end
+end

data/lib/mork/resolved/cell.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mork
+  class Resolved; end # rubocop:disable Lint/EmptyClass
+
+  # A resolved Cell
+  class Resolved::Cell
+    attr_reader :key
+    attr_reader :value
+
+    def initialize(key:, value:)
+      @key = key
+      @value = value
+    end
+  end
+end

data/lib/mork/resolved/id.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mork
+  class Resolved; end # rubocop:disable Lint/EmptyClass
+
+  # A resolved Mork Id
+  class Resolved::Id
+    attr_reader :action
+    attr_reader :namespace
+    attr_reader :id
+
+    def initialize(action:, namespace:, id:)
+      @action = action
+      @namespace = namespace
+      @id = id
+    end
+  end
+end

data/lib/mork/resolved/row.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Mork
+  class Resolved; end # rubocop:disable Lint/EmptyClass
+
+  # A resolved Row
+  class Resolved::Row
+    attr_reader :action
+    attr_reader :namespace
+    attr_reader :id
+    attr_reader :cells
+
+    def initialize(action:, namespace:, id:, cells:)
+      @action = action
+      @namespace = namespace
+      @id = id
+      @cells = cells
+    end
+
+    def to_h
+      cells.
+        each.with_object({}) do |cell, acc|
+        acc[cell.key] = cell.value
+      end
+    end
+  end
+end

data/lib/mork/resolved/table.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mork
+  class Resolved; end # rubocop:disable Lint/EmptyClass
+
+  # A resolved Table
+  class Resolved::Table
+    attr_reader :action
+    attr_reader :namespace
+    attr_reader :id
+    attr_reader :rows
+
+    def initialize(action:, namespace:, id:, rows:)
+      @action = action
+      @namespace = namespace
+      @id = id
+      @rows = rows
+    end
+  end
+end

data/lib/mork.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mork
+  VERSION = "0.1.1"
+end

data/mork.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/mork"
+
+Gem::Specification.new do |spec|
+  spec.name = "mork-parser"
+  spec.version = Mork::VERSION
+  spec.authors = ["Joe Yates"]
+  spec.email = ["joe.g.yates@gmail.com"]
+
+  spec.summary = "Parse Mork databases (as used by Mozilla Thunderbird)"
+  spec.homepage = "https://github.com/joeyates/mork"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/main/CHANGELOG.md")
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.glob("lib/**/*.rb")
+  spec.files += ["mork.gemspec"]
+  spec.files += %w[LICENSE.txt README.md]
+  spec.bindir = "exe"
+  spec.executables = []
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: mork-parser
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/mork.rb
+- lib/mork/data.rb
+- lib/mork/lexer.rb
+- lib/mork/parser.rb
+- lib/mork/raw.rb
+- lib/mork/raw/alias.rb
+- lib/mork/raw/cell.rb
+- lib/mork/raw/dictionary.rb
+- lib/mork/raw/group.rb
+- lib/mork/raw/id.rb
+- lib/mork/raw/meta_alias.rb
+- lib/mork/raw/meta_table.rb
+- lib/mork/raw/row.rb
+- lib/mork/raw/table.rb
+- lib/mork/resolved/cell.rb
+- lib/mork/resolved/id.rb
+- lib/mork/resolved/row.rb
+- lib/mork/resolved/table.rb
+- mork.gemspec
+homepage: https://github.com/joeyates/mork
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joeyates/mork
+  source_code_uri: https://github.com/joeyates/mork
+  changelog_uri: https://github.com/joeyates/mork/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Parse Mork databases (as used by Mozilla Thunderbird)
+test_files: []