rpg-callouts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e4733dd33bfb3ad9281033115cca37191c55c30c582980e7bdf08970ddba054
+  data.tar.gz: d4ce7d22fa58b6a6b16132f3616f2fca068db2868a3fc5ad1a33a27ed6787c02
+SHA512:
+  metadata.gz: 667078f8795ae6b71a68663ef92bc403410b5f26fb37bf407cf1a844b88219c0faa3badffb0ffeace5e721327d94dcb22f568a996e78977a63f919c8d7c901ed
+  data.tar.gz: 2e49c8180b0b2f741d11e123013b877a0c6502a7a8616b09b870270b8e573cb46ca722c95e157099027ad2e5b7b5bb3cd878b604232860f411561dae52b721bf

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Directsun Games
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# rpg-callouts
+
+Stand-alone Jekyll plugin that merges Just the Docs callout definitions into the host site config.
+
+| Class | Title | Color |
+| --- | --- | --- |
+| `monster` | Monster | red |
+| `monster-no-title` | — | red |
+| `item` | Item | blue |
+
+Site `_config.yml` wins if you redefine the same callout names. Merge is in memory only — nothing is copied into the site source.
+
+## Install
+
+```ruby
+group :jekyll_plugins do
+  gem "rpg-callouts", path: "../rpg-callouts"
+end
+```
+
+```yaml
+# _config.yml
+plugins:
+  - rpg-callouts
+```
+
+## Usage
+
+```markdown
+{: .monster}
+> **Goblin**
+>
+> AC 6 [13], HD 1-1 (3hp), Att 1 × spear (1d6)
+
+{: .item}
+> **Silver Key**
+>
+> Opens the locked door in area 3.
+
+{: .monster-no-title}
+> Same red styling, no "Monster" heading.
+```
+
+## Options
+
+```yaml
+# _config.yml
+rpg_callouts:
+  enabled: true                 # set false to skip
+  config_file: callouts.yml     # optional alternate YAML (absolute or site-relative)
+```
+
+Default definitions live in `callouts/config.yml` inside this gem.

data/callouts/config.yml

@@ -0,0 +1,12 @@
+# Callout definitions for Just the Docs.
+# Merged into the host site config in memory (never copied into the site).
+# Keys already set in the site `_config.yml` win.
+callouts:
+  monster:
+    title: Monster
+    color: red
+  monster-no-title:
+    color: red
+  item:
+    title: Item
+    color: blue

data/lib/rpg-callouts.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "jekyll"
+
+require_relative "rpg_callouts/version"
+require_relative "rpg_callouts/merge"
+
+module RpgCallouts
+  module_function
+
+  def root
+    File.expand_path("..", __dir__)
+  end
+
+  def default_config_path
+    File.join(root, "callouts", "config.yml")
+  end
+
+  def apply!(site)
+    options = site.config["rpg_callouts"] || {}
+    return if options["enabled"] == false
+
+    path = options["config_file"] || default_config_path
+    fragment = load_fragment(path, site)
+    return if fragment.empty?
+
+    RpgCallouts::Merge.into_site!(site, fragment)
+    Jekyll.logger.info("rpg-callouts:", "merged callouts into site config")
+  end
+
+  def load_fragment(path, site)
+    resolved = resolve_config_path(path, site)
+    raise ArgumentError, "rpg-callouts config missing: #{resolved}" unless File.file?(resolved)
+
+    data = YAML.safe_load(
+      File.read(resolved),
+      permitted_classes: [Date, Time, Symbol],
+      aliases: true
+    )
+    raise ArgumentError, "rpg-callouts config must be a mapping: #{resolved}" unless data.is_a?(Hash)
+
+    data
+  end
+
+  def resolve_config_path(path, site)
+    return path if absolute_path?(path)
+    return default_config_path if path == default_config_path
+
+    candidates = [
+      File.expand_path(path, site.source),
+      File.expand_path(path, Dir.pwd),
+      File.expand_path(path, root)
+    ]
+    candidates.find { |candidate| File.file?(candidate) } || candidates.first
+  end
+
+  def absolute_path?(path)
+    path.start_with?(File::SEPARATOR) || path.match?(/\A[A-Za-z]:[\\\/]/)
+  end
+end
+
+Jekyll::Hooks.register :site, :after_reset do |site|
+  RpgCallouts.apply!(site)
+end

data/lib/rpg_callouts/merge.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RpgCallouts
+  # Deep-merges gem/config fragments into `site.config`.
+  # Later overlays win within the fragment; site `_config.yml` wins overall.
+  module Merge
+    module_function
+
+    def into_site!(site, fragment)
+      fragment.each do |key, value|
+        site.config[key] = deep_merge(value, site.config[key])
+      end
+    end
+
+    # Overlay wins on leaf conflicts. Hashes merge recursively.
+    def deep_merge(base, overlay)
+      return dup_value(base) if overlay.nil?
+      return dup_value(overlay) unless hash?(base) && hash?(overlay)
+
+      result = stringify_keys(base)
+      stringify_keys(overlay).each do |key, value|
+        result[key] = result.key?(key) ? deep_merge(result[key], value) : dup_value(value)
+      end
+      result
+    end
+
+    def hash?(value)
+      value.is_a?(Hash)
+    end
+
+    def stringify_keys(hash)
+      hash.each_with_object({}) do |(key, value), out|
+        out[key.to_s] = value
+      end
+    end
+
+    def dup_value(value)
+      case value
+      when Hash
+        value.each_with_object({}) { |(key, child), out| out[key.to_s] = dup_value(child) }
+      when Array
+        value.map { |child| dup_value(child) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/rpg_callouts/version.rb

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: rpg-callouts
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- directsun
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- callouts/config.yml
+- lib/rpg-callouts.rb
+- lib/rpg_callouts/merge.rb
+- lib/rpg_callouts/version.rb
+homepage: https://github.com/sunflowermans/rpg-callouts
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Just the Docs callouts for RPG adventures (monster, item).
+test_files: []