validb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aecd94c7cb36508bb2fe17f98a8c8ff7e35fbd36
-  data.tar.gz: 399a316d78060de84cd0534b5c3d4286aa0d512c
+  metadata.gz: 5e66a8a7fe86ed39a2a756c8bb8e62e302ee4576
+  data.tar.gz: fc47f3fc3335fd08755b95e3c57df02761d94cc9
 SHA512:
-  metadata.gz: 7df0136e326c3dc0fa8da5d58e5d59ba0b44c4224db734b6421d8b956affb96a2a8090ad1f5b2f39b9e1ae2b6eb0b49cc9a8b73592f177d4c84d417a2ba4e456
-  data.tar.gz: 9966e8375e09f154eeb6326eb3c72a84bb08c9a2448d2952af7fc01cc606931980f291601cd6199ecdc05fd94f3e3089af92a5124ea6f9b40b4cf254973bea69
+  metadata.gz: ba05c70df13a9f8268bf6005106feb0e65a961c4a9bac37fb3c552e1b40961c0cc1a3c8a42afad6b2c40f34514385c1b685be12f270ab94cbd44fa02d83f5efa
+  data.tar.gz: 38ef49e1b9fa51db2646d07779038234125d893504d54220daa107396b6ecbbe3693c658cf4952f8bac6e2ec6d28027380152dbc14542d99137f3c8c895154bb

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.1.0, released 2013-03-28
+* CHANGE: Don't check base models if we have decendants
+* Parameter for the batch size
+* Sort models to be validated
+* Fix progress reporting output
+* Show total model record count
+* Show model table name
+
 ## 1.0.0, released 2013-03-27
 * Add rake task to generate config file
 * Allow filtering of unwanted models

data/Gemfile

@@ -2,10 +2,6 @@ source 'https://rubygems.org/'
 
 gemspec
 
-gem "rake"
 gem "pry"
-
 gem "rspec"
- 
 gem "sqlite3"
-gem "activerecord"

data/README.md

@@ -38,7 +38,8 @@ Check your database for invalid models.
       ],
       "ignored_prefixes": [
         "Api"
-      ]
+      ],
+      "batch_size": 100
     }
 
 ## License

data/lib/tasks/validb.rake

@@ -2,17 +2,17 @@ namespace :validb do
   desc "Check DB for invalid records"
   task :validate => :environment do
     models = ENV["models"] || ""
-    logger = ENV["logger"] || "Validb::ConsoleLogger"
+    logger_class = ENV["logger"] || "Validb::ConsoleLogger"
     filename = ENV["config"] || default_configuration_file
 
     # force all models to load so we can find them
     Rails.application.eager_load!
 
-    configuration = Validb::Configuration.new(filename)
-    finder = Validb::Finder.new(configuration, models)
+    params = Validb::Configuration.new(filename).params
+    finder = Validb::Finder.new(params, models)
 
-    console_logger = logger.constantize.new
-    checker = Validb::Checker.new(console_logger)
+    logger = logger_class.constantize.new
+    checker = Validb::Checker.new(params, logger)
     checker.check(finder.models)
   end
 
@@ -31,7 +31,7 @@ namespace :validb do
   end
 
   def default_configuration
-    { "ignored_models" => [], "ignored_prefixes" => [] }
+    { "ignored_models" => [], "ignored_prefixes" => [], "batch_size" => 100 }
   end
 
   def write_configuration_file

data/lib/validb/batcher.rb

@@ -6,7 +6,7 @@ module Validb
     end
 
     def validate(record_batch)
-      puts "."
+      $stdout.print "."
       record_batch.each do |record|
         @record_validator.validate(record)
       end

data/lib/validb/checker.rb

@@ -1,8 +1,8 @@
 module Validb
   class Checker
 
-    def initialize(logger)
-      @model_validator = Validb::ModelValidator.new(logger)
+    def initialize(params, logger)
+      @model_validator = Validb::ModelValidator.new(params, logger)
     end
 
     def check(models)

