skap 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b24eb7212466fb9d393d5d3847d279bf502c6ea798d5b6169443df4c704949e8
-  data.tar.gz: 5c45d5fd262e0b9ef739f8d4145ca6aab80ada327e2c211b6d7aa0449a2d19c7
+  metadata.gz: 16e74f93e2cb2c5bfb6ec42565f0ee3a276f6d134a63418a98328a259141272e
+  data.tar.gz: a00a345fb79bd667ecde44d7b62fc8933f0f6e131185a740a6a6e30afd78e047
 SHA512:
-  metadata.gz: cf53061aa0925dbc45a03068bf4565f7c6de5fa1033ea946a209667cec3194e16791bd0af89001f1bf66281b811eebe5515bf31eecd605f6071dea4ed05977f8
-  data.tar.gz: 4dff3e1661ea6a77720be3c600add6a5af121c25490f579b1c66f34e7a129a627d4e44928b7ee75bd91da14459d43fb339afde31a7e16b1f0f035fbd0f612cc7
+  metadata.gz: '0908fffd649481ec79c9f772585beacf0b327ff6614dd2da60c9090c77876bb67cd0ec0d4f014b2b0eada4ddc1141c43c9f330c38e612fcfd03bcfa35f1d1459'
+  data.tar.gz: 27c06e31d15c05c3b311854f26f0f01eb8adb23487b79b9c8d8d426b09799d75720a5dd9c7bcaf9e11f33ae4f90c92f4b4e812c5c09529935cb2540fa0a7d248

data/lib/skap/cli.rb

@@ -6,6 +6,7 @@ require "io/console"
 require "psych"
 
 require_relative "command"
+require_relative "string_utils"
 require_relative "yaml_file"
 
 require_relative "files/menu"

data/lib/skap/version.rb

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

data/menu.yaml

@@ -31,8 +31,8 @@
     - 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
+          Save record about work (DOCUMENT) and pass list of file paths of sources
+          (FILE_PATH ...) which relate to this work. 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

data/skap.gemspec

@@ -22,10 +22,7 @@ Gem::Specification.new do |spec|
   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.files = %w[Gemfile menu.yaml skap.gemspec] + Dir.glob("{exe,lib}/**/*", base: __dir__)
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Evgeniy Nochevnov
@@ -87,14 +87,7 @@ executables:
 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

data/.bundle/config.template

@@ -1,7 +0,0 @@
----
-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

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

data/.rubocop.yml

@@ -1,20 +0,0 @@
-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.lock

@@ -1,75 +0,0 @@
-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

@@ -1,119 +0,0 @@
-# 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

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

data/bin/yard

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