arql 0.2.12 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59eda4176935ad6c21bff248beac1078df7c44239f17c5febd60cd3af5617b34
-  data.tar.gz: f6362e715937b0792285ded2d9d10dc00a1e4e9cb224ec7e6ac01ea67d08f268
+  metadata.gz: 7814d23bef8d728235b779a5d8ddcd76565d7240fd37b7d6d9b62e37ed851d2f
+  data.tar.gz: cd9f77c2a41055bd20c18ec38ae3f461b580c3bfb983b4f73bf23df9fc027408
 SHA512:
-  metadata.gz: 50c7e6ac7e3014bc25a7b345ac126b61b79a194907d728140deef9a62ef2adc64947dc84cfad5870894005c3b1a48b7b1c96daee2708fac423ed71a207dbba96
-  data.tar.gz: 825621c088e16302953709aa518e5d19f5064212852b65cb230f685e10b47972400eeb2e77b921fa57fb16a8eb9af743e684a60d7d7bc7cfb0e8a61551608131
+  metadata.gz: ef4eb1f78e9419f02155a0f27d6903adcd553ed071eec9f589a86dd69b0d2ca0a8a858865d23d85ec50284ec7dfa7eac0b2290ba9162dbe56f732545e3d81179
+  data.tar.gz: 69ed39eca6d84f869190b7ee8e49aa5080dcfe13c0a46341a5552a01e41bdf03a8d31099257639fa28ce2dd6d81088d060fec402c79a7c1e6f442b94eda38249

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    arql (0.2.12)
-      activerecord (~> 6.0.3)
+    arql (0.3.1)
+      activerecord (>= 6.0.3, < 6.2.0)
       activesupport (~> 6.0.3)
       caxlsx (~> 3.0.2)
       composite_primary_keys (~> 12.0.3)
@@ -10,7 +10,7 @@ PATH
       net-ssh-gateway (~> 2.0.0)
       pry (~> 0.13.1)
       pry-byebug (~> 3.9.0)
-      pry-doc (~> 1.1.0)
+      pry-doc (~> 1.2.0)
       rainbow (~> 3.0.0)
       roo (~> 2.8.3)
       sqlite3 (~> 1.4)
@@ -20,65 +20,69 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activesupport (6.0.3.4)
+    activemodel (6.0.4.1)
+      activesupport (= 6.0.4.1)
+    activerecord (6.0.4.1)
+      activemodel (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
+    activesupport (6.0.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     byebug (11.1.3)
-    caxlsx (3.0.2)
+    caxlsx (3.0.4)
       htmlentities (~> 4.3, >= 4.3.4)
       mimemagic (~> 0.3)
       nokogiri (~> 1.10, >= 1.10.4)
       rubyzip (>= 1.3.0, < 3)
     coderay (1.1.3)
-    composite_primary_keys (12.0.3)
+    composite_primary_keys (12.0.10)
       activerecord (~> 6.0.0)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     htmlentities (4.3.4)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
+    mimemagic (0.4.3)
+      nokogiri (~> 1)
+      rake
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
     mysql2 (0.5.3)
     net-ssh (6.1.0)
     net-ssh-gateway (2.0.0)
       net-ssh (>= 4.0.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    pry-doc (1.1.0)
+    pry-doc (1.2.0)
       pry (~> 0.11)
       yard (~> 0.9.11)
+    racc (1.6.0)
     rainbow (3.0.0)
     rake (12.3.3)
     roo (2.8.3)
       nokogiri (~> 1)
       rubyzip (>= 1.3.0, < 3.0.0)
-    rubyzip (2.3.0)
+    rubyzip (2.3.2)
     sqlite3 (1.4.2)
     table_print (1.5.7)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.8)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    yard (0.9.25)
-    zeitwerk (2.4.2)
+    unicode-display_width (1.8.0)
+    yard (0.9.26)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -88,4 +92,4 @@ DEPENDENCIES
   rake (~> 12.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/arql.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %{Use ActiveRecord and Pry as your favorite SQL query editor.}
   spec.homepage      = "https://github.com/lululau/arql"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
 
 
@@ -28,13 +28,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sqlite3', '~> 1.4'
   # spec.add_dependency 'activerecord-sqlserver-adapter'
   # spec.add_dependency 'activerecord-oracle_enhanced-adapter'
-  spec.add_dependency 'activerecord', '~> 6.0.3'
+  spec.add_dependency 'activerecord', '>= 6.0.3', '< 6.2.0'
   spec.add_dependency 'composite_primary_keys', '~> 12.0.3'
   spec.add_dependency 'activesupport', '~> 6.0.3'
   spec.add_dependency 'net-ssh-gateway', '~> 2.0.0'
   spec.add_dependency 'pry', '~> 0.13.1'
   spec.add_dependency 'pry-byebug', '~> 3.9.0'
-  spec.add_dependency 'pry-doc', '~> 1.1.0'
+  spec.add_dependency 'pry-doc', '~> 1.2.0'
   spec.add_dependency 'rainbow', '~> 3.0.0'
   spec.add_dependency 'terminal-table', '~> 1.8.0'
   spec.add_dependency 'table_print', '~> 1.5.6'

data/lib/arql/app.rb

@@ -4,7 +4,7 @@ module Arql
   class App
 
     class << self
-      attr_accessor :log_io, :env, :prompt, :instance
+      attr_accessor :log_io, :env, :prompt, :instance, :connect_options
 
       def config
         @@effective_config
@@ -27,7 +27,8 @@ module Arql
       require "arql/definition"
       @options = options
       App.env = @options.env
-      Connection.open(connect_options)
+      App.connect_options = connect_options
+      Connection.open(App.connect_options)
       @definition = Definition.new(effective_config)
       load_initializer!
       App.instance = self

data/lib/arql/concerns/global_data_definition.rb

@@ -0,0 +1,244 @@
+require 'active_support/concern'
+
+module Arql
+  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