table_inspector 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7b361cd6519e4f22acd13f7414daa56d361f83b2bc742679fd7413bc3a3e9d3
-  data.tar.gz: efebb7e0def5dc75c974a06d7504efaa462068d009438885c16d9a0e6ed73ba1
+  metadata.gz: ce96fede5dc61b809184ab371402e7972da49f1fc1708529bf7c38751fc1b595
+  data.tar.gz: 9318bbdcfc07d9e5af604bdcf98a1078cada3731136cd259b16ca78e5fbd22fd
 SHA512:
-  metadata.gz: cfb17c67a0091dbaccbad92a638bd22de4f7361458baf0bcc25902ce97709d6d15b69d7e01ec51112d5b649f2d89e1c24e762ce3dd2d536055ad9d1b8ab15fe8
-  data.tar.gz: dd4b194ebf0c45c0b76c18b447ca77460fc84cc74343673cfe250a561e381efc8bccabd4628ec46c2a42262745e7485d8861c498be8f81f2b2cff82d332bc6f4
+  metadata.gz: a127d351bc28568ceb50173324092b43d04289bfe0e3af625b304a2208697ea734437db2fc9be9bc6f296eb3db2e3f227e7eccadaef1a7850d3ed5f6c0d84a2a
+  data.tar.gz: cc0119437824fbd9be0f0ec80756ffd59339db0143167295943f109b91d0585306f7bcd192fe844176e657db5927d9bf07819f5359004d3f60dbf1238e9f65d8

data/README.md

@@ -1,5 +1,5 @@
 # TableInspector
-![Test coverage](https://img.shields.io/badge/Test_coverage-99.65-green)
+![Test coverage](https://img.shields.io/badge/Test_coverage-96.71%25-green)
 ![Release version](https://img.shields.io/badge/Release-v0.6.0-green)
 ![Workflow badge](https://github.com/otorain/table_inspector/actions/workflows/run_test.yml/badge.svg)
 
@@ -30,18 +30,15 @@ $ gem install table_inspector
 Assuming there is a model call `User` which has `id` and `name` column, and has a unique index for `name`.
 For print the table structure of User, we can use: 
 ```ruby
-require "table_inspector"
-
 TableInspector.scan User
 ```
 
 ![TableInspect scan table](/img/table_inspector_scan_table_3.png)
 
-It will print the scheme of table and indexes. 
-(If the table content is too long, It may be printed messy. You can adjust the scaling of the terminal window to fix it. 
-Alternatively, you can use `TableInspector.scan(User, :name)` to print a specific column)
+This will print the scheme of table and indexes. 
+If the table content is too long and appears messy, you can adjust the scaling of the terminal window or use the `TableInspector.scan(User, :name)` syntax to print a specific column. 
 
-Or you can use `TableInspector.ascan` to print more colorful table(`ascan` means `awesome scan`) :
+Alternatively, you can use `TableInspector.ascan` to print a more colorful table(`ascan` means `awesome scan`) :
 ```ruby
 TableInspector.ascan User
 ```
@@ -56,19 +53,25 @@ TableInspector.scan User, :name
 
 It will print the column definition and which indexes that contains this column.
 
-**It is recommended to include `TableInspector::Inspectable` in `app/models/application_record.rb` and use `ti` or `ati` method to print the table definition: **
+If you are using Ruby version 2.7.0 or later, you can define a helper method directly in the model itself by editing the `app/models/application_record.rb` file and adding the code provided below:
 ```ruby
 # app/models/application_record.rb
 class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-  
-  # Add this line
-  include TableInspector::Inspectable
+  # ...
 
+  def self.ti(...)
+    TableInspector.scan(self, ...) if const_defined?("TableInspector")
+  end
+
+  def self.ati(...)
+    TableInspector.ascan(self, ...) if const_defined?("TableInspector")
+  end
+  
   # ...
 end
 ```
-and call:
+Then you will be able to achieve the same effect as `scan` and `ascan` do by invoking `ti` and `ati` on the model class:
+
 ```ruby
 # Same as TableInspector.scan User
 User.ti
@@ -76,7 +79,6 @@ User.ti
 # Same as TableInspector.ascan User
 User.ati
 ```
-The module `TableInspector::Inspectable` only defines two class methods: `ti` and `ati`, which delegate to `TableInspector.scan` and `TableInspector.ascan` respectively.
 
 You can print the database column type by providing the `sql_type: true` option:
 ```ruby
@@ -86,7 +88,7 @@ TableInspector.scan User, sql_type: true
 ```
 ![Table Inspector scan table column with sql type](/img/table_inspector_scan_table_with_sql_type_3.png)
 
-To print comment column only for the table, use `comment_only: true` option:
+Additionally, if you want to print the comments associated with the columns of the table, you can use the `comment_only` option:
 ```ruby
 User.ti comment_only: true
 # or
@@ -96,7 +98,7 @@ TableInspector.scan User, comment_only: true
 If the `sql_type: true` option is also provided, the sql_type option will be omitted.
 
 ## Style
-You can change the style of the table by setting the `TableInspector.style` in `config/initalizers/table_inspector.rb`(create it if not exists): 
+To change the style of the table by setting the `TableInspector.style` in `config/initializers/table_inspector.rb`(create it if not exists): 
 ```ruby
 # config/initializers/table_inspector.rb
 

data/lib/table_inspector/column.rb

@@ -7,7 +7,7 @@ module TableInspector
     def initialize(klass, column_name, presenter_option)
       @column = klass.columns.find { |column| column.name == column_name.to_s }
       @klass = klass
-      @presenter = Presenter.new(klass, presenter_option)
+      @presenter = Presenter.current.new(klass, presenter_option)
     end
 
     def render

data/lib/table_inspector/presenter/mysql2.rb

@@ -0,0 +1,14 @@
+class TableInspector::Presenter::Mysql2 < TableInspector::Presenter
+  def extract_meta_without_highlight(column)
+    column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys).tap do |column_data|
+      column_data["default"] = case column_data["type"]
+                               when "string"
+                                 column_data["default"]&.inspect
+                               when "boolean"
+                                 { "1" => true, "0" => false }[column_data["default"]]
+                               else
+                                 column_data["default"]
+                               end
+    end
+  end
+end

data/lib/table_inspector/presenter/postgresql.rb

@@ -0,0 +1,15 @@
+
+class TableInspector::Presenter::Postgresql < TableInspector::Presenter
+  def extract_meta_without_highlight(column)
+    column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys).tap do |column_data|
+      column_data["default"] = case column_data["type"]
+                               when "string"
+                                 column_data["default"]&.inspect
+                               when "boolean"
+                                 { "true" => true, "false" => false }[column_data["default"]]
+                               else
+                                 column_data["default"]
+                               end
+    end
+  end
+end

data/lib/table_inspector/presenter/sqlite3.rb

@@ -0,0 +1,15 @@
+class TableInspector::Presenter::Sqlite3 < TableInspector::Presenter
+
+  def extract_meta_without_highlight(column)
+    column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys).tap do |column_data|
+      column_data["default"] = case column_data["type"]
+                               when "string"
+                                 column_data["default"]&.inspect
+                               when "boolean"
+                                 { "1" => true, "0" => false }[column_data["default"]]
+                               else
+                                 column_data["default"]
+                               end
+    end
+  end
+end

data/lib/table_inspector/presenter.rb

@@ -21,31 +21,44 @@ module TableInspector
       ordered_keys.map(&:humanize)
     end
 
+    def self.current
+      adapter = ApplicationRecord.connection_db_config.adapter.camelize
+      available_presenter = %w[Mysql2 Postgresql Sqlite3]
+
+      if available_presenter.include?(adapter)
+        "TableInspector::Presenter::#{adapter}".constantize
+      else
+        TableInspector::Presenter
+      end
+    end
+
     private
 
+    def extract_meta_without_highlight(column)
+      column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys).tap do |column_data|
+        column_data["default"] = if column_data["type"] == "string"
+                                   column_data["default"]&.inspect
+                                 else
+                                   column_data["default"]
+                                 end
+      end
+    end
+
     def extract_meta_with_highlight(column)
       column_data = extract_meta_without_highlight(column)
 
