skap 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7487b2bdb15b4a94bf5e9f5862eeebaf20f6a23b9e7c3aae850fdf6350283c3
-  data.tar.gz: 55c46f71dd2c1bdf6a04c0160c9cbf378c14ae13dd244606d0c0cd170ff0defb
+  metadata.gz: 64c306b147d5300884174c3d2a4d6c6c51aec457b254304ec8d5d5df1be6b5f4
+  data.tar.gz: a652962929effff42642bcbe13f35c06c6cd787827377ce2e98d8c1909d0e23f
 SHA512:
-  metadata.gz: 849759daeaffebc05744d58df836f6a7da9e703c48d3d273a0180449a0bd82fc911782a7ee1f2df1ad9f6694361e364f5bd6b3704a20d85e778100c72cb98e96
-  data.tar.gz: dc7359b30974a0844520c45c858b178319f5d660e0fe5846de49a1c71c9dd30a69a26f6150462e62edeb459b56173a8962c6db1bd887bf0a683db55e8ec7aaa3
+  metadata.gz: d70210fe51ee5f0fa6f88683679f6995b2d39c07065be89a4bc16499658339e98313940e08b3d4814e1699fab9c043f8bf1ec3e834c162155e535562e145711b
+  data.tar.gz: ecfca637dbb0deb6f68c90e4dfcbffc08a4fc619bd87f7df1d754e7846935a730844c45ea6da7177dec3349912bdd34360b6b737dd39b41253835a09577c1b1a

data/lib/skap/cli/help.rb

@@ -1,58 +1,57 @@
 # frozen_string_literal: true
 
-module Skap
-  module CLI::Help
-    include Command
-    extend self
+# CLI command with help message.
+module Skap::CLI::Help
+  include Skap::Command
+  extend self
 
-    # @return [void]
-    def start
-      menu = Files::Menu.new
+  # @return [void]
+  def start
+    menu = Skap::Files::Menu.new
 
-      puts "Usage:", ""
+    puts "Usage:", ""
 
-      show_menu(menu, $DEFAULT_OUTPUT.winsize.last)
-    end
-
-    private
+    show_menu(menu, $DEFAULT_OUTPUT.winsize.last)
+  end
 
-    # @param text [String]
-    # @param indent [String]
-    # @param max_width [Integer]
-    # @return [void]
-    def output_menu_item_text(text, indent, max_width)
-      res = []
+  private
 
-      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
+  # @param text [String]
+  # @param indent [String]
+  # @param max_width [Integer]
+  # @return [void]
+  def output_menu_item_text(text, indent, max_width)
+    res = []
 
-      res.each { |line| puts "#{indent}#{line}" }
+    if text.is_a?(Array)
+      text.each { |paragraph| res += Skap::StringUtils.break_by_words(paragraph, max_width) }
+    else
+      res += Skap::StringUtils.break_by_words(text, max_width)
     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
+    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"]
+    menu.each do |item|
+      puts item["cmd"]
 
-        output_menu_item_text(item["text"], section_indent, within_section) if item.key?("text")
+      output_menu_item_text(item["text"], section_indent, within_section) if item.key?("text")
 
-        next unless item.key?("children")
+      next unless item.key?("children")
 
-        item["children"].each do |subitem|
-          [*subitem["cmd"]].each { |cmd| puts "#{section_indent}#{cmd}" }
+      item["children"].each do |subitem|
+        [*subitem["cmd"]].each { |cmd| puts "#{section_indent}#{cmd}" }
 
-          output_menu_item_text(subitem["text"], command_indent, within_command)
-        end
+        output_menu_item_text(subitem["text"], command_indent, within_command)
       end
     end
   end

data/lib/skap/cli/init.rb

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

data/lib/skap/cli/sources.rb

@@ -1,62 +1,61 @@
 # 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
+# CLI command for managing sources list.
+module Skap::CLI::Sources
+  include Skap::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
+  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)
+  # @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}")
+    return unless shell("git submodule add -b #{branch} --depth 3 -- #{repo} #{dir}")
 
-      Files::Sources.new.add_source(dir)
-    end
+    Skap::Files::Sources.new.add_source(dir)
+  end
 
-    # @param dir [String]
-    # @param rest [Array<String>]
-    # @return [void]
-    def delete(dir, *rest)
-      assert_empty_options(rest)
+  # @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}")
+    shell("git submodule deinit -f -- #{dir} && git rm -f #{dir} && rm -rf .git/modules/#{dir}")
 
