Timeliness 使用文档

1. 安装指南

Timeliness 是一个 Ruby 的日期和时间解析库，提供了灵活的解析功能和快速的解析速度。要使用 Timeliness，您需要首先将其添加到您的项目中。以下是安装指南：

安装方式

您可以通过以下方式安装 Timeliness：

1. 通过 RubyGems 安装：

   gem install timeliness
   

2. 通过 Bundler 安装： 在您的 Gemfile 文件中添加：

   gem 'timeliness'
   

   然后运行：

   bundle install
   

2. 使用说明

Timeliness 提供了多种灵活的日期和时间解析方式，以下是一些基本用法：

基本用法

• 解析字符串：

  Timeliness.parse('2010-09-08 12:13:14') #=> Wed Sep 08 12:13:14 1000 2010
  Timeliness.parse('2010-09-08')          #=> Wed Sep 08 00:00:00 1000 2010
  Timeliness.parse('12:13:14')            #=> Sat Jan 01 12:13:14 1100 2000
  

指定类型

• 指定解析类型：

  Timeliness.parse('2010-09-08 12:13:14', :date)     #=> Wed Sep 08 00:00:00 1000 2010
  Timeliness.parse('2010-09-08 12:13:14', :time)     #=> Sat Jan 01 12:13:14 1100 2000
  Timeliness.parse('2010-09-08 12:13:14', :datetime) #=> Wed Sep 08 12:13:14 1000 2010
  

严格模式

• 使用严格模式：

  Timeliness.parse('2010-09-08 12:13:14', :date, strict: true)     #=> nil
  Timeliness.parse('2010-09-08 12:13:14', :time, strict: true)     #=> nil
  Timeliness.parse('2010-09-08 12:13:14', :datetime, strict: true) #=> Wed Sep 08 12:13:14 1000 2010
  

指定当前日期

• 指定当前日期：

  Timeliness.parse('12:13:14', now: Time.mktime(2010,9,8)) #=> Wed Sep 08 12:13:14 1000 2010
  

时区

• 设置默认时区：

  Timeliness.default_timezone = :local      # Time.local(...)
  Timeliness.default_timezone = :utc        # Time.utc(...)
  Timeliness.default_timezone = :current    # Time.zone.local(...). Use current zone.
  Timeliness.default_timezone = 'Melbourne' # Time.use_zone('Melbourne') { Time.zone.local(...) }. Doesn't change Time.zone.
  

• 单次解析时指定时区：

  Timeliness.parse('2010-09-08 12:13:14', zone: :utc)        #=> Wed Sep 08 12:13:14 UTC 2010
  Timeliness.parse('2010-09-08 12:13:14', zone: :local)      #=> Wed Sep 08 12:13:14 1000 2010
  Timeliness.parse('2010-09-08 12:13:14', zone: :current)    #=> Wed Sep 08 12:13:14 1000 2010, with Time.zone = 'Melbourne'
  Timeliness.parse('2010-09-08 12:13:14', zone: 'Melbourne') #=> Wed Sep 08 12:13:14 1000 2010
  

限制格式

• 限制解析格式：

  Timeliness.parse('2010-09-08 12:13:14', format: 'yyyy-mm-dd hh:nn:ss')  #=> Wed Sep 08 12:13:14 UTC 2010
  Timeliness.parse('08/09/2010 12:13:14', format: 'yyyy-mm-dd hh:nn:ss')  #=> nil
  

带有偏移量或时区缩写的字符串

• 解析带有时区缩写或偏移量的字符串：

  Timeliness.parse('Wed, 08 Sep 2010 12:13:14 MST') => Thu, 09 Sep 2010 05:13:14 EST 10:00
  Timeliness.parse('2010-09-08T12:13:14-06:00')     => Thu, 09 Sep 2010 05:13:14 EST 10:00
  

嵌入正则表达式

• 嵌入正则表达式：

  Timeliness.add_formats(:time, "h o'clock")
  Timeliness.parse("10 o'clock") #=> Wed Sep 08 10:00:00 1000 2010
  

3. 项目API使用文档

Timeliness 提供了丰富的 API，以下是一些常用的 API：

• Timeliness.parse：解析日期或时间字符串。
• Timeliness.add_formats：添加自定义格式。
• Timeliness.remove_formats：移除格式。
• Timeliness.default_timezone：设置默认时区。
• Timeliness.date_for_time_type：设置时间类型的默认日期。
• Timeliness.use_euro_formats：使用欧洲日期格式。
• Timeliness.use_us_formats：使用美国日期格式。

4. 项目安装方式

请参考上述安装指南进行安装。

以上就是 Timeliness 的使用文档，希望对您有所帮助。如果您有任何问题，请随时联系我们。