gloo-yaml 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1657fd9808c1094ce1bacf4e032a696b517bc857af07eabda0a387064afbdd31
+  data.tar.gz: db60fc7cff408eabc5acc9f31165b1e3a3a1104faf4a32df0b3372f204be4f25
+SHA512:
+  metadata.gz: 2d5a8be48fed57b74c6a073e961b1481e2cd50bb89a6dfbe6105e301d08fa1fadf77c977963e6d93043eea286ed6f7ff06c68ffe5163cf8b64551f4f03c58900
+  data.tar.gz: dc61a19b20c2d39212546c6a931a8ca532302e223efef90bab12838d459b75a091343f2bef1b04aa8ab01cd539dce25b1efcfdbfdc4ec851d514d66101671c28

data/README.md

@@ -0,0 +1,19 @@
+# gloo-yaml
+
+A core gloo library for YAML file operations.
+
+## Usage
+
+Load this library in a gloo script:
+
+```gloo
+> load lib yaml
+```
+
+## Objects
+
+- `yaml` (shortcut `yml`) — a YAML file object, holding a path to a YAML file and its parsed data
+
+## Full Reference
+
+The object's children and messages are documented in-app once the library is loaded — `help> object yaml`.

data/lib/gloo-yaml.rb

@@ -0,0 +1,18 @@
+#
+# Shim to allow `require 'gloo-yaml'`
+#
+require 'yaml_obj'
+
+#
+# Registers the extension.
+#
+class YamlInit < Gloo::Plugin::Base
+
+  #
+  # Register verbs and objects.
+  #
+  def register( callback )
+    callback.register_obj( YamlObj )
+  end
+
+end

data/lib/yaml_obj.rb

@@ -0,0 +1,156 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2026 Eric Crane.  All rights reserved.
+#
+# A YAML file object. Holds a path to a YAML file and supports
+# loading and saving named fields via a container object.
+#
+require 'yaml'
+
+class YamlObj < Gloo::Core::Obj
+
+  KEYWORD       = 'yaml'.freeze
+  KEYWORD_SHORT = 'yml'.freeze
+
+  #
+  # The name of the object type.
+  #
+  def self.typename
+    return KEYWORD
+  end
+
+  #
+  # The short name of the object type.
+  #
+  def self.short_typename
+    return KEYWORD_SHORT
+  end
+
+  #
+  # Set the value with any necessary type conversions.
+  #
+  def set_value( new_value )
+    self.value = new_value.to_s
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Messages
+  # ---------------------------------------------------------------------
+
+  #
+  # Get a list of message names that this object receives.
+  #
+  def self.messages
+    return super + %w[load save]
+  end
+
+  #
+  # Load fields from the YAML file into a container.
+  # The param is a path to a container object whose children
+  # are matched by name to YAML keys.
+  #
+  def msg_load
+    return unless @params&.token_count&.positive?
+
+    container = resolve_container
+    return unless container
+
+    data = read_yaml_file
+    return unless data
+
+    container.children.each do |child|
+      key = child.name
+      child.set_value data[ key ].to_s if data.key?( key )
+    end
+  end
+
+  #
+  # Save fields from a container into the YAML file.
+  # The param is a path to a container object whose children
+  # are matched by name to YAML keys.
+  #
+  def msg_save
+    return unless @params&.token_count&.positive?
+
+    container = resolve_container
+    return unless container
+
+    data = read_yaml_file || {}
+
+    container.children.each do |child|
+      data[ child.name ] = child.value
+    end
+
+    write_yaml_file data
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Helpers
+  # ---------------------------------------------------------------------
+
+  private
+
+  #
+  # Resolve the container object from the first param.
+  #
+  def resolve_container
+    pn = Gloo::Core::Pn.new( @engine, @params.first )
+    pn.resolve
+  end
+
+  #
+  # Read and parse the YAML file. Returns a hash, or nil on error.
+  #
+  def read_yaml_file
+    path = File.expand_path( self.value )
+    unless File.exist?( path )
+      @engine.log.error "YAML file not found: #{path}"
+      return nil
+    end
+    YAML.load_file( path ) || {}
+  end
+
+  #
+  # Serialize data hash and write it back to the YAML file.
+  #
+  def write_yaml_file( data )
+    path = File.expand_path( self.value )
+    File.write( path, data.to_yaml )
+  end
+
+  # ---------------------------------------------------------------------
+  #    Object Documentation
+  # ---------------------------------------------------------------------
+
+  #
+  # Get the object's documentation data.
+  #
+  def self.doc_data
+    {
+      :name => KEYWORD,
+      :shortcut => KEYWORD_SHORT,
+      :description => 'A YAML file object. Holds a path to a YAML ' \
+        'file (as its own value) and supports loading and saving ' \
+        'named fields via a container object.',
+      :messages => [
+        'load ({container.path}) — Load fields from the YAML file into the given container. Children of the container are matched by name to YAML keys. A parameter is required.',
+        'save ({container.path}) — Save fields from the given container into the YAML file, matching container children by name to YAML keys. A parameter is required.'
+      ],
+      :notes => 'No vault documentation exists for this object type — ' \
+        'this was authored directly from the code.',
+      :examples => <<~EXAMPLES.strip
+        settings [can] :
+          path [yaml] : ~/.my_app/settings.yml
+          data [can] :
+            name [string] :
+            theme [string] :
+          on_load [script] :
+            tell path to load (data)
+            put 'dark' into data.theme
+            tell path to save (data)
+      EXAMPLES
+    }
+  end
+
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: gloo-yaml
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Eric Crane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-08 00:00:00.000000000 Z
+dependencies: []
+description: Adds YAML file read/write support to Gloo.
+email:
+- eric.crane@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/gloo-yaml.rb
+- lib/yaml_obj.rb
+homepage: https://github.com/ecrane/gloo
+licenses:
+- MIT
+metadata:
+  gloo.type: core-library
+  documentation_uri: https://github.com/ecrane/gloo
+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.5.16
+signing_key:
+specification_version: 4
+summary: Gloo core library. YAML file support.
+test_files: []