Class: Sequel::Postgres::PGRange

Inherits:
Object
  • Object
show all
Includes:
Enumerable, SQL::AliasMethods
Defined in:
lib/sequel/extensions/pg_range_ops.rb,
lib/sequel/extensions/pg_range.rb

Overview

:nocov:

Defined Under Namespace

Modules: DatabaseMethods, DatasetMethods Classes: Parser

Constant Summary collapse

ENDLESS_RANGE_NOT_SUPPORTED = 
RUBY_VERSION < '2.6'
STARTLESS_RANGE_NOT_SUPPORTED = 
RUBY_VERSION < '2.7'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SQL::AliasMethods

#as

Constructor Details

#initialize(beg, en, opts = OPTS) ⇒ PGRange

Initialize a new PGRange instance. Accepts the following options:

:db_type

The PostgreSQL database type for the range.

:empty

Whether the range is empty (has no points)

:exclude_begin

Whether the beginning element is excluded from the range.

:exclude_end

Whether the ending element is excluded from the range.


335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/sequel/extensions/pg_range.rb', line 335

def initialize(beg, en, opts=OPTS)
  @begin = beg
  @end = en
  @empty = !!opts[:empty]
  @exclude_begin = !!opts[:exclude_begin]
  @exclude_end = !!opts[:exclude_end]
  @db_type = opts[:db_type]
  if @empty
    raise(Error, 'cannot have an empty range with either a beginning or ending') unless @begin.nil? && @end.nil? && opts[:exclude_begin].nil? && opts[:exclude_end].nil?
  end
end

Instance Attribute Details

#begin ⇒ Object (readonly)

The beginning of the range. If nil, the range has an unbounded beginning.


310
311
312
 
# File 'lib/sequel/extensions/pg_range.rb', line 310

def begin
  @begin
end

#db_type ⇒ Object (readonly)

The PostgreSQL database type for the range (e.g. 'int4range').


316
317
318
 
# File 'lib/sequel/extensions/pg_range.rb', line 316

def db_type
  @db_type
end

#end ⇒ Object (readonly)

The end of the range. If nil, the range has an unbounded ending.


313
314
315
 
# File 'lib/sequel/extensions/pg_range.rb', line 313

def end
  @end
end

Class Method Details

.empty(db_type = nil) ⇒ Object

Create an empty PGRange with the given database type.


325
326
327
 
# File 'lib/sequel/extensions/pg_range.rb', line 325

def self.empty(db_type=nil)
  new(nil, nil, :empty=>true, :db_type=>db_type)
end

.from_range(range, db_type = nil) ⇒ Object

Create a new PGRange instance using the beginning and ending of the ruby Range, with the given db_type.


320
321
322
 
# File 'lib/sequel/extensions/pg_range.rb', line 320

def self.from_range(range, db_type=nil)
  new(range.begin, range.end, :exclude_end=>range.exclude_end?, :db_type=>db_type)
end

Instance Method Details

#===(other) ⇒ Object

Allow PGRange values in case statements, where they return true if they are equal to each other using eql?, or if this PGRange can be converted to a Range, delegating to that range.


405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/sequel/extensions/pg_range.rb', line 405

def ===(other)
  if eql?(other)
    true
  else
    if valid_ruby_range?
      to_range === other 
    else
      false
    end
  end
end

#cover?(value) ⇒ Boolean

Return whether the value is inside the range.

Returns:

  • (Boolean) 

354
355
356
357
358
359
360
361
 
# File 'lib/sequel/extensions/pg_range.rb', line 354

def cover?(value)
  return false if empty?
  b = self.begin
  return false if b && b.public_send(exclude_begin? ? :>= : :>, value)
  e = self.end
  return false if e && e.public_send(exclude_end? ? :<= : :<, value)
  true
end

#empty? ⇒ Boolean

Whether this range is empty (has no points). Note that for manually created ranges (ones not retrieved from the database), this will only be true if the range was created using the :empty option.

Returns:

  • (Boolean) 

420
421
422
 
# File 'lib/sequel/extensions/pg_range.rb', line 420

def empty?
  @empty
end

#eql?(other) ⇒ Boolean Also known as: ==

Consider the receiver equal to other PGRange instances with the same beginning, ending, exclusions, and database type. Also consider it equal to Range instances if this PGRange can be converted to a a Range and those ranges are equal.

Returns:

  • (Boolean) 

367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/sequel/extensions/pg_range.rb', line 367

def eql?(other)
  case other
  when PGRange
    if db_type == other.db_type
      if empty?
        other.empty?
      elsif other.empty?
        false
      else
        [:@begin, :@end, :@exclude_begin, :@exclude_end].all?{|v| instance_variable_get(v) == other.instance_variable_get(v)}
      end
    else
      false
    end
  when Range
    if valid_ruby_range?
      to_range.eql?(other)
    else
      false
    end
  else
    false
  end
end

#exclude_begin? ⇒ Boolean

Whether the beginning element is excluded from the range.

Returns:

  • (Boolean) 

425
426
427
 
# File 'lib/sequel/extensions/pg_range.rb', line 425

def exclude_begin?
  @exclude_begin
end

#exclude_end? ⇒ Boolean

Whether the ending element is excluded from the range.

Returns:

  • (Boolean) 

430
431
432
 
# File 'lib/sequel/extensions/pg_range.rb', line 430

def exclude_end?
  @exclude_end
end

#hash ⇒ Object

Make sure equal ranges have the same hash.


394
395
396
397
398
399
400
 
# File 'lib/sequel/extensions/pg_range.rb', line 394

def hash
  if @empty
    @db_type.hash
  else
    [@begin, @end, @exclude_begin, @exclude_end, @db_type].hash
  end
end

#op ⇒ Object

Wrap the PGRange instance in an RangeOp, allowing you to easily use the PostgreSQL range functions and operators with literal ranges.


141
142
143
 
# File 'lib/sequel/extensions/pg_range_ops.rb', line 141

def op
  RangeOp.new(self)
end

#sql_literal_append(ds, sql) ⇒ Object

Append a literalize version of the receiver to the sql.


435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/sequel/extensions/pg_range.rb', line 435

def sql_literal_append(ds, sql)
  if (s = @db_type) && !empty?
    sql << s.to_s << "("
    ds.literal_append(sql, self.begin)
    sql << ','
    ds.literal_append(sql, self.end)
    sql << ','
    ds.literal_append(sql, "#{exclude_begin? ? "(" : "["}#{exclude_end? ? ")" : "]"}")
    sql << ")"
  else
    ds.literal_append(sql, unquoted_literal(ds))
    if s
      sql << '::' << s.to_s
    end
  end
end

#to_range ⇒ Object

Return a ruby Range object for this instance, if one can be created.

Raises:


456
457
458
459
460
461
462
463
464
465
 
# File 'lib/sequel/extensions/pg_range.rb', line 456

def to_range
  return @range if @range
  raise(Error, "cannot create ruby range for an empty PostgreSQL range") if empty?
  raise(Error, "cannot create ruby range when PostgreSQL range excludes beginning element") if exclude_begin?
  # :nocov:
  raise(Error, "cannot create ruby range when PostgreSQL range has unbounded beginning") if STARTLESS_RANGE_NOT_SUPPORTED && !self.begin
  raise(Error, "cannot create ruby range when PostgreSQL range has unbounded ending") if ENDLESS_RANGE_NOT_SUPPORTED && !self.end
  # :nocov:
  @range = Range.new(self.begin, self.end, exclude_end?)
end

#unbounded_begin? ⇒ Boolean

Whether the beginning of the range is unbounded.

Returns:

  • (Boolean) 

475
476
477
 
# File 'lib/sequel/extensions/pg_range.rb', line 475

def unbounded_begin?
  self.begin.nil? && !empty?
end

#unbounded_end? ⇒ Boolean

Whether the end of the range is unbounded.

Returns:

  • (Boolean) 

480
481
482
 
# File 'lib/sequel/extensions/pg_range.rb', line 480

def unbounded_end?
  self.end.nil? && !empty?
end

#unquoted_literal(ds) ⇒ Object

Return a string containing the unescaped version of the range. Separated out for use by the bound argument code.


486
487
488
489
490
491
492
 
# File 'lib/sequel/extensions/pg_range.rb', line 486

def unquoted_literal(ds)
  if empty?
    'empty'
  else
    "#{exclude_begin? ? "(" : "["}#{escape_value(self.begin, ds)},#{escape_value(self.end, ds)}#{exclude_end? ? ")" : "]"}"
  end
end

#valid_ruby_range? ⇒ Boolean

Whether or not this PGRange is a valid ruby range. In order to be a valid ruby range, it must have a beginning and an ending (no unbounded ranges), and it cannot exclude the beginning element.

Returns:

  • (Boolean) 

470
471
472
 
# File 'lib/sequel/extensions/pg_range.rb', line 470

def valid_ruby_range?
  !(empty? || exclude_begin? || (STARTLESS_RANGE_NOT_SUPPORTED && !self.begin) || (ENDLESS_RANGE_NOT_SUPPORTED && !self.end))
end