class Sequel::Postgres::PGRange

  1. lib/sequel/extensions/pg_range.rb
  2. lib/sequel/extensions/pg_range_ops.rb
  3. show all
Superclass: Object

:nocov:

Included modules

  1. Sequel::SQL::AliasMethods
  2. Enumerable

Constants

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

Public Instance Aliases

== -> eql?

Attributes

begin [R]

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

db_type [R]

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

end [R]

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

Public Class methods

empty(db_type=nil)

Create an empty PGRange with the given database type.

[show source]
    # File lib/sequel/extensions/pg_range.rb
333 def self.empty(db_type=nil)
334   new(nil, nil, :empty=>true, :db_type=>db_type)
335 end
from_range(range, db_type=nil)

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

[show source]
    # File lib/sequel/extensions/pg_range.rb
328 def self.from_range(range, db_type=nil)
329   new(range.begin, range.end, :exclude_end=>range.exclude_end?, :db_type=>db_type)
330 end
new(beg, en, opts=OPTS)

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.

[show source]
    # File lib/sequel/extensions/pg_range.rb
343 def initialize(beg, en, opts=OPTS)
344   @begin = beg
345   @end = en
346   @empty = !!opts[:empty]
347   @exclude_begin = !!opts[:exclude_begin]
348   @exclude_end = !!opts[:exclude_end]
349   @db_type = opts[:db_type]
350   if @empty
351     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?
352   end
353 end

Public Instance methods

===(other)

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.

[show source]
    # File lib/sequel/extensions/pg_range.rb
413 def ===(other)
414   if eql?(other)
415     true
416   else
417     if valid_ruby_range?
418       to_range === other 
419     else
420       false
421     end
422   end
423 end
cover?(value)

Return whether the value is inside the range.

[show source]
    # File lib/sequel/extensions/pg_range.rb
362 def cover?(value)
363   return false if empty?
364   b = self.begin
365   return false if b && b.public_send(exclude_begin? ? :>= : :>, value)
366   e = self.end
367   return false if e && e.public_send(exclude_end? ? :<= : :<, value)
368   true
369 end
empty?()

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.

[show source]
    # File lib/sequel/extensions/pg_range.rb
428 def empty?
429   @empty
430 end
eql?(other)

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.

[show source]
    # File lib/sequel/extensions/pg_range.rb
375 def eql?(other)
376   case other
377   when PGRange
378     if db_type == other.db_type
379       if empty?
380         other.empty?
381       elsif other.empty?
382         false
383       else
384         [:@begin, :@end, :@exclude_begin, :@exclude_end].all?{|v| instance_variable_get(v) == other.instance_variable_get(v)}
385       end
386     else
387       false
388     end
389   when Range
390     if valid_ruby_range?
391       to_range.eql?(other)
392     else
393       false
394     end
395   else
396     false
397   end
398 end
exclude_begin?()

Whether the beginning element is excluded from the range.

[show source]
    # File lib/sequel/extensions/pg_range.rb
433 def exclude_begin?
434   @exclude_begin
435 end
exclude_end?()

Whether the ending element is excluded from the range.

[show source]
    # File lib/sequel/extensions/pg_range.rb
438 def exclude_end?
439   @exclude_end
440 end
hash()

Make sure equal ranges have the same hash.

[show source]
    # File lib/sequel/extensions/pg_range.rb
402 def hash
403   if @empty
404     @db_type.hash
405   else
406     [@begin, @end, @exclude_begin, @exclude_end, @db_type].hash
407   end
408 end
op()

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

[show source]
    # File lib/sequel/extensions/pg_range_ops.rb
125 def op
126   RangeOp.new(self)
127 end
sql_literal_append(ds, sql)

Append a literalize version of the receiver to the sql.

[show source]
    # File lib/sequel/extensions/pg_range.rb
443 def sql_literal_append(ds, sql)
444   if (s = @db_type) && !empty?
445     sql << s.to_s << "("
446     ds.literal_append(sql, self.begin)
447     sql << ','
448     ds.literal_append(sql, self.end)
449     sql << ','
450     ds.literal_append(sql, "#{exclude_begin? ? "(" : "["}#{exclude_end? ? ")" : "]"}")
451     sql << ")"
452   else
453     ds.literal_append(sql, unquoted_literal(ds))
454     if s
455       sql << '::' << s.to_s
456     end
457   end
458 end
to_range()

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

[show source]
    # File lib/sequel/extensions/pg_range.rb
464 def to_range
465   return @range if @range
466   raise(Error, "cannot create ruby range for an empty PostgreSQL range") if empty?
467   raise(Error, "cannot create ruby range when PostgreSQL range excludes beginning element") if exclude_begin?
468   # :nocov:
469   raise(Error, "cannot create ruby range when PostgreSQL range has unbounded beginning") if STARTLESS_RANGE_NOT_SUPPORTED && !self.begin
470   raise(Error, "cannot create ruby range when PostgreSQL range has unbounded ending") if ENDLESS_RANGE_NOT_SUPPORTED && !self.end
471   # :nocov:
472   @range = Range.new(self.begin, self.end, exclude_end?)
473 end
unbounded_begin?()

Whether the beginning of the range is unbounded.

[show source]
    # File lib/sequel/extensions/pg_range.rb
483 def unbounded_begin?
484   self.begin.nil? && !empty?
485 end
unbounded_end?()

Whether the end of the range is unbounded.

[show source]
    # File lib/sequel/extensions/pg_range.rb
488 def unbounded_end?
489   self.end.nil? && !empty?
490 end
unquoted_literal(ds)

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

[show source]
    # File lib/sequel/extensions/pg_range.rb
494 def unquoted_literal(ds)
495   if empty?
496     'empty'
497   else
498     "#{exclude_begin? ? "(" : "["}#{escape_value(self.begin, ds)},#{escape_value(self.end, ds)}#{exclude_end? ? ")" : "]"}"
499   end
500 end
valid_ruby_range?()

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.

[show source]
    # File lib/sequel/extensions/pg_range.rb
478 def valid_ruby_range?
479   !(empty? || exclude_begin? || (STARTLESS_RANGE_NOT_SUPPORTED && !self.begin) || (ENDLESS_RANGE_NOT_SUPPORTED && !self.end))
480 end