-      # Colorize text but except "comment" field
-      column_data.each do |k, v|
-        if k != "comment"
-          column_data[k] = colorize(v)
+      # Colorize text except comment
+      column_data.except("comment").each do |k, v|
+        if k == "default"
+          column_data[k] = colorize(v, column.type)
         else
-          column_data[k]
+          column_data[k] = colorize(v)
         end
       end
 
       column_data.slice(*ordered_keys)
     end
 
-    def extract_meta_without_highlight(column)
-      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
       if option.comment_only
         %w[name comment]
@@ -56,7 +69,30 @@ module TableInspector
       end
     end
 
-    def colorize(value)
+    def colorize(value, type = nil)
+      if type
+        colorize_by_type(value, type)
+      else
+        colorize_by_value(value)
+      end
+    end
+
+    def colorize_by_type(value, type)
+      case type
+      when :datetime
+        green(value)
+      when :boolean
+        value ? green(value) : red(value)
+      when :integer, :decimal
+        blue(value)
+      when :string, :json, :jsonb
+        yellow(value)
+      else
+        value
+      end
+    end
+
+    def colorize_by_value(value)
       case value
       when TrueClass, DateTime, 'datetime'
         green(value)

data/lib/table_inspector/table.rb

@@ -6,7 +6,7 @@ module TableInspector
 
     def initialize(klass, presenter_option)
       @klass = klass
-      @presenter = Presenter.new(klass, presenter_option)
+      @presenter = Presenter.current.new(klass, presenter_option)
       @presenter_option = presenter_option
     end
 

data/lib/table_inspector/version.rb

@@ -1,3 +1,3 @@
 module TableInspector
-  VERSION = "0.6.0"
+  VERSION = "1.0.0"
 end

data/lib/table_inspector.rb

@@ -7,6 +7,9 @@ require "table_inspector/terminal_table"
 require "table_inspector/indexes"
 require "table_inspector/column"
 require "table_inspector/presenter"
+require "table_inspector/presenter/sqlite3"
+require "table_inspector/presenter/postgresql"
+require "table_inspector/presenter/mysql2"
 require "table_inspector/model_validator"
 require "table_inspector/column_validator"
 require "table_inspector/presenter_option"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_inspector
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-27 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -55,6 +55,9 @@ files:
 - lib/table_inspector/inspectable.rb
 - lib/table_inspector/model_validator.rb
 - lib/table_inspector/presenter.rb
+- lib/table_inspector/presenter/mysql2.rb
+- lib/table_inspector/presenter/postgresql.rb
+- lib/table_inspector/presenter/sqlite3.rb
 - lib/table_inspector/presenter_option.rb
 - lib/table_inspector/railtie.rb
 - lib/table_inspector/table.rb
@@ -84,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Print table structure of ActiveRecord class