nullalign 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5af4ac1d6d4cfd1977ef54a3f0474dbce25f9fea
+  data.tar.gz: bad6def07e87ca11b13fac642d6f937314143f45
+SHA512:
+  metadata.gz: d26458bc42d5646822a211380a7f558a1d99027423cf307df635bc90f7669278d49a9e79ae0cc2388c96a3fcbd9cd94fd3f73917210be8399328077e4a114623
+  data.tar.gz: '091cdc67b563263fdf6e04a1fc56037f4bc26fdc1bc1c59c4a6cee2ef0704fcbeff6d818108bc854db6be6947a892701a18cfe2fbfa5999a1d222924fca6ebad'

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.2

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## v0.0.1 Sep 28 2017
+
+* Initial release
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Colin Jones
+
+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,52 @@
+# Nullalign
+
+## Description
+
+nullalign is a tool to detect missing non-null constraints in Rails projects.
+
+Suppose you have a validation like this:
+
+    validates :email, presence: true
+
+Do you have a non-null constraint in your database to back that up?  If not, nullalign will find it for you.
+
+Nullalign is based on Colin Jones' [consistency_fail](https://github.com/trptcolin/consistency_fail).  I mean really really based on it, as in I copied and pasted over a bunch of the code and changed the module and file names.  And a lot of this README, too.
+
+## Installation
+
+Put this in the `development` group in your `Gemfile`
+
+    gem 'nullalign'
+
+## Usage
+
+Run it like this:
+
+    bundle exec nullalign
+
+## Example output
+
+    There are presence validators that aren't backed by non-null constraints.
+    --------------------------------------------------------------------------------
+    Model              Table Columns
+    --------------------------------------------------------------------------------
+    Album              albums: name, owner_id
+    AttendanceRecord   attendance_records: group_id, attended_at
+    CheckinLabel       checkin_labels: name, xml
+    CheckinTime        checkin_times: campus
+
+## Limitations
+
+nullalign depends on being able to find all your `ActiveRecord::Base`
+subclasses with some `$LOAD_PATH` trickery. If any models are in a path either
+not on your project's load path or in a path that doesn't include the word
+"models", nullalign won't be able to find or analyze them. I'm open to
+making the text "models" configurable if people want that. Please open an issue
+or pull request if so!
+
+To disable nullalign, I could add a thing that checks column comments for a string
+like 'nonullalign' if people think that would be useful.  Just let me know.
+
+## License
+
+Released under the MIT License. See the LICENSE file for further details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/nullalign

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+base_dir = File.join(Dir.pwd, ARGV.first.to_s)
+puts "\nWarning! You are going out of current directory, ruby version may be wrong and some gems may be missing.\n" unless File.realpath(base_dir).start_with?(Dir.pwd)
+
+begin
+
+  require File.join(base_dir, 'config', 'boot')
+rescue LoadError
+  puts "\nUh-oh! You must be in the root directory of a Rails project.\n"
+  raise
+end
+
+require 'active_record'
+require File.join(base_dir, 'config', 'environment')
+
+$:<< File.join(File.dirname(__FILE__), '..', 'lib')
+require 'nullalign'
+
+if Nullalign.run
+  exit 0
+else
+  exit 1
+end

data/lib/nullalign.rb

@@ -0,0 +1,28 @@
+require 'nullalign/models'
+require 'nullalign/introspectors/table_data'
+require 'nullalign/introspectors/validates_presence_of'
+require 'nullalign/reporter'
+
+module Nullalign
+  def self.run
+    models = Nullalign::Models.new($LOAD_PATH)
+    models.preload_all
+
+    reporter = Nullalign::Reporter.new
+
+    introspector = Nullalign::Introspectors::ValidatesPresenceOf.new
+    problems = problems(models.all, introspector)
+    reporter.report_validates_presence_problems(problems)
+    problems.empty?
+  end
+  
+  private
+  
+  def self.problems(models, introspector)
+    models.map do |m|
+      [m, introspector.missing_nonnull_constraints(m)]
+    end.reject do |m, columns|
+      columns.empty?
+    end
+  end
+end

data/lib/nullalign/introspectors/table_data.rb

@@ -0,0 +1,17 @@
+require 'nullalign/nonnull_constraint'
+
+module Nullalign
+  module Introspectors
+    class TableData
+      def nonnull_constraints(model)
+        return [] if !model.table_exists?
+
+        nonnull_constraints_by_table(model, model.table_name)
+      end
+
+      def nonnull_constraints_by_table(model, table_name)
+        model.columns.select {|c| !c.null }.map {|c| Nullalign::NonnullConstraint.new(model, table_name, c.name) }
+      end
+    end
+  end
+end

data/lib/nullalign/introspectors/validates_presence_of.rb

@@ -0,0 +1,41 @@
+require 'nullalign/nonnull_constraint'
+
+module Nullalign
+  module Introspectors
+    class ValidatesPresenceOf
+      def instances(model)
+        model.validators.select do |v|
+          v.class == ActiveRecord::Validations::PresenceValidator
+        end
+      end
+
+      def desired_nonnull_constraints(model)
+        instances(model).map do |v|
+          v.attributes.map do |attribute|
+            # This next bit is to avoid a false positive in the case where a validator uses
+            # an association name rather than the field name (i.e. user vs user_id).
+            association = model.reflect_on_all_associations.detect {|r| r.name == attribute }
+            attribute_value = if association != nil
+              association.foreign_key
+            else
+              attribute
+            end
+            Nullalign::NonnullConstraint.new(model,
+                                       model.table_name,
+                                       attribute_value)
+          end
+        end.flatten
+      end
+      private :desired_nonnull_constraints
+
+      def missing_nonnull_constraints(model)
+        return [] unless model.connection.tables.include? model.table_name
+        existing_nonnull_constraints = TableData.new.nonnull_constraints(model)
+
+        desired_nonnull_constraints(model).reject do |index|
+          existing_nonnull_constraints.include?(index)
+        end
+      end
+    end
+  end
+end

data/lib/nullalign/models.rb

@@ -0,0 +1,29 @@
+require 'active_record'
+
+module Nullalign
+  class Models
+    MODEL_DIRECTORY_REGEXP = /models/
+
+    attr_reader :load_path
+
+    def initialize(load_path)
+      @load_path = load_path
+    end
+
+    def dirs
+      load_path.select { |lp| MODEL_DIRECTORY_REGEXP =~ lp.to_s }
+    end
+
+    def preload_all
+      self.dirs.each do |d|
+        Dir.glob(File.join(d, "**", "*.rb")).each do |model_filename|
+          Kernel.require_dependency model_filename
+        end
+      end
+    end
+
+    def all
+      ActiveRecord::Base.descendants.sort_by(&:name)
+    end
+  end
+end

data/lib/nullalign/nonnull_constraint.rb

@@ -0,0 +1,15 @@
+module Nullalign
+  class NonnullConstraint
+    attr_reader :model, :table_name, :column
+    def initialize(model, table_name, column)
+      @model = model
+      @table_name = table_name
+      @column = column.to_s
+    end
+
+    def ==(other)
+      self.table_name == other.table_name &&
+        self.column == other.column
+    end
+  end
+end

data/lib/nullalign/reporter.rb

@@ -0,0 +1,9 @@
+require 'nullalign/reporters/validates_presence_of'
+
+module Nullalign
+  class Reporter
+    def report_validates_presence_problems(null_constraints_by_model)
+      Nullalign::Reporters::ValidatesPresenceOf.new.report(null_constraints_by_model)
+    end
+  end
+end

data/lib/nullalign/reporters/base.rb

@@ -0,0 +1,79 @@
+module Nullalign
+  module Reporters
+    class Base
+      TERMINAL_WIDTH = 80
+
+      RED = 31
+      GREEN = 32
+
+      def use_color(code)
+        print "\e[#{code}m"
+      end
+
+      def use_default_color
+        use_color(0)
+      end
+
+      def report_success(macro)
+        use_color(GREEN)
+        # TODO not using 'macro' but leaving it here in case this gets
+        # rolled into consistency_fail
+        puts "Hooray! All presence validators are backed by a non-null constraint."
+        use_default_color
+      end
+
+      def divider(pad_to = TERMINAL_WIDTH)
+        puts "-" * [pad_to, TERMINAL_WIDTH].max
+      end
+
+      def report_failure_header(macro, longest_model_length)
+        puts
+        use_color(RED)
+        # TODO not using 'macro' but leaving it here in case this gets
+        # rolled into consistency_fail
+        puts "There are presence validators that aren't backed by non-null constraints."
+        use_default_color
+        divider(longest_model_length * 2)
+
+        column_1_header, column_2_header = column_headers
+        print column_1_header.ljust(longest_model_length + 2)
+        puts column_2_header
+
+        divider(longest_model_length * 2)
+      end
+
+      def column_1(model)
+        model.name
+      end
+
+      def column_headers
+        ["Model", "Table Columns"]
+      end
+
+      def report(null_constraints_by_model)
+        if null_constraints_by_model.empty?
+          report_success(macro)
+        else
+          null_constraints_by_table_name = null_constraints_by_model.map do |model, columns|
+            [column_1(model), model, columns]
+          end.sort_by(&:first)
+          longest_model_length = null_constraints_by_table_name.map(&:first).
+                                                       sort_by(&:length).
+                                                       last.
+                                                       length
+          column_1_header_length = column_headers.first.length
+          longest_model_length = [longest_model_length, column_1_header_length].max
+
+          report_failure_header(macro, longest_model_length)
+
+          null_constraints_by_table_name.each do |table_name, model, columns|
+            print model.name.ljust(longest_model_length + 2)
+            puts columns.first.table_name + ": " + columns.map {|x| x.column }.join(', ')
+          end
+          divider(longest_model_length * 2)
+        end
+        puts
+      end
+    end
+  end
+end

data/lib/nullalign/reporters/validates_presence_of.rb

@@ -0,0 +1,13 @@
+require 'nullalign/reporters/base'
+
+module Nullalign
+  module Reporters
+    class ValidatesPresenceOf < Base
+      attr_reader :macro
+
+      def initialize
+        @macro = :validates_presence_of
+      end
+    end
+  end
+end

data/lib/nullalign/version.rb

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

data/nullalign.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nullalign/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nullalign"
+  s.version     = Nullalign::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tom Copeland"]
+  s.email       = ["tom@thomasleecopeland.com"]
+  s.homepage    = "http://github.com/tcopeland/nullalign"
+  s.summary     = %q{A tool to detect missing non-null constraints}
+  s.description = <<-EOF
+If you have a presence validation, you'll probably want a
+non-null constraint to go with it.
+EOF
+  s.license = "MIT"
+
+  s.add_development_dependency "activerecord", "~>3.0"
+  s.add_development_dependency "sqlite3", "~>1.3"
+  s.add_development_dependency "rspec", "~>3.2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/models_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Nullalign::Models do
+  
+  def models(load_path)
+    Nullalign::Models.new(load_path)
+  end
+
+  it "gets the load path" do
+    expect(models([:a, :b, :c]).load_path).to eq([:a, :b, :c])
+  end
+
+  it "gets the directories matching /models/" do
+    models = models(["foo/bar/baz", "app/models", "some/other/models"])
+    expect(models.dirs).to eq(["app/models", "some/other/models"])
+  end
+
+  it "accepts and matches path names as well as strings" do
+    models = models([Pathname.new("app/models")])
+    expect { models.dirs }.not_to raise_error
+    expect(models.dirs).to eq([Pathname.new("app/models")])
+  end
+
+  it "preloads models by calling require_dependency" do
+    models = models(["foo/bar/baz", "app/models", "some/other/models"])
+    allow(Dir).to receive(:glob).
+        with(File.join("app/models", "**", "*.rb")).
+        and_return(["app/models/account.rb"])
+    allow(Dir).to receive(:glob).
+        with(File.join("some/other/models", "**", "*.rb")).
+        and_return(["some/other/models/foo.rb"])
+
+    expect(Kernel).to receive(:require_dependency).with("app/models/account.rb")
+    expect(Kernel).to receive(:require_dependency).with("some/other/models/foo.rb")
+
+    models.preload_all
+  end
+
+  it "gets all models" do
+    # TODO fails, but why?
+    # model_a = double(:name => "animal")
+    # model_b = double(:name => "cat")
+    # model_c = double(:name => "beach_ball")
+    #
+    # allow(ActiveRecord::Base).to receive(:send).with(:descendants).and_return([model_a, model_b, model_c])
+    #
+    # expect(models([]).all).to eq([model_a, model_c, model_b])
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+Dir['./spec/support/**/*.rb'].sort.each { |file| require file }
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"

data/spec/support/models/correct_account.rb

@@ -0,0 +1,3 @@
+class CorrectAccount < ActiveRecord::Base
+  validates :email, presence: true
+end

data/spec/support/models/new_correct_account.rb

@@ -0,0 +1,7 @@
+class NewCorrectAccount < CorrectAccount
+  self.table_name = 'new_correct_account'
+
+  def readonly?
+    true
+  end
+end

data/spec/support/models/nonexistent.rb

@@ -0,0 +1,2 @@
+class Nonexistent < ActiveRecord::Base
+end

data/spec/support/models/wrong_account.rb

@@ -0,0 +1,3 @@
+class WrongAccount < ActiveRecord::Base
+  validates :email, presence: true
+end

data/spec/support/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define(version: 0) do
+  self.verbose = false
+
+  create_table :correct_accounts do |t|
+    t.string :email, null: false
+    t.timestamps
+  end
+
+  create_table :wrong_accounts do |t|
+    t.string :email
+    t.timestamps
+  end
+
+  execute 'CREATE VIEW new_correct_people AS '\
+          'SELECT * FROM correct_people '\
+          'WHERE created_at = updated_at'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: nullalign
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |
+  If you have a presence validation, you'll probably want a
+  non-null constraint to go with it.
+email:
+- tom@thomasleecopeland.com
+executables:
+- nullalign
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/nullalign
+- lib/nullalign.rb
+- lib/nullalign/introspectors/table_data.rb
+- lib/nullalign/introspectors/validates_presence_of.rb
+- lib/nullalign/models.rb
+- lib/nullalign/nonnull_constraint.rb
+- lib/nullalign/reporter.rb
+- lib/nullalign/reporters/base.rb
+- lib/nullalign/reporters/validates_presence_of.rb
+- lib/nullalign/version.rb
+- nullalign.gemspec
+- spec/models_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/models/correct_account.rb
+- spec/support/models/new_correct_account.rb
+- spec/support/models/nonexistent.rb
+- spec/support/models/wrong_account.rb
+- spec/support/schema.rb
+homepage: http://github.com/tcopeland/nullalign
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A tool to detect missing non-null constraints
+test_files:
+- spec/models_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/models/correct_account.rb
+- spec/support/models/new_correct_account.rb
+- spec/support/models/nonexistent.rb
+- spec/support/models/wrong_account.rb
+- spec/support/schema.rb