table_inspector 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38e7941896785704a1baec51bb5f4a76b9ed699ad2957b796797739b08d5169a
-  data.tar.gz: 32ab18e8189f664e8928f42050a14daa19f467b6a2de15db95d1de7a3b04771b
+  metadata.gz: 13d2e909962ad986dd0d91e00067ccb1329951a2235fa3cee6e24b702043d8de
+  data.tar.gz: bfd53531536b24cd6b701106a505731d03212984d332627a34085e277bdef76f
 SHA512:
-  metadata.gz: e5cd066d6abc3300397f72caeb5239313db2a0981c5b0b4b72ab8abd2f030b151208a96100cb36266b3e36a0a49c8ba3470047c8820e0b2c324405d6ebbbe175
-  data.tar.gz: 7f9abe964be15dccec104bc094a8c6e8b7a296d3a61cfe3831f8382d49b986c67c1a10cde3f971cec276805e784c419f19c95316c705eec639e46baffd8ddc11
+  metadata.gz: aafe5d2d7e3bafb8b8138572668af4ea163ae367ac2ccd92cf35e6e09512315ef99c23f607ac40f5a00507b37111da2862eccb762d7f872764b39e95e7621f10
+  data.tar.gz: ff22018ac69756f6cf3f795331e1697f9116e5329d27dea11195f6200d5b5cad32808d6e213bb06b637af02ffaa3249cfcaf42032cb96f677000a68bffb81524

data/README.md

@@ -1,21 +1,33 @@
 # 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: 
-
+Assuming there is a model call `User` which has `id` and `name` column, and has a unique index for `name`.
+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)
+
+It will print the all table definition and all indexes.
+
 And to print specific column by:
 
 ```ruby
 TableInspector.scan User, :name
 ```
+![Table Inspector scan column](img/table_inspector_scan_column.png)
+
+It will print the column definition and which indexes that contains this column.
+
+Also, you can print `sql_type` which type of column in database by provide `sql_type: true` option: 
+
+![Table Inspector scan table column with sql type](img/table_inspector_scan_table_with_sql_type.png)
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/table_inspector/column.rb

@@ -0,0 +1,45 @@
+
+module TableInspector
+  class Column
+    attr_reader :column, :klass, :sql_type, :presenter
+
+    def initialize(klass, column_name, sql_type: false)
+      @column = klass.columns.find {|column| column.name == column_name.to_s}
+      raise_column_not_found_error! unless @column
+      @klass = klass
+      @sql_type = sql_type
+      @presenter = Presenter.new(klass, sql_type: sql_type)
+    end
+
+    def render
+      Text.break_line
+
+      render_title
+      render_body
+
+      Text.break_line
+
+      Indexes.new(klass, column.name).render
+
+      Text.break_line
+    end
+
+    private
+
+    def render_title
+      Grid.new.render padding: [0, 2] do |grid|
+        grid << ["#{Text.bold('Table')}: #{klass.table_name}", "#{Text.bold('Column')}: #{column.name}"]
+      end
+    end
+
+    def render_body
+      Grid.new(header: presenter.header).render_ascii do |grid|
+        grid << @presenter.extract_meta(column).values
+      end
+    end
+
+    def raise_column_not_found_error!
+      raise TableInspector::Error, "Column not found!"
+    end
+  end
+end

data/lib/table_inspector/grid.rb

@@ -0,0 +1,26 @@
+
+module TableInspector
+  class Grid
+    attr_reader :grid
+
+    def initialize(**options)
+      @grid = TTY::Table.new(**options)
+    end
+
+    def render(**with)
+      yield grid
+      puts grid.render(**common_render_options.merge(with))
+    end
+
+    def render_ascii(**with)
+      yield grid
+      puts grid.render(:ascii, **common_render_options.merge(with))
+    end
+
+    def common_render_options
+      {
+        multiline: true
+      }
+    end
+  end
+end

data/lib/table_inspector/indexes.rb

@@ -0,0 +1,75 @@
+
+module TableInspector
+  class Indexes
+    attr_reader :klass, :column
+
+    def initialize(klass, column = nil)
+      @klass = klass
+      @column = column
+    end
+
+    def render
+      render_title
+
+      if column
+        render_indexes_with_specify_column
+      else
+        render_indexes
+      end
+    end
+
+    private
+
+    def render_title
+      Grid.new.render padding: [0, 2] do |grid|
+        grid << [Text.bold("Indexes")]
+      end
+    end
+
+    def render_indexes_with_specify_column
+      if indexes_with_specific_column.blank?
+        puts "Empty."
+        return
+      end
+
+      Grid.new.render do |grid|
+        indexes_with_specific_column.each do |index|
+          grid << [
+            index.name,
+            "[#{index.columns.join(', ')}]",
+            index.unique ? "UNIQUE" : ""
+          ]
+        end
+      end
+    end
+
+    def render_indexes
+      if indexes.blank?
+        puts "Empty."
+        return
+      end
+
+      Grid.new.render do |grid|
+        indexes.each do |index|
+          grid << [
+            index.name,
+            "[#{index.columns.join(', ')}]",
+            index.unique ? "UNIQUE" : ""
+          ]
+        end
+      end
+    end
+
+    def indexes
+      @indexes ||= connection.indexes(klass.table_name)
+    end
+
+    def indexes_with_specific_column
+      indexes.select{|index| index.columns.include?(column) }
+    end
+
+    def connection
+      @connection ||= ActiveRecord::Base.connection
+    end
+  end
+end