-      Files::Sources.new.delete_source(dir)
-    end
+    Skap::Files::Sources.new.delete_source(dir)
+  end
 
-    # @param dirs [Array<String>]
-    # @return [void]
-    def update(*dirs)
-      path_arg = dirs.empty? ? "" : "-- #{dirs.join(" ")}"
+  # @param dirs [Array<String>]
+  # @return [void]
+  def update(*dirs)
+    path_arg = dirs.empty? ? "" : "-- #{dirs.join(" ")}"
 
-      commands = [
-        "git submodule init",
-        "git submodule update --checkout --single-branch --recursive #{path_arg}",
-      ]
+    commands = [
+      "git submodule init",
+      "git submodule update --checkout --single-branch --recursive #{path_arg}",
+    ]
 
-      shell(commands.join(" && "))
-    end
+    shell(commands.join(" && "))
   end
 end

data/lib/skap/cli/version.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-module Skap
-  module CLI::Version
-    include Command
-    extend self
+# CLI command for showing Skap version.
+module Skap::CLI::Version
+  include Skap::Command
+  extend self
 
-    # @return [void]
-    def start
-      puts "Skap, v#{Skap::VERSION}"
-    end
+  # @return [void]
+  def start
+    puts "Skap, v#{Skap::VERSION}"
   end
 end

data/lib/skap/cli/works.rb

@@ -1,175 +1,174 @@
 # 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
+# CLI command for managing works (files based on sources).
+module Skap::CLI::Works
+  include Skap::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
+  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
+  # @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 path [String]
+  # @return [String]
+  def commit_sha(path)
+    dir, file = File.split(path)
 
-    # @param dirs [Array<String>]
-    # @return [void]
-    def covered(*dirs)
-      sources = Files::Sources.new.extract("indexed", dir_names_without_slash(dirs))
+    shell("git rev-parse HEAD -- #{file}", dir:).split("\n").first
+  end
 
-      puts (Files::Versions.new.covered_sources & collect_files(sources)).sort
-    end
+  # @param dirs [Array<String>]
+  # @return [void]
+  def covered(*dirs)
+    sources = Skap::Files::Sources.new.extract("indexed", dir_names_without_slash(dirs))
 
