sleeping_king_studios-docs 0.2.0 → 0.3.0

data/lib/sleeping_king_studios/docs/yard/build.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'cuprum'
+
+require 'sleeping_king_studios/docs/yard'
+
+module SleepingKingStudios::Docs::Yard
+  # Command for creating generic data objects from YARD objects.
+  class Build < Cuprum::Command
+    DATA_TYPES = {
+      YARD::CodeObjects::RootObject     =>
+        SleepingKingStudios::Docs::Data::RootObject,
+      YARD::CodeObjects::ClassObject    =>
+        SleepingKingStudios::Docs::Data::ClassObject,
+      YARD::CodeObjects::ConstantObject =>
+        SleepingKingStudios::Docs::Data::ConstantObject,
+      YARD::CodeObjects::MethodObject   =>
+        SleepingKingStudios::Docs::Data::MethodObject,
+      YARD::CodeObjects::ModuleObject   =>
+        SleepingKingStudios::Docs::Data::ModuleObject
+    }.freeze
+    private_constant :DATA_TYPES
+
+    private
+
+    def process(native)
+      matching = DATA_TYPES.each_key.find { |type| native.is_a?(type) }
+
+      return failure(unknown_type_error(native)) unless matching
+
+      DATA_TYPES[matching].new(native:)
+    end
+
+    def unknown_type_error(native)
+      message =
+        "unable to parse native object #{native.inspect} - no matching data" \
+        "type defined for #{native.class}"
+
+      SleepingKingStudios::Docs::Errors::RegistryError.new(message:)
+    end
+  end
+end

data/lib/sleeping_king_studios/docs/{commands → yard}/parse.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
+require 'cuprum/cli'
 require 'cuprum/command'
+require 'plumbum'
 require 'yard'
 
-require 'sleeping_king_studios/docs/commands'
+require 'sleeping_king_studios/docs/yard'
 
-module SleepingKingStudios::Docs::Commands
+module SleepingKingStudios::Docs::Yard
   # Adds the specified data to the YARD Registry.
   class Parse < Cuprum::Command
+    include Plumbum::Consumer
+    prepend Plumbum::Parameters
+
+    dependency :file_system
+
+    provider Cuprum::Cli::Dependencies.provider
+
     # @!method call
     #   @overload call
     #     Parses the working directory per YARD defaults.
@@ -29,21 +38,19 @@ module SleepingKingStudios::Docs::Commands
     end
 
     def process(path = nil)
-      if path.nil?
-        ::YARD.parse
+      if path
+        step { validate_file_path(path) }
 
-        return success(nil)
+        ::YARD.parse(path)
+      else
+        ::YARD.parse
       end
 
-      step { validate_file_path(path) }
-
-      ::YARD.parse(path)
-
-      success(nil)
+      SleepingKingStudios::Docs::Yard::Registry.build
     end
 
     def validate_file_path(path)
-      return if File.exist?(path)
+      return if file_system.directory?(path) || file_system.file?(path)
 
       failure(file_not_found_error(path))
     end

data/lib/sleeping_king_studios/docs/yard/registry.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'plumbum'
+require 'yard'
+
+require 'sleeping_king_studios/docs/yard'
+
+module SleepingKingStudios::Docs::Yard
+  Registry = ::Data.define(:items)
+
+  # Dependency injection provider wrapping the YARD registry.
+  #
+  # @!attribute [r] items
+  #   @return [Array<YARD::CodeObjects::Base>] the defined YARD objects.
+  class Registry < ::Data
+    include Enumerable
+
+    # @return [SleepingKingStudios::Docs::Yard::Registry] a new registry
+    #   instance wrapping the current YARD state.
+    def self.build
+      new(items: [::YARD::Registry.root, *::YARD::Registry.to_a])
+    end
+
+    # Provides an injectable instance of the repository wrapper.
+    #
+    # @return [Plumbum::Provider<SleepingKingStudios::Docs::Registry>] the
+    #   registry provider.
+    def self.provider
+      @provider ||= Plumbum::OneProvider.new(:registry, write_once: true)
+    end
+
+    # @param items [Array<YARD::CodeObjects::Base>] the defined YARD objects.
+    def initialize(items: [])
+      super
+    end
+
+    # @overload each
+    #   @return [Enumerator] an enumerator that iterates over the registry
+    #     items.
+    #
+    # @overload each(&block)
+    #   @yield [YARD::CodeObjects::Base] each item in the registry.
+    def each(&)
+      block_given? ? items.each(&) : enum_for(:each)
+    end
+
+    alias to_a items
+  end
+
+  class Registry
+    # An empty registry instance.
+    EMPTY = new
+  end
+end

data/lib/sleeping_king_studios/docs/{registry_query.rb → yard/registry_query.rb}

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
+require 'plumbum'
 require 'sleeping_king_studios/docs'
 
-module SleepingKingStudios::Docs
+module SleepingKingStudios::Docs::Yard
   # Checks for the presence of requested data in the YARD registry.
   class RegistryQuery
-    # @param registry [Enumerable] the YARD registry.
-    def initialize(registry:)
-      @registry = registry
-    end
+    include Plumbum::Consumer
+    prepend Plumbum::Parameters
+
+    dependency :registry,
+      default: SleepingKingStudios::Docs::Yard::Registry::EMPTY
+
+    provider SleepingKingStudios::Docs::Yard::Registry.provider
 
     # Checks if the given class method is defined in the registry.
     #
@@ -72,8 +76,6 @@ module SleepingKingStudios::Docs
 
     private
 
-    attr_reader :registry
-
     def legacy_class_method_exists?(method_name)
       method_name = method_name.reverse.sub('::', '.').reverse
 

data/lib/sleeping_king_studios/docs/yard.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/docs'
+
+module SleepingKingStudios::Docs
+  # Functionality for parsing and querying YARD documentation.
+  module Yard
+    autoload :Build,         'sleeping_king_studios/docs/yard/build'
+    autoload :Parse,         'sleeping_king_studios/docs/yard/parse'
+    autoload :Registry,      'sleeping_king_studios/docs/yard/registry'
+    autoload :RegistryQuery, 'sleeping_king_studios/docs/yard/registry_query'
+  end
+end

data/lib/sleeping_king_studios/docs.rb

@@ -1,27 +1,39 @@
 # frozen_string_literal: true
 
+require 'cuprum/cli'
+require 'sleeping_king_studios/tools'
+
 # Hic iacet Arthurus, rex quondam, rexque futurus.
 module SleepingKingStudios
   # Tooling for working with YARD documentation.
   module Docs
-    class << self
-      # @return [String] the absolute path to the gem directory.
-      def gem_path
-        pattern = /#{File.join('', 'lib', 'sleeping_king_studios', '')}?\z/
-
-        __dir__.sub(pattern, '')
-      end
-
-      # @return [String] The current version of the gem.
-      def version
-        VERSION
-      end
+    autoload :Data,   'sleeping_king_studios/docs/data'
+    autoload :Errors, 'sleeping_king_studios/docs/errors'
+    autoload :Jekyll, 'sleeping_king_studios/docs/jekyll'
+    autoload :Yard,   'sleeping_king_studios/docs/yard'
+
+    @initializer = SleepingKingStudios::Tools::Toolbox::Initializer.new do
+      Cuprum::Cli.initializer.call
+
+      SleepingKingStudios::Tools.initializer.call
     end
 
-    autoload :Commands,      'sleeping_king_studios/docs/commands'
-    autoload :Data,          'sleeping_king_studios/docs/data'
-    autoload :Errors,        'sleeping_king_studios/docs/errors'
-    autoload :Registry,      'sleeping_king_studios/docs/registry'
-    autoload :RegistryQuery, 'sleeping_king_studios/docs/registry_query'
+    # @return [String] the absolute path to the gem directory.
+    def self.gem_path
+      pattern = /#{File.join('', 'lib', 'sleeping_king_studios', '')}?\z/
+
+      __dir__.sub(pattern, '')
+    end
+
+    # @return [SleepingKingStudios::Tools::Toolbox::Initializer] the initializer
+    #   for the module.
+    def self.initializer
+      @initializer
+    end
+
+    # @return [String] The current version of the gem.
+    def self.version
+      VERSION
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-docs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
@@ -15,14 +15,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: cuprum-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -37,20 +57,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: plumbum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: sleeping_king_studios-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -107,18 +141,6 @@ files:
 - LICENSE
 - README.md
 - lib/sleeping_king_studios/docs.rb
-- lib/sleeping_king_studios/docs/commands.rb
-- lib/sleeping_king_studios/docs/commands/generate.rb
-- lib/sleeping_king_studios/docs/commands/generators.rb
-- lib/sleeping_king_studios/docs/commands/generators/base.rb
-- lib/sleeping_king_studios/docs/commands/generators/data_generator.rb
-- lib/sleeping_king_studios/docs/commands/generators/reference_generator.rb
-- lib/sleeping_king_studios/docs/commands/installation.rb
-- lib/sleeping_king_studios/docs/commands/installation/install_jekyll.rb
-- lib/sleeping_king_studios/docs/commands/installation/install_templates.rb
-- lib/sleeping_king_studios/docs/commands/installation/install_workflow.rb
-- lib/sleeping_king_studios/docs/commands/parse.rb
-- lib/sleeping_king_studios/docs/commands/write_file.rb
 - lib/sleeping_king_studios/docs/data.rb
 - lib/sleeping_king_studios/docs/data/base.rb
 - lib/sleeping_king_studios/docs/data/class_object.rb
