Merge pull request #499 from interlegis/497-encapsulamento-das-apps

Fix #497 Encaps apps secundárias dentro app sapl

MANIFEST.in

@@ -0,0 +1,6 @@
+include README.rst LICENSE.txt
+recursive-include sapl *.html *.yaml
+recursive-include sapl/static *
+recursive-include sapl/relatorios/templates *.py
+global-exclude __pycache__
+global-exclude *.py[co]

README.rst

@@ -244,10 +244,20 @@ Boas Práticas
   - Execute ``./manage.py check``
   - Execute todos os testes com ``py.test`` na pasta raiz do projeto
 
-* Em caso de Implementação de modelo que envolva a classe from django.contrib.auth.models.User, não a use diretamente, use para isso a função get_user_model() de sapl.utils. Exemplo:
+* Em caso de Implementação de modelo que envolva a classe ``django.contrib.auth.models.User``, não a use diretamente, use para isso a função ``get_settings_auth_user_model()`` de ``sapl.utils``. Exemplo:
 
   - no lugar de ``owner = models.ForeignKey(User, ... )``  
-  - use ``owner = models.ForeignKey(get_user_model(), ... )``
+  - use ``owner = models.ForeignKey(get_settings_auth_user_model(), ... )``  
+
+  - Não use em qualquer modelagem futura, ``ForeignKey`` com ``User`` ou mesmo ``settings.AUTH_USER_MODEL`` sem o import correto que não é o do projeto e sim o que está em ``sapl.utils``, ou seja (``from django.conf import settings``)
+
+    - em https://docs.djangoproject.com/en/1.9/topics/auth/customizing/#referencing-the-user-model é explicado por que ser dessa forma!  
+
+  - Já em qualquer uso em implementação de execução, ao fazer uma query, por exemplo:
+
+    - não use ``django.contrib.auth.models.User`` para utilizar as caracteristicas do model, para isso, use esta função: django.contrib.auth.get_user_model()
+
+  - Seguir esses passos simplificará qualquer customização futura que venha a ser feita na autenticação do usuários ao evitar correções de inúmeros import's e ainda, desta forma, torna a funcionalidade de autenticação reimplementável por qualquer outro projeto que venha usar partes ou o todo do SAPL.     
 
 Atenção:
 

base/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'base.apps.AppConfig'

comissoes/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'comissoes.apps.AppConfig'

lexml/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'lexml.apps.AppConfig'

materia/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'materia.apps.AppConfig'

norma/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'norma.apps.AppConfig'

painel/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'painel.apps.AppConfig'

parlamentares/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'parlamentares.apps.AppConfig'

protocoloadm/__init__.py

@@ -1 +0,0 @@
-default_app_config = 'protocoloadm.apps.AppConfig'

sapl/base/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'sapl.base.apps.AppConfig'

base/admin.py → sapl/base/admin.py

@@ -1,7 +1,7 @@
 from django.contrib import admin
 from django.core.urlresolvers import reverse
 
-from base.models import ProblemaMigracao
+from sapl.base.models import ProblemaMigracao
 from sapl.utils import register_all_models_in_admin
 
 register_all_models_in_admin(__name__)

base/apps.py → sapl/base/apps.py

@@ -3,5 +3,6 @@ from django.utils.translation import ugettext_lazy as _
 
 
 class AppConfig(apps.AppConfig):
-    name = 'base'
+    name = 'sapl.base'
+    label = 'base'
     verbose_name = _('Dados Básicos')

base/forms.py → sapl/base/forms.py

@@ -3,8 +3,8 @@ from django.contrib.auth.forms import AuthenticationForm
 from django.core.exceptions import ValidationError
 from django.forms import ModelForm
 
-import sapl
 from sapl.settings import MAX_IMAGE_UPLOAD_SIZE
+from sapl.utils import ImageThumbnailFileInput
 
 from .models import CasaLegislativa
 
@@ -33,7 +33,7 @@ class CasaLegislativaForm(ModelForm):
             'cep': forms.TextInput(attrs={'class': 'cep'}),
             'telefone': forms.TextInput(attrs={'class': 'telefone'}),
             'fax': forms.TextInput(attrs={'class': 'telefone'}),
-            'logotipo': sapl.utils.ImageThumbnailFileInput,
+            'logotipo':  ImageThumbnailFileInput,
             'informacao_geral': forms.Textarea(
                 attrs={'id': 'texto-rico'})
         }
@@ -47,11 +47,13 @@ class CasaLegislativaForm(ModelForm):
 
 
 class LoginForm(AuthenticationForm):
-    username = forms.CharField(label="Username", max_length=30,
+    username = forms.CharField(
+        label="Username", max_length=30,
         widget=forms.TextInput(
             attrs={
                 'class': 'form-control', 'name': 'username'}))
-    password = forms.CharField(label="Password", max_length=30,
+    password = forms.CharField(
+        label="Password", max_length=30,
         widget=forms.PasswordInput(
             attrs={
                 'class': 'form-control', 'name': 'password'}))

base/migrations/0003_auto_20160107_1122.py → sapl/base/migrations/0003_auto_20160107_1122.py

@@ -2,7 +2,7 @@
 from __future__ import unicode_literals
 
 from django.db import migrations, models
-import base.models
+import sapl.base.models
 
 
 class Migration(migrations.Migration):
@@ -15,6 +15,7 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='casalegislativa',
             name='logotipo',
-            field=models.FileField(null=True, upload_to=base.models.get_casa_media_path, verbose_name='Logotipo', blank=True),
+            field=models.FileField(
+                null=True, upload_to=sapl.base.models.get_casa_media_path, verbose_name='Logotipo', blank=True),
         ),
     ]

base/migrations/0007_auto_20160107_1837.py → sapl/base/migrations/0007_auto_20160107_1837.py

@@ -2,7 +2,7 @@
 from __future__ import unicode_literals
 
 from django.db import models, migrations
-import base.models
+import sapl.base.models
 
 
 class Migration(migrations.Migration):
@@ -15,11 +15,13 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='casalegislativa',
             name='informacao_geral',
-            field=models.CharField(blank=True, max_length=100, verbose_name='Informação Geral', null=True),
+            field=models.CharField(
+                blank=True, max_length=100, verbose_name='Informação Geral', null=True),
         ),
         migrations.AlterField(
             model_name='casalegislativa',
             name='logotipo',
-            field=models.ImageField(blank=True, upload_to=base.models.get_casa_media_path, verbose_name='Logotipo', null=True),
+            field=models.ImageField(
+                blank=True, upload_to=sapl.base.models.get_casa_media_path, verbose_name='Logotipo', null=True),
         ),
     ]

base/migrations/0008_auto_20160216_1015.py → sapl/base/migrations/0008_auto_20160216_1015.py

@@ -1,10 +1,12 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import models, migrations
 import datetime
+
+from django.db import models, migrations
 from django.utils.timezone import utc
-import base.models
+
+import sapl.base.models
 
 
 class Migration(migrations.Migration):
@@ -17,32 +19,38 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='casalegislativa',
             name='email',
-            field=models.CharField(verbose_name='E-mail', max_length=100, default=datetime.datetime(2016, 2, 16, 12, 15, 30, 241941, tzinfo=utc), blank=True),
+            field=models.CharField(verbose_name='E-mail', max_length=100, default=datetime.datetime(
+                2016, 2, 16, 12, 15, 30, 241941, tzinfo=utc), blank=True),
             preserve_default=False,
         ),
         migrations.AlterField(
             model_name='casalegislativa',
             name='endereco_web',
-            field=models.CharField(verbose_name='HomePage', max_length=100, blank=True),
+            field=models.CharField(
+                verbose_name='HomePage', max_length=100, blank=True),
         ),
         migrations.AlterField(
             model_name='casalegislativa',
             name='fax',
-            field=models.CharField(verbose_name='Fax', max_length=100, blank=True),
+            field=models.CharField(
+                verbose_name='Fax', max_length=100, blank=True),
         ),
         migrations.AlterField(
             model_name='casalegislativa',
             name='informacao_geral',
-            field=models.CharField(verbose_name='Informação Geral', max_length=100, blank=True),
+            field=models.CharField(
+                verbose_name='Informação Geral', max_length=100, blank=True),
         ),
         migrations.AlterField(
             model_name='casalegislativa',
             name='logotipo',
-            field=models.ImageField(verbose_name='Logotipo', upload_to=base.models.get_casa_media_path, blank=True),
+            field=models.ImageField(
+                verbose_name='Logotipo', upload_to=sapl.base.models.get_casa_media_path, blank=True),
         ),
         migrations.AlterField(
             model_name='casalegislativa',
             name='telefone',
-            field=models.CharField(verbose_name='Telefone', max_length=100, blank=True),
+            field=models.CharField(
+                verbose_name='Telefone', max_length=100, blank=True),
         ),
     ]

base/models.py → sapl/base/models.py

@@ -7,7 +7,7 @@ from sapl.utils import UF
 
 
 def get_sessao_media_path(instance, subpath, filename):
-    return './casa/%s/%s' % (subpath, filename)
+    return './sapl/casa/%s/%s' % (subpath, filename)
 
 
 def get_casa_media_path(instance, filename):

base/templatetags/menus.py → sapl/base/templatetags/menus.py

@@ -1,13 +1,11 @@
 import os
 
-import yaml
 from django import template
 from django.core.urlresolvers import reverse
+import yaml
 
-from sapl.settings import BASE_DIR
 
 register = template.Library()
-TEMPLATES_DIR = BASE_DIR.child("templates")
 
 
 @register.inclusion_tag('menus/subnav.html', takes_context=True)
@@ -24,32 +22,34 @@ def subnav(context, path=None):
         obj = context.get('object', None)
         if obj:
             root_pk = obj.pk
+
     if root_pk:
         request = context['request']
-        app = request.resolver_match.app_name
-        # Esse IF elimina o bug que ocorria nas Tabelas Auxiliares
-        # Algumas recebiam a nav-bar de seu app gerada pelo APP CRUD
-        # Essa nav-bar é indesejada nesses casos
-        # A solução encontrada foi verificar se havia 'sistema' na URL
-        # ou se o nome do app estava presente na URL
-        # Para essa Solução haviam duas exceções, pois o nome base das URLs
-        # de comissões e parlamentares são diferentes do nome do app
-        # Deve-se cuidar para que o nome base das URLs sejam
-        # iguais ao nome do app Ex: app = 'parlamentares' e
-        # url = 'parlamentares/...'
 
-        if (request.path.find('parlamentar') != -1 and
+        if 'sistema' in request.path:
-           app == 'parlamentares' or
-           request.path.find('comissao') != -1 and app == 'comissoes'):
-            pass
-        elif (request.path.find(app) == -1 or
-              request.path.find('sistema') != -1):
             return
-        default_path = '%s/subnav.yaml' % app
+
-        path = os.path.join(TEMPLATES_DIR, path or default_path)
+        app = request.resolver_match.app_name
-        if os.path.exists(path):
+        app_template = app.split('.')
-            menu = yaml.load(open(path, 'r'))
+        app_template = app_template[1] if app_template[
+            0] == 'sapl' and len(app_template) > 1 else app_template[0]
+
+        yaml_path = '%s/subnav.yaml' % app_template
+
+        try:
+            """ Por padrão, são carragados dois Loaders,  
+            filesystem.Loader - busca em TEMPLATES_DIRS do projeto atual
+            app_directories.Loader - busca em todas apps instaladas
+            A função abaixo é nativa e busca em todos os Loaders Configurados.
+            """
+            yaml_template = template.loader.get_template(yaml_path)
+            menu = yaml.load(open(yaml_template.origin.name, 'r'))
             resolve_urls_inplace(menu, root_pk, app)
+        except:
+            # um erro será lançado por get_template se não for encontrado
+            # yaml_path em nenhum de locais registrados.
+            pass
+
     return {'menu': menu}
 
 

base/tests/test_login.py → sapl/base/tests/test_login.py

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
+from django.contrib.auth import get_user_model
 import pytest
-from django.contrib.auth.models import User
+
 
 pytestmark = pytest.mark.django_db
 
 
 @pytest.fixture
 def user():
-    return User.objects.create_user('jfirmino', password='123')
+    return get_user_model().objects.create_user('jfirmino', password='123')
 
 
 def test_login_aparece_na_barra_para_usuario_nao_logado(client):
@@ -35,7 +36,7 @@ def test_nome_completo_do_usuario_logado_aparece_na_barra(client, user):
     assert '<a href="/logout/">Sair</a>' in str(response.content)
 
 
-@pytest.mark.urls('base.tests.teststub_urls')
+@pytest.mark.urls('sapl.base.tests.teststub_urls')
 @pytest.mark.parametrize("link_login,destino", [
     # login redireciona para home
     ('/login/', '/'),

base/views.py → sapl/base/views.py

@@ -1,7 +1,6 @@
 from django.views.generic.base import TemplateView
 
-import crud.base
+from sapl.crud.base import Crud, CrudBaseMixin, CrudCreateView, CrudUpdateView
-from crud.base import Crud
 
 from .forms import CasaLegislativaForm
 from .models import CasaLegislativa
@@ -15,13 +14,13 @@ class CasaLegislativaCrud(Crud):
     model = CasaLegislativa
     help_path = ''
 
-    class BaseMixin(crud.base.CrudBaseMixin):
+    class BaseMixin(CrudBaseMixin):
         list_field_names = ['codigo', 'nome', 'sigla']
 
-    class CreateView(crud.base.CrudCreateView):
+    class CreateView(CrudCreateView):
         form_class = CasaLegislativaForm
 
-    class UpdateView(crud.base.CrudUpdateView):
+    class UpdateView(CrudUpdateView):
         form_class = CasaLegislativaForm
 
 

sapl/comissoes/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'sapl.comissoes.apps.AppConfig'

comissoes/apps.py → sapl/comissoes/apps.py

@@ -3,5 +3,6 @@ from django.utils.translation import ugettext_lazy as _
 
 
 class AppConfig(apps.AppConfig):
-    name = 'comissoes'
+    name = 'sapl.comissoes'
+    label = 'comissoes'
     verbose_name = _('Comissões')

comissoes/models.py → sapl/comissoes/models.py

@@ -2,7 +2,7 @@ from django.db import models
 from django.utils.translation import ugettext_lazy as _
 from model_utils import Choices
 
-from parlamentares.models import Parlamentar
+from sapl.parlamentares.models import Parlamentar
 from sapl.utils import YES_NO_CHOICES
 
 

comissoes/tests/test_comissoes.py → sapl/comissoes/tests/test_comissoes.py

@@ -2,8 +2,8 @@ import pytest
 from django.core.urlresolvers import reverse
 from model_mommy import mommy
 
-from comissoes.models import Comissao, Composicao, Periodo, TipoComissao
+from sapl.comissoes.models import Comissao, Composicao, Periodo, TipoComissao
-from parlamentares.models import Filiacao, Parlamentar, Partido
+from sapl.parlamentares.models import Filiacao, Parlamentar, Partido
 
 
 def make_composicao(comissao):
@@ -48,7 +48,7 @@ def test_incluir_parlamentar_errors(client):
     comissao = make_comissao()
     composicao = make_composicao(comissao)
 
-    response = client.post(reverse('comissoes:participacao_create',
+    response = client.post(reverse('sapl.comissoes:participacao_create',
                                    kwargs={'pk': composicao.pk}),
                            {'salvar': 'salvar'},
                            follow=True)
@@ -67,7 +67,7 @@ def test_incluir_comissao_submit(client):
                       sigla='T',
                       nome='Teste')
 
-    response = client.post(reverse('comissoes:comissao_create'),
+    response = client.post(reverse('sapl.comissoes:comissao_create'),
                            {'tipo': tipo.pk,
                             'nome': 'Comissão Teste',
                             'sigla': 'CT',
@@ -84,7 +84,7 @@ def test_incluir_comissao_submit(client):
 @pytest.mark.django_db(transaction=False)
 def test_incluir_comissao_errors(client):
 
-    response = client.post(reverse('comissoes:comissao_create'),
+    response = client.post(reverse('sapl.comissoes:comissao_create'),
                            {'salvar': 'salvar'},
                            follow=True)
 

comissoes/urls.py → sapl/comissoes/urls.py

@@ -1,6 +1,6 @@
 from django.conf.urls import include, url
 
-from comissoes.views import (CargoCrud, ComissaoCrud, ComposicaoCrud,
+from sapl.comissoes.views import (CargoCrud, ComissaoCrud, ComposicaoCrud,
                                   MateriasTramitacaoListView, ParticipacaoCrud,
                                   PeriodoComposicaoCrud, TipoComissaoCrud)
 

comissoes/views.py → sapl/comissoes/views.py

@@ -1,11 +1,9 @@
 from django.core.urlresolvers import reverse
 from django.views.generic import ListView
 
-import crud.base
+from sapl.crud.base import Crud, CrudBaseMixin
-import crud.masterdetail
+from sapl.crud.masterdetail import MasterDetailCrud
-from crud.base import Crud
+from sapl.materia.models import Tramitacao
-from crud.masterdetail import MasterDetailCrud
-from materia.models import Tramitacao
 
 from .models import (CargoComissao, Comissao, Composicao, Participacao,
                      Periodo, TipoComissao)
@@ -18,7 +16,7 @@ TipoComissaoCrud = Crud.build(TipoComissao, 'tipo_comissao')
 def pegar_url_composicao(pk):
     participacao = Participacao.objects.get(id=pk)
     comp_pk = participacao.composicao.pk
-    url = reverse('comissoes:composicao_detail', kwargs={'pk': comp_pk})
+    url = reverse('sapl.comissoes:composicao_detail', kwargs={'pk': comp_pk})
     return url
 
 
@@ -39,12 +37,14 @@ class ParticipacaoCrud(MasterDetailCrud):
 
         def get_success_url(self):
             return reverse(
-                'comissoes:composicao_detail', kwargs={'pk': self.kwargs['pk']}
+                'sapl.comissoes:composicao_detail',
+                kwargs={'pk': self.kwargs['pk']}
             )
 
         def cancel_url(self):
             return reverse(
-                'comissoes:composicao_detail', kwargs={'pk': self.kwargs['pk']}
+                'sapl.comissoes:composicao_detail',
+                kwargs={'pk': self.kwargs['pk']}
             )
 
     class UpdateView(MasterDetailCrud.UpdateView):
@@ -83,7 +83,7 @@ class ComissaoCrud(Crud):
     model = Comissao
     help_path = 'modulo_comissoes'
 
-    class BaseMixin(crud.base.CrudBaseMixin):
+    class BaseMixin(CrudBaseMixin):
         list_field_names = ['nome', 'sigla', 'tipo', 'data_criacao']
 
 

sapl/compilacao/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'sapl.compilacao.apps.AppConfig'

compilacao/apps.py → sapl/compilacao/apps.py

@@ -3,5 +3,6 @@ from django.utils.translation import ugettext_lazy as _
 
 
 class AppConfig(apps.AppConfig):
-    name = 'compilacao'
+    name = 'sapl.compilacao'
+    label = 'compilacao'
     verbose_name = _('Compilação')

compilacao/forms.py → sapl/compilacao/forms.py

@@ -13,14 +13,15 @@ from django.forms.models import ModelForm
 from django.template import defaultfilters
 from django.utils.translation import ugettext_lazy as _
 
-from compilacao.models import (NOTAS_PUBLICIDADE_CHOICES,
-                               PARTICIPACAO_SOCIAL_CHOICES, Dispositivo, Nota,
-                               Publicacao, TextoArticulado, TipoDispositivo,
-                               TipoNota, TipoPublicacao, TipoTextoArticulado,
-                               TipoVide, VeiculoPublicacao, Vide)
-from compilacao.utils import DISPOSITIVO_SELECT_RELATED
-from crispy_layout_mixin import SaplFormLayout, to_column, to_row
 from sapl import utils
+from sapl.compilacao.models import (NOTAS_PUBLICIDADE_CHOICES,
+                                    PARTICIPACAO_SOCIAL_CHOICES, Dispositivo,
+                                    Nota, Publicacao, TextoArticulado,
+                                    TipoDispositivo, TipoNota, TipoPublicacao,
+                                    TipoTextoArticulado, TipoVide,
+                                    VeiculoPublicacao, Vide)
+from sapl.compilacao.utils import DISPOSITIVO_SELECT_RELATED
+from sapl.crispy_layout_mixin import SaplFormLayout, to_column, to_row
 from sapl.utils import YES_NO_CHOICES
 
 error_messages = {