random-words 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42163e52744bbdbc3f9bd4d0353df06cfe1942d69b8af451833e5b5db370d068
+  data.tar.gz: 121a950df08f9729228b17382f7c6af429139d181f27b50f844969597d587c28
+SHA512:
+  metadata.gz: 06ad1503982001ecbe33f28972f158e2afb9b77f0620fff22ee38b1ff11fffdf538756e9975fe151be652fa1849a86f748fb79bb29989ff92ba867c156d4ba2b
+  data.tar.gz: 6f213ced087fa35366c9cb28c2a435fac1d47f0c6b9e417e15379d814fd1e76134f075d6af8eefd5ff31df5272d1e03e970990d9885fe0d627f8a06057658311

data/.irbrc

@@ -0,0 +1,4 @@
+$: << 'lib'
+require_relative 'lib/random-words'
+
+@rw = RandomWords::Generator.new

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--pattern "{spec,lib}/**/*_spec.rb"

data/.rspec_status

@@ -0,0 +1,39 @@
+example_id                         | status | run_time        |
+---------------------------------- | ------ | --------------- |
+./spec/generator_spec.rb[1:1:1]    | passed | 0.00343 seconds |
+./spec/generator_spec.rb[1:2:1]    | passed | 0.00242 seconds |
+./spec/generator_spec.rb[1:3:1]    | passed | 0.0016 seconds  |
+./spec/generator_spec.rb[1:4:1]    | passed | 0.00094 seconds |
+./spec/generator_spec.rb[1:5:1]    | passed | 0.00259 seconds |
+./spec/generator_spec.rb[1:5:2]    | passed | 0.00107 seconds |
+./spec/generator_spec.rb[1:5:3]    | passed | 0.00061 seconds |
+./spec/generator_spec.rb[1:5:4]    | passed | 0.00099 seconds |
+./spec/generator_spec.rb[1:5:5]    | passed | 0.00092 seconds |
+./spec/generator_spec.rb[1:6:1]    | passed | 0.00113 seconds |
+./spec/generator_spec.rb[1:7:1]    | passed | 0.00059 seconds |
+./spec/generator_spec.rb[1:7:2]    | passed | 0.00129 seconds |
+./spec/generator_spec.rb[1:7:3]    | passed | 0.00067 seconds |
+./spec/generator_spec.rb[1:8:1]    | passed | 0.00103 seconds |
+./spec/generator_spec.rb[1:9:1]    | passed | 0.00069 seconds |
+./spec/generator_spec.rb[1:10:1]   | passed | 0.00071 seconds |
+./spec/generator_spec.rb[1:11:1]   | passed | 0.0005 seconds  |
+./spec/generator_spec.rb[1:12:1]   | passed | 0.00224 seconds |
+./spec/generator_spec.rb[1:13:1]   | passed | 0.0005 seconds  |
+./spec/generator_spec.rb[1:13:2]   | passed | 0.00055 seconds |
+./spec/generator_spec.rb[1:14:1]   | passed | 0.0005 seconds  |
+./spec/generator_spec.rb[1:14:2]   | passed | 0.00077 seconds |
+./spec/hello_world_spec.rb[1:1]    | passed | 0.00003 seconds |
+./spec/initialize_spec.rb[1:1:1]   | passed | 0.00052 seconds |
+./spec/initialize_spec.rb[1:1:2]   | passed | 0.00049 seconds |
+./spec/initialize_spec.rb[1:1:3]   | passed | 0.00048 seconds |
+./spec/initialize_spec.rb[1:1:4]   | passed | 0.00043 seconds |
+./spec/initialize_spec.rb[1:1:5:1] | passed | 0.00073 seconds |
+./spec/initialize_spec.rb[1:1:6:1] | passed | 0.00054 seconds |
+./spec/module_spec.rb[1:1]         | passed | 0.00059 seconds |
+./spec/string_spec.rb[1:1:1]       | passed | 0.00003 seconds |
+./spec/string_spec.rb[1:2:1]       | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:2:2]       | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:2:3]       | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:3:1]       | passed | 0.00005 seconds |
+./spec/string_spec.rb[1:4:1]       | passed | 0.00002 seconds |
+./spec/string_spec.rb[1:5:1]       | passed | 0.00003 seconds |

data/.rubocop.yml