data/lib/validb/configuration.rb

@@ -6,6 +6,12 @@ module Validb
       print_ignored
     end
 
+    def params
+      Validb::Parameters.new(ignored_models, ignored_prefixes, batch_size)
+    end
+
+    private
+
     def ignored_models
       convert_model_name_strings_to_constants
     end
@@ -14,7 +20,9 @@ module Validb
       config["ignored_prefixes"]
     end
 
-    private
+    def batch_size
+      config["batch_size"]
+    end
 
     def print_ignored
       puts "Ignoring prefixes: #{ignored_prefixes.join(',')}" if ignored_prefixes.any?
@@ -28,7 +36,8 @@ module Validb
                     else
                       {
                         "ignored_models" => [],
-                        "ignored_prefixes" => []
+                        "ignored_prefixes" => [],
+                        "batch_size" => 100
                       }
                     end
                   end

data/lib/validb/console_logger.rb

@@ -2,7 +2,7 @@ module Validb
   class ConsoleLogger
 
     def out(record_hash)
-      puts "#{record_hash[:model]}:#{record_hash[:id]} - #{record_hash[:error_messages]}"
+      $stdout.puts "\n#{record_hash[:model]}:#{record_hash[:id]} - #{record_hash[:error_messages]}"
     end
   end
 end

data/lib/validb/finder.rb

@@ -1,8 +1,8 @@
 module Validb
   class Finder
 
-    def initialize(configuration, model_name_string)
-      @model_filterer = Validb::ModelFilterer.new(configuration)
+    def initialize(params, model_name_string)
+      @model_filterer = Validb::ModelFilterer.new(params)
       @model_name_string = model_name_string || ""
     end
 

data/lib/validb/model_filterer.rb

@@ -1,25 +1,29 @@
 module Validb
   class ModelFilterer
 
-    def initialize(configuration)
-      @configuration = configuration
+    def initialize(params)
+      @params = params
     end
 
     def filter(models)
       filtered_models = validatable_models(models)
-      filtered_models = non_inherited_models(filtered_models)
       filtered_models = non_ignored_models(filtered_models)
-      non_ignored_prefix_models(filtered_models)
+      filtered_models = non_ignored_prefix_models(filtered_models)
+      non_inherited_models(filtered_models).sort_by(&:name)
     end
 
     private
 
     def ignored_models
-      @configuration.ignored_models
+      @params.ignored_models
     end
 
     def ignored_prefixes
-      @configuration.ignored_prefixes
+      @params.ignored_prefixes
+    end
+
+    def non_inherited_models(models)
+      models.reject { |model| (models & model.descendants).any? }
     end
 
     def non_ignored_prefix_models(models)
@@ -32,10 +36,6 @@ module Validb
       models - ignored_models
     end
 
-    def non_inherited_models(models)
-      models.reject { |model| model != model.base_class && models.include?(model.base_class)}
-    end
-
     def validatable_models(models)
       models.select { |model| model.validators.any? }
     end

data/lib/validb/model_validator.rb

@@ -1,13 +1,14 @@
 module Validb
   class ModelValidator
 
-    def initialize(logger)
+    def initialize(params, logger)
+      @params = params
       @batcher = Validb::Batcher.new(logger)
     end
 
     def validate(model)
-      puts "Checking #{model}"
-      model.find_in_batches do |record_batch|
+      $stdout.print "\nChecking #{model}(#{model.table_name}) (#{model.count} records)."
+      model.find_in_batches(batch_size: @params.batch_size) do |record_batch|
         @batcher.validate(record_batch)
       end
     end

data/lib/validb/parameters.rb

@@ -0,0 +1,3 @@
+module Validb
+  Parameters = Struct.new(:ignored_models, :ignored_prefixes, :batch_size)
+end

data/lib/validb/version.rb

@@ -1,3 +1,3 @@
 module Validb
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/validb.rb

@@ -13,4 +13,5 @@ module Validb
   autoload :ModelValidator, 'validb/model_validator'
   autoload :Batcher, 'validb/batcher'
   autoload :RecordValidator, 'validb/record_validator'