-    # @param dirs [Array<String>]
-    # @return [Array<String>]
-    def dir_names_with_slash(dirs)
-      dirs.map { |x| x.end_with?("/") ? x : "#{x}/" }
-    end
+    puts (Skap::Files::Versions.new.covered_sources & collect_files(sources)).sort
+  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 dirs [Array<String>]
+  # @return [Array<String>]
+  def dir_names_with_slash(dirs)
+    dirs.map { |x| x.end_with?("/") ? x : "#{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?
+  # @param dirs [Array<String>]
+  # @return [Array<String>]
+  def dir_names_without_slash(dirs)
+    dirs.map { |x| x.end_with?("/") ? x.chop : x }
+  end
 
-        result
-      else
-        raise ArgumentError, "File \"#{path_pattern}\" doesn't exist" if !File.exist?(path_pattern)
+  # @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?
 
-        path_pattern
-      end
-    end
+      result
+    else
+      raise ArgumentError, "File \"#{path_pattern}\" doesn't exist" if !File.exist?(path_pattern)
 
-    # @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) } }
+      path_pattern
     end
+  end
 
-    # @param dirs [Array<String>]
-    # @return [void]
-    def ignored(*dirs)
-      sources = Files::Sources.new.extract("ignored", dir_names_without_slash(dirs))
+  # @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
 
-      puts collect_files(sources).sort
-    end
+  # @param dirs [Array<String>]
+  # @return [void]
+  def ignored(*dirs)
+    sources = Skap::Files::Sources.new.extract("ignored", dir_names_without_slash(dirs))
 
-    # @param dirs [Array<String>]
-    # @return [void]
-    def outdated(*dirs)
-      dirs = dir_names_with_slash(dirs)
+    puts collect_files(sources).sort
+  end
 
-      outdated_documents =
-        Files::Versions.new.outdated_documents do |source_path|
-          dirs.empty? || source_path.start_with?(*dirs) ? commit_sha(source_path) : nil
-        end
+  # @param dirs [Array<String>]
+  # @return [void]
+  def outdated(*dirs)
+    dirs = dir_names_with_slash(dirs)
 
-      outdated_documents.each do |(doc_path, outdated_sources)|
-        puts doc_path, outdated_sources.map { |x| "* #{x}" }, ""
+    outdated_documents =
+      Skap::Files::Versions.new.outdated_documents do |source_path|
+        dirs.empty? || source_path.start_with?(*dirs) ? commit_sha(source_path) : nil
       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
+    outdated_documents.each do |(doc_path, outdated_sources)|
+      puts doc_path, outdated_sources.map { |x| "* #{x}" }, ""
+    end
+  end
 
-      excluded_file_paths.map! { |x| x[1..] }
+  # @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
 
-      versions = Files::Versions.new
-      doc = versions.find_document(document_path) || {}
+    excluded_file_paths.map! { |x| x[1..] }
 
-      update_document_info(doc, added_file_paths, excluded_file_paths)
-      versions.add_document(document_path, doc)
+    versions = Skap::Files::Versions.new
+    doc = versions.find_document(document_path) || {}
 
-      puts "Version updated for #{document_path} in #{Files::Versions.file_name}"
-    end
+    update_document_info(doc, added_file_paths, excluded_file_paths)
+    versions.add_document(document_path, doc)
 
-    # @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
+    puts "Version updated for #{document_path} in #{Skap::Files::Versions.file_name}"
+  end
 
-    # @param dirs [Array<String>]
-    # @return [void]
-    def uncovered(*dirs)
-      sources = Files::Sources.new.extract("indexed", dir_names_without_slash(dirs))
+  # @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
 
-      puts (collect_files(sources) - Files::Versions.new.covered_sources.to_a).sort
-    end
+  # @param dirs [Array<String>]
+  # @return [void]
+  def uncovered(*dirs)
+    sources = Skap::Files::Sources.new.extract("indexed", dir_names_without_slash(dirs))
 
-    # @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?
+    puts (collect_files(sources) - Skap::Files::Versions.new.covered_sources.to_a).sort
+  end
 
-      all_files = trackable_files(sources_data)
-      ignored_files = collect_files(sources_data.extract("ignored"))
-      indexed_files = collect_files(sources_data.extract("indexed"))
+  # @param dirs [Array<String>]
+  # @return [void]
+  def unknown(*dirs)
+    sources_data = Skap::Files::Sources.new
+    sources_data.select_directories!(dir_names_without_slash(dirs)) if !dirs.empty?
 
-      puts (all_files - ignored_files - indexed_files).sort
-    end
+    all_files = trackable_files(sources_data)
+    ignored_files = collect_files(sources_data.extract("ignored"))
+    indexed_files = collect_files(sources_data.extract("indexed"))
 
-    # @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")
+    puts (all_files - ignored_files - indexed_files).sort
+  end
 
-      doc["date"] = today
-      doc["sources"] ||= {}
+  # @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")
 
-      added_file_paths.each do |path|
-        entry = (doc["sources"][path] ||= {})
-        entry["date"] = today
-        entry["sha"] = commit_sha(path)
-      end
+    doc["date"] = today
+    doc["sources"] ||= {}
 
-      excluded_file_paths.each { |x| doc["sources"].delete(x) }
+    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

data/lib/skap/cli.rb

@@ -13,22 +13,21 @@ 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
+# Dispatcher for CLI commands.
+module Skap::CLI
+  # @param argv [Array<String>]
+  # @return [void]
+  def self.start(argv = ARGV)
+    section, command, *rest = argv
 
-      case section
-      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)
-      when "version", "--version", "-v" then CLI::Version.start
-      when "works" then CLI::Works.start(command, rest)
-      else
-        raise ArgumentError, "Unknown section: #{section}"
-      end
+    case section
+    when "help", "--help", "-h", nil then Skap::CLI::Help.start
+    when "init" then Skap::CLI::Init.start(command, rest)
+    when "sources" then Skap::CLI::Sources.start(command, rest)
+    when "version", "--version", "-v" then Skap::CLI::Version.start
+    when "works" then Skap::CLI::Works.start(command, rest)
+    else
+      raise ArgumentError, "Unknown section: #{section}"
     end
   end
 end

data/lib/skap/command.rb

@@ -1,28 +1,27 @@
 # frozen_string_literal: true
 
-module Skap
-  module Command
-    CURRENT_DIR = Dir.pwd.freeze
+# Common class for CLI command.
+module Skap::Command
+  CURRENT_DIR = Dir.pwd.freeze
 
-    private
+  private
 
-    # @return [void]
-    def assert_cwd
-      raise "Current dir isn't a repo for sources" if !File.exist?(Files::Sources.file_name)
-    end
+  # @return [void]
+  def assert_cwd
+    raise "Current dir isn't a repo for sources" if !File.exist?(Skap::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 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
+  # @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

data/lib/skap/files/menu.rb

@@ -2,16 +2,13 @@
 
 require "forwardable"
 
-module Skap
-  module Files
-    class Menu < YAMLFile
-      extend Forwardable
+# Class for file "menu.yaml" (this file is part of Skap).
+class Skap::Files::Menu < Skap::YAMLFile
+  extend Forwardable
 
-      SKAP_DIR = File.expand_path("../../..", __dir__).freeze
+  SKAP_DIR = File.expand_path("../../..", __dir__).freeze
 
-      self.file_name = File.join(SKAP_DIR, "menu.yaml")
+  self.file_name = File.join(SKAP_DIR, "menu.yaml")
 
-      def_delegators :file, :each
-    end
-  end
+  def_delegators :file, :each
 end

data/lib/skap/files/sources.rb

@@ -1,41 +1,38 @@
 # frozen_string_literal: true
 
-module Skap
-  module Files
-    class Sources < YAMLFile
-      self.file_name = "sources.yaml"
+# Class for file "sources.yaml" (this file describes sources in project repository).
+class Skap::Files::Sources < Skap::YAMLFile
+  self.file_name = "sources.yaml"
 
-      # @param dir [String]
-      # @return [void]
-      def add_source(dir)
-        file[dir] = {"file-extensions" => [], "ignored" => [], "indexed" => []}
-        @file = file.sort_by(&:first).to_h
+  # @param dir [String]
+  # @return [void]
+  def add_source(dir)
+    file[dir] = {"file-extensions" => [], "ignored" => [], "indexed" => []}
+    @file = file.sort_by(&:first).to_h
 
-        update_file
-      end
+    update_file
+  end
 
-      # @param dir [String]
-      # @return [void]
-      def delete_source(dir)
-        file.delete(dir)
-        update_file
-      end
+  # @param dir [String]
+  # @return [void]
+  def delete_source(dir)
+    file.delete(dir)
+    update_file
+  end
 
-      # @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 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
+  # @param dirs [Array<String>]
+  # @return [Hash<String, Hash<String, Array<String>>>]
+  def select_directories!(dirs)
+    @file = file.slice(*dirs)
   end
 end

data/lib/skap/files/versions.rb

@@ -1,48 +1,45 @@
 # 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
-
-        update_file
-      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?
+# Class for file "versions.yaml" (this file describes versions of works in project repository).
+class Skap::Files::Versions < Skap::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
+
+    update_file
+  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
-      end
+      [doc_path, outdated_sources] if !outdated_sources.empty?
     end
   end
 end

data/lib/skap/string_utils.rb

@@ -1,49 +1,48 @@
 # 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
+# Manipulations with strings.
+module Skap::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.pop if parts.last.empty?
 
-      parts.map { |line| line.join(" ") }
-    end
+    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
 
-    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
+      if new_line_width == max_width
+        parts << []
+        0
       else
-        parts << [word]
-        word.size
+        new_line_width
       end
+    else
+      parts << [word]
+      word.size
     end
   end
 end

data/lib/skap/version.rb

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

data/lib/skap/yaml_file.rb

@@ -1,29 +1,28 @@
 # frozen_string_literal: true
 
-module Skap
-  class YAMLFile
-    class << self
-      attr_accessor :file_name
+# Common class for reading & updating YAML files.
+class Skap::YAMLFile
+  class << self
+    attr_accessor :file_name
 
-      private :file_name=
-    end
+    private :file_name=
+  end
 
-    def initialize
-      @file = load_file
-    end
+  def initialize
+    @file = load_file
+  end
 
-    private
+  private
 
-    attr_reader :file
+  attr_reader :file
 
-    # @return [Hash<String, Object>]
-    def load_file
-      Psych.load_file(self.class.file_name, symbolize_names: false) || {}
-    end
+  # @return [Hash<String, Object>]
+  def load_file
+    Psych.load_file(self.class.file_name, symbolize_names: false) || {}
+  end
 
-    # @return [void]
-    def update_file
-      File.write(self.class.file_name, Psych.dump(file, line_width: 100))
-    end
+  # @return [void]
+  def update_file
+    File.write(self.class.file_name, Psych.dump(file, line_width: 100))
   end
 end

data/lib/skap.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
+# Skap, document management system.
+module Skap
+  # Class wrappers for files with settings.
+  module Files
+  end
+end
+
 require_relative "skap/cli"
 require_relative "skap/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skap
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Evgeniy Nochevnov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: ''