arql 0.3.29 → 0.3.31

data/helper-for-datetime-range-query-zh_CN.org

@@ -0,0 +1,216 @@
+* 定义快速按时间查询的便利方法
+  
+** 问题
+
+   对于按照时间范围查询的需求，一般需要构造一个表示时间范围的 Range 对象，例如：
+
+   #+BEGIN_SRC ruby
+     Student.where(created_at: Time.now.beginning_of_day..Time.now.end_of_day)
+   #+END_SRC
+
+   或者
+
+   #+BEGIN_SRC ruby
+     Student.where(created_at: Time.new(2016, 1, 1)..Time.new(2016, 12, 31))
+   #+END_SRC
+
+** 定义一个便利方法
+  
+   为了简化构造时间 Range 对象的过程，我们可以定义一个便利方法，例如：
+
+   创建一个文件 =~/.arql.d/date_range.rb= ，内容如下：
+
+   #+BEGIN_SRC ruby
+     module Kernel
+    
+       # == Example:
+       #  Range
+       #    1. -3..0
+       #    2. '27'..'29'
+       #    3. '04-01'..'04-10'
+       #    4. '2021-04-01'..'2021-04-10'
+       #  Array
+       #    1. [nil, nil] or [] => 1970-01-01 ~ 1000 days later from now
+       #    2. [:yday, :today] or [:yesterday, :today]
+       #    3. [-10.months, :today]
+       #  Others
+       #    1. Time.now or Date.today
+       #    2. :now or :today
+       #    3. :yesterday or :yday
+       #    4. -2
+       #    5. -2.months
+       def dates_range(dates)
+         dates = :yesterday if dates == :yday
+         if dates.is_a?(Range)
+           s = if dates.begin.is_a?(Integer)
+                 (Time.now+dates.begin.days).beginning_of_day
+               elsif dates.begin.is_a?(String) && dates.begin =~ /^\d{4}-\d{2}-\d{2}$/
+                 Time.parse(dates.begin).beginning_of_day
+               elsif dates.begin.is_a?(String) && dates.begin =~ /^\d{2}-\d{2}$/
+                 Time.strptime(dates.begin, '%m-%d').beginning_of_day
+               elsif dates.begin.is_a?(String) && dates.begin =~ /^\d{2}$/
+                 Time.strptime(dates.begin, '%d').beginning_of_day
+               else
+                 dates.begin
+               end
+           e = if dates.end.is_a?(Integer)
+                 (Time.now+dates.end.days).end_of_day
+               elsif dates.end.is_a?(String) && dates.end =~ /^\d{4}-\d{2}-\d{2}$/
+                 Time.parse(dates.end).end_of_day
+               elsif dates.end.is_a?(String) && dates.end =~ /^\d{2}-\d{2}$/
+                 Time.strptime(dates.end, '%m-%d').end_of_day
+               elsif dates.end.is_a?(String) && dates.end =~ /^\d{2}$/
+                 Time.strptime(dates.end, '%d').end_of_day
+               else
+                 dates.end
+               end
+           s..e
+         elsif dates.is_a?(Array)
+           if dates.size == 2
+             s = dates.first || Date.new(1970, 1, 1)
+             s = if s.is_a?(Time) || s.is_a?(Date)
+                   s.beginning_of_day
+                 elsif s == :now
+                   Time.now.beginning_of_day
+                 elsif s == :today
+                   Date.today.beginning_of_day
+                 elsif s == :yesterday || s == :yday
+                   Date.yesterday.beginning_of_day
+                 elsif s.in?(Time.instance_methods)
+                   Time.now.send(s).beginning_of_day
+                 elsif s.is_a?(ActiveSupport::Duration)
+                   (Time.now+s).beginning_of_day
+                 elsif s.is_a?(Integer)
+                   (Time.now+s.days).beginning_of_day
+                 else
+                   raise "Not supported s: #{s}"
+                 end
+             e = dates.last || Date.today + 1000.days
+             e = if e.is_a?(Time) || e.is_a?(Date)
+                   e.end_of_day
+                 elsif e == :now
+                   Time.now.end_of_day
+                 elsif e == :today
+                   Date.today.end_of_day
+                 elsif e == :yesterday || e == :yday
+                   Date.yesterday.end_of_day
+                 elsif e.in?(Time.instance_methods)
+                   Time.now.send(e).end_of_day
+                 elsif e.is_a?(ActiveSupport::Duration)
+                   (Time.now+e).end_of_day
+                 elsif e.is_a?(Integer)
+                   (Time.now+e.days).beginning_of_day
+                 else
+                   raise "Not supported e: #{e}"
+                 end
+             return s..e
+           else
+             times = dates.map do |date|
+               if date.nil?
+                 nil
+               elsif date.is_a?(Time)
+                 date
+               elsif date == :now
+                 Time.now
+               elsif date.in?(Time.instance_methods)
+                 Time.now.send(date)
+               elsif date.is_a?(ActiveSupport::Duration)
+                 Time.now+date
+               elsif date.is_a?(Integer)
+                 (Time.now+date.days).beginning_of_day
+               else
+                 raise "Not supported date: #{date}"
+               end
+             end
+             s = times.first || Time.new(1970, 1, 1, 0, 0, 0)
+             e = times.last || Time.now + 1000.days
+             return s..e
+           end
+         else
+           if dates.is_a?(Time) or dates.is_a?(Date)
+             dates = dates.beginning_of_day..dates.end_of_day
+           elsif dates == :now
+             dates = Time.now.beginning_of_day..Time.now.end_of_day
+           elsif dates == :today
+             dates = Date.today.beginning_of_day..Date.today.end_of_day
+           elsif dates == :yday || dates == :yesterday
+             dates = Date.yesterday.beginning_of_day..Date.yesterday.end_of_day
+           elsif dates.in?(Time.instance_methods)
+             dates = Time.now.send(dates).beginning_of_day..Time.now.send(dates).end_of_day
+           elsif dates.is_a?(ActiveSupport::Duration)
+             dates = (Time.now+dates).beginning_of_day..(Time.now+dates).end_of_day
+           elsif dates.is_a?(Integer)
+             (Time.now+dates.days).beginning_of_day..(Time.now+dates.days).end_of_day
+           else
+             raise "Not supported dates: #{dates}"
+           end
+         end
+       end
+    
+       alias_method :dates, :dates_range
+     end
+    
+     class ::ArqlModel
+    
+       class << self
+         def ts_attribute_for_create
+           (timestamp_attributes_for_create||[]).find { |e| e.in?(column_names) }
+         end
+    
+         def ts_attribute_for_update
+           (timestamp_attributes_for_update||[]).find { |e| e.in?(column_names) }
+         end
+    
+    
+         def created_on(dates)
+           attr = ts_attribute_for_create
+           raise 'No attrtibute for create defined' unless attr
+           where(attr => dates_range(dates))
+         end
+    
+         alias on created_on
+    
+         def today
+           created_on(0)
+         end
+    
+         def modified_on(dates)
+           attr = ts_attribute_for_update
+           raise 'No attrtibute for update defined' unless attr
+           where(attr: dates_range(dates))
+         end
+       end
+     end
+   #+END_SRC
+  
+   然后在 =~/.arql.d/init.rb= 中引入这个文件:
+
+   #+BEGIN_SRC ruby
+     load(File.absolute_path(File.dirname(__FILE__) + "/date_range.rb"))
+   #+END_SRC
+
+  
+** 使用方法
+
+   然后就可以使用这个方法了:
+
+   #+BEGIN_SRC ruby
+     Student.where(created_at: dates(0)). # 查询今天创建的
+     Student.where(created_at: dates(:today)). # 查询今天创建的
+     Student.where(created_at: dates('2016-01-01'..'2016-01-31')) # 查询 2016 年 1 月创建的
+     Student.where(created_at: dates('01'..'10'))  # 查询当月 1-10 号创建的
+     Student.where(created_at: dates('03-01'..'04-10'))  # 查询当年 3 月 1 日到 4 月 10 日创建的
+     Student.where(created_at: dates(-20..-1))  # 查询 20 天前到昨天创建的
+   #+END_SRC
+
+   如果是对 created_at 字段 (在 =init.yaml= 中通过 =created_at= 配置，默认值是 =created_at=) 进行查询, 可以直接使用:
+
+   #+BEGIN_SRC ruby
+     Student.on(0). # 查询今天创建的
+     Student.on(:today). # 查询今天创建的
+     Student.on('2016-01-01'..'2016-01-31') # 查询 2016 年 1 月创建的
+     Student.on('01'..'10')  # 查询当月 1-10 号创建的
+     Student.on('03-01'..'04-10')  # 查询当年 3 月 1 日到 4 月 10 日创建的
+     Student.on(-20..-1)  # 查询 20 天前到昨天创建的
+   #+END_SRC
+

data/helper-for-datetime-range-query.org

@@ -0,0 +1,218 @@
+* Define helper function to create datetime range objects
+  
+** Problem
+
+   When we need to query records within a time range, we need to construct a Range object representing the time range, for example:
+
+   #+BEGIN_SRC ruby
+     Student.where(created_at: Time.now.beginning_of_day..Time.now.end_of_day)
+   #+END_SRC
+
+   or
+
+   #+BEGIN_SRC ruby
+     Student.where(created_at: Time.new(2016, 1, 1)..Time.new(2016, 12, 31))
+   #+END_SRC
+
+** Define a helper function
+
+    To simplify the process of constructing a time Range object, we can define a helper function, for example:
+  
+    Create a file =~/.arql.d/date_range.rb= with the following content:
+
+       #+BEGIN_SRC ruby
+     module Kernel
+    
+       # == Example:
+       #  Range
+       #    1. -3..0
+       #    2. '27'..'29'
+       #    3. '04-01'..'04-10'
+       #    4. '2021-04-01'..'2021-04-10'
+       #  Array
+       #    1. [nil, nil] or [] => 1970-01-01 ~ 1000 days later from now
+       #    2. [:yday, :today] or [:yesterday, :today]
+       #    3. [-10.months, :today]
+       #  Others
+       #    1. Time.now or Date.today
+       #    2. :now or :today
+       #    3. :yesterday or :yday
+       #    4. -2
+       #    5. -2.months
+       def dates_range(dates)
+         dates = :yesterday if dates == :yday
+         if dates.is_a?(Range)
+           s = if dates.begin.is_a?(Integer)
+                 (Time.now+dates.begin.days).beginning_of_day
+               elsif dates.begin.is_a?(String) && dates.begin =~ /^\d{4}-\d{2}-\d{2}$/
+                 Time.parse(dates.begin).beginning_of_day
+               elsif dates.begin.is_a?(String) && dates.begin =~ /^\d{2}-\d{2}$/
+                 Time.strptime(dates.begin, '%m-%d').beginning_of_day
+               elsif dates.begin.is_a?(String) && dates.begin =~ /^\d{2}$/
+                 Time.strptime(dates.begin, '%d').beginning_of_day
+               else
+                 dates.begin
+               end
+           e = if dates.end.is_a?(Integer)
+                 (Time.now+dates.end.days).end_of_day
+               elsif dates.end.is_a?(String) && dates.end =~ /^\d{4}-\d{2}-\d{2}$/
+                 Time.parse(dates.end).end_of_day
+               elsif dates.end.is_a?(String) && dates.end =~ /^\d{2}-\d{2}$/
+                 Time.strptime(dates.end, '%m-%d').end_of_day
+               elsif dates.end.is_a?(String) && dates.end =~ /^\d{2}$/
+                 Time.strptime(dates.end, '%d').end_of_day
+               else
+                 dates.end
+               end
+           s..e
+         elsif dates.is_a?(Array)
+           if dates.size == 2
+             s = dates.first || Date.new(1970, 1, 1)
+             s = if s.is_a?(Time) || s.is_a?(Date)
+                   s.beginning_of_day
+                 elsif s == :now
+                   Time.now.beginning_of_day
+                 elsif s == :today
+                   Date.today.beginning_of_day
+                 elsif s == :yesterday || s == :yday
+                   Date.yesterday.beginning_of_day
+                 elsif s.in?(Time.instance_methods)
+                   Time.now.send(s).beginning_of_day
+                 elsif s.is_a?(ActiveSupport::Duration)
+                   (Time.now+s).beginning_of_day
+                 elsif s.is_a?(Integer)
+                   (Time.now+s.days).beginning_of_day
+                 else
+                   raise "Not supported s: #{s}"
+                 end
+             e = dates.last || Date.today + 1000.days
+             e = if e.is_a?(Time) || e.is_a?(Date)
+                   e.end_of_day
+                 elsif e == :now
+                   Time.now.end_of_day
+                 elsif e == :today
+                   Date.today.end_of_day
+                 elsif e == :yesterday || e == :yday
+                   Date.yesterday.end_of_day
+                 elsif e.in?(Time.instance_methods)
+                   Time.now.send(e).end_of_day
+                 elsif e.is_a?(ActiveSupport::Duration)
+                   (Time.now+e).end_of_day
+                 elsif e.is_a?(Integer)
+                   (Time.now+e.days).beginning_of_day
+                 else
+                   raise "Not supported e: #{e}"
+                 end
+             return s..e
+           else
+             times = dates.map do |date|
+               if date.nil?
+                 nil
+               elsif date.is_a?(Time)
+                 date
+               elsif date == :now
+                 Time.now
+               elsif date.in?(Time.instance_methods)
+                 Time.now.send(date)
+               elsif date.is_a?(ActiveSupport::Duration)
+                 Time.now+date
+               elsif date.is_a?(Integer)
+                 (Time.now+date.days).beginning_of_day
+               else
+                 raise "Not supported date: #{date}"
+               end
+             end
+             s = times.first || Time.new(1970, 1, 1, 0, 0, 0)
+             e = times.last || Time.now + 1000.days
+             return s..e
+           end
+         else
+           if dates.is_a?(Time) or dates.is_a?(Date)
+             dates = dates.beginning_of_day..dates.end_of_day
+           elsif dates == :now
+             dates = Time.now.beginning_of_day..Time.now.end_of_day
+           elsif dates == :today
+             dates = Date.today.beginning_of_day..Date.today.end_of_day
+           elsif dates == :yday || dates == :yesterday
+             dates = Date.yesterday.beginning_of_day..Date.yesterday.end_of_day
+           elsif dates.in?(Time.instance_methods)
+             dates = Time.now.send(dates).beginning_of_day..Time.now.send(dates).end_of_day
+           elsif dates.is_a?(ActiveSupport::Duration)
+             dates = (Time.now+dates).beginning_of_day..(Time.now+dates).end_of_day
+           elsif dates.is_a?(Integer)
+             (Time.now+dates.days).beginning_of_day..(Time.now+dates.days).end_of_day
+           else
+             raise "Not supported dates: #{dates}"
+           end
+         end
+       end
+    
+       alias_method :dates, :dates_range
+     end
+    
+     class ::ArqlModel
+    
+       class << self
+         def ts_attribute_for_create
+           (timestamp_attributes_for_create||[]).find { |e| e.in?(column_names) }
+         end
+    
+         def ts_attribute_for_update
+           (timestamp_attributes_for_update||[]).find { |e| e.in?(column_names) }
+         end
+    
+    
+         def created_on(dates)
+           attr = ts_attribute_for_create
+           raise 'No attrtibute for create defined' unless attr
+           where(attr => dates_range(dates))
+         end
+    
+         alias on created_on
+    
+         def today
+           created_on(0)
+         end
+    
+         def modified_on(dates)
+           attr = ts_attribute_for_update
+           raise 'No attrtibute for update defined' unless attr
+           where(attr: dates_range(dates))
+         end
+       end
+     end
+   #+END_SRC
+
+    
+    Then include this file in =~/.arql.d/init.rb=:
+  
+    #+BEGIN_SRC ruby
+      load(File.absolute_path(File.dirname(__FILE__) + "/date_range.rb"))
+    #+END_SRC
+
+
+** Usage
+
+    Then you can use this method:
+
+    #+BEGIN_SRC ruby
+      Student.where(created_at: dates(0)). # Query records created today
+      Student.where(created_at: dates(:today)). # Query records created today
+      Student.where(created_at: dates('2016-01-01'..'2016-01-31')) # Query records created in January 2016
+      Student.where(created_at: dates('01'..'10'))  # Query records created on the 1st to the 10th of the current month
+      Student.where(created_at: dates('03-01'..'04-10'))  # Query records created from March 1st to April 10th of the current year
+      Student.where(created_at: dates(-20..-1))  # Query records created 20 days ago to yesterday
+    #+END_SRC
+
+    If you are querying the =created_at= field (configured in =init.yaml= with =created_at=, the default value is =created_at=), you can use:
+
+    #+BEGIN_SRC ruby
+      Student.on(0). # Query records created today
+      Student.on(:today). # Query records created today
+      Student.on('2016-01-01'..'2016-01-31') # Query records created in January 2016
+      Student.on('01'..'10')  # Query records created on the 1st to the 10th of the current month
+      Student.on('03-01'..'04-10')  # Query records created from March 1st to April 10th of the current year
+      Student.on(-20..-1)  # Query records created 20 days ago to yesterday
+    #+END_SRC
+
+

data/initializer-structure-zh_CN.org

@@ -0,0 +1,33 @@
+* 将不同环境的初始化代码放在不同的文件中
+
+  配置文件中往往有多个数据库的多个环境配置，这时候可以使用这里的方法，将不同环境的初始化代码放在不同的文件中来避免冲突。
+
+  假设配置文件中配置了 4 个数据库环境：
+
+  + apollo.dev
+  + apollo.prod
+  + space.dev
+  + space.prod
+
+  那么可以在 =~/.arql.d/= 目录下创建以下文件：
+
+  + apollo.rb
+  + space.rb
+
+  在 =apollo.rb= 文件中放置 apollo 项目的初始化代码; 在 =space.rb= 文件中放置 space 项目的初始化代码。
+
+  然后在 =~/.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
+      end
+    end
+  #+END_SRC
+
+  这样，当执行 =arql -e apollo.dev= 或 =arql =e apollo.prod= 时，就会加载 =apollo.rb= 文件中的初始化代码；当执行 =arql
+  -e space.dev= 或 =arql -e space.prod= 时，就会加载 =space.rb= 文件中的初始化代码。
+
+  

data/initializer-structure.org

@@ -0,0 +1,31 @@
+* 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:
+
+  + apollo.dev
+  + apollo.prod
+  + space.dev
+  + space.prod
+
+  You can create the following files in the =~/.arql.d/= directory:
+
+  + 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 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
+      end
+    end
+  #+END_SRC
+
+  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.
+  

