spreen-wiki 0.1.0

data/sig/generated/spreen/wiki/home.rbs

@@ -0,0 +1,54 @@
+# Generated from lib/spreen/wiki/home.rb with RBS::Inline
+
+module Spreen
+  module Wiki
+    # Generates the wiki Home page, optionally splitting per-owner content out
+    # into `wikis-by-owner/<owner>.md` when home_overflow is enabled. Returns
+    # the configured wiki URL (if any) so callers can point at the result.
+    class Home < Application
+      # @rbs return: String?
+      def run: () -> String?
+
+      private
+
+      # @rbs return: String
+      def path_to_wikis_by_owner: () -> String
+
+      # @rbs return: String
+      def path_to_home_template: () -> String
+
+      # @rbs return: Array[String]
+      def home_passage: () -> Array[String]
+
+      # @rbs return: void
+      def write_home_passage: () -> void
+
+      # @rbs return: void
+      def write_concise_home_passage: () -> void
+
+      # @rbs return: void
+      def write_per_namespace_files: () -> void
+
+      # @rbs return: void
+      def write_home_table_of_contents: () -> void
+
+      # @rbs passage: Array[String]
+      # @rbs namespace: String
+      # @rbs wikis: Array[String]
+      # @rbs owned: bool
+      # @rbs return: void
+      def append_block: (Array[String] passage, String namespace, Array[String] wikis, owned: bool) -> void
+
+      # @rbs namespace: String
+      # @rbs wikis: Array[String]
+      # @rbs owned: bool
+      # @rbs return: void
+      def write_overflow_block: (String namespace, Array[String] wikis, owned: bool) -> void
+
+      # @rbs namespace: String
+      # @rbs owned: bool
+      # @rbs return: String
+      def heading_for: (String namespace, owned: bool) -> String
+    end
+  end
+end

data/sig/generated/spreen/wiki/sidebar.rbs

@@ -0,0 +1,31 @@
+# Generated from lib/spreen/wiki/sidebar.rb with RBS::Inline
+
+module Spreen
+  module Wiki
+    # Generates the wiki _Sidebar.md as a nested list of owners/categories and
+    # their wiki pages.
+    class Sidebar < Application
+      # @rbs return: void
+      def run: () -> void
+
+      private
+
+      # @rbs return: Array[String]
+      def wiki_list: () -> Array[String]
+
+      # @rbs return: void
+      def update_wiki_list: () -> void
+
+      # @rbs namespace: String
+      # @rbs wikis: Array[String]
+      # @rbs owned: bool
+      # @rbs return: void
+      def append_section: (String namespace, Array[String] wikis, owned: bool) -> void
+
+      # @rbs namespace: String
+      # @rbs owned: bool
+      # @rbs return: String
+      def section_heading: (String namespace, owned: bool) -> String
+    end
+  end
+end

data/sig/generated/spreen/wiki/unknown_wiki_count_list_exporter.rbs

@@ -0,0 +1,40 @@
+# Generated from lib/spreen/wiki/unknown_wiki_count_list_exporter.rb with RBS::Inline
+
+module Spreen
+  module Wiki
+    # Writes a sorted text report of how many wikis exist under each of the
+    # configured "unknown owner/category" namespaces.
+    class UnknownWikiCountListExporter < Application
+      DEFAULT_OUTPUT_FILENAME: ::String
+
+      # @rbs base_path: String
+      # @rbs group_by: String
+      # @rbs language: String
+      # @rbs home_overflow: (bool | String)
+      # @rbs output: String?
+      # @rbs **options: untyped
+      # @rbs return: void
+      def initialize: (?base_path: String, ?group_by: String, ?language: String, ?home_overflow: bool | String, ?output: String?, **untyped) -> void
+
+      # @rbs return: [Array[String], String]
+      def run: () -> [ Array[String], String ]
+
+      private
+
+      attr_reader path_to_export: String
+
+      # @rbs filename: String
+      # @rbs return: String
+      def resolve_output_path: (String filename) -> String
+
+      # @rbs return: Array[String]
+      def namespace_list: () -> Array[String]
+
+      # @rbs return: Array[String]
+      def missing_count_list_by_namespace: () -> Array[String]
+
+      # @rbs return: Array[String]
+      def count_list_by_namespace: () -> Array[String]
+    end
+  end
+end

