table_inspector 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38e7941896785704a1baec51bb5f4a76b9ed699ad2957b796797739b08d5169a
-  data.tar.gz: 32ab18e8189f664e8928f42050a14daa19f467b6a2de15db95d1de7a3b04771b
+  metadata.gz: 9658ef637dc9ee281cfc80f5480949dc522aa16c1c0b9c1ea61310058f9fb62d
+  data.tar.gz: 2460f6b96e97c20bc81bcd61dfe3ed021e5c0e1a4efec47ef1a0ebd17176ebb5
 SHA512:
-  metadata.gz: e5cd066d6abc3300397f72caeb5239313db2a0981c5b0b4b72ab8abd2f030b151208a96100cb36266b3e36a0a49c8ba3470047c8820e0b2c324405d6ebbbe175
-  data.tar.gz: 7f9abe964be15dccec104bc094a8c6e8b7a296d3a61cfe3831f8382d49b986c67c1a10cde3f971cec276805e784c419f19c95316c705eec639e46baffd8ddc11
+  metadata.gz: c26c6a0458ed9fdda4430d645af95891acb2604e731fcd846c17024377bba51fc2fa7044210867596811a8062fe11ddfa7f467f59f1777a366dbe72e538ded7a
+  data.tar.gz: 83ef3ead19f01b223a6f52dd9bf06c2d2e961f28ca0c8aa794f5374e4a82ed84f2e8f58962cdcd99687f37705bf2edd0dad927312bb3bc5c756bb3645aa820bb

data/README.md

@@ -1,22 +1,24 @@
 # TableInspector
 This is a rails gem for print the definition of table. Sometimes we use some gems to embed the table schema to model file(like `annotate`).
-but sometimes it is hard to maintain. Cause we may just want to see the definition once, and it always in the model file.
+but sometimes it is hard to maintain, and it has a little noise. I want to find another way to check the schema of table instead of 
+using `annotate`, So I wrote this gem to do this.
 
 ## Usage
 Assuming there is a model is called User which has `id` and `name` column. For print the definition of User, we can use: 
-
 ```ruby
 require "table_inspector"
 
 TableInspector.scan User
 ```
 
+![TableInspect scan table](img/table_inspector_scan_table.png)
+
 And to print specific column by:
 
 ```ruby
 TableInspector.scan User, :name
 ```
-
+![Table Inspector scan column](img/table_inspector_scan_column.png)
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/table_inspector/version.rb

@@ -1,3 +1,3 @@
 module TableInspector
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/table_inspector.rb

@@ -7,60 +7,67 @@ module TableInspector
 
   extend self
   
-  def scan(klass, column_name = nil)
+  def scan(klass, column_name = nil, sql_type: false)
     begin
       unless klass.is_a?(Class)
         klass = klass.constantize
       end
-    rescue NameError => e
+    rescue NameError
       raise_invalid_model_error!
     end
 
     raise_invalid_model_error! unless klass < ActiveRecord::Base
 
     if column_name
-      scan_column(klass, column_name)
+      scan_column(klass, column_name, sql_type: sql_type)
     else
-      scan_table(klass)
+      scan_table(klass, sql_type: sql_type)
     end
   end
   
   private
 
-  def scan_column(klass, col_name)
+  def scan_column(klass, col_name, sql_type: false)
     columns = klass.columns
     column = columns.find{|col| col.name == col_name.to_s}
 
     raise_column_not_found_error! unless column
 
-    meta = extract_meta(column)
+    meta = extract_meta(column, sql_type: sql_type)
     header = meta.keys.map(&:upcase_first)
 
     table = TTY::Table.new(header: header)
-    table << extract_meta(column).values
+    table << extract_meta(column, sql_type: sql_type).values
 
     puts table.render(:ascii)
   end
 
-  def scan_table(klass)
+  def scan_table(klass, sql_type: false )
     columns = klass.columns
-    first_column_meta = extract_meta(columns.first)
-    header = first_column_meta.keys.map(&:upcase_first)
+    first_column_meta = extract_meta(columns.first, sql_type: sql_type)
+    header = first_column_meta.keys.map(&:humanize)
     table = TTY::Table.new(header: header)
 
     columns.each do |column|
-      table << extract_meta(column).values
+      table << extract_meta(column, sql_type: sql_type).values
     end
 
+    puts "\n"
+    puts "#{bold("Table")}: #{klass.table_name}"
+    puts "\n"
     puts table.render(:ascii)
+    puts "\n"
+    print_indexes(klass)
   end
 
-  def extract_meta(column)
-    column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys)
+  def extract_meta(column, sql_type: false)
+    column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys(sql_type: sql_type))
   end
 
-  def ordered_keys
-    %w[ name type limit null default precision scale comment]
+  def ordered_keys(sql_type: false)
+    %w[ name type limit null default precision scale comment].tap do |keys|
+      keys << "sql_type" if sql_type
+    end
   end
 
   def raise_invalid_model_error!
@@ -70,4 +77,33 @@ module TableInspector
   def raise_column_not_found_error!
     raise Error, "Column not found!"
   end
+
+  def list_indexes(klass)
+    table_name = klass.table_name
+    connection.indexes(table_name)
+  end
+
+  def print_indexes(klass)
+    table = TTY::Table.new
+    indexes = list_indexes(klass)
+    indexes.each do |index|
+      table << [
+        index.name,
+        "[#{index.columns.join(', ')}]",
+        index.unique ? "UNIQUE" : ""
+      ]
+    end
+
+    puts bold("Indexes")
+    puts "\n"
+    puts table.render
+  end
+
+  def connection
+    @_connection ||= ActiveRecord::Base.connection
+  end
+
+  def bold(str)
+    "\033[1m#{str}\033[0m"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_inspector
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails