Refactor example miniapps - services_v1, services_v2

ets-labs · Jun 27, 2018 · 96b4400 · 96b4400
1 parent 32a8052
commit 96b4400
Show file tree

Hide file tree

Showing 19 changed files with 203 additions and 268 deletions.
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -16,6 +16,7 @@ and powered by *Dependency Injector* framework.
     :maxdepth: 2
 
     movie_lister
-    services_miniapp
+    services_miniapp_v1
+    services_miniapp_v2
     bundles_miniapp
     use_cases_miniapp
diff --git a/docs/examples/services_miniapp.rst → docs/examples/services_miniapp_v1.rst b/docs/examples/services_miniapp.rst → docs/examples/services_miniapp_v1.rst
@@ -1,13 +1,14 @@
-Services mini application example
----------------------------------
+Services mini application example (v1 - multiple containers)
+------------------------------------------------------------
 
 .. meta::
    :description: "Services miniapp" is an example mini application that 
                  consists from several services that have dependencies on 
                  some standard and 3rd-party libraries for logging, 
                  interaction with database and remote service via API. 
                  "Services miniapp" example demonstrates usage of 
-                 Dependency Injector for creating several IoC containers.
+                 Dependency Injector for creating several inversion of control /
+                 dependency injection containers.
 
 "Services miniapp" is an example mini application that consists from several 
 services that have dependencies on some standard and 3rd-party libraries for 
@@ -44,13 +45,13 @@ Example application structure:
 
 Listing of ``example/services.py``:
 
-.. literalinclude:: ../../examples/miniapps/services/example/services.py
+.. literalinclude:: ../../examples/miniapps/services_v1/example/services.py
    :language: python
    :linenos:
 
 Listing of ``example/main.py``:
 
-.. literalinclude:: ../../examples/miniapps/services/example/main.py
+.. literalinclude:: ../../examples/miniapps/services_v1/example/main.py
    :language: python
    :linenos:
 
@@ -59,7 +60,7 @@ IoC containers
 
 Listing of ``containers.py``:
 
-.. literalinclude:: ../../examples/miniapps/services/containers.py
+.. literalinclude:: ../../examples/miniapps/services_v1/containers.py
    :language: python
    :linenos:
 
@@ -68,7 +69,7 @@ Run application
 
 Listing of ``run.py``:
 
-.. literalinclude:: ../../examples/miniapps/services/run.py
+.. literalinclude:: ../../examples/miniapps/services_v1/run.py
    :language: python
    :linenos:
 

diff --git a/docs/examples/services_miniapp_v2.rst b/docs/examples/services_miniapp_v2.rst
@@ -0,0 +1,77 @@
+Services mini application example (v2 - single container)
+---------------------------------------------------------
+
+.. meta::
+   :description: "Services miniapp" is an example mini application that 
+                 consists from several services that have dependencies on 
+                 some standard and 3rd-party libraries for logging, 
+                 interaction with database and remote service via API. 
+                 "Services miniapp" example demonstrates usage of 
+                 Dependency Injector for creating inversion of control /
+                 dependency injection container.
+
+"Services miniapp" is an example mini application that consists from several 
+services that have dependencies on some standard and 3rd-party libraries for 
+logging, interaction with database and remote service calls via API.
+
+"Services miniapp" example demonstrates usage of 
+:doc:`Dependency Injector <../index>` for creating IoC container.
+
+Instructions for running:
+
+.. code-block:: bash
+
+    python run.py 1 secret photo.jpg
+
+Example application
+~~~~~~~~~~~~~~~~~~~
+
+Classes diagram:
+
+.. image:: /images/miniapps/services/classes.png
+    :width: 100%
+    :align: center
+
+
+Example application structure:
+
+.. code-block:: bash
+
+    /example
+        /__init__.py
+        /main.py
+        /services.py
+
+
+Listing of ``example/services.py``:
+
+.. literalinclude:: ../../examples/miniapps/services_v2/example/services.py
+   :language: python
+   :linenos:
+
+Listing of ``example/main.py``:
+
+.. literalinclude:: ../../examples/miniapps/services_v2/example/main.py
+   :language: python
+   :linenos:
+
+IoC container
+~~~~~~~~~~~~~
+
+Listing of ``container.py``:
+
+.. literalinclude:: ../../examples/miniapps/services_v2/container.py
+   :language: python
+   :linenos:
+
+Run application
+~~~~~~~~~~~~~~~
+
+Listing of ``run.py``:
+
+.. literalinclude:: ../../examples/miniapps/services_v2/run.py
+   :language: python
+   :linenos:
+
+
+.. disqus::
diff --git a/examples/miniapps/ioc_container/example/main.py b/examples/miniapps/ioc_container/example/main.py
diff --git a/examples/miniapps/ioc_container/example/services.py b/examples/miniapps/ioc_container/example/services.py
diff --git a/examples/miniapps/services/example/main.py b/examples/miniapps/services/example/main.py