check_yo_spelling 0.1.0

data/data/wyoming_cities.yml

@@ -0,0 +1,156 @@
+---
+- afton
+- albin
+- alpine
+- alpine northeast
+- alpine northwest
+- alta
+- antelope valley crestview
+- arapahoe
+- auburn
+- baggs
+- bairoil
+- bar nunn
+- basin
+- bear river
+- bedford
+- bessemer bend
+- big horn
+- big piney
+- boulder
+- boulder flats
+- brookhurst
+- buffalo
+- burlington
+- burns
+- byron
+- casper
+- casper mountain
+- centennial
+- cheyenne
+- chugcreek
+- chugwater
+- clearmont
+- clearview acres
+- cody
+- cokeville
+- cora
+- cowley
+- crowheart
+- daniel
+- dayton
+- deaver
+- diamondville
+- douglas
+- dubois
+- east thermopolis
+- eden
+- edgerton
+- elk mountain
+- encampment
+- ethete
+- etna
+- evanston
+- evansville
+- fairview
+- farson
+- fort bridger
+- fort laramie
+- fort washakie
+- fox farm college
+- frannie
+- freedom
+- garland
+- gillette
+- glendo
+- glenrock
+- granger
+- green river
+- greybull
+- grover
+- guernsey
+- hanna
+- hartrandt
+- hill view heights
+- hoback
+- homa hills
+- hudson
+- hulett
+- jackson
+- james town
+- johnstown
+- kaycee
+- kelly
+- kemmerer
+- la barge
+- la grange
+- lander
+- laramie
+- lingle
+- lovell
+- lucerne
+- lusk
+- lyman
+- mammoth
+- manderson
+- marbleton
+- meadow acres
+- medicine bow
+- meeteetse
+- midwest
+- mills
+- moorcroft
+- moose wilson road
+- mountain view
+- newcastle
+- nordic
+- north rock springs
+- osage
+- osmond
+- parkman
+- pavillion
+- pine bluffs
+- pine haven
+- pinedale
+- powell
+- purple sage
+- rafter j ranch
+- ralston
+- ranchester
+- ranchettes
+- rawlins
+- red butte
+- reliance
+- riverton
+- rock river
+- rock springs
+- rolling hills
+- saratoga
+- sheridan
+- shoshoni
+- sinclair
+- sleepy hollow
+- smoot
+- south greeley
+- south park
+- star valley ranch
+- story
+- sundance
+- superior
+- ten sleep
+- teton village
+- thayne
+- thermopolis
+- torrington
+- turnerville
+- upton
+- urie
+- vista west
+- wamsutter
+- warren afb
+- wheatland
+- wilson
+- worland
+- wright
+- y o ranch
+- yoder

data/gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'levenshtein', '~> 0.2.2'
+gem 'geolookup', '~> 0.5.10'
+
+gemspec

data/lib/check_yo_spelling.rb

@@ -0,0 +1,4 @@
+require 'check_yo_spelling/usa'
+
+module CheckYoSpelling
+end

data/lib/check_yo_spelling/usa.rb

@@ -0,0 +1,52 @@
+module CheckYoSpelling
+  class USA
+    # Use the Levenshtein gem to find the closest match
+    # NOTE: the gem treats replacement edits as a distance of 2
+    MIN_DISTANCE = 4
+    class << self
+      # Find the closest existing city in the state
+      def check_city city, state
+        full_state = Geolookup::USA::State.abbreviation_to_name state
+        return nil if full_state.nil?
+        @@city_arrays ||= Hash.new
+        filename = "#{full_state.downcase.gsub(" ", "_")}_cities.yml"
+        @@city_arrays[filename] ||= words(filename)
+        check city, @@city_arrays[filename]
+      end
+
+      # Find the closest existing state
+      def check_state state
+        @@states ||= words("states.yml")
+        check state, @@states
+      end
+
+    private
+      def check word, nwords
+        word.downcase!
+        best_match = nil # return nil if no match
+        current_distance = MIN_DISTANCE # only accept possible matches that are close enough
+        nwords.each do |proposed|
+          distance = Levenshtein.distance word, proposed.downcase
+          if distance < current_distance
+            best_match = proposed
+            current_distance = distance
+          end
+          break if distance == 0 # Found perfect match
+        end
+        best_match = titleize(best_match) if best_match
+        best_match
+      end
+
+      def words filename
+        YAML.load_file(File.join(File.dirname(__FILE__), "/../../data/", filename))
+      end
+
+      # Basic titleize functionality ex: rhode island => Rhode Island
+      def titleize string
+        string.gsub(/\w+/) do |word|
+          word.capitalize
+        end
+      end
+    end
+  end
+end

data/lib/check_yo_spelling/version.rb

@@ -0,0 +1,3 @@
+module CheckYoSpelling
+  VERSION = "0.1.0"
+end

data/spec/lib/usa_city_checker_spec.rb

@@ -0,0 +1,16 @@
+describe "CheckYoSpelling::USA" do
+  it "should check city names" do
+    city = CheckYoSpelling::USA.check_city "Los Angelos", "CA"
+    expect(city).to eq("Los Angeles")
+  end
+
+  it "should return the same city name for a correct city" do
+    city = CheckYoSpelling::USA.check_city "Los Angeles", "CA"
+    expect(city).to eq("Los Angeles")
+  end
+
+  it "should return nil for city names that are too incorrect" do
+    city = CheckYoSpelling::USA.check_city "Los Angelesaaaaa", "CA"
+    expect(city).to eq(nil)
+  end
+end

data/spec/lib/usa_state_checker_spec.rb

@@ -0,0 +1,16 @@
+describe "CheckYoSpelling::USA" do
+ it "should check state names" do
+    state = CheckYoSpelling::USA.check_state "Californa"
+    expect(state).to eq("California")
+  end
+
+  it "should return the same state name for a correct state" do
+    state = CheckYoSpelling::USA.check_state "California"
+    expect(state).to eq("California")
+  end
+
+  it "should return nil for state names that are too incorrect" do
+    state = CheckYoSpelling::USA.check_state "Californiaaaaaa"
+    expect(state).to eq(nil)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'check_yo_spelling'
+require 'geolookup'
+require 'levenshtein'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: check_yo_spelling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Austin Fonacier
+- Eric Kuecks
+- Emily Lutz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+description: Spell checker for U.S. cities and states
+email:
+- austin@spokeo.com
+- ekuecks@ucla.edu
+- emily.lutz@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.rdoc
+- Gemfile.lock
+- README.md
+- Rakefile
+- check_yo_spelling.gemspec
+- data/.keep
+- data/alabama_cities.yml
+- data/alaska_cities.yml
+- data/arizona_cities.yml
+- data/arkansas_cities.yml
+- data/california_cities.yml
+- data/colorado_cities.yml
+- data/connecticut_cities.yml
+- data/delaware_cities.yml
+- data/florida_cities.yml
+- data/georgia_cities.yml
+- data/hawaii_cities.yml
+- data/idaho_cities.yml
+- data/illinois_cities.yml
+- data/indiana_cities.yml
+- data/iowa_cities.yml
+- data/kansas_cities.yml
+- data/kentucky_cities.yml
+- data/louisiana_cities.yml
+- data/maine_cities.yml
+- data/maryland_cities.yml
+- data/massachusetts_cities.yml
+- data/michigan_cities.yml
+- data/minnesota_cities.yml
+- data/mississippi_cities.yml
+- data/missouri_cities.yml
+- data/montana_cities.yml
+- data/nebraska_cities.yml
+- data/nevada_cities.yml
+- data/new_hampshire_cities.yml
+- data/new_jersey_cities.yml
+- data/new_mexico_cities.yml
+- data/new_york_cities.yml
+- data/north_carolina_cities.yml
+- data/north_dakota_cities.yml
+- data/ohio_cities.yml
+- data/oklahoma_cities.yml
+- data/oregon_cities.yml
+- data/pennsylvania_cities.yml
+- data/rhode_island_cities.yml
+- data/south_carolina_cities.yml
+- data/south_dakota_cities.yml
+- data/states.yml
+- data/tennessee_cities.yml
+- data/texas_cities.yml
+- data/utah_cities.yml
+- data/vermont_cities.yml
+- data/virginia_cities.yml
+- data/washington_cities.yml
+- data/west_virginia_cities.yml
+- data/wisconsin_cities.yml
+- data/wyoming_cities.yml
+- gemfile
+- lib/check_yo_spelling.rb
+- lib/check_yo_spelling/usa.rb
+- lib/check_yo_spelling/version.rb
+- pkg/spell_checker-0.1.0.gem
+- spec/lib/usa_city_checker_spec.rb
+- spec/lib/usa_state_checker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spokeo/CheckYoSpelling
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Spell checker for U.S. cities and states
+test_files:
+- spec/lib/usa_city_checker_spec.rb
+- spec/lib/usa_state_checker_spec.rb
+- spec/spec_helper.rb