data/sig/generated/spreen/wiki/unknown_wiki_list_exporter_for_llm.rbs

@@ -0,0 +1,37 @@
+# Generated from lib/spreen/wiki/unknown_wiki_list_exporter_for_llm.rb with RBS::Inline
+
+module Spreen
+  module Wiki
+    # Writes a flat list of the wikis under the configured "unknown
+    # owner/category" namespace in a form suitable for feeding to an LLM.
+    class UnknownWikiListExporterForLLM < Application
+      DEFAULT_OUTPUT_FILENAME: ::String
+
+      # @rbs base_path: String
+      # @rbs group_by: String
+      # @rbs language: String
+      # @rbs home_overflow: (bool | String)
+      # @rbs output: String?
+      # @rbs **options: untyped
+      # @rbs return: void
+      def initialize: (?base_path: String, ?group_by: String, ?language: String, ?home_overflow: bool | String, ?output: String?, **untyped) -> void
+
+      # @rbs return: String
+      def run: () -> String
+
+      private
+
+      attr_reader path_to_export: String
+
+      # @rbs filename: String
+      # @rbs return: String
+      def resolve_output_path: (String filename) -> String
+
+      # @rbs return: String
+      def target_namespace: () -> String
+
+      # @rbs return: Array[String]
+      def unknown_wiki_list_for_llm: () -> Array[String]
+    end
+  end
+end

data/sig/generated/spreen/wiki/version.rbs

@@ -0,0 +1,7 @@
+# Generated from lib/spreen/wiki/version.rb with RBS::Inline
+
+module Spreen
+  module Wiki
+    VERSION: ::String
+  end
+end

data/sig/generated/spreen/wiki.rbs

@@ -0,0 +1,10 @@
+# Generated from lib/spreen/wiki.rb with RBS::Inline
+
+module Spreen
+  # Spreens a GitHub wiki — the falcon's stoop, then the preen: generates
+  # Home.md and _Sidebar.md grouped by the Owner/Category declared on the
+  # first line of each page, and exports reports of the pages whose owner
+  # or category is unknown.
+  module Wiki
+  end
+end

data/sig/generated/spreen-wiki.rbs

@@ -0,0 +1,2 @@
+# Generated from lib/spreen-wiki.rb with RBS::Inline
+

data/sig/generated/test/application_test.rbs

@@ -0,0 +1,30 @@
+# Generated from test/application_test.rb with RBS::Inline
+
+class ApplicationTest < Minitest::Test
+  TEST_FILE_MAPS: Hash[Array[String], Hash[String, String]]
+
+  def setup: (?base_path: untyped, ?group_by: untyped, ?language: untyped, ?home_overflow: untyped) -> untyped
+
+  def teardown: () -> untyped
+
+  def test_validate_group_by!: () -> untyped
+
+  def test_validate_language!: () -> untyped
+
+  def test_validate_home_overflow!: () -> untyped
+
+  def test_self_run: () -> untyped
+
+  private
+
+  attr_reader base_path: untyped
+
+  attr_reader group_by: untyped
+
+  attr_reader language: untyped
+
+  attr_reader home_overflow: untyped
+
+  # @rbs return: Hash[String, String]
+  def test_file_maps: () -> Hash[String, String]
+end

data/sig/generated/test/configuration_test.rbs

@@ -0,0 +1,38 @@
+# Generated from test/configuration_test.rb with RBS::Inline
+
+class ConfigurationTest < ApplicationTest
+  CUSTOM_CONFIG: ::String
+
+  def test_default_group_bys_and_languages: () -> untyped
+
+  def test_default_labels: () -> untyped
+
+  def test_default_unknown_namespaces: () -> untyped
+
+  def test_default_excluded_dirs: () -> untyped
+
+  def test_urls_are_absent_without_an_organisation: () -> untyped
+
+  def test_urls_derived_from_organisation_and_repository: () -> untyped
+
+  def test_explicit_urls_win_over_derived_ones: () -> untyped
+
+  def test_empty_values_are_treated_as_absent: () -> untyped
+
+  def test_default_template_dir_ships_with_the_library: () -> untyped
+
+  def test_config_file_overrides_values: () -> untyped
+
+  def test_config_file_extends_languages: () -> untyped
+
+  def test_explicit_options_win_over_the_config_file: () -> untyped
+
+  def test_config_file_language_passes_validation: () -> untyped
+
+  def test_exporter_honours_custom_output_filename: () -> untyped
+
+  private
+
+  # @rbs return: void
+  def write_config_file: () -> void
+end

data/sig/generated/test/home_test.rbs

@@ -0,0 +1,60 @@
+# Generated from test/home_test.rb with RBS::Inline
+
+class HomeTest < ApplicationTest
+  def setup: (?group_by: untyped, ?language: untyped, ?home_overflow: untyped) -> untyped
+
+  private
+
+  attr_reader path_to_home: untyped
+
+  attr_reader home: untyped
+
+  attr_reader path_to_wikis_by_owner: untyped
+
+  # Expected Home pages live under test/fixtures/home/.
+  # @rbs basename: String
+  # @rbs return: String
+  def expected_home: (String basename) -> String
+
+  module English
+    class OwnedHomeTest < HomeTest
+      class NonOverflowTest < OwnedHomeTest
+        def test_self_run: () -> untyped
+      end
+
+      class OverflowTest < OwnedHomeTest
+        def setup: () -> untyped
+
+        def test_self_run: () -> untyped
+      end
+    end
+
+    class CategorisedHomeTest < HomeTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+    end
+  end
+
+  module Japanese
+    class OwnedHomeTest < HomeTest
+      class NonOverflowTest < OwnedHomeTest
+        def setup: () -> untyped
+
+        def test_self_run: () -> untyped
+      end
+
+      class OverflowTest < OwnedHomeTest
+        def setup: () -> untyped
+
+        def test_self_run: () -> untyped
+      end
+    end
+
+    class CategorisedHomeTest < HomeTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+    end
+  end
+end

data/sig/generated/test/sidebar_test.rbs

@@ -0,0 +1,42 @@
+# Generated from test/sidebar_test.rb with RBS::Inline
+
+class SidebarTest < ApplicationTest
+  def setup: (?group_by: untyped, ?language: untyped) -> untyped
+
+  private
+
+  attr_reader path_to_sidebar: untyped
+
+  attr_reader sidebar: untyped
+
+  # Expected Sidebar pages live under test/fixtures/sidebar/.
+  # @rbs basename: String
+  # @rbs return: String
+  def expected_sidebar: (String basename) -> String
+
+  module English
+    class OwnedSidebarTest < SidebarTest
+      def test_self_run: () -> untyped
+    end
+
+    class PlainSidebarTest < SidebarTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+    end
+  end
+
+  module Japanese
+    class OwnedSidebarTest < SidebarTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+    end
+
+    class PlainSidebarTest < SidebarTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+    end
+  end
+end

data/sig/generated/test/unknown_wiki_count_list_exporter_test.rbs

@@ -0,0 +1,161 @@
+# Generated from test/unknown_wiki_count_list_exporter_test.rb with RBS::Inline
+
+class UnknownWikiCountListExporterTest < ApplicationTest
+  def setup: (?group_by: untyped, ?language: untyped) -> untyped
+
+  private
+
+  attr_reader path_to_unknown_wiki_count_list: untyped
+
+  attr_reader unknown_wiki_count_list: untyped
+
+  module English
+    class OwnershipTest < UnknownWikiCountListExporterTest
+      class RegularCase1 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+      end
+
+      class RegularCase2 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+
+      class IrregularCase1 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+
+      class IrregularCase2 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+
+      class IrregularCase3 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+    end
+
+    class CategoryTest < UnknownWikiCountListExporterTest
+      def setup: () -> untyped
+
+      class RegularCase < CategoryTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+      end
+
+      class IrregularCase < CategoryTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+    end
+  end
+
+  module Japanese
+    class OwnershipTest < UnknownWikiCountListExporterTest
+      def setup: () -> untyped
+
+      class RegularCase1 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+      end
+
+      class RegularCase2 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+
+      class IrregularCase1 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+
+      class IrregularCase2 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+
+      class IrregularCase3 < OwnershipTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+    end
+
+    class CategoryTest < UnknownWikiCountListExporterTest
+      def setup: () -> untyped
+
+      class RegularCase < CategoryTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+      end
+
+      class IrregularCase < CategoryTest
+        def test_self_run: () -> untyped
+
+        private
+
+        def unknown_wiki_count_list_by_namespace: () -> untyped
+
+        def test_file_maps: () -> untyped
+      end
+    end
+  end
+end

data/sig/generated/test/unknown_wiki_list_exporter_for_llm_test.rbs

@@ -0,0 +1,53 @@
+# Generated from test/unknown_wiki_list_exporter_for_llm_test.rb with RBS::Inline
+
+class UnknownWikiListExporterForLLMTest < ApplicationTest
+  def setup: (?group_by: untyped, ?language: untyped) -> untyped
+
+  private
+
+  attr_reader path_to_unknown_wiki_list_for_llm: untyped
+
+  attr_reader unknown_wiki_list_for_llm: untyped
+
+  module English
+    class OwnershipTest < UnknownWikiListExporterForLLMTest
+      def test_self_run: () -> untyped
+
+      private
+
+      def unknown_wiki_list: () -> untyped
+    end
+
+    class CategoryTest < UnknownWikiListExporterForLLMTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+
+      private
+
+      def unknown_wiki_list: () -> untyped
+    end
+  end
+
+  module Japanese
+    class OwnershipTest < UnknownWikiListExporterForLLMTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+
+      private
+
+      def unknown_wiki_list: () -> untyped
+    end
+
+    class CategoryTest < UnknownWikiListExporterForLLMTest
+      def setup: () -> untyped
+
+      def test_self_run: () -> untyped
+
+      private
+
+      def unknown_wiki_list: () -> untyped
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: spreen-wiki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hayat01sh1da
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Spreen — the falcon's stoop, then the preen. Generates Home.md and _Sidebar.md
+  for a GitHub wiki by grouping pages by the Owner/Category declared on the first
+  line of each page (English and Japanese labels built in, extensible via .spreen.yml),
+  and exports reports of the pages whose owner or category is unknown.
+executables:
+- spreen
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/spreen
+- lib/spreen-wiki.rb
+- lib/spreen/wiki.rb
+- lib/spreen/wiki/application.rb
+- lib/spreen/wiki/cli.rb
+- lib/spreen/wiki/configuration.rb
+- lib/spreen/wiki/home.rb
+- lib/spreen/wiki/sidebar.rb
+- lib/spreen/wiki/templates/category/english.md
+- lib/spreen/wiki/templates/category/japanese.md
+- lib/spreen/wiki/templates/owner/english.md
+- lib/spreen/wiki/templates/owner/japanese.md
+- lib/spreen/wiki/unknown_wiki_count_list_exporter.rb
+- lib/spreen/wiki/unknown_wiki_list_exporter_for_llm.rb
+- lib/spreen/wiki/version.rb
+- sig/generated/spreen-wiki.rbs
+- sig/generated/spreen/wiki.rbs
+- sig/generated/spreen/wiki/application.rbs
+- sig/generated/spreen/wiki/cli.rbs
+- sig/generated/spreen/wiki/configuration.rbs
+- sig/generated/spreen/wiki/home.rbs
+- sig/generated/spreen/wiki/sidebar.rbs
+- sig/generated/spreen/wiki/unknown_wiki_count_list_exporter.rbs
+- sig/generated/spreen/wiki/unknown_wiki_list_exporter_for_llm.rbs
+- sig/generated/spreen/wiki/version.rbs
+- sig/generated/test/application_test.rbs
+- sig/generated/test/configuration_test.rbs
+- sig/generated/test/home_test.rbs
+- sig/generated/test/sidebar_test.rbs
+- sig/generated/test/unknown_wiki_count_list_exporter_test.rbs
+- sig/generated/test/unknown_wiki_list_exporter_for_llm_test.rbs
+homepage: https://github.com/hayat01sh1da/spreen-wiki
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hayat01sh1da/spreen-wiki
+  source_code_uri: https://github.com/hayat01sh1da/spreen-wiki
+  changelog_uri: https://github.com/hayat01sh1da/spreen-wiki/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hayat01sh1da/spreen-wiki/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: 'Spreen your GitHub wiki: organise Home and _Sidebar pages by owner or category.'
+test_files: []