table_inspector 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66bb18ecff6dea2031545bdff1230cde6380155cb32426d2da0d4fc468aa8f02
-  data.tar.gz: 33b460f855700d11ceb65894004cd47730ebaba01df84f839d644483c41b26aa
+  metadata.gz: daa366bf65aa393dfec28755c95859132ac9ada94b7f64ec7e5aa51a8a624dfe
+  data.tar.gz: 7d55ca091b0428d4d5e7f8f49407df81f57800246cdc033d2cc3b86a48c3f434
 SHA512:
-  metadata.gz: af82ef5518522d418045544193a5937d23e98ad6c59d402c548b8736c0111a6fcc24db88e0054b27d6d9d510a9ba04d08aa07294b1c0564f996ccf745e183dd5
-  data.tar.gz: 30e2d9dc5f4a8d112cbce43840f89b51ccd2fa4aa1645ace7abdde07ef64890a3fde45ca213ebfa30f8e2a5bd9f2ea37faad81412e49dc2c4ff4fd04fdfe7113
+  metadata.gz: f30222ece677477bca2df6918e8a12b2198c5c673db1edcbe6160f3d33f921cd2926f4564eee4ff07d70b6091845d15b814896ae8b16f2f1bffc37e04ef4b305
+  data.tar.gz: fa30655cc9f20b570ffc5bb100b27245a86c101ed0c21c6bbc669149c20d09ef8d41caab1145c6819a3287a4edb52060f25b6f97895ab666411e21068e8e9442

data/README.md

