table_inspector 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42d6919ba568fa3f00f338fc84c7d526de66932b17693f72fea8fd0ab8497961
-  data.tar.gz: 82978c52fac51ee0943ed41a2d4105079fb536fd69c66fc0bf52a1d2c95fb226
+  metadata.gz: 64cb2752d497fae638297315267d3b4f5621b7a197fc321c440b60c73a353a14
+  data.tar.gz: 92ca3311efa5e77768aad96784d6d11c14dd7196ee0877529b4aaa2213d90a0f
 SHA512:
-  metadata.gz: 2bd23700289b479051fd88f701721e0cffab48b33ebca2a80e043007e8020e78f0db3a05c19405a1b7c2c7656ab526f618b31522b94231670fa87a16700c404d
-  data.tar.gz: 4a81daad914ffff7eac4853761044c408d49cbd5f4e2ea9f38a2c3ec2ef355b8024b1fc770bdff3124465ec7359a6a2e9db9ebd410fa594cba2d520839eebcdf
+  metadata.gz: 2cbf4d4ea540bb0883528f4ee3ab95ba428fc5e649e387461b7c0037165a64a461d9f9db3c1d9c75ee6fa66ae1d64bc3bd77d964e03f75e431d4ad14f5d117cc
+  data.tar.gz: 5b4b05a46dea671f457740f72f6e64f08123e006cdbb7bb8f0952990ca9369472aa0454c549a02807b61d54cd54e88b826301235efad9fd43bfb7ed04732381a

data/README.md

@@ -12,22 +12,31 @@ require "table_inspector"
 TableInspector.scan User
 ```
 
-![TableInspect scan table](img/table_inspector_scan_table.png)
+![TableInspect scan table](/img/table_inspector_scan_table_1.png)
 
 It will print the all table definition and all indexes.
 
+Or you can use `TableInspector.ascan` to print more colorful table(`ascan` means `awesome scan`) :
+```ruby
+TableInspector.ascan User
+```
+![TableInspect ascan table](/img/table_inspector_ascan_table_1.png)
+
 And to print specific column by:
 
 ```ruby
 TableInspector.scan User, :name
 ```
-![Table Inspector scan column](img/table_inspector_scan_column.png)
+![Table Inspector scan column](/img/table_inspector_scan_column_1.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)
+```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)
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/table_inspector/column.rb

@@ -3,12 +3,11 @@ module TableInspector
   class Column
     attr_reader :column, :klass, :sql_type, :presenter
 
-    def initialize(klass, column_name, sql_type: false)
+    def initialize(klass, column_name, sql_type: false, colorize: 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)
+      @presenter = Presenter.new(klass, sql_type: sql_type, colorize: false)
     end
 
     def render
@@ -27,19 +26,15 @@ module TableInspector
     private
 
     def render_title
-      Grid.new.render padding: [0, 2] do |grid|
+      Grid.new.render(padding: [0, 4, 0, 0]) 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.new(header: presenter.header).render_ascii(indent: 2) 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

@@ -17,10 +17,16 @@ module TableInspector
       puts grid.render(:ascii, **common_render_options.merge(with))
     end
 
+    def self.render_empty
+      new.render(padding: [0, 2]) do |grid|
+        grid << ["Empty."]
+      end
+    end
+
     def common_render_options
       {
         multiline: true
       }
     end
   end
-end
+end

data/lib/table_inspector/indexes.rb

@@ -21,18 +21,17 @@ module TableInspector
     private
 
     def render_title
-      Grid.new.render padding: [0, 2] do |grid|
+      Grid.new.render do |grid|
         grid << [Text.bold("Indexes")]
       end
     end
 
     def render_indexes_with_specific_column
       if indexes_with_specific_column.blank?
-        puts "Empty."
-        return
+        Grid.render_empty
       end
 
-      Grid.new.render do |grid|
+      Grid.new.render(padding: [0, 2]) do |grid|
         indexes_with_specific_column.each do |index|
           grid << compose_index_data(index)
         end
@@ -41,11 +40,11 @@ module TableInspector
 
     def render_indexes
       if indexes.blank?
-        puts "Empty."
+        Grid.render_empty
         return
       end
 
-      Grid.new.render do |grid|
+      Grid.new.render(padding: [0, 2]) do |grid|
         indexes.each do |index|
           grid << compose_index_data(index)
         end

data/lib/table_inspector/presenter.rb

@@ -3,15 +3,39 @@ module TableInspector
   class Presenter
     attr_reader :klass, :sql_type
 
-    def initialize(klass, sql_type:)
+    def initialize(klass, sql_type:, colorize: false)
       @klass = klass
       @sql_type = sql_type
+      @colorize = colorize
     end
 
-    def extract_meta(column)
+    def extract_meta_with_highlight(column)
+      column_data = column.as_json.merge(column.sql_type_metadata.as_json)
+
+      # Colorize text but except "comment" field
+      column_data.each do |k, v|
+        if k != "comment"
+          column_data[k] = colorize(v)
+        else
+          column_data[k]
+        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)
     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)
@@ -24,5 +48,22 @@ module TableInspector
         keys << "sql_type" if sql_type
       end
     end
+
+    def colorize(value)
+      case value
+      when TrueClass, DateTime, 'datetime'
+        Text.green(value)
+      when FalseClass
+        Text.red(value)
+      when Numeric, 'integer', 'decimal'
+        Text.blue(value)
+      when 'boolean'
+        Text.cyan(value)
+      when String
+        Text.yellow(value)
+      else
+        value
+      end
+    end
   end
-end
+end

data/lib/table_inspector/table.rb

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

data/lib/table_inspector/text.rb

@@ -10,5 +10,25 @@ module TableInspector
     def break_line
       puts "\n"
     end
+    
+    def red(text)
+      "\e[31m#{text}\e[0m"
+    end
+
+    def green(text)
+      "\e[32m#{text}\e[0m"
+    end
+    
+    def yellow(text)
+      "\e[33m#{text}\e[0m"
+    end
+    
+    def blue(text)
+      "\e[34m#{text}\e[0m"
+    end
+
+    def cyan(text)
+      "\e[36m#{text}\e[0m"
+    end
   end
-end
+end

data/lib/table_inspector/validator.rb

@@ -0,0 +1,37 @@
+
+module TableInspector
+  class Validator
+    def initialize(klass, column_name)
+      @klass = klass
+      @column = column_name
+    end
+
+    def validate!
+
+      if column_name && !validate_column(klass, column_name)
+        puts column_is_not_exists_hint(klass, column_name)
+        return
+      end
+
+      true
+    end
+
+    private
+
+    def is_active_record_class?(klass)
+      klass < ActiveRecord::Base
+    end
+
+    def validate_column(klass, column_name)
+      klass.columns.find{|column| column.name == column_name.to_s }
+    end
+
+    def not_a_model_class_hint(klass)
+      "#{klass} is not a model klass"
+    end
+
+    def column_is_not_exists_hint(klass, column_name)
+      puts "Column '#{column_name}' doesn't exists in table '#{klass.table_name}'"
+    end
+  end
+end

data/lib/table_inspector/version.rb

@@ -1,3 +1,3 @@
 module TableInspector
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/table_inspector.rb

@@ -7,33 +7,53 @@ require "table_inspector/indexes"
 require "table_inspector/text"
 require "table_inspector/column"
 require "table_inspector/presenter"
+require "table_inspector/validator"
 
 module TableInspector
   extend self
 
-  Error = Class.new(StandardError)
+  def ascan(klass, column_name = nil, sql_type: false)
+    klass = init_klass!(klass)
+    return unless klass
+
+    return unless Validator.new(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)
+    return unless klass
+
+    return unless Validator.new(klass, column_name)
+
+    render(klass, column_name, sql_type)
+  end
+
+  private
+
+  def init_klass!(klass)
     begin
       unless klass.is_a?(Class)
-        klass = klass.constantize
+        klass = klass.to_s.classify.constantize
       end
     rescue NameError
-      raise_invalid_model_error!
+      puts invalid_model_name_hint(klass.inspect)
+      return
     end
 
-    raise_invalid_model_error! unless klass < ActiveRecord::Base
+    klass
+  end
 
+  def render(klass, column_name, sql_type, colorize: false)
     if column_name
-      Column.new(klass, column_name, sql_type: sql_type).render
+      Column.new(klass, column_name, sql_type: sql_type, colorize: colorize).render
     else
-      Table.new(klass, sql_type: sql_type).render
+      Table.new(klass, sql_type: sql_type, colorize: colorize).render
     end
   end
-  
-  private
 
-  def raise_invalid_model_error!
-    raise Error, "Passed class is not a Model class!"
+  def invalid_model_name_hint(klass)
+    "'#{klass}' can be transform to a model class."
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_inspector
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-19 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,6 +56,7 @@ files:
 - lib/table_inspector/railtie.rb
 - lib/table_inspector/table.rb
 - lib/table_inspector/text.rb
+- lib/table_inspector/validator.rb
 - lib/table_inspector/version.rb
 - lib/tasks/table_inspector_tasks.rake
 homepage: https://github.com/table_inspector