unique_names_generator 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b327e97d35d0196016feff3a0f7814f4b398405c58a6a398beb835a364a74d
-  data.tar.gz: ad729f68a508030690fcf38c56bd899bce70e372886a113995ef63ca8e896751
+  metadata.gz: f9773f651a33cab35886353896b6138a9e1df7d1bbecf1c0573be4da2567eda2
+  data.tar.gz: 3dac60147e276911a7c17c505afe95e305800e6aeb897797d925a1844fe2d57d
 SHA512:
-  metadata.gz: '038bb93ba4b7bc097fe528575bc6ba4debb7810b8f2c0d204cdd2a08bfaf82cd888ee7972afb14ed34d09f7fecde9f62b3e0b7ef18246720f67b59e24e69fcb4'
-  data.tar.gz: 4c4aa71be2f0f243ebf30f1184d41842c2627380271428463c53120bf2676e49d6539f492b948d5908d99e3c1be3f9f6e029fe05f4118e7a05e014777edecedb
+  metadata.gz: 61b362f06916f9f08ab89e91421a4ee0c482433a4d6c9843645d6b02feab966d6197383993425fbf8b1740d211ea53ef149e9d632df0669172755a57be977a32
+  data.tar.gz: 0534cb36f75cc5e04fe72c9cdae7e05199880d0e06f1b3e0d7f6f797644f882980356232a79a2c06bb0a54da29ffbdc67f07e22ee6b2e96b9d51548e0aae78e5

data/.rubocop.yml

@@ -27,5 +27,12 @@ Style/SymbolArray:
   Exclude:
     - 'spec/**/*'
 
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'spec/**/*'
+
 Style/NumericPredicate:
