skap 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b24eb7212466fb9d393d5d3847d279bf502c6ea798d5b6169443df4c704949e8
+  data.tar.gz: 5c45d5fd262e0b9ef739f8d4145ca6aab80ada327e2c211b6d7aa0449a2d19c7
+SHA512:
+  metadata.gz: cf53061aa0925dbc45a03068bf4565f7c6de5fa1033ea946a209667cec3194e16791bd0af89001f1bf66281b811eebe5515bf31eecd605f6071dea4ed05977f8
+  data.tar.gz: 4dff3e1661ea6a77720be3c600add6a5af121c25490f579b1c66f34e7a129a627d4e44928b7ee75bd91da14459d43fb339afde31a7e16b1f0f035fbd0f612cc7

data/.bundle/config.template

@@ -0,0 +1,7 @@
+---
+BUNDLE_GLOBAL_GEM_CACHE: true
+BUNDLE_IGNORE_FUNDING_REQUESTS: true
+BUNDLE_IGNORE_MESSAGES: true
+BUNDLE_SHEBANG: ruby
+BUNDLE_SILENCE_DEPRECATIONS: false
+BUNDLE_SILENCE_ROOT_WARNING: false

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/config
+.yardoc
+*.gem

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_gem:
+  rubocop-configs:
+    - _all_cops.yml
+    - _ruby.yml
+    - gemspec.yml
+    - performance.yml
+
+AllCops:
+  TargetRubyVersion: 3.3
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Lint/Debugger:
+  DebuggerMethods:
+    # Exclude "puts" from this list.
+    Kernel: [warn, binding.irb, p, Kernel.binding.irb]
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+# Turn off warnging: %{gem} was loaded from the standard library,
+# but will no longer be part of the default gems starting from Ruby 3.5.0
+gem "rdoc"
+
+gem "prism" # For parser_prism in Rubocop.
+gem "rubocop-configs", require: false, git: "https://github.com/crosspath/rubocop-configs.git"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+GIT
+  remote: https://github.com/crosspath/rubocop-configs.git
+  revision: ef433c9f20720610194773a31ca1b89a7888e5e7
+  specs:
+    rubocop-configs (0.17.0)
+      rake (>= 13.0)
+
+PATH
+  remote: .
+  specs:
+    skap (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    parallel (1.26.3)
+    parser (3.3.4.2)
+      ast (~> 2.4.1)
+      racc
+    prism (1.0.0)
+    psych (5.1.2)
+      stringio
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.2)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.22.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.1)
+    unicode-display_width (2.5.0)
+    yard (0.9.37)
+
+PLATFORMS
+  ruby
+  x86_64-linux-gnu
+
+DEPENDENCIES
+  prism
+  rdoc
+  rspec-core (~> 3.13)
+  rspec-expectations (~> 3.13)
+  rubocop (~> 1.66)
+  rubocop-configs!
+  rubocop-performance (~> 1.22)
+  skap!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.5.19

data/README.md

