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
dd0d9c6835
active_model_serializers/ActiveModelSerializers/Logging/Macros.html
Benjamin Fleischer dd0d9c6835 Generating docs for version 0.10.0 at ref 7578a3c.
2016-06-15 10:31:33 -05:00

249 lines
9.8 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::Logging::Macros
&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/Logging/Macros.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 (M)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../ActiveModelSerializers.html" title="ActiveModelSerializers (module)">ActiveModelSerializers</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Logging.html" title="ActiveModelSerializers::Logging (module)">Logging</a></span></span>
&raquo;
<span class="title">Macros</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::Logging::Macros
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/active_model_serializers/logging.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Macros that can be used to customize the logging of class or instance
methods, by extending the class or its singleton.</p>
<p>Adapted from:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_https'>https</span><span class='symbol'>:/</span><span class='op'>/</span><span class='id identifier rubyid_github'>github</span><span class='period'>.</span><span class='id identifier rubyid_com'>com</span><span class='op'>/</span><span class='id identifier rubyid_rubygems'>rubygems</span><span class='op'>/</span><span class='id identifier rubyid_rubygems'>rubygems</span><span class='op'>/</span><span class='id identifier rubyid_blob'>blob</span><span class='op'>/</span><span class='id identifier rubyid_cb28f5e991'>cb28f5e991</span><span class='op'>/</span><span class='id identifier rubyid_lib'>lib</span><span class='op'>/</span><span class='id identifier rubyid_rubygems'>rubygems</span><span class='op'>/</span><span class='id identifier rubyid_deprecate'>deprecate</span><span class='period'>.</span><span class='id identifier rubyid_rb'>rb</span>
</code></pre>
<p>Provides a single method <code>notify</code> to be used to declare when
something a method notifies, with the argument <code>callback_name</code>
of the notification callback.</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Adapter</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_klass_method'>klass_method</span>
<span class='comment'># ...
</span> <span class='kw'>end</span>
<span class='kw'>def</span> <span class='id identifier rubyid_instance_method'>instance_method</span>
<span class='comment'># ...
</span> <span class='kw'>end</span>
<span class='id identifier rubyid_include'>include</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Logging</span><span class='op'>::</span><span class='const'>Macros</span>
<span class='id identifier rubyid_notify'>notify</span> <span class='symbol'>:instance_method</span><span class='comma'>,</span> <span class='symbol'>:render</span>
<span class='kw'>class</span> <span class='op'>&lt;&lt;</span> <span class='kw'>self</span>
<span class='id identifier rubyid_extend'>extend</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Logging</span><span class='op'>::</span><span class='const'>Macros</span>
<span class='id identifier rubyid_notify'>notify</span> <span class='symbol'>:klass_method</span><span class='comma'>,</span> <span class='symbol'>:render</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#notify-instance_method" title="#notify (instance method)">- (Object) <strong>notify</strong>(name, callback_name) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Simple notify method that wraps up <code>name</code> in a dummy method.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="notify-instance_method">
- (<tt>Object</tt>) <strong>notify</strong>(name, callback_name)
</h3><div class="docstring">
<div class="discussion">
<p>Simple notify method that wraps up <code>name</code> in a dummy method. It
notifies on with the <code>callback_name</code> notifier on each call to
the dummy method, telling what the current serializer and adapter are being
rendered. Adapted from:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_https'>https</span><span class='symbol'>:/</span><span class='op'>/</span><span class='id identifier rubyid_github'>github</span><span class='period'>.</span><span class='id identifier rubyid_com'>com</span><span class='op'>/</span><span class='id identifier rubyid_rubygems'>rubygems</span><span class='op'>/</span><span class='id identifier rubyid_rubygems'>rubygems</span><span class='op'>/</span><span class='id identifier rubyid_blob'>blob</span><span class='op'>/</span><span class='id identifier rubyid_cb28f5e991'>cb28f5e991</span><span class='op'>/</span><span class='id identifier rubyid_lib'>lib</span><span class='op'>/</span><span class='id identifier rubyid_rubygems'>rubygems</span><span class='op'>/</span><span class='id identifier rubyid_deprecate'>deprecate</span><span class='period'>.</span><span class='id identifier rubyid_rb'>rb</span>
</code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63
64
65
66
67
68
69
70
71
72
73</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/active_model_serializers/logging.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_callback_name'>callback_name</span><span class='rparen'>)</span>
<span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
<span class='id identifier rubyid_old'>old</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>_notifying_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_callback_name'>callback_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_alias_method'>alias_method</span> <span class='id identifier rubyid_old'>old</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_define_method'>define_method</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>do</span> <span class='op'>|</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='op'>|</span>
<span class='id identifier rubyid_run_callbacks'>run_callbacks</span> <span class='id identifier rubyid_callback_name'>callback_name</span> <span class='kw'>do</span>
<span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_old'>old</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 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