table_inspector 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 501b198b975a552496604e4342afac6e837423ca04487327a9a7354c72f9ba36
-  data.tar.gz: 04d8de8b58039d17d8e5229cfab6b766776c099ce5ef0d39f22cfbba8ffab09a
+  metadata.gz: 83143bbf7fb6d4ce752da10da85b265037f75fad9417f104ab761660d638db1b
+  data.tar.gz: 6268b3194f9eef7ec25c830cae63cad79d0fa29ed8b98f27c77049b450d31def
 SHA512:
-  metadata.gz: baaf7974ceeb46d135c2d611b7397669b13081e3d29e15d5a5703b080e97f9380f29b599ab6119f6e5f7e4da3eead47201e5cd7a5532993358c8565e9afa8ec4
-  data.tar.gz: 30175fa53056aaa4716aabd45085b0f84d05cc5f68f746828dd8b06c082565799bfc1bdeec962ad77e3756de883a2d4fc9c6190b104cd2f4508d0ef43d7d60ab
+  metadata.gz: 5e5df809d52919113556d0048e91e633663bcba444b4d2cff13919bb0670f01a51a9460de7789ef556f661c5fc25aa213eff3fb38547a0566331300cd17dd5f4
+  data.tar.gz: a137cf1372c765da06bcfc459f4ab0d5b7f9e09f947bbaa0908c560f8cbea24e3e6ab45a5dad043527e7b6f57328d4541876f1acae10394faf2d5435888bf344

data/README.md

@@ -1,7 +1,5 @@
 # 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, 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.
+This is a Rails gem that allows you to print the definition of a table. While some gems (like [annotate_models](https://github.com/ctran/annotate_models)) are used to embed the table schema in the model file, they can be difficult to maintain and add unnecessary noise. This gem provides an alternative way to check the schema of a table without using `annotate_models`.
 
 ## Usage
 Assuming there is a model call `User` which has `id` and `name` column, and has a unique index for `name`.
@@ -12,7 +10,7 @@ require "table_inspector"
 TableInspector.scan User
 ```
 
-![TableInspect scan table](/img/table_inspector_scan_table_2.png)
+![TableInspect scan table](/img/table_inspector_scan_table_3.png)
 
 It will print the all table definition and all indexes.
 
@@ -20,14 +18,14 @@ Or you can use `TableInspector.ascan` to print more colorful table(`ascan` means
 ```ruby
 TableInspector.ascan User
 ```
-![TableInspect ascan table](/img/table_inspector_ascan_table_2.png)
+![TableInspect ascan table](/img/table_inspector_ascan_table_3.png)
 
 And to print a specific column by:
 
 ```ruby
 TableInspector.scan User, :name
 ```
-![Table Inspector scan column](/img/table_inspector_scan_column_2.png)
+![Table Inspector scan column](/img/table_inspector_scan_column_3.png)
 
 It will print the column definition and which indexes that contains this column.
 
@@ -36,7 +34,7 @@ Also, you can print `sql_type` which type of column in database by provide `sql_
 ```ruby
 TableInspector.scan User, sql_type: true
 ```
-![Table Inspector scan table column with sql type](/img/table_inspector_scan_table_with_sql_type_2.png)
+![Table Inspector scan table column with sql type](/img/table_inspector_scan_table_with_sql_type_3.png)
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/table_inspector/column.rb

@@ -7,6 +7,7 @@ module TableInspector
       @column = klass.columns.find {|column| column.name == column_name.to_s}
       @klass = klass
       @sql_type = sql_type
+      @colorize = colorize
       @presenter = Presenter.new(klass, sql_type: sql_type, colorize: colorize)
     end
 
@@ -15,7 +16,7 @@ module TableInspector
       render_title
       render_body
       Text.break_line
-      Indexes.new(klass, column.name).render
+      Indexes.new(klass, column.name, colorize: @colorize).render
       Text.break_line
     end
 

data/lib/table_inspector/indexes.rb

@@ -3,9 +3,10 @@ module TableInspector
   class Indexes
     attr_reader :klass, :column_name
 
-    def initialize(klass, column_name = nil)
+    def initialize(klass, column_name = nil, colorize: false)
       @klass = klass
       @column_name = column_name
+      @colorize = colorize
     end
 
     def render
@@ -43,6 +44,22 @@ module TableInspector
     end
 
     def compose_index_data(index)
+      if @colorize
+        compose_index_data_with_highlight(index)
+      else
+        compose_index_data_without_highlight(index)
+      end
+    end
+
+    def compose_index_data_with_highlight(index)
+      [
+        index.name,
+        "[#{Text.yellow(index.columns.join(', '))}]",
+        index.unique ? "UNIQUE" : ""
+      ]
+    end
+
+    def compose_index_data_without_highlight(index)
       [
         index.name,
         "[#{index.columns.join(', ')}]",
@@ -59,7 +76,7 @@ module TableInspector
     end
 
     def indexes_with_specific_column
-      indexes.select{|index| index.columns.include?(column_name) }
+      indexes.select{|index| index.columns.include?(column_name.to_s) }
     end
 
     def connection

data/lib/table_inspector/presenter.rb

@@ -25,7 +25,7 @@ module TableInspector
     private
 
     def extract_meta_with_highlight(column)
-      column_data = column.as_json.merge(column.sql_type_metadata.as_json)
+      column_data = extract_meta_without_highlight(column)
 
       # Colorize text but except "comment" field
       column_data.each do |k, v|
@@ -40,7 +40,11 @@ module TableInspector
     end
 
     def extract_meta_without_highlight(column)
-      column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys)
+      column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys).tap do |column_data|
+        if column_data["default"] == ""
+          column_data["default"] = column_data["default"].inspect
+        end
+      end
     end
 
     def ordered_keys

data/lib/table_inspector/table.rb

@@ -7,6 +7,7 @@ module TableInspector
       @klass = klass
       @sql_type = sql_type
       @presenter = Presenter.new(klass, sql_type: sql_type, colorize: colorize)
+      @colorize = colorize
     end
 
     def render
@@ -35,7 +36,7 @@ module TableInspector
     end
 
     def render_indexes
-      Indexes.new(klass).render
+      Indexes.new(klass, colorize: @colorize).render
     end
   end
 end

data/lib/table_inspector/version.rb

@@ -1,3 +1,3 @@
 module TableInspector
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_inspector
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Inspect table structure of ActiveRecord class