errata 0.1.4

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brighter Planet
+
+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.rdoc

@@ -0,0 +1,31 @@
+=errata
+
+Correct strings based on remote errata files.
+
+==Real-life usage
+
+Used by data_miner (http://github.com/seamusabshere/data_miner)
+
+==Example
+
+Taken from <tt>#{GEMDIR}/test/errata_test.rb</tt>:
+
+  errata = Errata.new(:url => 'http://static.brighterplanet.com/science/data/transport/automobiles/make_fleet_years/errata.csv')
+  rover = { 'manufacturer_name' => 'foobar Austin Rover foobar' }
+  mercedes = { 'manufacturer_name' => 'MERCEDES' }
+  errata.correct!(mercedes)
+  errata.correct!(rover)
+
+Now you will have
+
+  rover['manufacturer_name']    #=> 'Rover'         (used to be 'foobar Austin Rover foobar')
+  mercedes['manufacturer_name'] #=> 'Mercedes-Benz' (used to be 'MERCEDES')
+
+==Authors
+
+* Seamus Abshere <seamus@abshere.net>
+* Andy Rossmeissl <andy@rossmeissl.net>
+
+==Copyright
+
+Copyright (c) 2009 Brighter Planet. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "errata"
+    gem.summary = %Q{Correct strings based on remote errata files}
+    gem.description = %Q{Correct strings based on remote errata files}
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/errata"
+    gem.authors = ["Seamus Abshere", "Andy Rossmeissl"]
+    %w{ activesupport remote_table }.each { |name| gem.add_dependency name }
+    gem.require_path = "lib"
+    gem.files.include %w(lib/erratum) unless gem.files.empty? # seems to fail once it's in the wild
+    gem.rdoc_options << '--line-numbers' << '--inline-source'
+    gem.rubyforge_project = "errata"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "errata #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/errata.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{errata}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Seamus Abshere", "Andy Rossmeissl"]
+  s.date = %q{2009-11-02}
+  s.description = %q{Correct strings based on remote errata files}
+  s.email = %q{seamus@abshere.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "errata.gemspec",
+     "lib/errata.rb",
+     "lib/erratum.rb",
+     "lib/erratum/delete.rb",
+     "lib/erratum/reject.rb",
+     "lib/erratum/replace.rb",
+     "lib/erratum/simplify.rb",
+     "lib/erratum/transform.rb",
+     "lib/erratum/truncate.rb",
+     "test/errata_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/seamusabshere/errata}
+  s.rdoc_options = ["--charset=UTF-8", "--line-numbers", "--inline-source"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{errata}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Correct strings based on remote errata files}
+  s.test_files = [
+    "test/errata_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<remote_table>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<remote_table>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<remote_table>, [">= 0"])
+  end
+end
+

data/lib/errata.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'activesupport'
+require 'remote_table'
+require 'erratum'
+require 'erratum/delete'
+require 'erratum/reject'
+require 'erratum/replace'
+require 'erratum/simplify'
+require 'erratum/transform'
+require 'erratum/truncate'
+
+class Errata
+  attr_reader :klass
+  
+  def initialize(options = {})
+    @klass = options[:klass]
+    @_table = RemoteTable.new(:url => options[:url])
+  end
+  
+  def rejects?(row)
+    rejections.any? { |erratum| erratum.targets?(row) }
+  end
+  
+  def correct!(row)
+    corrections.each { |erratum| erratum.correct!(row) }
+    nil
+  end
+  
+  def implied_matching_methods
+    (rejections + corrections).map { |erratum| erratum.matching_method }.compact.uniq
+  end
+  
+  private
+  
+  def rejections
+    @_rejections ||= @_table.rows.map { |erratum| ::Errata::Erratum::Reject.new(self, erratum) if erratum[:action] == 'reject' }.compact
+  end
+  
+  def corrections
+    @_corrections ||= @_table.rows.map { |erratum| "::Errata::Erratum::#{erratum[:action].camelcase}".constantize.new(self, erratum) if %w{delete replace simplify transform truncate}.include?(erratum[:action]) }.compact
+  end
+end

data/lib/erratum.rb

@@ -0,0 +1,75 @@
+class Errata
+  class Erratum
+    attr_accessor :errata, :column, :matching_method
+    delegate :klass, :to => :errata
+    
+    def initialize(errata, options = {})
+      raise "you can't set this from outside" if options.has_key?(:prefix)
+      @errata = errata
+      @column = options[:section]
+      @matching_method = "#{options[:condition].gsub(/[^a-z0-9]/i, '_').downcase}?".to_sym if options[:condition]
+    end
+    
+    def inspect
+      "<#{self.class.name}:#{object_id} klass=#{klass.name} column=#{column} matching_method=#{matching_method}"
+    end
+    
+    def targets?(row)
+      !!(method_matches?(row) and expression_matches?(row))
+    end
+    
+    def correct!(row, &block)
+      return :skipped unless targets?(row)
+      # old_value = row[column].to_s.dup
+      yield if block_given?
+      # unless name.demodulize.underscore == 'truncate' or name.demodulize.underscore == 'simplify'
+      #   puts "-" * 64
+      #   puts inspect
+      #   puts row.inspect
+      #   if row[column] != old_value
+      #     puts "#{old_value} -> #{row[column]}"
+      #   else
+      #     puts "no change"
+      #   end
+      #   puts
+      # end
+      :corrected
+    end
+
+    private
+    
+    def expression_matches?(row)
+      return true if matching_expression.blank? or column.blank?
+      if matching_expression.is_a?(Regexp)
+        matching_expression.match(row[column].to_s)
+      else
+        row[column].to_s.include?(matching_expression)
+      end
+    end
+    
+    def method_matches?(row)
+      return true if matching_method.nil?
+      klass.send(matching_method, row)
+    end
+    
+    def set_matching_expression(options = {})
+      if options[:x].blank?
+        @matching_expression = nil
+      elsif options[:x].starts_with?('/')
+        if options[:x].ends_with?('i')
+          ci = true
+          options[:x] = options[:x].chop
+        else
+          ci = false
+        end
+        @matching_expression = Regexp.new(options[:x].gsub(/\A\/|\/\z/, ''), ci)
+      elsif /\Aabbr\((.*)\)\z/.match(options[:x])
+        @matching_expression = Regexp.new('(\A|\s)' + $1.split(/(\w\??)/).reject { |a| a == '' }.join('\.?\s?') + '\.?([^\w\.]|\z)', true)
+      elsif options[:prefix] == true
+        @matching_expression = Regexp.new('\A\s*' + Regexp.escape(options[:x]), true)
+      else
+        @matching_expression = options[:x]
+      end
+    end
+  end
+end

data/lib/erratum/delete.rb

@@ -0,0 +1,24 @@
+class Errata
+  class Erratum
+    class Delete < Erratum
+      attr_accessor :matching_expression, :backfill
+      
+      def initialize(errata, options = {})
+        super
+        set_matching_expression(options)
+        # otherwise abbr(X) will kill the characters before and after the match
+        @backfill = /\Aabbr\((.*)\)\z/.match(options[:x]) ? '\1\2' : ''
+      end
+      
+      def inspect
+        super + " matching_expression=#{matching_expression}>"
+      end
+      
+      def correct!(row)
+        super(row) do
+          row[column].gsub!(matching_expression, backfill)
+        end
+      end
+    end
+  end
+end

data/lib/erratum/reject.rb

@@ -0,0 +1,20 @@
+class Errata
+  class Erratum
+    class Reject < Erratum
+      attr_accessor :matching_expression
+      
+      def initialize(errata, options = {})
+        super
+        set_matching_expression(options.merge(:prefix => true))
+      end
+      
+      def inspect
+        super + " matching_expression=#{matching_expression}"
+      end
+      
+      def correct!
+        raise "rejections don't correct"
+      end
+    end
+  end
+end

data/lib/erratum/replace.rb

@@ -0,0 +1,27 @@
+class Errata
+  class Erratum
+    class Replace < Erratum
+      attr_accessor :matching_expression, :correction
+      
+      def initialize(errata, options = {})
+        super
+        set_matching_expression(options)
+        @correction = /\Aabbr\((.*)\)\z/.match(options[:x]) ? '\1' + options[:y].to_s + '\2' : options[:y].to_s
+      end
+      
+      def inspect
+        super + " matching_expression=#{matching_expression} correction=#{correction}>"
+      end
+      
+      def correct!(row)
+        super(row) do
+          if matching_expression.blank?
+            row[column] = correction
+          else
+            row[column].gsub!(matching_expression, correction)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erratum/simplify.rb

@@ -0,0 +1,33 @@
+class Errata
+  class Erratum
+    class Simplify < Erratum
+      attr_accessor :second_column
+      
+      def initialize(errata, options = {})
+        super
+        @second_column = options[:x]
+      end
+
+      def inspect
+        super + " second_column=#{second_column}>"
+      end
+      
+      def targets?(row)
+        !row[column].blank? and !row[second_column].blank? and method_matches?(row) and matching_expression(row).match(row[column])
+      end
+      
+      def correct!(row)
+        super(row) do
+          row[column].gsub!(matching_expression(row), '')
+        end
+      end
+      
+      private
+      
+      def matching_expression(row)
+        @_matching_expressions ||= {}
+        @_matching_expressions[row[second_column]] ||= /[\s\(\[\'\"]*#{Regexp.escape(row[second_column])}[\s\)\]\'\"]*/
+      end
+    end
+  end
+end

data/lib/erratum/transform.rb

@@ -0,0 +1,25 @@
+class Errata
+  class Erratum
+    class Transform < Erratum
+      ALLOWED_METHODS = %w{upcase downcase}
+      attr_accessor :matching_expression, :string_method
+      
+      def initialize(errata, options = {})
+        super
+        set_matching_expression(options)
+        @string_method = options[:y]
+        raise "string method (#{@string_method}) needs to be in (#{ALLOWED_METHODS.join(', ')})" unless ALLOWED_METHODS.include?(@string_method)
+      end
+      
+      def inspect
+        super + " matching_expression=#{matching_expression} string_method=#{string_method}>"
+      end
+      
+      def correct!(row)
+        super(row) do
+          row[column].gsub!(matching_expression) { |match| match.send(string_method) }
+        end
+      end
+    end
+  end
+end

data/lib/erratum/truncate.rb

@@ -0,0 +1,24 @@
+class Errata
+  class Erratum
+    class Truncate < Erratum
+      attr_accessor :matching_expression, :necessary_and_sufficient_prefix
+      
+      def initialize(errata, options = {})
+        super
+        @necessary_and_sufficient_prefix = options[:x]
+        raise "necessary_and_sufficient_prefix cannot be blank" if @necessary_and_sufficient_prefix.blank?
+        set_matching_expression(options.merge(:prefix => true))
+      end
+
+      def inspect
+        super + " matching_expression=#{matching_expression} necessary_and_sufficient_prefix=#{necessary_and_sufficient_prefix}>"
+      end
+      
+      def correct!(row)
+        super(row) do
+          row[column] = necessary_and_sufficient_prefix
+        end
+      end
+    end
+  end
+end

data/test/errata_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class Brewery
+  def self.is_microbrew?(row)
+    row[:volume] < 500
+  end
+end
+
+class ErrataTest < Test::Unit::TestCase
+  def setup
+    @e = Errata.new(:url => 'http://static.brighterplanet.com/science/data/transport/automobiles/make_fleet_years/errata.csv')
+  end
+  
+  should "return implied matching methods" do
+    flunk "create a fake errata for Brewery"
+  end
+  
+  should "use matching methods" do
+    flunk "create a fake errata for Brewery"
+  end
+  
+  should "correct rows" do
+    rover = { 'manufacturer_name' => 'foobar Austin Rover foobar' }
+    mercedes = { 'manufacturer_name' => 'MERCEDES' }
+    @e.correct!(mercedes)
+    @e.correct!(rover)
+    assert_equal 'Mercedes-Benz', mercedes['manufacturer_name']
+    assert_equal 'Rover',         rover['manufacturer_name']
+  end
+  
+  should "reject rows" do
+    assert @e.rejects?('manufacturer_name' => 'AURORA CARS')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'errata'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: errata
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Seamus Abshere
+- Andy Rossmeissl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: remote_table
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Correct strings based on remote errata files
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- errata.gemspec
+- lib/errata.rb
+- lib/erratum.rb
+- lib/erratum/delete.rb
+- lib/erratum/reject.rb
+- lib/erratum/replace.rb
+- lib/erratum/simplify.rb
+- lib/erratum/transform.rb
+- lib/erratum/truncate.rb
+- test/errata_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/seamusabshere/errata
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: errata
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Correct strings based on remote errata files
+test_files: 
+- test/errata_test.rb
+- test/test_helper.rb