random-words 1.0.6 → 1.0.8

data/README.md

@@ -16,25 +16,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
@@ -78,9 +91,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
 
@@ -118,9 +145,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
@@ -128,8 +157,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
@@ -154,30 +209,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.
 

data/bin/randw

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/random-words'
-require 'optparse'
+require_relative "../lib/random-words"
+require "optparse"
 
 module RandomWords
+  # Terminal methods for testing
   class Terminal
     def initialize(source = :english)
       # Create an instance of the generator
@@ -15,7 +16,7 @@ module RandomWords
         counter: :boldcyan,
         marker: :boldgreen,
         bracket: :cyan,
-        language: :boldmagenta
+        language: :boldmagenta,
       }
       @sources = @sentence_generator.sources.keys.map(&:to_s)
     end
@@ -30,15 +31,15 @@ module RandomWords
         magenta: 35,
         cyan: 36,
         white: 37,
-        boldblack: '1;30',
-        boldred: '1;31',
-        boldgreen: '1;32',
-        boldyellow: '1;33',
-        boldblue: '1;34',
-        boldmagenta: '1;35',
-        boldcyan: '1;36',
-        boldwhite: '1;37',
-        reset: 0
+        boldblack: "1;30",
+        boldred: "1;31",
+        boldgreen: "1;32",
+        boldyellow: "1;33",
+        boldblue: "1;34",
+        boldmagenta: "1;35",
+        boldcyan: "1;36",
+        boldwhite: "1;37",
+        reset: 0,
       }
     end
 
@@ -50,13 +51,13 @@ module RandomWords
 
     def header_1(text)
       puts colorize_text("\n\n#{text}", :boldgreen)
-      puts colorize_text('=' * text.length, :boldgreen)
+      puts colorize_text("=" * text.length, :boldgreen)
       puts "\n"
     end
 
     def header_2(text)
       puts colorize_text("\n\n#{text}", :boldyellow)
-      puts colorize_text('-' * text.length, :boldyellow)
+      puts colorize_text("-" * text.length, :boldyellow)
       puts "\n"
     end
 
@@ -83,7 +84,7 @@ module RandomWords
     def combined_sentences(length = nil)
       number_of_sentences = length || 2
 
-      header_1('Random Combined Sentences:')
+      header_1("Random Combined Sentences:")
       @sources.count.times do |i|
         @sentence_generator.source = @sources[i - 1]
         @sentence_generator.sentence_length = :medium
@@ -92,20 +93,20 @@ module RandomWords
         s = @sentence_generator.sentence
         puts "#{marker} #{text(s)}"
         puts counter("#{s.split(/ /).count} words, #{s.length} characters")
-        puts colorize_text(' ' * 2, :boldwhite)
+        puts colorize_text(" " * 2, :boldwhite)
       end
     end
 
     def random_sentences
-      header_1('Random Sentences')
-      @sentence_generator.lengths.keys.each_with_index  do |length, index|
+      header_1("Random Sentences")
+      @sentence_generator.lengths.keys.each_with_index do |length, index|
         @sentence_generator.source = @sources[index]
         sentence(length)
       end
     end
 
     def random_paragraphs
-      header_1('Random Paragraphs')
+      header_1("Random Paragraphs")
       @sentence_generator.lengths.keys.each_with_index do |length, index|
         @sentence_generator.source = @sources[index]
         paragraphs(length, 3)
@@ -132,7 +133,7 @@ module RandomWords
 
     # Generate and print specified number of characters
     def random_characters
-      header_1('Random Characters (exact length)')
+      header_1("Random Characters (exact length)")
       [20, 50, 120, 200, 500].each_with_index do |i, index|
         @sentence_generator.source = @sources[index]
         chars = @sentence_generator.characters(i, whole_words: true)
@@ -143,7 +144,7 @@ module RandomWords
       max_characters = [15, 25, 53, 110, 600]
       min_characters = [10, 20, 50, 100, 500]
 
-      header_1('Random Characters (length range)')
+      header_1("Random Characters (length range)")
       max_characters.count.times do |i|
         @sentence_generator.source = @sources[i]
         chars = @sentence_generator.characters(min_characters[i], max_characters[i], whole_words: true)
@@ -153,7 +154,7 @@ module RandomWords
     end
 
     def marker
-      colorize_text('•', @colors[:marker])
+      colorize_text("•", @colors[:marker])
     end
 
     def text(text)