data/lib/arql/cli.rb

@@ -36,7 +36,7 @@ module Arql
             @options.env = env
           end
 
-          opts.on('-aDB_ADAPTER', '--db-adapter=DB_ADAPTER', 'Specify database Adapter, default is mysql2') do |db_adapter|
+          opts.on('-aDB_ADAPTER', '--db-adapter=DB_ADAPTER', 'Specify database Adapter, default is sqlite3') do |db_adapter|
             @options.adapter = db_adapter
           end
 

data/lib/arql/commands/models.rb

@@ -13,21 +13,51 @@ module Arql::Commands
         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 }
-          }
+      def models_table(table_regexp=nil, column_regexp=nil)
+        if column_regexp.nil?
+          Terminal::Table.new do |t|
+            models.each_with_index { |row, idx| t << (row || :separator) if row.nil? ||
+              table_regexp.nil? ||
+              idx.zero? ||
+              row.any? { |e| e =~ table_regexp }
+            }
+          end
+        else
+          connection = ::ActiveRecord::Base.connection
+          table = Terminal::Table.new do |t|
+            t << ['PK', 'Table', 'Model', 'Name', 'SQL Type', 'Ruby Type', 'Limit', 'Precision', 'Scale', 'Default', 'Nullable', 'Comment']
+            t << :separator
+            Arql::Definition.models.each do |definition|
+              model_class = definition[:model]
+              matched_columns = model_class.columns.select { |column| column.name =~ column_regexp || column.comment =~ column_regexp }
+              next if matched_columns.empty?
+              matched_columns.each do |column|
+                pk = if [connection.primary_key(definition[:table])].flatten.include?(column.name)
+                       'Y'
+                     else
+                       ''
+                     end
+                t << [pk, definition[:table], model_class.name, 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, "#{definition[:comment]} - #{column.comment}"]
+              end
+            end
+          end
+          puts table
         end
       end
     end
   end
 
