sleeping_king_studios-docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4efbec5418a43dab48ee3f399e9461fd64f17f1b31931d384f6bd5b3de0407cb
+  data.tar.gz: a609dd607d8b1c9a71495e09c0f01e70bac9d92ad91a29817f5abbfb1baefeb8
+SHA512:
+  metadata.gz: b2c4d06f1f2ff5cf128cee30e748a5255d99699f80a3e69054f54d544d1389aa045752b38be64b0c002e6b71e3fb654e77856293eb66d2297565e65315b2aba3
+  data.tar.gz: d01dd772621dbaac3c8261089ea997ad471edabd9f7b2a65d01467cd062415dae4a15a1b04f4198baa7c6bd117dd1852d2342bef2297c35befb75a03e9c7ca56

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+# 0.1.0
+
+Initial development release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+merlin@sleepingkingstudios.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2022 Rob Smith
+
+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,101 @@
+# SleepingKingStudios::Docs
+
+Tools for generating a versioned documentation site from YARD docs.
+
+<blockquote>
+  Read The
+  <a href="https://www.sleepingkingstudios.com/sleeping_king_studios-docs" target="_blank">
+    Documentation
+  </a>
+</blockquote>
+
+## About
+
+### Compatibility
+
+SleepingKingStudios::Yard is tested against Ruby (MRI) 3.1 through 3.4.
+
+### Documentation
+
+Documentation is generated using [YARD](https://yardoc.org/), and can be generated locally using the `yard` gem. Online documentation for current and previous versions is available at [sleepingkingstudios.com](https://www.sleepingkingstudios.com/sleeping_king_studios-docs).
+
+### License
+
+Copyright (c) 2022-2025 Rob Smith
+
+SleepingKingStudios::Docs is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+### Contribute
+
+The canonical repository for this gem is located at https://github.com/sleepingkingstudios/sleeping_king_studios-docs.
+
+To report a bug or submit a feature request, please use the [Issue Tracker](https://github.com/sleepingkingstudios/sleeping_king_studios-docs/issues).
+
+To contribute code, please fork the repository, make the desired updates, and then provide a [Pull Request](https://github.com/sleepingkingstudios/sleeping_king_studios-docs/pulls). Pull requests must include appropriate tests for consideration, and all code must be properly formatted.
+
+### Code of Conduct
+
+Please note that the `SleepingKingStudios::Docs` project is released with a [Contributor Code of Conduct](https://github.com/sleepingkingstudios/sleeping_king_studios-docs/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
+
+## Installation
+
+Add the docs dependencies to your Gemfile:
+
+```ruby
+group :docs do
+  gem 'jekyll'
+  gem 'sleeping_king_studios-docs'
+  gem 'webrick'
+  gem 'yard',  require: false
+end
+```
+
+You may also want to consider adding a [Jekyll theme](https://jekyllrb.com/docs/themes/#pick-up-a-theme) and/or a Markdown parser (Kramdown is recommended).
+
+Generate or update your `tasks.thor` file:
+
+```ruby
+# frozen_string_literal: true
+
+load 'sleeping_king_studios/docs/tasks.rb'
+```
+
+### Installation Script
+
+Use the installation script to quickly install the Jekyll application:
+
+```bash
+bundle exec thor docs:install --name="Orichalcum" --description="A real gem." --repository="www.example.com"
+```
+
+You can also install a GitHub pages workflow to automatically deploy to GitHub Pages. Make sure that Pages is configured for your repository to deploy from a GitHub action.
+
+```bash
+bundle exec thor docs:install:workflow
+```
+
+## Generating Documentation
+
+Use the [Thor CLI](https://www.sleepingkingstudios.com/sleeping_king_studios-docs/tasks#documentation) to generate and update the reference documentation for your project.
+
+The `docs:generate` task will generate the documentation files for each Ruby file in your project. It does not update any existing files by default, so if you have made changes to existing code use the `docs:update` command or use the `--force` command line option.
+
+```bash
+bundle exec thor docs:generate
+```
+
+The `docs:update` task will generate and updates th documentation files for each Ruby file in your project. It will update any existing documentation files.
+
+```bash
+bundle exec thor docs:update
+```
+
+### Versioned Documentation
+
+You can pass a `--version` flag to the `docs:generate` or `docs:update` tasks, indicating that the generated documentation is for a specific version of the software. This is recommended for each major and minor release; patch-level changes may or may not need to be documented depending on the degree of change.
+
+```bash
+bundle exec thor docs:generate --version="1.2.3"
+```
+
+Any non-reference documentation should be copied into the newly created version scope. Make sure to update the `versions/index.md` file to link the new scope.

data/lib/sleeping_king_studios/docs/commands/generate.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+require 'cuprum/command'
+require 'sleeping_king_studios/tools/toolbelt'
+
+require 'sleeping_king_studios/docs/commands'
+
+module SleepingKingStudios::Docs::Commands
+  # Generates YARD documentation files.
+  class Generate < SleepingKingStudios::Docs::Commands::Generators::Base # rubocop:disable Metrics/ClassLength
+    # @overload initialize(docs_path:, **options)
+    #   @param docs_path [String] the directory path for generating the
+    #     documentation files.
+    #   @param options [Hash] the configured options for the generator.
+    #
+    #   @option options dry_run [Boolean] if true, does not make any changes to
+    #     the filesystem.
+    #   @option options force [Boolean] if true, overwrites any existing files.
+    #   @option options version [String] the code version for the generated
+    #     documentation.
+    #   @option options verbose [Boolean] if true, prints status messages to
+    #     STDOUT.
+    def initialize(
+      docs_path:,
+      error_stream:  $stderr,
+      output_stream: $stdout,
+      **options
+    )
+      super(docs_path:, **options)
+
+      @error_stream  = error_stream
+      @output_stream = output_stream
+    end
+
+    private
+
+    attr_reader :failures
+
+    def build_constant(native:)
+      SleepingKingStudios::Docs::Data::ConstantObject.new(native:)
+    end
+
+    def build_class(native:)
+      SleepingKingStudios::Docs::Data::ClassObject.new(native:)
+    end
+
+    def build_method(native:)
+      SleepingKingStudios::Docs::Data::MethodObject.new(native:)
+    end
+
+    def build_module(native:)
+      SleepingKingStudios::Docs::Data::ModuleObject.new(native:)
+    end
+
+    def build_root_namespace(native:)
+      SleepingKingStudios::Docs::Data::RootObject.new(native:)
+    end
+
+    def data_command
+      @data_command ||=
+        SleepingKingStudios::Docs::Commands::Generators::DataGenerator
+        .new(docs_path:, **options)
+    end
+
+    def generate_classes
+      puts "\nGenerating Classes:" if verbose? && !registry_classes.empty?
+
+      registry_classes.each do |native|
+        data_object = build_class(native:)
+
+        puts "- #{data_object.name}" if verbose?
+
+        generate_data_file(data_object:)
+        generate_reference_file(data_object:)
+      end
+    end
+
+    def generate_constants
+      puts "\nGenerating Constants:" if verbose? && !registry_constants.empty?
+
+      registry_constants.each do |native|
+        data_object = build_constant(native:)
+
+        puts "- #{data_object.name}" if verbose?
+
+        generate_data_file(data_object:)
+      end
+    end
+
+    def generate_data_file(data_object:, **options)
+      report_result(
+        command:     data_command,
+        data_object:,
+        result:      data_command.call(data_object:, **options),
+        **options
+      )
+    end
+
+    def generate_methods
+      puts "\nGenerating Methods:" if verbose? && !registry_methods.empty?
+
+      registry_methods.each do |native|
+        data_object = build_method(native:)
+
+        puts "- #{data_object.name}" if verbose?
+
+        generate_data_file(data_object:)
+      end
+    end
+
+    def generate_modules
+      puts "\nGenerating Modules:" if verbose? && !registry_modules.empty?
+
+      registry_modules.each do |native|
+        data_object = build_module(native:)
+
+        puts "- #{data_object.name}" if verbose?
+
+        generate_data_file(data_object:)
+        generate_reference_file(data_object:)
+      end
+    end
+
+    def generate_reference_file(data_object:, **options)
+      report_result(
+        command:     reference_command,
+        data_object:,
+        result:      reference_command.call(
+          data_object:,
+          **options
+        ),
+        **options
+      )
+    end
+
+    def generate_root_namespace
+      puts 'Generating Root Namespace:' if verbose?
+
+      data_object = build_root_namespace(native: registry_root)
+
+      puts '- root namespace' if verbose?
+
+      generate_data_file(data_object:, data_type: :namespace)
+    end
+
+    def parse_registry(file_path:)
+      SleepingKingStudios::Docs::Commands::Parse.new.call(file_path)
+    end
+
+    def process(file_path: nil)
+      step { parse_registry(file_path:) }
+
+      @failures = []
+
+      generate_root_namespace
+      generate_classes
+      generate_constants
+      generate_methods
+      generate_modules
+
+      report_all_failures
+
+      nil
+    end
+
+    def puts(string)
+      output_stream.puts(string)
+    end
+
+    def reference_command
+      @reference_command ||=
+        SleepingKingStudios::Docs::Commands::Generators::ReferenceGenerator
+        .new(docs_path:, **options)
+    end
+
+    def registry
+      SleepingKingStudios::Docs::Registry.instance
+    end
+
+    def registry_classes
+      registry
+        .select { |obj| obj.type == :class }
+        .reject { |obj| obj.tags.any? { |tag| tag.tag_name == 'private' } }
+        .sort_by(&:path)
+    end
+
+    def registry_constants
+      registry
+        .select { |obj| obj.type == :constant && obj.visibility == :public }
+        .reject { |obj| obj.tags.any? { |tag| tag.tag_name == 'private' } }
+        .sort_by(&:path)
+    end
+
+    def registry_methods
+      registry
+        .select { |obj| obj.type == :method && obj.visibility == :public }
+        .reject { |obj| obj.tags.any? { |tag| tag.tag_name == 'private' } }
+        .reject(&:is_alias?)
+        .sort_by(&:path)
+    end
+
+    def registry_modules
+      registry
+        .select { |obj| obj.type == :module }
+        .reject { |obj| obj.tags.any? { |tag| tag.tag_name == 'private' } }
+        .sort_by(&:path)
+    end
+
+    def registry_root
+      registry
+        .find { |obj| obj.type == :root }
+    end
+
+    def report_all_failures
+      return if failures.empty?
+      return unless verbose?
+
+      warn "\nFailures:"
+
+      failures.each do |failure|
+        report_failure(**failure, nested: true)
+      end
+    end
+
+    def report_failure(file_path:, result:, nested: false)
+      message = nested ? '  - ' : ''
+      message +=
+        "FAILURE: unable to write file to #{file_path} - " \
+        "#{result.error.class}: #{result.error.message}"
+
+      warn message
+    end
+
+    def report_result(command:, data_object:, result:, data_type: nil) # rubocop:disable Metrics/MethodLength
+      data_type ||= data_object_type(data_object:)
+      file_path   = command.file_path(
+        data_object:,
+        data_type:
+      )
+
+      if result.success?
+        report_success(file_path:)
+      else
+        failures << { file_path:, result: }
+
+        report_failure(file_path:, result:, nested: verbose?)
+      end
+
+      result
+    end
+
+    def report_success(file_path:)
+      return unless verbose?
+
+      message = "  - SUCCESS: file written to #{file_path}"
+
+      puts message
+    end
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+
+    def warn(string)
+      error_stream.puts(string)
+    end
+  end
+end

data/lib/sleeping_king_studios/docs/commands/generators/base.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'cuprum/command'
+require 'cuprum/exception_handling'
+require 'sleeping_king_studios/tools/toolbelt'
+
+require 'sleeping_king_studios/docs/commands/generators'
+
+module SleepingKingStudios::Docs::Commands::Generators
+  # Abstract base class for writing generator classes.
+  class Base < Cuprum::Command
+    include Cuprum::ExceptionHandling
+
+    # @param docs_path [String] the directory path for generating the
+    #   documentation files.
+    # @param options [Hash] the configured options for the generator.
+    #
+    # @option options dry_run [Boolean] if true, does not make any changes to
+    #   the filesystem.
+    # @option options force [Boolean] if true, overwrites any existing files.
+    # @option options version [String] the code version for the generated
+    #   documentation.
+    # @option options verbose [Boolean] if true, prints status messages to
+    #   STDOUT.
+    def initialize(docs_path:, **options)
+      super()
+
+      @docs_path = docs_path
+      @options   = default_options.merge(options)
+    end
+
+    # @return [String] the directory path for generating the documentation
+    #   files.
+    attr_reader :docs_path
+
+    # @return [Hash] the configured options for the generator.
+    attr_reader :options
+
+    # @return [Boolean] if true, does not make any changes to the filesystem.
+    def dry_run?
+      @options[:dry_run]
+    end
+
+    # @return [Boolean] if true, overwrites any existing files.
+    def force?
+      @options[:force]
+    end
+
+    # @return [String] the relative path to the Jekyll templates for each data
+    #   type.
+    def template_path
+      @options.fetch(:template_path, 'reference')
+    end
+
+    # @return [Boolean] if true, prints status messages to STDOUT.
+    def verbose?
+      @options[:verbose]
+    end
+
+    # @return [String] the code version for the generated documentation.
+    def version
+      @options[:version]
+    end
+
+    private
+
+    attr_reader :error_stream
+
+    attr_reader :output_stream
+
+    def data_object_type(data_object:)
+      data_object
+        .class
+        .name
+        .split('::')
+        .last
+        .then { |str| str[0...-6] }
+        .then { |str| tools.string_tools.underscore(str) }
+    end
+
+    def default_options
+      {
+        dry_run: false,
+        force:   false,
+        verbose: false
+      }
+    end
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+
+    def version_string
+      version || '*'
+    end
+  end
+end

data/lib/sleeping_king_studios/docs/commands/generators/data_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require 'sleeping_king_studios/tools/toolbelt'
+
+require 'sleeping_king_studios/docs/commands/generators'
+
+module SleepingKingStudios::Docs::Commands::Generators
+  # Generator for writing data files.
+  class DataGenerator < SleepingKingStudios::Docs::Commands::Generators::Base
+    # Determines the generated file path for the given data object.
+    #
+    # @param data_object [SleepingKingStudios::Docs::Data::Base] the data object
+    #   for which the file is generated.
+    # @param data_type [String, Symbol] the type of data file to generate.
+    #
+    # @return [String] the qualified path to the generated file.
+    def file_path(data_object:, data_type: nil)
+      data_type ||= data_object_type(data_object:)
+
+      File.join(dir_path(data_type), "#{data_object.data_path}.yml")
+    end
+
+    private
+
+    def dir_path(data_type)
+      scope = "_#{tools.string_tools.pluralize(data_type.to_s)}"
+
+      if version
+        File.join(docs_path, scope, "version--#{version}")
+      else
+        File.join(docs_path, scope)
+      end
+    end
+
+    def file_data(data_object:)
+      data_object
+        .as_json
+        .merge('version' => version_string)
+    end
+
+    def process(data_object:, data_type: nil)
+      data        = file_data(data_object:)
+      data_type ||= data_object_type(data_object:)
+
+      return success(nil) if dry_run?
+
+      write_command.call(
+        contents:  YAML.dump(data),
+        file_path: file_path(
+          data_object:,
+          data_type:
+        )
+      )
+    end
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+
+    def write_command
+      @write_command ||=
+        SleepingKingStudios::Docs::Commands::WriteFile
+        .new(force: force?)
+    end
+  end
+end