validates_overlap 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e861b52a30a5b27d67b83042a658a6cd923025a
-  data.tar.gz: 242c6bff486745218266e73c6e562995d6ed7e68
+  metadata.gz: 483af513bf060127e3608a51a2257f7f9f4e1f3b
+  data.tar.gz: da46a701164a966e9f26d21e31aafcc4bf2ddc24
 SHA512:
-  metadata.gz: 3f60ffe6700e1e3100931adb078e05d9c34a0344a4eb7221035e894cbbc18d36424fb8c09dbb40b1cd70f63a4506025c4a09ded49b7946e278633b4e7f36c242
-  data.tar.gz: 87f79459a1ef597b566a7dcccf0d16af964ba4c7229e8cea3bff813e2c9ef4580fba0f99d3b925b09a31176e867d75db63f66dfd46ae462637fa749b5bc41e4d
+  metadata.gz: b43a7550f859c43f109cdf62acc9ebcef51985de90c3d54f0d8fbba1ed94fbc19bac6aa5a5696ed3cdf39f18060a0621c751510e6bf2eb83d24da6dbbca88526
+  data.tar.gz: d9ac0f6e807ae6198b21c7e804addd35e8fd24dbcdea8d6d7390e708964a4c687da0aa8a00432babad2dc910173059d1182ea3006432525bb1725505c81a05d9

data/.gitignore

@@ -8,3 +8,4 @@ spec/dummy/tmp/
 database.yml
 Gemfile*.lock
 .DS_Store
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Encoding:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.rails50

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 5.0'

data/README.md

@@ -4,10 +4,10 @@
 
 This project rocks and uses MIT-LICENSE.
 
-#### This gem is compatible with Rails 3 and 4.
+#### This gem is compatible with Rails 3, 4, 5.
 
 #### When this gem should be helpful for you?
-If you are developing Rails 3 app, let say some meeting planner and you can't save records which have time overlap.
+Ideal solution for booking applications where you want to make sure, that one place can be booked only once in specific time period.
 
 #### Using
 
@@ -76,6 +76,20 @@ class ActiveMeeting < ActiveRecord::Base
 end
 ```
 
+#### Overlapped records
+If you need to know what records are in conflict, pass the `{load_overlapped: true }` as validator option and validator will set instance variable `@overlapped_records` to the validated object.
+
+```ruby
+class ActiveMeeting < ActiveRecord::Base
+  validates :starts_at, :ends_at, :overlap => {:load_overlapped => true}
+
+  def overlapped_records
+    @overlapped_records || []
+  end
+end
+
+```
+
 ## Rails 4.1 update
 
 If you just upgraded your application to rails 4.1 you can discover some issue with custom scopes. In older versions we suggest to use definition like

data/Rakefile

@@ -10,16 +10,16 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "validates_overlap #{version}"
   rdoc.rdoc_files.include('README*')

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/validates_overlap/locale/es.yml

@@ -0,0 +1,4 @@
+es:
+  errors:
+    messages:
+      overlap: coincide con otro registro

data/lib/validates_overlap/overlap_validator.rb

@@ -3,8 +3,8 @@ require 'active_support/i18n'
 I18n.load_path << File.dirname(__FILE__) + '/locale/en.yml'
 
 class OverlapValidator < ActiveModel::EachValidator
-  BEGIN_OF_UNIX_TIME = Time.at(-2147483648).to_datetime
-  END_OF_UNIX_TIME = Time.at(2147483648).to_datetime
+  BEGIN_OF_UNIX_TIME = Time.at(-2_147_483_648).to_datetime
+  END_OF_UNIX_TIME = Time.at(2_147_483_648).to_datetime
 
   attr_accessor :sql_conditions
   attr_accessor :sql_values
@@ -12,11 +12,17 @@ class OverlapValidator < ActiveModel::EachValidator
 
   def initialize(args)
     attributes_are_range(args[:attributes])
+
     super
   end
 
   def validate(record)
-    if self.find_crossed(record)
+    initialize_query(record, options)
+    if overlapped_exists?
+      if options[:load_overlapped]
+        record.instance_variable_set(:@overlapped_records, get_overlapped)
+      end
+
       if record.respond_to? attributes.first
         record.errors.add(options[:message_title] || attributes.first, options[:message_content] || :overlap)
       else
@@ -25,27 +31,31 @@ class OverlapValidator < ActiveModel::EachValidator
     end
   end
 
-
   protected
 
-  # Check if exists at least one record in DB which is crossed with current record
-  def find_crossed(record)
+  def initialize_query(record, options = {})
     self.scoped_model = record.class
-    self.generate_overlap_sql_values(record)
-    self.generate_overlap_sql_conditions(record)
-    self.add_attributes(record, options[:scope]) if options && options[:scope].present?
-    self.add_query_options(options[:query_options]) if options && options[:query_options].present?
+    generate_overlap_sql_values(record)
+    generate_overlap_sql_conditions(record)
+    add_attributes(record, options[:scope]) if options && options[:scope].present?
+    add_query_options(options[:query_options]) if options && options[:query_options].present?
+  end
 
-    return self.scoped_model.exists?([sql_conditions, sql_values])
+  # Check if exists at least one record in DB which is overlapped with current record
+  def overlapped_exists?
+    scoped_model.exists?([sql_conditions, sql_values])
   end
 
+  def get_overlapped
+    scoped_model.where([sql_conditions, sql_values])
+  end
 
   # Resolve attributes values from record to use in sql conditions
   # return array in form ['2011-01-10', '2011-02-20']
   def resolve_values_from_attributes(record)
     attributes.map do |attr|
-      if attr.to_s.include?(".")
-        self.get_assoc_value(record, attr)
+      if attr.to_s.include?('.')
+        get_assoc_value(record, attr)
       else
         record.send(attr.to_sym)
       end
@@ -53,7 +63,7 @@ class OverlapValidator < ActiveModel::EachValidator
   end
 
   def get_assoc_value(record, attr)
-    assoc, attr_name = attr.to_s.split(".")
+    assoc, attr_name = attr.to_s.split('.')
     assoc_name = assoc.singularize.to_sym
     assoc_obj = record.send(assoc_name) if record.respond_to?(assoc_name)
     (assoc_obj || record).send(attr_name.to_sym)
@@ -64,26 +74,23 @@ class OverlapValidator < ActiveModel::EachValidator
     attributes.map { |attr| attribute_to_sql(attr, record) }
   end
 
-
   # Prepare attribute name to use in sql conditions created in form 'table_name.attribute_name'
   def attribute_to_sql(attr, record)
-    if attr.to_s.include?(".")
+    if attr.to_s.include?('.')
       attr
     else
       "#{record_table_name(record)}.#{attr}"
     end
   end
 
-
   # Get the table name for the record
   def record_table_name(record)
     record.class.table_name
   end
 
-
   # Check if the validation of time range is defined by 2 attributes
   def attributes_are_range(attributes)
-    raise "Validation of time range must be defined by 2 attributes" unless attributes.size == 2
+    fail 'Validation of time range must be defined by 2 attributes' unless attributes.size == 2
   end
 
   def primary_key(record)
@@ -113,54 +120,52 @@ class OverlapValidator < ActiveModel::EachValidator
     starts_at_value, ends_at_value = resolve_values_from_attributes(record)
     starts_at_value += options.fetch(:start_shift) { 0 } if starts_at_value && options
     ends_at_value += options.fetch(:end_shift) { 0 } if ends_at_value && options
-    self.sql_values = {:starts_at_value => starts_at_value || BEGIN_OF_UNIX_TIME, :ends_at_value => ends_at_value || END_OF_UNIX_TIME}
+    self.sql_values = { starts_at_value: starts_at_value || BEGIN_OF_UNIX_TIME, ends_at_value: ends_at_value || END_OF_UNIX_TIME }
   end
 
   # Return the condition string depend on exclude_edges option.
   def condition_string(starts_at_attr, ends_at_attr)
     except_option = Array(options[:exclude_edges]).map(&:to_s)
-    starts_at_sign = except_option.include?(starts_at_attr.to_s.split(".").last) ? "<" : "<="
-    ends_at_sign = except_option.include?(ends_at_attr.to_s.split(".").last) ? ">" : ">="
+    starts_at_sign = except_option.include?(starts_at_attr.to_s.split('.').last) ? '<' : '<='
+    ends_at_sign = except_option.include?(ends_at_attr.to_s.split('.').last) ? '>' : '>='
     query = []
     query << "(#{ends_at_attr} IS NULL OR #{ends_at_attr} #{ends_at_sign} :starts_at_value)"
     query << "(#{starts_at_attr} IS NULL OR #{starts_at_attr} #{starts_at_sign} :ends_at_value)"
-    query.join(" AND ")
+    query.join(' AND ')
   end
 
-
   # Add attributes and values to sql conditions.
   # helps to use with scope options, so scope can be added as this forms :scope => "user_id" or :scope => ["user_id", "place_id"]
   def add_attributes(record, attrs)
     if attrs.is_a?(Array)
-      attrs.each { |attr| self.add_attribute(record, attr) }
+      attrs.each { |attr| add_attribute(record, attr) }
     elsif attrs.is_a?(Hash)
       attrs.each do |attr_name, value|
-        self.add_attribute(record, attr_name, value)
+        add_attribute(record, attr_name, value)
       end
     else
-      self.add_attribute(record, attrs)
+      add_attribute(record, attrs)
     end
   end
 
-
   # Add attribute and his value to sql condition
   def add_attribute(record, attr_name, value = nil)
     _value = resolve_scope_value(record, attr_name, value)
     operator = if _value.nil?
-      " IS NULL"
-    elsif _value.is_a?(Array)
-      " IN (:%s)"
-    else
-      " = :%s"
+                 ' IS NULL'
+               elsif _value.is_a?(Array)
+                 ' IN (:%s)'
+               else
+                 ' = :%s'
     end
 
     self.sql_conditions += " AND #{attribute_to_sql(attr_name, record)} #{operator}" % value_attribute_name(attr_name)
-    self.sql_values.merge!({:"#{value_attribute_name(attr_name)}" => _value})
+    sql_values.merge!(:"#{value_attribute_name(attr_name)}" => _value)
   end
 
   def value_attribute_name(attr_name)
-    name = attr_name.to_s.include?(".") ? attr_name.to_s.gsub(".", "_") : attr_name
-    name + "_value"
+    name = attr_name.to_s.include?('.') ? attr_name.to_s.gsub('.', '_') : attr_name.to_s
+    name + '_value'
   end
 
   def resolve_scope_value(record, attr_name, value = nil)
@@ -176,8 +181,7 @@ class OverlapValidator < ActiveModel::EachValidator
   # validates_overlap :date_from, :date_to, :query_options => {:includes => "visits"}
   def add_query_options(methods)
     methods.each do |method_name, params|
-      self.scoped_model = self.scoped_model.send(method_name.to_sym, *params)
+      self.scoped_model = scoped_model.send(method_name.to_sym, *params)
     end
   end
-
 end

data/spec/dummy/app/models/active_meeting.rb

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

data/spec/dummy/app/models/end_overlap_meeting.rb

@@ -1,3 +1,3 @@
 class EndOverlapMeeting < ActiveRecord::Base
-  validates :starts_at, :ends_at, :overlap => {:exclude_edges => :ends_at}
-end
+  validates :starts_at, :ends_at, overlap: { exclude_edges: :ends_at }
+end

data/spec/dummy/app/models/meeting.rb

@@ -1,3 +1,3 @@
 class Meeting < ActiveRecord::Base
-  validates :starts_at, :ends_at, :overlap => true
+  validates :starts_at, :ends_at, overlap: { load_overlapped: true }
 end

data/spec/dummy/app/models/position.rb

@@ -2,8 +2,8 @@ class Position < ActiveRecord::Base
   belongs_to :time_slot
   belongs_to :user
   validates :"time_slots.starts_at", :"time_slots.ends_at",
-    :overlap => {
-      :query_options => {:includes => :time_slot},
-      :scope => { "positions.user_id" => proc{|position| position.user_id} }
-    }
+            overlap: {
+              query_options: { includes: :time_slot },
+              scope: { 'positions.user_id' => proc { |position| position.user_id } }
+            }
 end

data/spec/dummy/app/models/secure_meeting.rb

@@ -1,3 +1,3 @@
 class SecureMeeting < ActiveRecord::Base
-  validates :starts_at, :ends_at, :overlap => true
+  validates :starts_at, :ends_at, overlap: true
 end

data/spec/dummy/app/models/shift.rb

@@ -1,3 +1,3 @@
 class Shift < ActiveRecord::Base
-  validates :starts_at, :ends_at, :overlap => {:start_shift => -1.day, :end_shift => 1.day}
+  validates :starts_at, :ends_at, overlap: { start_shift: -1.day, end_shift: 1.day }
 end

data/spec/dummy/app/models/start_end_overlap_meeting.rb

@@ -1,3 +1,3 @@
 class StartEndOverlapMeeting < ActiveRecord::Base
-  validates :starts_at, :ends_at, :overlap => {:exclude_edges => [:starts_at, :ends_at]}
-end
+  validates :starts_at, :ends_at, overlap: { exclude_edges: [:starts_at, :ends_at] }
+end

data/spec/dummy/app/models/start_overlap_meeting.rb

@@ -1,3 +1,3 @@
 class StartOverlapMeeting < ActiveRecord::Base
-  validates :starts_at, :ends_at, :overlap => {:exclude_edges => :starts_at}
+  validates :starts_at, :ends_at, overlap: { exclude_edges: :starts_at }
 end

data/spec/dummy/app/models/time_slot.rb

@@ -1,8 +1,8 @@
 class TimeSlot < ActiveRecord::Base
   has_many :positions
   validates :"time_slots.starts_at", :"time_slots.ends_at",
-    :overlap => {
-      :query_options => {:includes => :positions},
-      :scope => {"positions.user_id" => proc{|time_slot| time_slot.positions.map(&:user_id)} }
-    }
+            overlap: {
+              query_options: { includes: :positions },
+              scope: { 'positions.user_id' => proc { |time_slot| time_slot.positions.map(&:user_id) } }
+            }
 end

data/spec/dummy/app/models/user_meeting.rb

@@ -1,3 +1,3 @@
 class UserMeeting < ActiveRecord::Base
-  validates :starts_at, :ends_at, :overlap => {:scope => "user_id"}
+  validates :starts_at, :ends_at, overlap: { scope: 'user_id' }
 end

data/spec/dummy/config/application.rb

@@ -1,13 +1,13 @@
 require File.expand_path('../boot', __FILE__)
 
-require "active_model/railtie"
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_view/railtie"
-require "action_mailer/railtie"
+require 'active_model/railtie'
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
 
 Bundler.require
-require "validates_overlap"
+require 'validates_overlap'
 
 module Dummy
   class Application < Rails::Application
@@ -37,7 +37,7 @@ module Dummy
     # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
 
     # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
+    config.encoding = 'utf-8'
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]

data/spec/dummy/config/boot.rb

@@ -7,4 +7,4 @@ if File.exist?(gemfile)
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environments/development.rb

@@ -11,7 +11,7 @@ Dummy::Application.configure do
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
-  #config.action_view.debug_rjs             = true
+  # config.action_view.debug_rjs             = true
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send
@@ -23,4 +23,3 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 end
-

data/spec/dummy/config/environments/production.rb

@@ -10,7 +10,7 @@ Dummy::Application.configure do
   config.action_controller.perform_caching = true
 
   # Specifies the header that your server uses for sending files
-  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+  config.action_dispatch.x_sendfile_header = 'X-Sendfile'
 
   # For nginx:
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'

data/spec/dummy/config/initializers/session_store.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information