random-words 1.0.4 → 1.0.6

data/lib/random-words/words/veggie/verbs-plural.txt

@@ -0,0 +1,79 @@
+arrange
+bake
+balance
+blend
+buy
+catalog
+challenge
+choose
+chop
+clean
+collect
+combine
+complete
+consume
+cook
+cut
+dice
+dig
+distribute
+dress
+eat
+enhance
+enjoy
+export
+fertilize
+finish
+flavor
+freeze
+frost
+fry
+glaze
+grill
+grow
+harvest
+import
+innovate
+inspect
+marinate
+marvel
+mash
+melt
+offer
+organize
+pair
+pick
+plant
+plate
+prepare
+preserve
+process
+purchase
+puree
+recommend
+refrigerate
+roast
+sample
+sauté
+savor
+season
+select
+separate
+serve
+share
+shred
+slice
+specialize
+sprinkle
+steam
+stir
+store
+substitute
+taste
+toss
+transform
+transport
+wash
+whip
+whisk
+zest

data/lib/random-words/words/veggie/verbs-singular.txt

@@ -0,0 +1,79 @@
+arranges
+bakes
+balances
+blends
+buys
+catalogs
+challenges
+chooses
+chops
+cleans
+collects
+combines
+completes
+consumes
+cooks
+cuts
+dices
+digs
+distributes
+dresses
+eats
+enhances
+enjoys
+exports
+fertilizes
+finishes
+flavors
+freezes
+frosts
+fry
+glazes
+grills
+grows
+harvests
+imports
+innovates
+inspects
+marinates
+marvels
+mashes
+melts
+offers
+organizes
+pairs
+picks
+plants
+plates
+prepares
+preserves
+processes
+purchases
+purees
+recommends
+refrigerates
+roasts
+samples
+sautés
+savors
+seasons
+selects
+separates
+serves
+shares
+shreds
+slices
+specializes
+sprinkles
+steams
+stirs
+stores
+substitutes
+tastes
+tosses
+transforms
+transports
+washes
+whips
+whisks
+zests

data/lib/random-words.rb

@@ -1,6 +1,34 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'fileutils'
+require 'yaml'
+
 require_relative 'random-words/version'
 require_relative 'random-words/string'
+require_relative 'random-words/hash'
+require_relative 'random-words/array'
+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'
+
+# Main module for RandomWords
+module RandomWords
+  # Main class for RandomWords
+  class << self
+    # @!visibility private
+    attr_accessor :testing, :tested
+
+    # @!visibility private
+    # Initialize the RandomWords module
+    def initialize!(testing = false)
+      @testing ||= testing
+      @tested ||= []
+    end
+  end
+
+  initialize!
+end

data/random-words.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 2.6.0'
 
-  spec.metadata['rubygems_mfa_required'] = false
+  spec.metadata['rubygems_mfa_required'] = 'true'
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['bug_tracker_uri'] = "#{spec.metadata['source_code_uri']}/issues"
@@ -33,4 +33,6 @@ Gem::Specification.new do |spec|
   end
 
   spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'nokogiri', '~> 1.12'
 end

data/src/_README.md

@@ -1,7 +1,7 @@
 # RandomWords
 <!--README-->
 
-[![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.
 
@@ -9,7 +9,11 @@ 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
 
@@ -17,24 +21,169 @@ The gem installs a binary `randw`. It can generate random characters, sentences,
 
 ```console
 Usage: randw [options]
-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
+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
+PASSWORD OPTIONS:
         --separator [CHAR]           Specify the separator character for the password
-    -n, --no-whitespace              Specify whether to remove whitespace in generated text (characters only)
+        --[no-]extended              Specify whether to use extended punctuation in generated text
+    -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:
+
+    $ randw -m "latin/10/ol/dl/table"
+    $ randw -m "english/5/all"
+
+
+#### 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
+nouns-plural.txt
+nouns-singular.txt
+numbers.txt
+prepositions.txt
+terminators.txt
+verbs-passive.txt
+verbs-plural.txt
+verbs-singular.txt
+```
+
+The `terminators.txt` file contains pairs of punctuation,
+separated by commas, one per line. If a sentene 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.
+
+
+##### 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).
+
+> 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

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: random-words
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Brett Terpstra
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
-dependencies: []
+date: 2025-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
 email: me@brettterpstra.com
@@ -29,18 +43,65 @@ files:
 - Rakefile
 - bin/randw
 - lib/random-words.rb
+- lib/random-words/array.rb
+- lib/random-words/config.rb
 - lib/random-words/generator.rb
+- lib/random-words/hash.rb
+- lib/random-words/html2markdown.rb
+- lib/random-words/lorem-markdown.rb
+- lib/random-words/number-to-word.rb
+- lib/random-words/source.rb
 - lib/random-words/string.rb
+- lib/random-words/table-cleanup.rb
 - lib/random-words/version.rb
+- lib/random-words/words/1984/adjectives.txt
+- lib/random-words/words/1984/adverbs.txt
+- lib/random-words/words/1984/articles-plural.txt
+- lib/random-words/words/1984/articles-singular.txt
+- lib/random-words/words/1984/clauses.txt
+- lib/random-words/words/1984/config.yml
+- lib/random-words/words/1984/conjunctions-coordinating.txt
+- lib/random-words/words/1984/conjunctions-subordinate.txt
+- lib/random-words/words/1984/names.txt
+- 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/prepositions.txt
+- lib/random-words/words/1984/terminators.txt
+- lib/random-words/words/1984/verbs-passive.txt
+- lib/random-words/words/1984/verbs-plural.txt
+- lib/random-words/words/1984/verbs-singular.txt
+- lib/random-words/words/alice/adjectives.txt
+- lib/random-words/words/alice/adverbs.txt
+- lib/random-words/words/alice/articles-plural.txt
+- lib/random-words/words/alice/articles-singular.txt
+- lib/random-words/words/alice/clauses.txt
+- lib/random-words/words/alice/config.yml
+- lib/random-words/words/alice/conjunctions-coordinating.txt
+- lib/random-words/words/alice/conjunctions-subordinate.txt
+- lib/random-words/words/alice/names.txt
+- 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/prepositions.txt
+- lib/random-words/words/alice/terminators.txt
+- lib/random-words/words/alice/verbs-passive.txt
+- lib/random-words/words/alice/verbs-plural.txt
+- lib/random-words/words/alice/verbs-singular.txt
 - lib/random-words/words/bacon/adjectives.txt
 - lib/random-words/words/bacon/adverbs.txt
 - lib/random-words/words/bacon/articles-plural.txt
 - lib/random-words/words/bacon/articles-singular.txt
 - lib/random-words/words/bacon/clauses.txt
+- lib/random-words/words/bacon/config.yml
+- lib/random-words/words/bacon/conjunctions-coordinating.txt
 - lib/random-words/words/bacon/conjunctions-subordinate.txt
+- lib/random-words/words/bacon/names.txt
 - lib/random-words/words/bacon/nouns-plural.txt
 - lib/random-words/words/bacon/nouns-singular.txt
-- lib/random-words/words/bacon/numbers.txt
+- lib/random-words/words/bacon/numbers.yml
+- lib/random-words/words/bacon/prepositions.txt
+- lib/random-words/words/bacon/terminators.txt
 - lib/random-words/words/bacon/verbs-passive.txt
 - lib/random-words/words/bacon/verbs-plural.txt
 - lib/random-words/words/bacon/verbs-singular.txt
@@ -49,37 +110,137 @@ files:
 - lib/random-words/words/corporate/articles-plural.txt
 - lib/random-words/words/corporate/articles-singular.txt
 - lib/random-words/words/corporate/clauses.txt
+- lib/random-words/words/corporate/config.yml
+- lib/random-words/words/corporate/conjunctions-coordinating.txt
 - lib/random-words/words/corporate/conjunctions-subordinate.txt
+- lib/random-words/words/corporate/names.txt
 - lib/random-words/words/corporate/nouns-plural.txt
 - lib/random-words/words/corporate/nouns-singular.txt
-- lib/random-words/words/corporate/numbers.txt
+- lib/random-words/words/corporate/numbers.yml
+- lib/random-words/words/corporate/prepositions.txt
+- lib/random-words/words/corporate/terminators.txt
 - lib/random-words/words/corporate/verbs-passive.txt
 - lib/random-words/words/corporate/verbs-plural.txt
 - lib/random-words/words/corporate/verbs-singular.txt
+- lib/random-words/words/doctor/adjectives.txt
+- lib/random-words/words/doctor/adverbs.txt
+- lib/random-words/words/doctor/articles-plural.txt
+- lib/random-words/words/doctor/articles-singular.txt
+- lib/random-words/words/doctor/clauses.txt
+- lib/random-words/words/doctor/config.yml
+- lib/random-words/words/doctor/conjunctions-coordinating.txt
+- lib/random-words/words/doctor/conjunctions-subordinate.txt
+- lib/random-words/words/doctor/names.txt
+- 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/prepositions.txt
+- lib/random-words/words/doctor/terminators.txt
+- lib/random-words/words/doctor/verbs-passive.txt
+- lib/random-words/words/doctor/verbs-plural.txt
+- lib/random-words/words/doctor/verbs-singular.txt
 - lib/random-words/words/english/adjectives.txt
 - lib/random-words/words/english/adverbs.txt
 - lib/random-words/words/english/articles-plural.txt
 - lib/random-words/words/english/articles-singular.txt
 - lib/random-words/words/english/clauses.txt
+- lib/random-words/words/english/config.yml
+- lib/random-words/words/english/conjunctions-coordinating.txt
 - lib/random-words/words/english/conjunctions-subordinate.txt
+- lib/random-words/words/english/names.txt
 - lib/random-words/words/english/nouns-plural.txt
 - lib/random-words/words/english/nouns-singular.txt
-- lib/random-words/words/english/numbers.txt
+- lib/random-words/words/english/numbers.yml
+- lib/random-words/words/english/prepositions.txt
+- lib/random-words/words/english/terminators.txt
 - lib/random-words/words/english/verbs-passive.txt
 - lib/random-words/words/english/verbs-plural.txt
 - lib/random-words/words/english/verbs-singular.txt
+- lib/random-words/words/foulmouth/adjectives.txt
+- lib/random-words/words/foulmouth/adverbs.txt
+- lib/random-words/words/foulmouth/articles-plural.txt
+- lib/random-words/words/foulmouth/articles-singular.txt
+- lib/random-words/words/foulmouth/clauses.txt
+- lib/random-words/words/foulmouth/config.yml
+- lib/random-words/words/foulmouth/conjunctions-coordinating.txt
+- lib/random-words/words/foulmouth/conjunctions-subordinate.txt
+- lib/random-words/words/foulmouth/names.txt
+- 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/prepositions.txt
+- lib/random-words/words/foulmouth/terminators.txt
+- lib/random-words/words/foulmouth/verbs-passive.txt
+- lib/random-words/words/foulmouth/verbs-plural.txt
+- lib/random-words/words/foulmouth/verbs-singular.txt
+- lib/random-words/words/hipster/adjectives.txt
+- lib/random-words/words/hipster/adverbs.txt
+- lib/random-words/words/hipster/articles-plural.txt
+- lib/random-words/words/hipster/articles-singular.txt
+- lib/random-words/words/hipster/clauses.txt
+- lib/random-words/words/hipster/config.yml
+- lib/random-words/words/hipster/conjunctions-coordinating.txt
+- lib/random-words/words/hipster/conjunctions-subordinate.txt
+- lib/random-words/words/hipster/names.txt
+- 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/prepositions.txt
+- lib/random-words/words/hipster/terminators.txt
+- lib/random-words/words/hipster/verbs-passive.txt
+- lib/random-words/words/hipster/verbs-plural.txt
+- lib/random-words/words/hipster/verbs-singular.txt
 - lib/random-words/words/latin/adjectives.txt
 - lib/random-words/words/latin/adverbs.txt
 - lib/random-words/words/latin/articles-plural.txt
 - lib/random-words/words/latin/articles-singular.txt
 - lib/random-words/words/latin/clauses.txt
+- lib/random-words/words/latin/config.yml
+- lib/random-words/words/latin/conjunctions-coordinating.txt
 - lib/random-words/words/latin/conjunctions-subordinate.txt
+- lib/random-words/words/latin/names.txt
 - lib/random-words/words/latin/nouns-plural.txt
 - lib/random-words/words/latin/nouns-singular.txt
-- lib/random-words/words/latin/numbers.txt
+- lib/random-words/words/latin/numbers.yml
+- lib/random-words/words/latin/prepositions.txt
+- lib/random-words/words/latin/terminators.txt
 - lib/random-words/words/latin/verbs-passive.txt
 - lib/random-words/words/latin/verbs-plural.txt
 - lib/random-words/words/latin/verbs-singular.txt
+- lib/random-words/words/spanish/adjectives.txt
+- lib/random-words/words/spanish/adverbs.txt
+- lib/random-words/words/spanish/articles-plural.txt
+- lib/random-words/words/spanish/articles-singular.txt
+- lib/random-words/words/spanish/clauses.txt
+- lib/random-words/words/spanish/config.yml
+- lib/random-words/words/spanish/conjunctions-coordinating.txt
+- lib/random-words/words/spanish/conjunctions-subordinate.txt
+- lib/random-words/words/spanish/names.txt
+- 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/prepositions.txt
+- lib/random-words/words/spanish/terminators.txt
+- lib/random-words/words/spanish/verbs-passive.txt
+- lib/random-words/words/spanish/verbs-plural.txt
+- lib/random-words/words/spanish/verbs-singular.txt
+- lib/random-words/words/veggie/adjectives.txt
+- lib/random-words/words/veggie/adverbs.txt
+- lib/random-words/words/veggie/articles-plural.txt
+- lib/random-words/words/veggie/articles-singular.txt
+- lib/random-words/words/veggie/clauses.txt
+- lib/random-words/words/veggie/config.yml
+- lib/random-words/words/veggie/conjunctions-coordinating.txt
+- lib/random-words/words/veggie/conjunctions-subordinate.txt
+- lib/random-words/words/veggie/names.txt
+- 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/prepositions.txt
+- lib/random-words/words/veggie/terminators.txt
+- lib/random-words/words/veggie/verbs-passive.txt
+- lib/random-words/words/veggie/verbs-plural.txt
+- lib/random-words/words/veggie/verbs-singular.txt
 - random-words.gemspec
 - src/_README.md
 homepage: https://github.com/ttscoff/random-words

data/lib/random-words/words/bacon/numbers.txt

@@ -1,21 +0,0 @@
-zero
-one
-two
-three
-four
-five
-six
-seven
-eight
-nine
-ten
-eleven
-twelve
-thirteen
-fourteen
-fifteen
-sixteen
-seventeen
-eighteen
-nineteen
-twenty

data/lib/random-words/words/corporate/numbers.txt

@@ -1,21 +0,0 @@
-zero
-one
-two
-three
-four
-five
-six
-seven
-eight
-nine
-ten
-eleven
-twelve
-thirteen
-fourteen
-fifteen
-sixteen
-seventeen
-eighteen
-nineteen
-twenty