recheck 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 229b7b48547c7da457bff99e2d10cef1d46a915ad4f3699dd0ae3ad29b7075af
-  data.tar.gz: 55d665725da5fe601a0c86ba9c4f62943702b56c7ae239aa3c8c1fe31e01b94c
+  metadata.gz: 4f6d708bcbdaeb426979687daffc616bf45829d7d3cc82f36bbf5331664ac737
+  data.tar.gz: dc56ce8289e425936891ecb106f1b4a7a7c82b58035bd4b4f4c90d0353312bbd
 SHA512:
-  metadata.gz: b2b403ea3658c20f66b825f1198c3c6ea341161b84face61a83529c284135f230b069bd4db13f2550dde0e7965944ac36d3de56b3ec0cb4b579a99796e16dc5a
-  data.tar.gz: 1dbfd3a4dd3252b9e8603a9b9bbb28fb35255acdb4d068dfe74d55fde7e0683b53ff66b59c89eae29848070193a0ea48c8da51a78195e88ede9e3f8c35b6039a
+  metadata.gz: 4a368e70331a30b93eeeafc5f75cc92fe94fa06ceba27d66a334367f17b84c666e4cbeb32106826fd779b0c3ffd40e5b04656b63c08b3fd214f71fc6cde83898
+  data.tar.gz: e6b8607c5338ac141da261503da2c8e820b2397adef3a2e6926577bca5e97162a2024c3eec34bfba36e705b7d2d09b99ee377f681c1f9f99582a83bd337f5433

data/lib/recheck/rails/railtie.rb

@@ -0,0 +1,10 @@
+require "rails"
+require "recheck"
+
+module Recheck
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path("../../tasks/recheck_tasks.rake", __FILE__)
+    end
+  end
+end

data/lib/recheck/rails/setup.rb

@@ -0,0 +1,143 @@
+require "pathname"
+
+require "erb"
+
+require_relative "validation"
+
+module Recheck
+  module Command
+    class Setup
+      # override the base gem's method; with the Rails env booted we can
+      # introspect the models to create much better initial checks
+      def setup_model_checks
+        puts "Introspecting ApplicationRecord..."
+
+        # surely there's a better way to find the gem's root
+        template_dir = File.join(File.expand_path("../../..", __dir__), "template")
+        model_template = File.read("#{template_dir}/application_record_check.rb.erb")
+        validation_template = File.read("#{template_dir}/validation_checker.rb.erb")
+
+        # Get all non-abstract ActiveRecord model classes
+        models = ApplicationRecord.descendants.each do |model|
+          puts model
+          puts "  skipping abstract class" or next if model.abstract_class?
+          puts "  skipping readonly model (probably a view)" or next if model.new.send(:readonly?)
+
+          source_location = Object.const_source_location(model.to_s)
+          model_root_filename = source_location[0].sub(%r{#{Rails.root}/}, "")
+          # kind of a bad variable name here, but support the default model path + others
+          model_filename = model_root_filename.sub(%r{^app/models/}, "")
+
+          if %r{/zeitwerk/}.match?(source_location.first)
+            puts "  Warning: model class wasn't loaded; apparently saw a zeitwerk placeholder for its source_location: #{souce_location}"
+            puts "Your app boots/preloads in an unexpected way, if you can help debug please open an issue on recheck."
+            exit 1
+          end
+
+          model_check_filename = "recheck/model/#{model_filename}"
+          class_name = model.name.sub("::", "_") # to differentiate AccountName and Account::Name
+          depth = 1 + model_filename.count("/")
+
+          puts "  #{model_check_filename}"
+          FileUtils.mkdir_p(File.dirname(model_check_filename))
+          rendered = ERB.new(model_template).result_with_hash({class_name:, depth:, model:, model_root_filename:})
+          File.write(model_check_filename, rendered)
+
+          validation_check_filename = "recheck/validation/#{model_filename}"
+          puts "  #{validation_check_filename}"
+          FileUtils.mkdir_p(File.dirname(validation_check_filename))
+          binding = Validation.new(class_name:, depth:, model:, model_root_filename:, queries: queries(model:)).get_binding
+          rendered = ERB.new(validation_template, trim_mode: "-").result(binding)
+          File.write(validation_check_filename, rendered)
+        end
+      end
+
+      def queries model:
+        model.validators.map do |validator|
+          # validators take a list of attributes but operate on them individually
+          validator.attributes.map do |attr|
+            name = "query_#{validator.kind}_#{attr}"
+            # remove memory addresses; just noise
+            inspect = validator.inspect.gsub(/(#<[\w:]+):0x[0-9a-f]+ /, '\1 ')
+
+            column = model.columns_hash[attr.to_s]
+            next Placeholder.new inspect:, comment: "Can't query attribute #{attr}, it's not a database column" if column.nil?
+            type = column.sql_type_metadata.type
+
+            if validator.options[:if] || validator.options[:unless]
+              next Placeholder.new inspect:, comment: "Can't automatically translate this validation's :if or :unless into a query"
+            end
+
+            # normalizing - if not specified or [], on: means [:create, :udpate]
+            on = validator.options[:on] || []
+            on = [:create, :update] if on.empty?
+            if validator.options[:on] == [:create]
+              next Placeholder.new inspect:, comment: "Only validates on: :create, so there's nothing to validate for persisted records"
+            end
+
+            warning = if validator.options[:allow_nil] && !column.null
+              "Warning: model #{model.name} validates #{attr} with :allow_nil but column #{column.name} is NOT NULL, so a 'valid' record can't be saved.\nRemove :allow_nil or make the column nullable."
+            end
+
+            case validator
+            when ActiveModel::BlockValidator
+              Placeholder.new inspect:, comment: "Can't automatically translate a Ruby block into a query."
+            when ActiveModel::Validations::ConfirmationValidator
+              FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
+            when ActiveModel::Validations::FormatValidator
+              FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
+            when ActiveModel::Validations::InclusionValidator
+              FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
+            when ActiveRecord::Validations::AbsenceValidator
+              FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
+            when ActiveRecord::Validations::AssociatedValidator
+              FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
+            when ActiveRecord::Validations::LengthValidator
+              or_clauses = []
+              if type == :stirng || type == :integer
+                if validator.options[:is]
+                  or_clauses << %{"LENGTH(`#{column.name}`) = '')"}
+                end
+                if validator.options[:minimum] && validator.options[:maximum]
+                  or_clauses << %{"LENGTH(`#{column.name}`) >= #{validator.options[:minimum]} and "LENGTH(`#{column.name}`) <= #{validator.options[:maximum]}}
+                elsif validator.options[:minimum]
+                  or_clauses << %{"LENGTH(`#{column.name}`) >= #{validator.options[:minimum]}}
+                elsif validator.options[:maximum]
+                  or_clauses << %{"LENGTH(`#{column.name}`) <= #{validator.options[:maximum]}}
+                end
+              elsif type == :boolean
+                comment = "Validating length of a boolean is backend-dependednt and a strange idea."
+              else
+                comment = "Recheck doesn't know how to handle presence on a #{type}, please report."
+              end
+              if !validator.options[:allow_nil] && !validator.options[:allow_blank]
+                or_clauses << "#{column.name}: nil"
+              end
+            when ActiveRecord::Validations::NumericalityValidator
+              FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
+            when ActiveRecord::Validations::PresenceValidator
+              if validator.options[:allow_blank]
+                next Placeholder.new inspect:, comment: "Validates presence of #{attr} with :allow_blank, which can never fail."
+              end
+              or_clauses = []
+              if !validator.options[:allow_nil]
+                or_clauses << "#{column.name}: nil"
+              end
+              case type
+              when :string
+                or_clauses << %{"TRIM(`#{column.name}`) = ''"}
+              when :boolean
+                or_clauses << "#{column.name}: false"
+              else
+                comment = "Recheck doesn't know how to handle presence on a #{type}, please report."
+              end
+              Query.new inspect:, name:, warning:, comment:, or_clauses:
+            when ActiveRecord::Validations::UniquenessValidator
+              FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
+            end
+          end
+        end.flatten
+      end
+    end
+  end
+end

data/lib/recheck/rails/validation.rb

@@ -0,0 +1,11 @@
+module Recheck
+  Placeholder = Data.define(:inspect, :comment)
+  FunctionPlaceholder = Data.define(:inspect, :name, :comment)
+  Query = Data.define(:inspect, :warning, :name, :comment, :or_clauses)
+
+  Validation = Data.define(:class_name, :depth, :model, :model_root_filename, :queries) do
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/recheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Recheck
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/recheck.rb

@@ -9,12 +9,14 @@ module Recheck
   end
 end
 
-require_relative "../vendor/optimist"
-require_relative "recheck/checkers"
-require_relative "recheck/cli"
-require_relative "recheck/commands"
-require_relative "recheck/results"
-require_relative "recheck/count_stats"
-require_relative "recheck/reporters"
-require_relative "recheck/runner"
-require_relative "recheck/version"
+require "recheck/vendor/optimist"
+require "recheck/checkers"
+require "recheck/cli"
+require "recheck/commands"
+require "recheck/results"
+require "recheck/count_stats"
+require "recheck/reporters"
+require "recheck/runner"
+require "recheck/version"
+
+require "recheck/rails/railtie" if defined?(::Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recheck
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Peter Bhat Harkins
@@ -66,9 +66,13 @@ files:
 - lib/recheck/cli.rb
 - lib/recheck/commands.rb
 - lib/recheck/count_stats.rb
+- lib/recheck/rails/railtie.rb
+- lib/recheck/rails/setup.rb
+- lib/recheck/rails/validation.rb
 - lib/recheck/reporters.rb
 - lib/recheck/results.rb
 - lib/recheck/runner.rb
+- lib/recheck/vendor/optimist.rb
 - lib/recheck/version.rb
 - template/recheck_helper.rb
 - template/regression_checker_sample.rb
@@ -76,7 +80,6 @@ files:
 - template/site/dns_checker.rb
 - template/site/tls_checker.rb
 - template/site/whois_checker.rb
-- vendor/optimist.rb
 homepage: https://recheck.dev
 licenses:
 - LGPL-3.0