validb 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cf59a57d2e7a7218ba7e757ff4f749d6580582d
-  data.tar.gz: 84a2ece5b8606e99232db4441be80cab9ad50cd6
+  metadata.gz: 28235bb827e10873757a172aa4341de2125825b5
+  data.tar.gz: 534c056bd73c20c1a720283757e569d64bfa9cec
 SHA512:
-  metadata.gz: f0bacdfd14f9864abb0fae1a8031041c3ca77ba214381a0d2febed0cfda3d6ff297f2bcde18f1c49475c5d3ce0d09c9d4a0a152e790e451ee9c6ca0d3ae5bb22
-  data.tar.gz: 43f299bccc537dca44c532eeaaee011c88ada7b328186b6bf94e2629ac9b996749b8153b55651430ec285939747e5fed6936a8aa6101fe2e068835193a1c44f9
+  metadata.gz: 7b58b722f5f0f96b7aea4b0f9c89e228682145c4a3876dbaf9a3bd71fb7a56d5fcc60f2b1ac624c6c6c58fcbdc6c777762644dd64812b32338db1fb5ea09f9ca
+  data.tar.gz: 61ded8105b8e95ff8c116adf0ebb88e9ec51bc24e960d21595437b9b8b310c4d1681f6e8731ec19ec1392875dea5b5534478656fd8d5e2e07530bd8062c4a1e7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.0, released 2013-03-26
+* Rake task now takes parameters differently
+* Classes now use instances, not class methods
+* Add new logger class to allow for custom logging
+
 ## 0.0.3, released 2013-03-25
 * Use table_exists? in place of table name
 * Add progress indicator during run

data/README.md

@@ -13,11 +13,14 @@ Check your database for invalid models.
 
 ## Usage
 
-### All models
+### All models, default logger
     rake validb:validate 
 
 ### Specific models
-    rake validb:validate[Model,Model]
+    rake validb:validate models="Model,Model"
+
+### Specific logger
+    rake validb:validate logger="Validb::ConsoleLogger"
 
 ## License
 Released under the MIT License

data/lib/tasks/validb.rake

@@ -1,7 +1,15 @@
 namespace :validb do
   desc "Check DB for invalid records"
-  task :validate, [:model_names] => [:environment] do |t, args|
+  task :validate => :environment do
+    models = ENV["models"] || ""
+    logger = ENV["logger"] || "Validb::ConsoleLogger"
+
+    # force all models to load so we can find them
     Rails.application.eager_load!
-    Validb::Checker.check(args[:model_names])
+    finder = Validb::Finder.new(models)
+
+    console_logger = logger.constantize.new
+    checker = Validb::Checker.new(console_logger)
+    checker.check(finder.models)
   end
 end

data/lib/validb/batcher.rb

@@ -0,0 +1,15 @@
+module Validb
+  class Batcher
+
+    def initialize(logger)
+      @record_validator = RecordValidator.new(logger)
+    end
+
+    def validate(record_batch)
+      puts "."
+      record_batch.each do |record|
+        @record_validator.validate(record)
+      end
+    end
+  end
+end

data/lib/validb/checker.rb

@@ -1,11 +1,13 @@
 module Validb
   class Checker
-    class << self
-      def check(model_names)
-        models = Validb::Finder.get_models(model_names)
-        models.each do |model|
-          Validb::ModelValidator.validate(model)
-        end
+
+    def initialize(logger)
+      @model_validator = Validb::ModelValidator.new(logger)
+    end
+
+    def check(models)
+      models.each do |model|
+        @model_validator.validate(model)
       end
     end
   end

data/lib/validb/console_logger.rb

@@ -0,0 +1,8 @@
+module Validb
+  class ConsoleLogger
+
+    def out(record_hash)
+      puts "#{record_hash[:model]}:#{record_hash[:id]} - #{record_hash[:error_messages]}"
+    end
+  end
+end

data/lib/validb/finder.rb

@@ -1,24 +1,22 @@
 module Validb
   class Finder
-    class << self
-      def get_models(model_name_string)
-        model_name_string ||= ""
-        filter_models(model_name_string.split(",").map(&:strip))
-      end
 
-      private
+    def initialize(model_name_string)
+      @model_name_string = model_name_string || ""
+    end
+
+    def models
+      model_names.empty? ? all : all.select { |model| model_names.include?(model.name) }
+    end
 
-      def all
-        @models ||= ActiveRecord::Base.descendants.select { |model| model.table_exists? }
-      end
+    private
+
+    def model_names
+      @model_names ||= @model_name_string.split(",").map(&:strip)
+    end
 
-      def filter_models(model_names)
-        if model_names.any?
-          all.select { |model| model_names.include?(model.name) }
-        else
-          all
-        end
-      end
+    def all
+      @models ||= ActiveRecord::Base.descendants.select { |model| model.table_exists? }
     end
   end
 end

data/lib/validb/model_validator.rb

@@ -1,21 +1,14 @@
 module Validb
   class ModelValidator
-    class << self
-      def validate(model)
-        puts "Checking #{model}"
 
-        model.find_in_batches do |batch|
-          validate_batch(batch)
-        end
-      end
-
-      private
+    def initialize(logger)
+      @batcher = Validb::Batcher.new(logger)
+    end
 
-      def validate_batch(record_batch)
-        puts "."
-        record_batch.each do |record|
-          RecordValidator.validate(record)
-        end
+    def validate(model)
+      puts "Checking #{model}"
+      model.find_in_batches do |record_batch|
+        @batcher.validate(record_batch)
       end
     end
   end

data/lib/validb/record_validator.rb

@@ -1,8 +1,19 @@
 module Validb
   class RecordValidator
-    def self.validate(record)
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def validate(record)
       if !record.valid?
-        puts "#{record.class.name}:#{record.id} - #{record.errors.full_messages.join(',')}"
+        @logger.out(
+          {
+            model: record.class.name,
+            id: record.id,
+            error_messages: record.errors.full_messages.join(',')
+          }
+        )
       end
     end
   end

data/lib/validb/version.rb

@@ -1,3 +1,3 @@
 module Validb
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/validb.rb

@@ -5,8 +5,10 @@ require 'validb/version'
 
 module Validb
   require 'validb/railtie' if defined?(Rails)
+  autoload :ConsoleLogger, 'validb/console_logger'
   autoload :Checker, 'validb/checker'
   autoload :Finder, 'validb/finder'
-  autoload :RecordValidator, 'validb/record_validator'
   autoload :ModelValidator, 'validb/model_validator'
+  autoload :Batcher, 'validb/batcher'
+  autoload :RecordValidator, 'validb/record_validator'
 end

data/spec/validb/batcher_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Validb::Batcher do
+  describe "#initialize" do
+    it "creates a batcher" do
+      logger = double('logger')
+      Validb::RecordValidator.should_receive(:new).with(logger)
+      Validb::Batcher.new(logger)
+    end
+  end
+
+  describe "#validate" do
+    it "validates the batch of records" do
+      record_batch = [Blog.new(title: "Title")]
+      logger = double('logger')
+      batcher = Validb::Batcher.new(logger)
+
+      $stdout.should_receive(:puts).with(".")
+      batcher.validate(record_batch)
+    end
+  end
+end

data/spec/validb/checker_spec.rb

@@ -1,23 +1,25 @@
 require 'spec_helper'
 
 describe Validb::Checker do
-  describe ".check" do
-    context "without specified models" do
-      it "validates the passed in model's records" do
-        Validb::ModelValidator.should_receive(:validate).with(Blog)
-        Validb::ModelValidator.should_receive(:validate).with(Post)
-        Validb::ModelValidator.should_receive(:validate).with(Comment)
-        Validb::Checker.check("")
-      end
+  describe "#initialize" do
+    it "creates a checker" do
+      logger = double('logger')
+      Validb::ModelValidator.should_receive(:new).with(logger)
+      Validb::Checker.new(logger)
     end
+  end
+
+  describe "#check" do
+    it "validates the passed in models records" do
+      logger = double('logger')
+      model_validator = double('model_validator')
+      Validb::ModelValidator.should_receive(:new).with(logger).and_return(model_validator)
+      checker = Validb::Checker.new(logger)
+
+      model_validator.should_receive(:validate).with(Blog)
+      model_validator.should_receive(:validate).with(Post)
 
-    context "with specified models" do
-      it "validates the passed in model's records" do
-        Validb::ModelValidator.should_receive(:validate).with(Blog)
-        Validb::ModelValidator.should_receive(:validate).with(Post)
-        Validb::ModelValidator.should_not_receive(:validate).with(Comment)
-        Validb::Checker.check("Blog, Post")
-      end
+      checker.check([Blog, Post])
     end
   end
 end

data/spec/validb/console_logger_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Validb::ConsoleLogger do
+  describe "#out" do
+    it "prints the hash output" do
+      hash = { model: Blog, id: 1, error_messages: "Error message" }
+
+      console_logger = Validb::ConsoleLogger.new
+      $stdout.should_receive(:puts).with("Blog:1 - Error message")
+      console_logger.out(hash)
+    end
+  end
+end

data/spec/validb/finder_spec.rb

@@ -4,17 +4,26 @@ describe Validb::Finder do
   class NoTable < ActiveRecord::Base
   end
 
-  describe ".get_models" do
+  describe "#models" do
     context "with an empty string" do
-      Validb::Finder.get_models("").should =~ [Post, Blog, Comment]
+      it "returns all the models with tables" do
+        finder = Validb::Finder.new("")
+        finder.models.should =~ [Post, Blog, Comment]
+      end
     end
 
     context "valid model names" do
-      Validb::Finder.get_models("Post, Blog").should =~ [Post, Blog]
+      it "returns all the selected models with tables" do
+        finder = Validb::Finder.new("Post, Blog")
+        finder.models.should =~ [Post, Blog]
+      end
     end
 
     context "with invalid model names" do
-      Validb::Finder.get_models("Post, Blog, Fake").should =~ [Post, Blog]
+      it "returns all the valid models with tables" do
+        finder = Validb::Finder.new("Post, Blog, Fake")
+        finder.models.should =~ [Post, Blog]
+      end
     end
   end
 end

data/spec/validb/model_validator_spec.rb

@@ -1,15 +1,22 @@
 require 'spec_helper'
 
 describe Validb::ModelValidator do
-  describe "#validate" do
-    context "with a model" do
-      it "validates the records of the model" do
-        model = Blog
+  describe "#initialize" do
+    it "creates a model validator" do
+      logger = double('logger')
+      Validb::Batcher.should_receive(:new).with(logger)
+      Validb::ModelValidator.new(logger)
+    end
+  end
 
-        $stdout.should_receive(:puts).with("Checking Blog")
+  describe "#validate" do
+    it "validates the records of the model" do
+      model = Blog
+      logger = double('logger')
+      model_validator = Validb::ModelValidator.new(logger)
 
-        Validb::ModelValidator.validate(model)
-      end
+      $stdout.should_receive(:puts).with("Checking Blog")
+      model_validator.validate(model)
     end
   end
 end

data/spec/validb/record_validator_spec.rb

@@ -4,22 +4,29 @@ describe Validb::RecordValidator do
   describe "#validate" do
     context "with a valid record" do
       it "validates the passed in record" do
+        logger = double(:logger)
+        record_validator = Validb::RecordValidator.new(logger)
         record = Blog.new(title: "title")
 
-        $stdout.should_not_receive(:puts)
-
-        Validb::RecordValidator.validate(record)
+        logger.should_not_receive(:out)
+        record_validator.validate(record)
       end
     end
 
     context "with an invalid record" do
       it "outputs the record information" do
+        logger = double(:logger)
+        record_validator = Validb::RecordValidator.new(logger)
         record = Blog.new
         record.save(validate: false)
 
-        $stdout.should_receive(:puts).with("Blog:#{record.id} - Title can't be blank")
-
-        Validb::RecordValidator.validate(record)
+        hash = {
+          model: "Blog",
+          id: record.id,
+          error_messages: "Title can't be blank"
+        }
+        logger.should_receive(:out).with(hash)
+        record_validator.validate(record)
       end
     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 == "0.0.3"
+    Validb::VERSION.should == "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Joey Geiger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,14 +38,18 @@ files:
 - Rakefile
 - lib/tasks/validb.rake
 - lib/validb.rb
+- lib/validb/batcher.rb
 - lib/validb/checker.rb
+- lib/validb/console_logger.rb
 - lib/validb/finder.rb
 - lib/validb/model_validator.rb
 - lib/validb/railtie.rb
 - lib/validb/record_validator.rb
 - lib/validb/version.rb
 - spec/spec_helper.rb
+- spec/validb/batcher_spec.rb
 - spec/validb/checker_spec.rb
+- spec/validb/console_logger_spec.rb
 - spec/validb/finder_spec.rb
 - spec/validb/model_validator_spec.rb
 - spec/validb/record_validator_spec.rb