arql 0.4.15 → 0.4.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d444bc5ecc11b4c15db01b52b413341e85525d71d82f24e994315418b728a989
-  data.tar.gz: 1e69014e37aafa3974c3aae3be52c37c7f3c27db2c7b59d169caa8b4de5ce6d7
+  metadata.gz: 2e298f643cc8cba53568449f235fed8f490cb93b35f6238477f3031bac708cf4
+  data.tar.gz: 5a575e23be87acd3031bcc870d6ed538c651b75f3bbdc7ffd258730bd1008ea7
 SHA512:
-  metadata.gz: 0dd50276ddff1a65d3d01bc7eb8ec05dbdd59d441eb8fe2555ca3ccaf2b951650ace6b7bf5908f4eccb2f38a0dec7000130f41c63f62df74e4a8ef4c6504897d
-  data.tar.gz: ada7756d3e50fbff30e8b6581b1eceaebff35fdacb7bf76bf504348410fd7152398515799de35f355e91c3d3cb87d87646a401901da3003bb4b16c2ead88bfd5
+  metadata.gz: c0de2dc777e08f079a7a52ab1423a5139b42bbf12fb7b315fe3ce4f44d525ab699629fdedde4bbd661fe98409692c36ab3800c232272e61d0b49a8b1ff2d1ced
+  data.tar.gz: c1e1aca6d3ead4305fd70dee0fbd5cb00e68ed87c39db856b2d6bf5080c4b7d3b2adc1fa20e5519e6b7bad295487e1fcd0604310ee6f7b3403cc218db179646f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    arql (0.4.15)
+    arql (0.4.16)
       activerecord (>= 6.1.5, < 7.1.0)
       activesupport (>= 6.1.5, < 7.1.0)
       caxlsx (~> 3.3.0)

data/README-zh_CN.org

@@ -199,6 +199,40 @@
         建的常量别名（Arql 默认也会按照一定的规则自动为生成的模型类创建别名，如果这里指定了别名，将会使用用户提供的值作
         为别名）
     12. =ignored_columns=: 一个列名的数组，在生成模型时将忽略这些列，默认为空数组
+    13. =rename_columns=: 一个 Hash，用于将数据库列名映射为新的名称。当列名与 ActiveRecord 内置方法冲突时（例如 =model_name=、
+        =valid=、=connection=、=type= 等），会导致 =ActiveRecord::DangerousAttributeError= 错误。使用此配置项可以重命名这些冲突列。
+        重命名后，原始列名将被隐藏，只能通过新名称访问。新名称同样可用于查询（例如 =where(new_name: 'value')=
+        会自动翻译为 =WHERE old_name = 'value'=）。arql 会在启动时校验新名称，确保其不与已有列名、ActiveRecord 保留方法名
+        或 arql 内置方法名冲突。如果新名称是 ActiveRecord 保留方法名，arql 将在启动时报错。
+
+    =rename_columns= 配置项示例:
+
+    #+BEGIN_SRC yaml
+        development:
+          adapter: mysql2
+          host: localhost
+          database: myapp
+          rename_columns:
+            model_name: record_model_name
+            valid: is_valid
+            type: biz_type
+    #+END_SRC
+
+    使用以上配置后:
+
+    #+begin_example
+    ARQL@dev(main) [1] ❯ Attachment.last
+    => #<I::Attachment:0xabc id: 1, record_model_name: "SomeModel", is_valid: true, biz_type: "image">
+
+    ARQL@dev(main) [2] ❯ Attachment.where(record_model_name: "SomeModel").to_sql
+    => "SELECT `attachments`.* FROM `attachments` WHERE `attachments`.`model_name` = 'SomeModel'"
+
+    ARQL@dev(main) [3] ❯ Attachment.last.is_valid
+    => true
+
+    ARQL@dev(main) [4] ❯ Attachment.last.model_name
+    => NoMethodError (原始名称已被隐藏)
+    #+end_example
 
     =model_names= 配置项的例子:
     

data/README.org

@@ -226,6 +226,41 @@
         the generated model class according to certain rules, and if an alias is specified here, the user-provided value
         will be used as the alias)
     12. =ignored_columns= : An array of column names to be ignored when generating the model, default is an empty array
+    13. =rename_columns= : A hash mapping original column names to new names. When a column name conflicts with an ActiveRecord
+        built-in method (e.g., =model_name=, =valid=, =connection=, =type=), it causes =ActiveRecord::DangerousAttributeError=.
+        Use this option to rename conflicting columns. The original column name will be hidden and only the new name will be
+        accessible. The new name also works in queries (e.g., =where(new_name: 'value')= translates to =WHERE old_name = 'value'=).
+        Arql validates that the new name does not conflict with existing columns, ActiveRecord reserved methods, or arql
+        built-in methods. If the new name is an ActiveRecord reserved method, arql will raise an error at startup.
+
+    Example of =rename_columns= configuration:
+
+    #+BEGIN_SRC yaml
+        development:
+          adapter: mysql2
+          host: localhost
+          database: myapp
+          rename_columns:
+            model_name: record_model_name
+            valid: is_valid
+            type: biz_type
+    #+END_SRC
+
+    With the above configuration:
+
+    #+begin_example
+    ARQL@dev(main) [1] ❯ Attachment.last
+    => #<I::Attachment:0xabc id: 1, record_model_name: "SomeModel", is_valid: true, biz_type: "image">
+
+    ARQL@dev(main) [2] ❯ Attachment.where(record_model_name: "SomeModel").to_sql
+    => "SELECT `attachments`.* FROM `attachments` WHERE `attachments`.`model_name` = 'SomeModel'"
+
+    ARQL@dev(main) [3] ❯ Attachment.last.is_valid
+    => true
+
+    ARQL@dev(main) [4] ❯ Attachment.last.model_name
+    => NoMethodError (original name is hidden)
+    #+end_example
 
     =model_names= Examples of configuration items:
 

data/lib/arql/definition.rb

@@ -239,14 +239,28 @@ module Arql
           end
           self.attribute_aliases = rename_columns.transform_keys(&:to_sym).invert
 
-          original_inspect = instance_method(:inspect)
-          rename_columns_for_inspect = rename_columns.dup
-          define_method(:inspect) do
-            result = original_inspect.bind(self).call
-            rename_columns_for_inspect.each do |old_name, new_name|
-              result = result.sub(/\b#{Regexp.escape(old_name.to_s)}(?=:)/, new_name.to_s)
+          rename_map = rename_columns.transform_keys(&:to_s)
+          define_method(:pretty_print) do |pp|
+            pp.object_address_group(self) do
+              if defined?(@attributes) && @attributes
+                attr_names = self.class.attribute_names.select { |name| _has_attribute?(name) }
+                pp.seplist(attr_names, proc { pp.text ',' }) do |attr_name|
+                  display_name = rename_map.fetch(attr_name, attr_name)
+                  pp.breakable ' '
+                  pp.group(1) do
+                    pp.text display_name
+                    pp.text ':'
+                    pp.breakable
+                    value = _read_attribute(attr_name)
+                    value = inspection_filter.filter_param(attr_name, value) unless value.nil?
+                    pp.pp value
+                  end
+                end
+              else
+                pp.breakable ' '
+                pp.text 'not initialized'
+              end
             end
-            result
           end
         end
       end

data/lib/arql/version.rb

@@ -1,3 +1,3 @@
 module Arql
-  VERSION = "0.4.15"
+  VERSION = "0.4.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arql
 version: !ruby/object:Gem::Version
-  version: 0.4.15
+  version: 0.4.16
 platform: ruby
 authors:
 - Liu Xiang