asciidoctor-list-content 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10f4720470db26b90ba32f652524acba57e3970da6890497f9e43cac515fa2fc
+  data.tar.gz: 953804b4375bbc24f19e0b452b5e5640ee07861bd1192bc2a64ad912baba49fa
+SHA512:
+  metadata.gz: 8a4f37f62eb062aa4d1d63710813eeb289cec6a9df03a97cbd4b36089338e91f974b2661c97093992c47233a09f4b384ae6fd56c3a6e03034dc206b88d346725
+  data.tar.gz: 05236dd26b112092ebf4c785074ab0b3aa56b7617663ff10cb8d19179971f2062f13c67e2bba2d3c3a7d5d119201134ce3c43106bdef1308197e76a7206ba809

data/AUTHORS

@@ -0,0 +1 @@
+Jaromir Hradilek <jhradilek@gmail.com>

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (C) 2024, 2025 Jaromir Hradilek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# list-content
+
+`list-content` is a simple script that parses an AsciiDoc file and prints all files included in it to standard output.
+
+## Installation
+
+Install the `asciidoctor-list-content` Ruby gem:
+
+```console
+gem install asciidoctor-list-content
+```
+
+## Usage
+
+*   List all AsciiDoc files included in the specified file:
+
+    ```console
+    list-content main.adoc
+    ```
+
+    By default, the files are listed with the path relative to the current working directory. To make the paths relative to a different directory, specify the `--relative-to` or `-r` command-line option:
+
+    ```console
+    list-content --relative-to ../../../ main.adoc
+    ```
+*   Include the name of the specified file on each output line:
+
+    ```console
+    list-content --with-filename main.adoc
+    ```
+
+    This is especially useful if you are running the script of multiple files at the same time:
+
+    ```console
+    list-content --with-filename */main.adoc
+    ```
+
+    By default, the script uses a colon followed by a single space as the separator. If you plan to save the output as a CSV file, specify the `--delimiter` or `-d` command-line option:
+
+    ```console
+    list-content --with-filename --delimiter ',' */main.adoc
+    ```
+*   For a complete list of available options, run the script with the `--help` or `-h` command-line option:
+
+    ```console
+    list-content --help
+    ```
+
+## Copyright
+
+Copyright © 2022, 2025 Jaromir Hradilek
+
+This program is free software, released under the terms of the MIT license. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

