ValidatesOverlap技术文档

1. 安装指南

在您的项目中使用ValidatesOverlap前，需要确保您的Rails版本为6。若您使用的是Rails 3、4或5，请使用版本0.8.6。

将以下代码添加到您的Gemfile文件中：

gem 'validates_overlap'

然后执行以下命令安装该gem：

bundle install

2. 项目使用说明

ValidatesOverlap是一个针对预订应用 ideal 的解决方案，它可以确保某个地点在特定时间周期内只能被预订一次。

在您的模型中，根据需要选择以下使用方式：

不带作用域

validates :starts_at, :ends_at, :overlap => true

带作用域

validates :starts_at, :ends_at, :overlap => {:scope => "user_id"}

排除边缘

validates :starts_at, :ends_at, :overlap => {:exclude_edges => "starts_at"}
validates :starts_at, :ends_at, :overlap => {:exclude_edges => ["starts_at", "ends_at"]}

移动边缘

validates :starts_at, :ends_at, :overlap => {:start_shift => -1.day, :end_shift => 1.day}

定义自定义验证键和消息

validates :starts_at, :ends_at, :overlap => {:message_title => "Some validation title", :message_content => "Some validation message"}
validates :starts_at, :ends_at, :overlap => {:message_title => [:start_at, :end_at], :message_content => "Some validation message"}

复杂关系

class Position < ActiveRecord::Base
  belongs_to :time_slot
  belongs_to :user
  validates "time_slots.starts_at", "time_slots.ends_at",
    :overlap => {
      :query_options => {:joins => :time_slot},
      :scope => { "positions.user_id" => proc{|position| position.user_id} }
    }
end

应用命名作用域

class ActiveMeeting < ActiveRecord::Base
  validates :starts_at, :ends_at, :overlap => {:query_options => {:active => nil}}
  scope :active, where(:is_active => true)
end

3. 项目API使用文档

若需要知道冲突的记录，可以将{load_overlapped: true}作为验证器选项传递，验证器会将@overlapped_records实例变量设置为被验证的对象。

class ActiveMeeting < ActiveRecord::Base
  validates :starts_at, :ends_at, :overlap => {:load_overlapped => true}

  def overlapped_records
    @overlapped_records || []
  end
end

4. 项目安装方式

请遵循上述安装指南中的步骤，通过添加gem到您的Gemfile并执行bundle install来进行安装。