random-words 1.0.8 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c87c310a16cb1a1afc9fbcc9603021da8c2cfcb27602fdfd03b1141b2f82e39e
-  data.tar.gz: ef2773e2c2f1d834ef4f16655eebda7376417c82f6f11762df47c311d0b06750
+  metadata.gz: 3e432bb793efaf4e7187dda39d35ec168077810dad3076d369aa6884952a5693
+  data.tar.gz: 44d83919366580b073691440d200a605efdc07ea6b6f39bab6995d9b57c7cac4
 SHA512:
-  metadata.gz: eb2bb1a14981fcfe5a2c2e278a781109ff60ca6fec79f19c48b2b102433169bc586f263159980f448d6ce9948cec73739c0e40d619c4453cbc664a2c993ec35a
-  data.tar.gz: c1c28313e3bd6a63247db6b7db039b9173fd918057f3c79b581f4d6014ba7d0b6ff8381e7493336fc43c6fb2f3af16a4c780dec3459f90a0a7eb5c2c0c64cd67
+  metadata.gz: a507d5bb5f3b44c60e06effbfee25487cbb84a30d941aa910b60b413195a534ce4fb75bcb88113ed0714bc38536c0c94f4b5724a61a8031cf2e5b63eb6a0b565
+  data.tar.gz: 242e5627fbee393dfecf0a9297985c66678c1698b5b66b46c634d796cd301fabb35d5dcceec94b9575547eddbb5b966b5561585617418c00e4ea71b29b48c046

data/.rspec

@@ -1,4 +1,3 @@
 --format progress
 --color auto
 --require spec_helper
--b

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### 1.0.10
+
+2025-04-22 06:30
+
+#### NEW
+
+- Debug mode that shows parts of speech in output
+
+#### IMPROVED
+
+- Fix clauses so sentences make more sense
+- Number to word phrasing
+- Fixes for spec tests
+
+### 1.0.9
+
+2025-04-20 06:34
+
+#### NEW
+
+- Random punctuation between clauses
+
+#### IMPROVED
+
+- Add espanol as a trigger for spanish (with tilde)
+
+#### FIXED
+
+- Better handling of extended puntuation arguments
+
 ### 1.0.8
 
 2025-04-17 13:37

data/LICENSE

