active_record_table_info 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0199acfc3e5118a88df5a365c2080f87100944701e151a93121d2b1a6f568fee'
+  data.tar.gz: dc669dd15f8ffd8ecedafd60395f0990d73de7ea0ad72100bf1cfcf669a307f8
+SHA512:
+  metadata.gz: 8b6f238b3733a5476268913f72633c74f72acae37bae85ada1f8d6f0391ccfa0459b29dd458d20d71e8eca1ca8d15b3081e7e181b93a4d8f8f06d69e23aaa6f2
+  data.tar.gz: ea3d436d23f3ae2c87abb4573de0ba0def1bf51ef866c41c4734ac03f7d3e882f20e56ef41e1d9d4dcf0e057ae3d69d4f22af3b9e823e57311eca4c275bf3e9c

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require:
+  - rubocop-rails
+  - rubocop-minitest
+  - rubocop-rake
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.4
+  TargetRailsVersion: 6.0
+  NewCops: enable
+
+Rails:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_table_info.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-minitest'
+gem 'rubocop-performance'
+gem 'rubocop-rails'
+gem 'rubocop-rake'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Narazaka
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.

data/README.md

@@ -0,0 +1,47 @@
+# ActiveRecordTableInfo
+
+`User.table_info` shows columns and indexes like `SHOW CREATE TABLE`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_table_info'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_record_table_info
+
+## Usage
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  extend ActiveRecordTableInfo
+end
+```
+
+then
+
+```
+User.table_info
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_record_table_info.
+
+## License
+
+[Zlib](LICENSE)

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/active_record_table_info.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/active_record_table_info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_table_info'
+  spec.version       = ActiveRecordTableInfo::VERSION
+  spec.authors       = ['Narazaka']
+  spec.email         = ['info@narazaka.net']
+  spec.licenses      = ['Zlib']
+
+  spec.summary       = '`User.table_info` shows columns and indexes like `SHOW CREATE TABLE`'
+  spec.homepage      = 'https://github.com/Narazaka/active_record_table_info'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Narazaka/active_record_table_info.git'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "active_record_table_info"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record_table_info.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'active_record_table_info/version'
+
+module ActiveRecordTableInfo # rubocop:disable Style/Documentation
+  def show_create_table
+    puts connection.select_one("show create table #{table_name}")['Create Table'] # rubocop:disable Rails/Output
+  end
+
+  def table_info
+    puts (['-- COLUMNS --'] + table_columns + ['-- INDEXES --'] + table_indexes).map { |line| "#{line}\n" }.join # rubocop:disable Rails/Output
+  end
+
+  def table_columns # rubocop:disable Metrics/AbcSize
+    connection.columns(table_name).map do |column|
+      [
+        "`#{column.name}`",
+        column.sql_type,
+        column.null ? 'NULL' : 'NOT NULL',
+        column.try(:collation) ? "COLLATE #{column.collation}" : nil,
+        column.try(:extra) == 'auto_increment' ? 'AUTO_INCREMENT' : nil,
+        column.null || !column.default.nil? ? "DEFAULT #{column.default.inspect}" : nil
+      ].compact.join(' ')
+    end
+  end
+
+  def table_indexes
+    [table_primary_index] + table_non_primary_indexes
+  end
+
+  def table_primary_index
+    "PRIMARY KEY (#{primary_key})"
+  end
+
+  def table_non_primary_indexes
+    connection.indexes(table_name).map do |index|
+      "#{index.unique ? 'UNIQUE KEY' : 'KEY'} `#{index.name}` (#{index.columns.join(', ')})"
+    end
+  end
+end

data/lib/active_record_table_info/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordTableInfo
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: active_record_table_info
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Narazaka
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_record_table_info.gemspec
+- bin/console
+- bin/setup
+- lib/active_record_table_info.rb
+- lib/active_record_table_info/version.rb
+homepage: https://github.com/Narazaka/active_record_table_info
+licenses:
+- Zlib
+metadata:
+  homepage_uri: https://github.com/Narazaka/active_record_table_info
+  source_code_uri: https://github.com/Narazaka/active_record_table_info.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: "`User.table_info` shows columns and indexes like `SHOW CREATE TABLE`"
+test_files: []