validb 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b848b12eed8009be429914ef6310dc3dbddae8d
-  data.tar.gz: 78ed0cdb95648b0611e0e50fe8043772d3868b67
+  metadata.gz: 37dd5d6147cb53a3dfb53c855f2a55d0cf647537
+  data.tar.gz: 5be261954815e7d0c9fe79bbbf5e127c239c8a3a
 SHA512:
-  metadata.gz: 4c5117c74c947b2447eedb3f2b67dcbab81c7eedfc31d6376ee312bb71a34d0dcc25e9579df4f3e274139f6aeaa29113e9c1087dd9df137f17390a6ff2f9840e
-  data.tar.gz: 5ae04ab9bb93db6f1757f4962bbda4fcc04682b7e5bfc0d43346fb16e386d43c6965ae19c3ea323f55d44d7f22b1703a3e6af4cf9a2b8d7d6d9813bb15eed889
+  metadata.gz: fcd4b986c94eefb884ba2f8fc464370547cf593ea286ab8de0e55427c7ca282d82eed62203e6574932776a624f6069b2f563358f95858d48b949beb434bdcd9a
+  data.tar.gz: a442ed7e407b7f86196387f745951010cad183461b05292c8b4445651b3c7e731ec29e58c9937584aff828e7c3db3e1177a2fe7b2d52d239b62ae629af369ebe

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## 1.1.3, released 2013-04-21
+## 1.2.0, released 2013-04-04
+* FileSystem logger is now default
+* Print an 'x' for each record validation failure when using FileSystem logger
+* Output number of seconds for task completion
+
+## 1.1.3, released 2013-04-01
 * Remove extra period in output to remove batch confusion
 * Set default batch size to 1000
 

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/validb.png)](https://rubygems.org/gems/validb)
 [![Dependency Status](https://gemnasium.com/jgeiger/validb.png)](https://gemnasium.com/jgeiger/validb)
 [![Build Status](https://travis-ci.org/jgeiger/validb.png)](https://travis-ci.org/jgeiger/validb)
+[![Code Climate](https://codeclimate.com/github/jgeiger/validb.png)](https://codeclimate.com/github/jgeiger/validb)
 
 ## Description
 
@@ -24,7 +25,7 @@ Check your database for invalid models.
     rake validb:validate models="Model,Model"
 
 ### Specific logger
-    rake validb:validate logger="Validb::ConsoleLogger"
+    rake validb:validate logger="Validb::Logger::Console"
 
 ### Generate config file in config/validb.json
     rake validb:generate_config

data/lib/tasks/validb.rake

@@ -2,7 +2,7 @@ namespace :validb do
   desc "Check DB for invalid records"
   task :validate => :environment do
     models = ENV["models"] || ""
-    logger_class = ENV["logger"] || "Validb::ConsoleLogger"
+    logger_class = ENV["logger"] || "Validb::Logger::FileSystem"
     filename = ENV["config"] || default_configuration_file
 
     # force all models to load so we can find them
@@ -13,8 +13,12 @@ namespace :validb do
     finder = Validb::Finder.new(params, models)
 
     logger = logger_class.constantize.new
+    logger.prepare
+
+    started_at = Time.now
     checker = Validb::Checker.new(params, logger)
     checker.check(finder.models)
+    puts "\nFinished in #{Time.now-started_at} seconds"
   end
 
   desc "Generate config/validb.json"

data/lib/validb.rb

@@ -6,7 +6,6 @@ require 'validb/version'
 module Validb
   require 'validb/railtie' if defined?(Rails)
   autoload :Configuration, 'validb/configuration'
-  autoload :ConsoleLogger, 'validb/console_logger'
   autoload :Checker, 'validb/checker'
   autoload :Finder, 'validb/finder'
   autoload :ModelFilterer, 'validb/model_filterer'
@@ -14,4 +13,9 @@ module Validb
   autoload :Batcher, 'validb/batcher'
   autoload :RecordValidator, 'validb/record_validator'
   autoload :Parameters, 'validb/parameters'
+  module Logger
+    autoload :Base, 'validb/logger/base'
+    autoload :FileSystem, 'validb/logger/file_system'
+    autoload :Console, 'validb/logger/console'
+  end
 end

data/lib/validb/logger/base.rb

@@ -0,0 +1,11 @@
+module Validb
+  module Logger
+    class Base
+      def prepare
+      end
+
+      def out(record_hash)
+      end
+    end
+  end
+end

data/lib/validb/logger/console.rb

@@ -0,0 +1,9 @@
+module Validb
+  module Logger
+    class Console < Base
+      def out(record_hash)
+        $stdout.puts "\n#{record_hash[:model]}:#{record_hash[:id]} - #{record_hash[:error_messages]}"
+      end
+    end
+  end
+end

data/lib/validb/logger/file_system.rb

@@ -0,0 +1,23 @@
+module Validb
+  module Logger
+    class FileSystem < Base
+      def prepare
+        File.delete(filename) if File.exists?(filename)
+        $stdout.puts("Writing output to #{filename}")
+      end
+
+      def out(record_hash)
+        File.open(filename, "ab+") do |file|
+          file.puts("#{record_hash[:model]}:#{record_hash[:id]} - #{record_hash[:error_messages]}")
+        end
+        $stdout.print("x")
+      end
+
+      private
+
+      def filename
+        @filename ||= defined?(Rails) ? Rails.root.join('log', 'validb.log') : "validb.log"
+      end
+    end
+  end
+end

data/lib/validb/version.rb

@@ -1,3 +1,3 @@
 module Validb
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/spec/validb/{console_logger_spec.rb → logger/console_spec.rb}

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

data/spec/validb/logger/file_system_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Validb::Logger::FileSystem do
+  describe "#prepare" do
+    context "when the file exists" do
+      it "deletes the file" do
+        File.should_receive(:exists?).with("validb.log").and_return(true)
+        File.should_receive(:delete).with("validb.log")
+
+        $stdout.should_receive(:puts).with("Writing output to validb.log")
+
+        file_logger = Validb::Logger::FileSystem.new
+        file_logger.prepare
+      end
+    end
+
+    context "when the file does not exist" do
+      it "does nothing" do
+        File.should_receive(:exists?).with("validb.log").and_return(false)
+        File.should_not_receive(:delete)
+
+        $stdout.should_receive(:puts).with("Writing output to validb.log")
+
+        file_logger = Validb::Logger::FileSystem.new
+        file_logger.prepare
+      end
+    end
+  end
+
+  describe "#out" do
+    it "writes the hash output to a file and prints an X" do
+      file = double('file')
+      File.should_receive(:open).with("validb.log", "ab+").and_yield(file)
+      file.should_receive(:puts).with("Blog:1 - Error message")
+
+      $stdout.should_receive(:print).with("x")
+
+      hash = { model: Blog, id: 1, error_messages: "Error message" }
+      file_logger = Validb::Logger::FileSystem.new
+      file_logger.out(hash)
+    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 == "1.1.3"
+    Validb::VERSION.should == "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validb
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Joey Geiger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -41,8 +41,10 @@ files:
 - lib/validb/batcher.rb
 - lib/validb/checker.rb
 - lib/validb/configuration.rb
-- lib/validb/console_logger.rb
 - lib/validb/finder.rb
+- lib/validb/logger/base.rb
+- lib/validb/logger/console.rb
+- lib/validb/logger/file_system.rb
 - lib/validb/model_filterer.rb
 - lib/validb/model_validator.rb
 - lib/validb/parameters.rb
@@ -54,8 +56,9 @@ files:
 - spec/validb/batcher_spec.rb
 - spec/validb/checker_spec.rb
 - spec/validb/configuration_spec.rb
-- spec/validb/console_logger_spec.rb
 - spec/validb/finder_spec.rb
+- spec/validb/logger/console_spec.rb
+- spec/validb/logger/file_system_spec.rb
 - spec/validb/model_filterer_spec.rb
 - spec/validb/model_validator_spec.rb
 - spec/validb/record_validator_spec.rb

data/lib/validb/console_logger.rb

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