@@ -0,0 +1,19 @@
+MIT License Copyright (c) 2025 Brett Terpstra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
 
 
-[![RubyGems.org](https://img.shields.io/gem/v/random-words)](https://rubygems.org/gems/random-words)
+[![RubyGems.org](https://img.shields.io/gem/v/random-words)](https://rubygems.org/gems/random-words)[![](https://img.shields.io/github/license/ttscoff/random-words)](https://opensource.org/licenses/MIT)
 
 A random text (Lorem Ipsum) generator.
 
@@ -17,7 +17,7 @@ you use [Homebrew](https://brew.sh).
 ### CLI
 
 The gem installs a binary `randw`. It can generate random
-characters, sentences, paragraphs, markdown, html,  and
+characters, sentences, paragraphs, markdown, html, and
 passwords.
 
 ```console
@@ -67,7 +67,7 @@ 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
+can add any digits to determine how many paragraphs are
 generated (default 5), e.g. `corporate/medium/10`.
 
 Then you can add individual elements, or use `/all` to
@@ -86,6 +86,7 @@ trigger all elements. The elements available are:
 | headers | add headlines             |
 | image   | add images                |
 | table   | add tables                |
+| x       | add extended punctuation  |
 
 The number of elements inserted depends on the length you specify.
 
@@ -167,6 +168,7 @@ YAML configuration. It contains the keys:
 name: english
 description: English words
 triggers: [english]
+extended_punctuation: false
 ```
 
 A default configuration file will be created when running `--create-dictionary` with the CLI.
@@ -177,8 +179,11 @@ A default configuration file will be created when running `--create-dictionary`
 - `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).
-
+    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).
+- `extended_punctuation`: Whether to include extended
+  punctuation like parenthesis, quotes, and ellipsis.
 
 
 ##### Terminators
@@ -211,13 +216,13 @@ 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.
+The `names.txt` file is just used when creating random
+names. 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
 
@@ -232,8 +237,11 @@ If you create a fun dictionary, please let me know (or make a PR) and I'll gladl
 ```ruby
 require 'random-words'
 
-# Argument defines source dictionary (latin, english, corporate, bacon)
+# Argument defines source dictionary (latin, english, corporate, bacon, etc.)
 rw = RandomWords::Generator.new(:corporate)
+
+rw.sources # List all available dictionaries
+
 # Change source dictionary and re-init
 rw.source = :bacon
 

data/bin/randw

@@ -44,6 +44,10 @@ module RandomWords
     end
 
     def colorize_text(text, color)
+      return text unless $stdout.isatty
+
+      return text unless colors.key?(color)
+
       color_code = colors[color]
 
       "\e[#{color_code}m#{text}\e[0m"
@@ -190,10 +194,9 @@ end
   paragraph_length: 3,
   count: 1,
   method: nil,
-  debug: false,
+  debug: 0,
   whitespace: true,
-  separator: " ",
-  use_extended_punctuation: false,
+  separator: " "
 }
 
 markdown_help = <<HELP
@@ -308,8 +311,9 @@ OptionParser.new do |opts|
 
   opts.separator "OTHER OPTIONS:"
 
-  opts.on("-d", "--debug", "Enable debug mode, displays sentence/word/character counts") do
+  opts.on("-d", "--debug [LEVEL]", "Enable debug mode, 1 displays sentence/word/character counts, 2 displays parts of speech (default 1)") do |level|
     @options[:debug] = true
+    @options[:debug_level] = level.to_i || 1
   end
 
   opts.on("-h", "--help", "Display this help message") do
@@ -357,6 +361,7 @@ def markdown_settings(settings)
     mark: false,
     headers: false,
     table: false,
+    extended: false
   }
   sources = []
   RandomWords::Generator.new(:latin).sources.each { |k, v| sources.concat(v.names.map(&:to_s)) }
@@ -379,6 +384,7 @@ def markdown_settings(settings)
         headers: true,
         image: true,
         table: true,
+        extended: true
       }
       markdown_options.merge!(new_options)
     when Regexp.union(sources)
@@ -407,6 +413,8 @@ def markdown_settings(settings)
       markdown_options[:table] = true
     when 'short', 's', 'medium', 'med', 'm', 'long', 'l', 'very_long', 'vl'
       markdown_options[:length] = setting.to_length
+    when 'x', 'extended'
+      markdown_options[:extended] = true
     else
       markdown_options[:source] = setting.to_source
     end
@@ -415,10 +423,12 @@ def markdown_settings(settings)
   markdown_options
 end
 
-@rw = RandomWords::Generator.new(@options[:source])
+@rw = RandomWords::Generator.new(@options[:source], { debug: @options[:debug_level] > 1 })
 @rw.sentence_length = @options[:length] || :medium
 @rw.paragraph_length = @options[:paragraph_length] || 3
-@rw.use_extended_punctuation = @options[:use_extended_punctuation] || false
+@options[:use_extended_punctuation] = @options[:use_extended_punctuation] ? true : false
+@rw.use_extended_punctuation = @options[:use_extended_punctuation] ? true : @rw.config.config[:use_extended_punctuation]
+
 @options[:count] = @options[:count].to_i
 
 case @options[:method]
@@ -465,7 +475,10 @@ when :markdown, :html
   @rw.source = settings[:source]
   @rw.sentence_length = settings[:length] || :medium
   @rw.paragraph_length = settings[:sentences] || 5
-  @rw.use_extended_punctuation = settings[:use_extended_punctuation] || false
+
+  @rw.use_extended_punctuation = settings[:extended] ? true : @options[:use_extended_punctuation]
+  settings[:extended] = @rw.use_extended_punctuation
+
   if @options[:method] == :markdown
     puts @rw.markdown(settings)
   else

data/lib/random-words/array.rb

@@ -67,5 +67,14 @@ module RandomWords
       full_names.delete_if(&:empty?)
       [first_names, last_names, full_names]
     end
+
+    def rotate
+      return self if empty?
+
+      # Rotate the array by moving the first element to the end
+      first_element = shift
+      push(first_element)
+      self
+    end
   end
 end

data/lib/random-words/boolean.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RandomWords
+  # @!visibility private
+  # This class is used to convert boolean values to strings, integers, and floats.
+  # It also provides a method to check if the value is truish.
+  class ::FalseClass
+    # Convert a boolean value to a string.
+    # @return [String] "true" or "false"
+    def to_s
+      'false'
+    end
+
+    # Convert a boolean value to an integer.
+    # @return [Integer] 1 for true, 0 for false
+    def to_i
+      0
+    end
+
+    # Convert a boolean value to a float.
+    # @return [Float] 1.0 for true, 0.0 for false
+    def to_f
+      0.0
+    end
+
+    # Shim for truish
+    # @return [Boolean] false
+    def trueish?
+      false
+    end
+  end
+
+  # @!visibility private
+  # This class is used to convert boolean values to strings, integers, and floats.
+  # It also provides a method to check if the value is truish.
+  class ::TrueClass
+    # Convert a boolean value to a string.
+    # @return [String] "true" or "false"
+    def to_s
+      'true'
+    end
+
+    # Convert a boolean value to an integer.
+    # @return [Integer] 1 for true, 0 for false
+    def to_i
+      1
+    end
+
+    # Convert a boolean value to a float.
+    # @return [Float] 1.0 for true, 0.0 for false
+    def to_f
+      1.0
+    end
+
+    # Shim for truish
+    def trueish?
+      true
+    end
+  end
+end

data/lib/random-words/config.rb

@@ -34,6 +34,9 @@ module RandomWords
     # Source directory for languages
     attr_reader :source_dir
 
+    # Base config
+    attr_reader :config
+
     # Initialize the config with the given language
     # @param lang [Symbol] The language to use
     # @raise [RuntimeError] if no dictionary is found for the given language
@@ -204,10 +207,12 @@ module RandomWords
     # @param configuration [Hash] The configuration hash
     # @return [Hash] The converted configuration hash
     def handle_config(configuration)
+      ext_punc = configuration[:extended_punctuation]
       {
         source: configuration[:source].to_source || :latin,
         sentence_length: configuration[:length].to_length || :medium,
-        paragraph_length: configuration[:paragraph_length].to_i || 5
+        paragraph_length: configuration[:paragraph_length].to_i || 5,
+        use_extended_punctuation: (ext_punc && ext_punc.trueish?) || false
       }
     end
 
@@ -244,7 +249,8 @@ module RandomWords
       config = {
         'source' => 'latin',
         'length' => 'medium',
-        'paragraph_length' => 5
+        'paragraph_length' => 5,
+        'extended_punctuation' => false
       }
       File.write(config_file, config.to_yaml)
       warn "Created #{config_file}"