-  Enabled: false
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 150

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unique_names_generator (0.1.1)
+    unique_names_generator (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,7 +12,7 @@ by adding `unique_names_generator` to your list of gemfile dependencies:
 Add this line to your application's Gemfile:
 
 ```
-gem 'unique_names_generator', "~> 0.1.1"
+gem 'unique_names_generator', '~> 0.2.0'
 ```
 
 And then execute:
@@ -29,16 +29,19 @@ $ gem install unique_names_generator
 
 ## Usage
 
-In a nutshell, you can begin generating randon names with UniqueNamesGenerator by simply specifying an array of one or more dictionaries via `UniqueNamesGenerator.generate`. Available dictionary types are `[:adjectives, :animals, :colors, :languages, :names, :numbers, :star_wars]`.
+In a nutshell, you can begin generating random names with UniqueNamesGenerator by simply creating a Generator instance and specifying an array of one or more dictionaries. Available dictionary types are `[:adjectives, :animals, :colors, :languages, :names, :numbers, :star_wars]`.
 
 ```ruby
-UniqueNamesGenerator.generate([:adjectives, :animals])
+generator = UniqueNamesGenerator::Generator.new([:adjectives, :animals])
+generator.generate
 # => Generates ex: "dramatic_limpet"
 
-UniqueNamesGenerator.generate([:adjectives, :colors, :animals])
+generator = UniqueNamesGenerator::Generator.new([:adjectives, :colors, :animals])
+generator.generate
 # => Generates ex: "tremendous_brown_cat"
 
-UniqueNamesGenerator.generate([:adjectives, :names, :numbers])
+generator = UniqueNamesGenerator::Generator.new([:adjectives, :names, :numbers])
+generator.generate
 # => Generates ex: "doubtful_wanda_979"
 ```
 
@@ -46,7 +49,9 @@ To use custom dictionaries, simply include your array of strings as part of the
 
 ```ruby
 drinks = ['Sprite', 'Coca-Cola', 'Juice', 'Tea']
-UniqueNamesGenerator.generate([:colors, drinks])
+
+generator = UniqueNamesGenerator::Generator.new([:colors, drinks])
+generator.generate
 # => Generates ex: "cyan_sprite"
 ```
 
@@ -55,17 +60,20 @@ UniqueNamesGenerator.generate([:colors, drinks])
 UniqueNamesGenerator can be used with either the default provided config (`separator: '_', style: :lowercase, creativity: 0`) or by specifying any of your own configuration options for seeding, seperator, style and creativity.
 
 #### More details on possible options
-
-- **Separator options**: Any ASCII character string such as underscore, dash or blank space. `nil` for no space.
+- **Dictionaries**: [Array<Symbol, Array<String>>] List of dictionaries to use for name generation. Can be symbols referring to built-in dictionaries or custom arrays of strings.
+- **Separator**: [String] Character(s) used to join words in the generated name. Default: '_'. `nil` can be used for no space.
   - ex: '_', '-', ' ' or `nil` for no space.
-- **Style options**: Atom, one of `:lowercase`, `:uppercase`, `:capital`.
-- **Creativity options**: An integer or float between 1 and 10.
+- **Style**: [Symbol] Capitalization style for generated names.
+  - Options: `:lowercase`, `:uppercase`, `:capital`. Default: `:lowercase`
+- **Creativity**: [Integer] Level of creativity in name generation, affecting word selection. Must be between 0 and 10. A Float value can also be used. Default: 0
 
 ```ruby
-UniqueNamesGenerator.generate([:colors, :animals], style: :capital, separator: ' ')
+generator = UniqueNamesGenerator::Generator.new([:colors, :animals], style: :capital, separator: ' ')
+generator.generate
 # => Generates ex: "Lavender Marlin"
 
-UniqueNamesGenerator.generate([:colors, :adjectives, :animals], creativity: 8, style: :capital, separator: ' ')
+generator = UniqueNamesGenerator::Generator.new([:colors, :adjectives, :animals], creativity: 8, style: :capital, separator: ' ')
+generator.generate
 # => Generates ex: "Yellow Local Hippopotamus"
 ```
 
@@ -73,20 +81,22 @@ UniqueNamesGenerator.generate([:colors, :adjectives, :animals], creativity: 8, s
 Using the creativity option changes how `UniqueNamesGenerator` selects terms from the dictionaries in use, essentially acting as a multiplier. For dictionaries with a similar term length, while using a seed, the selection may at times appear to be alphabetical or closely related (ex: "Amber Anakin Skywalker"). Utilizing the `creative` option with a value between 1 and 10 will use a sequential multiplier for subsequent dictionaries providing a seemingly more "random" or "creative" result whilst still allowing for seeded generation.
 
 ```ruby
-UniqueNamesGenerator.generate([:colors, :adjectives, :animals], creativity: 8, seed: 'f6da7a28-5ae6-4d6b-b3b8-a197b99ed4eb')
+generator = UniqueNamesGenerator::Generator.new([:colors, :adjectives, :animals], creativity: 8)
+generator.generate(seed: 'f6da7a28-5ae6-4d6b-b3b8-a197b99ed4eb')
 
 # => Seed "f6da7a28-5ae6-4d6b-b3b8-a197b99ed4eb" with creativity of 8 always generates: "plum_flying_cobra"
 ```
 
 ### Seeded Generation
 
-A seed can be used to deterministically generate a name. As long as the provided seed and creativity values are the same between runs, then the generated name will also always be the same. Simply provide a string or integer as the value of the seed key, ie; `seed: 'hello'`. 
+A seed can be used to deterministically generate a name. As long as the provided seed and creativity values are the same between runs, then the generated name will also always be the same. Simply provide a string or integer as an argument to the generate method, ie; `seed: 'hello'`. 
 
-_(**Usecase example:** generate a username for an authenticated user based on UUID. Ex: `13a5d03e-61d0-4b5b-ae3b-57953c268c5f` will always generate the name "beige_boba_fett_145" when used together with the colors/star_wars/numbers dictionaries)._
+_(**Usecase example:** generate a username for an authenticated user based on UUID. Ex: `13a5d03e-61d0-4b5b-ae3b-57953c268c5f` will always generate the name "coral_greedo_320" when used together with the colors/star_wars/numbers dictionaries)._
 
 ```ruby
-UniqueNamesGenerator.generate([:colors, :star_wars, :numbers], seed: '13a5d03e-61d0-4b5b-ae3b-57953c268c5f')
-# => Seed "13a5d03e-61d0-4b5b-ae3b-57953c268c5f" always generates: "beige_boba_fett_145"
+generator = UniqueNamesGenerator::Generator.new([:colors, :star_wars, :numbers])
+generator.generate(seed: '13a5d03e-61d0-4b5b-ae3b-57953c268c5f')
+# => Seed "13a5d03e-61d0-4b5b-ae3b-57953c268c5f" always generates: "coral_greedo_320"
 ```
 
 ## License

data/lib/unique_names_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UniqueNamesGenerator
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/unique_names_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # An implementation of a unique_names_generator in Ruby
-# with support for PRNG/seeds
+# with support for PRNG/deterministic seeds
 
 require_relative './unique_names_generator/seed'
 
@@ -15,24 +15,33 @@ require_relative './unique_names_generator/dictionaries/star_wars'
 
 # UniqueNamesGenerator implementation
 module UniqueNamesGenerator
-  module_function
-
-  def generate(dictionaries, separator: '_', style: :lowercase, seed: nil, creativity: 0)
-    @separator = separator
-    @style = style
-    @seed = seed
-    @creativity = creativity
-
-    if creativity.negative? || creativity > 10
-      raise ArgumentError, 'Outside creativity range. Must be between 0 and 10.'
+  # UniqueNamesGenerator::Generator
+  #
+  # This class generates unique names based on specified dictionaries and configuration options.
+  # It allows for customizable name generation with various styles, separators, and creativity levels.
+  class Generator
+    def initialize(dictionaries, separator: '_', style: :lowercase, creativity: 0)
+      @dictionaries = dictionaries
+      @separator = separator
+      @style = style
+      @creativity = creativity
+
+      # Will raise error if any specified dictionary is invalid
+      dictionaries.map { |dictionary| word_list(dictionary) }
+      raise ArgumentError, 'Outside creativity range. Must be between 0 and 10.' if outside_creativity_bounds?
     end
 
-    generate_name(dictionaries)
-  end
+    def generate(seed: nil)
+      @seed = seed
+      generate_name(@dictionaries)
+    end
 
-  class << self
     private
 
+    def outside_creativity_bounds?
+      @creativity.negative? || @creativity > 10
+    end
+
     def match_word_list(dictionary)
       module_name = camelize_dictionary(dictionary)
       begin
@@ -146,7 +155,7 @@ module UniqueNamesGenerator
     end
 
     def raise_invalid_dictionary(dictionary)
-      raise ArgumentError, "Invalid dictionary: #{dictionary}"
+      raise ArgumentError, "Invalid dictionary #{dictionary}"
     end
 
     def format_with_separator(word)

data/unique_names_generator.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/jongirard/unique_names_generator_ruby'
   s.metadata      = { 'homepage_uri' => 'https://github.com/jongirard/unique_names_generator_ruby',
                       'source_code_uri' => 'https://github.com/jongirard/unique_names_generator_ruby',
-                      'documentation_uri' => 'https://jongirard.github.io/unique_names_generator_ruby' }
+                      'documentation_uri' => 'https://www.rubydoc.info/gems/unique_names_generator/' }
   s.require_paths = ['lib']
   s.license       = 'MIT'
   s.files         = Dir.chdir(File.expand_path(__dir__)) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unique_names_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jon Girard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -60,7 +60,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jongirard/unique_names_generator_ruby
   source_code_uri: https://github.com/jongirard/unique_names_generator_ruby
-  documentation_uri: https://jongirard.github.io/unique_names_generator_ruby
+  documentation_uri: https://www.rubydoc.info/gems/unique_names_generator/
 post_install_message:
 rdoc_options: []
 require_paths: