arql 0.3.31 → 0.4.1

data/auto-set-id-before-save-zh_CN.org

@@ -5,7 +5,7 @@
   创建一个文件 =~/.arql.d/auto_gen_id.rb= ，内容如下：
 
   #+BEGIN_SRC ruby
-    class ::ArqlModel
+    class ::Arql::BaseModel
       before_create do
         if id.blank?
           id_type = self.class.columns_hash['id'].sql_type.scan(/\w+/).first

data/auto-set-id-before-save.org

@@ -5,7 +5,7 @@
   Create a file =~/.arql.d/auto_gen_id.rb= with the following content:
 
   #+BEGIN_SRC ruby
-    class ::ArqlModel
+    class :Arql::BaseModel
       before_create do
         if id.blank?
           id_type = self.class.columns_hash['id'].sql_type.scan(/\w+/).first

data/custom-configurations-zh_CN.org

@@ -1,6 +1,6 @@
 * 配置文件中的自定义配置项
 
-  你可以在配置文件 (如默认的 =~/.arql.yaml= / =~/.arql.d/init.yaml= ) 中定义自己的配置项，然后在代码中通过 =Arql::App.config["CONF_KEY"]-= 来获取配置项的值。
+  你可以在配置文件 (如默认的 =~/.arql.yaml= / =~/.arql.d/init.yaml= ) 中定义自己的配置项，然后在代码中通过 =env_config(/my_env/)["CONF_KEY"]-= 来获取配置项的值。
 
   例如，假设系统对 BankAccount 表的 =account_no= 字段进行了加密，你可以在配置文件中定义加密的密钥：
 
@@ -23,7 +23,7 @@
       def self.encrypt_account_no(account_no)
         cipher = OpenSSL::Cipher.new('AES-128-ECB')
         cipher.encrypt
-        cipher.key = Arql::App.config["encrypt_key"]
+        cipher.key = env_config(/my_env/)["encrypt_key"]
         encrypted = cipher.update(account_no) + cipher.final
         encrypted.unpack('H*').first
       end
@@ -31,7 +31,7 @@
       def self.decrypt_account_no(encrypted_account_no)
         cipher = OpenSSL::Cipher.new('AES-128-ECB')
         cipher.decrypt
-        cipher.key = Arql::App.config["encrypt_key"]
+        cipher.key = env_config(/my_env/)["encrypt_key"]
         decrypted = cipher.update([encrypted_account_no].pack('H*')) + cipher.final
         decrypted
       end
@@ -48,3 +48,40 @@
       end
     end
   #+END_SRC
+
+  也可以直接使用 Namespace Module 的 config 方法来获取配置项的值，例如：
+
+  假设 Namespace Module 为 =NS=, 那么上述代码可以改写为：
+
+  #+BEGIN_SRC ruby
+    class BankAccount
+    
+      def self.encrypt_account_no(account_no)
+        cipher = OpenSSL::Cipher.new('AES-128-ECB')
+        cipher.encrypt
+        cipher.key = NS::config["encrypt_key"]
+        encrypted = cipher.update(account_no) + cipher.final
+        encrypted.unpack('H*').first
+      end
+    
+      def self.decrypt_account_no(encrypted_account_no)
+        cipher = OpenSSL::Cipher.new('AES-128-ECB')
+        cipher.decrypt
+        cipher.key = NS::config["encrypt_key"]
+        decrypted = cipher.update([encrypted_account_no].pack('H*')) + cipher.final
+        decrypted
+      end
+    
+    
+      # 从数据库查询出数据之后，自动解密 account_no 字段
+      after_find do
+        self.password = decrypt_account_no(self.password)
+      end
+    
+      # 保存数据之前，自动加密 account_no 字段
+      before_save do
+        self.password = encrypt_account_no(self.password)
+      end
+    end
+  #+END_SRC
+  

data/custom-configurations.org

@@ -1,54 +1,93 @@
 * Additional config items in Configuration File
 
