madison 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+script: rake

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+gem "json"
+
+group :development do
+  gem "rspec"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.4)
+  json
+  rdoc (~> 3.12)
+  rspec
+  simplecov

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Mike Ball
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+[![Build Status](https://secure.travis-ci.org/mdb/ruby-madison.png)](http://travis-ci.org/mdb/ruby-madison)
+
+# madison
+
+A dirt simple Ruby gem for working with US state names and abbreviations.
+
+This is the Ruby version of Node.js [madison](http://github.com/mdb/madison) and was built as an example gem for other developers.
+
+Note that it's currently unpublished.
+
+## Installation
+
+    git clone https://github.com/mdb/ruby-madison
+    cd ruby-madison 
+    bundle install
+    rake install
+
+## Run Rspec tests
+
+    rake
+
+## View code coverage after running Rspec tests
+
+    open coverage/index.html
+
+## Usage 
+
+Require madison:
+  
+    require 'madison'
+
+Initialize madison:
+
+    m = Madison.new
+
+Get a state's abbreviation:
+
+    m.get_abbrev 'virginia' // 'VA'
+
+Get a state's name asynchronously:
+
+    m.get_name 'va' // 'Virginia'
+
+Get a Ruby hash of US states, each containing 'name' and 'abbr' properties:
+
+    m.states

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "madison"
+  gem.homepage = "http://github.com/mdb/madison.rb"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple Ruby gem for working with U.S. state names and abbreviations.}
+  gem.description = %Q{Get a U.S. state name from its abbreviation or get a U.S. state abbreviation from its name.}
+  gem.email = "mikedball@gmail.com"
+  gem.authors = ["Mike Ball"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "madison #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/madison.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+class Madison
+  attr_accessor :states
+
+  def states 
+    @states ||= JSON.parse( File.open(File.join("lib", "states.json")).read )
+  end
+
+  def get_abbrev(name)
+    raise ArgumentError("Argument must be a string") unless name.is_a? String
+    state_abbrevs[name.downcase]
+  end
+
+  def get_name(abbrev)
+    raise ArgumentError("Argument must be a string") unless abbrev.is_a? String
+    state_names[abbrev.downcase]
+  end
+
+  private
+  def state_names
+    @state_names ||= build_map('abbr', 'name')
+  end
+
+  def state_abbrevs
+    @state_abbrevs ||= build_map('name', 'abbr')
+  end
+
+  def build_map(in_key, out_key)
+    states.inject({}) do |map, state|
+      map[state[in_key].downcase] = state[out_key]
+      map 
+    end
+  end
+end

data/lib/states.json

@@ -0,0 +1,206 @@
+[
+  {
+    "name": "Alabama",
+    "abbr": "AL"
+  },
+  {
+    "name": "Alaska",
+    "abbr": "AK"
+  },
+  {
+    "name": "Arizona",
+    "abbr": "AZ"
+  },
+  {
+    "name": "Arkansas",
+    "abbr": "AR"
+  },
+  {
+    "name": "California",
+    "abbr": "CA"
+  },
+  {
+    "name": "Colorado",
+    "abbr": "CO"
+  },
+  {
+    "name": "Connecticut",
+    "abbr": "CT"
+  },
+  {
+    "name": "Delaware",
+    "abbr": "DE"
+  },
+  {
+    "name": "District Of Columbia",
+    "abbr": "DC"
+  },
+  {
+    "name": "Florida",
+    "abbr": "FL"
+  },
+  {
+    "name": "Georgia",
+    "abbr": "GA"
+  },
+  {
+    "name": "Hawaii",
+    "abbr": "HI"
+  },
+  {
+    "name": "Idaho",
+    "abbr": "ID"
+  },
+  {
+    "name": "Illinois",
+    "abbr": "IL"
+  },
+  {
+    "name": "Indiana",
+    "abbr": "IN"
+  },
+  {
+    "name": "Iowa",
+    "abbr": "IA"
+  },
+  {
+    "name": "Kansas",
+    "abbr": "KS"
+  },
+  {
+    "name": "Kentucky",
+    "abbr": "KY"
+  },
+  {
+    "name": "Louisiana",
+    "abbr": "LA"
+  },
+  {
+    "name": "Maine",
+    "abbr": "ME"
+  },
+  {
+    "name": "Maryland",
+    "abbr": "MD"
+  },
+  {
+    "name": "Massachusetts",
+    "abbr": "MA"
+  },
+  {
+    "name": "Michigan",
+    "abbr": "MI"
+  },
+  {
+    "name": "Minnesota",
+    "abbr": "MN"
+  },
+  {
+    "name": "Mississippi",
+    "abbr": "MS"
+  },
+  {
+    "name": "Missouri",
+    "abbr": "MO"
+  },
+  {
+    "name": "Montana",
+    "abbr": "MT"
+  },
+  {
+    "name": "Nebraska",
+    "abbr": "NE"
+  },
+  {
+    "name": "Nevada",
+    "abbr": "NV"
+  },
+  {
+    "name": "New Hampshire",
+    "abbr": "NH"
+  },
+  {
+    "name": "New Jersey",
+    "abbr": "NJ"
+  },
+  {
+    "name": "New Mexico",
+    "abbr": "NM"
+  },
+  {
+    "name": "New York",
+    "abbr": "NY"
+  },
+  {
+    "name": "North Carolina",
+    "abbr": "NC"
+  },
+  {
+    "name": "North Dakota",
+    "abbr": "ND"
+  },
+  {
+    "name": "Ohio",
+    "abbr": "OH"
+  },
+  {
+    "name": "Oklahoma",
+    "abbr": "OK"
+  },
+  {
+    "name": "Oregon",
+    "abbr": "OR"
+  },
+  {
+    "name": "Pennsylvania",
+    "abbr": "PA"
+  },
+  {
+    "name": "Rhode Island",
+    "abbr": "RI"
+  },
+  {
+    "name": "South Carolina",
+    "abbr": "SC"
+  },
+  {
+    "name": "South Dakota",
+    "abbr": "SD"
+  },
+  {
+    "name": "Tennessee",
+    "abbr": "TN"
+  },
+  {
+    "name": "Texas",
+    "abbr": "TX"
+  },
+  {
+    "name": "Utah",
+    "abbr": "UT"
+  },
+  {
+    "name": "Vermont",
+    "abbr": "VT"
+  },
+  {
+    "name": "Virginia",
+    "abbr": "VA"
+  },
+  {
+    "name": "Washington",
+    "abbr": "WA"
+  },
+  {
+    "name": "West Virginia",
+    "abbr": "WV"
+  },
+  {
+    "name": "Wisconsin",
+    "abbr": "WI"
+  },
+  {
+    "name": "Wyoming",
+    "abbr": "WY"
+  }
+]

data/madison.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "madison"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Ball"]
+  s.date = "2012-10-17"
+  s.description = "Get a U.S. state name from its abbreviation or get a U.S. state abbreviation from its name."
+  s.email = "mikedball@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/madison.rb",
+    "lib/states.json",
+    "madison.gemspec",
+    "spec/lib/madison_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/mdb/madison.rb"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "A simple Ruby gem for working with U.S. state names and abbreviations."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/lib/madison_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Madison do
+  describe "#states" do
+    it "returns a Ruby hash of state names and abbreviations" do 
+      m = Madison.new
+      m.states[0]['name'].should === "Alabama"
+      m.states[50]['abbr'].should === "WY"
+      m.states.length.should === 51 
+    end
+  end
+  
+  describe "#get_abbrev" do
+    before(:each) do
+      @m = Madison.new
+    end
+
+    it "returns a state's abbreviation when it's passed a state's name" do 
+      @m.get_abbrev("virginia").should === "VA"
+      @m.get_abbrev("west virginia").should === "WV"
+    end
+    
+    it "returns a state's abbreviation when it's passed a state's name, indpendent of the argument's case" do 
+      @m.get_abbrev("virginiA").should === "VA"
+      @m.get_abbrev("AlaBama").should === "AL"
+    end
+
+    it "returns nil in the event that is not passed a valid state name" do
+      @m.get_abbrev("Fake State").should === nil
+    end
+
+    it "raises an ArgumentError if it is not passed a string" do
+      lambda { @m.get_abbrev(3) }.should raise_error
+      lambda { @m.get_abbrev(nil) }.should raise_error
+      lambda { @m.get_abbrev({}) }.should raise_error
+    end
+  end
+  
+  describe "#get_name" do
+    before(:each) do
+      @m = Madison.new
+    end
+
+    it "returns a state's abbreviation when it's passed a state's name" do 
+      @m.get_name("va").should === "Virginia"
+      @m.get_name("WV").should === "West Virginia"
+    end
+    
+    it "returns a state's abbreviation when it's passed a state's name, indpendent of the argument's case" do 
+      @m.get_name("vA").should === "Virginia"
+      @m.get_name("Al").should === "Alabama"
+    end
+
+    it "returns nil in the event that is not passed a valid state name" do
+      @m.get_name("FS").should === nil
+    end
+
+    it "raises an ArgumentError if it is not passed a string" do
+      lambda { @m.get_name(3) }.should raise_error
+      lambda { @m.get_name(nil) }.should raise_error
+      lambda { @m.get_name({}) }.should raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+require 'rspec'
+SimpleCov.start
+
+require_relative '../lib/madison'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: madison
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2165488140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165488140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165487440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165487440
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2165482580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2165482580
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2165481580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165481580
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2165480980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *2165480980
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2165480320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165480320
+description: Get a U.S. state name from its abbreviation or get a U.S. state abbreviation
+  from its name.
+email: mikedball@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/madison.rb
+- lib/states.json
+- madison.gemspec
+- spec/lib/madison_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mdb/madison.rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1175181656016196400
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A simple Ruby gem for working with U.S. state names and abbreviations.
+test_files: []