1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
# frozen-string-literal: true
#
# The pg_inet extension adds support for Sequel to handle
# PostgreSQL's inet and cidr types using ruby's IPAddr class.
#
# This extension integrates with Sequel's native postgres and jdbc/postgresql
# adapters, so that when inet/cidr fields are retrieved, they are returned as
# IPAddr instances.
#
# To use this extension, load it into your database:
#
# DB.extension :pg_inet
#
# This extension integrates with the pg_array extension. If you plan
# to use the inet[] or cidr[] types, load the pg_array extension before
# the pg_inet extension:
#
# DB.extension :pg_array, :pg_inet
#
# This extension does not add special support for the macaddr
# type. Ruby doesn't have a stdlib class that represents mac
# addresses, so these will still be returned as strings. The exception
# to this is that the pg_array extension integration will recognize
# macaddr[] types return them as arrays of strings.
#
# See the {schema modification guide}[rdoc-ref:doc/schema_modification.rdoc]
# for details on using inet/cidr columns in CREATE/ALTER TABLE statements.
#
# Related module: Sequel::Postgres::InetDatabaseMethods
require 'ipaddr'
module Sequel
module Postgres
# Methods enabling Database object integration with the inet/cidr types.
module InetDatabaseMethods
# Reset the conversion procs when extending the Database object, so
# it will pick up the inet/cidr converter. Also, extend the datasets
# with support for literalizing the IPAddr types.
def self.extended(db)
db.instance_exec do
extend_datasets(InetDatasetMethods)
# :nocov:
if !defined?(SEQUEL_PG_VERSION_INTEGER) || SEQUEL_PG_VERSION_INTEGER >= 11300
# :nocov:
# sequel_pg 1.13.0+ will use inet/cidr conversion procs, but doing so is
# slower, so don't add the conversion procs if using sequel_pg 1.13.0+.
meth = IPAddr.method(:new)
add_conversion_proc(869, meth)
add_conversion_proc(650, meth)
if respond_to?(:register_array_type)
register_array_type('inet', :oid=>1041, :scalar_oid=>869)
register_array_type('cidr', :oid=>651, :scalar_oid=>650)
end
end
if respond_to?(:register_array_type)
register_array_type('macaddr', :oid=>1040, :scalar_oid=>829)
end
@schema_type_classes[:ipaddr] = IPAddr
end
end
# Convert an IPAddr arg to a string. Probably not necessary, but done
# for safety.
def bound_variable_arg(arg, conn)
case arg
when IPAddr
"#{arg.to_s}/#{arg.instance_variable_get(:@mask_addr).to_s(2).count('1')}"
else
super
end
end
private
# Make the column type detection recognize the inet and cidr types.
def schema_column_type(db_type)
case db_type
when 'inet', 'cidr'
:ipaddr
else
super
end
end
# Set the :ruby_default value if the default value is recognized as an ip address.
def schema_post_process(_)
super.each do |a|
h = a[1]
if h[:type] == :ipaddr && h[:default] =~ /\A'([:a-fA-F0-9\.\/]+)'::(?:inet|cidr)\z/
h[:ruby_default] = IPAddr.new($1)
end
end
end
# Typecast the given value to an IPAddr object.
def typecast_value_ipaddr(value)
case value
when IPAddr
value
when String
IPAddr.new(typecast_check_string_length(value, 100))
else
raise Sequel::InvalidValue, "invalid value for inet/cidr: #{value.inspect}"
end
end
end
module InetDatasetMethods
private
# Allow auto parameterization of IPAddr instances.
def auto_param_type_fallback(v)
if defined?(super) && (type = super)
type
elsif IPAddr === v
"::inet"
end
end
# Convert IPAddr value to a string and append a literal version
# of the string to the sql.
def literal_other_append(sql, value)
if value.is_a?(IPAddr)
literal_string_append(sql, "#{value.to_s}/#{value.instance_variable_get(:@mask_addr).to_s(2).count('1')}")
else
super
end
end
end
end
Database.register_extension(:pg_inet, Postgres::InetDatabaseMethods)
end
|
