table_inspector 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38e7941896785704a1baec51bb5f4a76b9ed699ad2957b796797739b08d5169a
+  data.tar.gz: 32ab18e8189f664e8928f42050a14daa19f467b6a2de15db95d1de7a3b04771b
+SHA512:
+  metadata.gz: e5cd066d6abc3300397f72caeb5239313db2a0981c5b0b4b72ab8abd2f030b151208a96100cb36266b3e36a0a49c8ba3470047c8820e0b2c324405d6ebbbe175
+  data.tar.gz: 7f9abe964be15dccec104bc094a8c6e8b7a296d3a61cfe3831f8382d49b986c67c1a10cde3f971cec276805e784c419f19c95316c705eec639e46baffd8ddc11

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 ian
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# 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.
+
+## Usage
+Assuming there is a model is called User which has `id` and `name` column. For print the definition of User, we can use: 
+
+```ruby
+require "table_inspector"
+
+TableInspector.scan User
+```
+
+And to print specific column by:
+
+```ruby
+TableInspector.scan User, :name
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "table_inspector"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install table_inspector
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/table_inspector/railtie.rb

@@ -0,0 +1,4 @@
+module TableInspector
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/table_inspector/version.rb

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

data/lib/table_inspector.rb

@@ -0,0 +1,73 @@
+require "table_inspector/version"
+require "table_inspector/railtie"
+require "tty-table"
+
+module TableInspector
+  Error = Class.new(StandardError)
+
+  extend self
+  
+  def scan(klass, column_name = nil)
+    begin
+      unless klass.is_a?(Class)
+        klass = klass.constantize
+      end
+    rescue NameError => e
+      raise_invalid_model_error!
+    end
+
+    raise_invalid_model_error! unless klass < ActiveRecord::Base
+
+    if column_name
+      scan_column(klass, column_name)
+    else
+      scan_table(klass)
+    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

data/lib/tasks/table_inspector_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :table_inspector do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: table_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- ian
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.0
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: Inspect table structure of ActiveRecord class
+email:
+- ianlynxk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/table_inspector.rb
+- lib/table_inspector/railtie.rb
+- lib/table_inspector/version.rb
+- lib/tasks/table_inspector_tasks.rake
+homepage: https://github.com/table_inspector
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/table_inspector
+  source_code_uri: https://github.com/otorain/table_inspector
+  changelog_uri: https://github.com/otorain/table_inspector/CHANGELOG
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.13
+signing_key:
+specification_version: 4
+summary: Inspect table structure of ActiveRecord class
+test_files: []