Features/testing dry hack

[guyzmo]

just a simple illustration of #10.

it's not perfect: the name_id properties had to be changed to id and the hook_type had to be renamed type. That's not great regarding shadowing of globals, but it's ok because in usage they'll always be namespaced.

[guyzmo]

(I might not have time to finish this, but at least my goal was to give you some ideas about that, and open a discussion)

[ethantkoenig]

I'm intrigued, but could you rebase this onto master? It contains some changes (namely 6ae13ca) that are already on master.

[guyzmo]

ok, rebased and actually finished it.

[guyzmo]

I also updated the travis test to use pytest with a proper coverage report. Hope you'll like it!

[guyzmo]

collected 35 items

tests/http_utils_test.py ......
tests/interface_test.py .............................

----------- coverage: platform linux, python 3.6.1-final-0 -----------
Name                                        Stmts   Miss  Cover   Missing
-------------------------------------------------------------------------
gogs_client/__init__.py                         4      0   100%
gogs_client/_implementation/__init__.py         0      0   100%
gogs_client/_implementation/http_utils.py      26      1    96%   36
gogs_client/auth.py                            30      2    93%   20, 61
gogs_client/entities.py                        84      1    99%   12
gogs_client/interface.py                      202     22    89%   110, 231-242, 378, 410, 612-613, 620-6
21, 628-629, 636-637, 644-645, 679, 707, 710, 719
gogs_client/updates.py                         82      6    93%   68-69, 108-109, 151-152
-------------------------------------------------------------------------
TOTAL                                         428     32    93%

[guyzmo]

sorry for the build flood, but I had to make a bunch of minor adjustments to have it all work 👌 on travis 😉

[ethantkoenig]

Could we add a repo_id property to GogsRepo? I'm fine with having an id property, but I'd like to keep repo_id to maintain backwards compatibility. (similarly for everything else renamed from XYZ_id to id)

[guyzmo]

done 👌

[ethantkoenig]

Changes to .travis.yml should be a separate PR; from what I can tell this isn't related to the DRY refactor in any way.

[guyzmo]

done 👌

[guyzmo]

otherwise, how do you feel about this change?

[coveralls]

Coverage decreased (-1.3%) to 92.661% when pulling e955663 on guyzmo:features/testing_DRY_hack into aea8d9d on unfoldingWord-dev:master.

[ethantkoenig]

@guyzmo Unfornuately, the refactor messed up the docs (we autogenerate Sphinx documentation from docstrings). Essentially, we should be using comment of the form

#: Description
#:
#: :rtype: str

instead of docstrings for class attributes. Also, we need to update entities.rst to be like

.. autoclass:: gogs_client.entities::GogsUser()

    .. autoattribute:: id
        :annotation:

    .. autoattribute:: username
        :annotation:

    .. autoattribute:: email
        :annotation:

    .. autoattribute:: full_name
        :annotation:

    .. autoattribute:: avatar_url
        :annotation:

instead of

.. autoclass:: gogs_client.entities::GogsUser()
    :members:

I've started making these changes at 57f51cd. If you can finish it off, that would be great; otherwise I can finish sometime later this week.

[guyzmo]

so, I have took another path: keeping members and keep the documentation close to where the attribute is.

There's also an issue for attrs to generate ivar values appropriately python-attrs/attrs#104 for a class, so it does not build the awful Attribute(……………) crap!

As my current commit is, the only remaining issue is the repetition of the subclasses like GogsRepo.Urls etc.

[ethantkoenig]

+1 for the changes to conf.py, but why did you change the format of all the docstrings? I would prefer using :type: (had previously been using :rtype: but :type: probably makes more sense) instead of (as *int*)

[ethantkoenig]

I've manually merged e955663 and some extra changes I made into master, so I'm closing this PR.

[guyzmo]

👍 happy you liked the idea!