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
|
# frozen-string-literal: true
require 'sequel/core'
module Sequel
# Delegate to Sequel::Model, only for backwards compatibility.
def self.cache_anonymous_models
Model.cache_anonymous_models
end
# Delegate to Sequel::Model, only for backwards compatibility.
def self.cache_anonymous_models=(v)
Model.cache_anonymous_models = v
end
# <tt>Sequel::Model</tt> is an object relational mapper built on top of Sequel core. Each
# model class is backed by a dataset instance, and many dataset methods can be
# called directly on the class. Model datasets return rows as model instances,
# which have fairly standard ORM instance behavior.
#
# <tt>Sequel::Model</tt> is built completely out of plugins. Plugins can override any class,
# instance, or dataset method defined by a previous plugin and call super to get the default
# behavior. By default, <tt>Sequel::Model</tt> loads two plugins, <tt>Sequel::Model</tt>
# (which is itself a plugin) for the base support, and <tt>Sequel::Model::Associations</tt>
# for the associations support.
#
# You can set the +SEQUEL_NO_ASSOCIATIONS+ constant or environment variable to
# make Sequel not load the associations plugin by default.
class Model
OPTS = Sequel::OPTS
# Map that stores model classes created with <tt>Sequel::Model()</tt>, to allow the reopening
# of classes when dealing with code reloading.
ANONYMOUS_MODEL_CLASSES = @Model_cache = {}
# Mutex protecting access to ANONYMOUS_MODEL_CLASSES
ANONYMOUS_MODEL_CLASSES_MUTEX = @Model_mutex = Mutex.new
# Class methods added to model that call the method of the same name on the dataset
DATASET_METHODS = (Dataset::ACTION_METHODS + Dataset::QUERY_METHODS +
[:each_server]) - [:and, :or, :[], :columns, :columns!, :delete, :update, :add_graph_aliases, :first, :first!]
# Boolean settings that can be modified at the global, class, or instance level.
BOOLEAN_SETTINGS = [:typecast_empty_string_to_nil, :typecast_on_assignment, :strict_param_setting, \
:raise_on_save_failure, :raise_on_typecast_failure, :require_modification, :use_after_commit_rollback, :use_transactions]
# Hooks that are called before an action. Can return false to not do the action. When
# overriding these, it is recommended to call +super+ as the last line of your method,
# so later hooks are called before earlier hooks.
BEFORE_HOOKS = [:before_create, :before_update, :before_save, :before_destroy, :before_validation]
# Hooks that are called after an action. When overriding these, it is recommended to call
# +super+ on the first line of your method, so later hooks are called after earlier hooks.
AFTER_HOOKS = [:after_create, :after_update, :after_save, :after_destroy,
:after_validation, :after_commit, :after_rollback, :after_destroy_commit, :after_destroy_rollback]
# Hooks that are called around an action. If overridden, these methods must call super
# exactly once if the behavior they wrap is desired. The can be used to rescue exceptions
# raised by the code they wrap or ensure that some behavior is executed no matter what.
AROUND_HOOKS = [:around_create, :around_update, :around_save, :around_destroy, :around_validation]
# Empty instance methods to create that the user can override to get hook/callback behavior.
# Just like any other method defined by Sequel, if you override one of these, you should
# call +super+ to get the default behavior (while empty by default, they can also be defined
# by plugins). See the {"Model Hooks" guide}[rdoc-ref:doc/model_hooks.rdoc] for
# more detail on hooks.
HOOKS = BEFORE_HOOKS + AFTER_HOOKS
# Class instance variables that are inherited in subclasses. If the value is <tt>:dup</tt>, dup is called
# on the superclass's instance variable when creating the instance variable in the subclass.
# If the value is +nil+, the superclass's instance variable is used directly in the subclass.
INHERITED_INSTANCE_VARIABLES = {:@allowed_columns=>:dup,
:@dataset_method_modules=>:dup, :@primary_key=>nil, :@use_transactions=>nil,
:@raise_on_save_failure=>nil, :@require_modification=>nil,
:@restricted_columns=>:dup, :@restrict_primary_key=>nil,
:@simple_pk=>nil, :@simple_table=>nil, :@strict_param_setting=>nil,
:@typecast_empty_string_to_nil=>nil, :@typecast_on_assignment=>nil,
:@raise_on_typecast_failure=>nil, :@plugins=>:dup, :@setter_methods=>nil,
:@use_after_commit_rollback=>nil, :@fast_pk_lookup_sql=>nil,
:@fast_instance_delete_sql=>nil, :@finders=>:dup, :@finder_loaders=>:dup,
:@db=>nil, :@default_set_fields_options=>:dup, :@require_valid_table=>nil,
:@cache_anonymous_models=>nil, :@Model_mutex=>nil}
# Regular expression that determines if a method name is normal in the sense that
# it could be used literally in ruby code without using send. Used to
# avoid problems when using eval with a string to define methods.
NORMAL_METHOD_NAME_REGEXP = /\A[A-Za-z_][A-Za-z0-9_]*\z/
# Regular expression that determines if the method is a valid setter name
# (i.e. it ends with =).
SETTER_METHOD_REGEXP = /=\z/
@allowed_columns = nil
@cache_anonymous_models = true
@db = nil
@db_schema = nil
@dataset = nil
@dataset_method_modules = []
@default_eager_limit_strategy = true
@default_set_fields_options = {}
@finders = {}
@finder_loaders = {}
@overridable_methods_module = nil
@fast_pk_lookup_sql = nil
@fast_instance_delete_sql = nil
@plugins = []
@primary_key = :id
@raise_on_save_failure = true
@raise_on_typecast_failure = false
@require_modification = nil
@require_valid_table = false
@restrict_primary_key = true
@restricted_columns = nil
@setter_methods = nil
@simple_pk = nil
@simple_table = nil
@strict_param_setting = true
@typecast_empty_string_to_nil = true
@typecast_on_assignment = true
@use_after_commit_rollback = true
@use_transactions = true
Sequel.require %w"default_inflections inflections plugins dataset_module base exceptions errors", "model"
if !defined?(::SEQUEL_NO_ASSOCIATIONS) && !ENV.has_key?('SEQUEL_NO_ASSOCIATIONS')
Sequel.require 'associations', 'model'
plugin Model::Associations
end
# The setter methods (methods ending with =) that are never allowed
# to be called automatically via +set+/+update+/+new+/etc..
RESTRICTED_SETTER_METHODS = instance_methods.map(&:to_s).grep(SETTER_METHOD_REGEXP)
def_Model(::Sequel)
end
end
|
