ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-22 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
b49d396397
active_model_serializers/ActiveModelSerializers/KeyTransform.html
Benjamin Fleischer b49d396397 Generating docs for version 0.10.0 at ref 7398e89.
2016-06-14 10:45:56 -05:00

533 lines
16 KiB
HTML
Raw Blame History

<!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>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: ActiveModelSerializers::KeyTransform
&mdash; Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!ActiveModelSerializers/KeyTransform.html";
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (K)</a> &raquo;
<span class='title'><span class='object_link'><a href="../ActiveModelSerializers.html" title="ActiveModelSerializers (module)">ActiveModelSerializers</a></span></span>
&raquo;
<span class="title">KeyTransform</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: ActiveModelSerializers::KeyTransform
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/active_model_serializers/key_transform.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#camel-class_method" title="camel (class method)">+ (Object) <strong>camel</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Transforms values to UpperCamelCase or PascalCase.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#camel_lower-class_method" title="camel_lower (class method)">+ (Object) <strong>camel_lower</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Transforms values to camelCase.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dash-class_method" title="dash (class method)">+ (Object) <strong>dash</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Transforms values to dashed-case.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unaltered-class_method" title="unaltered (class method)">+ (Object) <strong>unaltered</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value unaltered.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#underscore-class_method" title="underscore (class method)">+ (Object) <strong>underscore</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Transforms values to underscore_case.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="camel-class_method">
+ (<tt>Object</tt>) <strong>camel</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>Transforms values to UpperCamelCase or PascalCase.</p>
<p>@example:</p>
<pre class="code ruby"><code class="ruby">&quot;some_key&quot; =&gt; &quot;SomeKey&quot;,</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="{https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L66-L76" target="_parent" title="ActiveSupport::Inflector.camelize}">ActiveSupport::Inflector.camelize}</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14
15
16
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/key_transform.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_camel'>camel</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>when</span> <span class='const'>Hash</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_deep_transform_keys!'>deep_transform_keys!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <span class='id identifier rubyid_camel'>camel</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>when</span> <span class='const'>Symbol</span> <span class='kw'>then</span> <span class='id identifier rubyid_camel'>camel</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>when</span> <span class='const'>String</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span>
<span class='kw'>else</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="camel_lower-class_method">
+ (<tt>Object</tt>) <strong>camel_lower</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>Transforms values to camelCase.</p>
<p>@example:</p>
<pre class="code ruby"><code class="ruby">&quot;some_key&quot; =&gt; &quot;someKey&quot;,</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="{https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L66-L76" target="_parent" title="ActiveSupport::Inflector.camelize}">ActiveSupport::Inflector.camelize}</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/key_transform.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_camel_lower'>camel_lower</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>when</span> <span class='const'>Hash</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_deep_transform_keys!'>deep_transform_keys!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <span class='id identifier rubyid_camel_lower'>camel_lower</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>when</span> <span class='const'>Symbol</span> <span class='kw'>then</span> <span class='id identifier rubyid_camel_lower'>camel_lower</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>when</span> <span class='const'>String</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='symbol'>:lower</span><span class='rparen'>)</span>
<span class='kw'>else</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="dash-class_method">
+ (<tt>Object</tt>) <strong>dash</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>Transforms values to dashed-case. This is the default case for the JsonApi
adapter.</p>
<p>@example:</p>
<pre class="code ruby"><code class="ruby">&quot;some_key&quot; =&gt; &quot;some-key&quot;,</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="{https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L185-L187" target="_parent" title="ActiveSupport::Inflector.dasherize}">ActiveSupport::Inflector.dasherize}</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43
44
45
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/key_transform.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dash'>dash</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>when</span> <span class='const'>Hash</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_deep_transform_keys!'>deep_transform_keys!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <span class='id identifier rubyid_dash'>dash</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>when</span> <span class='const'>Symbol</span> <span class='kw'>then</span> <span class='id identifier rubyid_dash'>dash</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>when</span> <span class='const'>String</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span><span class='period'>.</span><span class='id identifier rubyid_dasherize'>dasherize</span>
<span class='kw'>else</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unaltered-class_method">
+ (<tt>Object</tt>) <strong>unaltered</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value unaltered</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/key_transform.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unaltered'>unaltered</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="underscore-class_method">
+ (<tt>Object</tt>) <strong>underscore</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>Transforms values to underscore_case. This is the default case for
deserialization in the JsonApi adapter.</p>
<p>@example:</p>
<pre class="code ruby"><code class="ruby">&quot;some-key&quot; =&gt; &quot;some_key&quot;,</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="{https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L89-L98" target="_parent" title="ActiveSupport::Inflector.underscore}">ActiveSupport::Inflector.underscore}</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58
59
60
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/key_transform.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_underscore'>underscore</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>when</span> <span class='const'>Hash</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_deep_transform_keys!'>deep_transform_keys!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <span class='id identifier rubyid_underscore'>underscore</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>when</span> <span class='const'>Symbol</span> <span class='kw'>then</span> <span class='id identifier rubyid_underscore'>underscore</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>when</span> <span class='const'>String</span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_underscore'>underscore</span>
<span class='kw'>else</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Jun 14 10:45:52 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink