care_bert 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0192361d8faffa37ecf535c9b2aca53fda05b221
-  data.tar.gz: 4e95efa522cb0fec19b593551b8d6b6bc6b56fef
+  metadata.gz: 44ac9bdf896ba7635c558b5dd428fdbb6da1a150
+  data.tar.gz: b35e9622dd7cdaff3149ec5a3dfa2b4223bfee19
 SHA512:
-  metadata.gz: 037a877e86dbcd706d52717ef3d64b95264c7caf4889d07458e4ea7b750eb5bd4565a835e76d46dcca558b292982a8d4d42bd3a8e3c82a4558ba109c5c2707fb
-  data.tar.gz: 177a474937fdb4dfa2f392d9c9ba7d298729b4f7ea8378d1842501147e6068e9e290eb64e9ec25f8cf25cf2c28dc9c5ec8e44d4881da8e23489c5264b454b31b
+  metadata.gz: a2fd39550a50b302d6a514ff235adea3521cccd38f60df16cd02885c227b8d493f5ba9bfad483f4c1b0f9f5ff2a1c2a5fbf7b8cdced26361ef0923796525f27b
+  data.tar.gz: cc138bb6e51dc7cb7b94c393dae6accc06f6e70cdbcd87568a7a5c2dc5f7ca31aebc37b9fc049c181d3f46d6db45ff4e3fd33c8b0075129b089b4c61ea559537

data/README.md

