model_probe 1.0.7 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 256df9f2a0d516dc276210959300379bdf59a743
-  data.tar.gz: ec8afcc2bafbf1d2bf86ef0c2529bf0cc4c78316
+SHA256:
+  metadata.gz: fedda5d159cc8bbc6bd0181bf718555437137143a893ca70c0ebacc9cdb1bf50
+  data.tar.gz: ec4be05cd44a4824637e062a538234327beaf5644630565beedbfd2c520becb6
 SHA512:
-  metadata.gz: 156afe3b29d19de7bda2b5ade402b84827f250e2285ad02f23f2808e1122f88aafc8611f5d3dda292bed8de34127bbedc30e0de78d0c50a17099afa47ee3eba6
-  data.tar.gz: a0d678decaac686cfb1d234436f2504be0b2d54d67f4343d551771e34c19baa0904b41784be02acaf7d519d8322a15ddc61321130a4db7c729f115f3aea2cc05
+  metadata.gz: ce89a216d52fbace263249b4874c674cc94302305acd38205f2e5f57861cb2af086fb414b7fcd692171732cda07151c8874c4d690579447c25850d30cc700e11
+  data.tar.gz: a30aac6054f3c4beca2d7b745b4628fe9b654fc0265da4c498ceb3e8b9f7385d3f8aac3e19962a4811be5ac487a2ae4f22f66cf1907c8ae5c7a905024e7e0897

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec

data/Gemfile.lock

@@ -1,19 +1,62 @@
 PATH
   remote: .
   specs:
-    model_probe (1.0.7)
+    model_probe (1.1.1)
+      rainbow
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (10.4.2)
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    magic_frozen_string_literal (1.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.52.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.29.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    standardrb (1.0.1)
+      standard
+    unicode-display_width (2.4.2)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
+  magic_frozen_string_literal
   model_probe!
-  rake
+  standardrb
 
 BUNDLED WITH
-   1.16.0
+   2.3.5

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Nathan Hopkins
+Copyright (c) 2023 Nathan Hopkins
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,140 +1,74 @@
 # ModelProbe
 
-<a target='_blank' rel='nofollow' href='https://app.codesponsor.io/link/QMSjMHrtPhvfmCnk5Hbikhhr/hopsoft/model_probe'>
-  <img alt='Sponsor' width='888' height='68' src='https://app.codesponsor.io/embed/QMSjMHrtPhvfmCnk5Hbikhhr/hopsoft/model_probe.svg' />
-</a>
-
-## Schema introspection for ActiveRecord
-
-Provides a detailed view of the underlying schema that backs an ActiveRecord model.
-
-*This functionality can be added to any object that implements [ActiveRecord's columns interface](http://rubydoc.info/docs/rails/ActiveRecord/ModelSchema/ClassMethods#columns-instance_method).*
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'model_probe'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install model_probe
-
-## Usage
-
-```ruby
-MyModel.extend ModelProbe
-MyModel.probe
-MyModel.print_fixture
-MyModel.print_model
-```
-
-## Rails Integration
-
-ModelProbe auto initializes in the Rails development environment.
-This means your models are implicitly extended with this behavior when developing.
-
-It also ships with these convenient rake tasks.
-
-```sh
-rails t -T model_probe
-
-# rails model_probe:print_fixture[klass]  # Print fixture
-# rails model_probe:print_model[klass]    # Print model
-# rails model_probe:probe[klass]          # Probe
-```
-
-```sh
-rails model_probe:probe[User]
-
-#   confirmation_sent_at datetime..timestamp without time zone NULL
-#     confirmation_token string....character varying           NULL
-#           confirmed_at datetime..timestamp without time zone NULL
-#             created_at datetime..timestamp without time zone
-#     current_sign_in_at datetime..timestamp without time zone NULL
-#     current_sign_in_ip inet......inet                        NULL
-#                  email string....character varying           NULL []
-#     encrypted_password string....character varying            []
-#        failed_attempts integer...integer                      [0]
-#                   * id uuid......uuid
-#        last_sign_in_at datetime..timestamp without time zone NULL
-#        last_sign_in_ip inet......inet                        NULL
-#              locked_at datetime..timestamp without time zone NULL
-#       payment_platform string....character varying           NULL
-#    payment_platform_id string....character varying           NULL
-#        phone_number_id uuid......uuid
-#    remember_created_at datetime..timestamp without time zone NULL
-# reset_password_sent_at datetime..timestamp without time zone NULL
-#   reset_password_token string....character varying           NULL
-#          sign_in_count integer...integer                      [0]
-#      unconfirmed_email string....character varying           NULL
-#           unlock_token string....character varying           NULL
-#             updated_at datetime..timestamp without time zone
-```
-
-```sh
-rails model_probe:print_fixture[User]
-
-# ---
-# user:
-#   confirmation_sent_at: value
-#   confirmation_token: value
-#   confirmed_at: value
-#   current_sign_in_at: value
-#   current_sign_in_ip: value
-#   email: ''
-#   encrypted_password: ''
-#   failed_attempts: '0'
-#   last_sign_in_at: value
-#   last_sign_in_ip: value
-#   locked_at: value
-#   payment_platform: value
-#   payment_platform_id: value
-#   phone_number_id: value
-#   reset_password_sent_at: value
-#   reset_password_token: value
-#   sign_in_count: '0'
-#   unconfirmed_email: value
-#   unlock_token: value
-```
-
-```sh
-rails model_probe:print_model[User]
-
-# class User < ApplicationRecord
-#   # extends ...................................................................
-#   # includes ..................................................................
-#
-#   # relationships .............................................................
-#   belongs_to :payment_platform
-#   belongs_to :phone_number
-#
-#   # validations ...............................................................
-#   validates :created_at, presence: true
-#   validates :encrypted_password, presence: true
-#   validates :failed_attempts, presence: true
-#   validates :phone_number_id, presence: true
-#   validates :sign_in_count, presence: true
-#   validates :updated_at, presence: true
-#
-#   # callbacks .................................................................
-#   # scopes ....................................................................
-#   # additional config (i.e. accepts_nested_attribute_for etc...) ..............
-#
-#   # class methods .............................................................
-#   class << self
-#   end
-#
-#   # public instance methods ...................................................
-#
-#   # protected instance methods ................................................
-#   protected
-#
-#   # private instance methods ..................................................
-#   private
-# end
-```
+## ActiveRecord schema visualization and model organization made easy 🙌
+
+Colorized table info for columns, types, nullables, indexes...
+and the actual DDL used by the database to create the table.
+_All this and more with ModelProbe!_
+
+1. Get a clear picture of your model's underlying schema with beautiful and informative schema introspection.
+1. Generate model class definitions with a well organized, logical structure.
+1. Create sensible text fixture stubs.
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [Quick Start](#quick-start)
+  - [Supported Databases](#supported-databases)
+  - [Videos](#videos)
+  - [Screenshots](#screenshots)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+## Quick Start
+
+1. Add the GEM to your project
+
+    ```sh
+    bundle add model_probe
+    ```
+
+   _ModelProbe auto initializes in the Rails `development` environment._
+
+1. Use in a Rails console
+
+    ```ruby
+    # examples for a User model
+    User.probe
+    User.print_model
+    User.print_fixture
+    ```
+1. Use with Rails (Rake) tasks
+
+    ```sh
+    # examples for a User model
+    bin/rails model_probe:probe[User]
+    bin/rails model_probe:print_model[User]
+    bin/rails model_probe:print_fixture[User]
+    ```
+
+## Supported Databases
+
+- MySQL
+- PostgreSQL
+- SQLite
+- _...more? contributions welcome ;)_
+
+## Videos
+
+[![image](https://ik.imagekit.io/hopsoft/model_probe_intro_Zf04NFJ1-.webp?updatedAt=1683471619001)](https://youtu.be/Q3IdyKateQE)
+
+## Screenshots
+
+Introspect your ActiveRecord models to build a deep understanding of the underlying database structure.
+
+![ModelProbe probe](https://ik.imagekit.io/hopsoft/mode_probe_probe_3ouJjft48.webp?updatedAt=1683465723169)
+
+Generate a well organized template for your ActiveRecord model's class definition.
+
+![ModelProbe print_model](https://ik.imagekit.io/hopsoft/model_probe_print_model_sGOZWw-D5.webp?updatedAt=1683465723049)
+
+Create fixture stubs to use in the test suite.
+
+![ModelProbe print_fixture](https://ik.imagekit.io/hopsoft/model_probe_print_fixture_ZZ2TavUO7.webp?updatedAt=1683465722977)

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"

data/lib/model_probe/probes/columns.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ModelProbe::Probes::Columns
+  def probe_columns
+    name_pad = columns.map { |c| c.name.length }.max + 2
+    type_pad = columns.map { |c| c.type.length }.max + 2
+    sql_type_pad = columns.map { |c| c.sql_type.length }.max + 1
+    columns.sort_by(&:name).each do |column|
+      probe_column column, name_pad: name_pad, type_pad: type_pad, sql_type_pad: sql_type_pad
+    end
+  end
+
+  protected
+
+  def primary_key_columns
+    columns.select { |column| primary_key_column? column }.sort_by(&:name)
+  end
+
+  def foreign_key_columns
+    columns.select { |column| foreign_key_column? column }.sort_by(&:name)
+  end
+
+  def relation_columns
+    columns.select { |column| relation_column? column }.sort_by(&:name)
+  end
+
+  def required_columns
+    columns.select { |column| required_column? column }.sort_by(&:name)
+  end
+
+  def limit_columns
+    columns.select { |column| limit_column? column }.sort_by(&:name)
+  end
+
+  def validation_columns
+    (required_columns + limit_columns).uniq.sort_by(&:name)
+  end
+
+  private
+
+  def probe_column(column, name_pad:, type_pad:, sql_type_pad:)
+    name = column.name
+    if primary_key_column?(column)
+      print Rainbow("*#{name}".rjust(name_pad)).magenta.bright
+    else
+      print Rainbow(name.to_s.rjust(name_pad)).magenta
+    end
+    print " "
+    print column.type.to_s.ljust(type_pad, ".")
+    print Rainbow(column.sql_type.to_s.ljust(sql_type_pad)).dimgray
+    print Rainbow("NULLABLE ").dimgray.faint if column.null
+    print Rainbow("REQUIRED ").indianred unless column.null
+    print Rainbow("default=").dimgray + Rainbow("#{column.default} ").skyblue if column.default
+    print "- #{Rainbow(column.comment).dimgray}" if column.comment
+    puts
+  end
+
+  def primary_key_column?(column)
+    column.name == primary_key
+  end
+
+  def foreign_key_column?(column)
+    return false if primary_key_column?(column)
+    column.name.end_with? "_id"
+  end
+
+  def timestamp_column?(column)
+    column.type == :datetime && column.name =~ /(created|updated|modified)/
+  end
+
+  def required_column?(column)
+    return false if primary_key_column?(column)
+    return false if foreign_key_column?(column)
+    return false if timestamp_column?(column)
+    !column.null
+  end
+
+  def limit_column?(column)
+    return false if primary_key_column?(column)
+    return false if foreign_key_column?(column)
+    return false if timestamp_column?(column)
+    %i[text string].include?(column.type) && column.limit.to_i > 0
+  end
+
+  def relation_column?(column)
+    return false if column.name == primary_key
+    column.name.end_with?("_id")
+  end
+
+  def fixture_columns
+    columns.sort_by(&:name).select do |column|
+      !primary_key_column?(column) && !timestamp_column?(column)
+    end
+  end
+end

data/lib/model_probe/probes/indexes.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ModelProbe::Probes::Indexes
+  def probe_indexes
+    indexes = connection.indexes(table_name)
+    name_pad = indexes.map { |c| c.name.length }.max + 1
+    indexes.sort_by(&:name).each do |index|
+      probe_index index, name_pad: name_pad
+    end
+  end
+
+  private
+
+  def probe_index(index, name_pad:)
+    print Rainbow(index.name.to_s.rjust(name_pad)).yellow
+    print Rainbow(" [").dimgray
+    index.columns.each_with_index do |column, index|
+      print Rainbow(", ").dimgray if index > 0
+      print Rainbow(column).magenta
+    end
+    print Rainbow("]").dimgray
+    print Rainbow(" UNIQUE").green.bright if index.unique
+
+    if index.where
+      print Rainbow(" where(#{index.where})").dimgray
+    end
+
+    if index.using
+      print Rainbow(" using(#{index.using})").dimgray
+    end
+    puts
+  end
+end

data/lib/model_probe/probes/metadata.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ModelProbe::Probes::Metadata
+  def probe_metadata
+    puts Rainbow(name).green + Rainbow(" < ").dimgray.faint + Rainbow(superclass.name).green.faint
+    puts Rainbow("  Database engine ".ljust(24, ".")).darkgray + " " + Rainbow(connection.adapter_name).skyblue.bright + " " + Rainbow(connection.database_version).skyblue.faint
+    puts Rainbow("  Database name ".ljust(24, ".")).darkgray + " " + Rainbow(connection_db_config.database).skyblue
+    puts Rainbow("  Table name ".ljust(24, ".")).darkgray + " " + Rainbow(table_name).skyblue
+    puts Rainbow("  Default role".ljust(24, ".")).darkgray + " " + Rainbow(default_role).skyblue
+    puts Rainbow("  Connection config ".ljust(24, ".")).darkgray
+    connection_db_config.configuration_hash.to_yaml.split("\n")[1..].each { |line| puts "    " + Rainbow(line).skyblue.faint }
+    puts
+    puts Rainbow("  DDL ".ljust(24, ".")).darkgray
+    if /create table/i.match?(ddl)
+      ddl.split("\n").each do |line|
+        line = line.squish
+        next if line.blank?
+        next if line.start_with?("--")
+        next if line.start_with?("/*")
+        next if /error|warning|Couldn't execute/i.match?(line)
+        puts Rainbow("    #{line}").skyblue.faint
+      end
+    else
+      puts Rainbow("    Failed to generate DDL string! #{ddl}").indianred
+    end
+  end
+
+  private
+
+  def ddl
+    config = connection_db_config.configuration_hash
+    @ddl ||= begin
+      case connection.adapter_name
+      when /sqlite/i
+        `sqlite3 #{config[:database]} '.schema #{table_name}' 2>&1`
+      when /postgresql/i
+        `PGPASSWORD=#{config[:password]} pg_dump --host=#{config[:host]} --port=#{config[:port]} --username=#{config[:username]} --schema-only --table=#{table_name} #{config[:database]} 2>&1`
+      when /mysql/i
+        `mysqldump --host=#{config[:host]} --port=#{config[:port]} --user=#{config[:username]} --password=#{config[:password]} --skip-lock-tables --no-data --compact #{config[:database]} #{table_name} 2>&1`
+      else
+        "DDL output is not yet supported for #{connection.adapter_name}!"
+      end
+    rescue => e
+      "Failed to generate DDL string! #{e.message}"
+    end
+  end
+end

data/lib/model_probe/probes/subclasses.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ModelProbe::Probes::Subclasses
+  def probe_subclasses
+    @count = 0
+    @max_name_size = 0
+    puts Rainbow(name).green + Rainbow(" < ").dimgray.faint + Rainbow(superclass.name).green.faint
+    grouped = subclasses.each_with_object({}) do |model, memo|
+      @max_name_size = model.name.size if model.name.size > @max_name_size
+      location = Object.const_source_location(model.name)
+      case location
+      when Array
+        path = location.first
+        type = "First party" if first_party?(path)
+        type = "Third party" if third_party?(path)
+        type ||= "Unknown"
+        memo[type] ||= []
+        memo[type] << {name: model.name, path: path}
+      when NilClass
+        memo["Dynamic"] ||= []
+        memo["Dynamic"] << {name: model.name, path: "defined dynamically at runtime"}
+      else
+        memo["Unknown"] ||= []
+        memo["Unknown"] << {name: model.name, path: nil}
+      end
+    end
+
+    keys = [
+      "First party",
+      "Dynamic",
+      "Third party",
+      "Unknown"
+    ]
+
+    keys.each do |key|
+      next unless grouped[key]&.any?
+      puts Rainbow("  #{key} subclasses ".ljust(35, ".")).dimgray
+      grouped[key].sort_by { |entry| entry[:name] }.each do |entry|
+        probe_subclass entry[:name], entry[:path]
+      end
+    end
+  end
+
+  private
+
+  def probe_subclass(name, path)
+    path = path.split(/\/(?=app\/models\/)/i).last if path.include?("/app/models/") && !path.include?("/ruby/gems/")
+    path = path.split(/\/(?=ruby\/gems\/)/i).last if path.include?("/ruby/gems/")
+    prefix = (@count += 1).to_s.rjust(8) + " ..."
+    puts [
+      Rainbow(prefix.to_s.ljust(prefix.size + @max_name_size - name.size, ".")).dimgray.faint,
+      Rainbow(name).mediumslateblue,
+      Rainbow("<").faint,
+      Rainbow(self.name).dimgray.faint,
+      Rainbow(path.to_s).faint
+    ].join(" ")
+  end
+
+  def third_party?(path)
+    path.include? "/ruby/gems/"
+  end
+
+  def first_party?(path)
+    return false if third_party?(path)
+    path.include? "/app/models/"
+  end
+end

data/lib/model_probe/probes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ModelProbe::Probes; end
+
+require_relative "probes/metadata"
+require_relative "probes/columns"
+require_relative "probes/indexes"
+require_relative "probes/subclasses"
+
+module ModelProbe::Probes
+  include Metadata
+  include Columns
+  include Indexes
+  include Subclasses
+
+  def probe
+    if name == "ActiveRecord::Base" || abstract_class?
+      probe_subclasses
+      return nil
+    end
+
+    probe_metadata
+    puts
+
+    puts Rainbow("  Columns ".ljust(24, ".")).darkgray
+    probe_columns
+    puts
+
+    puts Rainbow("  Indexes ".ljust(24, ".")).darkgray
+    probe_indexes
+    puts
+
+    nil
+  end
+end

data/lib/model_probe/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if Rails.env.development?
   ActiveRecord::Base.extend ModelProbe
 

data/lib/model_probe/templates/fixture.yml.erb

@@ -0,0 +1,4 @@
+<%= name.underscore %>_fixture:
+<% fixture_columns.each do |column| -%>
+  <%= column.name.underscore %>: <%= column&.default || column.type %>
+<% end -%>

data/lib/model_probe/templates/model.rb.erb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class <%= name -%> < <%= superclass_name %>
+  # extends ..................................................................................................
+
+  # includes .................................................................................................
+
+  # constants ................................................................................................
+
+  # class methods ............................................................................................
+  class << self
+  end
+
+  # relationships ............................................................................................
+<% foreign_key_columns.each do |column| -%>
+  <%= "belongs_to :#{column.name.sub(/_id\z/, "")}" %>
+<% end -%>
+
+  # validations ..............................................................................................
+<% validation_columns.each do |column| -%>
+  <%= "validates :#{column.name}, presence: true" unless column.null if required_columns.include?(column) %>
+  <%= "validates :#{column.name}, length: {maximum: #{column.limit}}" if limit_columns.include?(column) %>
+<% end -%>
+
+  # callbacks (caution: side effects) ........................................................................
+
+  # scopes (composable queries) ..............................................................................
+
+  # additional config (accepts_nested_attribute_for, etc.) ...................................................
+
+  # public instance methods ..................................................................................
+
+  # protected instance methods ...............................................................................
+
+  # private instance methods .................................................................................
+end

data/lib/model_probe/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModelProbe
-  VERSION = "1.0.7"
+  VERSION = "1.1.1"
 end

data/lib/model_probe.rb

@@ -1,114 +1,43 @@
-require "model_probe/version"
-require "model_probe/color"
-require "model_probe/railtie" if defined?(Rails)
+# frozen_string_literal: true
 
-module ModelProbe
-  include ModelProbe::Color
-
-  # Pretty prints column meta data for an ActiveModel
-  def probe
-    name_pad = columns.map { |c| c.name.length }.max + 1
-    type_pad = columns.map { |c| c.type.length }.max + 2
-    sql_type_pad = columns.map { |c| c.sql_type.length }.max + 1
+require "erb"
+require "rainbow"
+require_relative "model_probe/version"
+require_relative "model_probe/railtie" if defined?(Rails)
+require_relative "model_probe/probes"
 
-    columns.sort { |a, b| a.name <=> b.name }.map do |column|
-      name = column.name
-      name = "* #{name}" if primary_key_column?(column)
-      print yellow(name.to_s.rjust(name_pad))
-      print " "
-      print blue(column.type.to_s.ljust(type_pad, "."))
-      print magenta(column.sql_type.to_s.ljust(sql_type_pad))
-      column.null ? print(red("NULL")) : print("    ")
-      print " [#{column.default}]" if column.default
-      print " #{gray column.comment}" if column.comment
-      puts
-    end
-    nil
-  end
+module ModelProbe
+  include Probes
 
   # Prints a stub that can be used for a test fixture
   def print_fixture
-    values = columns.sort_by(&:name).each_with_object({}) do |column, memo|
-      next if primary_key_column?(column)
-      next if timestamp_column?(column)
-      memo[column.name] = column.default || "value"
-    end
-
-    hash = { self.name.underscore => values }
-    puts hash.to_yaml
+    template = erb_template("model_probe/templates/fixture.yml.erb")
+    puts template.result_with_hash(name: name, fixture_columns: fixture_columns)
     nil
   end
 
   # Prints a new model definition based on the database schema
   def print_model
-    puts "class #{name} < #{superclass.name}"
-    puts "  # extends ..................................................................."
-    puts "  # includes .................................................................."
-    puts if relation_columns.size > 0
-    puts "  # relationships ............................................................."
-    relation_columns.sort_by(&:name).each do |column|
-      next if primary_key_column?(column)
-      puts "  belongs_to :#{column.name.sub(/_id\z/, "")}" if column.name =~ /_id\z/
-    end
-    puts if relation_columns.size > 0 || validation_columns.size > 0
-    puts "  # validations ..............................................................."
-    validation_columns.sort_by(&:name).each do |column|
-      next if primary_key_column?(column)
-      puts "  validates :#{column.name}, presence: true" unless column.null
-      if %i(text string).include?(column.type) && column.limit.to_i > 0
-        puts "  validates :#{column.name}, length: { maximum: #{column.limit} }"
-      end
-    end
-    puts if validation_columns.size > 0
-    puts "  # callbacks ................................................................."
-    puts "  # scopes ...................................................................."
-    puts "  # additional config (i.e. accepts_nested_attribute_for etc...) .............."
-    puts
-    puts "  # class methods ............................................................."
-    puts "  class << self"
-    puts "  end"
-    puts
-    puts "  # public instance methods ..................................................."
-    puts
-    puts "  # protected instance methods ................................................"
-    puts "  protected"
-    puts
-    puts "  # private instance methods .................................................."
-    puts "  private"
-    puts "end"
+    template = erb_template("model_probe/templates/model.rb.erb")
+    puts template.result_with_hash(
+      name: name,
+      superclass_name: superclass.name,
+      primary_key_columns: primary_key_columns,
+      foreign_key_columns: foreign_key_columns,
+      relation_columns: relation_columns,
+      required_columns: required_columns,
+      limit_columns: limit_columns,
+      validation_columns: validation_columns
+    )
     nil
   end
 
   private
 
-    def relation_columns
-      @relation_columns ||= begin
-        columns.select { |column| relation_column? column }
-      end
-    end
-
-    def validation_columns
-      @validation_columns ||= begin
-        columns.select { |column| validation_column? column }
-      end
-    end
-
-    def primary_key_column?(column)
-      column.name == primary_key
-    end
-
-    def timestamp_column?(column)
-      column.type == :datetime && column.name =~ /(created|updated|modified)/
-    end
-
-    def relation_column?(column)
-      return false if column.name == primary_key
-      column.name.end_with?("_id")
-    end
-
-    def validation_column?(column)
-      return false if column.name == primary_key
-      return true unless column.null
-      %i(text string).include?(column.type) && column.limit.to_i > 0
-    end
+  def erb_template(relative_path)
+    template_path = File.expand_path(relative_path, __dir__)
+    template_text = File.read(template_path)
+    # trim_mode doesn't seem to work regardless of how it's passed with Ruby 2.7.5
+    ERB.new template_text, trim_mode: "-"
+  end
 end

data/lib/tasks/model_probe.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :model_probe do
   desc <<~DESC
     Probe. Usage: `rails model:probe[User]`

data/model_probe.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "lib/model_probe/version"
+
+Gem::Specification.new do |s|
+  s.name = "model_probe"
+  s.version = ModelProbe::VERSION
+  s.authors = ["Nathan Hopkins"]
+  s.email = ["natehop@gmail.com"]
+  s.summary = "ActiveRecord schema visualization and model organization made easy"
+  s.homepage = "http://hopsoft.github.com/model_probe/"
+
+  s.files = Dir["lib/**/*rb", "lib/tasks/*rake", "[A-Z]*"]
+
+  s.add_dependency "rainbow"
+
+  s.add_development_dependency "magic_frozen_string_literal"
+  s.add_development_dependency "standardrb"
+end

data/tags

@@ -0,0 +1,111 @@
+!_TAG_EXTRA_DESCRIPTION	anonymous	/Include tags for non-named objects like lambda/
+!_TAG_EXTRA_DESCRIPTION	fileScope	/Include tags of file scope/
+!_TAG_EXTRA_DESCRIPTION	pseudo	/Include pseudo tags/
+!_TAG_EXTRA_DESCRIPTION	subparser	/Include tags generated by subparsers/
+!_TAG_FIELD_DESCRIPTION	epoch	/the last modified time of the input file (only for F\/file kind tag)/
+!_TAG_FIELD_DESCRIPTION	file	/File-restricted scoping/
+!_TAG_FIELD_DESCRIPTION	input	/input file/
+!_TAG_FIELD_DESCRIPTION	name	/tag name/
+!_TAG_FIELD_DESCRIPTION	pattern	/pattern/
+!_TAG_FIELD_DESCRIPTION	typeref	/Type and name of a variable or typedef/
+!_TAG_FIELD_DESCRIPTION!Ruby	mixin	/how the class or module is mixed in (mixin:HOW:MODULE)/
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_KIND_DESCRIPTION!GemSpec	g,gem	/gems/
+!_TAG_KIND_DESCRIPTION!Markdown	S,subsection	/level 2 sections/
+!_TAG_KIND_DESCRIPTION!Markdown	T,l4subsection	/level 4 sections/
+!_TAG_KIND_DESCRIPTION!Markdown	c,chapter	/chapters/
+!_TAG_KIND_DESCRIPTION!Markdown	n,footnote	/footnotes/
+!_TAG_KIND_DESCRIPTION!Markdown	s,section	/sections/
+!_TAG_KIND_DESCRIPTION!Markdown	t,subsubsection	/level 3 sections/
+!_TAG_KIND_DESCRIPTION!Markdown	u,l5subsection	/level 5 sections/
+!_TAG_KIND_DESCRIPTION!Rake	d,directory	/directory tasks/
+!_TAG_KIND_DESCRIPTION!Rake	f,File	/file tasks/
+!_TAG_KIND_DESCRIPTION!Rake	m,multitask	/multi tasks/
+!_TAG_KIND_DESCRIPTION!Rake	n,namespace	/namespaces/
+!_TAG_KIND_DESCRIPTION!Rake	t,task	/tasks/
+!_TAG_KIND_DESCRIPTION!Rake	x,xtask	/tasks defined with special constructor/
+!_TAG_KIND_DESCRIPTION!Ruby	A,accessor	/accessors/
+!_TAG_KIND_DESCRIPTION!Ruby	C,constant	/constants/
+!_TAG_KIND_DESCRIPTION!Ruby	L,library	/libraries/
+!_TAG_KIND_DESCRIPTION!Ruby	S,singletonMethod	/singleton methods/
+!_TAG_KIND_DESCRIPTION!Ruby	a,alias	/aliases/
+!_TAG_KIND_DESCRIPTION!Ruby	c,class	/classes/
+!_TAG_KIND_DESCRIPTION!Ruby	f,method	/methods/
+!_TAG_KIND_DESCRIPTION!Ruby	m,module	/modules/
+!_TAG_KIND_DESCRIPTION!Sh	a,alias	/aliases/
+!_TAG_KIND_DESCRIPTION!Sh	f,function	/functions/
+!_TAG_KIND_DESCRIPTION!Sh	h,heredoc	/label for here document/
+!_TAG_KIND_DESCRIPTION!Sh	s,script	/script files/
+!_TAG_OUTPUT_EXCMD	mixed	/number, pattern, mixed, or combineV2/
+!_TAG_OUTPUT_FILESEP	slash	/slash or backslash/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
+!_TAG_OUTPUT_VERSION	0.0	/current.age/
+!_TAG_PARSER_VERSION!GemSpec	0.0	/current.age/
+!_TAG_PARSER_VERSION!Markdown	0.0	/current.age/
+!_TAG_PARSER_VERSION!Rake	0.0	/current.age/
+!_TAG_PARSER_VERSION!Ruby	0.0	/current.age/
+!_TAG_PARSER_VERSION!Sh	0.0	/current.age/
+!_TAG_PATTERN_LENGTH_LIMIT	96	/0 for no limit/
+!_TAG_PROC_CWD	/Users/nate.hopkins/work/hopsoft/model_probe/	//
+!_TAG_PROGRAM_AUTHOR	Universal Ctags Team	//
+!_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
+!_TAG_PROGRAM_URL	https://ctags.io/	/official site/
+!_TAG_PROGRAM_VERSION	6.0.0	//
+!_TAG_ROLE_DESCRIPTION!GemSpec!gem	develDep	/specifying development dependency/
+!_TAG_ROLE_DESCRIPTION!GemSpec!gem	runtimeDep	/specifying runtime dependency/
+!_TAG_ROLE_DESCRIPTION!Ruby!library	loaded	/loaded by "load" method/
+!_TAG_ROLE_DESCRIPTION!Ruby!library	required	/loaded by "require" method/
+!_TAG_ROLE_DESCRIPTION!Ruby!library	requiredRel	/loaded by "require_relative" method/
+!_TAG_ROLE_DESCRIPTION!Sh!heredoc	endmarker	/end marker/
+!_TAG_ROLE_DESCRIPTION!Sh!script	loaded	/loaded/
+ActiveRecord schema visualization and model organization made easy 🙌	README.md	/^## ActiveRecord schema visualization and model organization made easy 🙌$/;"	s	chapter:ModelProbe
+Columns	lib/model_probe/probes/columns.rb	/^module ModelProbe::Probes::Columns$/;"	m	module:ModelProbe.Probes
+Indexes	lib/model_probe/probes/indexes.rb	/^module ModelProbe::Probes::Indexes$/;"	m	module:ModelProbe.Probes
+Metadata	lib/model_probe/probes/metadata.rb	/^module ModelProbe::Probes::Metadata$/;"	m	module:ModelProbe.Probes
+ModelProbe	README.md	/^# ModelProbe$/;"	c
+ModelProbe	lib/model_probe.rb	/^module ModelProbe$/;"	m	mixin:include:Probes
+ModelProbe	lib/model_probe/railtie.rb	/^  module ModelProbe$/;"	m
+ModelProbe	lib/model_probe/version.rb	/^module ModelProbe$/;"	m
+Probes	lib/model_probe/probes.rb	/^module ModelProbe::Probes$/;"	m	module:ModelProbe	mixin:include:Metadata,include:Columns,include:Indexes,include:Subclasses
+Probes	lib/model_probe/probes.rb	/^module ModelProbe::Probes; end$/;"	m	module:ModelProbe
+Quick Start	README.md	/^## Quick Start$/;"	s	chapter:ModelProbe
+Railtie	lib/model_probe/railtie.rb	/^    class Railtie < Rails::Railtie$/;"	c	module:ModelProbe
+Screenshots	README.md	/^## Screenshots$/;"	s	chapter:ModelProbe
+Subclasses	lib/model_probe/probes/subclasses.rb	/^module ModelProbe::Probes::Subclasses$/;"	m	module:ModelProbe.Probes
+Supported Databases	README.md	/^## Supported Databases$/;"	s	chapter:ModelProbe
+Table of Contents	README.md	/^## Table of Contents$/;"	s	chapter:ModelProbe
+VERSION	lib/model_probe/version.rb	/^  VERSION = "1.1.1"$/;"	C	module:ModelProbe
+Videos	README.md	/^## Videos$/;"	s	chapter:ModelProbe
+ddl	lib/model_probe/probes/metadata.rb	/^  def ddl$/;"	f	module:Metadata
+erb_template	lib/model_probe.rb	/^  def erb_template(relative_path)$/;"	f	module:ModelProbe
+first_party?	lib/model_probe/probes/subclasses.rb	/^  def first_party?(path)$/;"	f	module:Subclasses
+fixture_columns	lib/model_probe/probes/columns.rb	/^  def fixture_columns$/;"	f	module:Columns
+foreign_key_column?	lib/model_probe/probes/columns.rb	/^  def foreign_key_column?(column)$/;"	f	module:Columns
+foreign_key_columns	lib/model_probe/probes/columns.rb	/^  def foreign_key_columns$/;"	f	module:Columns
+limit_column?	lib/model_probe/probes/columns.rb	/^  def limit_column?(column)$/;"	f	module:Columns
+limit_columns	lib/model_probe/probes/columns.rb	/^  def limit_columns$/;"	f	module:Columns
+model_probe	lib/tasks/model_probe.rake	/^namespace :model_probe do$/;"	n
+model_probe	model_probe.gemspec	/^  s.name = "model_probe"$/;"	g
+primary_key_column?	lib/model_probe/probes/columns.rb	/^  def primary_key_column?(column)$/;"	f	module:Columns
+primary_key_columns	lib/model_probe/probes/columns.rb	/^  def primary_key_columns$/;"	f	module:Columns
+print_fixture	lib/model_probe.rb	/^  def print_fixture$/;"	f	module:ModelProbe
+print_fixture	lib/tasks/model_probe.rake	/^  task :print_fixture, [:klass] => :environment do |task, args|$/;"	t	namespace:model_probe
+print_model	lib/model_probe.rb	/^  def print_model$/;"	f	module:ModelProbe
+print_model	lib/tasks/model_probe.rake	/^  task :print_model, [:klass] => :environment do |task, args|$/;"	t	namespace:model_probe
+probe	lib/model_probe/probes.rb	/^  def probe$/;"	f	module:Probes
+probe	lib/tasks/model_probe.rake	/^  task :probe, [:klass] => :environment do |task, args|$/;"	t	namespace:model_probe
+probe_column	lib/model_probe/probes/columns.rb	/^  def probe_column(column, name_pad:, type_pad:, sql_type_pad:)$/;"	f	module:Columns
+probe_columns	lib/model_probe/probes/columns.rb	/^  def probe_columns$/;"	f	module:Columns
+probe_index	lib/model_probe/probes/indexes.rb	/^  def probe_index(index, name_pad:)$/;"	f	module:Indexes
+probe_indexes	lib/model_probe/probes/indexes.rb	/^  def probe_indexes$/;"	f	module:Indexes
+probe_metadata	lib/model_probe/probes/metadata.rb	/^  def probe_metadata$/;"	f	module:Metadata
+probe_subclass	lib/model_probe/probes/subclasses.rb	/^  def probe_subclass(name, path)$/;"	f	module:Subclasses
+probe_subclasses	lib/model_probe/probes/subclasses.rb	/^  def probe_subclasses$/;"	f	module:Subclasses
+relation_column?	lib/model_probe/probes/columns.rb	/^  def relation_column?(column)$/;"	f	module:Columns
+relation_columns	lib/model_probe/probes/columns.rb	/^  def relation_columns$/;"	f	module:Columns
+required_column?	lib/model_probe/probes/columns.rb	/^  def required_column?(column)$/;"	f	module:Columns
+required_columns	lib/model_probe/probes/columns.rb	/^  def required_columns$/;"	f	module:Columns
+third_party?	lib/model_probe/probes/subclasses.rb	/^  def third_party?(path)$/;"	f	module:Subclasses
+timestamp_column?	lib/model_probe/probes/columns.rb	/^  def timestamp_column?(column)$/;"	f	module:Columns
+validation_columns	lib/model_probe/probes/columns.rb	/^  def validation_columns$/;"	f	module:Columns

metadata

@@ -1,17 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: model_probe
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.1
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-12 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: magic_frozen_string_literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -37,10 +65,18 @@ files:
 - README.md
 - Rakefile
 - lib/model_probe.rb
-- lib/model_probe/color.rb
+- lib/model_probe/probes.rb
+- lib/model_probe/probes/columns.rb
+- lib/model_probe/probes/indexes.rb
+- lib/model_probe/probes/metadata.rb
+- lib/model_probe/probes/subclasses.rb
 - lib/model_probe/railtie.rb
+- lib/model_probe/templates/fixture.yml.erb
+- lib/model_probe/templates/model.rb.erb
 - lib/model_probe/version.rb
 - lib/tasks/model_probe.rake
+- model_probe.gemspec
+- tags
 homepage: http://hopsoft.github.com/model_probe/
 licenses: []
 metadata: {}
@@ -59,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Schema introspection for ActiveModel
+summary: ActiveRecord schema visualization and model organization made easy
 test_files: []

data/lib/model_probe/color.rb

@@ -1,22 +0,0 @@
-module ModelProbe
-  module Color
-    extend self
-
-    colors = {
-      :gray    => "1;30",
-      :red     => 31,
-      :green   => 32,
-      :yellow  => 33,
-      :blue    => 34,
-      :magenta => 35,
-      :cyan    => 36,
-      :white   => 37
-    }
-
-    colors.each do |name, code|
-      define_method name do |text|
-      "\e[#{code}m#{text}\e[0m"
-      end
-    end
-  end
-end