data/lib/table_inspector/presenter.rb

@@ -0,0 +1,28 @@
+
+module TableInspector
+  class Presenter
+    attr_reader :klass, :sql_type
+
+    def initialize(klass, sql_type:)
+      @klass = klass
+      @sql_type = sql_type
+    end
+
+    def extract_meta(column)
+      column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys)
+    end
+
+    def header
+      first_column = klass.columns.first
+      extract_meta(first_column).keys.map(&:humanize)
+    end
+
+    private
+
+    def ordered_keys
+      %w[name type limit null default precision scale comment].tap do |keys|
+        keys << "sql_type" if sql_type
+      end
+    end
+  end
+end

data/lib/table_inspector/table.rb

@@ -0,0 +1,41 @@
+
+module TableInspector
+  class Table
+    attr_reader :klass, :sql_type, :presenter
+
+    def initialize(klass, sql_type: false)
+      @klass = klass
+      @sql_type = sql_type
+      @presenter = Presenter.new(klass, sql_type: sql_type)
+    end
+
+    def render
+      Text.break_line
+
+      render_title
+      render_body
+
+      Text.break_line
+
+      Indexes.new(klass).render
+
+      Text.break_line
+    end
+
+    private
+
+    def render_title
+      Grid.new.render with: {padding: [0, 2]} do |grid|
+        grid << ["#{Text.bold('Table')}: #{klass.table_name}"]
+      end
+    end
+
+    def render_body
+      Grid.new(header: presenter.header).render_ascii do |grid|
+        klass.columns.each do |column|
+          grid << presenter.extract_meta(column).values
+        end
+      end
+    end
+  end
+end

data/lib/table_inspector/text.rb

@@ -0,0 +1,14 @@
+
+module TableInspector
+  module Text
+    extend self
+
+    def bold(text)
+      "\033[1m#{text}\033[0m"
+    end
+
+    def break_line
+      puts "\n"
+    end
+  end
+end

data/lib/table_inspector/version.rb

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

data/lib/table_inspector.rb

@@ -1,73 +1,39 @@
 require "table_inspector/version"
 require "table_inspector/railtie"
 require "tty-table"
+require "table_inspector/table"
+require "table_inspector/grid"
+require "table_inspector/indexes"
+require "table_inspector/text"
+require "table_inspector/column"
+require "table_inspector/presenter"
 
 module TableInspector
+  extend self
+
   Error = Class.new(StandardError)
 
-  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)
+      Column.new(klass, column_name, sql_type: sql_type).render
     else
-      scan_table(klass)
+      Table.new(klass, sql_type: sql_type).render
     end
   end
   
   private
 
-  def scan_column(klass, col_name)
-    columns = klass.columns
-    column = columns.find{|col| col.name == col_name.to_s}
-
-    raise_column_not_found_error! unless column
-
-    meta = extract_meta(column)
-    header = meta.keys.map(&:upcase_first)
-
-    table = TTY::Table.new(header: header)
-    table << extract_meta(column).values
-
-    puts table.render(:ascii)
-  end
-
-  def scan_table(klass)
-    columns = klass.columns
-    first_column_meta = extract_meta(columns.first)
-    header = first_column_meta.keys.map(&:upcase_first)
-    table = TTY::Table.new(header: header)
-
-    columns.each do |column|
-      table << extract_meta(column).values
-    end
-
-    puts table.render(:ascii)
-  end
-
-  def extract_meta(column)
-    column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys)
-  end
-
-  def ordered_keys
-    %w[ name type limit null default precision scale comment]
-  end
-
   def raise_invalid_model_error!
     raise Error, "Passed class is not a Model class!"
   end
-
-  def raise_column_not_found_error!
-    raise Error, "Column not found!"
-  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.3.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
@@ -49,7 +49,13 @@ files:
 - README.md
 - Rakefile
 - lib/table_inspector.rb
+- lib/table_inspector/column.rb
+- lib/table_inspector/grid.rb
+- lib/table_inspector/indexes.rb
+- lib/table_inspector/presenter.rb
 - lib/table_inspector/railtie.rb
+- lib/table_inspector/table.rb
+- lib/table_inspector/text.rb
 - lib/table_inspector/version.rb
 - lib/tasks/table_inspector_tasks.rake
 homepage: https://github.com/table_inspector