random-words 1.0.5 → 1.0.7

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

@@ -0,0 +1,56 @@
+are bought
+were bought
+are eaten
+were eaten
+are cooked
+were cooked
+are prepared
+were prepared
+are served
+were served
+are grown
+were grown
+are harvested
+were harvested
+are selected
+were selected
+are stored
+were stored
+are chopped
+were chopped
+are washed
+were washed
+are seasoned
+were seasoned
+are sliced
+were sliced
+are steamed
+were steamed
+are sautéed
+were sautéed
+are roasted
+were roasted
+are grilled
+were grilled
+are diced
+were diced
+are pureed
+were pureed
+are blended
+were blended
+are tossed
+were tossed
+are marinated
+were marinated
+are consumed
+were consumed
+are picked
+were picked
+are preserved
+were preserved
+are arranged
+were arranged
+are plated
+were plated
+are seasoned
+were seasoned

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'
+require_relative 'random-words/html2markdown'
+
+# 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

@@ -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'
@@ -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,32 +9,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