Document UnpackStrategy.

Library/Homebrew/unpack_strategy.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+# Module containing all available strategies for unpacking archives.
+#
+# @api private
 module UnpackStrategy
+  # Helper module for identifying the file type.
   module Magic
-    # length of the longest regex (currently Tar)
+    # Length of the longest regex (currently Tar).
     MAX_MAGIC_NUMBER_LENGTH = 262
 
     refine Pathname do
@@ -31,18 +35,18 @@ module UnpackStrategy
 
   def self.strategies
     @strategies ||= [
-      Tar, # needs to be before Bzip2/Gzip/Xz/Lzma
+      Tar, # Needs to be before Bzip2/Gzip/Xz/Lzma.
       Pax,
       Gzip,
       Lzma,
       Xz,
       Lzip,
-      Air, # needs to be before Zip
-      Jar, # needs to be before Zip
-      LuaRock, # needs to be before Zip
-      MicrosoftOfficeXml, # needs to be before Zip
+      Air, # Needs to be before `Zip`.
+      Jar, # Needs to be before `Zip`.
+      LuaRock, # Needs to be before `Zip`.
+      MicrosoftOfficeXml, # Needs to be before `Zip`.
       Zip,
-      Pkg, # needs to be before Xar
+      Pkg, # Needs to be before `Xar`.
       Xar,
       Ttf,
       Otf,
@@ -50,10 +54,10 @@ module UnpackStrategy
       Mercurial,
       Subversion,
       Cvs,
-      SelfExtractingExecutable, # needs to be before Cab
+      SelfExtractingExecutable, # Needs to be before `Cab`.
       Cab,
       Executable,
-      Dmg, # needs to be before Bzip2
+      Dmg, # Needs to be before `Bzip2`.
       Bzip2,
       Fossil,
       Bazaar,

Library/Homebrew/unpack_strategy/air.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking Adobe Air archives.
   class Air
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/bazaar.rb

@@ -3,6 +3,7 @@
 require_relative "directory"
 
 module UnpackStrategy
+  # Strategy for unpacking Bazaar archives.
   class Bazaar < Directory
     using Magic
 

Library/Homebrew/unpack_strategy/bzip2.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking bzip2 archives.
   class Bzip2
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/cab.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking Cabinet archives.
   class Cab
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/compress.rb

@@ -3,6 +3,7 @@
 require_relative "tar"
 
 module UnpackStrategy
+  # Strategy for unpacking compress archives.
   class Compress < Tar
     using Magic
 

Library/Homebrew/unpack_strategy/cvs.rb

@@ -3,6 +3,7 @@
 require_relative "directory"
 
 module UnpackStrategy
+  # Strategy for unpacking CVS repositories.
   class Cvs < Directory
     using Magic
 

Library/Homebrew/unpack_strategy/directory.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking directories.
   class Directory
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/dmg.rb

@@ -3,9 +3,11 @@
 require "tempfile"
 
 module UnpackStrategy
+  # Strategy for unpacking disk images.
   class Dmg
     include UnpackStrategy
 
+    # Helper module for listing the contents of a volume mounted from a disk image.
     module Bom
       DMG_METADATA = Set.new(%w[
                                .background
@@ -23,11 +25,12 @@ module UnpackStrategy
       private_constant :DMG_METADATA
 
       refine Pathname do
+        # Check if path is considered disk image metadata.
         def dmg_metadata?
           DMG_METADATA.include?(cleanpath.ascend.to_a.last.to_s)
         end
 
-        # symlinks to system directories (commonly to /Applications)
+        # Check if path is a symlink to a system directory (commonly to /Applications).
         def system_dir_symlink?
           symlink? && MacOS.system_dir?(dirname.join(readlink))
         end
@@ -48,9 +51,9 @@ module UnpackStrategy
     end
     private_constant :Bom
 
-    using Bom
-
+    # Strategy for unpacking a volume mounted from a disk image.
     class Mount
+      using Bom
       include UnpackStrategy
 
       def eject(verbose: false)

Library/Homebrew/unpack_strategy/executable.rb

@@ -3,6 +3,7 @@
 require_relative "uncompressed"
 
 module UnpackStrategy
+  # Strategy for unpacking executables.
   class Executable < Uncompressed
     using Magic
 

Library/Homebrew/unpack_strategy/fossil.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking Fossil repositories.
   class Fossil
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/generic_unar.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking archives with `unar`.
   class GenericUnar
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/git.rb

@@ -3,6 +3,7 @@
 require_relative "directory"
 
 module UnpackStrategy
+  # Strategy for unpacking Git repositories.
   class Git < Directory
     using Magic
 

Library/Homebrew/unpack_strategy/gzip.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking gzip archives.
   class Gzip
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/jar.rb

@@ -3,6 +3,7 @@
 require_relative "uncompressed"
 
 module UnpackStrategy
+  # Strategy for unpacking Java archives.
   class Jar < Uncompressed
     using Magic
 

Library/Homebrew/unpack_strategy/lha.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking LHa archives.
   class Lha
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/lua_rock.rb

@@ -3,6 +3,7 @@
 require_relative "uncompressed"
 
 module UnpackStrategy
+  # Strategy for unpacking LuaRock archives.
   class LuaRock < Uncompressed
     using Magic
 

Library/Homebrew/unpack_strategy/lzip.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking lzip archives.
   class Lzip
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/lzma.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking LZMA archives.
   class Lzma
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/mercurial.rb

@@ -3,6 +3,7 @@
 require_relative "directory"
 
 module UnpackStrategy
+  # Strategy for unpacking Mercurial repositories.
   class Mercurial < Directory
     using Magic
 

Library/Homebrew/unpack_strategy/microsoft_office_xml.rb

@@ -3,6 +3,7 @@
 require_relative "uncompressed"
 
 module UnpackStrategy
+  # Strategy for unpacking Microsoft Office documents.
   class MicrosoftOfficeXml < Uncompressed
     using Magic
 

Library/Homebrew/unpack_strategy/otf.rb

@@ -3,6 +3,7 @@
 require_relative "uncompressed"
 
 module UnpackStrategy
+  # Strategy for unpacking OpenType fonts.
   class Otf < Uncompressed
     using Magic
 

Library/Homebrew/unpack_strategy/p7zip.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking P7ZIP archives.
   class P7Zip
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/pax.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking pax archives.
   class Pax
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/pkg.rb

@@ -3,6 +3,7 @@
 require_relative "uncompressed"
 
 module UnpackStrategy
+  # Strategy for unpacking macOS package installers.
   class Pkg < Uncompressed
     using Magic
 

Library/Homebrew/unpack_strategy/rar.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking RAR archives.
   class Rar
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/self_extracting_executable.rb

@@ -3,6 +3,7 @@
 require_relative "generic_unar"
 
 module UnpackStrategy
+  # Strategy for unpacking self-extracting executables.
   class SelfExtractingExecutable < GenericUnar
     using Magic
 

Library/Homebrew/unpack_strategy/sit.rb

@@ -3,6 +3,7 @@
 require_relative "generic_unar"
 
 module UnpackStrategy
+  # Strategy for unpacking Stuffit archives.
   class Sit < GenericUnar
     using Magic
 

Library/Homebrew/unpack_strategy/subversion.rb

@@ -3,6 +3,7 @@
 require_relative "directory"
 
 module UnpackStrategy
+  # Strategy for unpacking Subversion repositories.
   class Subversion < Directory
     using Magic
 

Library/Homebrew/unpack_strategy/tar.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking tar archives.
   class Tar
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/ttf.rb

@@ -3,6 +3,7 @@
 require_relative "uncompressed"
 
 module UnpackStrategy
+  # Strategy for unpacking TrueType fonts.
   class Ttf < Uncompressed
     using Magic
 

Library/Homebrew/unpack_strategy/uncompressed.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking uncompressed files.
   class Uncompressed
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/xar.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking xar archives.
   class Xar
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/xz.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking xz archives.
   class Xz
     include UnpackStrategy
 

Library/Homebrew/unpack_strategy/zip.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module UnpackStrategy
+  # Strategy for unpacking ZIP archives.
   class Zip
     include UnpackStrategy