fix: add doc on new use cases (#91)

* Move create_raid_request to raid.request * Regenerate docs
tripledes · Dec 24, 2019 · 050d02b · 050d02b
1 parent f305ba5
commit 050d02b
Show file tree

Hide file tree

Showing 14 changed files with 197 additions and 91 deletions.
diff --git a/doc/build/doctrees/application.doctree b/doc/build/doctrees/application.doctree
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
diff --git a/doc/build/html/_sources/application.rst.txt b/doc/build/html/_sources/application.rst.txt
@@ -10,14 +10,19 @@ thesheriff.application module.
 Gang
 ----
 
-.. _join_gang_request:
-.. module:: thesheriff.application.gang.request.join_gang_request
-.. autoclass:: JoinGangRequest
-   :members:
 .. _gang_list_gangs:
 .. module:: thesheriff.application.gang.list_gangs
 .. autoclass:: ListGangs
    :members:
+.. _create_gang_request:
+.. module:: thesheriff.application.gang.request.create_gang_request
+.. autoclass:: CreateGangRequest
+   :members:
+.. _join_gang_request:
+.. module:: thesheriff.application.gang.request.join_gang_request
+.. autoclass:: JoinGangRequest
+   :members:
+
 
 Outlaw
 ------
@@ -30,6 +35,10 @@ Outlaw
 .. module:: thesheriff.application.outlaw.create_outlaw
 .. autoclass:: CreateOutlaw
    :members:
+.. _invite_friend:
+.. module:: thesheriff.application.outlaw.invite_friend
+.. autoclass:: InviteFriend
+   :members:
 .. _join_gang:
 .. module:: thesheriff.application.outlaw.join_gang
 .. autoclass:: JoinGang
@@ -46,10 +55,6 @@ Outlaw
 .. module:: thesheriff.application.outlaw.rate_raid
 .. autoclass:: RateRaid
    :members:
-.. _invite_friend:
-.. module:: thesheriff.application.outlaw.invite_friend
-.. autoclass:: InviteFriend
-   :members:
 .. _create_outlaw_request:
 .. module:: thesheriff.application.outlaw.request.create_outlaw_request
 .. autoclass:: CreateOutlawRequest
@@ -67,3 +72,7 @@ Raid
 .. module:: thesheriff.application.raid.grade_raid
 .. autoclass:: GradeRaid
    :members:
+.. _create_raid_request:
+.. module:: thesheriff.application.raid.request.create_raid_request
+.. autoclass:: CreateRaidRequest
+   :members:
diff --git a/doc/build/html/application.html b/doc/build/html/application.html
@@ -38,20 +38,6 @@
 thesheriff.application module.</p>
 <div class="section" id="gang">
 <h2>Gang<a class="headerlink" href="#gang" title="Permalink to this headline">¶</a></h2>
-<span class="target" id="module-thesheriff.application.gang.request.join_gang_request"><span id="join-gang-request"></span></span><dl class="class">
-<dt id="thesheriff.application.gang.request.join_gang_request.JoinGangRequest">
-<em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.gang.request.join_gang_request.</code><code class="sig-name descname">JoinGangRequest</code><span class="sig-paren">(</span><em class="sig-param">gang_id: int</em>, <em class="sig-param">outlaw_id: int</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.gang.request.join_gang_request.JoinGangRequest" title="Permalink to this definition">¶</a></dt>
-<dd><p>Class JoinGangRequest holds data required to join a Gang.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>gang_id</strong> (<em>Integer</em>) – Id of the Gang.</p></li>
-<li><p><strong>outlaw_id</strong> (<em>Integer</em>) – Id of the Outlaw generating the request.</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-
 <span class="target" id="module-thesheriff.application.gang.list_gangs"><span id="gang-list-gangs"></span></span><dl class="class">
 <dt id="thesheriff.application.gang.list_gangs.ListGangs">
 <em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.gang.list_gangs.</code><code class="sig-name descname">ListGangs</code><span class="sig-paren">(</span><em class="sig-param">gang_repository: thesheriff.domain.gang.repository.gang_repository.GangRepository</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.gang.list_gangs.ListGangs" title="Permalink to this definition">¶</a></dt>
@@ -77,6 +63,34 @@ <h2>Gang<a class="headerlink" href="#gang" title="Permalink to this headline">¶
 
 </dd></dl>
 
+<span class="target" id="module-thesheriff.application.gang.request.create_gang_request"><span id="create-gang-request"></span></span><dl class="class">
+<dt id="thesheriff.application.gang.request.create_gang_request.CreateGangRequest">
+<em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.gang.request.create_gang_request.</code><code class="sig-name descname">CreateGangRequest</code><span class="sig-paren">(</span><em class="sig-param">owner_id: int</em>, <em class="sig-param">name: str</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.gang.request.create_gang_request.CreateGangRequest" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class JoinGangRequest holds data required to join a Gang.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<em>String</em>) – Name of the Gang.</p></li>
+<li><p><strong>owner_id</strong> (<em>Integer</em>) – Id of the Outlaw creating the gang.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
+<span class="target" id="module-thesheriff.application.gang.request.join_gang_request"><span id="join-gang-request"></span></span><dl class="class">
+<dt id="thesheriff.application.gang.request.join_gang_request.JoinGangRequest">
+<em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.gang.request.join_gang_request.</code><code class="sig-name descname">JoinGangRequest</code><span class="sig-paren">(</span><em class="sig-param">gang_id: int</em>, <em class="sig-param">outlaw_id: int</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.gang.request.join_gang_request.JoinGangRequest" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class JoinGangRequest holds data required to join a Gang.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>gang_id</strong> (<em>Integer</em>) – Id of the Gang.</p></li>
+<li><p><strong>outlaw_id</strong> (<em>Integer</em>) – Id of the Outlaw generating the request.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 </div>
 <div class="section" id="outlaw">
 <h2>Outlaw<a class="headerlink" href="#outlaw" title="Permalink to this headline">¶</a></h2>
@@ -139,6 +153,34 @@ <h2>Outlaw<a class="headerlink" href="#outlaw" title="Permalink to this headline
 
 </dd></dl>
 
+<span class="target" id="module-thesheriff.application.outlaw.invite_friend"><span id="invite-friend"></span></span><dl class="class">
+<dt id="thesheriff.application.outlaw.invite_friend.InviteFriend">
+<em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.outlaw.invite_friend.</code><code class="sig-name descname">InviteFriend</code><span class="sig-paren">(</span><em class="sig-param">mail_notifier: thesheriff.domain.mail.notifier.mail_notifier.MailNotifier</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.outlaw.invite_friend.InviteFriend" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class InviteFriend implements the invite a friend use case.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>mail_notifier</strong> (<em>MailNotifier</em>) – Repository managing the Gang domain entities.</p>
+</dd>
+</dl>
+<dl class="method">
+<dt id="thesheriff.application.outlaw.invite_friend.InviteFriend.execute">
+<code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">receiver_mail_address</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.outlaw.invite_friend.InviteFriend.execute" title="Permalink to this definition">¶</a></dt>
+<dd><p>execute is the actual action of the Invite Friend use case.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><p><strong>receiver_mail_address</strong> (<em>String</em>) – The address to write on the TO field.</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>No value returned.</p>
+</dd>
+<dt class="field-odd">Return type</dt>
+<dd class="field-odd"><p>NoReturn</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
 <span class="target" id="module-thesheriff.application.outlaw.join_gang"><span id="join-gang"></span></span><dl class="class">
 <dt id="thesheriff.application.outlaw.join_gang.JoinGang">
 <em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.outlaw.join_gang.</code><code class="sig-name descname">JoinGang</code><span class="sig-paren">(</span><em class="sig-param">outlaw_repository: thesheriff.domain.outlaw.repository.outlaw_repository.OutlawRepository</em>, <em class="sig-param">gang_repository: thesheriff.domain.gang.repository.gang_repository.GangRepository</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.outlaw.join_gang.JoinGang" title="Permalink to this definition">¶</a></dt>
@@ -261,34 +303,6 @@ <h2>Outlaw<a class="headerlink" href="#outlaw" title="Permalink to this headline
 
 </dd></dl>
 
-<span class="target" id="module-thesheriff.application.outlaw.invite_friend"><span id="invite-friend"></span></span><dl class="class">
-<dt id="thesheriff.application.outlaw.invite_friend.InviteFriend">
-<em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.outlaw.invite_friend.</code><code class="sig-name descname">InviteFriend</code><span class="sig-paren">(</span><em class="sig-param">mail_notifier: thesheriff.domain.mail.notifier.mail_notifier.MailNotifier</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.outlaw.invite_friend.InviteFriend" title="Permalink to this definition">¶</a></dt>
-<dd><p>Class InviteFriend implements the invite a friend use case.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>mail_notifier</strong> (<em>MailNotifier</em>) – Repository managing the Gang domain entities.</p>
-</dd>
-</dl>
-<dl class="method">
-<dt id="thesheriff.application.outlaw.invite_friend.InviteFriend.execute">
-<code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">receiver_mail_address</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.outlaw.invite_friend.InviteFriend.execute" title="Permalink to this definition">¶</a></dt>
-<dd><p>execute is the actual action of the Invite Friend use case.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>receiver_mail_address</strong> (<em>String</em>) – The address to write on the TO field.</p>
-</dd>
-<dt class="field-even">Returns</dt>
-<dd class="field-even"><p>No value returned.</p>
-</dd>
-<dt class="field-odd">Return type</dt>
-<dd class="field-odd"><p>NoReturn</p>
-</dd>
-</dl>
-</dd></dl>
-
-</dd></dl>
-
 <span class="target" id="module-thesheriff.application.outlaw.request.create_outlaw_request"><span id="create-outlaw-request"></span></span><dl class="class">
 <dt id="thesheriff.application.outlaw.request.create_outlaw_request.CreateOutlawRequest">
 <em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.outlaw.request.create_outlaw_request.</code><code class="sig-name descname">CreateOutlawRequest</code><span class="sig-paren">(</span><em class="sig-param">name: str</em>, <em class="sig-param">email: str</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.outlaw.request.create_outlaw_request.CreateOutlawRequest" title="Permalink to this definition">¶</a></dt>
@@ -365,6 +379,24 @@ <h2>Raid<a class="headerlink" href="#raid" title="Permalink to this headline">¶
 
 </dd></dl>
 
+<span class="target" id="module-thesheriff.application.raid.request.create_raid_request"><span id="create-raid-request"></span></span><dl class="class">
+<dt id="thesheriff.application.raid.request.create_raid_request.CreateRaidRequest">
+<em class="property">class </em><code class="sig-prename descclassname">thesheriff.application.raid.request.create_raid_request.</code><code class="sig-name descname">CreateRaidRequest</code><span class="sig-paren">(</span><em class="sig-param">name: str, date: datetime.datetime, location: str, gang_id: int, sheriff_id: int, outlaw_ids: List[int]</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.raid.request.create_raid_request.CreateRaidRequest" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class CreateOutlawRequest holds data required to create an Outlaw.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<em>String</em>) – Outlaw’s given name.</p></li>
+<li><p><strong>date</strong> (<em>datetime.datetime</em>) – Date and time for the Raid.</p></li>
+<li><p><strong>location</strong> (<em>String</em>) – Location of the Raid.</p></li>
+<li><p><strong>gang_id</strong> (<em>Integer</em>) – Id of the Gang where the Raid is being organized.</p></li>
+<li><p><strong>sheriff_id</strong> (<em>Integer</em>) – Id of the Sheriff organizing the Raid.</p></li>
+<li><p><strong>outlaw_ids</strong> (<em>List</em><em>[</em><em>Integer</em><em>]</em>) – List of Outlaw Ids invited to the Raid.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 </div>
 </div>
 

diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html
@@ -87,10 +87,14 @@ <h2 id="C">C</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="application.html#thesheriff.application.outlaw.create_gang.CreateGang">CreateGang (class in thesheriff.application.outlaw.create_gang)</a>
+</li>
+      <li><a href="application.html#thesheriff.application.gang.request.create_gang_request.CreateGangRequest">CreateGangRequest (class in thesheriff.application.gang.request.create_gang_request)</a>
 </li>
       <li><a href="application.html#thesheriff.application.outlaw.create_outlaw.CreateOutlaw">CreateOutlaw (class in thesheriff.application.outlaw.create_outlaw)</a>
 </li>
       <li><a href="application.html#thesheriff.application.outlaw.request.create_outlaw_request.CreateOutlawRequest">CreateOutlawRequest (class in thesheriff.application.outlaw.request.create_outlaw_request)</a>
+</li>
+      <li><a href="application.html#thesheriff.application.raid.request.create_raid_request.CreateRaidRequest">CreateRaidRequest (class in thesheriff.application.raid.request.create_raid_request)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -255,6 +259,8 @@ <h2 id="T">T</h2>
       <li><a href="application.html#module-thesheriff.application">thesheriff.application (module)</a>
 </li>
       <li><a href="application.html#module-thesheriff.application.gang.list_gangs">thesheriff.application.gang.list_gangs (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.gang.request.create_gang_request">thesheriff.application.gang.request.create_gang_request (module)</a>
 </li>
       <li><a href="application.html#module-thesheriff.application.gang.request.join_gang_request">thesheriff.application.gang.request.join_gang_request (module)</a>
 </li>
@@ -278,12 +284,14 @@ <h2 id="T">T</h2>
 </li>
       <li><a href="application.html#module-thesheriff.application.raid.grade_raid">thesheriff.application.raid.grade_raid (module)</a>
 </li>
-      <li><a href="domain.html#module-thesheriff.domain">thesheriff.domain (module)</a>
+      <li><a href="application.html#module-thesheriff.application.raid.request.create_raid_request">thesheriff.application.raid.request.create_raid_request (module)</a>
 </li>
-      <li><a href="domain.html#module-thesheriff.domain.gang.gang">thesheriff.domain.gang.gang (module)</a>
+      <li><a href="domain.html#module-thesheriff.domain">thesheriff.domain (module)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#module-thesheriff.domain.gang.gang">thesheriff.domain.gang.gang (module)</a>
+</li>
       <li><a href="domain.html#module-thesheriff.domain.gang.gang_factory">thesheriff.domain.gang.gang_factory (module)</a>
 </li>
       <li><a href="domain.html#module-thesheriff.domain.gang.repository.gang_repository">thesheriff.domain.gang.repository.gang_repository (module)</a>

diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv
diff --git a/doc/build/html/py-modindex.html b/doc/build/html/py-modindex.html
@@ -60,6 +60,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="application.html#module-thesheriff.application.gang.list_gangs"><code class="xref">thesheriff.application.gang.list_gangs</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="application.html#module-thesheriff.application.gang.request.create_gang_request"><code class="xref">thesheriff.application.gang.request.create_gang_request</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -115,6 +120,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="application.html#module-thesheriff.application.raid.grade_raid"><code class="xref">thesheriff.application.raid.grade_raid</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="application.html#module-thesheriff.application.raid.request.create_raid_request"><code class="xref">thesheriff.application.raid.request.create_raid_request</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;