Class: Sequel::Model
- Extended by:
- Enumerable, Inflections, Metaprogramming
- Includes:
- Metaprogramming
- Defined in:
- lib/sequel/model.rb,
lib/sequel/model/base.rb,
lib/sequel/model/errors.rb,
lib/sequel/model/plugins.rb,
lib/sequel/model/associations.rb
Overview
Sequel::Model 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.
Sequel::Model is built completely out of plugins, the only method not part of a plugin is the plugin method itself. Plugins can override any class, instance, or dataset method defined by a previous plugin and call super to get the default behavior.
You can set the SEQUEL_NO_ASSOCIATIONS constant or environment variable to make Sequel not load the associations plugin by default.
Defined Under Namespace
Modules: Associations, ClassMethods, DatasetMethods, InstanceMethods Classes: Errors
Constant Summary collapse
- ANONYMOUS_MODEL_CLASSES =
Map that stores model classes created with Sequel::Model(), to allow the reopening of classes when dealing with code reloading.
{}
- DATASET_METHODS =
Class methods added to model that call the method of the same name on the dataset
(Dataset::ACTION_METHODS + Dataset::QUERY_METHODS + [:eager, :eager_graph, :each_page, :each_server, :print]) - [:and, :or, :[], :[]=, :columns, :columns!]
- EMPTY_INSTANCE_VARIABLES =
Class instance variables to set to nil when a subclass is created, for -w compliance
[:@overridable_methods_module, :@db]
- BOOLEAN_SETTINGS =
Boolean settings that can be modified at the global, class, or instance level.
[:typecast_empty_string_to_nil, :typecast_on_assignment, :strict_param_setting, :raise_on_save_failure, :raise_on_typecast_failure, :require_modification, :use_transactions]
- BEFORE_HOOKS =
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_create, :before_update, :before_save, :before_destroy, :before_validation]
- AFTER_HOOKS =
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 before earlier hooks.
[:after_initialize, :after_create, :after_update, :after_save, :after_destroy, :after_validation]
- HOOKS =
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 for more detail on hooks.
BEFORE_HOOKS + AFTER_HOOKS
- INHERITED_INSTANCE_VARIABLES =
Class instance variables that are inherited in subclasses. If the value is :dup, 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.
{:@allowed_columns=>:dup, :@dataset_methods=>: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}
- NORMAL_METHOD_NAME_REGEXP =
Regexp that determines if a method name is normal in the sense that it could be called directly in ruby code without using send. Used to avoid problems when using eval with a string to define methods.
/\A[A-Za-z_][A-Za-z0-9_]*\z/
- SETTER_METHOD_REGEXP =
Regular expression that determines if the method is a valid setter name (i.e. it ends with =).
/=\z/
- RESTRICTED_SETTER_METHODS =
The setter methods (methods ending with =) that are never allowed to be called automatically via set/update/new/etc..
instance_methods.map{|x| x.to_s}.grep(SETTER_METHOD_REGEXP)
Constants included from Inflections
Inflections::CAMELIZE_CONVERT_REGEXP, Inflections::CAMELIZE_MODULE_REGEXP, Inflections::DASH, Inflections::DEMODULIZE_CONVERT_REGEXP, Inflections::EMPTY_STRING, Inflections::SLASH, Inflections::UNDERSCORE, Inflections::UNDERSCORE_CONVERT_REGEXP1, Inflections::UNDERSCORE_CONVERT_REGEXP2, Inflections::UNDERSCORE_CONVERT_REPLACE, Inflections::UNDERSCORE_MODULE_REGEXP, Inflections::VALID_CONSTANT_NAME_REGEXP
Class Method Summary collapse
-
.plugin(plugin, *args, &blk) ⇒ Object
Loads a plugin for use with the model class, passing optional arguments to the plugin.
Methods included from Inflections
clear, irregular, plural, singular, uncountable
Methods included from Metaprogramming
Class Method Details
.plugin(plugin, *args, &blk) ⇒ Object
Loads a plugin for use with the model class, passing optional arguments to the plugin. If the plugin is a module, load it directly. Otherwise, require the plugin from either sequel/plugins/#plugin or sequel_#plugin, and then attempt to load the module using a the camelized plugin name under Sequel::Plugins.
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/sequel/model/plugins.rb', line 29 def self.plugin(plugin, *args, &blk) arg = args.first m = plugin.is_a?(Module) ? plugin : plugin_module(plugin) unless @plugins.include?(m) @plugins << m m.apply(self, *args, &blk) if m.respond_to?(:apply) include(m::InstanceMethods) if m.const_defined?("InstanceMethods") extend(m::ClassMethods)if m.const_defined?("ClassMethods") if m.const_defined?("DatasetMethods") dataset.extend(m::DatasetMethods) if @dataset dataset_method_modules << m::DatasetMethods meths = m::DatasetMethods.public_instance_methods.reject{|x| NORMAL_METHOD_NAME_REGEXP !~ x.to_s} def_dataset_method(*meths) unless meths.empty? end end m.configure(self, *args, &blk) if m.respond_to?(:configure) end |