@@ -12,7 +12,7 @@ require "table_inspector"
 TableInspector.scan User
 ```
 
-![TableInspect scan table](/img/table_inspector_scan_table_1.png)
+![TableInspect scan table](/img/table_inspector_scan_table_2.png)
 
 It will print the all table definition and all indexes.
 
@@ -20,14 +20,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_1.png)
+![TableInspect ascan table](/img/table_inspector_ascan_table_2.png)
 
 And to print a specific column by:
 
 ```ruby
 TableInspector.scan User, :name
 ```
-![Table Inspector scan column](/img/table_inspector_scan_column_1.png)
+![Table Inspector scan column](/img/table_inspector_scan_column_2.png)
 
 It will print the column definition and which indexes that contains this column.
 
@@ -36,7 +36,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_1.png)
+![Table Inspector scan table column with sql type](/img/table_inspector_scan_table_with_sql_type_2.png)
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/table_inspector/column.rb

@@ -12,29 +12,25 @@ module TableInspector
 
     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, 4, 0, 0]) do |grid|
-        grid << ["#{Text.bold('Table')}: #{klass.table_name}", "#{Text.bold('Column')}: #{column.name}"]
-      end
+      Grid.new do |grid|
+        grid.add_row(["#{Text.bold('Table')}: #{klass.table_name}", "#{Text.bold('Column')}: #{column.name}"])
+      end.render
     end
 
     def render_body
-      Grid.new(header: presenter.header).render_ascii(indent: 2) do |grid|
-        grid << @presenter.extract_meta(column).values
-      end
+      Grid.new(headings: presenter.headings) do |grid|
+        grid.add_row(@presenter.extract_meta(column).values)
+      end.render
     end
   end
 end

data/lib/table_inspector/grid.rb

@@ -1,32 +1,24 @@
 
 module TableInspector
   class Grid
-    attr_reader :grid
+    attr_reader :terminal_table
 
-    def initialize(**options)
-      @grid = TTY::Table.new(**options)
-    end
-
-    def render(**with)
-      yield grid
-      puts grid.render(**common_render_options.merge(with))
-    end
+    delegate :add_row,
+             :to_s,
+             :rows, to: :terminal_table
 
-    def render_ascii(**with)
-      yield grid
-      puts grid.render(:ascii, **common_render_options.merge(with))
+    def initialize(**options, &block)
+      @terminal_table = ::Terminal::Table.new(**options)
+      yield self if block_given?
     end
 
-    def self.render_empty
-      new.render(padding: [0, 2]) do |grid|
-        grid << ["Empty."]
+    def render
+      if rows.empty?
+        Text.break_line
+        puts "  Empty."
+      else
+        puts self
       end
     end
-
-    def common_render_options
-      {
-        multiline: true
-      }
-    end
   end
 end

data/lib/table_inspector/indexes.rb

@@ -1,17 +1,17 @@
 
 module TableInspector
   class Indexes
-    attr_reader :klass, :column
+    attr_reader :klass, :column_name
 
-    def initialize(klass, column = nil)
+    def initialize(klass, column_name = nil)
       @klass = klass
-      @column = column
+      @column_name = column_name
     end
 
     def render
       render_title
 
-      if column
+      if column_name
         render_indexes_with_specific_column
       else
         render_indexes
@@ -21,34 +21,25 @@ module TableInspector
     private
 
     def render_title
-      Grid.new.render do |grid|
-        grid << [Text.bold("Indexes")]
-      end
+      Grid.new do |grid|
+        grid.add_row([Text.bold("Indexes")])
+      end.render
     end
 
     def render_indexes_with_specific_column
-      if indexes_with_specific_column.blank?
-        Grid.render_empty
-      end
-
-      Grid.new.render(padding: [0, 2]) do |grid|
+      Grid.new(headings: headings) do |grid|
         indexes_with_specific_column.each do |index|
-          grid << compose_index_data(index)
+          grid.add_row(compose_index_data(index))
         end
-      end
+      end.render
     end
 
     def render_indexes
-      if indexes.blank?
-        Grid.render_empty
-        return
-      end
-
-      Grid.new.render(padding: [0, 2]) do |grid|
+      Grid.new(headings: headings) do |grid|
         indexes.each do |index|
-          grid << compose_index_data(index)
+          grid.add_row(compose_index_data(index))
         end
-      end
+      end.render
     end
 
     def compose_index_data(index)
@@ -59,12 +50,16 @@ module TableInspector
       ]
     end
 
+    def headings
+      %w(Name Columns Unique?)
+    end
+
     def indexes
       @indexes ||= connection.indexes(klass.table_name)
     end
 
     def indexes_with_specific_column
-      indexes.select{|index| index.columns.include?(column) }
+      indexes.select{|index| index.columns.include?(column_name) }
     end
 
     def connection

data/lib/table_inspector/presenter.rb

@@ -9,6 +9,21 @@ module TableInspector
       @colorize = colorize
     end
 
+    def extract_meta(column)
+      if @colorize
+        extract_meta_with_highlight(column)
+      else
+        extract_meta_without_highlight(column)
+      end
+    end
+
+    def headings
+      first_column = klass.columns.first
+      extract_meta(first_column).keys.map(&:humanize)
+    end
+
+    private
+
     def extract_meta_with_highlight(column)
       column_data = column.as_json.merge(column.sql_type_metadata.as_json)
 
@@ -28,21 +43,6 @@ module TableInspector
       column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys)
     end
 
-    def extract_meta(column)
-      if @colorize
-        extract_meta_with_highlight(column)
-      else
-        extract_meta_without_highlight(column)
-      end
-    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

data/lib/table_inspector/table.rb

@@ -11,31 +11,31 @@ module TableInspector
 
     def render
       Text.break_line
-
       render_title
       render_body
-
       Text.break_line
-
-      Indexes.new(klass).render
-
+      render_indexes
       Text.break_line
     end
 
     private
 
     def render_title
-      Grid.new.render do |grid|
-        grid << ["#{Text.bold('Table')}: #{klass.table_name}"]
-      end
+      Grid.new do |grid|
+        grid.add_row(["#{Text.bold('Table')}: #{klass.table_name}"])
+      end.render
     end
 
     def render_body
-      Grid.new(header: presenter.header).render_ascii(indent: 2) do |grid|
+      Grid.new(headings: presenter.headings) do |grid|
         klass.columns.each do |column|
-          grid << presenter.extract_meta(column).values
+          grid.add_row(presenter.extract_meta(column).values)
         end
-      end
+      end.render
+    end
+
+    def render_indexes
+      Indexes.new(klass).render
     end
   end
 end

data/lib/table_inspector/version.rb

@@ -1,3 +1,3 @@
 module TableInspector
-  VERSION = "0.4.2"
+  VERSION = "0.5.1"
 end

data/lib/table_inspector.rb

@@ -1,6 +1,6 @@
 require "table_inspector/version"
 require "table_inspector/railtie"
-require "tty-table"
+require "terminal-table"
 require "table_inspector/table"
 require "table_inspector/grid"
 require "table_inspector/indexes"
@@ -14,16 +14,16 @@ module TableInspector
   extend self
 
   def ascan(klass, column_name = nil, sql_type: false)
-    klass = init_klass!(klass)
+    klass = classify!(klass)
 
     return unless klass
-    return unless  validate!(klass, column_name)
+    return unless validate!(klass, column_name)
 
     render(klass, column_name, sql_type, colorize: true)
   end
 
   def scan(klass, column_name = nil, sql_type: false)
-    klass = init_klass!(klass)
+    klass = classify!(klass)
 
     return unless klass
     return unless validate!(klass, column_name)
@@ -33,7 +33,7 @@ module TableInspector
 
   private
 
-  def init_klass!(klass)
+  def classify!(klass)
     begin
       unless klass.is_a?(Class)
         klass = klass.to_s.classify.constantize

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_inspector
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,47 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.3.0
 - !ruby/object:Gem::Dependency
-  name: tty-table
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 3.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.1
+        version: 3.0.2
 description: Inspect table structure of ActiveRecord class
 email:
 - ianlynxk@gmail.com
@@ -88,11 +60,11 @@ files:
 - lib/table_inspector/text.rb
 - lib/table_inspector/version.rb
 - lib/tasks/table_inspector_tasks.rake
-homepage: https://github.com/table_inspector
+homepage: https://github.com/otorain/table_inspector
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/table_inspector
+  homepage_uri: https://github.com/otorain/table_inspector
   source_code_uri: https://github.com/otorain/table_inspector
   changelog_uri: https://github.com/otorain/table_inspector/CHANGELOG
 post_install_message:
@@ -110,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Inspect table structure of ActiveRecord class