coderifous-address_extractor 0.1.0 → 0.1.1

data/README.textile

@@ -5,6 +5,9 @@ Find and/or replace mailing addresses in strings.
 h2. Examples
 
 <pre><code>
+require 'rubygems'
+require 'address_extractor'
+  
 string = <<EOF
 Please send the package to 123 Foo St., Someplace FL
 
@@ -38,7 +41,7 @@ end
   
 h3. About
 
-Written by Jim Garvin at RubyConf '08 at the request of Chris Murphy and Ryan McGeary so they could use it in Yarp.com.
+Written by Jim Garvin ("coderifous":http://github.com/coderifous) at RubyConf '08 at the request of Chris Murphy ("chmurph2":http://github.com/chmurph2) and Ryan McGeary ("rmm5t":http://github.com/rmm5t) so they could use it in their awesome "invitation and survey app":http://yarp.com.
 
 You can use it, too.
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('address_extractor', '0.1.0') do |p|
+Echoe.new('address_extractor', '0.1.1') do |p|
   p.description    = "Give it text.  It finds addresses in it."
   p.url            = "http://github.com/coderifous/address_extractor"
   p.author         = "Jim Garvin"

data/address_extractor.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{address_extractor}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jim Garvin"]

data/lib/address_extractor.rb

@@ -1,21 +1,32 @@
 class AddressExtractor
   class << self
 
+    # Returns hash for address if address found.
+    # Returns nil if no address found.
     def first_address(string)
       hashify_results string.scan(ADDRESS_PATTERN).first
     end
-    
+
+    # Returns array of hashes for each address found.
+    # Returns empty array if no addresses found.
     def find_addresses(string)
       string.scan(ADDRESS_PATTERN).collect { |a| hashify_results(a) }.compact
     end
     
+    # Pass it a block that recieves 2 parameters: 
+    #   address hash
+    #   matched address string ($&)
+    # Whatever your block returns will be used for the substition.
+    # Returns new string with substition applied to first identified address.
+    # If no address found, returns same string unaltered.
     def replace_first_address(string)
       hash = first_address(string)
       string.sub(ADDRESS_PATTERN) do |match|
         yield(hash, $&)
       end
     end
-    
+
+    # Same as +replace_first_address+ but applies substition to all identified addresses.
     def replace_addresses(string)
       string.gsub(ADDRESS_PATTERN) do |match|
         hash = hashify_results match.scan(ADDRESS_PATTERN).first
@@ -23,7 +34,10 @@ class AddressExtractor
       end
     end
     
+  private
+    
     def hashify_results(matches)
+      return nil if matches.nil?
       result = { }
       capture_index = 0
       CAPTURE_MAP.each do |field|

data/test/test_address_extractor.rb

@@ -33,6 +33,13 @@ class AddressExtractorTest < Test::Unit::TestCase
     assert string =~ /via mail at:\n  skidoosh/
   end
   
+  def test_no_addresses_found
+    assert_nil AddressExtractor.first_address("foo")
+    assert_equal [], AddressExtractor.find_addresses("foo")
+    assert_equal "foo", AddressExtractor.replace_first_address("foo")
+    assert_equal "foo", AddressExtractor.replace_addresses("foo")
+  end
+  
   module Helpers
     def assert_first_address(a)
       assert_not_nil a

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: coderifous-address_extractor
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jim Garvin