+  autoload :Parameters, 'validb/parameters'
 end

data/spec/config/validb.json

@@ -6,5 +6,6 @@
   ],
   "ignored_prefixes": [
     "Api"
-  ]
+  ],
+  "batch_size": 200
 }

data/spec/validb/batcher_spec.rb

@@ -15,7 +15,7 @@ describe Validb::Batcher do
       logger = double('logger')
       batcher = Validb::Batcher.new(logger)
 
-      $stdout.should_receive(:puts).with(".")
+      $stdout.should_receive(:print).with(".")
       batcher.validate(record_batch)
     end
   end

data/spec/validb/checker_spec.rb

@@ -4,17 +4,19 @@ describe Validb::Checker do
   describe "#initialize" do
     it "creates a checker" do
       logger = double('logger')
-      Validb::ModelValidator.should_receive(:new).with(logger)
-      Validb::Checker.new(logger)
+      params = double('params')
+      Validb::ModelValidator.should_receive(:new).with(params, logger)
+      Validb::Checker.new(params, logger)
     end
   end
 
   describe "#check" do
     it "validates the passed in models records" do
       logger = double('logger')
+      params = double('params')
       model_validator = double('model_validator')
-      Validb::ModelValidator.should_receive(:new).with(logger).and_return(model_validator)
-      checker = Validb::Checker.new(logger)
+      Validb::ModelValidator.should_receive(:new).with(params, logger).and_return(model_validator)
+      checker = Validb::Checker.new(params, logger)
 
       model_validator.should_receive(:validate).with(Blog)
       model_validator.should_receive(:validate).with(Post)

data/spec/validb/configuration_spec.rb

@@ -8,38 +8,24 @@ describe Validb::Configuration do
     end
   end
 
-  describe "#ignored_models" do
+  describe "#params" do
     context "with a missing configuration file" do
-      it "returns an empty array" do
+      it "creates a params" do
         filename = File.expand_path(File.dirname(__FILE__) + '/../config/missing.json')
-        configuration = Validb::Configuration.new(filename)
-        configuration.ignored_models.should == []
+        params = Validb::Configuration.new(filename).params
+        params.ignored_models.should == []
+        params.ignored_prefixes.should == []
+        params.batch_size.should == 100
       end
     end
 
     context "with a configuration file" do
-      it "returns the ignored models" do
+      it "returns the batch size" do
         filename = File.expand_path(File.dirname(__FILE__) + '/../config/validb.json')
-        configuration = Validb::Configuration.new(filename)
-        configuration.ignored_models.should == [Blog, Post]
-      end
-    end
-  end
-
-  describe "#ignored_prefixes" do
-    context "with a missing configuration file" do
-      it "returns an empty array" do
-        filename = File.expand_path(File.dirname(__FILE__) + '/../config/missing.json')
-        configuration = Validb::Configuration.new(filename)
-        configuration.ignored_prefixes.should == []
-      end
-    end
-
-    context "with a configuration file" do
-      it "returns the ignored models" do
-        filename = File.expand_path(File.dirname(__FILE__) + '/../config/validb.json')
-        configuration = Validb::Configuration.new(filename)
-        configuration.ignored_prefixes.should == ["Api"]
+        params = Validb::Configuration.new(filename).params
+        params.ignored_models.should == [Blog, Post]
+        params.ignored_prefixes.should == ["Api"]
+        params.batch_size.should == 200
       end
     end
   end

data/spec/validb/console_logger_spec.rb

@@ -6,7 +6,7 @@ describe Validb::ConsoleLogger do
       hash = { model: Blog, id: 1, error_messages: "Error message" }
 
       console_logger = Validb::ConsoleLogger.new
-      $stdout.should_receive(:puts).with("Blog:1 - Error message")
+      $stdout.should_receive(:puts).with("\nBlog:1 - Error message")
       console_logger.out(hash)
     end
   end

data/spec/validb/finder_spec.rb

@@ -6,34 +6,34 @@ describe Validb::Finder do
 
   describe "#initialize" do
     it "creates a model filterer" do
-      configuration = double('configuration')
-      Validb::ModelFilterer.should_receive(:new).with(configuration)
-      Validb::Finder.new(configuration, "")
+      params = double('params')
+      Validb::ModelFilterer.should_receive(:new).with(params)
+      Validb::Finder.new(params, "")
     end
   end
 
   describe "#models" do
     context "with an empty string" do
       it "returns all the models with tables" do
-        configuration = Validb::Configuration.new("")
-        finder = Validb::Finder.new(configuration, "")
-        finder.models.should =~ [Post, Blog, Comment, Person]
+        params = Validb::Configuration.new("").params
+        finder = Validb::Finder.new(params, "")
+        finder.models.should == [Author, Blog, Comment, Post]
       end
     end
 
     context "valid model names" do
       it "returns all the selected models with tables" do
-        configuration = Validb::Configuration.new("")
-        finder = Validb::Finder.new(configuration, "Post, Blog")
-        finder.models.should =~ [Post, Blog]
+        params = Validb::Configuration.new("").params
+        finder = Validb::Finder.new(params, "Post, Blog")
+        finder.models.should == [Blog, Post]
       end
     end
 
     context "with invalid model names" do
       it "returns all the valid models with tables" do
-        configuration = Validb::Configuration.new("")
-        finder = Validb::Finder.new(configuration, "Post, Blog, Fake")
-        finder.models.should =~ [Post, Blog]
+        params = Validb::Configuration.new("").params
+        finder = Validb::Finder.new(params, "Post, Blog, Fake")
+        finder.models.should == [Blog, Post]
       end
     end
   end

data/spec/validb/model_filterer_spec.rb

@@ -14,12 +14,12 @@ describe Validb::ModelFilterer do
   describe "#models" do
     it "returns all the non filtered models" do
       filename = File.expand_path(File.dirname(__FILE__) + '/../config/validb.json')
-      configuration = Validb::Configuration.new(filename)
-      model_filterer = Validb::ModelFilterer.new(configuration)
+      params = Validb::Configuration.new(filename).params
+      model_filterer = Validb::ModelFilterer.new(params)
 
       models = [User, Author, Blog, Post, Api::Approval, Comment, Person]
 
-      model_filterer.filter(models).should =~ [Comment, Person]
+      model_filterer.filter(models).should == [Author, Comment]
     end
   end
 end

data/spec/validb/model_validator_spec.rb

@@ -4,8 +4,9 @@ describe Validb::ModelValidator do
   describe "#initialize" do
     it "creates a model validator" do
       logger = double('logger')
+      params = double('params')
       Validb::Batcher.should_receive(:new).with(logger)
-      Validb::ModelValidator.new(logger)
+      Validb::ModelValidator.new(params, logger)
     end
   end
 
@@ -13,9 +14,11 @@ describe Validb::ModelValidator do
     it "validates the records of the model" do
       model = Blog
       logger = double('logger')
-      model_validator = Validb::ModelValidator.new(logger)
+      params = double('params', batch_size: 200)
+      model_validator = Validb::ModelValidator.new(params, logger)
 
-      $stdout.should_receive(:puts).with("Checking Blog")
+      $stdout.should_receive(:print).with("\nChecking Blog(blogs) (0 records).")
+      model.should_receive(:find_in_batches).with(batch_size: 200)
       model_validator.validate(model)
     end
   end

data/spec/validb/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe Validb do
   it "returns the version" do
-    Validb::VERSION.should == "1.0.0"
+    Validb::VERSION.should == "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Joey Geiger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,6 +45,7 @@ files:
 - lib/validb/finder.rb
 - lib/validb/model_filterer.rb
 - lib/validb/model_validator.rb
+- lib/validb/parameters.rb
 - lib/validb/railtie.rb
 - lib/validb/record_validator.rb
 - lib/validb/version.rb