table_warnings 0.0.7 → 1.0.0

data/lib/table_warnings/version.rb

@@ -1,3 +1,3 @@
 module TableWarnings
-  VERSION = "0.0.7"
+  VERSION = "1.0.0"
 end

data/lib/table_warnings.rb

@@ -1,53 +1,163 @@
+require 'thread'
+
 require 'active_support'
 require 'active_support/version'
-require 'active_support/core_ext' if ::ActiveSupport::VERSION::MAJOR >= 3
+require 'active_support/core_ext' if ActiveSupport::VERSION::MAJOR >= 3
 require 'active_record'
 
-module TableWarnings
-  autoload :Config, 'table_warnings/config'
-  autoload :Warning, 'table_warnings/warning'
+require 'table_warnings/registry'
+require 'table_warnings/exclusive'
+require 'table_warnings/blank'
+require 'table_warnings/size'
+require 'table_warnings/arbitrary'
+require 'table_warnings/null'
+require 'table_warnings/column'
+require 'table_warnings/scout'
+require 'table_warnings/nonexistent_owner'
+require 'table_warnings/range'
 
-  def self.config #:nodoc: all
-    Config.instance
+module TableWarnings
+  def TableWarnings.registry
+    @registry || Thread.exclusive do
+      @registry ||= Registry.new
+    end
   end
 
-  # Get current warnings on the table.
+  # used to resolve columns to warnings
+  Disposition = Struct.new(:exclusives, :covers, :matches)
+
+  # Get current warning messages on the table.
   def table_warnings
-    ::TableWarnings.config.warnings[self].map { |w| w.messages }.flatten.compact.sort
+    messages = []
+
+    TableWarnings.registry.nonexclusive(self).each do |warning|
+      messages << warning.messages
+    end
+
+    pool = column_names.map do |column_name|
+      TableWarnings::Column.new self, column_name
+    end
+    exclusive = TableWarnings.registry.exclusive(self)
+
+    assignments = {}
+    # pass 1 - exclusives and covers
+    exclusive.each do |warning|
+      disposition = Disposition.new
+      disposition.exclusives = warning.exclusives pool
+      disposition.covers = warning.covers pool
+      assignments[warning] = disposition
+      pool -= disposition.exclusives
+    end
+    if ENV['TABLE_WARNINGS_DEBUG'] == 'true'
+      $stderr.puts "pass 1"
+      assignments.each do |warning, disposition|
+        $stderr.puts "  #{warning.scout.matcher} - exclusives=#{disposition.exclusives.map(&:name)} covers=#{disposition.covers.map(&:name)}"
+      end
+    end
+    # pass 2 - allow regexp matching, but only if somebody else didn't cover it
+    exclusive.each do |warning|
+      disposition = assignments[warning]
+      disposition.matches = warning.matches(pool).select do |match|
+        assignments.except(warning).none? { |_, other| other.covers.include?(match) }
+      end
+      pool -= disposition.matches
+    end
+    if ENV['TABLE_WARNINGS_DEBUG'] == 'true'
+      $stderr.puts "pass 2"
+      assignments.each do |warning, disposition|
+        $stderr.puts "  #{warning.scout.matcher} - exclusives=#{disposition.exclusives.map(&:name)} covers=#{disposition.covers.map(&:name)} matches=#{disposition.matches.map(&:name)}"
+      end
+    end
+    if ENV['TABLE_WARNINGS_STRICT'] == 'true'
+      $stderr.puts "uncovered columns"
+      $stderr.puts pool.join("\n")
+    end
+
+    # now you can generate messages
+    assignments.each do |warning, disposition|
+      messages << warning.messages(disposition.exclusives+disposition.matches)
+    end
+
+    messages.flatten.compact
+  end
+
+  def warn_unless_range(*args)
+    options = args.extract_options!
+    args.flatten.each do |matcher|
+      TableWarnings.registry.add_warning self, TableWarnings::Range.new(self, matcher, options)
+    end
   end
   
   # Warn if there are blanks in a certain column.
   #
   # Blank includes both NULL and "" (empty string)
-  def warn_if_blanks_in(column_name)
-    warning = ::TableWarnings::Warning::Blank.new :table => self, :column_name => column_name
-    ::TableWarnings.config.warnings[self].add warning
+  def warn_if_blanks(*args)
+    options = args.extract_options!
+    args.flatten.each do |matcher|
+      TableWarnings.registry.add_warning self, TableWarnings::Blank.new(self, matcher, options)
+    end
   end
   
+  # Warn if there are NULLs in a certain column.
+  def warn_if_nulls(*args)
+    options = args.extract_options!
+    args.flatten.each do |matcher|
+      TableWarnings.registry.add_warning self, TableWarnings::Null.new(self, matcher, options)
+    end
+  end
+
   # Warn if there are blanks in ANY column.
-  #
-  # Blank includes both NULL and "" (empty string)
   def warn_if_any_blanks
-    warning = ::TableWarnings::Warning::Blank.new :table => self
-    ::TableWarnings.config.warnings[self].add warning
+    TableWarnings.registry.add_warning self, TableWarnings::Blank.new(self, /.*/)
+  end
+
+  # Warn if there are nulls in ANY column.
+  def warn_if_any_nulls
+    TableWarnings.registry.add_warning self, TableWarnings::Null.new(self, /.*/)
   end
   
-  # Warn if the number of records falls out of an (approximate) range.
+  # Warn if the number of records falls out of an (approximate) size.
   #
   # Approximations: :few, :tens, :dozens, :hundreds, :thousands, :hundreds_of_thousands, :millions
   # Exact: pass a Range or a Numeric
-  def warn_unless_size_is(approximate_size)
-    warning = ::TableWarnings::Warning::Size.new :table => self, :approximate_size => approximate_size
-    ::TableWarnings.config.warnings[self].add warning
+  def warn_unless_size(approximate_size, options = {})
+    TableWarnings.registry.add_warning self, TableWarnings::Size.new(self, approximate_size, options)
   end
   
   # An arbitrary warning.
-  def warn(&blk)
-    warning = ::TableWarnings::Warning::Arbitrary.new :table => self, :blk => blk
-    ::TableWarnings.config.warnings[self].add warning
+  def warn_if(&blk)
+    TableWarnings.registry.add_warning self, TableWarnings::Arbitrary.new(self, blk)
+  end
+
+  def warn_if_nulls_except(*args)
+    options = args.extract_options!
+    args.flatten.each do |matcher|
+      TableWarnings.registry.add_warning self, TableWarnings::Null.new(self, matcher, options.merge(:negative => true))
+    end
+  end
+
+  def warn_if_blanks_except(*args)
+    options = args.extract_options!
+    args.flatten.each do |matcher|
+      TableWarnings.registry.add_warning self, TableWarnings::Blank.new(self, matcher, options.merge(:negative => true))
+    end
+  end
+
+  def warn_if_nonexistent_owner(*args)
+    options = args.extract_options!
+    args.flatten.each do |belongs_to_association_name|
+      TableWarnings.registry.add_warning self, TableWarnings::NonexistentOwner.new(self, belongs_to_association_name, options)
+    end
+  end
+
+  def warn_if_nonexistent_owner_except(*args)
+    options = args.extract_options!
+    args.flatten.each do |belongs_to_association_name|
+      TableWarnings.registry.add_warning self, TableWarnings::NonexistentOwner.new(self, belongs_to_association_name, options.merge(:negative => true))
+    end
   end
 end
 
-unless ::ActiveRecord::Base.method_defined? :table_warnings
-  ::ActiveRecord::Base.extend ::TableWarnings
+unless ActiveRecord::Base.method_defined? :table_warnings
+  ActiveRecord::Base.extend TableWarnings
 end

data/table_warnings.gemspec

@@ -1,11 +1,9 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'table_warnings/version'
+require File.expand_path('../lib/table_warnings/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'table_warnings'
   s.version     = TableWarnings::VERSION
-  s.platform    = Gem::Platform::RUBY
   s.authors     = ['Seamus Abshere']
   s.email       = ['seamus@abshere.net']
   s.homepage    = 'https://github.com/seamusabshere/table_warnings'
@@ -23,7 +21,10 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport'
 
   s.add_development_dependency 'fastercsv'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'mini_record-compat'
+  s.add_development_dependency 'active_record_inline_schema'
   s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'yard'
+  # s.add_development_dependency 'debugger'
 end

data/test/helper.rb

@@ -1,25 +1,103 @@
 require 'rubygems'
-require 'bundler'
-Bundler.setup
-require 'test/unit'
-require 'active_support/all'
-require 'active_record'
-require 'mini_record'
-# thanks authlogic!
-ActiveRecord::Schema.verbose = false
-begin
-  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
-rescue ArgumentError
-  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+require 'bundler/setup'
+
+if ::Bundler.definition.specs['debugger'].first
+  require 'debugger'
+elsif ::Bundler.definition.specs['ruby-debug'].first
+  require 'ruby-debug'
 end
 
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/reporters'
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+
+require 'active_record'
+require 'active_record_inline_schema'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
 # require 'logger'
 # logger = Logger.new $stdout
 # logger.level = Logger::DEBUG
 # ActiveRecord::Base.logger = logger
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'table_warnings'
-class Test::Unit::TestCase
+class ActiveRecord::Base
+  class << self
+    # ignores protected attrs
+    def force_create!(attrs = {})
+      record = new
+      attrs.each do |k, v|
+        record.send "#{k}=", v
+      end
+      record.save!
+      record
+    end
+  end
 end
+
+class MiniTest::Spec
+  # start transaction
+  before do
+    # activerecord-3.2.3/lib/active_record/fixtures.rb
+    @fixture_connections = ActiveRecord::Base.connection_handler.connection_pools.values.map(&:connection)
+    @fixture_connections.each do |connection|
+      connection.increment_open_transactions
+      connection.transaction_joinable = false
+      connection.begin_db_transaction
+    end
+  end
+
+  # rollback
+  after do
+    @fixture_connections.each do |connection|
+      if connection.open_transactions != 0
+        connection.rollback_db_transaction
+        connection.decrement_open_transactions
+      end
+    end
+    @fixture_connections.clear
+    ActiveRecord::Base.clear_active_connections!
+  end
+
+  def assert_warning(model, expected_warning)
+    hits = model.table_warnings.select { |warning| warning =~ expected_warning }
+    refute hits.none?, "#{model.name} unexpectedly lacked warning #{expected_warning.inspect}"
+    refute hits.many?, "#{model.name} had MULTIPLE warnings like #{expected_warning.inspect}: #{hits.inspect}"
+  end
+
+  def assert_no_warning(model, specific_unexpected_warning = nil)
+    warnings = model.table_warnings
+    if specific_unexpected_warning
+      refute(warnings.any? { |warning| warning =~ specific_unexpected_warning }, "#{model.name} unexpectedly had warning #{specific_unexpected_warning.inspect}")
+    else
+      refute warnings.any?, "#{model.name} unexpectedly had some warnings (#{warnings.inspect})"
+    end
+  end
+
+  def assert_causes_warning(model, expected_warnings)
+    expected_warnings = [expected_warnings].flatten
+    expected_warnings.each do |expected_warning|
+      assert_no_warning model, expected_warning
+    end
+    warnings_before = model.table_warnings
+    yield
+    expected_warnings.each do |expected_warning|
+      assert_warning model, expected_warning
+    end
+    unexpected_warnings = (model.table_warnings - warnings_before).reject do |warning|
+      expected_warnings.any? { |expected_warning| warning =~ expected_warning }
+    end
+    refute unexpected_warnings.any?, "#{model.name} unexpectedly ALSO got warnings #{unexpected_warnings.inspect}"
+  end
+
+  def assert_does_not_cause_warning(model)
+    assert_no_warning model
+    yield
+    assert_no_warning model
+  end
+
+end
+
+require 'table_warnings'

data/test/test_combinations.rb

@@ -0,0 +1,85 @@
+require 'helper'
+
+class PetAlpha < ActiveRecord::Base
+  col :birthday, :type => :datetime
+  col :gender
+  col :sire
+  warn_if_nulls :birthday
+  warn_if_nulls_except :gender
+end
+PetAlpha.auto_upgrade!
+
+class PetBeta < ActiveRecord::Base
+  col :birthday, :type => :datetime
+  col :gender
+  col :sire
+  warn_if_nulls :birthday
+  warn_if_nulls_except /ende/
+end
+PetBeta.auto_upgrade!
+
+class PetGamma < ActiveRecord::Base
+  col :birthday, :type => :datetime
+  col :gender
+  col :sire
+  col :certified, :type => :boolean
+  warn_if_nulls /irthd/, :conditions => { :certified => true }
+  warn_if_nulls_except /ende/
+end
+PetGamma.auto_upgrade!
+
+class PetDelta < ActiveRecord::Base
+  col :birthday, :type => :datetime
+  col :gender
+  col :sire
+  col :certified, :type => :boolean
+  warn_if_nulls /irthd/, :conditions => { :certified => true }
+  warn_if_nulls_except /ende/, :conditions => { :certified => true }
+end
+PetDelta.auto_upgrade!
+
+describe TableWarnings do
+  describe "combinations of positive ('in') and negative ('except') rules" do
+    it "combines a positive column and a negative column" do
+      assert_causes_warning PetAlpha, [/null.*birthday/i, /null.*sire/i] do
+        PetAlpha.force_create!
+      end
+    end
+    it "combines a positive column and a negative regexp" do
+      assert_causes_warning PetBeta, [/null.*birthday/i, /null.*sire/i] do
+        PetBeta.force_create!
+      end
+    end
+    it "combines a positive regexp with conditions and a negative regexp" do
+      assert_causes_warning PetGamma, [/null.*sire/i, /null.*certified/i] do
+        PetGamma.force_create!
+      end
+      PetGamma.delete_all # !
+      assert_causes_warning PetGamma, [/null.*sire/i, /null.*birthday/i] do
+        PetGamma.force_create! :certified => true
+      end
+    end
+    it "combines a positive regexp with conditions and a negative regexp with conditions" do
+      assert_does_not_cause_warning PetDelta do
+        PetDelta.force_create!
+      end
+      PetDelta.delete_all # !
+      assert_causes_warning PetDelta, [/null.*sire/i, /null.*birthday/i] do
+        PetDelta.force_create! :certified => true
+      end
+    end
+  end
+end
+
+=begin
+warn_if_nulls_except(
+  :alt_fuel_code,
+  :carline_mfr_code,
+  :vi_mfr_code,
+  :carline_code,
+  :carline_class_code,
+  :carline_class_name,
+)
+warn_if_nulls /alt_fuel_efficiency/, :conditions => 'alt_fuel_code IS NOT NULL'
+warn_if_nulls :carline_class, :conditions => 'year < 1998'
+=end

data/test/test_warn_if_nonexistent_owner.rb

@@ -0,0 +1,60 @@
+require 'helper'
+
+class Person < ActiveRecord::Base
+  col :llc_name
+end
+Person.auto_upgrade!
+
+class PetRed < ActiveRecord::Base
+  col :handler_id, :type => :integer
+  belongs_to :handler, :class_name => 'Person'
+  warn_if_nonexistent_owner :handler
+end
+PetRed.auto_upgrade!
+
+class PetBlue < ActiveRecord::Base
+  col :trainer_id
+  belongs_to :trainer, :class_name => 'Person', :primary_key => :llc_name
+  warn_if_nonexistent_owner :trainer
+end
+PetBlue.auto_upgrade!
+
+class PetGreen < ActiveRecord::Base
+  col :trainer_id
+  belongs_to :trainer, :class_name => 'Person', :primary_key => :llc_name
+  warn_if_nonexistent_owner :trainer, :allow_null => true
+end
+PetGreen.auto_upgrade!
+
+describe TableWarnings do
+  describe :warn_if_nonexistent_owner do
+    before do
+      Person.force_create! :llc_name => 'My Small Business, LLC'
+    end
+    it "takes a single belongs-to association name" do
+      assert_causes_warning PetRed, /nonexistent.*handler/i do
+        PetRed.force_create!
+      end
+    end
+    it "checks the value of foreign keys not just their presence" do
+      assert_causes_warning PetRed, /nonexistent.*handler/i do
+        PetRed.force_create! :handler_id => 999999
+      end
+    end
+    it "doesn't raise false warnings" do
+      assert_does_not_cause_warning PetRed do
+        PetRed.force_create! :handler_id => Person.first.id
+      end
+    end
+    it "regards nulls as nonexistent even if the association primary key column contains nulls" do
+      assert_causes_warning PetBlue, /nonexistent.*trainer/i do
+        PetBlue.force_create!
+      end
+    end
+    it "allows nulls if explicitly requested" do
+      assert_does_not_cause_warning PetGreen do
+        PetGreen.force_create!
+      end
+    end
+  end
+end