chore(refactor): Remove arrow dependency from the project #7022

mansiag · 2020-05-20T18:08:55Z

Fixes #6927

Short description of what this resolves:

Removes arrow dependency from the project by using pytz and humanize libraries for the same functionality

Checklist

I have read the Contribution & Best practices Guide and my PR follows them.
My branch is up-to-date with the Upstream development branch.
The unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)

All the functions created/modified in this PR contain relevant docstrings.

houndci-bot · 2020-05-20T18:09:36Z

tests/all/integration/api/helpers/test_humanize_helper.py

+                                        - datetime.timedelta(days=10))
+            actual_response = humanize_helper(test_order.created_at)
+            expected_response = '10 days ago'
+            self.assertEqual(actual_response, expected_response)


no newline at end of file

houndci-bot · 2020-05-20T18:09:37Z

tests/all/integration/api/helpers/test_humanize_helper.py

+
+        with self.app.test_request_context():
+            test_order = OrderFactory(created_at=datetime.datetime.now() 
+                                        - datetime.timedelta(days=10))


continuation line over-indented for visual indent

houndci-bot · 2020-05-20T18:09:37Z

tests/all/integration/api/helpers/test_humanize_helper.py

+        """Method to test humanization of order creation time"""
+
+        with self.app.test_request_context():
+            test_order = OrderFactory(created_at=datetime.datetime.now() 


trailing whitespace

houndci-bot · 2020-05-20T18:09:37Z

tests/all/integration/api/helpers/test_humanize_helper.py

+from tests.factories.order import OrderFactory
+
+
+class TestHumanizeHelper(OpenEventTestCase): 


Black would make changes.
trailing whitespace
undefined name 'OpenEventTestCase'

houndci-bot · 2020-05-20T18:09:38Z

app/templates/flask_ext/jinja/filters.py

@@ -20,5 +21,4 @@ def simple_datetime_display(date):
    def humanize_filter(time):
        if not time:
            return "N/A"
-        # TODO(Areeb): Only usage of arrow. Remove
-        return arrow.get(time).humanize()
+        return humanize_helper(time)


no newline at end of file

houndci-bot · 2020-05-20T18:09:38Z

app/api/helpers/humanize_helper.py

+    """Returns time passed from now in a human readable duration"""
+
+    return humanize.naturaldelta(datetime.now(pytz.utc) 
+                - time.astimezone(pytz.utc)) + ' ago'


continuation line under-indented for visual indent
no newline at end of file

houndci-bot · 2020-05-20T18:09:38Z

app/api/helpers/humanize_helper.py

+def humanize_helper(time):
+    """Returns time passed from now in a human readable duration"""
+
+    return humanize.naturaldelta(datetime.now(pytz.utc) 


Black would make changes.
trailing whitespace

iamareebjamal · 2020-05-20T18:23:56Z

tests/all/integration/api/helpers/test_humanize_helper.py

+from tests.factories.order import OrderFactory
+
+
+class TestHumanizeHelper(OpenEventTestCase): 


Please use new pytest style test

iamareebjamal · 2020-05-20T18:24:23Z

app/api/helpers/humanize_helper.py

+    """Returns time passed from now in a human readable duration"""
+
+    return humanize.naturaldelta(datetime.now(pytz.utc) 
+                - time.astimezone(pytz.utc)) + ' ago'


Humanize adds ago automatically

it adds ago with naturaltime, not with naturaldelta .

You can use naturaltime with timedelta

humanize.naturaltime(dt.timedelta(seconds=1001)) == 16 minutes ago

iamareebjamal · 2020-05-20T18:24:53Z

Remove arrow from requirements as well

houndci-bot · 2020-05-21T09:25:49Z

tests/all/integration/api/helpers/test_humanize_helper.py

+        created_at=datetime.datetime.now() - datetime.timedelta(days=10)
+    )
+    actual_response = humanize_helper(test_order.created_at)
+    expected_response = '10 days ago'


Black would make changes.

houndci-bot · 2020-05-21T09:25:49Z

app/templates/flask_ext/jinja/filters.py

-        # TODO(Areeb): Only usage of arrow. Remove
-        return arrow.get(time).humanize()
+        return humanize_helper(time)
+


blank line at end of file
blank line contains whitespace

codecov · 2020-05-21T09:32:39Z

Codecov Report

Merging #7022 into development will increase coverage by 0.00%.
The diff coverage is 87.50%.

@@             Coverage Diff              @@
##           development    #7022   +/-   ##
============================================
  Coverage        60.55%   60.55%           
============================================
  Files              260      259    -1     
  Lines            12877    12872    -5     
============================================
- Hits              7798     7795    -3     
+ Misses            5079     5077    -2

Impacted Files	Coverage Δ
app/templates/flask_ext/jinja/filters.py	`77.77% <87.50%> (+20.63%)`	⬆️
app/api/role_invites.py	`41.96% <0.00%> (-0.52%)`	⬇️
app/api/orders.py	`26.86% <0.00%> (-0.20%)`	⬇️
app/api/tax.py	`52.45% <0.00%> (ø)`
app/api/events.py	`21.70% <0.00%> (ø)`
app/api/tracks.py	`76.08% <0.00%> (ø)`
app/api/sessions.py	`41.46% <0.00%> (ø)`
app/api/speakers.py	`47.42% <0.00%> (ø)`
app/api/sponsors.py	`79.48% <0.00%> (ø)`
app/api/feedbacks.py	`50.64% <0.00%> (ø)`
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c7f7276...ca2ee7b. Read the comment docs.

iamareebjamal · 2020-05-21T11:52:52Z

app/templates/flask_ext/jinja/filters.py

+        return humanize_helper(time)
+


Suggested change

iamareebjamal · 2020-05-21T11:54:24Z

app/api/helpers/humanize_helper.py

+import pytz
+
+
+def humanize_helper(time):


No need to create a new file for it, add this function in filters.py

iamareebjamal · 2020-05-21T11:55:35Z

app/templates/flask_ext/jinja/filters.py

@@ -20,5 +21,5 @@ def simple_datetime_display(date):
    def humanize_filter(time):
        if not time:
            return "N/A"


You can move this logic to the function as well and add a test for it too

houndci-bot · 2020-05-21T17:09:32Z

tests/all/integration/api/helpers/test_humanize_helper.py

+    actual_response = humanize_helper(test_order.created_at)
+    expected_response = '10 days ago'
+    assert actual_response == expected_response
+


blank line contains whitespace

houndci-bot · 2020-05-21T17:09:32Z

app/templates/flask_ext/jinja/filters.py

-        # TODO(Areeb): Only usage of arrow. Remove
-        return arrow.get(time).humanize()
+        return humanize_helper(time)
+


blank line at end of file
blank line contains whitespace

houndci-bot · 2020-05-21T17:09:32Z

app/templates/flask_ext/jinja/filters.py

+    """Returns time passed from now in a human readable duration"""
+
+    if not time:
+            return "N/A"


Black would make changes.
over-indented

niranjan94 · 2020-05-21T17:37:20Z

Here is an overview of what got changed by this pull request:

Complexity increasing per file
==============================
- tests/all/integration/api/helpers/test_humanize_helper.py  3

See the complete overview on Codacy

mansiag added 2 commits May 20, 2020 23:09

refactor: remove arrow dependency

49f6fce

minor fix in coding style

17abde7

houndci-bot reviewed May 20, 2020

View reviewed changes

iamareebjamal reviewed May 20, 2020

View reviewed changes

Fix issues

e4290e4

houndci-bot reviewed May 21, 2020

View reviewed changes

mansiag added 2 commits May 21, 2020 15:13

Merge remote-tracking branch 'upstream/development' into remove-arrow

16d0296

Fix hound issue

c122c2b

iamareebjamal reviewed May 21, 2020

View reviewed changes

app/templates/flask_ext/jinja/filters.py Outdated

return humanize_helper(time)

Copy link

Member

iamareebjamal May 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

iamareebjamal reviewed May 21, 2020

View reviewed changes

make suggested changes

26f0c54

houndci-bot reviewed May 21, 2020

View reviewed changes

mansiag added 2 commits May 21, 2020 22:44

Fix hound issues

4e51df4

remove trailing whitespace

ca2ee7b

iamareebjamal approved these changes May 22, 2020

View reviewed changes

iamareebjamal changed the title ~~Remove arrow dependency from the project~~ chore(refactor): Remove arrow dependency from the project May 22, 2020

auto-label bot added chore refactor labels May 22, 2020

iamareebjamal merged commit 18a19fa into fossasia:development May 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(refactor): Remove arrow dependency from the project #7022

chore(refactor): Remove arrow dependency from the project #7022

mansiag commented May 20, 2020

houndci-bot May 20, 2020

houndci-bot May 20, 2020

houndci-bot May 20, 2020

houndci-bot May 20, 2020

houndci-bot May 20, 2020

houndci-bot May 20, 2020

houndci-bot May 20, 2020

iamareebjamal May 20, 2020

iamareebjamal May 20, 2020

mansiag May 20, 2020

iamareebjamal May 20, 2020

iamareebjamal commented May 20, 2020

houndci-bot May 21, 2020

houndci-bot May 21, 2020

codecov bot commented May 21, 2020 •

edited

Loading

iamareebjamal May 21, 2020

iamareebjamal May 21, 2020

iamareebjamal May 21, 2020

houndci-bot May 21, 2020

houndci-bot May 21, 2020

houndci-bot May 21, 2020

niranjan94 commented May 21, 2020

		from tests.factories.order import OrderFactory


		class TestHumanizeHelper(OpenEventTestCase):

chore(refactor): Remove arrow dependency from the project #7022

chore(refactor): Remove arrow dependency from the project #7022

Conversation

mansiag commented May 20, 2020

Short description of what this resolves:

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iamareebjamal commented May 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented May 21, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

niranjan94 commented May 21, 2020

codecov bot commented May 21, 2020 •

edited

Loading