model_probe 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87ab415eaa252a11811f0502ae31564a3b3346ef
-  data.tar.gz: 1267d9c94f1ff29e07706cf62a897a5c5608fc49
+  metadata.gz: 256df9f2a0d516dc276210959300379bdf59a743
+  data.tar.gz: ec8afcc2bafbf1d2bf86ef0c2529bf0cc4c78316
 SHA512:
-  metadata.gz: 0dcc0b484c372dd23e761200acf7bde44a35fdf1997c11ffe5ec1af5170995e3a7e073b2243174cd1bc50566e061f874012347662c337729c3f3e7b4e3e06ee8
-  data.tar.gz: 96a3d8ecb8ddc01e5b3b706de0c406a82d0f8df0e125f2054e8a8e13ec2e95ee24ccff0b361763c6420ee85f78bc9e463a14010b8a2c17a1446de3a1cbd92ded
+  metadata.gz: 156afe3b29d19de7bda2b5ade402b84827f250e2285ad02f23f2808e1122f88aafc8611f5d3dda292bed8de34127bbedc30e0de78d0c50a17099afa47ee3eba6
+  data.tar.gz: a0d678decaac686cfb1d234436f2504be0b2d54d67f4343d551771e34c19baa0904b41784be02acaf7d519d8322a15ddc61321130a4db7c729f115f3aea2cc05

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    model_probe (1.0.6)
+    model_probe (1.0.7)
 
 GEM
   remote: https://rubygems.org/
@@ -16,4 +16,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   1.13.6
+   1.16.0

data/README.md

@@ -1,5 +1,9 @@
 # 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.
@@ -28,3 +32,109 @@ 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
+```

data/lib/model_probe.rb

@@ -1,16 +1,17 @@
 require "model_probe/version"
 require "model_probe/color"
+require "model_probe/railtie" if defined?(Rails)
 
 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
+    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
 
-    columns.sort{ |a, b| a.name <=> b.name }.map do |column|
+    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))
@@ -80,34 +81,34 @@ module ModelProbe
 
   private
 
-  def relation_columns
-    @relation_columns ||= begin
-      columns.select { |column| relation_column? column }
+    def relation_columns
+      @relation_columns ||= begin
+        columns.select { |column| relation_column? column }
+      end
     end
-  end
 
-  def validation_columns
-    @validation_columns ||= begin
-      columns.select { |column| validation_column? column }
+    def validation_columns
+      @validation_columns ||= begin
+        columns.select { |column| validation_column? column }
+      end
     end
-  end
 
-  def primary_key_column?(column)
-    column.name == primary_key
-  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 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 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 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
 end

data/lib/model_probe/railtie.rb

@@ -0,0 +1,11 @@
+if Rails.env.development?
+  ActiveRecord::Base.extend ModelProbe
+
+  module ModelProbe
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "tasks/model_probe.rake"
+      end
+    end
+  end
+end

data/lib/model_probe/version.rb

@@ -1,3 +1,3 @@
 module ModelProbe
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/lib/tasks/model_probe.rake

@@ -0,0 +1,22 @@
+namespace :model_probe do
+  desc <<~DESC
+    Probe. Usage: `rails model:probe[User]`
+  DESC
+  task :probe, [:klass] => :environment do |task, args|
+    puts args.klass.constantize.probe
+  end
+
+  desc <<~DESC
+    Print fixture. Usage: `rails model:print_fixture[User]`
+  DESC
+  task :print_fixture, [:klass] => :environment do |task, args|
+    puts args.klass.constantize.print_fixture
+  end
+
+  desc <<~DESC
+    Print model. Usage: `rails model:print_model[User]`
+  DESC
+  task :print_model, [:klass] => :environment do |task, args|
+    puts args.klass.constantize.print_model
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_probe
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-30 00:00:00.000000000 Z
+date: 2017-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,7 +38,9 @@ files:
 - Rakefile
 - lib/model_probe.rb
 - lib/model_probe/color.rb
+- lib/model_probe/railtie.rb
 - lib/model_probe/version.rb
+- lib/tasks/model_probe.rake
 homepage: http://hopsoft.github.com/model_probe/
 licenses: []
 metadata: {}
@@ -58,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Schema introspection for ActiveModel