namna 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88875ba589b38bf48c968caaff07fcd1a9a9a065
-  data.tar.gz: e6ae08ae68ff77a6c27c16a60499e2b32d9202ec
+  metadata.gz: a4aa7cd19f2b862feccc25d8cfdcc0893a41910d
+  data.tar.gz: 2fd8645ccf0420be4ef8443e56a6ce8f75afcf88
 SHA512:
-  metadata.gz: fcfb246b23484a02fecae130fb8b026aefa85d78c67ebc95ca84e9f5983cc5555ce23b1e38baabba73d4f80411eda2b1b60f8460b629c3d6572a5c1a10075cf3
-  data.tar.gz: c7f38bc4f1430d1b2a7b3dd0ef3e1ab9c125316666618772a1b98ad75c8b62f4085f85a31d3045a7772f4be3a57c48404b18aa6a32601f66d508c62f22e1bb61
+  metadata.gz: 088a1b9035e07a8eb67f5e52236a4eeb510d31aa1f28af97271117a218c4335a00010890f0f8cce3c75fb2f5e2cefeddb2b8f505b56bb070cf3a9078a157eea7
+  data.tar.gz: 9df75ea79989b51286f2cdf3cb742e6f383e66438c5b20ed183f96e335943130843d523944a8f6da464807d51e8c50058087790a0850c1b88ed4f5b2062f2bd2

data/README.md

