class Sequel::Postgres::PGRange
:nocov:
Constants
- ENDLESS_RANGE_NOT_SUPPORTED
- STARTLESS_RANGE_NOT_SUPPORTED
Attributes
The beginning of the range. If nil, the range has an unbounded beginning.
The PostgreSQL database type for the range (e.g. 'int4range').
The end of the range. If nil, the range has an unbounded ending.
Public Class Methods
Create an empty PGRange with the given database type.
# File lib/sequel/extensions/pg_range.rb, line 314 def self.empty(db_type=nil) new(nil, nil, :empty=>true, :db_type=>db_type) end
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.
# File lib/sequel/extensions/pg_range.rb, line 324 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
Public Instance Methods
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.
# File lib/sequel/extensions/pg_range.rb, line 394 def ===(other) if eql?(other) true else if valid_ruby_range? to_range === other else false end end end
Return whether the value is inside the range.
# File lib/sequel/extensions/pg_range.rb, line 343 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
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.
# File lib/sequel/extensions/pg_range.rb, line 409 def empty? @empty end
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.
# File lib/sequel/extensions/pg_range.rb, line 356 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
Whether the beginning element is excluded from the range.
# File lib/sequel/extensions/pg_range.rb, line 414 def exclude_begin? @exclude_begin end
Whether the ending element is excluded from the range.
# File lib/sequel/extensions/pg_range.rb, line 419 def exclude_end? @exclude_end end
Make sure equal ranges have the same hash.
# File lib/sequel/extensions/pg_range.rb, line 383 def hash if @empty @db_type.hash else [@begin, @end, @exclude_begin, @exclude_end, @db_type].hash end end
Allow automatic parameterization for ranges with types.
# File lib/sequel/extensions/pg_range.rb, line 484 def sequel_auto_param_type(ds) "::#{db_type}" if db_type end
Append a literalize version of the receiver to the sql.
# File lib/sequel/extensions/pg_range.rb, line 424 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
Return a ruby Range object for this instance, if one can be created.
# File lib/sequel/extensions/pg_range.rb, line 445 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
Whether the beginning of the range is unbounded.
# File lib/sequel/extensions/pg_range.rb, line 464 def unbounded_begin? self.begin.nil? && !empty? end
Whether the end of the range is unbounded.
# File lib/sequel/extensions/pg_range.rb, line 469 def unbounded_end? self.end.nil? && !empty? end
Return a string containing the unescaped version of the range. Separated out for use by the bound argument code.
# File lib/sequel/extensions/pg_range.rb, line 475 def unquoted_literal(ds) if empty? 'empty' else "#{exclude_begin? ? "(" : "["}#{escape_value(self.begin, ds)},#{escape_value(self.end, ds)}#{exclude_end? ? ")" : "]"}" end end
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.
# File lib/sequel/extensions/pg_range.rb, line 459 def valid_ruby_range? !(empty? || exclude_begin? || (STARTLESS_RANGE_NOT_SUPPORTED && !self.begin) || (ENDLESS_RANGE_NOT_SUPPORTED && !self.end)) end
Private Instance Methods
Escape common range types. Instead of quoting, just backslash escape all special characters.
# File lib/sequel/extensions/pg_range.rb, line 492 def escape_value(k, ds) case k when nil '' when Time, Date ds.literal_date_or_time(k, true) when Integer, Float k.to_s when BigDecimal k.to_s('F') when LiteralString k when String if k.empty? '""' else k.gsub(/("|,|\\|\[|\]|\(|\))/, '\\\\\1') end else ds.literal(k).gsub(/("|,|\\|\[|\]|\(|\))/, '\\\\\1') end end