random-words 1.0.6 → 1.0.7

data/lib/random-words.rb

@@ -12,8 +12,8 @@ require_relative 'random-words/source'
 require_relative 'random-words/config'
 require_relative 'random-words/generator'
 require_relative 'random-words/number-to-word'
-require_relative 'random-words/lorem-markdown.rb'
-require_relative 'random-words/html2markdown.rb'
+require_relative 'random-words/lorem-markdown'
+require_relative 'random-words/html2markdown'
 
 # Main module for RandomWords
 module RandomWords
@@ -31,4 +31,4 @@ module RandomWords
   end
 
   initialize!
-end
+end

data/random-words.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = 'me@brettterpstra.com'
 
   spec.summary = 'Random words generator'
-  spec.description = 'Generate random text (lorem ipsum) from a variety of sources. Can be used to generate random words, sentences, or paragraphs.'
+  spec.description = 'Generate random text (lorem ipsum) from a variety of sources.'
   spec.homepage = 'https://github.com/ttscoff/random-words'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 2.6.0'

data/src/_README.md

@@ -17,25 +17,38 @@ 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
+    -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:
-    -p, --paragraphs [NUMBER]        Generate random paragraphs
-    -w, --words [NUMBER]             Generate random words
-    -c, --characters [NUMBER]        Generate random characters
-    -m, --markdown SETTINGS          Generate random markdown text, comma separated string like "latin,10,all"
-        --password                   Generate a random password
+    -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
-        --[no-]extended              Specify whether to use extended punctuation in generated text
+        --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
@@ -79,9 +92,23 @@ The number of elements inserted depends on the length you specify.
 
 Example commands:
 
-    $ randw -m "latin/10/ol/dl/table"
-    $ randw -m "english/5/all"
+```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
 
@@ -119,9 +146,11 @@ 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
@@ -129,8 +158,34 @@ 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 sentene terminator
+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
@@ -155,30 +210,19 @@ 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
 
-##### Language Configuration
-
-The `config.yml` file in a language directory is a simple
-YAML configuration. It contains the keys:
+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.
 
-```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).
+#### Language Notes
 
-> RandomWords loosely uses English rules for sentence construction, so non-English languages will likely generate even more nonsensical strings.
+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.
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: random-words
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Brett Terpstra
 bindir: bin
 cert_chain: []
-date: 2025-04-14 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -23,8 +23,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
-description: Generate random text (lorem ipsum) from a variety of sources. Can be
-  used to generate random words, sentences, or paragraphs.
+description: Generate random text (lorem ipsum) from a variety of sources.
 email: me@brettterpstra.com
 executables:
 - randw
@@ -36,6 +35,7 @@ files:
 - ".rspec"
 - ".rspec_status"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -66,6 +66,7 @@ files:
 - lib/random-words/words/1984/nouns-plural.txt
 - lib/random-words/words/1984/nouns-singular.txt
 - lib/random-words/words/1984/numbers.yml
+- lib/random-words/words/1984/phrases.txt
 - lib/random-words/words/1984/prepositions.txt
 - lib/random-words/words/1984/terminators.txt
 - lib/random-words/words/1984/verbs-passive.txt
@@ -83,6 +84,7 @@ files:
 - lib/random-words/words/alice/nouns-plural.txt
 - lib/random-words/words/alice/nouns-singular.txt
 - lib/random-words/words/alice/numbers.yml
+- lib/random-words/words/alice/phrases.txt
 - lib/random-words/words/alice/prepositions.txt
 - lib/random-words/words/alice/terminators.txt
 - lib/random-words/words/alice/verbs-passive.txt
@@ -100,6 +102,7 @@ files:
 - lib/random-words/words/bacon/nouns-plural.txt
 - lib/random-words/words/bacon/nouns-singular.txt
 - lib/random-words/words/bacon/numbers.yml
+- lib/random-words/words/bacon/phrases.txt
 - lib/random-words/words/bacon/prepositions.txt
 - lib/random-words/words/bacon/terminators.txt
 - lib/random-words/words/bacon/verbs-passive.txt
@@ -117,6 +120,7 @@ files:
 - lib/random-words/words/corporate/nouns-plural.txt
 - lib/random-words/words/corporate/nouns-singular.txt
 - lib/random-words/words/corporate/numbers.yml
+- lib/random-words/words/corporate/phrases.txt
 - lib/random-words/words/corporate/prepositions.txt
 - lib/random-words/words/corporate/terminators.txt
 - lib/random-words/words/corporate/verbs-passive.txt
@@ -134,6 +138,7 @@ files:
 - lib/random-words/words/doctor/nouns-plural.txt
 - lib/random-words/words/doctor/nouns-singular.txt
 - lib/random-words/words/doctor/numbers.yml
+- lib/random-words/words/doctor/phrases.txt
 - lib/random-words/words/doctor/prepositions.txt
 - lib/random-words/words/doctor/terminators.txt
 - lib/random-words/words/doctor/verbs-passive.txt
@@ -151,6 +156,7 @@ files:
 - lib/random-words/words/english/nouns-plural.txt
 - lib/random-words/words/english/nouns-singular.txt
 - lib/random-words/words/english/numbers.yml
+- lib/random-words/words/english/phrases.txt
 - lib/random-words/words/english/prepositions.txt
 - lib/random-words/words/english/terminators.txt
 - lib/random-words/words/english/verbs-passive.txt
@@ -168,6 +174,7 @@ files:
 - lib/random-words/words/foulmouth/nouns-plural.txt
 - lib/random-words/words/foulmouth/nouns-singular.txt
 - lib/random-words/words/foulmouth/numbers.yml
+- lib/random-words/words/foulmouth/phrases.txt
 - lib/random-words/words/foulmouth/prepositions.txt
 - lib/random-words/words/foulmouth/terminators.txt
 - lib/random-words/words/foulmouth/verbs-passive.txt
@@ -185,6 +192,7 @@ files:
 - lib/random-words/words/hipster/nouns-plural.txt
 - lib/random-words/words/hipster/nouns-singular.txt
 - lib/random-words/words/hipster/numbers.yml
+- lib/random-words/words/hipster/phrases.txt
 - lib/random-words/words/hipster/prepositions.txt
 - lib/random-words/words/hipster/terminators.txt
 - lib/random-words/words/hipster/verbs-passive.txt
@@ -202,6 +210,7 @@ files:
 - lib/random-words/words/latin/nouns-plural.txt
 - lib/random-words/words/latin/nouns-singular.txt
 - lib/random-words/words/latin/numbers.yml
+- lib/random-words/words/latin/phrases.txt
 - lib/random-words/words/latin/prepositions.txt
 - lib/random-words/words/latin/terminators.txt
 - lib/random-words/words/latin/verbs-passive.txt
@@ -219,6 +228,7 @@ files:
 - lib/random-words/words/spanish/nouns-plural.txt
 - lib/random-words/words/spanish/nouns-singular.txt
 - lib/random-words/words/spanish/numbers.yml
+- lib/random-words/words/spanish/phrases.txt
 - lib/random-words/words/spanish/prepositions.txt
 - lib/random-words/words/spanish/terminators.txt
 - lib/random-words/words/spanish/verbs-passive.txt
@@ -236,6 +246,7 @@ files:
 - lib/random-words/words/veggie/nouns-plural.txt
 - lib/random-words/words/veggie/nouns-singular.txt
 - lib/random-words/words/veggie/numbers.yml
+- lib/random-words/words/veggie/phrases.txt
 - lib/random-words/words/veggie/prepositions.txt
 - lib/random-words/words/veggie/terminators.txt
 - lib/random-words/words/veggie/verbs-passive.txt