@@ -1,8 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/namna.svg)](http://badge.fury.io/rb/namna)
 [![Build Status](https://travis-ci.org/kodnin/namna.svg?branch=master)](https://travis-ci.org/kodnin/namna)
 
 # Namna
 
-Namna is a simple formatted name generator for the command line written in Ruby.
+A name generator written in Ruby.
 
 ## Installation
 
@@ -22,12 +23,24 @@ Or install it yourself as:
 
 ## Usage
 
-Generate a name by invoking the ```namna``` command with a format argument. For example:
+Require the gem in your project or ```irb``` and generate a name:
 
-    $ namna 'a?*#z'
-    => adebz
+```ruby
+require 'namna'
+# => true
+Generator.random
+# => 'nuceop'
+Generator.random(5)
+# => 'xtkna'
+Generator.human
+# => 'fizaze'
+Generator.human(5)
+# => 'oxemo'
+Generator.format('a?*#z')
+# => 'adebz'
+```
 
-results in a name of five characters starting with an 'a', followed by a random character (?), a vowel (*), a consonant (#) and ending with a 'z'.
+Use the ```random``` method to generate a random name. Specify its length with an optional argument. Use the ```human``` method to generate a humanized random name. Again it is optional to specify a length. Use the ```format``` method to generate a formatted name. A ```?``` is substituted for a random character, a ```*``` is substituted for a vowel and a ```#``` is substituted for a consonant. Non-special characters remain unchanged.
 
 ## Contributing
 

data/lib/namna.rb

@@ -1,6 +1,6 @@
-require 'namna/version'
-require 'namna/string'
 require 'namna/generator'
+require 'namna/string'
+require 'namna/version'
 
 module Namna
 end

data/lib/namna/generator.rb

@@ -1,11 +1,17 @@
 class Generator
-  attr_reader :format
+  def self.random(length=(3..7).to_a.sample)
+    generate('?' * length)
+  end
+
+  def self.human(length=(3..7).to_a.sample)
+    generate(('*#' * length).slice(rand(length), length))
+  end
 
-  def initialize(format)
-    @format = format.downcase
+  def self.format(format)
+    generate(format)
   end
 
-  def generate
+  def self.generate(format)
     format.split('').map(&:namna_sub).join('')
   end
 end

data/lib/namna/version.rb

@@ -1,3 +1,3 @@
 module Namna
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/namna.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Namna::VERSION
   spec.authors       = ['David Boot']
   spec.email         = ['kodnin@gmail.com']
-  spec.summary       = %q{Simple formatted name generator.}
-  spec.description   = %q{A simple formatted name generator for the command line.}
+  spec.summary       = %q{Name generator.}
+  spec.description   = %q{Name generator written in Ruby.}
   spec.homepage      = 'https://github.com/kodnin/namna'
   spec.license       = 'MIT'
 

data/test/generator_test.rb

@@ -1,20 +1,26 @@
 require_relative './test_helper'
 
 class TestGenerator < Minitest::Test
-  def setup
-    @generator = Generator.new('a?*#z')
+  def test_random
+    assert (3..7).include?(Generator.random.length)
+    assert_equal 5, Generator.random(5).length
   end
 
-  def test_initialize
-    assert_equal 5, @generator.format.length
+  def test_human
+    assert (3..7).include?(Generator.human.length)
+    assert_equal 5, Generator.human(5).length
   end
 
-  def test_generate
-    assert_equal 5, @generator.generate.length
-    assert_equal 'a', @generator.generate[0]
-    assert_includes String::ALPHABET, @generator.generate[1]
-    assert_includes String::VOWELS, @generator.generate[2]
-    assert_includes String::CONSONANTS, @generator.generate[3]
-    assert_equal 'z', @generator.generate[4]
+  def test_format
+    name = Generator.format('a?*#z')
+
+    assert_equal 5, name.length
+
+    assert_equal 'a', name[0]
+    assert_equal 'z', name[4]
+
+    assert_includes String::ALPHABET, name[1]
+    assert_includes String::VOWELS, name[2]
+    assert_includes String::CONSONANTS, name[3]
   end
 end

data/test/string_test.rb

@@ -3,22 +3,27 @@ require_relative './test_helper'
 class TestString < Minitest::Test
   def test_constants
     assert_equal 26, String::ALPHABET.length
-    assert_includes String::ALPHABET, 'a'.namna_sub
-    assert_includes String::ALPHABET, 'b'.namna_sub
+    assert_includes String::ALPHABET, 'a'
+    assert_includes String::ALPHABET, 'b'
+
     assert_equal 5, String::VOWELS.length
-    assert_includes String::VOWELS, 'a'.namna_sub
-    refute_includes String::VOWELS, 'b'.namna_sub
+    assert_includes String::VOWELS, 'a'
+    refute_includes String::VOWELS, 'b'
+
     assert_equal 21, String::CONSONANTS.length
-    assert_includes String::CONSONANTS, 'b'.namna_sub
-    refute_includes String::CONSONANTS, 'a'.namna_sub
+    assert_includes String::CONSONANTS, 'b'
+    refute_includes String::CONSONANTS, 'a'
   end
 
   def test_namna_sub
     assert_equal 'a', 'a'.namna_sub
     assert_equal 'b', 'b'.namna_sub
+
     assert_includes String::ALPHABET, '?'.namna_sub
+
     assert_includes String::VOWELS, '*'.namna_sub
     refute_includes String::CONSONANTS, '*'.namna_sub
+
     assert_includes String::CONSONANTS, '#'.namna_sub
     refute_includes String::VOWELS, '#'.namna_sub
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: namna
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - David Boot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,11 +52,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.4.2
-description: A simple formatted name generator for the command line.
+description: Name generator written in Ruby.
 email:
 - kodnin@gmail.com
-executables:
-- namna
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -66,7 +65,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/namna
 - lib/namna.rb
 - lib/namna/generator.rb
 - lib/namna/string.rb
@@ -98,7 +96,7 @@ rubyforge_project:
 rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: Simple formatted name generator.
+summary: Name generator.
 test_files:
 - test/generator_test.rb
 - test/string_test.rb

data/bin/namna

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'namna'
-
-if ARGV.empty? || ARGV.first == '-h' || ARGV.first == '--help'
-  puts "namna '<format>'"
-  puts "  where:"
-  puts "    a-z remains a-z"
-  puts "    ? becomes random"
-  puts "    * becomes vowel"
-  puts "    # becomes consonant"
-elsif ARGV.first == '-v' || ARGV.first == '--version'
-  puts Namna::VERSION
-else
-  puts Generator.new(ARGV.first).generate
-end