valid_data 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 730971eefd74cc4c9ff9f2f6fdaae52a3a6ec82f
+  data.tar.gz: 1d64d7563a6f5eaf4b2f8cacb98eba919e95cd4a
+SHA512:
+  metadata.gz: c6ef722b0c0cbc715a0049a6b751a1b9a37d89b8f1d480888759f1353eb3a8e2cc2fcc6f4cf46199dd09807ba0b21a23701581428874b57fa8a9be444a56d818
+  data.tar.gz: 83a0b41b0122f67678129dd78b7903c65c327b886c672008aa818339dcdd9ac3e3cf30977091a77f5480437a524f2041629cfbc26ab8d47d10cb8df2d94c30e7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--profile

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.1.1"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in valid_data.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stack Builders Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+[![Build Status](https://travis-ci.org/stackbuilders/valid_data.png?branch=master)](https://travis-ci.org/stackbuilders/valid_data)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'valid_data'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install valid_data
+
+## Usage
+
+Invoke the `Rake Task` that is now at your fingertips:
+
+```bash
+rake validate_records[30]
+```
+... where the `30` refers to the amount of extra padding in the printed output.
+
+You should expect to see some output like this:
+
+```bash
+Model                          | Invalid                        | Total
+------------------------------------------------------------------------------------------
+MakeNegativeTemplate           | 0                              | 0
+KeywordSet                     | 0                              | 1
+Placeholder                    | 0                              | 5
+User                           | 0                              | 0
+Ad                             | 1                              | 1
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mecampbellsoup/valid_data/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+# Default task is running the test suite
+task :default => :spec

data/lib/tasks/valid_data.rake

@@ -0,0 +1,11 @@
+desc "Check for invalid records in the database"
+task :validate_records, [:padding] => [:environment] do |t, args|
+  # Load all models
+  Rails.application.eager_load!
+
+  # Set padding if not passed in ARGV
+  padding = args[:padding] || 30
+
+  # Instantiate the Runner and call #data on it
+  ValidData::Runner.new(padding, ActiveRecord::Base).run
+end

data/lib/valid_data.rb

@@ -0,0 +1,11 @@
+require "valid_data/version"
+require "valid_data/runner"
+require "valid_data/printer"
+require "valid_data/collector"
+
+module ValidData
+  require 'valid_data/railtie' if defined?(Rails)
+
+  # Result serves as a data structure between Runner and Printer
+  Result = Struct.new(:name, :invalid_count, :total)
+end

data/lib/valid_data/collector.rb

@@ -0,0 +1,32 @@
+module ValidData
+  class Collector
+    def initialize(models)
+      @models = models
+    end
+
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      models.each { |model|
+        yield compute_result(model)
+      }
+    end
+
+    def compute_result(model)
+      invalid_count, total = 0, 0
+
+      model.find_each do |m|
+        invalid_count += 1 if m.invalid?
+        total += 1
+      end
+
+      Result.new(model.name, invalid_count, total)
+      #NOTE: The following line doesn't work for Rails < 4.0!
+      #Result.new(model.name, model.find_each.select(&:valid?), model.count)
+    end
+
+    private
+
+    attr_reader :models
+  end
+end

data/lib/valid_data/printer.rb

@@ -0,0 +1,22 @@
+module ValidData
+  class Printer
+    #TODO: Auto-scale padding as a function of the longest name being printed.
+    def initialize(padding)
+      @padding = padding
+      puts header
+    end
+
+    def print(result)
+      "%s | %s | %s" % [result.name, result.invalid_count, result.total].map{ |cell| cell.to_s.ljust(padding) }
+    end
+
+    def header
+      "%s | %s | %s" % ["Model", "Invalid", "Total"].map{ |title| title.ljust(padding) } +
+      "\n" + "-" * 3 * padding
+    end
+
+    private
+
+    attr_reader :result, :padding
+  end
+end

data/lib/valid_data/railtie.rb

@@ -0,0 +1,12 @@
+require 'valid_data'
+require 'rails'
+
+module ValidData
+  class Railtie < Rails::Railtie
+    railtie_name :valid_data
+
+    rake_tasks do
+      load "tasks/valid_data.rake"
+    end
+  end
+end

data/lib/valid_data/runner.rb

@@ -0,0 +1,29 @@
+module ValidData
+  class Runner
+    def initialize(padding, adapter)
+      @padding = padding.to_i
+      @adapter = adapter
+      @printer = Printer.new(padding.to_i)
+    end
+
+    def run
+      collector.each { |result|
+        puts printer.print(result)
+      }
+    end
+
+    private
+
+    attr_reader :padding, :adapter, :printer
+
+    def collector
+      @collector ||= Collector.new(models)
+    end
+
+    def models
+      adapter.descendants.reject do |klass|
+        klass.name.include?("::Translation") || klass.abstract_class?
+      end
+    end
+  end
+end

data/lib/valid_data/version.rb

@@ -0,0 +1,3 @@
+module ValidData
+  VERSION = "0.0.1"
+end

data/spec/lib/valid_data/collector_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module ValidData
+  describe Collector do
+    let(:user_model) { double(name: 'User', count: 1) }
+    let(:users)      { [double(invalid?: true), double(invalid?: true), double(invalid?: false)] }
+    let(:collector)  { Collector.new([user_model]) }
+    let(:result)     { Result.new("User", 2, 3) }
+
+    before do
+      user_model.stub(:find_each).and_yield(users[0]).and_yield(users[1]).and_yield(users[2])
+    end
+
+    describe "#compute_result" do
+      it "returns a result object with the required information from the model" do
+        expect(collector.compute_result(user_model)).to eq result
+      end
+    end
+
+    describe "#each" do
+      it "iterates over computed result for each model" do
+        collector.each.to_a.should == [result]
+      end
+    end
+  end
+end

data/spec/lib/valid_data/printer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module ValidData
+  describe Printer do
+    let(:printer) { Printer.new(5) }
+
+    describe "#print" do
+      it "writes each row of the table with the appropriate padding" do
+        result = Result.new("User", 5, 20)
+        expect(printer.print(result)).to eq "User  | 5     | 20   "
+      end
+    end
+
+    describe "#header" do
+      it "writes the header with the appropriate padding" do
+        expect(printer.header).to eq "Model | Invalid | Total\n---------------"
+      end
+    end
+  end
+end

data/spec/lib/valid_data/runner_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module ValidData
+  describe Runner do
+    describe "#run" do
+      let(:user_model)   { double(name: 'User', count: 1, find_each: users, abstract_class?: false) }
+      let(:dealer_model) { double(name: 'Dealer', count: 1, find_each: dealers, abstract_class?: false) }
+      let(:users)        { [double(valid?: true)] }
+      let(:dealers)      { [double(valid?: true)] }
+      let(:adapter)      { double(descendants: [user_model, dealer_model]) }
+      let(:runner)       { Runner.new(30, adapter) }
+
+      it "prints the report" do
+        pending
+        runner.run
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'valid_data'
+require 'pry'
+require 'rails'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/valid_data.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'valid_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "valid_data"
+  spec.version       = ValidData::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Matt Campbell", "Wojciech Mach"]
+  spec.email         = ["support@stackbuilders.com"]
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/stackbuilders/valid_data"
+  spec.summary       = "Quickly check whether the rows in your database are valid according to your ActiveRecord validations."
+  spec.description   = <<-DESC
+As your Rails projects evolve and grow, your model validations tend to change
+as well. An unfortunate side effect of this evolution is that your table-
+backed ActiveRecord::Base descendants end up with rows that instantiate invalid
+model instances. ValidData generates a report for your Rails application,
+notifying you exactly how many rows in your models are invalid for each model.
+  DESC
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 2"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "rails", ">= 3.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: valid_data
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Campbell
+- Wojciech Mach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  As your Rails projects evolve and grow, your model validations tend to change
+  as well. An unfortunate side effect of this evolution is that your table-
+  backed ActiveRecord::Base descendants end up with rows that instantiate invalid
+  model instances. ValidData generates a report for your Rails application,
+  notifying you exactly how many rows in your models are invalid for each model.
+email:
+- support@stackbuilders.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tasks/valid_data.rake
+- lib/valid_data.rb
+- lib/valid_data/collector.rb
+- lib/valid_data/printer.rb
+- lib/valid_data/railtie.rb
+- lib/valid_data/runner.rb
+- lib/valid_data/version.rb
+- spec/lib/valid_data/collector_spec.rb
+- spec/lib/valid_data/printer_spec.rb
+- spec/lib/valid_data/runner_spec.rb
+- spec/spec_helper.rb
+- valid_data.gemspec
+homepage: https://github.com/stackbuilders/valid_data
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Quickly check whether the rows in your database are valid according to your
+  ActiveRecord validations.
+test_files:
+- spec/lib/valid_data/collector_spec.rb
+- spec/lib/valid_data/printer_spec.rb
+- spec/lib/valid_data/runner_spec.rb
+- spec/spec_helper.rb