validation_inspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c51fb4232f982dc74334f116cc6135a310692158de44c3a8fd5a006f1f5823b4
+  data.tar.gz: a0369bf8bd0ac7345137762313cc4429b80a8d69c9151582ac61bb1821481d19
+SHA512:
+  metadata.gz: 99c510be04b0f3285a955a886d49abed0a67acced17eb6e1cd3d185b9113f3fe36e7cebfbbce3ce7918bda2160982930c6d2edf1656afc5f4316e9e5c542b037
+  data.tar.gz: c63ee5669eafd5e23594b503c72a807202893bb6fcc7397bda47f16fddf1d88a8c2e344bc1c2ce78d81784c5c9df2d259132d862fc2a652ec4b509bc416ef242

data/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run RuboCop
+        run: bundle exec rubocop
+
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run RSpec
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-02-15
+
+- Initial release
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 tenmihi
+
+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,54 @@
+# ValidationInspector
+
+A simple Ruby gem to list ActiveModel validation callbacks with their conditions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validation_inspector'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+```ruby
+require 'validation_inspector'
+
+class User < ApplicationRecord
+  attr_accessor :name, :email, :age
+
+  validates :name, presence: true, if: :active?
+  validates :email, format: { with: /@/ }
+  validates :age, numericality: { greater_than: 0 }
+  validate :custom_validation
+end
+
+User.inspect_validations
+=>
+[
+  { validator: ActiveModel::Validations::PresenceValidator,
+    attributes: [:name],
+    if_conds: [":active?"] },
+  { validator: ActiveModel::Validations::FormatValidator,
+    attributes: [:email],
+    options: { with: "/@/" } },
+  { validator: ActiveModel::Validations::NumericalityValidator,
+    attributes: [:age],
+    options: { greater_than: 0 } },
+  { validator: :custom_validation,
+    attributes: nil }
+]
+```
+
+**Note**: Options from custom validators or other unsupported validators are not included in the `options` field.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/validation_inspector/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ValidationInspector
+  VERSION = "0.1.0"
+end

data/lib/validation_inspector.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "validation_inspector/version"
+
+# Lists ActiveModel validation callbacks with their conditions.
+module ValidationInspector
+  SUPPORTED_OPTION_KEYS = {
+    # LengthValidator
+    minimum: true,
+    maximum: true,
+    is: true,
+    in: true,
+    within: true,
+    # NumericalityValidator
+    only_integer: true,
+    greater_than: true,
+    greater_than_or_equal_to: true,
+    less_than: true,
+    less_than_or_equal_to: true,
+    equal_to: true,
+    other_than: true,
+    odd: true,
+    even: true,
+    # FormatValidator
+    with: true,
+    without: true,
+    # ComparisonValidator
+    # (greater_than, less_than, etc. are shared with NumericalityValidator)
+    # Common options
+    allow_nil: true,
+    allow_blank: true
+  }.freeze
+
+  def self.all(model_class)
+    model_class._validate_callbacks.map do |cb|
+      validator = validator_name(cb.filter)
+
+      attributes = cb.filter.respond_to?(:attributes) ? cb.filter.attributes : nil
+
+      { validator:, attributes: attributes }.tap do |v|
+        ifs     = Array(cb.instance_variable_get(:@if))
+        unlesss = Array(cb.instance_variable_get(:@unless))
+
+        v[:if_conds] = ifs.map { |c| format_condition(c) } unless ifs.empty?
+        v[:unless_conds] = unlesss.map { |c| format_condition(c) } unless unlesss.empty?
+
+        options = extract_options(cb.filter)
+        v[:options] = options unless options.empty?
+      end
+    end
+  end
+
+  def self.validator_name(filter)
+    case filter
+    when Symbol then filter
+    when Proc
+      loc = filter.source_location&.join(":")
+      "proc@#{loc || "unknown"}"
+    else
+      filter.class
+    end
+  end
+
+  def self.format_condition(cond)
+    cond.is_a?(Symbol) ? ":#{cond}" : (cond.source_location&.join(":") || cond.class.name)
+  end
+
+  def self.extract_options(filter)
+    return {} unless filter.respond_to?(:options)
+
+    options = filter.options
+    return {} unless options.is_a?(Hash)
+
+    options.each_with_object({}) do |(key, value), result|
+      next unless SUPPORTED_OPTION_KEYS.key?(key)
+
+      result[key] = value.is_a?(Regexp) ? value.inspect : value
+    end
+  end
+
+  private_class_method :format_condition, :validator_name, :extract_options
+end
+
+if defined?(ActiveModel::Validations)
+  module ValidationInspector
+    module ClassMethodsExtension
+      def inspect_validations
+        ValidationInspector.all(self)
+      end
+    end
+  end
+
+  ActiveModel::Validations::ClassMethods.prepend ValidationInspector::ClassMethodsExtension
+else
+  warn "Warning: ActiveModel is not available. ValidationInspector will not work without it."
+end

data/sig/validation_inspector.rbs

@@ -0,0 +1,4 @@
+module ValidationInspector
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+
+require "active_model"
+require "validation_inspector"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/validation_inspector_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe ValidationInspector do
+  class SampleModel
+    include ActiveModel::Validations
+
+    attr_accessor :name, :email, :active, :skip
+
+    validates :name, presence: true, if: :active?
+    validates :email, format: { with: /@/ }, unless: -> { skip? }
+    validate :custom_check
+    validate -> { errors.add(:base, "invalid") }
+
+    def active?
+      !!active
+    end
+
+    def skip?
+      !!skip
+    end
+
+    def custom_check
+      errors.add(:base, "custom")
+    end
+  end
+
+  class ModelWithOptions
+    include ActiveModel::Validations
+
+    attr_accessor :name, :age, :status, :role
+
+    validates :name, length: { minimum: 2, maximum: 255 }
+    validates :age, numericality: { greater_than_or_equal_to: 0, less_than: 150, only_integer: true }
+    validates :status, inclusion: { in: %w[active inactive] }
+    validates :role, exclusion: { in: %w[admin superuser], allow_nil: true }
+  end
+
+  describe ".all" do
+    it "lists ActiveModel validations" do
+      result = described_class.all(SampleModel)
+
+      presence = result.find { |v| v[:validator] == ActiveModel::Validations::PresenceValidator }
+      expect(presence).not_to be_nil
+      expect(presence[:attributes]).to eq([:name])
+      expect(presence[:if_conds]).to eq([":active?"])
+
+      format = result.find { |v| v[:validator] == ActiveModel::Validations::FormatValidator }
+      expect(format).not_to be_nil
+      expect(format[:attributes]).to eq([:email])
+    end
+
+    it "lists custom validation methods" do
+      result = described_class.all(SampleModel)
+
+      custom = result.find { |v| v[:validator] == :custom_check }
+      expect(custom).not_to be_nil
+      expect(custom[:attributes]).to be_nil
+    end
+
+    it "lists proc validations" do
+      result = described_class.all(SampleModel)
+
+      proc_entry = result.find { |v| v[:validator].is_a?(String) && v[:validator].start_with?("proc@") }
+      expect(proc_entry).not_to be_nil
+    end
+
+    it "extracts options from LengthValidator" do
+      result = described_class.all(ModelWithOptions)
+
+      length = result.find { |v| v[:validator] == ActiveModel::Validations::LengthValidator }
+      expect(length).not_to be_nil
+      expect(length[:options]).to include(minimum: 2, maximum: 255)
+    end
+
+    it "extracts options from NumericalityValidator" do
+      result = described_class.all(ModelWithOptions)
+
+      numericality = result.find { |v| v[:validator] == ActiveModel::Validations::NumericalityValidator }
+      expect(numericality).not_to be_nil
+      expect(numericality[:options]).to include(
+        greater_than_or_equal_to: 0,
+        less_than: 150,
+        only_integer: true
+      )
+    end
+
+    it "extracts options from InclusionValidator" do
+      result = described_class.all(ModelWithOptions)
+
+      inclusion = result.find { |v| v[:validator] == ActiveModel::Validations::InclusionValidator }
+      expect(inclusion).not_to be_nil
+      expect(inclusion[:options]).to include(in: %w[active inactive])
+    end
+
+    it "extracts allow_nil option from ExclusionValidator" do
+      result = described_class.all(ModelWithOptions)
+
+      exclusion = result.find { |v| v[:validator] == ActiveModel::Validations::ExclusionValidator }
+      expect(exclusion).not_to be_nil
+      expect(exclusion[:options]).to include(in: %w[admin superuser], allow_nil: true)
+    end
+
+    it "extracts regex pattern from FormatValidator as inspected string" do
+      result = described_class.all(SampleModel)
+
+      format = result.find { |v| v[:validator] == ActiveModel::Validations::FormatValidator }
+      expect(format).not_to be_nil
+      expect(format[:options][:with]).to eq("/@/")
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: validation_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tenmihi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-02-15 00:00:00.000000000 Z
+dependencies: []
+description: ValidationInspector lists ActiveModel validation callbacks and their
+  conditions (if/unless), including attributes and custom/proc validators.
+email:
+- tenmihi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/validation_inspector.rb
+- lib/validation_inspector/version.rb
+- sig/validation_inspector.rbs
+- spec/spec_helper.rb
+- spec/validation_inspector_spec.rb
+homepage: https://github.com/tenmihi/validation_inspector
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/tenmihi/validation_inspector
+  changelog_uri: https://github.com/tenmihi/validation_inspector/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.2
+signing_key:
+specification_version: 4
+summary: List ActiveModel validation callbacks with conditions.
+test_files: []