wordlist 1.0.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e732c8a8b2aa358e9c21c46fd9b5f509b5aeef52d51477ceb49111f94a4102d
-  data.tar.gz: 0cb119f423d984b5538b5547f972a7c6c54e1e96e52e461acf3ba13328e8f4d5
+  metadata.gz: 8257ee6c587ba685ac202f3c4839739312397c00b85af8b3a954fac4d889bf25
+  data.tar.gz: d75c4cd68b7d3eb5e05399b8f38d155cadd6dd6caeb06787c84e1872e9cf8467
 SHA512:
-  metadata.gz: b060a80fafcd2e24a1771537030085d19b70722b8436a62e810b2cc2ab876ac3c132b036d625ae496b2b2c2f18c11a75761b0ab6933878a29207f28cfb1b8a73
-  data.tar.gz: edef70fcf4bbcf6ab3d0ff4f78281bd4c1edca5535c057a515f662c5cd0efcae254a492d301d7d583ac622c0177961c3b028c2431d94a95da3d03116579824f1
+  metadata.gz: 23f77e8df9ad6a77fa21df3d47840b0938d5b562473ec40abd1823e21c06f3d456a0af28685cbc1522684948da798afc8287c13d5fe674c119ed53e9f715fd4e
+  data.tar.gz: 9e41f171d870b0b2868697407669bcb20a48e110b4ed6a7739cae09faba75ce42b634723793b403724bdd3acf557d74c9d7787a4f34de12646886e204a242a93

data/.github/workflows/ruby.yml

@@ -12,21 +12,26 @@ jobs:
           - ubuntu-latest
           - macos-latest
         ruby:
-          - 2.6
-          - 2.7
-          - 3.0
-          - 3.1
-          - 3.2
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
           - jruby
           - truffleruby
     name: OS ${{ matrix.os }} / Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Install dependencies
+      - if: matrix.os == 'ubuntu-latest'
+        name: Install external dependencies
+        run: sudo apt-get install -y xz-utils unzip p7zip
+      - if: matrix.os == 'macos-latest'
+        name: Install external dependencies
+        run: brew install xz unzip p7zip
+      - name: Install Ruby dependencies
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test

data/ChangeLog.md

@@ -1,3 +1,17 @@
+### 1.1.1 / 2024-01-23
+
+* Switched to using `require_relative` to improve load-times.
+
+### 1.1.0 / 2023-09-12
+
+* Added support for reading zip (`.zip`) and 7zip (`.7z`) compressed wordlist
+  files.
+* Added support for building zip or 7zip compressed wordlist files.
+
+#### CLI
+
+* `-f,--format` now accepts `zip` and `7zip` format values.
+
 ### 1.0.3 / 2023-08-04
 
 * Fix reading of compressed wordlists on macOS.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2023 Hal Brodigan
+Copyright (c) 2009-2024 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -15,10 +15,10 @@ building wordlists, efficiently.
 
 ## Features
 
-* Supports reading `.txt` wordlists, and `.txt.gz`, `.txt.bz2`, and `.txt.xz`
+* Supports reading `.txt` wordlists, and `.gz`, `.bz2`, `.xz`, `.zip`, and `.7z`
   compressed wordlists.
 * Supports building wordlists from arbitrary text. Also supports `.gz`, `.bz2,`
-  and `.xz` compression.
+  `.xz`, `.zip`, and `.7z` compression.
 * Provides an advanced lexer for parsing text into words.
   * Can parse/skip digits, special characters, whole numbers, acronyms.
   * Can normalize case, apostrophes, and acronyms.
@@ -223,7 +223,12 @@ builder.parse_file(path)
 
 ## Requirements
 
-* [ruby] >= 2.0.0
+* [ruby] >= 3.0.0
+* `zcat`/`gzip` (for reading/writing `.gz` wordlists)
+* `bzcat`/`bzip2` (for reading/writing `.bz2` wordlists)
+* `xzcat`/`xz` (for reading/writing `.xz` wordlists)
+* `unzip`/`zip` (for reading/writing `.zip` wordlists)
+* `7za` (for reading/writing `.7z` wordlists)
 
 [ruby]: https://www.ruby-lang.org/
 
@@ -247,6 +252,59 @@ gem 'wordlist', '~> 1.0'
 
 ### Synopsis
 
