madison 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc16088ec67c078a87f2b689483b09fcafa994f3
-  data.tar.gz: 298321db111e9788971b8414587ca308be36e01a
+  metadata.gz: 57386ed384eb3b234d7c24e6e607cfc6223f2bb7
+  data.tar.gz: ce4f672a178999536755c2c79e86ce93dfe4094b
 SHA512:
-  metadata.gz: eb0e66b81cc9e74a32d22562e662b20ba6fa67e76a715d8d0b28885d1eef03270030a15168e0e119f633b5fe4f8f84f662affc2dfb2c4ecfc85c08a455944473
-  data.tar.gz: fbf06dd63453d7e0d826b954239349880d88169f2867c78fa39fe9ed19fd5cb03b0bf8e85656966137cdc5bd6e8f1918c158d8bfc757d6f6a7a4f5040bdd30b1
+  metadata.gz: ac6e3bd30788ac73013c2e1acf300e48b76834599472c33e835a961b798b50df98348cfd8bded5b5cc46a8b76a798969e2b3474cfc8c7030eeabd3fa94f31ba9
+  data.tar.gz: ff5f7d24046d0fce2b2001c5f52b704f9cc2e55713e97faa96cbd71235ac17cfd40b7c013abbfcf8a746630ff78e28a9ab52a19eb2fdc20cc0cd1c6e8cfa21b3

data/.travis.yml

@@ -1,6 +1,3 @@
 language: ruby
 rvm:
-  - "1.9.2"
-  - "1.9.3"
   - "2.0"
-script: rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    madison (0.3.1)
+    madison (0.4.0)
       json
 
 GEM

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/mdb/ruby-madison.png)](http://travis-ci.org/mdb/ruby-madison)
+[![Build Status](https://travis-ci.org/mdb/madison.rb.svg?branch=master)](https://travis-ci.org/mdb/madison.rb)
 
 # madison
 
@@ -10,41 +10,90 @@ This is the Ruby version of the Node.js [madison](http://github.com/mdb/madison)
 
 The released gem (recommended):
 
-    gem install madison
+```
+$ gem install madison
+```
 
-Alternatively, from source code:
+## Usage
 
-    git clone https://github.com/mdb/madison.rb
-    cd madison.rb
-    bundle install
-    rake install
+Madison can be mixed into a class, or its singleton methods
+can be called directly on the `Madison` module.
 
-## Run Rspec tests
+Require madison:
 
-(Assuming you've installed from source code)
+```ruby
+require 'madison'
+```
 
-    rake
+### Include it as a mixin
 
-## View code coverage after running Rspec tests
+```ruby
+class MyClass
+  include Madison
+end
 
-(Again, assuming you've installed from source code)
+my_class = MyClass.new
+```
 
-    open coverage/index.html
+Get a state's abbreviation:
 
-## Usage 
+```ruby
+my_class.state_abbrev 'virginia'
+# => VA
+```
 
-Require madison:
-  
-    require 'madison'
+Get a state's name:
 
-Get a state's abbreviation:
+```ruby
+my_class.state_name 'va'
+# => Virginia
+```
 
-    Madison.get_abbrev 'virginia' // 'VA'
+Get an array of US state names/abbreviations:
 
-Get a state's name asynchronously:
+```ruby
+my_class.states
+# => [
+#  {
+#    name: 'Virginia',
+#    abbr: 'VA'
+#  },
+#  ...
+#]
+```
 
-    Madison.get_name 'va' // 'Virginia'
+Get the Madison::Map class used
 
-Get a Ruby hash of US states, each containing 'name' and 'abbr' properties:
+```ruby
+my_class.madison_map
+# => <Madison::Map:0x007f8dbc80e7f0>
+```
+
+### Use its singleton methods on the Madison module
+
+Get a state's abbreviation:
 
-    Madison.states
+```ruby
+Madison.get_abbrev 'virginia'
+# => VA
+```
+
+Get a state's name:
+
+```ruby
+Madison.get_name 'va'
+# => Virginia
+```
+
+Get an array of US state names/abbreviations:
+
+```ruby
+Madison.states
+# => [
+#  {
+#    name: 'Virginia',
+#    abbr: 'VA'
+#  },
+#  ...
+#]
+```

data/lib/madison.rb

@@ -15,4 +15,22 @@ module Madison
   def self.get_name(abbrev)
     @map.get_name(abbrev)
   end
+
+  # mixin methods
+
+  def states
+    madison_map.states
+  end
+
+  def state_name(abbrev)
+    madison_map.get_name(abbrev)
+  end
+
+  def state_abbrev(name)
+    madison_map.get_abbrev(name)
+  end
+
+  def madison_map
+    @madison_map ||= Madison::Map.new
+  end
 end

data/lib/madison/version.rb

@@ -1,3 +1,3 @@
 module Madison
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/spec/lib/madison_spec.rb

@@ -80,4 +80,70 @@ describe Madison do
       end
     end
   end
+
+  context 'the methods it provides a class when it is mixed into the class' do
+    include Madison
+
+    describe '#states' do
+      it 'returns an array of state names & abbreviations' do
+        expect(states.length).to eq 51
+      end
+
+      context 'each hash in the states array' do
+        it 'has a "name" key' do
+          expect(states[0]['name']).to eq 'Alabama'
+        end
+
+        it 'has an "abbrev" key' do
+          expect(states[0]['abbr']).to eq 'AL'
+        end
+      end
+    end
+
+    describe '#state_name' do
+      context 'when it is passed an abbreviation' do
+        it 'returns the correct state name' do
+          expect(state_name 'va').to eq 'Virginia'
+        end
+      end
+
+      context 'when it is passed an invalid abbreviation' do
+        it 'returns nil' do
+          expect(state_name 'xx').to eq nil
+        end
+      end
+
+      context 'when it is not passed an argument' do
+        it 'raises an error' do
+          expect { state_name }.to raise_error
+        end
+      end
+    end
+
+    describe '#state_abbrev' do
+      context 'when it is passed a state name' do
+        it 'returns the correct state abbreviation' do
+          expect(state_abbrev 'virginia').to eq 'VA'
+        end
+      end
+
+      context 'when it is passed an invalid name' do
+        it 'returns nil' do
+          expect(state_abbrev 'fake_state').to eq nil
+        end
+      end
+
+      context 'when it is not passed an argument' do
+        it 'raises an error' do
+          expect { state_abbrev }.to raise_error
+        end
+      end
+    end
+
+    describe '#madison_map' do
+      it 'returns an instance of a Madison::Map class' do
+        expect(madison_map.class).to eq Madison::Map
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madison
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Ball
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-30 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json