monikers 0.1.0 → 0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,6 +1,8 @@
 # Monikers
 
-TODO: Write a gem description
+Monikers is a _very_ simple Gem for listing and comparing first name 'monikers', or
+nicknames. If a 3rd party, web based API is overkill for your needs, but simple
+string or regex comparison is not sufficient, Monikers can fill the gap.
 
 ## Installation
 
@@ -18,10 +20,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+	Monikers.list("Bob") 					# => ["robert", "rob", "bobby", "bert", "bob"]
+	Monikers.list("Polycarp") 				# => ["polycarp"]
+	Monikers.equivalents?("Sam", "Samuel")	# => true
+	Monikers.equivalents?("Mike", "Matt") 	# => false
+
+## Implementation
+
+Monikers uses a static hash to lookup nicknames. The data structure is
+pre-built, stored in a flat file (`lib/data/monikers_hash.rb`) and `eval`'d
+when needed.
+
+The nickname hash is compiled from a static list of names in CSV format
+(`lib/data/monikers_list.csv`). This CSV is not accessed unless
+`Monikers::Generator.generate_cache` method is called. **This should not be done
+in normal use of the Gem**, such as during the execution of a routine using
+Monikers. Instead, it should only be done ahead of time to add or modify
+names in the hash cache. See the "Add or Modify" names section under "Contributing"
+below.
 
 ## Contributing
 
+### Add or Modify Names
+To add or modify names to the Monikers cache, make the changes to the static
+CSV, then run the generator on your local development machine to update the
+static data structure.
+
+	$ cd path/to/monikers
+	$ cd lib/monikers/generator/
+	$ irb
+	> require './generator.rb'
+	> Monikers::Generator.generate_cache
+
+`lib/data/monikders_hash.rb` should have been modified to include your changes.
+It is requested that if you submit a patch including new names or nicknames, that you 
+write a test or two for at least some of the new names created.
+
+Submit all changes in one commit (example: 54e49341efce2a6bcfef84c41598cf5dce48714e)
+via pull request.
+
+### Modifying Gem functionality or tests
+The Monikers Gem is simple by design. Pull requests for complex changes or 
+functionality may not be accepted. If you think you have a helpful addition or
+correction to the Gem or its tests, use a standard fork & branch workflow:
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/data/monikers_hash.rb

@@ -241,10 +241,10 @@
  "belinda"=>["belle", "linda"],
  "linda"=>
   ["belinda", "lindy", "lynn", "melinda", "philinda", "rosalinda", "rosalyn"],
- "benedict"=>["ben", "bennie"],
- "ben"=>["benedict", "benjamin", "bennie", "jamie"],
+ "benedict"=>["ben", "bennie", "benny"],
+ "ben"=>["benedict", "benjamin", "bennie", "jamie", "benny"],
  "bennie"=>["benedict", "benjamin", "ben"],
- "benjamin"=>["ben", "benjy", "bennie", "jamie"],
+ "benjamin"=>["ben", "benjy", "bennie", "jamie", "benny"],
  "benjy"=>["benjamin"],
  "jamie"=>["benjamin", "james", "ben"],
  "bernard"=>["barney", "berney", "bernie"],
@@ -1360,4 +1360,5 @@
  "cheryl"=>["sheryl"],
  "sheryl"=>["cheryl", "sher"],
  "cher"=>["sher"],
- "nik"=>["nick"]}
+ "nik"=>["nick"],
+ "benny"=>["benedict", "benjamin", "ben"]}

data/lib/data/monikers_list.csv

@@ -1429,3 +1429,6 @@
 1432, Will, Bill
 1433, Nick, Nik
 1434, Nik, Nick
+1435, Benedict, Benny
+1436, Benjamin, Benny
+1437, Ben, Benny

data/lib/monikers.rb

@@ -7,7 +7,7 @@ module Monikers
     name_down = name.downcase
 
     if @dataset.key?(name.downcase)
-      return @dataset[name_down]<< name_down
+      return @dataset[name_down].dup<< name_down
     else
       return Array.new<< name_down
     end

data/lib/monikers/version.rb

@@ -1,3 +1,3 @@
 module Monikers
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/monikers.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency 'rspec', '~> 2.10'
+  gem.add_development_dependency 'pry-debugger'
 end

data/spec/models/monikers_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Monikers do
+
+  it { should respond_to(:list).with(1).argument }
+  it { should respond_to(:equivalents?).with(2).arguments }
+
+  context "when calling Monikers twice" do
+    let(:monikers_list_one) { Monikers.list("Ben") }
+    let(:monikers_list_two) { Monikers.list("Ben") }
+
+    it "should should not add dupes to the dataset" do
+      monikers_list_one.size.should eq(monikers_list_two.size)
+      monikers_list_one.sort.should eq(monikers_list_two.sort)
+    end
+  end
+
+  context "when testing list method" do  
+    context "when given Ben" do
+      let(:monikers_list) { Monikers.list("Ben") }
+      let(:correct_results) { ["benjamin", "jamie", "benedict", "bennie", "benny", "ben"] }
+
+      it "should return the correct monikers list" do
+        monikers_list.sort.should eq(correct_results.sort)
+      end
+    end
+
+    context "when given Polycarp" do
+      let(:monikers_list) { Monikers.list("Polycarp") }
+      let(:correct_results) { ["polycarp"] }
+
+      it "should return the correct monikers list" do
+        monikers_list.sort.should eq(correct_results.sort)
+      end
+    end
+
+    context "when given John vs. john" do
+      let(:lowcase_list) { Monikers.list("john") }
+      let(:upcase_list) { Monikers.list("John") }
+
+      it "should return the same list" do
+        lowcase_list.sort.should eq(upcase_list.sort)
+      end
+    end
+  end
+
+  context "when testing equivalents method" do
+    it "should match Bob and Robert" do
+      Monikers.equivalents?("Bob", "Robert").should eq(true)
+    end 
+
+    it "should not match Mike and Matt" do
+      Monikers.equivalents?("Mike", "Matt").should eq(false)
+    end
+
+    it "should match Polycarp and Polycarp" do
+      Monikers.equivalents?("Polycarp", "Polycarp").should eq(true)
+    end
+
+    it "should match joE and Joe" do
+      Monikers.equivalents?("joE", "Joe").should eq(true)
+    end
+
+    it "should not match Jim and jOn" do
+      Monikers.equivalents?("Jim", "jOn").should eq(false)
+    end
+
+    it "should match Ben and Benny" do
+      Monikers.equivalents?("Ben", "Benny").should eq(true)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require
+
+Dir[File.expand_path("../../spec/support/**/*.rb", __FILE__)].each {|f| require f}
+
+require 'pry-debugger'
+require 'monikers'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monikers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Cached List of First Name Monikers (nicknames) in easy-access Ruby Gem
 email:
 - bdifrancesco@ascensionpress.com
@@ -35,6 +51,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -45,6 +62,8 @@ files:
 - lib/monikers/generator/generator.rb
 - lib/monikers/version.rb
 - monikers.gemspec
+- spec/models/monikers_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/apbendi/monikers
 licenses: []
 post_install_message: 
@@ -70,4 +89,6 @@ signing_key:
 specification_version: 3
 summary: Gem contains a precached data structure of first name monikers & convenience
   methods for access & comparison
-test_files: []
+test_files:
+- spec/models/monikers_spec.rb
+- spec/spec_helper.rb