+```
+usage: wordlist { [options] WORDLIST ... | --build WORDLIST [FILE ...] }
+
+Wordlist Reading Options:
+    -f {txt|gzip|bz2|xz|zip|7zip},   Sets the desired wordlist format
+        --format
+        --exec COMMAND               Runs the command with each word from the wordlist.
+                                     The string "{}" will be replaced with each word.
+
+Wordlist Operations:
+    -U, --union WORDLIST             Unions the wordlist with the other WORDLIST
+    -I, --intersect WORDLIST         Intersects the wordlist with the other WORDLIST
+    -S, --subtract WORDLIST          Subtracts the words from the WORDLIST
+    -p, --product WORDLIST           Combines every word with the other words from WORDLIST
+    -P, --power NUM                  Combines every word with the other words from WORDLIST
+    -u, --unique                     Filters out duplicate words
+
+Wordlist Modifiers:
+    -C, --capitalize                 Capitalize each word
+        --uppercase, --upcase        Converts each word to UPPERCASE
+        --lowercase, --downcase      Converts each word to lowercase
+    -t, --tr CHARS:REPLACE           Translates the characters of each word
+    -s, --sub PATTERN:SUB            Replaces PATTERN with SUB in each word
+    -g, --gsub PATTERN:SUB           Replaces all PATTERNs with SUB in each word
+    -m, --mutate PATTERN:SUB         Performs every possible substitution on each word
+    -M, --mutate-case                Switches the case of each letter in each word
+
+Wordlist Building Options:
+    -b, --build WORDLIST             Builds a wordlist
+    -a, --[no-]append                Appends to the new wordlist instead of overwriting it
+    -L, --lang LANG                  The language to expect
+        --stop-words WORDS...        Ignores the stop words
+        --ignore-words WORDS...      Ignore the words
+        --[no-]digits                Allow digits in the middle of words
+        --special-chars CHARS        Allows the given special characters inside of words
+        --[no-]numbers               Parses whole numbers in addition to words
+        --[no-]acronyms              Parses acronyms in addition to words
+        --[no-]normalize-case        Converts all words to lowercase
+        --[no-]normalize-apostrophes Removes "'s" from words
+        --[no-]normalize-acronyms    Removes the dots from acronyms
+
+General Options:
+    -V, --version                    Print the version
+    -h, --help                       Print the help output
+
+Examples:
+    wordlist rockyou.txt.gz
+    wordlist passwords_short.txt passwords_long.txt
+    wordlist sport_teams.txt -p beers.txt -p digits.txt
+    cat *.txt | wordlist --build custom.txt
+
+```
+
 Reading a wordlist:
 
 ```shell

data/gemspec.yml

@@ -8,7 +8,7 @@ description:
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: https://github.com/postmodern/wordlist.rb
+homepage: https://github.com/postmodern/wordlist.rb#readme
 has_yard: true
 
 metadata:
@@ -17,7 +17,7 @@ metadata:
   bug_tracker_uri:   https://github.com/postmodern/wordlist.rb/issues
   changelog_uri:     https://github.com/postmodern/wordlist.rb/blob/master/ChangeLog.md
 
-required_ruby_version: ">= 2.0.0"
+required_ruby_version: ">= 3.0.0"
 
 development_dependencies:
   bundler: ~> 2.0

data/lib/wordlist/abstract_wordlist.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/list_methods'
+require_relative 'list_methods'
 
 module Wordlist
   #

data/lib/wordlist/builder.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require 'wordlist/format'
-require 'wordlist/lexer'
-require 'wordlist/unique_filter'
-require 'wordlist/file'
-require 'wordlist/compression/writer'
+require_relative 'format'
+require_relative 'lexer'
+require_relative 'unique_filter'
+require_relative 'file'
+require_relative 'compression/writer'
 
 module Wordlist
   #
@@ -22,7 +22,7 @@ module Wordlist
 
     # The format of the wordlist file.
     #
-    # @return [:txt, :gzip, :bzip2, :xz]
+    # @return [:txt, :gzip, :bzip2, :xz, :zip, :7zip]
     attr_reader :format
 
     # The word lexer.
@@ -41,7 +41,7 @@ module Wordlist
     # @param [String] path
     #   The path of the wordlist file.
     #
-    # @param [:txt, :gz, :bzip2, :xz, nil] format
+    # @param [:txt, :gz, :bzip2, :xz, :zip, :7zip, nil] format
     #   The format of the wordlist. If not given the format will be inferred
     #   from the file extension.
     #

data/lib/wordlist/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'wordlist/file'
-require 'wordlist/builder'
-require 'wordlist/version'
+require_relative 'file'
+require_relative 'builder'
+require_relative 'version'
 
 require 'optparse'
 
@@ -26,7 +26,9 @@ module Wordlist
       'txt'  => :txt,
       'gzip' => :gzip,
       'bzip2'=> :bzip2,
-      'xz'   => :xz
+      'xz'   => :xz,
+      'zip'  => :zip,
+      '7zip' => :"7zip"
     }
 
     # The command's option parser.
@@ -74,7 +76,7 @@ module Wordlist
     #
     # @param [:read, :build] mode
     #
-    # @param [:txt, :gzip, :bzip2, :xz, nil] format
+    # @param [:txt, :gzip, :bzip2, :xz, :zip, :7zip, nil] format
     #
     # @param [String, nil] command
     #
@@ -277,7 +279,7 @@ module Wordlist
         opts.separator ""
         opts.separator "Wordlist Reading Options:"
 
-        opts.on('-f','--format {txt|gzip|bz2|xz}', FORMATS, 'Saves the output to FILE') do |format|
+        opts.on('-f','--format {txt|gzip|bz2|xz|zip|7zip}', FORMATS, 'Saves the output to FILE') do |format|
           @format = format
         end
 

data/lib/wordlist/compression/reader.rb

@@ -1,4 +1,4 @@
-require 'wordlist/exceptions'
+require_relative '../exceptions'
 
 require 'shellwords'
 
@@ -10,34 +10,31 @@ module Wordlist
     # @since 1.0.0
     #
     module Reader
-      # Mapping of compression formats to the commands to read them.
-      COMMANDS = {
-        gzip:  'zcat',
-        bzip2: 'bzcat',
-        xz:    'xzcat'
-      }
-
       #
       # Returns the command to read the compressed wordlist.
       #
       # @param [String] path
       #   The path to the file.
       #
-      # @param [:gzip, :bzip2, :xz] format
+      # @param [:gzip, :bzip2, :xz, :zip, :7zip] format
       #   The compression format of the file.
       #
       # @return [String]
       #   The shellescaped command string.
       #
       # @raise [UnknownFormat]
-      #   The given format was not `:gzip`, `:bzip2`, or `:xz`.
+      #   The given format was not `:gzip`, `:bzip2`, `:xz`, `:zip`, `:7zip`.
       #
       def self.command(path, format: )
-        command = COMMANDS.fetch(format) do
-          raise(UnknownFormat,"unsupported format: #{format.inspect}")
+        case format
+        when :gzip   then "zcat < #{Shellwords.shellescape(path)}"
+        when :bzip2  then "bzcat < #{Shellwords.shellescape(path)}"
+        when :xz     then "xzcat < #{Shellwords.shellescape(path)}"
+        when :zip    then "unzip -p #{Shellwords.shellescape(path)}"
+        when :"7zip" then "7za e -so #{Shellwords.shellescape(path)}"
+        else
+          raise(UnknownFormat,"unsupported input format: #{format.inspect}")
         end
-
-        "#{command} < #{Shellwords.shellescape(path)}"
       end
 
       #
@@ -53,10 +50,10 @@ module Wordlist
       #   The uncompressed IO stream.
       #
       # @raise [ArgumentError]
-      #   The given format was not `:gzip`, `:bzip2`, or `:xz`.
+      #   The given format was not `:gzip`, `:bzip2`, `:xz`, `:zip`, or `:7zip`.
       #
       # @raise [CommandNotFound]
-      #   The `zcat,` `bzcat`, or `xzcat` command could not be found.
+      #   The `zcat,` `bzcat`, `xzcat`, or `unzip` command could not be found.
       #
       def self.open(path,**kwargs,&block)
         command = self.command(path,**kwargs)

data/lib/wordlist/compression/writer.rb

@@ -1,4 +1,4 @@
-require 'wordlist/exceptions'
+require_relative '../exceptions'
 
 require 'shellwords'
 
@@ -10,20 +10,13 @@ module Wordlist
     # @since 1.0.0
     #
     module Writer
-      # Mapping of compression formats to the commands to write to them.
-      COMMANDS = {
-        gzip:  'gzip',
-        bzip2: 'bzip2',
-        xz:    'xz'
-      }
-
       #
       # Returns the command to write to the compressed wordlist.
       #
       # @param [String] path
       #   The path to the file.
       #
-      # @param [:gzip, :bzip2, :xz] format
+      # @param [:gzip, :bzip2, :xz, :zip] format
       #   The compression format of the file.
       #
       # @param [Boolean] append
@@ -33,19 +26,36 @@ module Wordlist
       # @return [String]
       #   The shellescaped command string.
       #
-      # @raise [UnknownFormat]
-      #   The given format was not `:gzip`, `:bzip2`, or `:xz`.
+      # @raise [UnknownFormat, AppendNotSupported]
+      #   * {UnknownFormat} - the given format was not `:gzip`, `:bzip2`, `:xz`,
+      #     or `:zip`.
+      #   * {AppendNotSupported} - the `zip` archive format does not support
+      #     appending to existing files within existing archives.
       #
       def self.command(path, format: , append: false)
-        command  = COMMANDS.fetch(format) do
-          raise(UnknownFormat,"unsupported format: #{format.inspect}")
-        end
+        case format
+        when :gzip, :bzip2, :xz
+          command  = format.to_s
+          redirect = if append then '>>'
+                     else           '>'
+                     end
 
-        redirect = if append then '>>'
-                   else           '>'
-                   end
+          "#{command} #{redirect} #{Shellwords.shellescape(path)}"
+        when :zip
+          if append
+            raise(AppendNotSupported,"zip format does not support appending to files within pre-existing archives: #{path.inspect}")
+          end
 
-        return "#{Shellwords.shellescape(command)} #{redirect} #{Shellwords.shellescape(path)}"
+          "zip -q #{Shellwords.shellescape(path)} -"
+        when :"7zip"
+          if append
+            raise(AppendNotSupported,"7zip format does not support appending to files within pre-existing archives: #{path.inspect}")
+          end
+
+          "7za a -si #{Shellwords.shellescape(path)} >/dev/null"
+        else
+          raise(UnknownFormat,"unsupported output format: #{format.inspect}")
+        end
       end
 
       #
@@ -61,10 +71,11 @@ module Wordlist
       #   The uncompressed IO stream.
       #
       # @raise [ArgumentError]
-      #   The given format was not `:gzip`, `:bzip2`, or `:xz`.
+      #   The given format was not `:gzip`, `:bzip2`, `:xz`, `:zip`.
       #
       # @raise [CommandNotFound]
-      #   The `gzip`, `bzip2,` or `xz` command was not found on the system.
+      #   The `gzip`, `bzip2,` `xz`, or `zip` command was not found on the
+      #   system.
       #
       def self.open(path,**kwargs)
         command = self.command(path,**kwargs)

data/lib/wordlist/exceptions.rb

@@ -17,6 +17,12 @@ module Wordlist
   class UnknownFormat < WordlistError
   end
 
+  #
+  # @since 1.1.0
+  #
+  class AppendNotSupported < WordlistError
+  end
+
   #
   # @since 1.0.0
   #

data/lib/wordlist/file.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-require 'wordlist/abstract_wordlist'
-require 'wordlist/exceptions'
-require 'wordlist/format'
-require 'wordlist/compression/reader'
+require_relative 'abstract_wordlist'
+require_relative 'exceptions'
+require_relative 'format'
+require_relative 'compression/reader'
 
 module Wordlist
   #
@@ -24,7 +24,7 @@ module Wordlist
 
     # The format of the wordlist file.
     #
-    # @return [:txt, :gzip, :bzip2, :xz]
+    # @return [:txt, :gzip, :bzip2, :xz, :zip, :7zip]
     attr_reader :format
 
     #
@@ -33,7 +33,7 @@ module Wordlist
     # @param [String] path
     #   The path to the `.txt` file wordlist read from.
     #
-    # @param [:txt, :gz, :bzip2, :xz, nil] format
+    # @param [:txt, :gz, :bzip2, :xz, :zip, :7zip, nil] format
     #   The format of the wordlist. If not given the format will be inferred
     #   from the file extension.
     #

data/lib/wordlist/format.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/exceptions'
+require_relative 'exceptions'
 
 module Wordlist
   #
@@ -13,7 +13,9 @@ module Wordlist
       '.txt' => :txt,
       '.gz'  => :gzip,
       '.bz2' => :bzip2,
-      '.xz'  => :xz
+      '.xz'  => :xz,
+      '.zip' => :zip,
+      '.7z'  => :"7zip"
     }
 
     # Valid formats.
@@ -25,7 +27,7 @@ module Wordlist
     # @param [String] path
     #   The path to the file.
     #
-    # @return [:txt, :gzip, :bzip2, :xz]
+    # @return [:txt, :gzip, :bzip2, :xz, :zip, :7zip]
     #
     # @raise [UnknownFormat]
     #   The format could not be inferred from the file path.

data/lib/wordlist/lexer/stop_words.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/exceptions'
+require_relative '../exceptions'
 
 module Wordlist
   class Lexer

data/lib/wordlist/lexer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'wordlist/lexer/lang'
-require 'wordlist/lexer/stop_words'
+require_relative 'lexer/lang'
+require_relative 'lexer/stop_words'
 
 require 'strscan'
 

data/lib/wordlist/list_methods.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'wordlist/operators'
-require 'wordlist/modifiers'
+require_relative 'operators'
+require_relative 'modifiers'
 
 module Wordlist
   #

data/lib/wordlist/modifiers/capitalize.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/modifier'
+require_relative 'modifier'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers/downcase.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/modifier'
+require_relative 'modifier'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers/gsub.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/sub'
+require_relative 'sub'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers/mutate.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/sub'
+require_relative 'sub'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers/mutate_case.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/mutate'
+require_relative 'mutate'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers/sub.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/modifier'
+require_relative 'modifier'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers/tr.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/modifier'
+require_relative 'modifier'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers/upcase.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/modifier'
+require_relative 'modifier'
 
 module Wordlist
   module Modifiers

data/lib/wordlist/modifiers.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require 'wordlist/modifiers/tr'
-require 'wordlist/modifiers/sub'
-require 'wordlist/modifiers/gsub'
-require 'wordlist/modifiers/capitalize'
-require 'wordlist/modifiers/upcase'
-require 'wordlist/modifiers/downcase'
-require 'wordlist/modifiers/mutate'
-require 'wordlist/modifiers/mutate_case'
+require_relative 'modifiers/tr'
+require_relative 'modifiers/sub'
+require_relative 'modifiers/gsub'
+require_relative 'modifiers/capitalize'
+require_relative 'modifiers/upcase'
+require_relative 'modifiers/downcase'
+require_relative 'modifiers/mutate'
+require_relative 'modifiers/mutate_case'

data/lib/wordlist/operators/binary_operator.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/operators/operator'
+require_relative 'operator'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/concat.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/operators/binary_operator'
+require_relative 'binary_operator'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/intersect.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'wordlist/operators/binary_operator'
-require 'wordlist/unique_filter'
+require_relative 'binary_operator'
+require_relative '../unique_filter'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/power.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'wordlist/operators/binary_operator'
-require 'wordlist/operators/product'
+require_relative 'binary_operator'
+require_relative 'product'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/product.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/operators/binary_operator'
+require_relative 'binary_operator'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/subtract.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'wordlist/operators/binary_operator'
-require 'wordlist/unique_filter'
+require_relative 'binary_operator'
+require_relative '../unique_filter'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/unary_operator.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'wordlist/operators/operator'
+require_relative 'operator'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/union.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'wordlist/operators/binary_operator'
-require 'wordlist/unique_filter'
+require_relative 'binary_operator'
+require_relative '../unique_filter'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators/unique.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'wordlist/operators/unary_operator'
-require 'wordlist/unique_filter'
+require_relative 'unary_operator'
+require_relative '../unique_filter'
 
 module Wordlist
   module Operators

data/lib/wordlist/operators.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-require 'wordlist/operators/concat'
-require 'wordlist/operators/subtract'
-require 'wordlist/operators/product'
-require 'wordlist/operators/power'
-require 'wordlist/operators/intersect'
-require 'wordlist/operators/union'
-require 'wordlist/operators/unique'
+require_relative 'operators/concat'
+require_relative 'operators/subtract'
+require_relative 'operators/product'
+require_relative 'operators/power'
+require_relative 'operators/intersect'
+require_relative 'operators/union'
+require_relative 'operators/unique'

data/lib/wordlist/version.rb

@@ -2,5 +2,5 @@
 
 module Wordlist
   # wordlist version
-  VERSION = '1.0.3'
+  VERSION = '1.1.1'
 end

data/lib/wordlist.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-require 'wordlist/words'
-require 'wordlist/file'
-require 'wordlist/builder'
-require 'wordlist/version'
+require_relative 'wordlist/words'
+require_relative 'wordlist/file'
+require_relative 'wordlist/builder'
+require_relative 'wordlist/version'
 
 module Wordlist
   # 
@@ -31,7 +31,7 @@ module Wordlist
   # @param [Hash{Symbol => Object}] kwargs
   #   Additional keyword arguments for {Wordlist::File#initialize}.
   #
-  # @option kwargs [:txt, :bzip, :bzip2, :xz] :format
+  # @option kwargs [:txt, :bzip, :bzip2, :xz, :zip, :7zip] :format
   #   Specifies the format of the wordlist. If no format is given, the format
   #   will be inferred from the path's file extension.
   #

data/spec/builder_spec.rb

@@ -46,6 +46,22 @@ describe Wordlist::Builder do
       end
     end
 
+    context "when the path ends in '.zip'" do
+      let(:path) { ::File.join(fixtures_dir,'new_wordlist.zip') }
+
+      it "must default #format to :zip" do
+        expect(subject.format).to eq(:zip)
+      end
+    end
+
+    context "when the path ends in '.7z'" do
+      let(:path) { ::File.join(fixtures_dir,'new_wordlist.7z') }
+
+      it "must default #format to :7zip" do
+        expect(subject.format).to eq(:"7zip")
+      end
+    end
+
     context "when format: :txt is given" do
       subject { described_class.new(path, format: :txt) }
 
@@ -78,6 +94,22 @@ describe Wordlist::Builder do
       end
     end
 
+    context "when format: :zip is given" do
+      subject { described_class.new(path, format: :zip) }
+
+      it "must set #format to :zip" do
+        expect(subject.format).to eq(:zip)
+      end
+    end
+
+    context "when format: :7zip is given" do
+      subject { described_class.new(path, format: :"7zip") }
+
+      it "must set #format to :7zip" do
+        expect(subject.format).to eq(:"7zip")
+      end
+    end
+
     it "must default #append? to false" do
       expect(subject.append?).to be(false)
     end

data/spec/compression/reader_spec.rb

@@ -53,13 +53,35 @@ describe Wordlist::Compression::Reader do
       end
     end
 
+    context "when given format: :zip" do
+      let(:file_name) { 'file_name'                }
+      let(:path)      { "path/to/#{file_name}.zip" }
+
+      subject { described_class.command(path, format: :zip) }
+
+      it "must return 'unzip -p path/to/file_name.zip'" do
+        expect(subject).to eq("unzip -p #{path}")
+      end
+    end
+
+    context "when given format: :7zip" do
+      let(:file_name) { 'file_name'               }
+      let(:path)      { "path/to/#{file_name}.7z" }
+
+      subject { described_class.command(path, format: :"7zip") }
+
+      it "must return 'unzip -p path/to/file_name.zip'" do
+        expect(subject).to eq("7za e -so #{path}")
+      end
+    end
+
     context "when given an unknown format: value" do
       let(:format) { :foo }
 
       it do
         expect {
           subject.command(path, format: format)
-        }.to raise_error(Wordlist::UnknownFormat,"unsupported format: #{format.inspect}")
+        }.to raise_error(Wordlist::UnknownFormat,"unsupported input format: #{format.inspect}")
       end
     end
   end

data/spec/compression/writer_spec.rb

@@ -79,13 +79,61 @@ describe Wordlist::Compression::Writer do
       end
     end
 
+    context "when given format: :zip" do
+      subject { described_class.command(path, format: :zip) }
+
+      it "must return 'zip -q path/to/file -'" do
+        expect(subject).to eq("zip -q #{path} -")
+      end
+
+      context "and given append: true" do
+        it do
+          expect {
+            described_class.command(path, format: :zip, append: true)
+          }.to raise_error(Wordlist::AppendNotSupported,"zip format does not support appending to files within pre-existing archives: #{path.inspect}")
+        end
+      end
+
+      context "and the file contains special characters" do
+        let(:path) { 'path/to/the file' }
+
+        it "must shellescape them" do
+          expect(subject).to eq("zip -q #{Shellwords.shellescape(path)} -")
+        end
+      end
+    end
+
+    context "when given format: :7zip" do
+      subject { described_class.command(path, format: :"7zip") }
+
+      it "must return '7za a -si path/to/file'" do
+        expect(subject).to eq("7za a -si #{path} >/dev/null")
+      end
+
+      context "and given append: true" do
+        it do
+          expect {
+            described_class.command(path, format: :"7zip", append: true)
+          }.to raise_error(Wordlist::AppendNotSupported,"7zip format does not support appending to files within pre-existing archives: #{path.inspect}")
+        end
+      end
+
+      context "and the file contains special characters" do
+        let(:path) { 'path/to/the file' }
+
+        it "must shellescape them" do
+          expect(subject).to eq("7za a -si #{Shellwords.shellescape(path)} >/dev/null")
+        end
+      end
+    end
+
     context "when given an unknown format: value" do
       let(:format) { :foo }
 
       it do
         expect {
           subject.command(path, format: format)
-        }.to raise_error(Wordlist::UnknownFormat,"unsupported format: #{format.inspect}")
+        }.to raise_error(Wordlist::UnknownFormat,"unsupported output format: #{format.inspect}")
       end
     end
   end
@@ -107,6 +155,7 @@ describe Wordlist::Compression::Writer do
       context "when written to" do
         before do
           subject.puts words
+          subject.flush
           subject.close
         end
 
@@ -118,7 +167,10 @@ describe Wordlist::Compression::Writer do
         end
       end
 
-      after { ::FileUtils.rm_f(path) }
+      after do
+        subject.close
+        ::FileUtils.rm_f(path)
+      end
     end
 
     context "when given format: :bzip2" do
@@ -133,6 +185,7 @@ describe Wordlist::Compression::Writer do
       context "when written to" do
         before do
           subject.puts words
+          subject.flush
           subject.close
         end
 
@@ -144,7 +197,10 @@ describe Wordlist::Compression::Writer do
         end
       end
 
-      after { ::FileUtils.rm_f(path) }
+      after do
+        subject.close
+        ::FileUtils.rm_f(path)
+      end
     end
 
     context "when given format: :xz" do
@@ -159,6 +215,7 @@ describe Wordlist::Compression::Writer do
       context "when written to" do
         before do
           subject.puts words
+          subject.flush
           subject.close
         end
 
@@ -170,7 +227,70 @@ describe Wordlist::Compression::Writer do
         end
       end
 
-      after { ::FileUtils.rm_f(path) }
+      after do
+        subject.close
+        ::FileUtils.rm_f(path)
+      end
+    end
+
+    context "when given format: :zip" do
+      let(:path) { ::File.join(fixtures_dir,'new_wordlist.txt.zip') }
+
+      subject { described_class.open(path, format: :zip) }
+
+      it "must return an IO object" do
+        expect(subject).to be_kind_of(IO)
+      end
+
+      context "when written to" do
+        before do
+          subject.puts words
+          subject.flush
+          subject.close
+        end
+
+        let(:written_contents) { `unzip -p #{Shellwords.shellescape(path)}` }
+        let(:written_words)    { written_contents.lines.map(&:chomp)    }
+
+        it "must writing xz compressed data to the file" do
+          expect(written_words).to eq(words)
+        end
+      end
+
+      after do
+        subject.close
+        ::FileUtils.rm_f(path)
+      end
+    end
+
+    context "when given format: :7zip" do
+      let(:path) { ::File.join(fixtures_dir,'new_wordlist.txt.7z') }
+
+      subject { described_class.open(path, format: :"7zip") }
+
+      it "must return an IO object" do
+        expect(subject).to be_kind_of(IO)
+      end
+
+      context "when written to" do
+        before do
+          subject.puts words
+          subject.flush
+          subject.close
+        end
+
+        let(:written_contents) { `7za e -so #{Shellwords.shellescape(path)}` }
+        let(:written_words)    { written_contents.lines.map(&:chomp)    }
+
+        it "must writing xz compressed data to the file" do
+          expect(written_words).to eq(words)
+        end
+      end
+
+      after do
+        subject.close
+        ::FileUtils.rm_f(path)
+      end
     end
 
     context "when the command is not installed" do

