metapath 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4091eaf52c7e621333e586ec6e584b1a44e11a83aec5b4dee3d983435e14289b
+  data.tar.gz: c97f90285b9e7677e9842fd64ae3b9798fc47c87178e4cdb27d39e8e10a0eeea
+SHA512:
+  metadata.gz: 9c21bc7669bb48e4c338344c93390898412767470d6a7705db004b0bfb8598bd89690bb3ca3c20dabdcc712a0c9108a709b3350ebc2b5fabaae2287266b31029
+  data.tar.gz: f1bef6a89a2aa460088fc54589c0dcb3122c01614bd7e8a923ceab84b3583d48b327032808c9f7c8e9a18f771558b19b4898fec3382b1ebe312394bdc48a61d1

data/LICENSE.adoc

@@ -0,0 +1,134 @@
+= Hippocratic License
+
+Version: 2.1.0.
+
+Purpose. The purpose of this License is for the Licensor named above to
+permit the Licensee (as defined below) broad permission, if consistent
+with Human Rights Laws and Human Rights Principles (as each is defined
+below), to use and work with the Software (as defined below) within the
+full scope of Licensor’s copyright and patent rights, if any, in the
+Software, while ensuring attribution and protecting the Licensor from
+liability.
+
+Permission and Conditions. The Licensor grants permission by this
+license ("License"), free of charge, to the extent of Licensor’s
+rights under applicable copyright and patent law, to any person or
+entity (the "Licensee") obtaining a copy of this software and
+associated documentation files (the "Software"), to do everything with
+the Software that would otherwise infringe (i) the Licensor’s copyright
+in the Software or (ii) any patent claims to the Software that the
+Licensor can license or becomes able to license, subject to all of the
+following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and
+entity subject to its terms and conditions. Licensee accepts this
+License and agrees to its terms and conditions by taking any action with
+the Software that, absent this License, would infringe any intellectual
+property right held by Licensor.
+* Notice. Licensee must ensure that everyone who gets a copy of any part
+of this Software from Licensee, with or without changes, also receives
+the License and the above copyright notice (and if included by the
+Licensor, patent, trademark and attribution notice). Licensee must cause
+any modified versions of the Software to carry prominent notices stating
+that Licensee changed the Software. For clarity, although Licensee is
+free to create modifications of the Software and distribute only the
+modified portion created by Licensee with additional or different terms,
+the portion of the Software not modified must be distributed pursuant to
+this License. If anyone notifies Licensee in writing that Licensee has
+not complied with this Notice section, Licensee can keep this License by
+taking all practical steps to comply within 30 days after the notice. If
+Licensee does not do so, Licensee’s License (and all rights licensed
+hereunder) shall end immediately.
+* Compliance with Human Rights Principles and Human Rights Laws.
+[arabic]
+. Human Rights Principles.
+[loweralpha]
+.. Licensee is advised to consult the articles of the United Nations
+Universal Declaration of Human Rights and the United Nations Global
+Compact that define recognized principles of international human rights
+(the "Human Rights Principles"). Licensee shall use the Software in a
+manner consistent with Human Rights Principles.
+.. Unless the Licensor and Licensee agree otherwise, any dispute,
+controversy, or claim arising out of or relating to (i) Section 1(a)
+regarding Human Rights Principles, including the breach of Section 1(a),
+termination of this License for breach of the Human Rights Principles,
+or invalidity of Section 1(a) or (ii) a determination of whether any Law
+is consistent or in conflict with Human Rights Principles pursuant to
+Section 2, below, shall be settled by arbitration in accordance with the
+Hague Rules on Business and Human Rights Arbitration (the "Rules");
+provided, however, that Licensee may elect not to participate in such
+arbitration, in which event this License (and all rights licensed
+hereunder) shall end immediately. The number of arbitrators shall be one
+unless the Rules require otherwise.
++
+Unless both the Licensor and Licensee agree to the contrary: (1) All
+documents and information concerning the arbitration shall be public and
+may be disclosed by any party; (2) The repository referred to under
+Article 43 of the Rules shall make available to the public in a timely
+manner all documents concerning the arbitration which are communicated
+to it, including all submissions of the parties, all evidence admitted
+into the record of the proceedings, all transcripts or other recordings
+of hearings and all orders, decisions and awards of the arbitral
+tribunal, subject only to the arbitral tribunal’s powers to take such
+measures as may be necessary to safeguard the integrity of the arbitral
+process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3)
+Article 26(6) of the Rules shall not apply.
+. Human Rights Laws. The Software shall not be used by any person or
+entity for any systems, activities, or other uses that violate any Human
+Rights Laws. "Human Rights Laws" means any applicable laws,
+regulations, or rules (collectively, "Laws") that protect human,
+civil, labor, privacy, political, environmental, security, economic, due
+process, or similar rights; provided, however, that such Laws are
+consistent and not in conflict with Human Rights Principles (a dispute
+over the consistency or a conflict between Laws and Human Rights
+Principles shall be determined by arbitration as stated above). Where
+the Human Rights Laws of more than one jurisdiction are applicable or in
+conflict with respect to the use of the Software, the Human Rights Laws
+that are most protective of the individuals or groups harmed shall
+apply.
+. Indemnity. Licensee shall hold harmless and indemnify Licensor (and
+any other contributor) against all losses, damages, liabilities,
+deficiencies, claims, actions, judgments, settlements, interest, awards,
+penalties, fines, costs, or expenses of whatever kind, including
+Licensor’s reasonable attorneys’ fees, arising out of or relating to
+Licensee’s use of the Software in violation of Human Rights Laws or
+Human Rights Principles.
+* Failure to Comply. Any failure of Licensee to act according to the
+terms and conditions of this License is both a breach of the License and
+an infringement of the intellectual property rights of the Licensor
+(subject to exceptions under Laws, e.g., fair use). In the event of a
+breach or infringement, the terms and conditions of this License may be
+enforced by Licensor under the Laws of any jurisdiction to which
+Licensee is subject. Licensee also agrees that the Licensor may enforce
+the terms and conditions of this License against Licensee through
+specific performance (or similar remedy under Laws) to the extent
+permitted by Laws. For clarity, except in the event of a breach of this
+License, infringement, or as otherwise stated in this License, Licensor
+may not terminate this License with Licensee.
+* Enforceability and Interpretation. If any term or provision of this
+License is determined to be invalid, illegal, or unenforceable by a
+court of competent jurisdiction, then such invalidity, illegality, or
+unenforceability shall not affect any other term or provision of this
+License or invalidate or render unenforceable such term or provision in
+any other jurisdiction; provided, however, subject to a court
+modification pursuant to the immediately following sentence, if any term
+or provision of this License pertaining to Human Rights Laws or Human
+Rights Principles is deemed invalid, illegal, or unenforceable against
+Licensee by a court of competent jurisdiction, all rights in the
+Software granted to Licensee shall be deemed null and void as between
+Licensor and Licensee. Upon a determination that any term or provision
+is invalid, illegal, or unenforceable, to the extent permitted by Laws,
+the court may modify this License to affect the original purpose that
+the Software be used in compliance with Human Rights Principles and
+Human Rights Laws as closely as possible. The language in this License
+shall be interpreted as to its fair meaning and not strictly for or
+against any party.
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES
+"AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND
+ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR
+OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
+OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an link:https://ethicalsource.dev[Ethical Source license] and is offered
+for use by licensors and licensees at their own risk, on an "AS IS" basis, and with no warranties
+express or implied, to the maximum extent permitted by Laws.