@@ -0,0 +1,90 @@
+# CareBert
+
+[![Gem Version](https://badge.fury.io/rb/care_bert.svg)](http://badge.fury.io/rb/care_bert)
+
+This project rocks and uses MIT-LICENSE.
+
+Any features missing? write your suggestions as issue or create a pull-request.
+
+## Usage
+
+### Overview of provided Rake Tasks
+
+```shell
+rake -T
+
+rake care_bert:missing_assocs      # Checks all belongs_to-associations of all instances and checks presence of model if foreign-key is set
+rake care_bert:table_integrity     # Tries to load all instances and tracks failures on load
+rake care_bert:validate_models     # Run model validations on all model records in database
+```
+
+
+### care\_bert:table\_integrity
+Tries to load all instances and tracks failures on load. This might occur, if there is invalid data on a serialized field (e.g. Hash) that can't be loaded by ActiveRecord.
+
+**It is strongly recommended to perform this rake task before any other one.**
+
+```shell
+rake care_bert:table_integrity
+
+-- records - broken instances - model --
+      5182 -                0 - Tweet
+       314 -                0 - Photo
+       278 -                0 - User
+```
+
+
+### care\_bert:missing\_assocs
+Checks all belongs_to-associations of all instances and checks presence of model if foreign-key is set.
+
+```shell
+rake care_bert:missing_assocs
+
+Daniel-DL-1307:paij-backend danielloy$ rake care_bert:missing_assocs
+-- records - broken instances - model --
+      5182 -                0 - Tweet
+       314 -                1 - Photo
+       278 -                0 - User
+
+Listing ids of missing model-instances of assocs:
+-------------------------------------------------------
+- Photo --------------
+>> affected_instances: [1]
+ -  1    >> {:user=>1231234}
+```
+
+### care\_bert:validate\_models
+Run model validations on all model records in database. Sums up all ids of failing models by the combined validation-errors.
+
+       
+       
+```shell
+rake care_bert:validate_models
+
+-- records - broken instances - model --
+      5182 -                0 - Tweet
+       314 -                0 - Photo
+       278 -                7 - User
+
+User: 
+["Name is missing"] >> [18, 42, 58, 95]
+["Name is missing", "E-Mail contains invalid characters"] >> [12, 128, 229]
+```
+
+
+
+## Agenda
+
+- [ ] Add Tests (with edge cases, securing rails3 and rails4 compat)
+- [ ] integrate Travis CI
+- [ ] fancy badges..
+- [ ] \(optional:) create tasks, that delete troubling model-instances
+- [ ] apply rubocop via git-hook
+- [ ] apply generic primary_key as lookup instead of static "id"
+
+
+## Credits
+
+This gem is also inspired from: http://blog.hasmanythrough.com/2006/8/27/validate-all-your-records
+https://github.com/joshsusser
+

data/Rakefile

@@ -14,9 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -28,5 +25,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/lib/care_bert/configuration.rb

@@ -1,9 +1,7 @@
-#require 'singleton'
+# require 'singleton'
 
 module CareBert
-
   module Configuration
     CHUNK_SIZE = 1000
   end
-
-end
+end

data/lib/care_bert/railtie.rb

@@ -8,11 +8,9 @@ module CareBert
     end
   end
 
-
-  #class Railtie
-    #def self.insert
-      #---
-    #end
-  #end
-
-end
+  # class Railtie
+  # def self.insert
+  #---
+  # end
+  # end
+end

data/lib/care_bert/reporter.rb

@@ -1,9 +1,7 @@
 module CareBert
-
   module Reporter
-
-    def self.validate_models report
-      puts "-- records -     smells - model --"
+    def self.validate_models(report)
+      puts '-- records -     smells - model --'
       report.each_key do |klass_name|
         printf "%10d - %10d - %s\n", report[klass_name][:total], report[klass_name][:smell_count], klass_name
       end
@@ -22,11 +20,10 @@ module CareBert
           puts
         end
       end
-
     end
 
-    def self.table_integrity report
-      puts "-- records - broken instances - model --"
+    def self.table_integrity(report)
+      puts '-- records - broken instances - model --'
       anything_broken = false
       report.each_key do |klass_name|
         printf "%10d - %16d - %s\n", report[klass_name][:total], report[klass_name][:broken_instances].count, klass_name
@@ -41,12 +38,10 @@ module CareBert
           printf " -  %s\n    >> %s\n\n", klass_name, report[klass_name][:broken_instances]
         end
       end
-
     end
 
-
-    def self.missing_assocs report
-      puts "-- records - broken instances - model --"
+    def self.missing_assocs(report)
+      puts '-- records - broken instances - model --'
       anything_broken = false
       report.each_key do |klass_name|
         printf "%10d - %16d - %s\n", report[klass_name][:total], report[klass_name][:smell_count], klass_name
@@ -60,7 +55,7 @@ module CareBert
         report.each_key do |klass_name|
           if report[klass_name][:errors].present?
             puts "- #{klass_name} --------------"
-            sorted_keys = report[klass_name][:errors].keys.collect{|b| b.to_i}.sort
+            sorted_keys = report[klass_name][:errors].keys.map(&:to_i).sort
             puts ">> affected_instances: #{sorted_keys}"
             sorted_keys.each do |record_id|
               printf " -  %s    >> %s\n", record_id, report[klass_name][:errors][record_id.to_s]
@@ -68,9 +63,6 @@ module CareBert
           end
         end
       end
-
     end
-
   end
-
 end

data/lib/care_bert/sniffer.rb

@@ -1,28 +1,25 @@
 module CareBert
-
   module Sniffer
-
     # returns hash with data
     def self.check_table_integrity
-      result = Hash.new
+      result = {}
 
       chunk_size = CareBert::Configuration::CHUNK_SIZE
 
       Dir.glob(Rails.root.join('/app/models/**/*.rb')).each { |file| require file }
-      ActiveRecord::Base.descendants.select { |c| c.base_class == c}.sort_by(&:name).each do |klass|
+      ActiveRecord::Base.descendants.select { |c| c.base_class == c }.sort_by(&:name).each do |klass|
         total = klass.count
 
         result[klass.name] = Hash.new
         result[klass.name][:total] = total
         result[klass.name][:broken_instances] = []
 
-
         (total / chunk_size + 1).times do |i|
           begin
-            chunk = klass.find(:all, :offset => (i * chunk_size), :limit => chunk_size)
+            chunk = klass.find(:all, offset: (i * chunk_size), limit: chunk_size)
             chunk.to_a
           rescue
-            #puts "Crashed while loading model #{klass.name}"
+            # puts "Crashed while loading model #{klass.name}"
             track_unloadable_instances(klass, offset..(offset + chunk_size - 1)).each do |id|
               result[klass.name][:broken_instances] << id
             end
@@ -33,67 +30,63 @@ module CareBert
       result
     end
 
-
-
     # inspired from from: http://blog.hasmanythrough.com/2006/8/27/validate-all-your-records
     def self.validate_models
-      result = Hash.new
+      result = {}
 
       chunk_size = CareBert::Configuration::CHUNK_SIZE
 
       Dir.glob(Rails.root.join('/app/models/**/*.rb')).each { |file| require file }
       ActiveRecord::Base.descendants.select { |c| c.base_class == c }.sort_by(&:name).each do |klass|
         result[klass.name] = {
-            total: klass.count,
-            smell_count: 0, # max klass.count
-            errors: Hash.new # max klass.count
+          total: klass.count,
+          smell_count: 0, # max klass.count
+          errors: Hash.new # max klass.count
         }
 
-
         (result[klass.name][:total] / chunk_size + 1).times do |i|
-          chunk = klass.find(:all, :offset => (i * chunk_size), :limit => chunk_size)
+          chunk = klass.find(:all, offset: (i * chunk_size), limit: chunk_size)
           chunk.reject(&:valid?).each do |record|
             result[klass.name][:smell_count] += 1
             errors_key = record.errors.full_messages || ['unknown validation error!?']
-            unless result[klass.name][:errors].has_key? errors_key
+            unless result[klass.name][:errors].key? errors_key
               result[klass.name][:errors][errors_key] = []
             end
             result[klass.name][:errors][errors_key] << record.id
           end rescue nil
-          result[klass.name][:errors].select {|err| !err.nil? }.each {|err| result[klass.name][:errors][err].sort! }
+
+          # TODO: check in which constellation the list to sort might ever be nil
+          result[klass.name][:errors].select { |err| !err.nil? }.each { |err| result[klass.name][:errors][err].sort! } rescue nil
         end
       end
 
       result
     end
 
-
-
     def self.check_missing_assocs
-      result = Hash.new
+      result = {}
 
       chunk_size = CareBert::Configuration::CHUNK_SIZE
 
       Dir.glob(Rails.root.join('/app/models/**/*.rb')).each { |file| require file }
       ActiveRecord::Base.descendants.select { |c| c.base_class == c }.sort_by(&:name).each do |klass|
         result[klass.name] = {
-            total: klass.count,
-            smell_count: 0, # max klass.count
-            errors: Hash.new # max klass.count
+          total: klass.count,
+          smell_count: 0, # max klass.count
+          errors: Hash.new # max klass.count
         }
 
-
         (result[klass.name][:total] / chunk_size + 1).times do |i|
-          chunk = klass.find(:all, :offset => (i * chunk_size), :limit => chunk_size)
+          chunk = klass.find(:all, offset: (i * chunk_size), limit: chunk_size)
           chunk.each do |record|
 
             failing_fields = {}
 
             [:belongs_to].each do |assoc_type| # optional => :has_one
-              fields = klass.reflect_on_all_associations(assoc_type).collect { |field| field.name }
+              fields = klass.reflect_on_all_associations(assoc_type).map(&:name)
 
               fields.each do |field|
-                #puts "Check #{klass.name} => #{field}"
+                # puts "Check #{klass.name} => #{field}"
 
                 id_field = "#{field}_id"
                 if record.respond_to?(id_field)
@@ -114,10 +107,7 @@ module CareBert
       result
     end
 
-
-
-
-    def self.track_unloadable_instances klass, id_range
+    def self.track_unloadable_instances(klass, id_range)
       result = []
       id_range.each do |id|
         begin
@@ -128,9 +118,5 @@ module CareBert
       end
       result
     end
-
-
   end
-
-
-end
+end

data/lib/care_bert/version.rb

@@ -1,3 +1,3 @@
 module CareBert
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/care_bert.rb

@@ -2,15 +2,10 @@ require 'care_bert/configuration'
 require 'care_bert/sniffer'
 require 'care_bert/reporter'
 
-
 module CareBert
-
-
   # load Railtie if Rails exists
   if defined?(Rails)
     require 'care_bert/railtie'
-    #CareBert::Railtie.insert
+    # CareBert::Railtie.insert
   end
-
-
 end

data/lib/tasks/care_bert_tasks.rake

@@ -1,33 +1,31 @@
 require 'care_bert'
 
-#desc "Explaining what the task does"
-#task :care_bert do
+# desc "Explaining what the task does"
+# task :care_bert do
 #   # Task goes here
 #  puts "success"
-#end
-
+# end
 
 # file: validate_models.rake
 # task: rake db:validate_models
 namespace :care_bert do
-  desc "Run model validations on all model records in database"
-  task :validate_models => :environment do
+  desc 'Run model validations on all model records in database'
+  task validate_models: :environment do
     # ANALYZE all
     report = CareBert::Sniffer.validate_models
     CareBert::Reporter.validate_models report
   end
 
-  desc "Tries to load all instances and tracks failures on load"
-  task :table_integrity => :environment do
+  desc 'Tries to load all instances and tracks failures on load'
+  task table_integrity: :environment do
     report = CareBert::Sniffer.check_table_integrity
     CareBert::Reporter.table_integrity report
   end
 
-  desc "Checks all belongs_to-associations of all instances and checks presence of model if foreign-key is set"
-  task :missing_assocs => :environment do
+  desc 'Checks all belongs_to-associations of all instances and checks presence of model if foreign-key is set'
+  task missing_assocs: :environment do
     report = CareBert::Sniffer.check_missing_assocs
     CareBert::Reporter.missing_assocs report
   end
 
-
-end
+end

data/test/care_bert_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class CareBertTest < ActiveSupport::TestCase
-  test "truth" do
+  test 'truth' do
     assert_kind_of Module, CareBert
   end
 end

data/test/dummy/config/application.rb

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "care_bert"
+require 'care_bert'
 
 module Dummy
   class Application < Rails::Application
@@ -20,4 +20,3 @@ module Dummy
     # config.i18n.default_locale = :de
   end
 end
-

data/test/dummy/config/initializers/cookies_serializer.rb

@@ -1,3 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.action_dispatch.cookies_serializer = :json
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/test/test_helper.rb

@@ -1,8 +1,8 @@
 # Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require 'rails/test_help'
 
 Rails.backtrace_cleaner.remove_silencers!
 
@@ -11,5 +11,5 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.method_defined?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActiveSupport::TestCase.fixture_path = File.expand_path('../fixtures', __FILE__)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: care_bert
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniel Loy
@@ -12,12 +12,26 @@ date: 2014-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: more Description of CareBert.
+description: CareBert analyzes the current items of your database and performs differing
+  validation and integrity tests.
 email:
 - loybert@gmail.com
 executables: []
@@ -46,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/care_bert.rb
 - lib/care_bert/configuration.rb
@@ -91,7 +107,7 @@ files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/test_helper.rb
-homepage: https://github.com/loybert
+homepage: https://github.com/loybert/care_bert
 licenses:
 - MIT
 metadata: {}