data/spec/file_spec.rb

@@ -75,6 +75,22 @@ describe Wordlist::File do
           expect(subject.format).to eq(:xz)
         end
       end
+
+      context "and the path ends in .zip" do
+        let(:path) { ::File.join(fixtures_dir,'wordlist.txt.zip') }
+
+        it "must set #format to :zip" do
+          expect(subject.format).to eq(:zip)
+        end
+      end
+
+      context "and the path ends in .7z" do
+        let(:path) { ::File.join(fixtures_dir,'wordlist.txt.7z') }
+
+        it "must set #format to :7zip" do
+          expect(subject.format).to eq(:"7zip")
+        end
+      end
     end
 
     context "when format: is given" do
@@ -162,6 +178,28 @@ describe Wordlist::File do
           }.to yield_successive_args(*expected_lines)
         end
       end
+
+      context "and the wordlist format is zip" do
+        let(:path) { ::File.join(fixtures_dir,'wordlist.txt.zip') }
+        let(:expected_contents) { `unzip -p #{Shellwords.shellescape(path)}` }
+
+        it "must read the uncompressed zip data" do
+          expect { |b|
+            subject.each_line(&b)
+          }.to yield_successive_args(*expected_lines)
+        end
+      end
+
+      context "and the wordlist format is 7zip" do
+        let(:path) { ::File.join(fixtures_dir,'wordlist.txt.7z') }
+        let(:expected_contents) { `7za e -so #{Shellwords.shellescape(path)}` }
+
+        it "must read the uncompressed 7zip data" do
+          expect { |b|
+            subject.each_line(&b)
+          }.to yield_successive_args(*expected_lines)
+        end
+      end
     end
 
     context "when not given a block" do
@@ -199,6 +237,26 @@ describe Wordlist::File do
           expect(subject.each_line.to_a).to eq(expected_lines)
         end
       end
+
+      context "and the wordlist format is zip" do
+        let(:path) { ::File.join(fixtures_dir,'wordlist.txt.zip') }
+        let(:expected_contents) { `unzip -p #{Shellwords.shellescape(path)}` }
+
+        it "must return an Enumerator of the compressed zip data" do
+          expect(subject.each_line).to be_kind_of(Enumerator)
+          expect(subject.each_line.to_a).to eq(expected_lines)
+        end
+      end
+
+      context "and the wordlist format is 7zip" do
+        let(:path) { ::File.join(fixtures_dir,'wordlist.txt.7z') }
+        let(:expected_contents) { `7za e -so #{Shellwords.shellescape(path)}` }
+
+        it "must return an Enumerator of the compressed 7zip data" do
+          expect(subject.each_line).to be_kind_of(Enumerator)
+          expect(subject.each_line.to_a).to eq(expected_lines)
+        end
+      end
     end
   end
 
@@ -242,6 +300,28 @@ describe Wordlist::File do
       end
     end
 
+    context "and the wordlist format is zip" do
+      let(:path) { ::File.join(fixtures_dir,'wordlist.txt.zip') }
+      let(:expected_contents) { `unzip -p #{Shellwords.shellescape(path)}` }
+
+      it "must read the uncompressed zip data" do
+        expect { |b|
+          subject.each_line(&b)
+        }.to yield_successive_args(*expected_lines)
+      end
+    end
+
+    context "and the wordlist format is 7z" do
+      let(:path) { ::File.join(fixtures_dir,'wordlist.txt.7z') }
+      let(:expected_contents) { `7za e -so #{Shellwords.shellescape(path)}` }
+
+      it "must read the uncompressed 7zip data" do
+        expect { |b|
+          subject.each_line(&b)
+        }.to yield_successive_args(*expected_lines)
+      end
+    end
+
     context "when the wordlist contains empty lines" do
       let(:expected_words) do
         super().reject { |w| w.empty? }

