myway_config 0.1.1

data/lib/myway_config/loaders/xdg_config_loader.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'anyway_config'
+require 'yaml'
+
+module MywayConfig
+  module Loaders
+    # XDG Base Directory Specification loader for Anyway Config
+    #
+    # Loads configuration from XDG-compliant paths:
+    # 1. $XDG_CONFIG_HOME/{app}/{app}.yml (if XDG_CONFIG_HOME is set)
+    # 2. ~/.config/{app}/{app}.yml (XDG default fallback)
+    #
+    # On macOS, also checks:
+    # 3. ~/Library/Application Support/{app}/{app}.yml
+    #
+    # This loader runs BEFORE the project-local config loader,
+    # so project configs take precedence over user-global configs.
+    #
+    # @example XDG config file location
+    #   ~/.config/myapp/myapp.yml
+    #
+    # @example Custom XDG_CONFIG_HOME
+    #   export XDG_CONFIG_HOME=/my/config
+    #   # Looks for /my/config/myapp/myapp.yml
+    #
+    class XdgConfigLoader < Anyway::Loaders::Base
+      class << self
+        # Returns all XDG config paths to check for a given app name
+        #
+        # @param name [String] the application name
+        # @return [Array<String>] list of potential config directory paths
+        def config_paths(name)
+          paths = []
+
+          # macOS Application Support (lowest priority for XDG loader)
+          if macos?
+            macos_path = File.expand_path("~/Library/Application Support/#{name}")
+            paths << macos_path if Dir.exist?(File.dirname(macos_path))
+          end
+
+          # XDG default: ~/.config/{name}
+          xdg_default = File.expand_path("~/.config/#{name}")
+          paths << xdg_default
+
+          # XDG_CONFIG_HOME override (highest priority for XDG loader)
+          if ENV['XDG_CONFIG_HOME'] && !ENV['XDG_CONFIG_HOME'].empty?
+            xdg_home = File.join(ENV['XDG_CONFIG_HOME'], name.to_s)
+            paths << xdg_home unless xdg_home == xdg_default
+          end
+
+          paths
+        end
+
+        # Find the first existing config file for the given app name
+        #
+        # @param name [String] config name (e.g., 'myapp')
+        # @return [String, nil] path to config file or nil if not found
+        def find_config_file(name)
+          config_paths(name).reverse_each do |dir|
+            file = File.join(dir, "#{name}.yml")
+            return file if File.exist?(file)
+          end
+          nil
+        end
+
+        private
+
+        def macos?
+          RUBY_PLATFORM.include?('darwin')
+        end
+      end
+
+      def call(name:, **_options)
+        config_file = self.class.find_config_file(name)
+        return {} unless config_file
+
+        trace!(:xdg, path: config_file) do
+          load_yaml(config_file, name)
+        end
+      end
+
+      private
+
+      def load_yaml(path, name)
+        return {} unless File.exist?(path)
+
+        content = File.read(path)
+        parsed = YAML.safe_load(
+          content,
+          permitted_classes: [Symbol],
+          symbolize_names: true,
+          aliases: true
+        ) || {}
+
+        env = current_environment
+
+        # Check for environment key first, fall back to root level
+        if parsed.key?(env.to_sym)
+          parsed[env.to_sym] || {}
+        elsif parsed.key?(env.to_s)
+          parsed[env.to_s] || {}
+        else
+          # No environment key, treat as flat config
+          parsed
+        end
+      rescue Psych::SyntaxError => e
+        warn "MywayConfig: Failed to parse XDG config #{path}: #{e.message}"
+        {}
+      end
+
+      def current_environment
+        Anyway::Settings.current_environment ||
+          ENV['RAILS_ENV'] ||
+          ENV['RACK_ENV'] ||
+          'development'
+      end
+    end
+  end
+end

data/lib/myway_config/version.rb

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

data/lib/myway_config.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'anyway_config'
+
+require_relative 'myway_config/version'
+require_relative 'myway_config/config_section'
+require_relative 'myway_config/loaders/defaults_loader'
+require_relative 'myway_config/loaders/xdg_config_loader'
+require_relative 'myway_config/base'
+
+module MywayConfig
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class ValidationError < Error; end
+
+  class << self
+    # Register the XDG and defaults loaders with Anyway Config
+    #
+    # Call this method after requiring myway_config to enable
+    # XDG config file loading and bundled defaults.
+    #
+    # The loader order determines priority (lowest to highest):
+    # 1. Bundled defaults (DefaultsLoader)
+    # 2. XDG user config (XdgConfigLoader)
+    # 3. Project config (:yml loader - Anyway default)
+    # 4. Environment variables (:env loader - Anyway default)
+    #
+    def setup!
+      return if @setup_complete
+
+      # Insert loaders before :yml so they have lower priority
+      # Bundled defaults first (lowest priority)
+      unless loader_registered?(:bundled_defaults)
+        Anyway.loaders.insert_before :yml, :bundled_defaults, Loaders::DefaultsLoader
+      end
+
+      # XDG config second (higher priority than bundled defaults)
+      unless loader_registered?(:xdg)
+        Anyway.loaders.insert_before :yml, :xdg, Loaders::XdgConfigLoader
+      end
+
+      @setup_complete = true
+    end
+
+    # Check if setup has been completed
+    #
+    # @return [Boolean]
+    def setup?
+      @setup_complete || false
+    end
+
+    # Reset setup state (mainly for testing)
+    def reset!
+      @setup_complete = false
+    end
+
+    private
+
+    def loader_registered?(name)
+      Anyway.loaders.registry.any? { |entry| entry.first == name }
+    end
+  end
+end
+
+# Auto-setup when the gem is loaded
+MywayConfig.setup!

data/mkdocs.yml

@@ -0,0 +1,148 @@
+# MkDocs Configuration for MywayConfig Documentation
+site_name: MywayConfig
+site_description: Configuration management for Ruby applications with XDG support and auto-configuration from YAML
+site_author: Dewayne VanHoozer
+site_url: https://madbomber.github.io/myway_config
+copyright: Copyright © 2025 Dewayne VanHoozer
+
+# Repository information
+repo_name: madbomber/myway_config
+repo_url: https://github.com/madbomber/myway_config
+edit_uri: edit/main/docs/
+
+# Configuration
+theme:
+  name: material
+
+  # Color scheme
+  palette:
+    - scheme: default
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    - scheme: slate
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  # Typography
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+  # Logo and icon
+  icon:
+    repo: fontawesome/brands/github
+    logo: material/cog
+
+  # Theme features
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.path
+    - navigation.indexes
+    - navigation.top
+    - navigation.footer
+    - toc.follow
+    - search.suggest
+    - search.highlight
+    - search.share
+    - content.code.copy
+    - content.code.annotate
+    - content.tabs.link
+    - content.tooltips
+
+# Plugins
+plugins:
+  - search:
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+
+# Extensions
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - tables
+  - toc:
+      permalink: true
+      title: On this page
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: madbomber
+      repo: myway_config
+      normalize_issue_symbols: true
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+# Social media and extra configuration
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/madbomber/myway_config
+      name: MywayConfig on GitHub
+    - icon: fontawesome/solid/gem
+      link: https://rubygems.org/gems/myway_config
+      name: MywayConfig on RubyGems
+
+# Navigation
+nav:
+  - Home: index.md
+  - Getting Started:
+      - getting-started/index.md
+      - Installation: getting-started/installation.md
+      - Quick Start: getting-started/quick-start.md
+  - Guides:
+      - guides/index.md
+      - Defining Configuration: guides/defining-configuration.md
+      - YAML Structure: guides/yaml-structure.md
+      - Accessing Values: guides/accessing-values.md
+      - Environment Overrides: guides/environment-overrides.md
+      - Custom File Loading: guides/custom-file-loading.md
+      - Hash-like Behavior: guides/hash-like-behavior.md
+  - API Reference:
+      - api/index.md
+      - MywayConfig::Base: api/base.md
+      - ConfigSection: api/config-section.md
+      - Loaders: api/loaders.md
+  - Examples:
+      - examples/index.md
+      - Basic Usage: examples/basic-usage.md
+      - Rails Integration: examples/rails-integration.md
+      - Standalone App: examples/standalone-app.md
+  - Development:
+      - development/index.md
+      - Contributing: development/contributing.md
+      - Testing: development/testing.md

data/sig/myway_config.rbs

@@ -0,0 +1,4 @@
+module MywayConfig
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: myway_config
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dewayne VanHoozer
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: MywayConfig extends anyway_config with XDG config file loading, bundled
+  defaults, and auto-configuration from YAML. Define your config structure once in
+  YAML and access values using method syntax, bracket notation, or Hash-like enumeration.
+email:
+- dewayne@vanhoozer.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- CHANGELOG.md
+- COMMITS.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/api/base.md
+- docs/api/config-section.md
+- docs/api/index.md
+- docs/api/loaders.md
+- docs/development/contributing.md
+- docs/development/index.md
+- docs/development/testing.md
+- docs/examples/basic-usage.md
+- docs/examples/index.md
+- docs/examples/rails-integration.md
+- docs/examples/standalone-app.md
+- docs/getting-started/index.md
+- docs/getting-started/installation.md
+- docs/getting-started/quick-start.md
+- docs/guides/accessing-values.md
+- docs/guides/custom-file-loading.md
+- docs/guides/defining-configuration.md
+- docs/guides/environment-overrides.md
+- docs/guides/hash-like-behavior.md
+- docs/guides/index.md
+- docs/guides/yaml-structure.md
+- docs/index.md
+- lib/myway_config.rb
+- lib/myway_config/base.rb
+- lib/myway_config/config_section.rb
+- lib/myway_config/loaders/defaults_loader.rb
+- lib/myway_config/loaders/xdg_config_loader.rb
+- lib/myway_config/version.rb
+- mkdocs.yml
+- sig/myway_config.rbs
+homepage: https://github.com/madbomber/myway_config
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/madbomber/myway_config
+  source_code_uri: https://github.com/madbomber/myway_config
+  changelog_uri: https://github.com/madbomber/myway_config/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Configuration management extending anyway_config with XDG support and auto-configuration
+test_files: []