data_sanity 0.2.2 → 0.2.3

data/README.md

@@ -6,8 +6,13 @@
         # Random data in all models :
             * specify n number of random records,
             * specify criteria
+    It allows you to see details in two strategies - table/csv
+        # output to a model named DataInspector
+            * For this you need to run migrations
+            * You get an advantage of using variable from command line
+        # output to a csv file in tmp folder as data_inspector.csv
 
-# It would output result in a table with following details
+# It would output result in a table/csv with following details
 
     +----+------------+-------------+-------------------+-----------------------+
     | id | table_name | primary_key	| primary_key_value | errors                |
@@ -16,15 +21,17 @@
     +----+------------+-------------+-------------------+-----------------------+
 
 # HOW TO USE
-    * adding migrations : rake data_sanity:db:migrate
-    * removing migrations : rake data_sanity:db:rollback
-    * Use normal rake db:migrate to migrate the migration added by rake data_sanity:db:migrate
+    
+    * adding migrations : rake data_sanity:db:migrate [for strategy table]
+    * removing migrations : rake data_sanity:db:rollback [for strategy table]
     * You can add a sample criteria file using rake data_sanity:criteria
     * To Investigate your data use rake data_sanity:investigate
-        - By default it runs for all data
+        - By default it runs for all data with strategy table
             : If criteria file is specifies then picks model from file and validates only those
             : Note: For any criteria mentioned except model names is ignored
-        - rake data_sanity:investigate[random,2]
+        - rake data_sanity:investigate[table,random,2]
             : parameter 1: random: show you want random selection
             : parameter 2: lets you add as many random records you want to verify [default is 1]
             : Note: if you have a criteria file it works only for models in criteria file
+        - rake data_sanity:investigate[csv,random,2]
+   

data/data_sanity.gemspec

@@ -15,4 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version = DataSanity::VERSION
   gem.license = 'MIT'
+
+  gem.add_dependency 'fastercsv', '1.5.5'
 end

data/lib/data_sanity.rb

@@ -3,5 +3,6 @@ require "rails"
 SOURCE_PATH = File.dirname(__FILE__)
 
 require SOURCE_PATH + "/data_sanity/inspector"
+require SOURCE_PATH + "/data_sanity/output"
 require SOURCE_PATH + "/data_sanity/railtie"
 require SOURCE_PATH + "/data_sanity/version"

data/lib/data_sanity/inspector.rb

@@ -3,9 +3,10 @@ module DataSanity
 
     CONSIDERED_RECORDS = 1
     ALLOWED_VALIDATION = [:all, :random, :criteria]
-    attr_accessor :all, :random, :criteria, :models, :records_per_model
+    attr_accessor :all, :random, :criteria, :models, :records_per_model, :output
 
     def initialize options = {}
+      @output = DataSanity::Output.new :option => ( options[:strategy] || :table ).to_sym
       options[:validate] == "random" ? @random = true : @all = true
       @records_per_model = options[:records_per_model].to_i == 0 ? CONSIDERED_RECORDS : options[:records_per_model].to_i
       @models = load_models
@@ -35,6 +36,7 @@ module DataSanity
           log_end(model_string)
         end
       end
+      @output.close
     end
 
     private
@@ -71,15 +73,9 @@ module DataSanity
     end
 
     def populate_if_invalid_record(instance, model)
-      DataInspector.create(:table_name => model.to_s,
-                           :table_primary_key => model.primary_key,
-                           :primary_key_value => instance.send(model.primary_key),
-                           :validation_errors => instance.errors.full_messages.to_yaml) unless instance.valid?
+      @output.create_from model, instance unless instance.valid?
     rescue Exception => exp
-      DataInspector.create(:table_name => model.to_s,
-                           :table_primary_key => model.primary_key,
-                           :primary_key_value => instance.send(model.primary_key),
-                           :validation_errors => exp.to_yaml)
+      @output.create_from model, instance, exp
     end
 
     def load_models

data/lib/data_sanity/output.rb

@@ -0,0 +1,37 @@
+require 'fastercsv'
+
+module DataSanity
+  class Output
+    OPTIONS = [:table, :csv]
+
+    attr_accessor :option, :csv_file
+    def initialize options = {}
+      raise Exception.new("This options to output the result of inspector is not valid") unless OPTIONS.include?(options[:option])
+      self.option = options[:option]
+      if self.option == :csv
+        self.csv_file = FasterCSV.open("#{Rails.root}/tmp/data_inspector.csv", 'w') 
+        self.csv_file.add_row ['table_name', 'table_primary_key', 'primary_key_value', 'validation_errors']
+      end
+    end
+
+    def create_from model, instance, exception = nil
+      send("store_to_#{self.option}", model, instance, exception)
+    end
+
+    def close
+      self.csv_file.close_write if self.csv_file
+    end
+
+    private
+    def store_to_table model, instance, exception
+      DataInspector.create(:table_name => model.to_s,
+                           :table_primary_key => model.primary_key,
+                           :primary_key_value => instance.send(model.primary_key),
+                           :validation_errors => (exception || instance.errors.full_messages.to_yaml))
+    end
+
+    def store_to_csv model, instance, exception
+      self.csv_file.add_row [model.to_s, model.primary_key, instance.send(model.primary_key), ( exception || instance.errors.full_messages.to_sentence) ]
+    end
+  end
+end

data/lib/data_sanity/tasks.rb

@@ -26,8 +26,8 @@ namespace :data_sanity do
     end
   end
 
-  desc 'Data Sanity run investigation'
-  task :investigate, [:validate, :records_per_model] => :environment do |t, args|
+  desc 'Data Sanity run investigation - params[strategy,validate,records_per_model]'
+  task :investigate, [:strategy, :validate, :records_per_model] => :environment do |t, args|
     DataSanity::Inspector.new(args).investigate
   end
 end

data/lib/data_sanity/version.rb

@@ -1,3 +1,3 @@
 module DataSanity
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/data_sanity/inspector_spec.rb

@@ -50,6 +50,20 @@ describe "DataSanity::Inspector" do
         YAML.load(DataInspector.first.validation_errors).should == first_person.errors.full_messages
       end
 
+      it "should check for errors on the model and populate fields in DataInspector" do
+        inspector = DataSanity::Inspector.new :strategy => :csv
+
+        Person.new(:age => 1).save(:validate => false)
+
+        inspector.investigate
+
+        first_person = Person.find_by_age(1)
+        first_person.valid?
+        path = "#{Rails.root}/tmp/data_inspector.csv"
+        FasterCSV.read(path).should == [["table_name", "table_primary_key", "primary_key_value", "validation_errors"], 
+          ["Person", "id", "#{first_person.id}", "#{first_person.errors.full_messages.to_sentence}"]]
+      end
+
       it "should check for errors on the model and populate fields in DataInspector even if valid? raises exception" do
         inspector = DataSanity::Inspector.new
 

data/spec/data_sanity/output_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe "DataSanity::Output" do
+
+  describe "initialize" do
+    it "should initialize the method of output of inspection" do
+      output = DataSanity::Output.new :option => :table
+      output.option.should == :table
+    end
+
+    it "should throw an exception if method not among specified options" do
+      lambda { DataSanity::Output.new :option => :invalid }.should raise_error("This options to output the result of inspector is not valid")
+    end
+  end
+
+  describe "store" do
+    it "should store to data_inspector model when option is database" do
+      output = DataSanity::Output.new :option => :table
+      errors = ["error1", "error2"]
+      instance = mock(:id => 2, :errors => mock(:full_messages => errors))
+      model = mock(:to_s => "model", :primary_key => "id")
+      output.create_from(model, instance)
+
+      DataInspector.count.should == 1
+      di = DataInspector.first
+      di.table_name.should == "model"
+      di.table_primary_key.should == "id"
+      di.primary_key_value.should == "2"
+      di.validation_errors.should == errors.to_yaml
+    end
+
+    it "should store to csv file in tmp folder of app" do
+      output = DataSanity::Output.new :option => :csv
+      errors = ["error1", "error2"]
+      instance = mock(:id => 2, :errors => mock(:full_messages => errors))
+      model = mock(:to_s => "model", :primary_key => "id")
+      output.create_from(model, instance)
+      output.close
+
+      path = "#{Rails.root}/tmp/data_inspector.csv"
+      FasterCSV.read(path).should == [["table_name", "table_primary_key", "primary_key_value", "validation_errors"], 
+        ["model", "id", "2", "error1 and error2"]]
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Habibullah, Rahul, Jigyasa, Jyotsna, Hephzibah, Garima
@@ -14,10 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-06 00:00:00 +05:30
+date: 2012-06-15 00:00:00 +05:30
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 5
+        version: 1.5.5
+  type: :runtime
+  version_requirements: *id001
 description: Gem for checking data sanity
 email: 
 - igarimasingh@gmail.com
@@ -37,11 +50,13 @@ files:
 - data_sanity.gemspec
 - lib/data_sanity.rb
 - lib/data_sanity/inspector.rb
+- lib/data_sanity/output.rb
 - lib/data_sanity/railtie.rb
 - lib/data_sanity/tasks.rb
 - lib/data_sanity/templates/data_sanity_criteria.yml
 - lib/data_sanity/version.rb
 - spec/data_sanity/inspector_spec.rb
+- spec/data_sanity/output_spec.rb
 - spec/spec_helper.rb
 - spec/support/helper.rb
 - spec/support/sample_app/.gitignore
@@ -90,6 +105,7 @@ files:
 - spec/support/sample_app/script/rails
 - spec/support/sample_app/test/performance/browsing_test.rb
 - spec/support/sample_app/test/test_helper.rb
+- spec/support/sample_app/tmp/tmp.txt
 - spec/support/sample_app/vendor/plugins/.gitkeep
 has_rdoc: true
 homepage: https://github.com/singhgarima/data_sanity
@@ -123,6 +139,7 @@ specification_version: 3
 summary: Gem for checking data sanity
 test_files: 
 - spec/data_sanity/inspector_spec.rb
+- spec/data_sanity/output_spec.rb
 - spec/spec_helper.rb
 - spec/support/helper.rb
 - spec/support/sample_app/.gitignore
@@ -171,4 +188,5 @@ test_files:
 - spec/support/sample_app/script/rails
 - spec/support/sample_app/test/performance/browsing_test.rb
 - spec/support/sample_app/test/test_helper.rb
+- spec/support/sample_app/tmp/tmp.txt
 - spec/support/sample_app/vendor/plugins/.gitkeep