yard-yaml 0.1.0 → 0.1.1

data/certs/pboling.pem

@@ -0,0 +1,27 @@
+-----BEGIN CERTIFICATE-----
+MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
+ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
+DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
+uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
+LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
+mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
+coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
+FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
+yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
+to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
+qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
+fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
+HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
+ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
+wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
+L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
+GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
+kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
+QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
+0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
+DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
+L9nRqA==
+-----END CERTIFICATE-----

data/lib/yard/yaml/converter.rb

@@ -12,10 +12,15 @@ module Yard
     #
     # Note: We intentionally keep the contract minimal and stable. Tests stub the backend.
     class Converter
+      BACKEND_STATE = {backend: nil}
+      BACKEND_MUTEX = Mutex.new
+
       class << self
         # Assignable backend for dependency injection in tests.
         # Expected to respond to `convert(yaml, options)` and return a Hash with :html, :title, :description, and :meta keys
-        attr_writer :backend
+        def backend=(backend)
+          BACKEND_MUTEX.synchronize { BACKEND_STATE[:backend] = backend }
+        end
 
         # Convert a YAML string into an HTML result.
         #
@@ -34,37 +39,70 @@ module Yard
         # @param config [Yard::Yaml::Config]
         # @return [Hash]
         def from_file(path, options = {}, config: Yard::Yaml.config)
-          content = read_file(path)
+          content = read_file(path, config: config)
           return empty_result if content.nil?
           run_convert(content, options.merge(source_path: path.to_s), config)
         end
 
         # Backend accessor with auto-discovery.
         def backend
-          return @backend if defined?(@backend) && @backend
+          configured_backend = BACKEND_MUTEX.synchronize { BACKEND_STATE[:backend] }
+          return configured_backend if configured_backend
+
           begin
             require "yaml/converter"
           rescue LoadError
             # ignore; backend may be set by tests
           end
-          @backend = if defined?(::Yaml) && ::Yaml.const_defined?(:Converter)
-            ::Yaml::Converter
+
+          BACKEND_MUTEX.synchronize do
+            BACKEND_STATE[:backend] ||= ::Yaml::Converter if defined?(::Yaml) && ::Yaml.const_defined?(:Converter)
           end
         end
 
         private
 
-        def read_file(path)
-          File.read(path.to_s)
+        def read_file(path, config: Yard::Yaml.config)
+          raw = File.binread(path.to_s)
+          if binary_content?(raw)
+            handle_error(Yard::Yaml::Error.new("binary file not supported"), strict: config.strict, context: path.to_s)
+            return
+          end
+
+          content = raw.dup.force_encoding(Encoding::UTF_8)
+          return content if content.valid_encoding?
+
+          if config.strict
+            handle_error(Yard::Yaml::Error.new("invalid UTF-8 bytes in file"), strict: true, context: path.to_s)
+            return
+          end
+
+          handle_error(
+            Yard::Yaml::Error.new("invalid UTF-8 bytes in file; replaced invalid sequences"),
+            strict: false,
+            context: path.to_s,
+          )
+          content.scrub
         rescue Errno::ENOENT => e
-          handle_error(e, strict: Yard::Yaml.config.strict, context: "missing file: #{path}")
+          handle_error(e, strict: config.strict, context: "missing file: #{path}")
           nil
         end
 
+        def binary_content?(raw)
+          sample = raw.byteslice(0, 4096) || "".b
+          return true if sample.include?("\x00")
+          return false if sample.empty?
+
+          control_bytes = sample.bytes.count do |byte|
+            (0..8).cover?(byte) || byte == 11 || byte == 12 || (14..31).cover?(byte)
+          end
+          control_bytes.fdiv(sample.bytesize) > 0.1
+        end
+
         def run_convert(yaml, options, config)
           opts = build_options(options, config)
           b = backend
-          unless b && b.respond_to?(:convert)
+          unless b&.respond_to?(:convert)
             handle_error(Yard::Yaml::Error.new("yaml-converter backend not available"), strict: config.strict, context: "backend")
             return empty_result
           end

data/lib/yard/yaml/plugin.rb

@@ -4,7 +4,8 @@ module Yard
   module Yaml
     # Plugin activation for yard-yaml (Phase 3: config + discovery; still no YARD registrations).
     module Plugin
-      @activated = false
+      STATE = {activated: false}
+      STATE_MUTEX = Mutex.new
 
       class << self
         # Whether the plugin has been activated for the current process.
@@ -12,7 +13,7 @@ module Yard
         #
         # @return [Boolean]
         def activated?
-          @activated
+          STATE[:activated]
         end
 
         # Activate the plugin.
@@ -44,14 +45,14 @@ module Yard
             # Non-strict errors are already warned by converter/discovery
           end
 
-          @activated = true
+          STATE_MUTEX.synchronize { STATE[:activated] = true }
           nil
         end
 
         # Test-helper: reset internal activation flag.
         # Not part of public API; used from test teardown to avoid state leakage.
         def __reset_state__
-          @activated = false
+          STATE_MUTEX.synchronize { STATE[:activated] = false }
           nil
         end
       end

data/lib/yard/yaml/tag_renderer.rb

@@ -19,7 +19,7 @@ module Yard
       # @param config [Yard::Yaml::Config]
       # @return [String] HTML fragment (may be empty string)
       def render_for(object, base_dir: Dir.pwd, config: Yard::Yaml.config)
-        return "" unless object && object.respond_to?(:tags)
+        return "" unless object&.respond_to?(:tags)
 
         parts = []
 

data/lib/yard/yaml/tags.rb

@@ -24,14 +24,10 @@ module Yard
             end
           else
             # Create a minimal shim that records define_tag calls
+            calls = []
             lib = Module.new
-            class << lib
-              attr_accessor :calls
-              def define_tag(*args)
-                self.calls ||= []
-                self.calls << args
-              end
-            end
+            lib.define_singleton_method(:calls) { calls }
+            lib.define_singleton_method(:define_tag) { |*args| calls << args }
             begin
               ::YARD::Tags.const_set(:Library, lib)
             rescue StandardError

data/lib/yard/yaml/version.rb

@@ -3,8 +3,8 @@
 module Yard
   module Yaml
     module Version
-      VERSION = "0.1.0"
+      VERSION = "0.1.1"
     end
-    VERSION = Version::VERSION # Support the traditional VERSION constant.
+    VERSION = Version::VERSION # Traditional Constant Location
   end
 end

data/lib/yard/yaml.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
+require "version_gem"
 require_relative "yaml/version"
+
+Yard::Yaml::Version.class_eval do
+  extend VersionGem::Basic
+end
 require_relative "yaml/config"
 require_relative "yaml/cli"
 require_relative "yaml/plugin"
@@ -17,8 +22,11 @@ module Yard
     # Generic error for yard-yaml
     class Error < StandardError; end
 
-    @config = nil
-    @pages = nil
+    STATE = {
+      config: nil,
+      pages: nil,
+    }
+    STATE_MUTEX = Mutex.new
 
     class << self
       # Access the global configuration for yard-yaml.
@@ -28,19 +36,21 @@ module Yard
       #
       # @return [Yard::Yaml::Config]
       def config
-        @config ||= Config.new
+        STATE[:config] || STATE_MUTEX.synchronize { STATE[:config] ||= Config.new }
       end
 
       # Access collected pages (Phase 3). Nil until plugin activation performs discovery.
       # Each page is a Hash with keys: :path, :html, :title, :description, :meta
       # @return [Array<Hash>, nil]
-      attr_reader :pages
+      def pages
+        STATE[:pages]
+      end
 
       # Internal: set collected pages (used by Plugin during activation)
       def __set_pages__(list)
-        @pages = Array(list)
-        mirror_pages_to_registry(@pages)
-        @pages
+        pages = STATE_MUTEX.synchronize { STATE[:pages] = Array(list) }
+        mirror_pages_to_registry(pages)
+        pages
       end
 
       # Configure the plugin programmatically.
