table_inspector 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9658ef637dc9ee281cfc80f5480949dc522aa16c1c0b9c1ea61310058f9fb62d
-  data.tar.gz: 2460f6b96e97c20bc81bcd61dfe3ed021e5c0e1a4efec47ef1a0ebd17176ebb5
+  metadata.gz: 13d2e909962ad986dd0d91e00067ccb1329951a2235fa3cee6e24b702043d8de
+  data.tar.gz: bfd53531536b24cd6b701106a505731d03212984d332627a34085e277bdef76f
 SHA512:
-  metadata.gz: c26c6a0458ed9fdda4430d645af95891acb2604e731fcd846c17024377bba51fc2fa7044210867596811a8062fe11ddfa7f467f59f1777a366dbe72e538ded7a
-  data.tar.gz: 83ef3ead19f01b223a6f52dd9bf06c2d2e961f28ca0c8aa794f5374e4a82ed84f2e8f58962cdcd99687f37705bf2edd0dad927312bb3bc5c756bb3645aa820bb
+  metadata.gz: aafe5d2d7e3bafb8b8138572668af4ea163ae367ac2ccd92cf35e6e09512315ef99c23f607ac40f5a00507b37111da2862eccb762d7f872764b39e95e7621f10
+  data.tar.gz: ff22018ac69756f6cf3f795331e1697f9116e5329d27dea11195f6200d5b5cad32808d6e213bb06b637af02ffaa3249cfcaf42032cb96f677000a68bffb81524

data/README.md

@@ -4,7 +4,8 @@ but sometimes it is hard to maintain, and it has a little noise. I want to find
 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"
 
@@ -13,12 +14,21 @@ 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.2.0"
+  VERSION = "0.3.0"
 end

data/lib/table_inspector.rb

@@ -1,12 +1,18 @@
 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, sql_type: false)
     begin
       unless klass.is_a?(Class)
@@ -19,91 +25,15 @@ module TableInspector
     raise_invalid_model_error! unless klass < ActiveRecord::Base
 
     if column_name
-      scan_column(klass, column_name, sql_type: sql_type)
+      Column.new(klass, column_name, sql_type: sql_type).render
     else
-      scan_table(klass, sql_type: sql_type)
+      Table.new(klass, sql_type: sql_type).render
     end
   end
   
   private
 
-  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, sql_type: sql_type)
-    header = meta.keys.map(&:upcase_first)
-
-    table = TTY::Table.new(header: header)
-    table << extract_meta(column, sql_type: sql_type).values
-
-    puts table.render(:ascii)
-  end
-
-  def scan_table(klass, sql_type: false )
-    columns = klass.columns
-    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, 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, sql_type: false)
-    column.as_json.merge(column.sql_type_metadata.as_json).slice(*ordered_keys(sql_type: sql_type))
-  end
-
-  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!
     raise Error, "Passed class is not a Model class!"
   end
-
-  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_inspector
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ian
@@ -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