validb 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28235bb827e10873757a172aa4341de2125825b5
-  data.tar.gz: 534c056bd73c20c1a720283757e569d64bfa9cec
+  metadata.gz: aecd94c7cb36508bb2fe17f98a8c8ff7e35fbd36
+  data.tar.gz: 399a316d78060de84cd0534b5c3d4286aa0d512c
 SHA512:
-  metadata.gz: 7b58b722f5f0f96b7aea4b0f9c89e228682145c4a3876dbaf9a3bd71fb7a56d5fcc60f2b1ac624c6c6c58fcbdc6c777762644dd64812b32338db1fb5ea09f9ca
-  data.tar.gz: 61ded8105b8e95ff8c116adf0ebb88e9ec51bc24e960d21595437b9b8b310c4d1681f6e8731ec19ec1392875dea5b5534478656fd8d5e2e07530bd8062c4a1e7
+  metadata.gz: 7df0136e326c3dc0fa8da5d58e5d59ba0b44c4224db734b6421d8b956affb96a2a8090ad1f5b2f39b9e1ae2b6eb0b49cc9a8b73592f177d4c84d417a2ba4e456
+  data.tar.gz: 9966e8375e09f154eeb6326eb3c72a84bb08c9a2448d2952af7fc01cc606931980f291601cd6199ecdc05fd94f3e3089af92a5124ea6f9b40b4cf254973bea69

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.0, released 2013-03-27
+* Add rake task to generate config file
+* Allow filtering of unwanted models
+* Allow filtering of unwanted prefixes
+* Don't check models without validation
+* Don't check child models of STI
+
 ## 0.1.0, released 2013-03-26
 * Rake task now takes parameters differently
 * Classes now use instances, not class methods

data/README.md

@@ -1,5 +1,9 @@
 # Validb
 
+[![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)
+
 ## Description
 
 Check your database for invalid models.
@@ -22,5 +26,20 @@ Check your database for invalid models.
 ### Specific logger
     rake validb:validate logger="Validb::ConsoleLogger"
 
+### Generate config file in config/validb.json
+    rake validb:generate_config
+
+#### Example validb.json file
+
+    {
+      "ignored_models": [
+        "Blog",
+        "Post"
+      ],
+      "ignored_prefixes": [
+        "Api"
+      ]
+    }
+
 ## License
 Released under the MIT License

data/lib/tasks/validb.rake

@@ -3,13 +3,40 @@ namespace :validb do
   task :validate => :environment do
     models = ENV["models"] || ""
     logger = ENV["logger"] || "Validb::ConsoleLogger"
+    filename = ENV["config"] || default_configuration_file
 
     # force all models to load so we can find them
     Rails.application.eager_load!
-    finder = Validb::Finder.new(models)
+
+    configuration = Validb::Configuration.new(filename)
+    finder = Validb::Finder.new(configuration, models)
 
     console_logger = logger.constantize.new
     checker = Validb::Checker.new(console_logger)
     checker.check(finder.models)
   end
+
+  desc "Generate config/validb.json"
+  task :generate_config => :environment do
+    if File.exists?(default_configuration_file)
+      puts "Configuration already exists at config/validb.json"
+    else
+      puts "Writing configuration to config/validb.json"
+      write_configuration_file
+    end
+  end
+
+  def default_configuration_file
+    @default_configuration_file ||= Rails.root.join('config', 'validb.json')
+  end
+
+  def default_configuration
+    { "ignored_models" => [], "ignored_prefixes" => [] }
+  end
+
+  def write_configuration_file
+    File.open(default_configuration_file,'w') do |file|
+      file.puts JSON.pretty_generate(default_configuration)
+    end
+  end
 end

data/lib/validb.rb

@@ -5,9 +5,11 @@ 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'
   autoload :ModelValidator, 'validb/model_validator'
   autoload :Batcher, 'validb/batcher'
   autoload :RecordValidator, 'validb/record_validator'

data/lib/validb/configuration.rb

@@ -0,0 +1,50 @@
+module Validb
+  class Configuration
+
+    def initialize(filename)
+      @filename = filename
+      print_ignored
+    end
+
+    def ignored_models
+      convert_model_name_strings_to_constants
+    end
+
+    def ignored_prefixes
+      config["ignored_prefixes"]
+    end
+
+    private
+
+    def print_ignored
+      puts "Ignoring prefixes: #{ignored_prefixes.join(',')}" if ignored_prefixes.any?
+      puts "Ignoring models: #{config['ignored_models'].join(',')}" if ignored_models.any?
+    end
+
+    def config
+      @config ||= begin
+                    if configuration_exists?
+                      JSON.parse(IO.read(@filename))
+                    else
+                      {
+                        "ignored_models" => [],
+                        "ignored_prefixes" => []
+                      }
+                    end
+                  end
+    end
+
+    def configuration_exists?
+      File.exists?(@filename)
+    end
+
+    def convert_model_name_strings_to_constants
+      config["ignored_models"].map do |model_string|
+        begin
+          model_string.constantize
+        rescue NameError
+        end
+      end.compact
+    end
+  end
+end

data/lib/validb/finder.rb

@@ -1,16 +1,21 @@
 module Validb
   class Finder
 
-    def initialize(model_name_string)
+    def initialize(configuration, model_name_string)
+      @model_filterer = Validb::ModelFilterer.new(configuration)
       @model_name_string = model_name_string || ""
     end
 
     def models
-      model_names.empty? ? all : all.select { |model| model_names.include?(model.name) }
+      @model_filterer.filter(selected_models)
     end
 
     private
 
+    def selected_models
+      model_names.empty? ? all : all.select { |model| model_names.include?(model.name) }
+    end
+
     def model_names
       @model_names ||= @model_name_string.split(",").map(&:strip)
     end

data/lib/validb/model_filterer.rb

@@ -0,0 +1,43 @@
+module Validb
+  class ModelFilterer
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def filter(models)
+      filtered_models = validatable_models(models)
+      filtered_models = non_inherited_models(filtered_models)
+      filtered_models = non_ignored_models(filtered_models)
+      non_ignored_prefix_models(filtered_models)
+    end
+
+    private
+
+    def ignored_models
+      @configuration.ignored_models
+    end
+
+    def ignored_prefixes
+      @configuration.ignored_prefixes
+    end
+
+    def non_ignored_prefix_models(models)
+      models.reject do |model|
+        ignored_prefixes.include?(model.name.split("::").first)
+      end
+    end
+
+    def non_ignored_models(models)
+      models - ignored_models
+    end
+
+    def non_inherited_models(models)
+      models.reject { |model| model != model.base_class && models.include?(model.base_class)}
+    end
+
+    def validatable_models(models)
+      models.select { |model| model.validators.any? }
+    end
+  end
+end

data/lib/validb/version.rb

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

data/spec/config/validb.json

@@ -0,0 +1,10 @@
+{
+  "ignored_models": [
+    "Blog",
+    "Post",
+    "Fake"
+  ],
+  "ignored_prefixes": [
+    "Api"
+  ]
+}

data/spec/spec_helper.rb

@@ -19,17 +19,26 @@ ActiveRecord::Schema.define do
 
   create_table :blogs, :force => true do |t|
     t.string :title
-    t.timestamps
   end
 
   create_table :posts, :force => true do |t|
     t.string :title
-    t.timestamps
   end
 
   create_table :comments, :force => true do |t|
     t.string :body
-    t.timestamps
+  end
+
+  create_table :users, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :people, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :approvals, :force => true do |t|
+    t.boolean :name
   end
 end
 
@@ -38,7 +47,16 @@ class Blog < ActiveRecord::Base
 end
 
 class Post < ActiveRecord::Base
+  validates :title, presence: true
 end
 
 class Comment < ActiveRecord::Base
+  validates :body, presence: true
+end
+
+class Person < ActiveRecord::Base
+  validates :name, presence: true
+end
+
+class User < ActiveRecord::Base
 end

data/spec/validb/configuration_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Validb::Configuration do
+  describe "#initialize" do
+    it "creates a configuration" do
+      Validb::Configuration.any_instance.should_receive(:print_ignored)
+      Validb::Configuration.new("")
+    end
+  end
+
+  describe "#ignored_models" do
+    context "with a missing configuration file" do
+      it "returns an empty array" do
+        filename = File.expand_path(File.dirname(__FILE__) + '/../config/missing.json')
+        configuration = Validb::Configuration.new(filename)
+        configuration.ignored_models.should == []
+      end
+    end
+
+    context "with a configuration file" do
+      it "returns the ignored models" do
+        filename = File.expand_path(File.dirname(__FILE__) + '/../config/validb.json')
+        configuration = Validb::Configuration.new(filename)
+        configuration.ignored_models.should == [Blog, Post]
+      end
+    end
+  end
+
+  describe "#ignored_prefixes" do
+    context "with a missing configuration file" do
+      it "returns an empty array" do
+        filename = File.expand_path(File.dirname(__FILE__) + '/../config/missing.json')
+        configuration = Validb::Configuration.new(filename)
+        configuration.ignored_prefixes.should == []
+      end
+    end
+
+    context "with a configuration file" do
+      it "returns the ignored models" do
+        filename = File.expand_path(File.dirname(__FILE__) + '/../config/validb.json')
+        configuration = Validb::Configuration.new(filename)
+        configuration.ignored_prefixes.should == ["Api"]
+      end
+    end
+  end
+end

data/spec/validb/finder_spec.rb

@@ -1,27 +1,38 @@
 require 'spec_helper'
 
 describe Validb::Finder do
-  class NoTable < ActiveRecord::Base
+  class NoTableModel < ActiveRecord::Base
+  end
+
+  describe "#initialize" do
+    it "creates a model filterer" do
+      configuration = double('configuration')
+      Validb::ModelFilterer.should_receive(:new).with(configuration)
+      Validb::Finder.new(configuration, "")
+    end
   end
 
   describe "#models" do
     context "with an empty string" do
       it "returns all the models with tables" do
-        finder = Validb::Finder.new("")
-        finder.models.should =~ [Post, Blog, Comment]
+        configuration = Validb::Configuration.new("")
+        finder = Validb::Finder.new(configuration, "")
+        finder.models.should =~ [Post, Blog, Comment, Person]
       end
     end
 
     context "valid model names" do
       it "returns all the selected models with tables" do
-        finder = Validb::Finder.new("Post, Blog")
+        configuration = Validb::Configuration.new("")
+        finder = Validb::Finder.new(configuration, "Post, Blog")
         finder.models.should =~ [Post, Blog]
       end
     end
 
     context "with invalid model names" do
       it "returns all the valid models with tables" do
-        finder = Validb::Finder.new("Post, Blog, Fake")
+        configuration = Validb::Configuration.new("")
+        finder = Validb::Finder.new(configuration, "Post, Blog, Fake")
         finder.models.should =~ [Post, Blog]
       end
     end

data/spec/validb/model_filterer_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Validb::ModelFilterer do
+
+  class Author < Person
+  end
+
+  module Api
+    class Approval < ActiveRecord::Base
+      self.table_name = "approvals"
+    end
+  end
+
+  describe "#models" do
+    it "returns all the non filtered models" do
+      filename = File.expand_path(File.dirname(__FILE__) + '/../config/validb.json')
+      configuration = Validb::Configuration.new(filename)
+      model_filterer = Validb::ModelFilterer.new(configuration)
+
+      models = [User, Author, Blog, Post, Api::Approval, Comment, Person]
+
+      model_filterer.filter(models).should =~ [Comment, Person]
+    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.1.0"
+    Validb::VERSION.should == "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Joey Geiger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,17 +40,22 @@ files:
 - lib/validb.rb
 - lib/validb/batcher.rb
 - lib/validb/checker.rb
+- lib/validb/configuration.rb
 - lib/validb/console_logger.rb
 - lib/validb/finder.rb
+- lib/validb/model_filterer.rb
 - lib/validb/model_validator.rb
 - lib/validb/railtie.rb
 - lib/validb/record_validator.rb
 - lib/validb/version.rb
+- spec/config/validb.json
 - spec/spec_helper.rb
 - 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/model_filterer_spec.rb
 - spec/validb/model_validator_spec.rb
 - spec/validb/record_validator_spec.rb
 - spec/validb/version_spec.rb