data/README.adoc

@@ -0,0 +1,356 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+:data_link: link:https://alchemists.io/articles/ruby_data[Data]
+:dry_monads_link: link:https://dry-rb.org/gems/dry-monads[Dry Monads]
+:railway_pattern_link: link:https://alchemists.io/articles/railway_pattern[Railway Pattern]
+:rubysmith_link: link:https://alchemists.io/projects/rubysmith[Rubysmith]
+
+= Metapath
+
+Dynamically parses and enriches paths metadata so you can obtain information from directories and files with minimal effort. Having metadata for each directory and/or file -- no matter how nested your directory structure is -- allows you to perform additional processing on your file structure for analysis, transformation, import, and so much more.
+
+toc::[]
+
+== Features
+
+* Dynamically obtains metadata about a directory or a file.
+* Supports an optional, per directory, configuration.
+* Supports nested directory structures.
+* Answers an array of paths with associated metadata.
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby].
+
+== Setup
+
+To install _with_ security, run:
+
+[source,bash]
+----
+# 💡 Skip this line if you already have the public certificate installed.
+gem cert --add <(curl --compressed --location https://alchemists.io/gems.pem)
+gem install metapath --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
+
+[source,bash]
+----
+gem install metapath
+----
+
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add metapath
+----
+
+Once the gem is installed, you only need to require it:
+
+[source,ruby]
+----
+require "metapath"
+----
+
+== Usage
+
+Getting started is as quick as creating an instance and then pointing it at a directory structure:
+
+[source,ruby]
+----
+metapath = Metapath.new
+metapath.call Pathname.pwd
+
+Success(
+  [
+    #<data Metapath::Model:0x00002710
+      attributes = {},
+      errors = {},
+      label = "Crested Butte",
+      name = "crested_butte",
+      path = #<Pathname:/Users/demo/Scratch/photos/Crested_Butte.jpeg>,
+      position = 0,
+      tags = []
+    >,
+    #<data Metapath::Model:0x00002780
+      attributes = {},
+      errors = {},
+      label = "Flaming Gorge",
+      name = "flaming_gorge",
+      path = #<Pathname:/Users/demo/Scratch/photos/Flaming_Gorge.jpeg>,
+      position = 0,
+      tags = []
+    >,
+    #<data Metapath::Model:0x000027f0
+      attributes = {},
+      errors = {},
+      label = "Grand Canyon",
+      name = "grand_canyon",
+      path = #<Pathname:/Users/demo/Scratch/photos/Grand_Canyon.jpeg>,
+      position = 0,
+      tags = []
+    >
+  ]
+)
+----
+
+=== Roots
+
+When calling a metapath, you must always supply a root path for processing. In the earlier example, this was `Pathname.pwd` (current path):
+
+[source,ruby]
+----
+metapath.call Pathname.pwd
+----
+
+Strings, if supplied, will be automatically converted into pathnames and auto-expanding into absolute paths. Examples:
+
+[source,ruby]
+----
+metapath.call "~/photos"
+# Expands to: #<Pathname:/Users/<your user>/photos>
+
+metapath.call "photos"
+# Expands to: #<Pathname:<current working directory>/photos>
+
+metapath.call "/Users/demo/photos"
+# Identical: "#<Pathname:/Users/demo/photos>"
+----
+
+All directories and files will be processed within the root path supplied (no matter how deeply nested).
+
+=== Directories and Files
+
+Each directory and file can have it's own metadata using any of the following characters:
+
+* `0-9`: Any number is valid.
+* `a-z`: Any lowercase letter is valid. This includes Unicode.
+* `A-Z`: Any uppercase letter is valid. This includes Unicode.
+* `-` (hyphen): Translates to `" - "` when building the label. Example:
+** Before: `A-Demo`.
+** After: `A - Demo`.
+* `_` (underscore): Translates to `" "` when building the label. Example:
+** Before: `A_Demo`.
+** After: `A Demo`.
+* `+` (plus): Marks the start of tag or attribute information. See examples below for details.
+* `,` (comma): Specifies an array of tag or attribute metdata. See examples below for details.
+* `=` (equals): Delimits the key and value of an attribute. For example `kind=demo`, where `kind` is the key and `demo` is the value.
+* `%` (percent): Reserved for token replacement as commonly found in {rubysmith_link} for processing of templates where you want to dynamically replace each placeholder (example: `%demo%`) with a dynamic value that matches the `demo` key (in this example). Currently meant for post-processing.
+* `.` (dot): Reserved for file extensions or multiple formats. Example: `demo.html`, `demo.html.erb`, etc.
+* `~` (tilde): Reserved but currently not used.
+* `@` (at): Reserved but currently not used.
+* `^` (carrot): Reserved but currently not used.
+
+All of the characters shown above allow you to have files and directories that don't require special quoting which works well across multiple operating systems.
+
+==== Positions
+
+Prefix your directories or files with a number immediately followed by a dash to keep them organized but also for sequential processing order.
+
+* *Format*: `<position>-<name>`
+* *Example* `01-demo`
+
+The position is always `0` when none is given.
+
+==== Tags
+
+Use tags to provide additional metadata about your directories and files (use a comma to separate multiple values).
+
+* *Format* (single): `<name>+<tag>`
+* *Example* (single): `demo+blue`
+* *Format* (multiple): `<name>+<tag>,<tag>,<tag>`
+* *Example* (multiple): `demo+blue,red,green`
+
+💡 Use a directory configuration (`meta.yml`) to extract common metadata if your metadata gets too long and unwieldy.
+
+==== Attributes
+
+Use attributes to provide additional metadata about your directories and files (use a comma to separate multiple values).
+
+* *Format* (single): `<name>+<key>=<value>`
+* *Example* (single): `demo+album=panoramas`
+* *Format* (multiple): `<name>+<key>=<value>,<key>=<value>,<key>=<value>`
+* *Example* (multiple): `demo+album=panoramas,kind=landscapes,location=snow_peak`
+
+💡 Use a directory configuration (`meta.yml`) to extract common metadata if your metadata gets too long and unwieldy.
+
+=== Configurations
+
+You can configure common metadata per directory by placing a `meta.yml` in the root of any directory. The following is an example of what this file might contain:
+
+[source,yaml]
+----
+tags:
+  - demo
+  - photos
+attributes:
+  album: panoramas
+  kind: landscapes
+----
+
+With the above, you can supply as many tags and attributes as necessary which will then be inherited as common metadata when processing files within the directory. This includes inheriting  configurations from parent directories. Keep in mind that any file with it's own metdata will take precedence.
+
+Only the `tag` and `attributes` keys are honored, all other top level keys are ignored.
+
+=== Priority
+
+Metadata is resolved by merging each of the following in order listed (lowest to highest):
+
+3. Directory
+2. `meta.yml`
+1. File
+
+Resolution of the above happens by merging metadata from the lowest level into the next level until all levels are merged as one. This means you can set defaults at the lowest level which will be inherited, or overwritten, at the highest level. In pseudo code, it looks like this:
+
+[source,ruby]
+----
+directory.deep_merge(meta).deep_merge file
+----
+
+=== Monads
+
+Every time you call your metapath instance, you'll get either a `Success` or `Failure` as provided by {dry_monads_link}. This allows you to use the {railway_pattern_link} pattern to build fault tolerant functional pipelines for robust error processing.
+
+When results are a success, you'll get an array of models. Example:
+
+[source,ruby]
+----
+Success(
+  [
+    #<data Metapath::Model:0x00002710
+      attributes = {},
+      label = "Crested Butte",
+      name = "crested_butte",
+      path = #<Pathname:/Users/demo/Scratch/photos/Crested_Butte.jpeg>,
+      position = 0,
+      tags = []
+    >
+  ]
+)
+----
+
+You can get a success when errors are detected with metadata associated with your directories or files. For example, let's say your `meta.yml` has the following content:
+
+[source,]
+----
+attributes:
+----
+
+[source,ruby]
+----
+Success(
+  [
+    #<data Metapath::Model:0x00002710
+      attributes = {},
+      errors = {attributes: ["must be filled"]},
+      label = "Crested Butte",
+      name = "crested_butte",
+      path = #<Pathname:/Users/demo/Scratch/photos/Crested_Butte.jpeg>,
+      position = 0,
+      tags = []
+    >
+  ]
+)
+----
+
+If a failure does occur, this usually means errors with your configuration. For example, let's say your `meta.yml` has the following content:
+
+[source,yaml]
+----
+Danger!
+----
+
+This means you'll get the following result:
+
+[source,ruby]
+----
+Failure "Invalid content: Danger."
+----
+
+=== Models
+
+Each model is a {data_link} object. Additionally, the following methods are also provided for you:
+
+[source,ruby]
+----
+model = Metapath::Model[
+  name: "demo",
+  label: "Demo",
+  tags: %w[demo photos],
+  attributes: {
+    "album" => "panoramas",
+    "kind" => "landscapes"
+  }
+]
+
+model.fetch "album"                  # "panoramas"
+model.fetch "bogus", "fallback"      # "fallback"
+model.fetch("bogus") { "fallback" }  # "fallback"
+model.fetch "bogus"                  # KeyError
+
+model.key? "album"                   # true
+model.key? "bogus"                   # false
+
+model.tag? "photos"                  # true
+model.tag? "bogus"                   # false
+
+other = Metapath::Model[name: "other", path: Pathname("_demo.html")]
+
+other.partial?                       # true
+model.partial?                       # false
+
+other = Metapath::Model[name: "other", path: Pathname("demo.html"), errors: {message: "Danger!"}]
+
+other.errors?                       # true
+model.errors?                       # false
+----
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/metapath
+cd metapath
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bin/rake
+----
+
+== link:https://alchemists.io/policies/license[License]
+
+== link:https://alchemists.io/policies/security[Security]
+
+== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
+
+== link:https://alchemists.io/policies/contributions[Contributions]
+
+== link:https://alchemists.io/policies/developer_certificate_of_origin[Developer Certificate of Origin]
+
+== link:https://alchemists.io/projects/metapath/versions[Versions]
+
+== link:https://alchemists.io/community[Community]
+
+== Credits
+
+* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/metapath/enricher.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/hash"
+require "refinements/pathname"
+
+module Metapath
+  # Enriches paths with metadata.
+  class Enricher
+    include Dry::Monads[:result]
+
+    using Refinements::Hash
+    using Refinements::Pathname
+
+    def initialize parser: Parser.new, loader: Loader.new, meta_file: "meta.yml"
+      @parser = parser
+      @loader = loader
+      @meta_file = meta_file
+      @metadata = {}
+    end
+
+    def call root
+      metadata.clear
+      visit(Pathname(root).expand_path).fmap { it.sort_by! { it[:path] } }
+    end
+
+    private
+
+    attr_reader :parser, :loader, :meta_file, :metadata
+
+    def visit directory, collection: []
+      merge_metadata_for(directory).fmap do
+        directory.children.each.with_object collection do |path, enrichments|
+          next if path.fnmatch? "*#{meta_file}"
+
+          if path.directory?
+            visit path, collection: enrichments
+          else
+            enrichments.append enrich(path)
+          end
+        end
+      end
+    end
+
+    def merge_metadata_for directory
+      metadata.deep_merge! parser.call(directory.name)
+
+      configuration_path = directory.files(meta_file).first
+
+      return Success() unless configuration_path
+
+      loader.call(configuration_path).fmap { metadata.deep_merge! it }
+    end
+
+    def enrich path
+      parser.call(path.name).then do |data|
+        merged = metadata.deep_merge data.to_h
+        name = merged.delete(:name).downcase
+
+        {name:, path:, **merged}
+      end
+    end
+  end
+end

data/lib/metapath/loader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/hash"
+require "yaml"
+
+module Metapath
+  # Load directory metadata.
+  class Loader
+    include Dry::Monads[:result]
+
+    using Refinements::Hash
+
+    def initialize yaml: YAML
+      @yaml = yaml
+    end
+
+    def call path
+      load path
+    rescue Errno::ENOENT,
+           NoMethodError,
+           Psych::AliasesNotEnabled,
+           Psych::DisallowedClass,
+           Psych::SyntaxError => error
+
+      Failure error.message
+    end
+
+    private
+
+    attr_reader :yaml
+
+    def load path
+      yaml.safe_load_file(path).then do |content|
+        case content
+          in Hash then Success content.symbolize_keys
+          in String then Failure "Invalid content: #{content}."
+          else Success Hash.new
+        end
+      end
+    end
+  end
+end

data/lib/metapath/model.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metapath
+  # Stores path metadata.
+  Model = Data.define :name, :path, :label, :position, :tags, :attributes, :errors do
+    def initialize name:, path:, label: nil, position: 0, tags: [], attributes: {}, errors: {}
+      super
+    end
+
+    def fetch(key, *default, &) = attributes.fetch(key.to_s, *default, &)
+
+    def tag?(item) = tags.include? item
+
+    def key?(value) = attributes.key? value
+
+    def partial? = path.basename.fnmatch? "_*"
+
+    def errors? = !errors.empty?
+  end
+end

data/lib/metapath/modeler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Metapath
+  # Validates and models metadata.
+  class Modeler
+    include Dry::Monads[:result]
+
+    def initialize enricher: Enricher.new, schema: Schema, model: Model
+      @enricher = enricher
+      @schema = schema
+      @model = model
+    end
+
+    def call(root, **) = enricher.call(root, **).fmap { build_models it }
+
+    private
+
+    attr_reader :enricher, :schema, :model
+
+    def instance_variables_to_inspect = %i[@enricher @model]
+
+    def build_models(data) = data.map { build_model it }
+
+    def build_model data
+      case schema.call(data).to_monad
+        in Success(result)
+          model[**result.to_h]
+        in Failure(result)
+          model[**data.slice(:name, :label, :path), errors: result.errors.to_h]
+      end
+    end
+  end
+end

data/lib/metapath/parser.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "refinements/hash"
+
+module Metapath
+  # Parses path metadata.
+  class Parser
+    using Refinements::Hash
+
+    PATTERN = /
+      (?:                       # Start non-capture group.
+      (?<position>[0-9]+)       # Position capture group, numbers only.
+      -                         # Dash.
+      )?                        # End non-capture group and make it optional.
+      (?<name>[[:word:]-]+)     # Name capture group, required.
+      (?:                       # Non-capture group start.
+      \+                        # Plus.
+      (?<meta>[[:word:]\-,=]+)  # Meta capture group, required.
+      )?                        # End non-capture group and make it optional.
+    /x
+
+    SPACERS = {dash: ["-", " - "], underscore: ["_", " "]}.freeze
+    DELIMITERS = {array: ",", hash: "="}.freeze
+
+    def initialize pattern: PATTERN, spacers: SPACERS, delimiters: DELIMITERS
+      @pattern = pattern
+      @spacers = spacers
+      @delimiters = delimiters
+    end
+
+    def call path
+      captures = path.to_s.match(pattern).named_captures
+      meta = parse_metadata captures["meta"]
+      name = captures["name"]
+
+      {name:, label: parse_label(name), position: captures["position"], **meta}.compress
+    end
+
+    private
+
+    attr_reader :pattern, :spacers, :delimiters
+
+    def instance_variables_to_inspect = []
+
+    def parse_label(value) = value.gsub(*spacers.fetch(:dash)).tr(*spacers.fetch(:underscore))
+
+    def parse_metadata value
+      return {} unless value
+
+      value.split(delimiters.fetch(:array))
+           .each
+           .with_object({tags: [], attributes: {}}) { |item, all| add_metadata item, all }
+    end
+
+    def add_metadata item, bag
+      if item.include? hash_delimiter
+        key, value = item.split hash_delimiter
+        bag[:attributes][key] = value
+      else
+        bag[:tags].append item
+      end
+    end
+
+    def hash_delimiter
+      @hash_delimiter ||= delimiters.fetch :hash
+    end
+  end
+end

data/lib/metapath/schema.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+module Metapath
+  # Validates metadata information.
+  Schema = Dry::Schema.Params do
+    required(:name).filled :string
+    required(:label).filled :string
+    required(:path).filled
+    optional(:position).filled :integer
+    optional(:tags).filled(:array).each(:string)
+    optional(:attributes).filled :hash
+  end
+end

data/lib/metapath.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+require "zeitwerk"
+
+Dry::Schema.load_extensions :monads
+
+Zeitwerk::Loader.new.then do |loader|
+  loader.inflector.inflect "cli" => "CLI"
+  loader.tag = File.basename __FILE__, ".rb"
+  loader.push_dir __dir__
+  loader.setup
+end
+
+# Main namespace.
+module Metapath
+  def self.loader registry = Zeitwerk::Registry
+    @loader ||= registry.loaders.each.find do |loader|
+      loader.tag == File.basename(__FILE__, ".rb")
+    end
+  end
+
+  def self.new = Modeler.new
+end

data/metapath.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "metapath"
+  spec.version = "0.0.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/metapath"
+  spec.summary = "A parser of enriched file path metadata."
+  spec.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/metapath/issues",
+    "changelog_uri" => "https://alchemists.io/projects/metapath/versions",
+    "homepage_uri" => "https://alchemists.io/projects/metapath",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "Metapath",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/metapath"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = ">= 4.0"
+
+  spec.add_dependency "dry-monads", "~> 1.11"
+  spec.add_dependency "dry-schema", "~> 1.16"
+  spec.add_dependency "refinements", "~> 14.0"
+  spec.add_dependency "zeitwerk", "~> 2.8"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: metapath
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIENjCCAp6gAwIBAgIBAzANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
+  aW8wHhcNMjYwMzI1MTI0OTEyWhcNMjcwMzI1MTI0OTEyWjBBMQ8wDQYDVQQDDAZi
+  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
+  GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
+  f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
+  M+7QOQ4b1xNLTvY7FYQB1wGK5a4x7TTokDrPYQxDB2jmsdDYCzVbIMrAvUfcecRi
+  khyGZCdByiiCl4fKv77P12tTT+NfsvXkLt/AYCGwjOUyGKTQ01Z6eC09T27GayPH
+  QQvIkakyFgcJtzSyGzs8bzK5q9u7wQ12MNTjJoXzW69lqp0oNvDylu81EiSUb5S6
+  QzzPxZBiRB1sgtbt1gUbVI262ZDq1gR+HxPFmp+Cgt7ZLIJZAtesQvtcMzseXpfn
+  hpmm0Sw22KGhRAy/mqHBRhDl5HqS1SJp2Ko3lcnpXeFResp0HNlt8NSu13vhC08j
+  GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
+  Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaM5MDcw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
+  F5wykJEVMA0GCSqGSIb3DQEBCwUAA4IBgQAG+ykjp+DIXSybGEtX+/ve974mYfN6
+  8U7qcVfRM+qDSOZ+97iu30qUTbVAKIHlHCDKRn3SgOffDUB5VU2MsJBh/3TPKWBZ
+  anB/uzMcwOfru+qyA3b7ZFqZzRLWmR5FtPObFxc0gYMT3YvLNHk2Nb9Vjq/PoiGG
+  e75PXweDOokwDA5m1gMOz1rdp/dlGMXkSFQg94PPVyUKXgO4VzWTgePSDxOIL+v6
+  +OWV6AaEH9BaqxnmdA5ubi0L7bhl0gbN92FxpNO3kpTjww8kme856a+wCK3qyM5w
+  7ZLbUexynDN0Au8eSpT2Bf6ztGmB1S9ffzDJsGX1/lkpMIB51e48Xe2+gzzOgemk
+  CdZaGupj6WkarnT8kh/cPtyA5ax4rGX6GOS8meGxzkv8Uy0JSEOYAp6wLfIisYZp
+  IJBIXIOkwKKJ0eB5YHrUSJxzpP4LlcIg/eTftaXmJdYjy+2VRrCZYDjfguyLmMjR
+  KR9w4/Fjvqy87kCHmxMWa6IL2Vzt1Clm2cA=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+email:
+- brooke@alchemists.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.adoc
+- README.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- lib/metapath.rb
+- lib/metapath/enricher.rb
+- lib/metapath/loader.rb
+- lib/metapath/model.rb
+- lib/metapath/modeler.rb
+- lib/metapath/parser.rb
+- lib/metapath/schema.rb
+- metapath.gemspec
+homepage: https://alchemists.io/projects/metapath
+licenses:
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/metapath/issues
+  changelog_uri: https://alchemists.io/projects/metapath/versions
+  homepage_uri: https://alchemists.io/projects/metapath
+  funding_uri: https://github.com/sponsors/bkuhlmann
+  label: Metapath
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/metapath
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.22
+specification_version: 4
+summary: A parser of enriched file path metadata.
+test_files: []