errata 1.1.0 → 1.1.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+1.1.1 / 2012-05-11
+
+* Enhancements
+
+  * Don't require a :responder if there are no conditions
+
 1.1.0 / 2012-05-03
 
 * Breaking changes

data/{README.md → README.markdown}

@@ -1,8 +1,36 @@
 # errata
 
-Correct strings based on remote errata files.
+Define an errata in table format (CSV) and then apply it to an arbitrary source. Inspired by RFC Errata, lets you keep your own errata in a transparent way.
 
-# Example
+Tested in MRI 1.8.7+, MRI 1.9.2+, and JRuby 1.6.7+. Thread safe.
+
+## Real-world usage
+
+<p><a href="http://brighterplanet.com"><img src="https://s3.amazonaws.com/static.brighterplanet.com/assets/logos/flush-left/inline/green/rasterized/brighter_planet-160-transparent.png" alt="Brighter Planet logo"/></a></p>
+
+We use `errata` for [data science at Brighter Planet](http://brighterplanet.com/research) and in production at
+
+* [Brighter Planet's reference data web service](http://data.brighterplanet.com)
+* [Brighter Planet's impact estimate web service](http://impact.brighterplanet.com)
+
+The killer combination:
+
+1. [`active_record_inline_schema`](https://github.com/seamusabshere/active_record_inline_schema) - define table structure
+2. [`remote_table`](https://github.com/seamusabshere/remote_table) - download data and parse it
+3. [`errata`](https://github.com/seamusabshere/errata) (this library!) - apply corrections in a transparent way
+4. [`data_miner`](https://github.com/seamusabshere/remote_table) - import data idempotently
+
+## Inspiration
+
+There's a process for reporting errata on RFC:
+
+* [RFC Errata](http://www.rfc-editor.org/errata.php)
+* [Status and Type Descriptions for RFC Errata](http://www.rfc-editor.org/status_type_desc.html)
+* [How to report errata](http://www.rfc-editor.org/how_to_report.html)
+
+<p><a href="http://www.rfc-editor.org"><img src="https://github.com/seamusabshere/errata/raw/master/rfc_editor.png" alt="screenshot of the RFC Editor" /></a></p>
+
+## Example
 
 Every errata has a table structure based on the [IETF RFC Editor's "How to Report Errata"](http://www.rfc-editor.org/how_to_report.html).
 
@@ -167,15 +195,44 @@ And then used
 
 Assumes all input strings are UTF-8. Otherwise there can be problems with Ruby 1.9 and Regexp::FIXEDENCODING. Specifically, ASCII-8BIT regexps might be applied to UTF-8 strings (or vice-versa), resulting in Encoding::CompatibilityError.
 
-## Real-life usage
+## More advanced usage
+
+The [`earth` library](https://github.com/brighterplanet/earth) has dozens of real-life examples showing errata in action:
 
-Used by [data_miner](http://github.com/seamusabshere/data_miner)
+<table>
+  <tr>
+    <th>Model</th>
+    <th>Reference</th>
+    <th>Errata file</th>
+  </tr>
+  <tr>
+    <td><a href="http://data.brighterplanet.com/countries">Country</a></td>
+    <td><a href="https://github.com/brighterplanet/earth/blob/master/lib/earth/locality/country/data_miner.rb">data_miner.rb</a></td>
+    <td><a href="https://raw.github.com/brighterplanet/earth/master/errata/country/wri_errata.csv">wri_errata.csv</a></td>
+  </tr>
+  <tr>
+    <td><a href="http://data.brighterplanet.com/aircraft">Aircraft</a></td>
+    <td><a href="https://github.com/brighterplanet/earth/blob/master/lib/earth/air/aircraft/data_miner.rb">data_miner.rb</a></td>
+    <td><a href="https://raw.github.com/brighterplanet/earth/master/errata/aircraft/faa_errata.csv">faa_errata.csv</a></td>
+  </tr>
+  <tr>
+    <td><a href="http://data.brighterplanet.com/airports">Airports</a></td>
+    <td><a href="https://github.com/brighterplanet/earth/blob/master/lib/earth/air/airport/data_miner.rb">data_miner.rb</a></td>
+    <td><a href="https://raw.github.com/brighterplanet/earth/master/errata/airport/openflights_errata.csv">openflights_errata.csv</a></td>
+  </tr>
+  <tr>
+    <td><a href="http://data.brighterplanet.com/automobile_make_model_year_variants">Automobile model variants</a></td>
+    <td><a href="https://github.com/brighterplanet/earth/blob/master/lib/earth/automobile/automobile_make_model_year_variant/data_miner.rb">data_miner.rb</a></td>
+    <td><a href="https://raw.github.com/brighterplanet/earth/master/errata/automobile_make_model_year_variant/feg_errata.csv">feg_errata.csv</a></td>
+  </tr>
+</table>
 
 ## Authors
 
 * Seamus Abshere <seamus@abshere.net>
 * Andy Rossmeissl <andy@rossmeissl.net>
+* Ian Hough <ijhough@gmail.com>
 
 ## Copyright
 
-Copyright (c) 2011 Brighter Planet. See LICENSE for details.
+Copyright (c) 2012 Brighter Planet. See LICENSE for details.

data/lib/errata.rb

@@ -23,13 +23,14 @@ class Errata
     options = options.symbolize_keys
 
     responder = options.delete :responder
-    raise "[errata] :responder is required" unless responder
     if responder.is_a?(::String)
       @lazy_load_responder_mutex = ::Mutex.new
       @lazy_load_responder_class_name = responder
-    else
+    elsif responder
       ::Kernel.warn %{[errata] Passing an object as :responder is deprecated. It's recommended to pass a class name instead, which will be constantized and instantiated with no arguments.}
       @responder = responder
+    else
+      @no_responder = true
     end
 
     if table = options.delete(:table)
@@ -52,6 +53,7 @@ class Errata
   end
 
   def responder
+    return if @no_responder == true
     @responder || @lazy_load_responder_mutex.synchronize do
       @responder ||= lazy_load_responder_class_name.constantize.new
     end

data/lib/errata/erratum.rb

@@ -24,6 +24,9 @@ class Errata
       @matching_methods = options[:condition].split(SEMICOLON_DELIMITER).map do |method_id|
         method_id.strip.gsub(/\W/, '_').downcase + '?'
       end
+      if @matching_methods.any? and @responder.nil?
+        raise ::ArgumentError, %{[errata] Conditions like #{@matching_methods.first.inspect} used, but no :responder defined}
+      end
       @matching_expression = if options[:x].blank?
         nil
       elsif (options[:x].start_with?('/') or options[:x].start_with?('%r{')) and as_regexp = options[:x].as_regexp

data/lib/errata/version.rb

@@ -1,3 +1,3 @@
 class Errata
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/test/test_errata.rb

@@ -2,24 +2,65 @@ require 'helper'
 require 'models'
 
 describe Errata do
-  before do
-    @e = Errata.new :url => 'http://spreadsheets.google.com/pub?key=t9WkYT39zjrStx7ruCFrZJg',
-                    :responder => 'AutomobileVariantGuru'
+  describe 'without responder' do
+    it "doesn't require a responder" do
+      e = Errata.new :url => 'https://docs.google.com/spreadsheet/pub?key=0AkCJNpm9Ks6JdHEtemF2YTZzdGRYbE1MTHFMRXpRUHc&single=true&gid=0&output=csv'
+      row = { 'name' => 'denver intl airport' }
+      e.correct! row
+      row['name'].must_equal 'denver International airport'
+    end
   end
-    
-  it "corrects rows" do
-    alfa = { "carline_mfr_name"=>"ALFA ROMEO" }
-    @e.correct!(alfa)
-    alfa['carline_mfr_name'].must_equal 'Alfa Romeo'
-  end
-  
-  it "rejects rows" do
-    @e.rejects?('carline_mfr_name' => 'AURORA CARS').must_equal true
+
+  describe 'with conditions' do
+    it "uses a responder to answer conditions" do
+      eval %{
+        class ColoradoGuru
+          def is_denver_airport?(record)
+            record['name'].to_s.downcase.include? 'denver'
+          end
+        end
+      }
+      e = Errata.new(
+        :url => 'https://docs.google.com/spreadsheet/pub?key=0AkCJNpm9Ks6JdG9PcFBjVnE4SGpLVXNTakVhSFY2VFE&single=true&gid=0&output=csv',
+        :responder => 'ColoradoGuru'
+      )
+      row = { 'name' => 'denver intl airport' }
+      e.correct! row
+      row['name'].must_equal 'denver International airport' # matched condition
+      row = { 'name' => 'madison intl airport' }
+      e.correct! row
+      row['name'].must_equal 'madison intl airport' # didn't match
+    end
+
+    it "blows up if you have conditions but no responder" do
+      e = Errata.new :url => 'https://docs.google.com/spreadsheet/pub?key=0AkCJNpm9Ks6JdG9PcFBjVnE4SGpLVXNTakVhSFY2VFE&single=true&gid=0&output=csv'
+      row = { 'name' => 'denver intl airport' }
+      lambda do
+        e.correct! row
+      end.must_raise ArgumentError, /conditions.*used/i
+    end
   end
+
+  describe 'to correct automobile model details' do
+    before do
+      @e = Errata.new :url => 'http://spreadsheets.google.com/pub?key=t9WkYT39zjrStx7ruCFrZJg',
+                      :responder => 'AutomobileVariantGuru'
+    end
+      
+    it "corrects rows" do
+      alfa = { "carline_mfr_name"=>"ALFA ROMEO" }
+      @e.correct!(alfa)
+      alfa['carline_mfr_name'].must_equal 'Alfa Romeo'
+    end
     
-  it "tries multiple conditions" do
-    bentley = { 'carline_mfr_name' => 'ROLLS-ROYCE BENTLEY', "carline name" => 'Super Bentley' }
-    @e.correct!(bentley)
-    bentley['carline_mfr_name'].must_equal 'Bentley'
+    it "rejects rows" do
+      @e.rejects?('carline_mfr_name' => 'AURORA CARS').must_equal true
+    end
+      
+    it "tries multiple conditions" do
+      bentley = { 'carline_mfr_name' => 'ROLLS-ROYCE BENTLEY', "carline name" => 'Super Bentley' }
+      @e.correct!(bentley)
+      bentley['carline_mfr_name'].must_equal 'Bentley'
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errata
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,12 +67,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
 - .gitignore
 - CHANGELOG
 - Gemfile
 - LICENSE
-- README.md
+- README.markdown
 - Rakefile
 - errata.gemspec
 - lib/errata.rb
@@ -84,6 +83,7 @@ files:
 - lib/errata/erratum/transform.rb
 - lib/errata/erratum/truncate.rb
 - lib/errata/version.rb
+- rfc_editor.png
 - test/helper.rb
 - test/models.rb
 - test/test_errata.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE