table_inspector 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13d2e909962ad986dd0d91e00067ccb1329951a2235fa3cee6e24b702043d8de
-  data.tar.gz: bfd53531536b24cd6b701106a505731d03212984d332627a34085e277bdef76f
+  metadata.gz: 5a2079df9ac551a32268d56a87c54ee17c33a4a2c349b19b91d2a38d0d46d192
+  data.tar.gz: 9e6ce315d803a4b69363938e632110078502e9ac64f0b79a836fc1e58c9702c6
 SHA512:
-  metadata.gz: aafe5d2d7e3bafb8b8138572668af4ea163ae367ac2ccd92cf35e6e09512315ef99c23f607ac40f5a00507b37111da2862eccb762d7f872764b39e95e7621f10
-  data.tar.gz: ff22018ac69756f6cf3f795331e1697f9116e5329d27dea11195f6200d5b5cad32808d6e213bb06b637af02ffaa3249cfcaf42032cb96f677000a68bffb81524
+  metadata.gz: 54961c16f48ef46fe7a0b162341b1844a6dd9245ec5ac3913dd13979404e4bc7b527df33c01c74d0c2338783fb5b6d35f3c823657e7ede877e94de8275362d8b
+  data.tar.gz: d26e796110ca40a61657ffe72b7272d817d61b12612f720e0a03383bf14191edffdd00e0970e598cbc77136239170dbe84ff9b7891f84127931aaaaec8dc1ac9

data/README.md

@@ -12,7 +12,7 @@ require "table_inspector"
 TableInspector.scan User
 ```
 
-![TableInspect scan table](img/table_inspector_scan_table.png)
+![TableInspect scan table](/img/table_inspector_scan_table.png)
 
 It will print the all table definition and all indexes.
 
@@ -21,13 +21,13 @@ 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.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)
+![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

@@ -5,7 +5,6 @@ module TableInspector
 
     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)
@@ -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,6 +17,12 @@ 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

data/lib/table_inspector/indexes.rb

@@ -12,7 +12,7 @@ module TableInspector
       render_title
 
       if column
-        render_indexes_with_specify_column
+        render_indexes_with_specific_column
       else
         render_indexes
       end
@@ -21,45 +21,44 @@ 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_specify_column
+    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 << [
-            index.name,
-            "[#{index.columns.join(', ')}]",
-            index.unique ? "UNIQUE" : ""
-          ]
+          grid << compose_index_data(index)
         end
       end
     end
 
     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 << [
-            index.name,
-            "[#{index.columns.join(', ')}]",
-            index.unique ? "UNIQUE" : ""
-          ]
+          grid << compose_index_data(index)
         end
       end
     end
 
+    def compose_index_data(index)
+      [
+        index.name,
+        "[#{index.columns.join(', ')}]",
+        index.unique ? "UNIQUE" : ""
+      ]
+    end
+
     def indexes
       @indexes ||= connection.indexes(klass.table_name)
     end

data/lib/table_inspector/table.rb

@@ -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/version.rb

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

data/lib/table_inspector.rb

@@ -11,18 +11,25 @@ require "table_inspector/presenter"
 module TableInspector
   extend self
 
-  Error = Class.new(StandardError)
-
   def scan(klass, column_name = nil, sql_type: false)
     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
+    unless klass < ActiveRecord::Base
+      puts not_a_model_class_hint(klass)
+      return
+    end
+
+    if column_name && !validate_column(klass, column_name)
+      puts column_is_not_exists_hint(klass, column_name)
+      return
+    end
 
     if column_name
       Column.new(klass, column_name, sql_type: sql_type).render
@@ -33,7 +40,19 @@ module TableInspector
   
   private
 
-  def raise_invalid_model_error!
-    raise Error, "Passed class is not a Model class!"
+  def validate_column(klass, column_name)
+    klass.columns.find{|column| column.name == column_name.to_s }
+  end
+
+  def invalid_model_name_hint(klass)
+    "'#{klass}' can be transform to a model class."
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_inspector
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-19 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails