<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: ActiveRecord::Acts::Versioned::ActMethods::ClassMethods</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">ActiveRecord::Acts::Versioned::ActMethods::ClassMethods</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../../../files/lib/acts_as_versioned_rb.html">
lib/acts_as_versioned.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000018">create_versioned_table</a>
<a href="#M000019">drop_versioned_table</a>
<a href="#M000017">versioned_class</a>
<a href="#M000016">versioned_columns</a>
<a href="#M000021">without_locking</a>
<a href="#M000020">without_revision</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="#M000018" class="method-signature">
<span class="method-name">create_versioned_table</span><span class="method-args">(create_table_options = {})</span>
</a>
</div>
<div class="method-description">
<p>
Rake migration task to create the versioned table using options passed to
acts_as_versioned
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000018-source">
<pre>
<span class="ruby-comment cmt"># File lib/acts_as_versioned.rb, line 408</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_versioned_table</span>(<span class="ruby-identifier">create_table_options</span> = {})
<span class="ruby-comment cmt"># create version column in main table if it does not exist</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">content_columns</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> [<span class="ruby-identifier">version_column</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value str">'lock_version'</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">name</span> }
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">add_column</span> <span class="ruby-identifier">table_name</span>, <span class="ruby-identifier">version_column</span>, <span class="ruby-identifier">:integer</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">reset_column_information</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">connection</span>.<span class="ruby-identifier">table_exists?</span>(<span class="ruby-identifier">versioned_table_name</span>)
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">create_table</span>(<span class="ruby-identifier">versioned_table_name</span>, <span class="ruby-identifier">create_table_options</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">t</span>.<span class="ruby-identifier">column</span> <span class="ruby-identifier">versioned_foreign_key</span>, <span class="ruby-identifier">:integer</span>
<span class="ruby-identifier">t</span>.<span class="ruby-identifier">column</span> <span class="ruby-identifier">version_column</span>, <span class="ruby-identifier">:integer</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">versioned_columns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">col</span><span class="ruby-operator">|</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">add_column</span> <span class="ruby-identifier">versioned_table_name</span>, <span class="ruby-identifier">col</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">col</span>.<span class="ruby-identifier">type</span>,
<span class="ruby-identifier">:limit</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">col</span>.<span class="ruby-identifier">limit</span>,
<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">col</span>.<span class="ruby-identifier">default</span>,
<span class="ruby-identifier">:scale</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">col</span>.<span class="ruby-identifier">scale</span>,
<span class="ruby-identifier">:precision</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">col</span>.<span class="ruby-identifier">precision</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">type_col</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">columns_hash</span>[<span class="ruby-identifier">inheritance_column</span>]
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">add_column</span> <span class="ruby-identifier">versioned_table_name</span>, <span class="ruby-identifier">versioned_inheritance_column</span>, <span class="ruby-identifier">type_col</span>.<span class="ruby-identifier">type</span>,
<span class="ruby-identifier">:limit</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type_col</span>.<span class="ruby-identifier">limit</span>,
<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type_col</span>.<span class="ruby-identifier">default</span>,
<span class="ruby-identifier">:scale</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type_col</span>.<span class="ruby-identifier">scale</span>,
<span class="ruby-identifier">:precision</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type_col</span>.<span class="ruby-identifier">precision</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">add_index</span> <span class="ruby-identifier">versioned_table_name</span>, <span class="ruby-identifier">versioned_foreign_key</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000019" class="method-detail">
<a name="M000019"></a>
<div class="method-heading">
<a href="#M000019" class="method-signature">
<span class="method-name">drop_versioned_table</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Rake migration task to drop the versioned table
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000019-source">
<pre>
<span class="ruby-comment cmt"># File lib/acts_as_versioned.rb, line 442</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">drop_versioned_table</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">drop_table</span> <span class="ruby-identifier">versioned_table_name</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000017" class="method-detail">
<a name="M000017"></a>
<div class="method-heading">
<a href="#M000017" class="method-signature">
<span class="method-name">versioned_class</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns an instance of the dynamic versioned model
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000017-source">
<pre>
<span class="ruby-comment cmt"># File lib/acts_as_versioned.rb, line 403</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">versioned_class</span>
<span class="ruby-identifier">const_get</span> <span class="ruby-identifier">versioned_class_name</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="#M000016" class="method-signature">
<span class="method-name">versioned_columns</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns an array of columns that are versioned. See non_versioned_columns
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000016-source">
<pre>
<span class="ruby-comment cmt"># File lib/acts_as_versioned.rb, line 398</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">versioned_columns</span>
<span class="ruby-ivar">@versioned_columns</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">columns</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">non_versioned_columns</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">name</span>) }
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000021" class="method-detail">
<a name="M000021"></a>
<div class="method-heading">
<a href="#M000021" class="method-signature">
<span class="method-name">without_locking</span><span class="method-args">(&block)</span>
</a>
</div>
<div class="method-description">
<p>
Turns off optimistic locking for the duration of the block
</p>
<pre>
Foo.without_locking do
@foo.save
end
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000021-source">
<pre>
<span class="ruby-comment cmt"># File lib/acts_as_versioned.rb, line 474</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">without_locking</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">current</span> = <span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">lock_optimistically</span>
<span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">lock_optimistically</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">current</span>
<span class="ruby-keyword kw">begin</span>
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
<span class="ruby-keyword kw">ensure</span>
<span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">lock_optimistically</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">current</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000020" class="method-detail">
<a name="M000020"></a>
<div class="method-heading">
<a href="#M000020" class="method-signature">
<span class="method-name">without_revision</span><span class="method-args">(&block)</span>
</a>
</div>
<div class="method-description">
<p>
Executes the block with the versioning callbacks disabled.
</p>
<pre>
Foo.without_revision do
@foo.save
end
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000020-source">
<pre>
<span class="ruby-comment cmt"># File lib/acts_as_versioned.rb, line 452</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">without_revision</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">class_eval</span> <span class="ruby-keyword kw">do</span>
<span class="ruby-constant">CALLBACKS</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr_name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">alias_method</span> <span class="ruby-node">"orig_#{attr_name}"</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">attr_name</span>
<span class="ruby-identifier">alias_method</span> <span class="ruby-identifier">attr_name</span>, <span class="ruby-identifier">:empty_callback</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
<span class="ruby-keyword kw">ensure</span>
<span class="ruby-identifier">class_eval</span> <span class="ruby-keyword kw">do</span>
<span class="ruby-constant">CALLBACKS</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr_name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">alias_method</span> <span class="ruby-identifier">attr_name</span>, <span class="ruby-node">"orig_#{attr_name}"</span>.<span class="ruby-identifier">to_sym</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>