spreen-wiki 0.1.0 → 0.3.0

data/sig/generated/spreen_wiki/unknown_wiki_count_list_exporter.rbs

@@ -0,0 +1,38 @@
+# Generated from lib/spreen_wiki/unknown_wiki_count_list_exporter.rb with RBS::Inline
+
+module SpreenWiki
+  # 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

data/sig/generated/spreen_wiki/unknown_wiki_list_exporter_for_llm.rbs

@@ -0,0 +1,35 @@
+# Generated from lib/spreen_wiki/unknown_wiki_list_exporter_for_llm.rb with RBS::Inline
+
+module SpreenWiki
+  # 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

data/sig/generated/spreen_wiki/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/spreen_wiki/version.rb with RBS::Inline
+
+module SpreenWiki
+  VERSION: ::String
+end

data/sig/generated/spreen_wiki.rbs

@@ -0,0 +1,8 @@
+# Generated from lib/spreen_wiki.rb with RBS::Inline
+
+# 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 SpreenWiki
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreen-wiki
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - hayat01sh1da
@@ -14,37 +14,37 @@ description: Spreen — the falcon's stoop, then the preen. Generates Home.md an
   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
+- wiki-organise
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- exe/spreen
+- exe/wiki-organise
 - 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
+- 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/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

data/lib/spreen/wiki/application.rb

@@ -1,151 +0,0 @@
-# frozen_string_literal: true
-# rbs_inline: enabled
-
-require_relative 'configuration'
-
-module Spreen
-  module Wiki
-    # Base class for the wiki-organising commands. Loads the wiki tree under
-    # base_path, groups it by Owner or Category in either English or Japanese,
-    # and exposes the resulting maps to its subclasses. Grouping criteria,
-    # languages and labels are resolved through Configuration and can be
-    # extended via a `.spreen.yml` file.
-    class Application
-      class NotImplementedError < StandardError; end
-
-      # @rbs base_path: String
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs home_overflow: (bool | String)
-      # @rbs **options: untyped
-      # @rbs return: untyped
-      def self.run(base_path: Dir.pwd, group_by: 'Owner', language: 'English', home_overflow: 'false', **)
-        instance = new(base_path:, group_by:, language:, home_overflow:, **)
-        instance.validate!
-        instance.run
-      end
-
-      # @rbs base_path: String
-      # @rbs group_by: String
-      # @rbs language: String
-      # @rbs home_overflow: (bool | String)
-      # @rbs config: Configuration?
-      # @rbs **options: untyped
-      # @rbs return: void
-      def initialize(base_path: Dir.pwd, group_by: 'Owner', language: 'English', home_overflow: 'false',
-                     config: nil, **)
-        @base_path       = base_path
-        @group_by        = group_by
-        @language        = language
-        @home_overflow   = parse_home_overflow(home_overflow)
-        @config          = config || Configuration.new(base_path:, **)
-        @path_to_home    = File.join(base_path, 'Home.md')
-        @path_to_sidebar = File.join(base_path, '_Sidebar.md')
-        @paths_to_wikis  = Dir[File.join(base_path, '**', '*.md')]
-        @excluded_paths  = @config.excluded_dirs.flat_map { |dir| Dir[File.join(base_path, dir, '**', '*.md')] }
-      end
-
-      # @rbs return: void
-      def validate!
-        raise ArgumentError, "Invalid group_by: `#{group_by}`" unless config.group_bys.include?(group_by)
-        raise ArgumentError, "Invalid language: `#{language}`" unless config.languages(group_by).include?(language)
-
-        validate_home_overflow!
-      end
-
-      # @rbs return: untyped
-      def run
-        raise NotImplementedError, 'This method must be implemented in each subclass.'
-      end
-
-      private
-
-      attr_reader :base_path,
-                  :group_by,
-                  :language,
-                  :home_overflow,
-                  :config,
-                  :path_to_home,
-                  :path_to_sidebar,
-                  :paths_to_wikis,
-                  :excluded_paths
-
-      # @rbs return: void
-      def validate_home_overflow!
-        return if [true, false].include?(home_overflow)
-
-        raise ArgumentError, "Invalid home_overflow: `#{home_overflow}` must be boolean"
-      end
-
-      # @rbs raw: (bool | String)
-      # @rbs return: (bool | String)
-      def parse_home_overflow(raw)
-        case raw
-        when 'true'  then true
-        when 'false' then false
-        else raw
-        end
-      end
-
-      # @rbs return: Array[String]
-      def target_paths
-        @target_paths ||= paths_to_wikis.reject do |path_to_wiki|
-          path_to_wiki == path_to_home ||
-            path_to_wiki == path_to_sidebar ||
-            excluded_paths.include?(path_to_wiki)
-        end
-      end
-
-      # @rbs return: Regexp
-      def target_regexp
-        @target_regexp ||= config.target_regexp(group_by)
-      end
-
-      # @rbs return: String
-      def no_declaration
-        @no_declaration ||= config.no_declaration(group_by, language)
-      end
-
-      # @rbs return: Hash[String, Array[String]]
-      def wiki_maps_with_namespace
-        @wiki_maps_with_namespace ||= begin
-          named      = Hash.new { |hash, namespace| hash[namespace] = [] } #: Hash[String, Array[String]]
-          undeclared = Hash.new { |hash, namespace| hash[namespace] = [] } #: Hash[String, Array[String]]
-          target_paths.each { |target_path| populate_namespace(target_path, named, undeclared) }
-          named.sort.to_h.merge(undeclared)
-        end
-      end
-
-      # @rbs target_path: String
-      # @rbs named: Hash[String, Array[String]]
-      # @rbs undeclared: Hash[String, Array[String]]
-      # @rbs return: void
-      def populate_namespace(target_path, named, undeclared)
-        return unless File.exist?(target_path)
-
-        namespace = namespace_for(target_path)
-        bucket    = namespace == no_declaration ? undeclared : named
-        bucket[namespace] << File.basename(target_path)
-      end
-
-      # @rbs target_path: String
-      # @rbs return: String
-      def namespace_for(target_path)
-        declaration = File.open(target_path, &:gets)
-        return no_declaration unless declaration&.start_with?(target_regexp)
-
-        declaration.chomp.gsub(target_regexp, '')
-      end
-
-      # @rbs return: Hash[String, Array[String]]
-      def owned_wiki_maps
-        @owned_wiki_maps ||= wiki_maps_with_namespace.select { |namespace, _| namespace.include?('@') }
-      end
-
-      # @rbs return: Hash[String, Array[String]]
-      def plain_wiki_maps
-        @plain_wiki_maps ||= wiki_maps_with_namespace.reject { |namespace, _| namespace.include?('@') }
-      end
-    end
-  end
-end

data/lib/spreen/wiki/cli.rb

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-# rbs_inline: enabled
-
-require 'optparse'
-require_relative 'version'
-require_relative 'home'
-require_relative 'sidebar'
-require_relative 'unknown_wiki_count_list_exporter'
-require_relative 'unknown_wiki_list_exporter_for_llm'
-
-module Spreen
-  module Wiki
-    # Command line interface behind the `spreen` executable:
-    # `spreen <update|count-report|llm-export> [options]`.
-    class CLI
-      HELP = <<~HELP
-        Usage: spreen <command> [options]
-
-        Commands:
-          update        Regenerate Home.md and _Sidebar.md from the wiki tree
-          count-report  Export a count report of the unknown-namespace wikis
-          llm-export    Export the unknown-namespace wiki list for an LLM
-          version       Print the version
-
-        Run `spreen <command> --help` to list the command's options.
-      HELP
-
-      # Flags shared by every command, mapped to the keyword arguments of the
-      # underlying classes. --exclude and the per-command flags are wired up
-      # separately because they need a type or a fixed value.
-      COMMON_OPTIONS = {
-        '--path PATH' => [:base_path, 'Path to the wiki clone (default: current directory)'],
-        '--group-by GROUP_BY' => [:group_by, 'Grouping criteria (default: Owner)'],
-        '--language LANGUAGE' => [:language, 'Language of the labels (default: English)'],
-        '--org ORGANISATION' => [:organisation, 'GitHub organisation/user hosting the wiki'],
-        '--repo REPOSITORY' => [:repository, 'GitHub repository whose wiki is organised'],
-        '--wiki-url URL' => [:wiki_url, 'Wiki URL (overrides the one derived from --org/--repo)'],
-        '--template-dir DIR' => [:template_dir, 'Directory of <group_by>/<language>.md Home templates'],
-        '--config FILE' => [:config_path, 'Config file path (default: <path>/.spreen.yml)']
-      }.freeze
-
-      # @rbs argv: Array[String]
-      # @rbs return: Integer
-      def self.start(argv = ARGV)
-        new(argv).run
-      end
-
-      # @rbs argv: Array[String]
-      # @rbs return: void
-      def initialize(argv)
-        @argv    = argv.dup
-        @options = { base_path: Dir.pwd, group_by: 'Owner', language: 'English', home_overflow: 'false' }
-      end
-
-      # @rbs return: Integer
-      def run
-        command = argv.shift
-        case command
-        when 'update', 'count-report', 'llm-export' then execute(command)
-        when 'version', '--version', '-v'           then print_version
-        when nil, 'help', '--help', '-h'            then print_help(command)
-        else unknown_command(command)
-        end
-      end
-
-      private
-
-      attr_reader :argv, :options
-
-      # @rbs command: String
-      # @rbs return: Integer
-      def execute(command)
-        parser(command).parse!(argv)
-        __send__(command.tr('-', '_'))
-        0
-      rescue ArgumentError, OptionParser::ParseError => e
-        warn e.message
-        1
-      end
-
-      # @rbs return: Integer
-      def print_version
-        puts VERSION
-        0
-      end
-
-      # @rbs command: String?
-      # @rbs return: Integer
-      def print_help(command)
-        puts HELP
-        command.nil? ? 1 : 0
-      end
-
-      # @rbs command: String
-      # @rbs return: Integer
-      def unknown_command(command)
-        warn "Unknown command: `#{command}`"
-        warn HELP
-        1
-      end
-
-      # @rbs return: void
-      def update
-        wiki_url = Home.run(**options)
-        Sidebar.run(**options)
-        puts 'Updated Home.md and _Sidebar.md.'
-        puts "Check them out at '#{wiki_url}' !!" if wiki_url
-      end
-
-      # @rbs return: void
-      def count_report
-        count_list_by_namespace, path_to_export = UnknownWikiCountListExporter.run(**options)
-        puts count_list_by_namespace
-        puts "Exported the unknown wiki count report to '#{path_to_export}'."
-      end
-
-      # @rbs return: void
-      def llm_export
-        path_to_export = UnknownWikiListExporterForLLM.run(**options)
-        puts "Exported the unknown wiki list for LLM to '#{path_to_export}'."
-      end
-
-      # @rbs command: String
-      # @rbs return: OptionParser
-      def parser(command)
-        OptionParser.new("Usage: spreen #{command} [options]") do |opt|
-          add_common_options(opt)
-          add_command_options(opt, command)
-        end
-      end
-
-      # @rbs opt: OptionParser
-      # @rbs return: void
-      def add_common_options(opt)
-        COMMON_OPTIONS.each do |flag, (key, description)|
-          opt.on(flag, description) { |value| options[key] = value }
-        end
-        opt.on('--exclude DIR1,DIR2', Array, 'Directories to skip while scanning') do |dirs|
-          options[:excluded_dirs] = dirs
-        end
-      end
-
-      # @rbs opt: OptionParser
-      # @rbs command: String
-      # @rbs return: void
-      def add_command_options(opt, command)
-        if command == 'update'
-          opt.on('--overflow', 'Split Home into per-namespace pages under wikis-by-owner/') do
-            options[:home_overflow] = 'true'
-          end
-        else
-          opt.on('--output FILENAME', 'Export filename (relative to --path unless absolute)') do |filename|
-            options[:output] = filename
-          end
-        end
-      end
-    end
-  end
-end