-  You can define your own configuration items in the configuration file (such as the default =~/.arql.yaml= /
-  =~/.arql.d/init.yaml=), and then get the value of the configuration item in the code through
-  =Arql::App.config["CONF_KEY"]=.
-
-  For example, suppose the system encrypts the =account_no= field of the BankAccount table, you can define the
-  encryption key in the configuration file:
-
-  #+BEGIN_SRC yaml
-    dev:
-      <<: *default
-      host: 127.0.0.1
-      port: 3306
-      username: test
-      password: test123456
-      database: devel 
-      encrypt_key: "1234567890abcdef"
-  #+END_SRC
-
-  Then you can read the value of the configuration item in the Initialzier code (=~/.arql.rb= /
-  =~/.arql.d/init.rb=):
-  
-  #+BEGIN_SRC ruby
+  You can define your own configuration items in a configuration file (such as the default =~/.arql.yaml= /
+  =~/.arql.d/init.yaml= ), and then get the value of the configuration item in the code with
+  =env_config(/my_env/)["CONF_KEY"]-=  .
+
+
+  For example, let's say the system encrypts the field of the =account_no= BankAccount table, and you can define the key
+  for encryption in the configuration file:
+
+  #+begin_src yaml
+      dev:
+        <<: *default
+        host: 127.0.0.1
+        port: 3306
+        username: test
+        password: test123456
+        database: devel
+        encrypt_key: "1234567890abcdef"
+  #+end_src
+
+
+  You can then read the value of the config item in the Initialzier code ( =~/.arql.rb= / =~/.arql.d/init.rb= ):
+
+  #+begin_src ruby
     class BankAccount
-    
+
       def self.encrypt_account_no(account_no)
         cipher = OpenSSL::Cipher.new('AES-128-ECB')
         cipher.encrypt
-        cipher.key = Arql::App.config["encrypt_key"]
+        cipher.key = env_config(/my_env/)["encrypt_key"]
         encrypted = cipher.update(account_no) + cipher.final
         encrypted.unpack('H*').first
       end
-    
+
       def self.decrypt_account_no(encrypted_account_no)
         cipher = OpenSSL::Cipher.new('AES-128-ECB')
         cipher.decrypt
-        cipher.key = Arql::App.config["encrypt_key"]
+        cipher.key = env_config(/my_env/)["encrypt_key"]
         decrypted = cipher.update([encrypted_account_no].pack('H*')) + cipher.final
         decrypted
       end
-    
-    
-      # After querying the data from the database, automatically decrypt the account_no field
+
+
+      # 从数据库查询出数据之后，自动解密 account_no 字段
       after_find do
         self.password = decrypt_account_no(self.password)
       end
-    
-      # Before saving the data, automatically encrypt the account_no field
+
+      # 保存数据之前，自动加密 account_no 字段
+      before_save do
+        self.password = encrypt_account_no(self.password)
+      end
+    end
+  #+end_src
+
+
+  You can also use the config method of the Namespace Module to obtain the value of the configuration item, for example:
+
+
+  Assuming the Namespace Module is , then =NS= the above code can be rewritten as:
+
+  #+begin_src ruby
+    class BankAccount
+
+      def self.encrypt_account_no(account_no)
+        cipher = OpenSSL::Cipher.new('AES-128-ECB')
+        cipher.encrypt
+        cipher.key = NS::config["encrypt_key"]
+        encrypted = cipher.update(account_no) + cipher.final
+        encrypted.unpack('H*').first
+      end
+
+      def self.decrypt_account_no(encrypted_account_no)
+        cipher = OpenSSL::Cipher.new('AES-128-ECB')
+        cipher.decrypt
+        cipher.key = NS::config["encrypt_key"]
+        decrypted = cipher.update([encrypted_account_no].pack('H*')) + cipher.final
+        decrypted
+      end
+
+
+      # 从数据库查询出数据之后，自动解密 account_no 字段
+      after_find do
+        self.password = decrypt_account_no(self.password)
+      end
+
+      # 保存数据之前，自动加密 account_no 字段
       before_save do
         self.password = encrypt_account_no(self.password)
       end
     end
-  #+END_SRC
+  #+end_src

data/define-associations-zh_CN.org

@@ -5,26 +5,29 @@
   Initializer 文件是一个 Ruby 文件，因此可以在其中定义关联关系，例如：
 
   #+BEGIN_SRC ruby
-    class Student
-      has_many :courses, foreign_key: :student_id, class_name: 'Course'
-      belongs_to :school, foreign_key: :school_id, class_name: 'School'
-
-      has_and_belongs_to_many :teachers, join_table: 'students_teachers', foreign_key: :student_id, association_foreign_key: :teacher_id, class_name: 'Teacher'
-    end
-
-    class Course
-      belongs_to :student, foreign_key: :student_id, class_name: 'Student'
-    end
-
-    class School
-      has_many :students, foreign_key: :school_id, class_name: 'Student'
-    end
-
-    class Teacher
-      has_and_belongs_to_many :students, join_table: 'students_teachers', foreign_key: :teacher_id, association_foreign_key: :student_id, class_name: 'Student'
+    module Blog
+      class Student
+        has_many :courses, foreign_key: :student_id, class_name: 'Course'
+        belongs_to :school, foreign_key: :school_id, class_name: 'School'
+    
+        has_and_belongs_to_many :teachers, join_table: 'students_teachers', foreign_key: :student_id, association_foreign_key: :teacher_id, class_name: 'Teacher'
+      end
+    
+      class Course
+        belongs_to :student, foreign_key: :student_id, class_name: 'Student'
+      end
+    
+      class School
+        has_many :students, foreign_key: :school_id, class_name: 'Student'
+      end
+    
+      class Teacher
+        has_and_belongs_to_many :students, join_table: 'students_teachers', foreign_key: :teacher_id, association_foreign_key: :student_id, class_name: 'Student'
+      end
     end
   #+END_SRC
 
+
   1. =has_one= 表明此表是一对一关系的属主
   2. =belongs_to= 表明此表是一对多或一对一关系的从属方
   3. =has_and_belongs_to_many= 表明此表是多对多关系的其中一方
@@ -36,3 +39,14 @@
 
   可以参考： https://guides.rubyonrails.org/association_basics.html
 
+  考虑到模型类都是定义在 Namespace module 下面的, 因此这里的 Blog 是必要的。
+
+  当然，不管通过 =-e= 选项选择了哪个环境，Arql 默认都会加载 =~/.arql.rb= 或 =~/.arql.d/init.rb= 文件，
+  因此像上述示例中把固定的 Namespace =Blog= 放在默认的初始化文件中, 不是一个好的选择。
+
+  有两种方案解决这个问题：
+
+  1. 使用 arql 时，对于不同的环境，用 =-i= 选项来指定不同的初始化文件，例如: =arql -e blog -i ~/.arql.d/blog.rb=
+  2. 参考 [[./initializer-structure-zh_CN.org][将不同环境的初始化代码放在不同的文件中]]
+
+  

data/define-associations.org

@@ -1,37 +1,60 @@
-* Define associations in Initializers
+* 1. Define the relationship in the initializer file
 
-  You can define associations in Initializers. Arql will generate model classes based on the database schema when it starts, and then load the Initializer file.
 
-  The Initializer file is a Ruby file, so you can define associations in it, for example:
+  Associations can be defined in the initializer file, and when Arql starts, it first generates the model class based on
+  the database schema and then loads the initializer file.
 
-  #+BEGIN_SRC ruby
-    class Student
-      has_many :courses, foreign_key: :student_id, class_name: 'Course'
-      belongs_to :school, foreign_key: :school_id, class_name: 'School'
 
-      has_and_belongs_to_many :teachers, join_table: 'students_teachers', foreign_key: :student_id, association_foreign_key: :teacher_id, class_name: 'Teacher'
-    end
+  The initializer file is a Ruby file, so you can define associations within it, for example:
 
-    class Course
-      belongs_to :student, foreign_key: :student_id, class_name: 'Student'
-    end
+  #+begin_src ruby
+    module Blog
+      class Student
+        has_many :courses, foreign_key: :student_id, class_name: 'Course'
+        belongs_to :school, foreign_key: :school_id, class_name: 'School'
 
-    class School
-      has_many :students, foreign_key: :school_id, class_name: 'Student'
-    end
+        has_and_belongs_to_many :teachers, join_table: 'students_teachers', foreign_key: :student_id, association_foreign_key: :teacher_id, class_name: 'Teacher'
+      end
+
+      class Course
+        belongs_to :student, foreign_key: :student_id, class_name: 'Student'
+      end
 
-    class Teacher
-      has_and_belongs_to_many :students, join_table: 'students_teachers', foreign_key: :teacher_id, association_foreign_key: :student_id, class_name: 'Student'
+      class School
+        has_many :students, foreign_key: :school_id, class_name: 'Student'
+      end
+
+      class Teacher
+        has_and_belongs_to_many :students, join_table: 'students_teachers', foreign_key: :teacher_id, association_foreign_key: :student_id, class_name: 'Student'
+      end
     end
-  #+END_SRC
-
-  1. =has_one= indicates that this table is the owner of a one-to-one relationship
-  2. =belongs_to= indicates that this table is the dependent side of a one-to-many or one-to-one relationship
-  3. =has_and_belongs_to_many= indicates that this table is one of the many-to-many relationships
-  4. =class_name= indicates the Model class name of the corresponding relationship (the Model class name is actually the CamelCase form of the table name)
-  5. =foreign_key= indicates the name of the association field on the dependent side of the association
-  6. =primary_key= indicates the name of the association field on the owner side of the association
-  7. =join_table= in many-to-many relationships, indicates the name of the intermediate table that associates the two tables
-  8. =association_foreign_key= in many-to-many relationships, indicates the association field name of the other Model in the intermediate table
-
-  You can refer to: https://guides.rubyonrails.org/association_basics.html
+  #+end_src
+
+  1.  =has_one= Indicates that this table is a one-to-one relationship with the owner
+  2. =belongs_to= Indicates that this table is a subordinate of a one-to-many or one-to-one relationship
+  3. =has_and_belongs_to_many= Indicates that this table is one of the parties to a many-to-many relationship
+  4. =class_name= The model class name of the other party that indicates the relationship (the model class name is
+     actually the CamelCase form of the table name)
+  5. =foreign_key= Indicates the name of the associated field on the side of the dependent table in the association
+  6. =primary_key= Indicates the name of the association field on the side of the master table in the association
+  7. =join_table= In a many-to-many relationship, the name of the intermediate table that is associated with two tables is
+     indicated
+  8. =association_foreign_key= In a many-to-many relationship, indicates the name of the field associated with the other
+     model's model in the intermediate table
+
+  可以参考： [[https://guides.rubyonrails.org/association_basics.html]]
+
+
+  Considering that the model classes are all defined under the Namespace module, a blog here is necessary.
+
+
+  Of course, Arql will load the =~/.arql.rb= OR =~/.arql.d/init.rb= file by default, regardless of which environment is
+  selected via the =-e= options, so putting a fixed namespace =Blog= in the default initialization file like in the
+  example above is not a good choice.
+
+  There are two ways to solve this problem:
+
+  1.
+     When using arql, for different environments, use =-i= the option to specify different initialization files, such as:
+     =arql -e blog -i ~/.arql.d/blog.rb=
+  2. Refer to Put the initialization code for different environments in different files

data/initializer-structure-zh_CN.org

@@ -19,15 +19,33 @@
   然后在 =~/.arql.d/init.eb= 文件中写入以下代码：
 
   #+BEGIN_SRC ruby
-    ["apollo", "space"].each do |project|
-      if Arql::App.env.try { |e| e.include?(project + ".") }
-        load(File.absolute_path(File.dirname(__FILE__) + "/#{project}.rb"))
-        break
+    Dir.glob(File.dirname(__FILE__) + '/*.rb').each do |f|
+      Arql::App.instance.definitions.each do |env, definition|
+        if env.starts_with?(File.basename(f, '.rb'))
+          load(f, definition.namespace_module)
+        end
       end
     end
   #+END_SRC
 
-  这样，当执行 =arql -e apollo.dev= 或 =arql =e apollo.prod= 时，就会加载 =apollo.rb= 文件中的初始化代码；当执行 =arql
+  这样，当执行 =arql -e apollo.dev= 或 =arql -e apollo.prod= 时，就会加载 =apollo.rb= 文件中的初始化代码；当执行 =arql
   -e space.dev= 或 =arql -e space.prod= 时，就会加载 =space.rb= 文件中的初始化代码。
 
+   =apollo.rb= 或 =space.rb= 文件中的代码将在对应的 Namespace Module 下执行：
+
+  #+BEGIN_SRC ruby
+    class Astronaut
+      has_many :missions
+    end
+  #+END_SRC
+
+  等价于：
+
+  #+BEGIN_SRC ruby
+    module Apollo
+      class Astronaut
+        has_many :missions
+      end
+    end
+  #+END_SRC
   

data/initializer-structure.org

@@ -1,31 +1,59 @@
 * Place your initialization code in a file named after the environment
 
-  If you have multiple environments in your configuration file, you can place the initialization code for each environment in a separate file to avoid conflicts.
 
-  Suppose you have 4 database environments in your configuration file:
+  There are often multiple environment configurations for multiple databases in the configuration file, so you can use the
+  method here to put the initialization code of different environments in different files to avoid conflicts.
 
-  + apollo.dev
-  + apollo.prod
-  + space.dev
-  + space.prod
+  Let's say you have 4 database environments configured in the configuration file:
 
-  You can create the following files in the =~/.arql.d/= directory:
+  - apollo.dev
+  - apollo.prod
+  - space.dev
+  - space.prod
 
-  + apollo.rb
-  + space.rb
 
-  Place the initialization code for the apollo project in the =apollo.rb= file; place the initialization code for the space project in the =space.rb= file.
+  Then you can create the following file in the =~/.arql.d/= directory:
+
+  - apollo.rb
+  - space.rb
+
+
+  Place the initialization code for the Apollo project =apollo.rb= in the file; Place the initialization code for the
+  space project =space.rb= in the file.
+
 
   Then write the following code in the =~/.arql.d/init.eb= file:
 
-  #+BEGIN_SRC ruby
-    ["apollo", "space"].each do |project|
-      if Arql::App.env.try { |e| e.include?(project + ".") }
-        load(File.absolute_path(File.dirname(__FILE__) + "/#{project}.rb"))
-        break
+  #+begin_src ruby
+    Dir.glob(File.dirname(__FILE__) + '/*.rb').each do |f|
+      Arql::App.instance.definitions.each do |env, definition|
+        if env.starts_with?(File.basename(f, '.rb'))
+          load(f, definition.namespace_module)
+        end
       end
     end
-  #+END_SRC
+  #+end_src
+
+
+  In this way, =arql -e apollo.prod= when or is executed, the initialization =apollo.rb= code in the file is loaded, and
+  =arql -e space.prod= when or is executed =arql -e apollo.dev= =arql -e space.dev= , the initialization code in the file
+  is loaded =space.rb=  .
+
 
-  Now, when you run =arql -e apollo.dev= or =arql =e apollo.prod=, the initialization code in the =apollo.rb= file will be loaded; when you run =arql -e space.dev= or =arql -e space.prod=, the initialization code in the =space.rb= file will be loaded.
-  
+  =apollo.rb= The code in the =space.rb= or file will be executed under the corresponding Namespace Module:
+
+  #+begin_src ruby
+    class Astronaut
+      has_many :missions
+    end
+  #+end_src
+
+  Equivalent to:
+
+  #+begin_src ruby
+    module Apollo
+      class Astronaut
+        has_many :missions
+      end
+    end
+  #+end_src