data/spec/format_spec.rb

@@ -27,6 +27,18 @@ describe Wordlist::Format do
       end
     end
 
+    context "when given a path ending in '.zip'" do
+      it "must return :zip" do
+        expect(subject.infer("path/to/file.zip")).to eq(:zip)
+      end
+    end
+
+    context "when given a path ending in '.7z'" do
+      it "must return :7zip" do
+        expect(subject.infer("path/to/file.7z")).to eq(:"7zip")
+      end
+    end
+
     context "when given a path ending in another file extension" do
       let(:path) { "path/to/file.foo" }
 

data/wordlist.gemspec

@@ -7,10 +7,7 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
-
-                  require 'wordlist/version'
+                  require_relative 'lib/wordlist/version'
                   Wordlist::VERSION
                 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wordlist
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,9 +135,11 @@ files:
 - spec/compression/writer_spec.rb
 - spec/file_spec.rb
 - spec/fixtures/wordlist.txt
+- spec/fixtures/wordlist.txt.7z
 - spec/fixtures/wordlist.txt.bz2
 - spec/fixtures/wordlist.txt.gz
 - spec/fixtures/wordlist.txt.xz
+- spec/fixtures/wordlist.txt.zip
 - spec/fixtures/wordlist_with_ambiguous_format
 - spec/fixtures/wordlist_with_comments.txt
 - spec/fixtures/wordlist_with_empty_lines.txt
@@ -175,7 +177,7 @@ files:
 - spec/wordlist_spec.rb
 - spec/words_spec.rb
 - wordlist.gemspec
-homepage: https://github.com/postmodern/wordlist.rb
+homepage: https://github.com/postmodern/wordlist.rb#readme
 licenses:
 - MIT
 metadata:
@@ -191,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="