data/bin/list-content

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+
+# list-content.rb - list content included in supplied AsciiDoc files
+# Copyright (C) 2022 Jaromir Hradilek
+
+# MIT License
+#
+# Permission  is hereby granted,  free of charge,  to any person  obtaining
+# a copy of  this software  and associated documentation files  (the "Soft-
+# ware"),  to deal in the Software  without restriction,  including without
+# limitation the rights to use,  copy, modify, merge,  publish, distribute,
+# sublicense, and/or sell copies of the Software,  and to permit persons to
+# whom the Software is furnished to do so,  subject to the following condi-
+# tions:
+#
+# The above copyright notice  and this permission notice  shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS
+# OR IMPLIED,  INCLUDING BUT NOT LIMITED TO  THE WARRANTIES OF MERCHANTABI-
+# LITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
+# SHALL THE AUTHORS OR COPYRIGHT HOLDERS  BE LIABLE FOR ANY CLAIM,  DAMAGES
+# OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM,  OUT OF OR IN CONNECTION WITH  THE SOFTWARE  OR  THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+require 'asciidoctor'
+require 'pathname'
+require 'optparse'
+
+# Set the script name and version:
+VERSION = '0.1.1'
+NAME    = File.basename($0)
+
+# Set the current working directory as the defualt starting point for
+# relative paths:
+relpath = Pathname.new(Dir.pwd)
+
+# Do not list images by default:
+images  = false
+
+# Do not include the main file in the output by default:
+with_filename = false
+
+# Do not include the content type determined from the file prefix in the output by default:
+with_prefix = false
+
+# Do not include the content type determined from the attribute in the output by default:
+with_attribute = false
+
+# Use colon as a field delimiter by default:
+delimiter = ': '
+
+# Configure the option parser:
+op = OptionParser.new do |opts|
+  opts.banner  = "Usage: #{NAME} [OPTION...] FILE...\n"
+  opts.banner += "       #{NAME} -h|-v\n\n"
+
+  opts.on('-i', '--images', 'list included images in addition to included files') do
+    images = true
+  end
+
+  opts.on('-f', '--with-filename', 'include the name of the main file in the output') do
+    with_filename = true
+  end
+
+  opts.on('-t', '--with-prefix-type', 'include the content type determined from the file prefix in the output') do
+    with_prefix = true
+  end
+
+  opts.on('-T', '--with-attribute-type', 'include the content type determined from the attribute in the output') do
+    with_attribute = true
+  end
+
+  opts.on('-d', '--delimiter=STRING', "use STRING instead of '#{delimiter}' for field delimiter") do |value|
+    delimiter = value
+  end
+
+  opts.on('-r', '--relative-to=DIR', 'print file paths relative to DIR') do |value|
+    abort "Directory does not exist: #{dir}" if not File.exist?(value)
+    abort "Not a directory: #{dir}" if not File.directory?(value)
+    relpath = Pathname.new(File.expand_path(value))
+  end
+
+  opts.on('-h', '--help', 'display this help and exit') do
+    puts op
+    exit
+  end
+
+  opts.on('-v', '--version', 'display the version and exit') do
+    puts "#{NAME} #{VERSION}"
+    exit
+  end
+end
+
+# Parse command-line options and return the remaining arguments:
+args = op.parse!
+
+# Verify the number of supplied command-line arguments:
+abort "Invalid number of arguments" if args.length < 1
+
+# Process each supplied file:
+args.each do |file|
+  # Verify that the supplied file exists and is readable:
+  abort "File does not exist: #{file}" if not File.exist?(file)
+  abort "Not a file: #{file}" if not File.file?(file)
+  abort "File not readable: #{file}" if not File.readable?(file)
+
+  # Get the adjusted relative path to the supplied file:
+  path = Pathname.new(File.realpath(file)).relative_path_from(relpath)
+
+  # Parse the supplied file:
+  doc = Asciidoctor.load_file(file, doctype: :book, safe: :safe, catalog_assets: true)
+
+  # Print the list of all included files:
+  doc.catalog[:includes].each do |item, _|
+    # Get the adjusted relative path to the included file:
+    include = Pathname.new(File.realpath(File.join(File.dirname(file), "#{item}.adoc"))).relative_path_from(relpath)
+
+    # Print the name of the parent file if requested:
+    print "#{path}#{delimiter}" if with_filename
+
+    # Print the content type from the file prefix if requested:
+    if with_prefix
+      case include.basename.to_s
+        when /^con_/
+          type = 'CONCEPT'
+        when /^proc_/
+          type = 'PROCEDURE'
+        when /^ref_/
+          type = 'REFERENCE'
+        when /^assembly_/
+          type = 'ASSEMBLY'
+        else
+          type = 'NONE'
+      end
+      print "#{type}#{delimiter}"
+    end
+
+    # Print the conent type from the related attribute if requested:
+    if with_attribute
+      type = File.read(include)[/^:_content-type: (.*)$/,1]
+      type = 'NONE' if not type
+      print "#{type}#{delimiter}"
+    end
+
+    # Print the name of the included file:
+    puts include
+  end
+
+  # Skip listing images if not requested:
+  next unless images
+
+  # Print the list of all included images:
+  doc.catalog[:images].each do |image|
+    print "#{path}#{delimiter}" if with_filename
+    print "IMAGE#{delimiter}" if with_prefix
+    print "IMAGE#{delimiter}" if with_attribute
+    puts Pathname.new(File.realpath(File.join(File.dirname(file), image.imagesdir || '', image.target))).relative_path_from(relpath)
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-list-content
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jaromir Hradilek
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: A simple script that parses a supplied AsciiDoc file and prints all files
+  included in it to standard output.
+email: jhradilek@gmail.com
+executables:
+- list-content
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- LICENSE
+- README.md
+- TODO
+- bin/list-content
+homepage: https://github.com/jhradilek/asciidoctor-list-content
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jhradilek/asciidoctor-list-content
+  bug_tracker_uri: https://github.com/jhradilek/asciidoctor-list-content/issues
+  documentation_uri: https://github.com/jhradilek/asciidoctor-list-content/blob/main/README.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: List files included in an AsciiDoc document
+test_files: []