@@ -0,0 +1,119 @@
+# Skap — document management system
+
+Word "skap" is a variation of Germanic words "skab"/"schap"/"schaf".
+Here it means storage closet with documents or books.
+
+Skap manages local copy of source documents published in git repositories.
+You may use Skap to track changes in source documents and to store revisions (versions)
+of your works based on these source documents, for example abstracts.
+
+## Available commands
+
+```plain
+help
+    Show help message about supported commands.
+init
+init DIRECTORY_PATH
+    Create configuration files in current directory or in DIRECTORY_PATH.
+sources
+    add DIRECTORY REPO BRANCH
+        Add git submodule into DIRECTORY from REPO and track BRANCH by default.
+    delete DIRECTORY
+        Delete git submodule from DIRECTORY.
+    update
+    update DIRECTORY ...
+        Update git submodule from upstream in DIRECTORY or in all git submodules if DIRECTORY
+        is not specified. You may pass one or more directory paths (DIRECTORY ...) to update their
+        contents.
+works
+    covered
+        List files of sources which have been used for published works.
+    ignored
+        List ignored files.
+    outdated
+        List documents which may contain outdated information.
+    publish DOCUMENT
+    publish DOCUMENT FILE_PATH ...
+        Save record about abstract (DOCUMENT) and pass list of file paths of sources (FILE_PATH ...)
+        which relate to this abstract. You should prepend minus sign to file path to exclude it from
+        list of related sources. Examples:
+        works publish _/docker/compose.md docs.docker.com/content/manuals/compose/**/*.md
+        works publish _/docker/compose.md -docs.docker.com/**/*.md
+    uncovered
+        List files of sources which have NOT been used for published works.
+    unknown
+        List files of sources which may be used for works or ignored.
+```
+
+## Suggested workflow
+
+1. Install Skap: `gem install skap`
+2. Initialize storage: `skap init ~/docs` (pass any path to storage)
+3. Add sources: `skap sources add docker https://github.com/docker/docs.git main`
+  (see command description in "Available commands")
+4. Look into downloaded source files and fill entries in file "sources.yaml" in your storage.
+5. Create file with your text (here it's known as "work") that relates somehow to source documents.
+6. Save revision of source documents with current state of "work":
+  `skap works publish _/docker/overview.md docker/content/get-started/docker-overview.md`
+  (here "_/docker/overview.md" is path to your "work")
+7. Commit changes into current git repository in your storage: `git commit ...` (see manual for git)
+
+Additionally you may push your changes into remote repository — see manual for git:
+git remote, git push.
+
+## Additional files in storage
+
+You should store changes in these files with "git commit".
+
+Schema of file "sources.yaml":
+
+```yaml
+%directory-name%:
+  file-extensions: [%ext%, %ext%]
+  ignored:
+    - %file-path-pattern-in-this-directory%
+  indexed:
+    - %file-path-pattern-in-this-directory%
+```
+
+Example of file "sources.yaml":
+
+```yaml
+docker:
+  file-extensions: [md, yaml]
+  ignored:
+    - "*.md"
+    - compose.yaml
+  indexed:
+    - content/get-started/**/*.md
+```
+
+Schema of file "versions.yaml":
+
+```yaml
+%work-file-path%:
+  date: %iso-date%
+  sources:
+    %source-file-path%:
+      date: %iso-date%
+      sha: %commit-sha%
+```
+
+Example of file "versions.yaml":
+
+```yaml
+_/docker/overview.md:
+  date: 2024-12-31
+  sources:
+    docker/content/get-started/docker-overview.md:
+      date: 2024-12-31
+      sha: fc77b05ffe69070796a6a8630802e62b75304455
+```
+
+## Development
+
+```shell
+bin/rubocop -A --only Style/FrozenStringLiteralComment,Layout/EmptyLineAfterMagicComment
+bin/rubocop -a
+bin/build
+```

data/bin/rubocop

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("rubocop", "rubocop"))

data/bin/yard

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("yard", "yard"))

data/exe/skap

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/skap"
+Skap::CLI.start

data/lib/skap/cli/help.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Skap
+  module CLI::Help
+    include Command
+    extend self
+
+    # @return [void]
+    def start
+      menu = Files::Menu.new
+
+      puts "Usage:", ""
+
+      show_menu(menu, $DEFAULT_OUTPUT.winsize.last)
+    end
+
+    private
+
+    # @param text [String]
+    # @param indent [String]
+    # @param max_width [Integer]
+    # @return [void]
+    def output_menu_item_text(text, indent, max_width)
+      res = []
+
+      if text.is_a?(Array)
+        text.each { |paragraph| res += StringUtils.break_by_words(paragraph, max_width) }
+      else
+        res += StringUtils.break_by_words(text, max_width)
+      end
+
+      res.each { |line| puts "#{indent}#{line}" }
+    end
+
+    # @param menu [Files::Menu]
+    # @param width [Integer]
+    # @return [void]
+    def show_menu(menu, width) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      section_indent = " " * 4
+      command_indent = " " * 8
+      within_section = width - 4
+      within_command = width - 8
+
+      menu.each do |item|
+        puts item["cmd"]
+
+        output_menu_item_text(item["text"], section_indent, within_section) if item.key?("text")
+
+        next unless item.key?("children")
+
+        item["children"].each do |subitem|
+          [*subitem["cmd"]].each { |cmd| puts "#{section_indent}#{cmd}" }
+
+          output_menu_item_text(subitem["text"], command_indent, within_command)
+        end
+      end
+    end
+  end
+end

data/lib/skap/cli/init.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Skap
+  module CLI::Init
+    include Command
+    extend self
+
+    # @param dir [String]
+    # @param args [Array<String>]
+    # @return [void]
+    def start(dir, args)
+      assert_empty_options(args)
+
+      FileUtils.mkdir_p(dir)
+
+      shell("git init", dir:)
+      shell("echo '---\n' > #{Files::Sources.file_name}", dir:)
+      shell("echo '---\n' > #{Files::Versions.file_name}", dir:)
+
+      puts "Git repo initialized in #{dir}"
+    end
+  end
+end

data/lib/skap/cli/sources.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Skap
+  module CLI::Sources
+    include Command
+    extend self
+
+    # @param command [String]
+    # @param args [Array<String>]
+    # @return [void]
+    def start(command, args)
+      assert_cwd
+
+      case command
+      when "add" then add(*args)
+      when "delete" then delete(*args)
+      when "update" then update(*args)
+      else
+        raise ArgumentError, "Unknown command: #{command}"
+      end
+    end
+
+    private
+
+    # @param dir [String]
+    # @param repo [String]
+    # @param branch [String]
+    # @param rest [Array<String>]
+    # @return [void]
+    def add(dir, repo, branch, *rest)
+      assert_empty_options(rest)
+
+      return unless shell("git submodule add -b #{branch} --depth 3 -- #{repo} #{dir}")
+
+      sources_data = load_file(SOURCES)
+      sources_data[dir] = {"file-extensions" => [], "ignored" => [], "indexed" => []}
+
+      sources_data = sources_data.sort_by(&:first).to_h
+      File.write(SOURCES, Psych.dump(sources_data, line_width: 100))
+    end
+
+    # @param dir [String]
+    # @param rest [Array<String>]
+    # @return [void]
+    def delete(dir, *rest)
+      assert_empty_options(rest)
+
+      shell("git submodule deinit -f -- #{dir} && git rm -f #{dir} && rm -rf .git/modules/#{dir}")
+    end
+
+    # @param dirs [Array<String>]
+    # @return [void]
+    def update(*dirs)
+      path_arg = dirs.empty? ? "" : "-- #{dirs.join(" ")}"
+
+      shell("git submodule update --checkout --single-branch --recursive #{path_arg}")
+    end
+  end
+end

data/lib/skap/cli/works.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Skap
+  module CLI::Works
+    include Command
+    extend self
+
+    # @param command [String]
+    # @param args [Array<String>]
+    # @return [void]
+    def start(command, args) # rubocop:disable Metrics/MethodLength
+      assert_cwd
+
+      case command
+      when "covered" then covered(*args)
+      when "ignored" then ignored(*args)
+      when "publish" then publish(*args)
+      when "outdated" then outdated(*args)
+      when "uncovered" then uncovered(*args)
+      when "unknown" then unknown(*args)
+      else
+        raise ArgumentError, "Unknown command: #{command}"
+      end
+    end
+
+    private
+
+    # @param path_patterns_as_hash [Hash<String, Array<String>>]
+    # @return [Array<String>]
+    def collect_files(path_patterns_as_hash)
+      flatten_path_patterns(path_patterns_as_hash).flat_map do |path_pattern|
+        find_files_by_pattern(path_pattern)
+      end
+    end
+
+    # @param path [String]
+    # @return [String]
+    def commit_sha(path)
+      dir, file = File.split(path)
+
+      shell("git rev-parse HEAD -- #{file}", dir:).split("\n").first
+    end
+
+    # @param dirs [Array<String>]
+    # @return [void]
+    def covered(*dirs)
+      sources = Files::Sources.new.extract("indexed", dir_names_without_slash(dirs))
+
+      puts (Files::Versions.new.covered_sources & collect_files(sources)).sort
+    end
+
+    # @param dirs [Array<String>]
+    # @return [Array<String>]
+    def dir_names_with_slash(dirs)
+      dirs.map { |x| x.end_with?("/") ? x : "#{x}/" }
+    end
+
+    # @param dirs [Array<String>]
+    # @return [Array<String>]
+    def dir_names_without_slash(dirs)
+      dirs.map { |x| x.end_with?("/") ? x.chop : x }
+    end
+
+    # @param path_pattern [String]
+    # @return [Array<String>]
+    def find_files_by_pattern(path_pattern)
+      if path_pattern.include?("*")
+        result = Dir.glob(path_pattern, base: CURRENT_DIR)
+        raise ArgumentError, "No files found for path pattern \"#{path_pattern}\"" if result.empty?
+
+        result
+      else
+        raise ArgumentError, "File \"#{path_pattern}\" doesn't exist" if !File.exist?(path_pattern)
+
+        path_pattern
+      end
+    end
+
+    # @param hash [Hash<String, Array<String>>]
+    # @return [Array<String>]
+    def flatten_path_patterns(hash)
+      hash.flat_map { |dir, paths| paths.map { |x| File.join(dir, x) } }
+    end
+
+    # @param dirs [Array<String>]
+    # @return [void]
+    def ignored(*dirs)
+      sources = Files::Sources.new.extract("ignored", dir_names_without_slash(dirs))
+
+      puts collect_files(sources).sort
+    end
+
+    # @param dirs [Array<String>]
+    # @return [void]
+    def outdated(*dirs)
+      dirs = dir_names_with_slash(dirs)
+
+      outdated_documents =
+        Files::Versions.new.outdated_documents do |source_path|
+          dirs.empty? || source_path.start_with?(*dirs) ? commit_sha(source_path) : nil
+        end
+
+      outdated_documents.each do |(doc_path, outdated_sources)|
+        puts doc_path, outdated_sources.map { |x| "* #{x}" }, ""
+      end
+    end
+
+    # @param document_path [String]
+    # @param sources_paths [Array<String>]
+    # @return [void]
+    def publish(document_path, *sources_paths)
+      excluded_file_paths = sources_paths.select { |x| x.start_with?("-") }
+      added_file_paths = sources_paths - excluded_file_paths
+
+      excluded_file_paths.map! { |x| x[1..] }
+
+      versions = Files::Versions.new
+      doc = versions.find_document(document_path) || {}
+
+      update_document_info(doc, added_file_paths, excluded_file_paths)
+      versions.add_document(document_path, doc)
+
+      puts "Version updated for #{document_path} in #{Files::Versions.file_name}"
+    end
+
+    # @param path_patterns_as_hash [Hash<String, Hash<String, Array<String>>>]
+    # @return [Array<String>]
+    def trackable_files(sources_data)
+      sources_data
+        .extract("file-extensions")
+        .transform_values { |v| v.join(",") }
+        .reduce([]) { |a, (dir, ext)| a + Dir.glob("#{dir}/**/*.{#{ext}}") }
+    end
+
+    # @param dirs [Array<String>]
+    # @return [void]
+    def uncovered(*dirs)
+      sources = Files::Sources.new.extract("indexed", dir_names_without_slash(dirs))
+
+      puts (collect_files(sources) - Files::Versions.new.covered_sources.to_a).sort
+    end
+
+    # @param dirs [Array<String>]
+    # @return [void]
+    def unknown(*dirs)
+      sources_data = Files::Sources.new
+      sources_data.select_directories!(dir_names_without_slash(dirs)) if !dirs.empty?
+
+      all_files = trackable_files(sources_data)
+      ignored_files = collect_files(sources_data.extract("ignored"))
+      indexed_files = collect_files(sources_data.extract("indexed"))
+
+      puts (all_files - ignored_files - indexed_files).sort
+    end
+
+    # @param doc [Hash<String, Object>]
+    # @param added_file_paths [Array<String>]
+    # @param excluded_file_paths [Array<String>]
+    # @return [void]
+    def update_document_info(doc, added_file_paths, excluded_file_paths)
+      today = Time.now.strftime("%F")
+
+      doc["date"] = today
+      doc["sources"] ||= {}
+
+      added_file_paths.each do |path|
+        entry = (doc["sources"][path] ||= {})
+        entry["date"] = today
+        entry["sha"] = commit_sha(path)
+      end
+
+      excluded_file_paths.each { |x| doc["sources"].delete(x) }
+    end
+  end
+end

data/lib/skap/cli.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "English"
+require "fileutils"
+require "io/console"
+require "psych"
+
+require_relative "command"
+require_relative "yaml_file"
+
+require_relative "files/menu"
+require_relative "files/sources"
+require_relative "files/versions"
+
+module Skap
+  module CLI
+    # @param argv [Array<String>]
+    # @return [void]
+    def self.start(argv = ARGV)
+      section, command, *rest = argv
+
+      case section
+      when "works" then CLI::Works.start(command, rest)
+      when "help", "--help", "-h", nil then CLI::Help.start
+      when "init" then CLI::Init.start(command, rest)
+      when "sources" then CLI::Sources.start(command, rest)
+      else
+        raise ArgumentError, "Unknown section: #{section}"
+      end
+    end
+  end
+end
+
+# TODO: Command "clone" - it calls "git clone" & initializes git submodules.
+# git clone --recurse <URL> <directory>
+
+require_relative "cli/help"
+require_relative "cli/init"
+require_relative "cli/sources"
+require_relative "cli/works"

data/lib/skap/command.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Skap
+  module Command
+    CURRENT_DIR = Dir.pwd.freeze
+
+    private
+
+    # @return [void]
+    def assert_cwd
+      raise "Current dir isn't a repo for sources" if !File.exist?(Files::Sources.file_name)
+    end
+
+    # @param args [Array<String>]
+    # @return [void]
+    def assert_empty_options(args)
+      raise ArgumentError, "Unknown options: #{args.inspect}" if !args.empty?
+    end
+
+    # @param cmd [String]
+    # @param dir [String]
+    # @return [String]
+    def shell(cmd, dir: "")
+      dir = dir == "~" ? Dir.home : File.absolute_path(dir, CURRENT_DIR)
+      `cd #{dir} && #{cmd}`.strip
+    end
+  end
+end

data/lib/skap/files/menu.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Skap
+  module Files
+    class Menu < YAMLFile
+      extend Forwardable
+
+      SKAP_DIR = File.expand_path("../../..", __dir__).freeze
+
+      self.file_name = File.join(SKAP_DIR, "menu.yaml")
+
+      def_delegators :file, :each
+    end
+  end
+end

data/lib/skap/files/sources.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Skap
+  module Files
+    class Sources < YAMLFile
+      self.file_name = "sources.yaml"
+
+      # @param key [String]
+      # @param dirs [Array<String>]
+      # @return [Hash<String, Array<String>>]
+      def extract(key, dirs = [])
+        sources = dirs.empty? ? file : file.slice(*dirs)
+        sources
+          .transform_values { |v| v[key] }
+          .reject { |_, v| v.nil? || v.empty? }
+      end
+
+      # @param dirs [Array<String>]
+      # @return [Hash<String, Hash<String, Array<String>>>]
+      def select_directories!(dirs)
+        @file = file.slice(*dirs)
+      end
+    end
+  end
+end

data/lib/skap/files/versions.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Skap
+  module Files
+    class Versions < YAMLFile
+      self.file_name = "versions.yaml"
+
+      # @param document_path [String]
+      # @param document [Hash<String, Object>]
+      # @return [void]
+      def add_document(document_path, document)
+        file[document_path] = document
+        @file = file.sort_by(&:first).to_h
+
+        File.write(self.class.file_name, Psych.dump(file, line_width: 100))
+      end
+
+      # @return [Set<String>]
+      def covered_sources
+        result = Set.new
+
+        file.each_value { |value| result.merge(value["sources"].keys) }
+
+        result
+      end
+
+      # @param document_path [String]
+      # @return [Hash<String, Object>]
+      def find_document(document_path)
+        file[document_path]
+      end
+
+      # @return [Array<Array(String, Array<String>)>]
+      def outdated_documents
+        sources_sha = {}
+
+        file.filter_map do |doc_path, hash|
+          outdated_sources =
+            hash["sources"].filter_map do |source_path, source_data|
+              sha = (sources_sha[source_path] ||= yield(source_path))
+              source_path if !sha.nil? && sha != source_data["sha"]
+            end
+          [doc_path, outdated_sources] if !outdated_sources.empty?
+        end
+      end
+    end
+  end
+end

data/lib/skap/string_utils.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Skap
+  module StringUtils
+    extend self
+
+    # @param paragraph [String]
+    # @param max_width [Integer]
+    # @return [Array<String>]
+    def break_by_words(paragraph, max_width)
+      words = paragraph.split
+      parts = [[]]
+      line_width = 0
+
+      while !words.empty?
+        word = words.shift
+        new_line_width = (line_width == 0 ? line_width : line_width + 1) + word.size
+        line_width = add_word(word, parts, new_line_width, max_width)
+      end
+
+      parts.pop if parts.last.empty?
+
+      parts.map { |line| line.join(" ") }
+    end
+
+    private
+
+    # @param word [String]
+    # @param parts [Array<String>]
+    # @param new_line_width [Integer]
+    # @param max_width [Integer]
+    # @return [Integer] Current line width
+    def add_word(word, parts, new_line_width, max_width) # rubocop:disable Metrics/MethodLength
+      if new_line_width <= max_width
+        parts.last << word
+
+        if new_line_width == max_width
+          parts << []
+          0
+        else
+          new_line_width
+        end
+      else
+        parts << [word]
+        word.size
+      end
+    end
+  end
+end

data/lib/skap/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Skap
+  VERSION = "1.0.0"
+end

data/lib/skap/yaml_file.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Skap
+  class YAMLFile
+    class << self
+      attr_accessor :file_name
+
+      private :file_name=
+    end
+
+    def initialize
+      @file = load_file
+    end
+
+    private
+
+    attr_reader :file
+
+    # @return [Hash<String, Object>]
+    def load_file
+      Psych.load_file(self.class.file_name, symbolize_names: false) || {}
+    end
+  end
+end

data/lib/skap.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "skap/cli"
+require_relative "skap/version"

data/menu.yaml

@@ -0,0 +1,48 @@
+---
+- cmd: help
+  text: "Show help message about supported commands."
+- cmd: ["init", "init DIRECTORY_PATH"]
+  text: "Create configuration files in current directory or in DIRECTORY_PATH."
+- cmd: sources
+  children:
+    - cmd: "add DIRECTORY REPO BRANCH"
+      text: "Add git submodule into DIRECTORY from REPO and track BRANCH by default."
+    - cmd: "delete DIRECTORY"
+      text: "Delete git submodule from DIRECTORY."
+    - cmd: ["update", "update DIRECTORY ..."]
+      text: >
+        Update git submodule from upstream in DIRECTORY or in all git submodules if DIRECTORY
+        is not specified. You may pass one or more directory paths (DIRECTORY ...) to update
+        their contents.
+- cmd: works
+  children:
+    - cmd: ["covered", "covered DIRECTORY ..."]
+      text: >
+        List files of sources which have been used for published works. Pass one or more directory
+        paths (DIRECTORY ...) to show files only in these directories.
+    - cmd: ["ignored", "ignored DIRECTORY ..."]
+      text: >
+        List ignored files. Pass one or more directory paths (DIRECTORY ...) to show files only in
+        these directories.
+    - cmd: ["outdated", "outdated DIRECTORY ..."]
+      text: >
+        List documents which may contain outdated information. Pass one or more directory paths
+        (DIRECTORY ...) to show files only in these directories.
+    - cmd: ["publish DOCUMENT", "publish DOCUMENT FILE_PATH ..."]
+      text:
+        - >
+          Save record about abstract (DOCUMENT) and pass list of file paths of sources
+          (FILE_PATH ...) which relate to this abstract. You should prepend minus sign to file path
+          to exclude it from list of related sources. Examples:
+        - >
+          works publish _/docker/compose.md docs.docker.com/content/manuals/compose/**/*.md
+        - >
+          works publish _/docker/compose.md -docs.docker.com/**/*.md
+    - cmd: ["uncovered", "uncovered DIRECTORY ..."]
+      text: >
+        List files of sources which have NOT been used for published works. Pass one or more
+        directory paths (DIRECTORY ...) to show files only in these directories.
+    - cmd: ["unknown", "unknown DIRECTORY ..."]
+      text: >
+        List files of sources which may be used for works or ignored. Pass one or more directory
+        paths (DIRECTORY ...) to show files only in these directories.

data/skap.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/skap/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "skap"
+  spec.version = Skap::VERSION
+  spec.summary = ""
+  # spec.description = ""
+  spec.authors = ["Evgeniy Nochevnov"]
+  spec.homepage = "https://github.com/crosspath/skap"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
+
+  spec.add_development_dependency("rspec-core", "~> 3.13")
+  spec.add_development_dependency("rspec-expectations", "~> 3.13")
+  spec.add_development_dependency("rubocop", "~> 1.66")
+  spec.add_development_dependency("rubocop-performance", "~> 1.22")
+  spec.add_development_dependency("yard", "~> 0.9")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").grep_v(%r{^spec/})
+    end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: skap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Evgeniy Nochevnov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description:
+email:
+executables:
+- skap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config.template"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/rubocop
+- bin/yard
+- exe/skap
+- lib/skap.rb
+- lib/skap/cli.rb
+- lib/skap/cli/help.rb
+- lib/skap/cli/init.rb
+- lib/skap/cli/sources.rb
+- lib/skap/cli/works.rb
+- lib/skap/command.rb
+- lib/skap/files/menu.rb
+- lib/skap/files/sources.rb
+- lib/skap/files/versions.rb
+- lib/skap/string_utils.rb
+- lib/skap/version.rb
+- lib/skap/yaml_file.rb
+- menu.yaml
+- skap.gemspec
+homepage: https://github.com/crosspath/skap
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/crosspath/skap
+  source_code_uri: https://github.com/crosspath/skap
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.19
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []