pry-helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a183f019f5bf5b3c3fe36d26687b5cd8d08f45d34ec628c734f08e35a8de8ed
+  data.tar.gz: 4f9f94dc18258f514af2263e7b33fc2ab6d99dc13d3f6fa4903f75aa2b2dd94a
+SHA512:
+  metadata.gz: e62ec3a4851f8351f3d2d7bc0a235eb7fe5e8de501c8f48b76d36f2306629394edba6480dea3dc4a9051edb4577b390c3b508fc4601a726031c70cd861f3d68f
+  data.tar.gz: bb27b6fe1389c76c6bfdb76b8dff54071366e10ba40eb829bc26e5202d94d96b28b42d8fc6d459cb9b5b19c10845e6063b17830fe15b25beec34d02ef9bfae1c

data/.gitignore

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

data/.solargraph.yml

@@ -0,0 +1,11 @@
+require:
+- actioncable
+- actionmailer
+- actionpack
+- actionview
+- activejob
+- activemodel
+- activerecord
+- activestorage
+- activesupport
+- caxlsx

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at liuxiang@ktjr.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pry-helper.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    pry-helper (0.1.0)
+      activerecord
+      activesupport
+      caxlsx
+      pry-doc
+      rainbow
+      roo
+      table_print
+      terminal-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    caxlsx (3.2.0)
+      htmlentities (~> 4.3, >= 4.3.4)
+      marcel (~> 1.0)
+      nokogiri (~> 1.10, >= 1.10.4)
+      rubyzip (>= 1.3.0, < 3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    htmlentities (4.3.4)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-doc (1.3.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    roo (2.9.0)
+      nokogiri (~> 1)
+      rubyzip (>= 1.3.0, < 3.0.0)
+    rubyzip (2.3.2)
+    table_print (1.5.7)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry-helper!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Liu Xiang
+
+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,8 @@
+# PryHelper
+
+## Installation
+
+Add the following line to your Gemfile:
+
+    gem 'pry-helper'
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pry-helper"
+
+# 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/pry-helper/commands/models.rb

@@ -0,0 +1,44 @@
+require 'terminal-table'
+
+module PryHelper::Commands
+  module Models
+    class << self
+      def models
+        t = []
+        t << ['Table Name', 'Model Class', 'Abbr', 'Comment']
+        t << nil
+        PryHelper::Definition.models.each do |definition|
+          t << [definition[:table], definition[:model].name, definition[:abbr] || '', definition[:comment] || '']
+        end
+        t
+      end
+
+      def models_table(regexp)
+        Terminal::Table.new do |t|
+          models.each_with_index { |row, idx| t << (row || :separator) if row.nil? ||
+            regexp.nil? ||
+            idx.zero? ||
+            row.any? { |e| e =~ regexp }
+          }
+        end
+      end
+    end
+  end
+
+  Pry.commands.block_command 'm' do |regexp|
+    puts
+    puts Models::models_table(regexp.try { |e| e.start_with?('/') ? eval(e) : Regexp.new(e) })
+  end
+
+  Pry.commands.alias_command 'l', 'm'
+end
+
+module Kernel
+  def models
+    PryHelper::Commands::Models::models
+  end
+
+  def tables
+    models
+  end
+end

data/lib/pry-helper/commands/table.rb

@@ -0,0 +1,55 @@
+require 'terminal-table'
+
+module PryHelper::Commands
+  module Table
+    class << self
+      def get_table_name(name)
+        name = name.to_s
+        return name if name =~ /^[a-z]/
+        if Object.const_defined?(name)
+          klass = Object.const_get(name)
+          return klass.table_name if klass < ActiveRecord::Base
+        end
+        name
+      end
+
+      def table_info_table(table_name)
+        Terminal::Table.new do |t|
+          table_info(table_name).each { |row| t << (row || :separator) }
+        end
+      end
+
+      def table_info(table_name)
+        t = []
+        t << ['PK', 'Name', 'SQL Type', 'Ruby Type', 'Limit', 'Precision', 'Scale', 'Default', 'Nullable', 'Comment']
+        t << nil
+        connection = ::ActiveRecord::Base.connection
+        connection.columns(table_name).each do |column|
+          pk = if [connection.primary_key(table_name)].flatten.include?(column.name)
+                 'Y'
+               else
+                 ''
+               end
+          t << [pk, column.name, column.sql_type,
+                column.sql_type_metadata.type, column.sql_type_metadata.limit || '',
+                column.sql_type_metadata.precision || '', column.sql_type_metadata.scale || '', column.default || '',
+                column.null, column.comment || '']
+        end
+        t
+      end
+    end
+
+    Pry.commands.block_command 't' do |name|
+      table_name = Table::get_table_name(name)
+      puts
+      puts "Table: #{table_name}"
+      puts Table::table_info_table(table_name)
+    end
+  end
+end
+
+module Kernel
+  def table(name)
+    PryHelper::Commands::Table::table_info(PryHelper::Commands::Table::get_table_name(name))
+  end
+end

data/lib/pry-helper/commands/vd.rb

@@ -0,0 +1,46 @@
+require 'pry-helper/vd'
+
+module PryHelper::Commands
+  module VD
+    class << self
+      def get_table_name(name)
+        name = name.to_s
+        return name if name =~ /^[a-z]/
+        if Object.const_defined?(name)
+          klass = Object.const_get(name)
+          return klass.table_name if klass < ActiveRecord::Base
+        end
+        name
+      end
+
+      def table_info_vd(table_name)
+        PryHelper::VD.new do |vd|
+          table_info(table_name).each { |row| vd << row }
+        end
+      end
+
+      def table_info(table_name)
+        t = []
+        t << ['PK', 'Name', 'SQL Type', 'Ruby Type', 'Limit', 'Precision', 'Scale', 'Default', 'Nullable', 'Comment']
+        connection = ::ActiveRecord::Base.connection
+        connection.columns(table_name).each do |column|
+          pk = if [connection.primary_key(table_name)].flatten.include?(column.name)
+                 'Y'
+               else
+                 ''
+               end
+          t << [pk, column.name, column.sql_type,
+                column.sql_type_metadata.type, column.sql_type_metadata.limit || '',
+                column.sql_type_metadata.precision || '', column.sql_type_metadata.scale || '', column.default || '',
+                column.null, column.comment || '']
+        end
+        t
+      end
+    end
+
+    Pry.commands.block_command 'vd' do |name|
+      table_name = VD::get_table_name(name)
+      VD::table_info_vd(table_name)
+    end
+  end
+end

data/lib/pry-helper/commands.rb

@@ -0,0 +1,6 @@
+require 'pry-helper/commands/models'
+require 'pry-helper/commands/table'
+require 'pry-helper/commands/vd'
+
+module PryHelper::Commands
+end

data/lib/pry-helper/concerns/global_data_definition.rb

@@ -0,0 +1,245 @@
+require 'active_support/concern'
+
+module PryHelper
+  module Concerns
+    module GlobalDataDefinition
+      extend ActiveSupport::Concern
+
+      included do
+
+        # Example:
+        #
+        #   create_table :post, id: false, primary_key: :id do |t|
+        #     t.column :id, :bigint, precison: 19, comment: 'ID'
+        #     t.column :name, :string, comment: '名称'
+        #     t.column :gmt_created, :datetime, comment: '创建时间'
+        #     t.column :gmt_modified, :datetime, comment: '最后修改时间'
+        #   end
+        #
+        # Creates a new table with the name +table_name+. +table_name+ may either
+        # be a String or a Symbol.
+        #
+        # There are two ways to work with #create_table. You can use the block
+        # form or the regular form, like this:
+        #
+        # === Block form
+        #
+        #   # create_table() passes a TableDefinition object to the block.
+        #   # This form will not only create the table, but also columns for the
+        #   # table.
+        #
+        #   create_table(:suppliers) do |t|
+        #     t.column :name, :string, limit: 60
+        #     # Other fields here
+        #   end
+        #
+        # === Block form, with shorthand
+        #
+        #   # You can also use the column types as method calls, rather than calling the column method.
+        #   create_table(:suppliers) do |t|
+        #     t.string :name, limit: 60
+        #     # Other fields here
+        #   end
+        #
+        # === Regular form
+        #
+        #   # Creates a table called 'suppliers' with no columns.
+        #   create_table(:suppliers)
+        #   # Add a column to 'suppliers'.
+        #   add_column(:suppliers, :name, :string, {limit: 60})
+        #
+        # The +options+ hash can include the following keys:
+        # [<tt>:id</tt>]
+        #   Whether to automatically add a primary key column. Defaults to true.
+        #   Join tables for {ActiveRecord::Base.has_and_belongs_to_many}[rdoc-ref:Associations::ClassMethods#has_and_belongs_to_many] should set it to false.
+        #
+        #   A Symbol can be used to specify the type of the generated primary key column.
+        # [<tt>:primary_key</tt>]
+        #   The name of the primary key, if one is to be added automatically.
+        #   Defaults to +id+. If <tt>:id</tt> is false, then this option is ignored.
+        #
+        #   If an array is passed, a composite primary key will be created.
+        #
+        #   Note that Active Record models will automatically detect their
+        #   primary key. This can be avoided by using
+        #   {self.primary_key=}[rdoc-ref:AttributeMethods::PrimaryKey::ClassMethods#primary_key=] on the model
+        #   to define the key explicitly.
+        #
+        # [<tt>:options</tt>]
+        #   Any extra options you want appended to the table definition.
+        # [<tt>:temporary</tt>]
+        #   Make a temporary table.
+        # [<tt>:force</tt>]
+        #   Set to true to drop the table before creating it.
+        #   Set to +:cascade+ to drop dependent objects as well.
+        #   Defaults to false.
+        # [<tt>:if_not_exists</tt>]
+        #   Set to true to avoid raising an error when the table already exists.
+        #   Defaults to false.
+        # [<tt>:as</tt>]
+        #   SQL to use to generate the table. When this option is used, the block is
+        #   ignored, as are the <tt>:id</tt> and <tt>:primary_key</tt> options.
+        #
+        # ====== Add a backend specific option to the generated SQL (MySQL)
+        #
+        #   create_table(:suppliers, options: 'ENGINE=InnoDB DEFAULT CHARSET=utf8mb4')
+        #
+        # generates:
+        #
+        #   CREATE TABLE suppliers (
+        #     id bigint auto_increment PRIMARY KEY
+        #   ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4
+        #
+        # ====== Rename the primary key column
+        #
+        #   create_table(:objects, primary_key: 'guid') do |t|
+        #     t.column :name, :string, limit: 80
+        #   end
+        #
+        # generates:
+        #
+        #   CREATE TABLE objects (
+        #     guid bigint auto_increment PRIMARY KEY,
+        #     name varchar(80)
+        #   )
+        #
+        # ====== Change the primary key column type
+        #
+        #   create_table(:tags, id: :string) do |t|
+        #     t.column :label, :string
+        #   end
+        #
+        # generates:
+        #
+        #   CREATE TABLE tags (
+        #     id varchar PRIMARY KEY,
+        #     label varchar
+        #   )
+        #
+        # ====== Create a composite primary key
+        #
+        #   create_table(:orders, primary_key: [:product_id, :client_id]) do |t|
+        #     t.belongs_to :product
+        #     t.belongs_to :client
+        #   end
+        #
+        # generates:
+        #
+        #   CREATE TABLE order (
+        #       product_id bigint NOT NULL,
+        #       client_id bigint NOT NULL
+        #   );
+        #
+        #   ALTER TABLE ONLY "orders"
+        #     ADD CONSTRAINT orders_pkey PRIMARY KEY (product_id, client_id);
+        #
+        # ====== Do not add a primary key column
+        #
+        #   create_table(:categories_suppliers, id: false) do |t|
+        #     t.column :category_id, :bigint
+        #     t.column :supplier_id, :bigint
+        #   end
+        #
+        # generates:
+        #
+        #   CREATE TABLE categories_suppliers (
+        #     category_id bigint,
+        #     supplier_id bigint
+        #   )
+        #
+        # ====== Create a temporary table based on a query
+        #
+        #   create_table(:long_query, temporary: true,
+        #     as: "SELECT * FROM orders INNER JOIN line_items ON order_id=orders.id")
+        #
+        # generates:
+        #
+        #   CREATE TEMPORARY TABLE long_query AS
+        #     SELECT * FROM orders INNER JOIN line_items ON order_id=orders.id
+        #
+        # See also TableDefinition#column for details on how to create columns.
+        def create_table(table_name, **options, &blk)
+          ActiveRecord::Base.connection.create_table(table_name, **options, &blk)
+        end
+
+        # Creates a new join table with the name created using the lexical order of the first two
+        # arguments. These arguments can be a String or a Symbol.
+        #
+        #   # Creates a table called 'assemblies_parts' with no id.
+        #   create_join_table(:assemblies, :parts)
+        #
+        # You can pass an +options+ hash which can include the following keys:
+        # [<tt>:table_name</tt>]
+        #   Sets the table name, overriding the default.
+        # [<tt>:column_options</tt>]
+        #   Any extra options you want appended to the columns definition.
+        # [<tt>:options</tt>]
+        #   Any extra options you want appended to the table definition.
+        # [<tt>:temporary</tt>]
+        #   Make a temporary table.
+        # [<tt>:force</tt>]
+        #   Set to true to drop the table before creating it.
+        #   Defaults to false.
+
+        #
+        # Note that #create_join_table does not create any indices by default; you can use
+        # its block form to do so yourself:
+        #
+        #   create_join_table :products, :categories do |t|
+        #     t.index :product_id
+        #     t.index :category_id
+        #   end
+        #
+        # ====== Add a backend specific option to the generated SQL (MySQL)
+        #
+        #   create_join_table(:assemblies, :parts, options: 'ENGINE=InnoDB DEFAULT CHARSET=utf8')
+        #
+        # generates:
+        #
+        #   CREATE TABLE assemblies_parts (
+        #     assembly_id bigint NOT NULL,
+        #     part_id bigint NOT NULL,
+        #   ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+        #
+        def create_join_table(table_1, table_2, column_options: {}, **options)
+          ActiveRecord::Base.connection.create_join_table(table_1, table_2, column_options, **options)
+        end
+
+        # Drops a table from the database.
+        #
+        # [<tt>:force</tt>]
+        #   Set to +:cascade+ to drop dependent objects as well.
+        #   Defaults to false.
+        # [<tt>:if_exists</tt>]
+        #   Set to +true+ to only drop the table if it exists.
+        #   Defaults to false.
+        #
+        # Although this command ignores most +options+ and the block if one is given,
+        # it can be helpful to provide these in a migration's +change+ method so it can be reverted.
+        # In that case, +options+ and the block will be used by #create_table.
+        def drop_table(table_name, **options)
+          ActiveRecord::Base.connection.drop_table(table_name, **options)
+        end
+
+        # Drops the join table specified by the given arguments.
+        # See #create_join_table for details.
+        #
+        # Although this command ignores the block if one is given, it can be helpful
+        # to provide one in a migration's +change+ method so it can be reverted.
+        # In that case, the block will be used by #create_join_table.
+        def drop_join_table(table_1, table_2, **options)
+          ActiveRecord::Base.connection.drop_join_table(table_1, table_2, **options)
+        end
+
+        # Renames a table.
+        #
+        #   rename_table('octopuses', 'octopi')
+        #
+        def rename_table(table_name, new_name)
+          ActiveRecord::Base.connection.rename_table(table_name, new_name)
+        end
+
+      end
+    end
+  end
+end