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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
module Sequel
# This module makes it easy to add deprecation functionality to other classes.
module Deprecation
# This sets the output stream for the deprecation messages. Set it to an IO
# (or any object that responds to puts) and it will call puts on that
# object with the deprecation message. Set to nil to ignore deprecation messages.
def self.deprecation_message_stream=(file)
@dms = file
end
# Set this to true to print tracebacks with every deprecation message,
# so you can see exactly where in your code the deprecated methods are
# being called.
def self.print_tracebacks=(pt)
@pt = pt
end
# Puts the messages unaltered to the deprecation message stream
def self.deprecate(message)
if @dms
@dms.puts(message)
caller.each{|c| @dms.puts(c)} if @pt
end
end
# Formats the message with a message that it will be removed in Sequel 2.0.
# This is the method that is added to the classes that include Sequel::Deprecation.
def deprecate(meth, message = nil)
::Sequel::Deprecation.deprecate("#{meth} is deprecated, and will be removed in Sequel 2.0.#{" #{message}." if message}")
end
end
class << self
include Sequel::Deprecation
def method_missing(m, *args) #:nodoc:
deprecate("Sequel.method_missing", "You should define Sequel.#{m} for the adapter.")
c = Database.adapter_class(m)
begin
# three ways to invoke this:
# 0 arguments: Sequel.dbi
# 1 argument: Sequel.dbi(db_name)
# more args: Sequel.dbi(db_name, opts)
case args.size
when 0
opts = {}
when 1
opts = args[0].is_a?(Hash) ? args[0] : {:database => args[0]}
else
opts = args[1].merge(:database => args[0])
end
rescue
raise Error::AdapterNotFound, "Unknown adapter (#{m})"
end
c.new(opts)
end
end
class Dataset
include Deprecation
MUTATION_RE = /^(.+)!$/.freeze
def clone_merge(opts = {}) #:nodoc:
deprecate("Sequel::Dataset#clone", "Use clone")
clone(opts)
end
def set_options(opts) #:nodoc:
deprecate("Sequel::Dataset#set_options")
@opts = opts
@columns = nil
end
def set_row_proc(&filter) #:nodoc:
deprecate("Sequel::Dataset#set_row_proc", "Use row_proc=")
@row_proc = filter
end
def remove_row_proc #:nodoc:
deprecate("Sequel::Dataset#remove_row_proc", "Use row_proc=nil")
@row_proc = nil
end
# Provides support for mutation methods (filter!, order!, etc.) and magic
# methods.
def method_missing(m, *args, &block) #:nodoc:
if m.to_s =~ MUTATION_RE
meth = $1.to_sym
super unless respond_to?(meth)
copy = send(meth, *args, &block)
super if copy.class != self.class
deprecate("Sequel::Dataset#method_missing", "Define Sequel::Dataset##{m}, or use Sequel::Dataset.def_mutation_method(:#{meth})")
@opts.merge!(copy.opts)
self
elsif magic_method_missing(m)
send(m, *args)
else
super
end
end
MAGIC_METHODS = {
/^order_by_(.+)$/ => proc {|c| proc {deprecate("Sequel::Dataset#method_missing", "Use order(#{c.inspect}) or define order_by_#{c}"); order(c)}},
/^first_by_(.+)$/ => proc {|c| proc {deprecate("Sequel::Dataset#method_missing", "Use order(#{c.inspect}).first or define first_by_#{c}"); order(c).first}},
/^last_by_(.+)$/ => proc {|c| proc {deprecate("Sequel::Dataset#method_missing", "Use order(#{c.inspect}).last or define last_by_#{c}"); order(c).last}},
/^filter_by_(.+)$/ => proc {|c| proc {|v| deprecate("Sequel::Dataset#method_missing", "Use filter(#{c.inspect}=>#{v.inspect}) or define filter_by_#{c}"); filter(c => v)}},
/^all_by_(.+)$/ => proc {|c| proc {|v| deprecate("Sequel::Dataset#method_missing", "Use filter(#{c.inspect}=>#{v.inspect}).all or define all_by_#{c}"); filter(c => v).all}},
/^find_by_(.+)$/ => proc {|c| proc {|v| deprecate("Sequel::Dataset#method_missing", "Use filter(#{c.inspect}=>#{v.inspect}).first or define find_by_#{c}"); filter(c => v).first}},
/^group_by_(.+)$/ => proc {|c| proc {deprecate("Sequel::Dataset#method_missing", "Use group(#{c.inspect}) or define group_by_#{c}"); group(c)}},
/^count_by_(.+)$/ => proc {|c| proc {deprecate("Sequel::Dataset#method_missing", "Use group_and_count(#{c.inspect}) or define count_by_#{c})"); group_and_count(c)}}
}
# Checks if the given method name represents a magic method and
# defines it. Otherwise, nil is returned.
def magic_method_missing(m) #:nodoc:
method_name = m.to_s
MAGIC_METHODS.each_pair do |r, p|
if method_name =~ r
impl = p[$1.to_sym]
return Dataset.class_def(m, &impl)
end
end
nil
end
end
module SQL
module DeprecatedColumnMethods #:nodoc:
AS = 'AS'.freeze
DESC = 'DESC'.freeze
ASC = 'ASC'.freeze
def as(a) #:nodoc:
Sequel::Deprecation.deprecate("Object#as is deprecated and will be removed in Sequel 2.0. Use Symbol#as or String#as.")
ColumnExpr.new(self, AS, a)
end
def AS(a) #:nodoc:
Sequel::Deprecation.deprecate("Object#AS is deprecated and will be removed in Sequel 2.0. Use Symbol#as or String#as.")
ColumnExpr.new(self, AS, a)
end
def desc #:nodoc:
Sequel::Deprecation.deprecate("Object#desc is deprecated and will be removed in Sequel 2.0. Use Symbol#desc or String#desc.")
ColumnExpr.new(self, DESC)
end
def DESC #:nodoc:
Sequel::Deprecation.deprecate("Object#DESC is deprecated and will be removed in Sequel 2.0. Use Symbol#desc or String#desc.")
ColumnExpr.new(self, DESC)
end
def asc #:nodoc:
Sequel::Deprecation.deprecate("Object#asc is deprecated and will be removed in Sequel 2.0. Use Symbol#asc or String#asc.")
ColumnExpr.new(self, ASC)
end
def ASC #:nodoc:
Sequel::Deprecation.deprecate("Object#ASC is deprecated and will be removed in Sequel 2.0. Use Symbol#asc or String#asc.")
ColumnExpr.new(self, ASC)
end
def all #:nodoc:
Sequel::Deprecation.deprecate("Object#all is deprecated and will be removed in Sequel 2.0. Use :#{self}.* or '#{self}.*'.lit.")
Sequel::SQL::ColumnAll.new(self)
end
def ALL #:nodoc:
Sequel::Deprecation.deprecate("Object#ALL is deprecated and will be removed in Sequel 2.0. Use :#{self}.* or '#{self}.*'.lit.")
Sequel::SQL::ColumnAll.new(self)
end
def cast_as(t) #:nodoc:
Sequel::Deprecation.deprecate("Object#cast_as is deprecated and will be removed in Sequel 2.0. Use Symbol#cast_as or String#cast_as.")
if t.is_a?(Symbol)
t = t.to_s.lit
end
Sequel::SQL::Function.new(:cast, self.as(t))
end
end
end
end
class Object
include Sequel::SQL::DeprecatedColumnMethods
def Sequel(*args) #:nodoc:
Sequel::Deprecation.deprecate("Object#Sequel is deprecated and will be removed in Sequel 2.0. Use Sequel.connect.")
Sequel.connect(*args)
end
def rollback! #:nodoc:
Sequel::Deprecation.deprecate("Object#rollback! is deprecated and will be removed in Sequel 2.0. Use raise Sequel::Error::Rollback.")
raise Sequel::Error::Rollback
end
end
class Symbol
# Converts missing method calls into functions on columns, if the
# method name is made of all upper case letters.
def method_missing(sym, *args) #:nodoc:
if ((s = sym.to_s) =~ /^([A-Z]+)$/)
Sequel::Deprecation.deprecate("Symbol#method_missing is deprecated and will be removed in Sequel 2.0. Use :#{sym}[:#{self}].")
Sequel::SQL::Function.new(s.downcase, self)
else
super
end
end
end
|
