random-words 1.0.5 → 1.0.7

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    random-words (1.0.5)
+    random-words (1.0.7)
+      nokogiri (~> 1.12)
 
 GEM
   remote: https://rubygems.org/
@@ -11,18 +12,24 @@ GEM
     awesome_print (1.9.2)
     diff-lcs (1.6.1)
     docile (1.4.1)
-    gem-release (2.2.2)
+    gem-release (2.2.4)
     json (2.10.2)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
+    mini_portile2 (2.8.8)
     multi_json (1.15.0)
-    parallel (1.26.3)
+    nokogiri (1.18.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.18.7-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.27.0)
     parse_gemspec (1.0.0)
     parse_gemspec-cli (1.0.0)
       multi_json
       parse_gemspec
       thor
-    parser (3.3.7.4)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
     prism (1.4.0)
@@ -31,7 +38,6 @@ GEM
     rake (13.2.1)
     rdoc (6.3.4.1)
     regexp_parser (2.10.0)
-    rexml (3.4.1)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -45,48 +51,59 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.2)
-    rubocop (1.52.1)
+    rubocop (1.75.2)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.43.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-performance (1.18.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rspec (2.20.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-console (0.9.1)
+    simplecov-console (0.9.3)
       ansi
       simplecov
       terminal-table
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    standard (1.29.0)
+    standard (1.49.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.52.0)
+      rubocop (~> 1.75.2)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.1.0)
-    standard-custom (1.0.1)
-      lint_roller (~> 1.0)
-    standard-performance (1.1.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
       lint_roller (~> 1.0)
-      rubocop-performance (~> 1.18.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
+      rubocop (~> 1.50)
+    standard-performance (1.8.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.25.0)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
     thor (1.3.2)
-    unicode-display_width (2.6.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
     yard (0.9.37)
 
 PLATFORMS
@@ -102,6 +119,9 @@ DEPENDENCIES
   random-words!
   rdoc (~> 6.3.4.1)
   rspec (~> 3.0)
+  rubocop (~> 1.75.2)
+  rubocop-performance (~> 1.25.0)
+  rubocop-rspec (~> 2.0)
   simplecov (~> 0.21)
   simplecov-console (~> 0.9)
   standard (~> 1.3)

data/README.md

@@ -1,6 +1,6 @@
 
 
-[![RubyGems.org](https://img.shields.io/gem/v/snibbets)](https://rubygems.org/gems/snibbets)
+[![RubyGems.org](https://img.shields.io/gem/v/random-words)](https://rubygems.org/gems/random-words)
 
 A random text (Lorem Ipsum) generator.
 
@@ -8,32 +8,225 @@ A random text (Lorem Ipsum) generator.
 
     gem install random-words
 
-Depending on your setup, you may need `gem install --user-install random-words`, or in worst case scenario, `sudo gem install random-words`. You can also use `brew gem install random-words` if you use [Homebrew](https://brew.sh).
+Depending on your setup, you may need
+`gem install --user-install random-words`, or in
+worst case scenario, `sudo gem install random-words`.
+You can also use `brew gem install random-words` if
+you use [Homebrew](https://brew.sh).
 
 ### CLI
 
-The gem installs a binary `randw`. It can generate random characters, sentences, paragraphs, and passwords.
+The gem installs a binary `randw`. It can generate random
+characters, sentences, paragraphs, markdown, html,  and
+passwords.
 
 ```console
 Usage: randw [options]
-Options:
-    -S, --source [SOURCE]            Specify the source language (default: latin)
-    -l [short|medium|long|very_long],
-        --length                     Specify the length of the sentence
-        --graf-length [NUMBER]       Specify the number of sentences in a paragraph
-    -s, --sentences [NUMBER]         Generate random sentences
-    -p, --paragraphs [NUMBER]        Generate random paragraphs
-    -w, --words [NUMBER]             Generate random words
-    -c, --characters [NUMBER]        Generate random characters
-        --password                   Generate a random password
-        --separator [CHAR]           Specify the separator character for the password
-    -n, --no-whitespace              Specify whether to remove whitespace in generated text (characters only)
+OPTIONS:
+    -S, --source SOURCE              Specify the source language (default: latin)
+    -l, --length LENGTH              Specify the length of the sentence [short|medium|long|very_long]
+        --graf-length NUMBER         Specify the number of sentences in a paragraph
+        --[no-]extended              Specify whether to use extended punctuation in generated text
+GENERATORS:
+    -s, --sentences [NUMBER]         Generate NUMBER of random sentences (default: 3)
+    -p, --paragraphs [NUMBER]        Generate NUMBER of random paragraphs (default: 3)
+    -w, --words [NUMBER]             Generate NUMBER of random words (default: 10)
+    -c, --characters [NUMBER]        Generate random characters of length (default: 100)
+    -m, --markdown [SETTINGS]        Generate random markdown text, comma separated string like "latin,10,all"
+                                     dec: add em and strong
+                                     link: add links
+                                     ul: add unordered lists
+                                     ol: add ordered lists
+                                     dl: add definition lists
+                                     bq: add block quotes
+                                     code: add code spans and block
+                                     mark: add ==highlights==
+                                     headers: add headlines
+                                     image: add images
+                                     table: add tables
+    -H, --html [SETTINGS]            Generate random html text, comma separated string like "latin,10,all"
+        --password [LENGTH]          Generate a random password of LENGTH (default: 20)
+PASSWORD OPTIONS:
+        --separator CHAR             Specify the separator character for the password (default: " ")
+    -n, --[no-]whitespace            Specify whether to remove whitespace in generated text (characters only)
+DICTIONARIES:
+        --list-dictionaries          List available dictionaries
+        --create-dictionary [NAME]   Create a new dictionary
+OTHER OPTIONS:
     -d, --debug                      Enable debug mode, displays sentence/word/character counts
     -h, --help                       Display this help message
     -v, --version                    Display the version
     -t, --test                       Run the full debug test
 ```
 
+#### Generating Markdown text
+
+The `--markdown` flag takes a SETTINGS argument. This is a
+comma- or slash-separated string that determines the
+elements to include.
+
+First, the source language (defaults to latin), then the
+length of paragraphs and tables: e.g. `english/medium`. You
+can add any digits to determine how many paragraps are
+generated (default 5), e.g. `corporate/medium/10`.
+
+Then you can add individual elements, or use `/all` to
+trigger all elements. The elements available are:
+
+| trigger | element                   |
+| :------ | :------------------------ |
+| dec     | add em and strong         |
+| link    | add links                 |
+| ul      | add unordered lists       |
+| ol      | add ordered lists         |
+| dl      | add definition lists      |
+| bq      | add block quotes          |
+| code    | add code spans and blocks |
+| mark    | add ==highlights==        |
+| headers | add headlines             |
+| image   | add images                |
+| table   | add tables                |
+
+The number of elements inserted depends on the length you specify.
+
+Example commands:
+
+```console
+$ randw -m "latin/1/short/ol"
+
+Illa brevis muros potior arcesso, apud multae octo centum nonaginta octo nodum! Haec ruosus misericordia mox contendo, apud nullus fors.
+
+
+1. Hoc cognatus opus facile complor latus discendo
+2. Aliqua apparens census quod nego
+3. Nullus salvus dux apud habeo spectabilis
+4. Quaedam sensus regnum cura gaudeo ornatus faeneo mox
+
+$ randw -m "english,5,all"
+
+# Any shiny napkin effectively picks
+
+Neither sudden lake exceedingly works, outside a clarity even if which is a source of _an_ strength even if which holds _one subtle horse_ the future. Any lovable tank remarkabl...
+```
+
+#### Creating A New Dictionary
+
+You can add your own sources for generating your random
+text. A dictionary is a directory containing several text
+files, one for each part of speech that RandomWords uses.
+All of the parts must exist. The directory name is the same
+as the name of the dictionary.
+
+User dictionaries must be stored in `~/.config/random-words/words/[NAME]`.
+
+The easiest way to generate a new language is to use the CLI:
+
+```console
+randw --create-dictionary [NAME]
+```
+
+Once this command is run, a new directory in
+`~/.config/random-words/words` will be created containing
+all of the necessary files with English defaults. Simply
+edit these files, and then you'll be able to call the
+language by its name (or triggers defined in the config, see
+below). If a language of the same name exists, missing files
+will be filled in, but existing files will not be
+overwritten.
+
+The necessary files are:
+
+```console
+adjectives.txt
+adverbs.txt
+articles-plural.txt
+articles-singular.txt
+clauses.txt
+config.yml
+conjunctions-coordinating.txt
+conjunctions-subordinate.txt
+names.txt
+nouns-plural.txt
+nouns-singular.txt
+numbers.txt
+phrases.txt
+prepositions.txt
+terminators.txt
+verbs-passive.txt
+verbs-plural.txt
+verbs-singular.txt
+```
+
+##### Language Configuration
+
+The `config.yml` file in a language directory is a simple
+YAML configuration. It contains the keys:
+
+```yaml
+---
+name: english
+description: English words
+triggers: [english]
+```
+
+A default configuration file will be created when running `--create-dictionary` with the CLI.
+
+- `name`: The name of the dictionary
+
+    This should be the same as the directory name in most cases
+- `description`: Just used for display when running `--list-dictionaries`
+- `triggers`: An array of triggers that can be used to trigger the language.
+
+    For example, the `bacon` language has the triggers `[bacon, meat, carnivore]`, so you can use `randw -S meat` on the command line (or with the library).
+
+
+
+##### Terminators
+
+The `terminators.txt` file contains pairs of punctuation,
+separated by commas, one per line. If a sentence terminator
+doesn't have opening punctuation, start the line with a
+comma. More than one character can be used in either side of
+the pair. For example, to create a double quoted sentence
+with a period inside the closing quote, you would use:
+
+    ",."
+
+A blank line (or any line not containing a comma) will
+separate regular punctuation from extended punctuation. In
+the default file, `.`, `?`, and `!` are considered regular
+punctuation, and parenthesis and quotes are considered
+extended punctuation. Extended punctuation is off by
+default, but in the CLI can be enabled with `--extended`,
+and using the library you can include
+`use_extended_punctuation: true` in the options when
+initializing, or use `@rw.use_extended_punctuation = true`
+to set it after initializing.
+
+Repeating words or terminators more than once in the config
+files increases their likelihood of being used. In the
+default terminator.txt files, the period, question mark, and
+exclamation point are repeated multiple times to make them
+the most likely to be used.
+
+##### Names
+
+The `names.txt` file is just used when creating block quotes
+in Markdown or HTML output. Sections are split by blank
+lines: first names, last names, and optionally full names.
+If the first line contains characters other than letters,
+single quotes, and dashes, it will be assumed that you've
+skipped straight to full names and those will be used
+instead of generating random combinations.
+
+#### Language Notes
+
+RandomWords loosely uses English rules for sentence construction, so non-English languages will likely generate even more nonsensical strings.
+
+If you create a fun dictionary, please let me know (or make a PR) and I'll gladly include (most) new dictionaries in the main distribution.
+
+> The easiest way to get words is with AI. A ChatGPT prompt like "give me 100 plural nouns related to the medical profession, in plain text, one per line, sorted alphabetically" will get you a good list of words you can then just paste into `nouns-plural.txt` in your dictionary.
+
 ### Library
 
 ```ruby