@@ -163,8 +164,7 @@ module RandomWords
     def language
       "#{colorize_text("(",
                        @colors[:bracket])}#{colorize_text("#{@sentence_generator.source}", @colors[:language])}#{colorize_text(")",
-                       @colors[:bracket])}"
-
+                                                                                                                               @colors[:bracket])}"
     end
 
     def counter(length)
@@ -192,91 +192,104 @@ end
   method: nil,
   debug: false,
   whitespace: true,
-  separator: ' ',
-  use_extended_punctuation: false
+  separator: " ",
+  use_extended_punctuation: false,
 }
 
+markdown_help = <<HELP
+                                     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
+HELP
+
 OptionParser.new do |opts|
-  opts.banner = 'Usage: randw [options]'
+  opts.banner = "Usage: randw [options]"
 
-  opts.separator 'OPTIONS:'
+  opts.separator "OPTIONS:"
 
-  opts.on('-S', '--source SOURCE', 'Specify the source language (default: latin)') do |source|
+  opts.on("-S", "--source SOURCE", "Specify the source language (default: latin)") do |source|
     @options[:source] = source.to_source
   end
 
-  opts.on('-l', '--length LENGTH', 'Specify the length of the sentence [short|medium|long|very_long]') do |length|
+  opts.on("-l", "--length LENGTH", "Specify the length of the sentence [short|medium|long|very_long]") do |length|
     @options[:length] = case length
-                        when /^s/
-                          :short
-                        when /^l/
-                          :long
-                        when /^v/
-                          :very_long
-                        else
-                          :medium
-                        end
+      when /^s/
+        :short
+      when /^l/
+        :long
+      when /^v/
+        :very_long
+      else
+        :medium
+      end
   end
 
-  opts.on('--graf-length NUMBER', 'Specify the number of sentences in a paragraph') do |length|
+  opts.on("--graf-length NUMBER", "Specify the number of sentences in a paragraph") do |length|
     @options[:paragraph_length] = length.to_i
   end
 
-  opts.on('--[no-]extended', 'Specify whether to use extended punctuation in generated text') do |value|
+  opts.on("--[no-]extended", "Specify whether to use extended punctuation in generated text") do |value|
     @options[:use_extended_punctuation] = value
   end
 
-  opts.separator 'GENERATORS:'
+  opts.separator "GENERATORS:"
 
-  opts.on('-s', '--sentences [NUMBER]', 'Generate NUMBER of random sentences (default: 3)') do |number|
+  opts.on("-s", "--sentences [NUMBER]", "Generate NUMBER of random sentences (default: 3)") do |number|
     @options[:method] = :sentences
     @options[:count] = number&.to_i || 3
   end
 
-
-  opts.on('-p', '--paragraphs [NUMBER]', 'Generate NUMBER of random paragraphs (default: 3)') do |number|
+  opts.on("-p", "--paragraphs [NUMBER]", "Generate NUMBER of random paragraphs (default: 3)") do |number|
     @options[:method] = :paragraphs
     @options[:count] = number&.to_i || 3
   end
 
-  opts.on('-w', '--words [NUMBER]', 'Generate NUMBER of random words (default: 10)') do |number|
+  opts.on("-w", "--words [NUMBER]", "Generate NUMBER of random words (default: 10)") do |number|
     @options[:method] = :words
     @options[:count] = number&.to_i || 10
   end
 
-  opts.on('-c', '--characters [NUMBER]', 'Generate random characters of length (default: 100)') do |number|
+  opts.on("-c", "--characters [NUMBER]", "Generate random characters of length (default: 100)") do |number|
     @options[:method] = :characters
     @options[:count] = number&.to_i || 100
   end
 
-  opts.on('-m', '--markdown [SETTINGS]', 'Generate random markdown text, comma separated string like "latin,10,all"') do |settings|
+  opts.on("-m", "--markdown [SETTINGS]", "Generate random markdown text, comma separated string like \"latin,10,all\"\n#{markdown_help}") do |settings|
     @options[:method] = :markdown
-    @options[:markdown_settings] = settings || 'latin,10,all'
+    @options[:markdown_settings] = settings || "latin,10,all"
   end
 
-  opts.on('-H', '--html [SETTINGS]', 'Generate random html text, comma separated string like "latin,10,all"') do |settings|
+  opts.on("-H", "--html [SETTINGS]", "Generate random html text, comma separated string like \"latin,10,all\"") do |settings|
     @options[:method] = :html