@@ -151,77 +173,35 @@ files:
 - lib/sleeping_king_studios/docs/errors/file_not_found.rb
 - lib/sleeping_king_studios/docs/errors/invalid_directory.rb
 - lib/sleeping_king_studios/docs/errors/invalid_file.rb
+- lib/sleeping_king_studios/docs/errors/outdated_documentation.rb
+- lib/sleeping_king_studios/docs/errors/registry_error.rb
 - lib/sleeping_king_studios/docs/jekyll.rb
+- lib/sleeping_king_studios/docs/jekyll/commands.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/backfill_versions.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/check.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/clobber.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/document_version.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/generate.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/install.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/install_templates.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/install_workflow.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/reference.rb
+- lib/sleeping_king_studios/docs/jekyll/commands/update.rb
+- lib/sleeping_king_studios/docs/jekyll/generators.rb
+- lib/sleeping_king_studios/docs/jekyll/generators/data_generator.rb
+- lib/sleeping_king_studios/docs/jekyll/generators/reference_generator.rb
+- lib/sleeping_king_studios/docs/jekyll/generators/version_generator.rb
 - lib/sleeping_king_studios/docs/jekyll/plugins.rb
 - lib/sleeping_king_studios/docs/jekyll/plugins/liquid.rb
 - lib/sleeping_king_studios/docs/jekyll/plugins/liquid/filters.rb
 - lib/sleeping_king_studios/docs/jekyll/plugins/liquid/filters/anchorize_slug.rb
 - lib/sleeping_king_studios/docs/jekyll/plugins/required.rb
-- lib/sleeping_king_studios/docs/registry.rb
-- lib/sleeping_king_studios/docs/registry_query.rb
-- lib/sleeping_king_studios/docs/tasks.rb
-- lib/sleeping_king_studios/docs/tasks/base.rb
-- lib/sleeping_king_studios/docs/tasks/generate.rb
-- lib/sleeping_king_studios/docs/tasks/installation.rb
-- lib/sleeping_king_studios/docs/tasks/installation/install_jekyll.rb
-- lib/sleeping_king_studios/docs/tasks/installation/install_templates.rb
-- lib/sleeping_king_studios/docs/tasks/installation/install_workflow.rb
-- lib/sleeping_king_studios/docs/tasks/update.rb
-- lib/sleeping_king_studios/docs/templates/config.yml.erb
-- lib/sleeping_king_studios/docs/templates/deploy-pages.yml.erb
-- lib/sleeping_king_studios/docs/templates/includes/breadcrumbs.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/attribute.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/attributes/heading.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/class.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/constant.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/constants/heading.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/constants/inherited.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/constants/overview.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/breadcrumbs.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/class_attributes.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/class_methods.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/constants.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/constructor.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/definitions.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/details.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/instance_attributes.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/instance_methods.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/overview.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/subclasses.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_attributes.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_methods.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/constants.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_attributes.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_methods.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/overview.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/method.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/aliases.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/heading.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/inherited.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/overload.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/overloads.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/overview.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/parameters.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/post_overview.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/raises.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/return_types.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/returns.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/methods/yields.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/module.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/namespace.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/parent_link.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/reference_link.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/see_link.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/type.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/type_list.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/types/array_type.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/types/hash_type.md
-- lib/sleeping_king_studios/docs/templates/includes/reference/types/ordered_type.md
-- lib/sleeping_king_studios/docs/templates/pages/index.md.erb
-- lib/sleeping_king_studios/docs/templates/pages/reference.md.erb
-- lib/sleeping_king_studios/docs/templates/pages/versions.md.erb
 - lib/sleeping_king_studios/docs/version.rb
+- lib/sleeping_king_studios/docs/yard.rb
+- lib/sleeping_king_studios/docs/yard/build.rb
+- lib/sleeping_king_studios/docs/yard/parse.rb
+- lib/sleeping_king_studios/docs/yard/registry.rb
+- lib/sleeping_king_studios/docs/yard/registry_query.rb
 homepage: http://sleepingkingstudios.com
 licenses:
 - MIT
@@ -234,16 +214,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '3.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Tools for generating a versioned documentation site from YARD docs.
 test_files: []