table_warnings 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+rdoc/*
+data_miner.log
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in table_warnings.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,26 @@
+=table_warnings
+
+NOTE: only for activerecord right now because it uses <tt>count(:conditions => [...])</tt>
+
+==How to define warning signs
+
+    class AutomobileMake < ActiveRecord::Base
+      warn_if_blanks_in :name
+      warn_if_blanks_in :fuel_efficiency
+      warn_unless_size_is :hundreds
+    end
+
+==How to see warnings for the table
+
+    ?> AutomobileMake.table_warnings
+    => [ "Table is not of expected size" ]
+
+==Defense
+
+* This is not the same as validations, because those interfere with the saving of individual records
+
+==Self-criticism
+
+* Maybe this should work work on any class that defines <tt>.all</tt>
+
+Copyright 2011 Seamus Abshere

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = TableWarnings::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "table_warnings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/table_warnings/config.rb

@@ -0,0 +1,11 @@
+require 'singleton'
+require 'set'
+module TableWarnings
+  class Config
+    include ::Singleton
+
+    def warnings
+      @warnings ||= ::Hash.new { |hash, key| hash[key] = ::Set.new }
+    end
+  end
+end

data/lib/table_warnings/version.rb

@@ -0,0 +1,3 @@
+module TableWarnings
+  VERSION = "0.0.2"
+end

data/lib/table_warnings/warning/blank.rb

@@ -0,0 +1,23 @@
+module TableWarnings
+  class Warning
+    class Blank < Warning
+      attr_reader :column_name
+      
+      def effective_column_names
+        if column_name
+          [column_name]
+        else
+          table.column_names
+        end
+      end
+      
+      def messages
+        effective_column_names.map do |c|
+          if table.count(:conditions => { c => ''}) > 0 or table.count(:conditions => { c => nil }) > 0
+            "There are blanks in the `#{c}` column."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/table_warnings/warning/size.rb

@@ -0,0 +1,34 @@
+module TableWarnings
+  class Warning
+    class Size < Warning
+      attr_reader :approximate_size
+      
+      def allowed_range
+        case approximate_size
+        when :few
+          1..10
+        when :dozens, :tens
+          10..100
+        when :hundreds
+          100..1_000
+        when :thousands
+          1_000..99_000
+        when :hundreds_of_thousands
+          100_000..1_000_000
+        when :millions
+          1_000_000..1_000_000_000
+        when Range
+          approximate_size
+        when Numeric
+          approximate_size..approximate_size
+        end
+      end
+
+      def messages
+        unless allowed_range.include? table.count
+          "Table is not of expected size (expected: #{allowed_range.to_s}, actual: #{table.count})"
+        end
+      end
+    end
+  end
+end

data/lib/table_warnings/warning.rb

@@ -0,0 +1,29 @@
+module TableWarnings
+  class Warning
+    autoload :Blank, 'table_warnings/warning/blank'
+    autoload :Size, 'table_warnings/warning/size'
+    
+    attr_reader :table
+    
+    def initialize(options = {})
+      options.each do |k, v|
+        instance_variable_set "@#{k}", v
+      end
+    end
+    
+    def to_hash
+      instance_variables.sort.inject({}) do |memo, ivar_name|
+        memo[ivar_name.to_s.sub('@', '')] = instance_variable_get ivar_name
+        memo
+      end
+    end
+    
+    def hash
+      to_hash.hash
+    end
+    
+    def eql?(other)
+      other.is_a?(Warning) and self.to_hash == other.to_hash
+    end
+  end
+end

data/lib/table_warnings.rb

@@ -0,0 +1,44 @@
+require 'active_record'
+
+module TableWarnings
+  autoload :Config, 'table_warnings/config'
+  autoload :Warning, 'table_warnings/warning'
+
+  def self.config #:nodoc: all
+    Config.instance
+  end
+
+  # Get current warnings on the table.
+  def table_warnings
+    ::TableWarnings.config.warnings[self].map { |w| w.messages }.flatten.compact.sort
+  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
+  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
+  end
+  
+  # Warn if the number of records falls out of an (approximate) range.
+  #
+  # 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
+  end
+end
+
+unless ::ActiveRecord::Base.method_defined? :table_warnings
+  ::ActiveRecord::Base.extend ::TableWarnings
+end

data/table_warnings.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'table_warnings/version'
+
+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'
+  s.summary     = %q{It's called validations to remind people of per-record validations, but it works on the table, and is meant to be used after a table is completely populated.}
+  s.description = %q{Validate an entire [ActiveRecord] table, checking for things like blank rows or total number of rows}
+
+  s.rubyforge_project = 'table_warnings'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.add_development_dependency 'fastercsv'
+  s.add_development_dependency 'earth', '0.3.11'
+  s.add_dependency 'activerecord' # for now
+end

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'test/unit'
+require 'active_support/all'
+require 'active_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:")
+end
+require 'earth'
+Earth.init :automobile, :apply_schemas => true
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'table_warnings'
+class Test::Unit::TestCase
+end

data/test/test_table_warnings.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class AutomobileMake < ActiveRecord::Base
+  warn_if_blanks_in :name
+  warn_if_blanks_in :fuel_efficiency
+  warn_unless_size_is :hundreds
+  warn_unless_size_is 100..1000
+end
+
+class AutomobileFuelType < ActiveRecord::Base
+  warn_if_any_blanks
+  warn_unless_size_is :few
+  warn_unless_size_is 1..6
+end
+
+AutomobileMake.create! :name => '', :fuel_efficiency => nil, :fuel_efficiency_units => 'kilometres_per_litre'
+AutomobileMake.create! :name => 'Alfa Romeo', :fuel_efficiency => 10.4075, :fuel_efficiency_units => 'kilometres_per_litre'
+
+AutomobileFuelType.create! :name => 'gas'
+AutomobileFuelType.create! :name => 'diesel'
+
+class TestTableWarnings < Test::Unit::TestCase
+  def test_warn_for_blanks_in_specific_columns
+    assert AutomobileMake.table_warnings.one? { |w| w =~ /blanks in.*name.*column/ }
+    assert AutomobileMake.table_warnings.one? { |w| w =~ /blanks in.*fuel_efficiency.*column/ }
+  end
+  def test_warn_of_size
+    assert AutomobileMake.table_warnings.many? { |w| w =~ /expected.*size/ }
+  end
+  def test_warn_for_blanks_in_any_column
+    assert AutomobileFuelType.table_warnings.one? { |w| w =~ /blanks in.*code.*column/ }
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: table_warnings
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-18 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: earth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 3
+        - 11
+        version: 0.3.11
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Validate an entire [ActiveRecord] table, checking for things like blank rows or total number of rows
+email: 
+- seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/table_warnings.rb
+- lib/table_warnings/config.rb
+- lib/table_warnings/version.rb
+- lib/table_warnings/warning.rb
+- lib/table_warnings/warning/blank.rb
+- lib/table_warnings/warning/size.rb
+- table_warnings.gemspec
+- test/helper.rb
+- test/test_table_warnings.rb
+has_rdoc: true
+homepage: https://github.com/seamusabshere/table_warnings
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: table_warnings
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: It's called validations to remind people of per-record validations, but it works on the table, and is meant to be used after a table is completely populated.
+test_files: 
+- test/helper.rb
+- test/test_table_warnings.rb