-    @options[:markdown_settings] = settings || 'latin,10,all'
+    @options[:markdown_settings] = settings || "latin,10,all"
   end
 
-  opts.on('--password [LENGTH]', 'Generate a random password of LENGTH (default: 20)') do |len|
+  opts.on("--password [LENGTH]", "Generate a random password of LENGTH (default: 20)") do |len|
     @options[:method] = :password
     @options[:count] = len&.to_i || 20
   end
 
-  opts.separator 'PASSWORD OPTIONS:'
+  opts.separator "PASSWORD OPTIONS:"
 
-  opts.on('--separator CHAR', 'Specify the separator character for the password (default: " ")') do |separator|
+  opts.on("--separator CHAR", 'Specify the separator character for the password (default: " ")') do |separator|
     @options[:separator] = separator
   end
 
-  opts.on('-n', '--[no-]whitespace', 'Specify whether to remove whitespace in generated text (characters only)') do |value|
+  opts.on("-n", "--[no-]whitespace", "Specify whether to remove whitespace in generated text (characters only)") do |value|
     @options[:whitespace] = value
   end
 
-  opts.separator 'DICTIONARIES:'
+  opts.separator "DICTIONARIES:"
 
-  opts.on('--list-dictionaries', 'List available dictionaries') do
+  opts.on("--list-dictionaries", "List available dictionaries") do
     @rw = RandomWords::Generator.new(:latin)
 
     @rw.sources.each do |k, v|
@@ -287,29 +300,29 @@ OptionParser.new do |opts|
     Process.exit 0
   end
 
-  opts.on('--create-dictionary [NAME]', 'Create a new dictionary') do |name|
+  opts.on("--create-dictionary [NAME]", "Create a new dictionary") do |name|
     @rw = RandomWords::Generator.new(:latin)
     @rw.create_dictionary(name)
     Process.exit 0
   end
 
-  opts.separator 'OTHER OPTIONS:'
+  opts.separator "OTHER OPTIONS:"
 
-  opts.on('-d', '--debug', 'Enable debug mode, displays sentence/word/character counts') do
+  opts.on("-d", "--debug", "Enable debug mode, displays sentence/word/character counts") do
     @options[:debug] = true
   end
 
-  opts.on('-h', '--help', 'Display this help message') do
+  opts.on("-h", "--help", "Display this help message") do
     puts opts
     exit
   end
 
-  opts.on('-v', '--version', 'Display the version') do
+  opts.on("-v", "--version", "Display the version") do
     puts "RandomWords v#{RandomWords::VERSION}"
     exit
   end
 
-  opts.on('-t', '--test', 'Run the full debug test') do
+  opts.on("-t", "--test", "Run the full debug test") do
     @options[:method] = :test
     @options[:debug] = true
   end
@@ -334,7 +347,7 @@ def markdown_settings(settings)
     grafs: 10,
     sentences: base_config[:paragraph_length],
     length: base_config[:sentence_length],
-    decorate: true,
+    decorate: false,
     link: false,
     ul: false,
     ol: false,
@@ -343,16 +356,17 @@ def markdown_settings(settings)
     code: false,
     mark: false,
     headers: false,
-    table: false
+    table: false,
   }
   sources = []
   RandomWords::Generator.new(:latin).sources.each { |k, v| sources.concat(v.names.map(&:to_s)) }
 
   markdown_options = defaults.dup
   settings = settings.split(%r{[,/.\|]}).map(&:strip)
+
   settings.each do |setting|
     case setting
-    when /^a(ll)?/
+    when /^all$/
       new_options = {
         decorate: true,
         link: true,
@@ -364,35 +378,37 @@ def markdown_settings(settings)
         mark: true,
         headers: true,
         image: true,
-        table: true
+        table: true,
       }
       markdown_options.merge!(new_options)
     when Regexp.union(sources)
       markdown_options[:source] = setting.to_source
     when /^\d+$/
       markdown_options[:grafs] = setting.to_i
-    when /^dec/
+    when 'dec', 'decorate'
       markdown_options[:decorate] = true
-    when /^link/
+    when 'link'
       markdown_options[:link] = true
-    when /^ul/
+    when 'ul'
       markdown_options[:ul] = true
-    when /^ol/
+    when 'ol'
       markdown_options[:ol] = true
-    when /^dl/
+    when 'dl'
       markdown_options[:dl] = true
-    when /^bq/
+    when 'bq', 'blockquote'
       markdown_options[:bq] = true
-    when /^co/
+    when 'code'
       markdown_options[:code] = true
-    when /^ma/
+    when 'mark'
       markdown_options[:mark] = true
-    when /^h/
+    when 'header', 'h'
       markdown_options[:headers] = true
-    when /^t(a|bl)/
+    when 'table', 't'
       markdown_options[:table] = true
-    when /^[smlv]/
+    when 'short', 's', 'medium', 'med', 'm', 'long', 'l', 'very_long', 'vl'
       markdown_options[:length] = setting.to_length
+    else
+      markdown_options[:source] = setting.to_source
     end
   end
 
@@ -410,21 +426,21 @@ when :sentences
   total = {
     sentences: @options[:count],
     words: 0,
-    characters: 0
+    characters: 0,
   }
   # @options[:count].times do
-    s = @rw.sentences(@options[:count]).join(' ')
-    total[:words] += s.split(/ /).count
-    total[:characters] += s.length
-    print s
-    debug "#{s.split(/ /).count}w, #{s.length}c"
+  s = @rw.sentences(@options[:count]).join(" ")
+  total[:words] += s.split(/ /).count
+  total[:characters] += s.length
+  print s
+  debug "#{s.split(/ /).count}w, #{s.length}c"
   # end
   debug "Total: #{total[:sentences]}s, #{total[:words]}w, #{total[:characters]}c"
 when :paragraphs
   total = {
     sentences: 0,
     words: 0,
-    characters: 0
+    characters: 0,
   }
   @options[:count].times do
     p = @rw.paragraph
@@ -450,14 +466,18 @@ when :markdown, :html
   @rw.sentence_length = settings[:length] || :medium
   @rw.paragraph_length = settings[:sentences] || 5
   @rw.use_extended_punctuation = settings[:use_extended_punctuation] || false
-  puts @rw.html(settings)
+  if @options[:method] == :markdown
+    puts @rw.markdown(settings)
+  else
+    puts @rw.html(settings)
+  end
 when :password
   p = @rw.characters(20, whitespace: @options[:whitespace])
 
   m = p.match(/[oleats]/i)
   if m
     num_char = m.begin(0)
-    char = m[0].tr('oleats', '013475')
+    char = m[0].tr("oleats", "013475")
   else
     num_char = p.length
     char = rand(10).to_s
@@ -468,7 +488,7 @@ when :password
   cap_char = rand(20) while p[cap_char] !~ /[a-z]/
   p[cap_char] = p[cap_char].upcase
 
-  tail_char = p =~ /[^a-z0-9]/i ? '' : %w[! @ # $ % ^ & * ( ) _ + - = ; : < > , . ? /].sample
+  tail_char = p =~ /[^a-z0-9]/i ? "" : %w[! @ # $ % ^ & * ( ) _ + - = ; : < > , . ? /].sample
 
   print p.gsub(/ /, @options[:separator]) + tail_char
   debug "#{p.split(@options[:separator]).count}w, #{p.length}c"
@@ -476,5 +496,5 @@ when :test
   t = RandomWords::Terminal.new(@options[:source])
   t.print_test
 else
-  puts 'Please specify a valid method: sentences, paragraphs, words, or characters.'
+  puts "Please specify a valid method: sentences, paragraphs, words, or characters."
 end

data/lib/random-words/array.rb

@@ -33,19 +33,39 @@ module RandomWords
     def split_names
       first_names = []
       last_names = []
+      full_names = []
       first_names_ended = false
+      last_names_ended = false
+
+      sections = [[]]
+      idx = 0
       each do |line|
-        if line.strip =~ /^[\w-]+$/ && !first_names_ended
-          first_names << line
-        elsif first_names_ended
-          last_names << line
+        if line.strip.empty? || line !~ /^[[:word:]]/i
+          idx += 1
+          sections[idx] = []
         else
-          first_names_ended = true
+          sections[idx] << line.strip
         end
       end
+
+      if sections.length == 1
+        first_names = []
+        last_names = []
+        full_names = sections[0]
+      elsif sections.length == 2
+        first_names = sections[0]
+        last_names = sections[1]
+        full_names = []
+      else
+        first_names = sections[0]
+        last_names = sections[1]
+        full_names = sections[2]
+      end
+
       first_names.delete_if(&:empty?)
       last_names.delete_if(&:empty?)
-      [first_names, last_names]
+      full_names.delete_if(&:empty?)
+      [first_names, last_names, full_names]
     end
   end
-end
+end