@@ -0,0 +1,64 @@
+AllCops:
+  NewCops: enable
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Lint/ScriptPermission:
+  Exclude:
+    - 'lib/random-words.rb'
+    - 'lib/random-words/loremipsum.rb'
+    - 'lib/random-words/string.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AutoCorrect.
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/random-words/loremipsum.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 39
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 300
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 50
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/random-words/string.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: RequireEnglish.
+# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_perl_names
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 135

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+### 1.0.3
+
+2025-04-09 09:00
+
+### 1.0.2
+
+2025-04-09 08:59
+
+### 1.0.1
+
+2025-04-09 08:41
+
+#### NEW
+
+- Add randw binary
+
+#### IMPROVED
+
+- More testable methods
+- Expand README
+
+### 1.0.0
+
+2025-04-08 07:34
+
+#### IMPROVED
+
+- Add documentation
+

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in snibbets.gemspec.
+gemspec
+
+gem 'awesome_print', '~> 1.9'
+gem 'bundler', '~> 2.0'
+gem 'gem-release', '~> 2.2'
+gem 'parse_gemspec-cli', '~> 1.0'
+gem 'rake', '~> 13.0'
+gem 'rdoc', '~> 6.3.4.1'
+gem 'rspec', '~> 3.0'
+gem 'simplecov', '~> 0.21'
+gem 'simplecov-console', '~> 0.9'
+gem 'standard', '~> 1.3'
+gem 'yard', '~> 0.9', '>= 0.9.36'

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    random-words (1.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.3)
+    awesome_print (1.9.2)
+    diff-lcs (1.6.1)
+    docile (1.4.1)
+    gem-release (2.2.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    multi_json (1.15.0)
+    parallel (1.26.3)
+    parse_gemspec (1.0.0)
+    parse_gemspec-cli (1.0.0)
+      multi_json
+      parse_gemspec
+      thor
+    parser (3.3.7.4)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.3.4.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.43.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    standard (1.29.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.3.2)
+    unicode-display_width (2.6.0)
+    yard (0.9.37)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.9)
+  bundler (~> 2.0)
+  gem-release (~> 2.2)
+  parse_gemspec-cli (~> 1.0)
+  rake (~> 13.0)
+  random-words!
+  rdoc (~> 6.3.4.1)
+  rspec (~> 3.0)
+  simplecov (~> 0.21)
+  simplecov-console (~> 0.9)
+  standard (~> 1.3)
+  yard (~> 0.9, >= 0.9.36)
+
+BUNDLED WITH
+   2.6.6

data/README.md

@@ -0,0 +1,90 @@
+
+
+[![RubyGems.org](https://img.shields.io/gem/v/snibbets)](https://rubygems.org/gems/snibbets)
+
+A random text (Lorem Ipsum) generator.
+
+### Installation
+
+    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).
+
+### CLI
+
+The gem installs a binary `randw`. It can generate random characters, sentences, paragraphs, 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)
+    -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
+```
+
+### Library
+
+```ruby
+require 'random-words'
+
+# Argument defines source dictionary (latin, english, corporate, bacon)
+rw = RandomWords::Generator.new(:corporate)
+# Change source dictionary and re-init
+rw.source = :bacon
+
+rw.paragraph_length = 5 # Number of sentences in a paragraph (default 3)
+rw.sentence_length = :short # :short, :medium, :long, :verylong (default :medium)
+
+# Redefine lengths, can include :short, :medium, :long, and :verylong
+rw.lengths = { short: 100, medium: 300 }
+
+## Characters
+# Outputs words but limits total to characters
+puts rw.characters(20)
+# limits total characters, allowing truncation
+puts rw.characters(20, whole_words: false)
+
+## Sentences
+# Output a sentence based on @sentence_length
+puts rw.sentence
+# Output a sentence with a specific number of characters
+puts rw.sentence(300)
+# Output an array of # sentences
+puts rw.sentences(3)
+
+## Paragraphs
+# Output a paragraph based on @paragraph_length
+puts rw.paragraph
+# Output a paragraph with a specified number of sentences
+# Sentence length is still determined by @sentence_length
+puts rw.paragraph(2)
+
+## Attributes
+# Parts of speech (arrays, r/w)
+rw.adjectives
+rw.articles
+rw.clauses
+rw.nouns
+rw.plural_nouns
+rw.verbs
+rw.plural_verbs
+rw.subordinate_conjunctions
+rw.numbers
+
+# Other attributes (r/w)
+rw.source
+rw.paragraph_length
+rw.sentence_length
+```

data/Rakefile

@@ -0,0 +1,85 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'standard/rake'
+require 'yard'
+
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
+  rd.title = 'RandomWords'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/random-words/**/*.rb']
+  t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--no-private', '-p', 'yard_templates']
+  # t.stats_options = ['--list-undoc']
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--pattern spec/**/*_spec.rb'
+end
+
+task default: %i[test]
+
+desc 'Alias for build'
+task package: :build
+
+task test: 'spec'
+task lint: 'standard'
+task format: 'standard:fix'
+
+desc 'Open an interactive ruby console'
+task :console do
+  require 'irb'
+  require 'bundler/setup'
+  require 'random-words'
+  ARGV.clear
+  IRB.start
+end
+
+desc 'Development version check'
+task :ver do
+  gver = `git ver`
+  cver = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+  res = `grep VERSION lib/random-words/version.rb`
+  version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
+  puts "git tag: #{gver}"
+  puts "version.rb: #{version}"
+  puts "changelog: #{cver}"
+end
+
+desc 'Changelog version check'
+task :cver do
+  puts IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+end
+
+desc 'Bump incremental version number'
+task :bump, :type do |_, args|
+  args.with_defaults(type: 'inc')
+  version_file = 'lib/random-words/version.rb'
+  content = IO.read(version_file)
+  content.sub!(/VERSION = '(?<major>\d+)\.(?<minor>\d+)\.(?<inc>\d+)(?<pre>\S+)?'/) do
+    m = Regexp.last_match
+    major = m['major'].to_i
+    minor = m['minor'].to_i
+    inc = m['inc'].to_i
+    pre = m['pre']
+
+    case args[:type]
+    when /^maj/
+      major += 1
+      minor = 0
+      inc = 0
+    when /^min/
+      minor += 1
+      inc = 0
+    else
+      inc += 1
+    end
+
+    $stdout.puts "At version #{major}.#{minor}.#{inc}#{pre}"
+    "VERSION = '#{major}.#{minor}.#{inc}#{pre}'"
+  end
+  File.open(version_file, 'w+') { |f| f.puts content }
+end