@@ -80,8 +90,10 @@ module Yard
 
       # Test-helper: reset memoized config to defaults (not public API)
       def __reset_state__
-        @config = nil
-        @pages = nil
+        STATE_MUTEX.synchronize do
+          STATE[:config] = nil
+          STATE[:pages] = nil
+        end
         if defined?(::Yard::Yaml::Plugin) && ::Yard::Yaml::Plugin.respond_to?(:__reset_state__)
           ::Yard::Yaml::Plugin.__reset_state__
         end

data/sig/yard/yaml/version.rbs

@@ -0,0 +1,9 @@
+module Yard
+  module Yaml
+    module Version
+      VERSION: String
+    end
+    VERSION: String
+  end
+end
+

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: yard-yaml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Aboling0
+- Annibelle Boling
 - Peter H. Boling
 bindir: exe
 cert_chain:
@@ -39,67 +39,67 @@ cert_chain:
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yaml-converter
+  name: version_gem
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.9
 - !ruby/object:Gem::Dependency
-  name: version_gem
+  name: yaml-converter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: kettle-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -148,26 +151,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.6
 - !ruby/object:Gem::Dependency
   name: kettle-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -191,7 +197,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -201,7 +207,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: gitmoji-regex
   requirement: !ruby/object:Gem::Requirement
@@ -222,7 +228,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.3
-description: "\U0001F968 A YARD plugin for YAML documents"
+description: "\U0001F52E A YARD plugin for YAML documents"
 email:
 - floss@galtzo.com
 executables: []
@@ -233,9 +239,8 @@ extra_rdoc_files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - FUNDING.md
-- LICENSE.txt
+- LICENSE.md
 - README.md
-- REEK
 - RUBOCOP.md
 - SECURITY.md
 files:
@@ -244,11 +249,11 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - FUNDING.md
-- LICENSE.txt
+- LICENSE.md
 - README.md
-- REEK
 - RUBOCOP.md
 - SECURITY.md
+- certs/pboling.pem
 - lib/yard-yaml.rb
 - lib/yard/yaml.rb
 - lib/yard/yaml/cli.rb
@@ -263,15 +268,16 @@ files:
 - lib/yard/yaml/templates.rb
 - lib/yard/yaml/version.rb
 - sig/yard/yaml.rbs
+- sig/yard/yaml/version.rbs
 homepage: https://github.com/galtzo-floss/yard-yaml
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://yard-yaml.galtzo.com/
-  source_code_uri: https://github.com/galtzo-floss/yard-yaml/tree/v0.1.0
-  changelog_uri: https://github.com/galtzo-floss/yard-yaml/blob/v0.1.0/CHANGELOG.md
+  homepage_uri: https://structuredmerge.org
+  source_code_uri: https://github.com/galtzo-floss/yard-yaml/tree/v0.1.1
+  changelog_uri: https://github.com/galtzo-floss/yard-yaml/blob/v0.1.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/galtzo-floss/yard-yaml/issues
-  documentation_uri: https://www.rubydoc.info/gems/yard-yaml/0.1.0
+  documentation_uri: https://www.rubydoc.info/gems/yard-yaml/0.1.1
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/galtzo-floss/yard-yaml/wiki
   news_uri: https://www.railsbling.com/tags/yard-yaml
@@ -279,7 +285,7 @@ metadata:
   rubygems_mfa_required: 'true'
 rdoc_options:
 - "--title"
-- "yard-yaml - \U0001F968 A YARD plugin for YAML documents"
+- "yard-yaml - \U0001F52E A YARD plugin for YAML documents"
 - "--main"
 - README.md
 - "--exclude"
@@ -300,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.10
 specification_version: 4
-summary: "\U0001F968 A YARD plugin for YAML documents"
+summary: "\U0001F52E A YARD plugin for YAML documents"
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 Annibelle Boling
-
-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.