asciidoctor-list-content 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10f4720470db26b90ba32f652524acba57e3970da6890497f9e43cac515fa2fc
-  data.tar.gz: 953804b4375bbc24f19e0b452b5e5640ee07861bd1192bc2a64ad912baba49fa
+  metadata.gz: d159dbea869af6eea5834a4b8d3b92f39034dce7090cff97c1cd8e1c9585757e
+  data.tar.gz: 9769823625e20bffa86d71b58bd787a8b5e5e0a2765a12449af492e537f18fcb
 SHA512:
-  metadata.gz: 8a4f37f62eb062aa4d1d63710813eeb289cec6a9df03a97cbd4b36089338e91f974b2661c97093992c47233a09f4b384ae6fd56c3a6e03034dc206b88d346725
-  data.tar.gz: 05236dd26b112092ebf4c785074ab0b3aa56b7617663ff10cb8d19179971f2062f13c67e2bba2d3c3a7d5d119201134ce3c43106bdef1308197e76a7206ba809
+  metadata.gz: 184791ac163885f54292b2e6c6e37aea1bf9dcaf4266d646a549cee5009c7693ce0571a46f502addfff5afcac7ee838cba1c359469551aad1a5ed0a3446383dc
+  data.tar.gz: 9c2b3ac3154a434104567fdafee85d0693324c1335efba62a29e8b6553af30878dbeefe1a294c194144182ffb24294278f4c58ce9c4130a8e1b12e155b2af9d1

data/README.md

@@ -48,6 +48,6 @@ gem install asciidoctor-list-content
 
 ## Copyright
 
-Copyright © 2022, 2025 Jaromir Hradilek
+Copyright © 2022, 2026 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

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # list-content.rb - list content included in supplied AsciiDoc files
-# Copyright (C) 2022 Jaromir Hradilek
+# Copyright (C) 2022, 2026 Jaromir Hradilek
 
 # MIT License
 #
@@ -29,7 +29,7 @@ require 'pathname'
 require 'optparse'
 
 # Set the script name and version:
-VERSION = '0.1.1'
+VERSION = '0.1.2'
 NAME    = File.basename($0)
 
 # Set the current working directory as the defualt starting point for
@@ -77,8 +77,8 @@ op = OptionParser.new do |opts|
   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)
+    abort "#{NAME}: Directory does not exist: #{dir}" if not File.exist?(value)
+    abort "#{NAME}: Not a directory: #{dir}" if not File.directory?(value)
     relpath = Pathname.new(File.expand_path(value))
   end
 
@@ -94,68 +94,82 @@ op = OptionParser.new do |opts|
 end
 
 # Parse command-line options and return the remaining arguments:
-args = op.parse!
+begin
+  args = op.parse!
+rescue OptionParser::InvalidArgument, OptionParser::InvalidOption,
+       OptionParser::AmbiguousOption, OptionParser::MissingArgument => error
+  abort "#{NAME}: #{error.message}"
+end
 
 # 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'
+abort "#{NAME}: Invalid number of arguments" if args.length < 1
+
+begin
+  # Process each supplied file:
+  args.each do |file|
+    # Verify that the supplied file exists and is readable:
+    abort "#{NAME}: File does not exist: #{file}" if not File.exist?(file)
+    abort "#{NAME}: Not a file: #{file}" if not File.file?(file)
+    abort "#{NAME}: 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: :unsafe, catalog_assets: true)
+
+    # Print the list of all included files:
+    doc.catalog[:includes].each do |item, _|
+      # Start composing the resulting output:
+      result = ''
+
+      # 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:
+      result << "#{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'
+          when /^snip[_-]/
+            type = 'SNIPPET'
+          else
+            type = 'NONE'
+        end
+        result << "#{type}#{delimiter}"
       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 conent type from the related attribute if requested:
+      if with_attribute
+        type = File.read(include)[/^:_(?:mod-docs-content|content|module)-type: (.*)$/,1]
+        type = 'NONE' if not type
+        result << "#{type}#{delimiter}"
+      end
 
-    # Print the name of the included file:
-    puts include
-  end
+      # Print the name of the included file:
+      puts result << include.to_s
+    end
 
-  # Skip listing images if not requested:
-  next unless images
+    # 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)
+    # 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
+rescue Interrupt
+  exit 130
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-list-content
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jaromir Hradilek
@@ -63,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.10
 specification_version: 4
 summary: List files included in an AsciiDoc document
 test_files: []