-  Pry.commands.block_command 'm' do |regexp|
+  Pry.commands.block_command 'm' do |arg|
     puts
-    puts Models::models_table(regexp.try { |e| e.start_with?('/') ? eval(e) : Regexp.new(e) })
+    if arg.start_with?('c=') or arg.start_with?('column=')
+      column_regexp = arg.sub(/^c(olumn)?=/, '')
+      Models::models_table(nil, column_regexp.try { |e| e.start_with?('/') ? eval(e) : Regexp.new(e) })
+    else
+      puts Models::models_table(arg.try { |e| e.start_with?('/') ? eval(e) : Regexp.new(e) }, nil)
+    end
   end
 
   Pry.commands.alias_command 'l', 'm'

data/lib/arql/definition.rb

@@ -119,7 +119,11 @@ module Arql
           tables.each do |table_name|
             table_comment = comments[table_name]
             primary_keys[table_name].tap do |pkey|
-              table_name.send(@@classify_method).tap do |const_name|
+              table_name_prefixes = options[:table_name_prefixes] || []
+              normalized_table_name = table_name_prefixes.each_with_object(table_name.dup) do |prefix, name|
+                name.sub!(/^#{prefix}/, '')
+              end
+              normalized_table_name.send(@@classify_method).tap do |const_name|
                 const_name = 'Modul' if const_name == 'Module'
                 const_name = 'Clazz' if const_name == 'Class'
                 Class.new(::ArqlModel) do
@@ -213,7 +217,11 @@ module Arql
         tables.each do |table_name|
           table_comment = comments[table_name]
           primary_keys[table_name].tap do |pkey|
-            table_name.send(@@classify_method).tap do |const_name|
+            table_name_prefixes = options[:table_name_prefixes] || []
+            normalized_table_name = table_name_prefixes.each_with_object(table_name.dup) do |prefix, name|
+              name.sub!(/^#{prefix}/, '')
+            end
+            normalized_table_name.send(@@classify_method).tap do |const_name|
               const_name = 'Modul' if const_name == 'Module'
               const_name = 'Clazz' if const_name == 'Class'
               if const_name !~ /^[A-Z][A-Za-z0-9_]*$/
@@ -359,4 +367,4 @@ module Arql
       end
     end
   end
-end
+end

data/lib/arql/version.rb

@@ -1,3 +1,3 @@
 module Arql
-  VERSION = "0.3.29"
+  VERSION = "0.3.31"
 end