random_username 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fcaa30c20e7ef7460e9b0e54fd794a57cb59b2e
-  data.tar.gz: 83edcf252a32e76d9cc2cfb0613d39187375da55
+  metadata.gz: a675071998814bca647af20257e0ec2a73809f9c
+  data.tar.gz: 7c9585857dfe4f97157dfc420474eddf858568c4
 SHA512:
-  metadata.gz: 3a023446e43e957d7e6e7c72f40d6d9386e525f2a6e57e2d40759492b2fbd896e82207d23bb0d7ff3fb357b0b69fb42830ed939edd32a9b646943fd6c55be2b4
-  data.tar.gz: 835c7110b1d0916eef8346cff440f7f43a41f70f1c5722b549035d6713505f701b8982772ee0b5cefaaad25737665bf7c7fc1b85d3e9820a2c09645a390c9666
+  metadata.gz: 352037dc4b567b4e7cf74a53713f26ac42acf6a3310ca84bf84d47a5022515616b65f5803971062bec939c4194300970752d55e081e784c84633a83bd9f3a548
+  data.tar.gz: 2c1c8990bb4fffefeb75e8db1f9ce2d0479a97c0f147ccc1a233866c9a94557ff3c8d7beea4ba22c4c7f376421f4156e2f113509e9a1c787b02098717dadc097

data/README.md

@@ -1,4 +1,42 @@
-random_username
-===============
+# RandomUsername
 
-Generate random Heroku-style names
+A random Heroku-style name generator.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+    gem "random_username"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install random_username
+
+## Usage
+
+    RandomUsername.noun
+    => "sunrise"
+    => "prize"
+    => "sage"
+
+    RandomUsername.adjective
+    => "heroic"
+    => "worthy"
+    => "enigmatic"
+
+    RandomUsername.username
+    => "hollowlight"
+    => "legitsunrise"
+    => "earthyleaf"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/random_username.rb

@@ -1,6 +1,8 @@
 require "random_username/version"
 
 module RandomUsername
+  RandomUsername::Error = Class.new(StandardError)
+
   def self.adjective(options = {})
     get_item("adjectives", options)
   end
@@ -9,10 +11,15 @@ module RandomUsername
     get_item("nouns", options)
   end
 
+  def self.username(options = {})
+    options[:max_length] /= 2 if options[:max_length]
+    adjective(options) + noun(options)
+  end
+
   def self.get_item(filename, options = {})
     items = items_from_file(filename)
     items.select!{ |item| item.length <= options[:max_length] } if options[:max_length]
-    items.sample
+    items.sample || fail(RandomUsername::Error, "No words found")
   end
 
   def self.items_from_file(filename)

data/lib/random_username/version.rb

@@ -1,3 +1,3 @@
 module RandomUsername
-  VERSION = "1.0"
+  VERSION = "1.0.1"
 end

data/test/test_random_username.rb

@@ -2,8 +2,18 @@ require "minitest/autorun"
 require "random_username"
 
 class TestRandomUsername < Minitest::Test
+  def all_adjectives
+    @all_adjectives ||= RandomUsername.items_from_file("adjectives")
+  end
+
+  def all_nouns
+    @all_nouns ||= RandomUsername.items_from_file("nouns")
+  end
+
   def test_adjective
-    refute_empty RandomUsername.adjective
+    adjective = RandomUsername.adjective
+    refute_empty adjective
+    assert_includes all_adjectives, adjective
   end
 
   def test_adjective_max_length
@@ -12,11 +22,15 @@ class TestRandomUsername < Minitest::Test
   end
 
   def test_adjective_invalid_max_length
-    assert_nil RandomUsername.adjective(:max_length => 1)
+    assert_raises RandomUsername::Error do
+      RandomUsername.adjective(:max_length => 1)
+    end
   end
 
   def test_noun
-    refute_empty RandomUsername.noun
+    noun = RandomUsername.noun
+    refute_empty noun
+    assert_includes all_nouns, noun
   end
 
   def test_noun_max_length
@@ -25,6 +39,29 @@ class TestRandomUsername < Minitest::Test
   end
 
   def test_noun_invalid_max_length
-    assert_nil RandomUsername.noun(:max_length => 1)
+    assert_raises RandomUsername::Error do
+      RandomUsername.noun(:max_length => 1)
+    end
+  end
+
+  def test_username
+    username = RandomUsername.username
+    refute_empty username
+    anchor = (2..username.length).detect do |i|
+      all_adjectives.include?(username[0..i])
+    end
+    assert_includes all_adjectives, username[0..anchor]
+    assert_includes all_nouns, username[anchor+1..-1]
+  end
+
+  def test_username_max_length
+    username = RandomUsername.username(:max_length => 10)
+    assert username.length <= 10
+  end
+
+  def test_username_invalid_max_length
+    assert_raises RandomUsername::Error do
+      RandomUsername.username(:max_length => 2)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: random_username
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Michael Foley