is_birthday should be is_anniversary

pendulum/date.py

@@ -196,9 +196,9 @@ def is_same_day(self, dt):
         """
         return self == dt
 
-    def is_birthday(self, dt=None):
+    def is_anniversary(self, dt=None):
         """
-        Check if its the birthday.
+        Check if its the anniversary.
 
         Compares the date/month values of the two dates.
 
@@ -207,10 +207,15 @@ def is_birthday(self, dt=None):
         if dt is None:
             dt = Date.today()
 
-        instance = dt1 = self.__class__(dt.year, dt.month, dt.day)
+        instance = self.__class__(dt.year, dt.month, dt.day)
 
         return (self.month, self.day) == (instance.month, instance.day)
 
+    # the additional method for checking if today is the anniversary day
+    # the alias is provided to start using a new name and keep the backward compatibility
+    # the old name can be completely replaced with the new in one of the future versions
+    is_birthday = is_anniversary
+
     # ADDITIONS AND SUBSTRACTIONS
 
     def add(self, years=0, months=0, weeks=0, days=0):

pendulum/datetime.py

@@ -571,9 +571,9 @@ def is_same_day(self, dt):
 
         return self.to_date_string() == dt.to_date_string()
 
-    def is_birthday(self, dt=None):
+    def is_anniversary(self, dt=None):
         """
-        Check if its the birthday.
+        Check if its the anniversary.
         Compares the date/month values of the two dates.
 
         :rtype: bool
@@ -585,6 +585,11 @@ def is_birthday(self, dt=None):
 
         return (self.month, self.day) == (instance.month, instance.day)
 
+    # the additional method for checking if today is the anniversary day
+    # the alias is provided to start using a new name and keep the backward compatibility
+    # the old name can be completely replaced with the new in one of the future versions
+    is_birthday = is_anniversary
+
     # ADDITIONS AND SUBSTRACTIONS
 
     def add(

tests/date/test_comparison.py

@@ -137,14 +137,30 @@ def test_less_than_or_equal_false():
     assert not d1 <= d3
 
 
-def test_is_birthday():
+def test_is_anniversary():
     d = pendulum.Date.today()
-    a_birthday = d.subtract(years=1)
-    assert a_birthday.is_birthday()
-    not_a_birthday = d.subtract(days=1)
-    assert not not_a_birthday.is_birthday()
-    also_not_a_birthday = d.add(days=2)
-    assert not also_not_a_birthday.is_birthday()
+    an_anniversary = d.subtract(years=1)
+    assert an_anniversary.is_anniversary()
+    not_an_anniversary = d.subtract(days=1)
+    assert not not_an_anniversary.is_anniversary()
+    also_not_an_anniversary = d.add(days=2)
+    assert not also_not_an_anniversary.is_anniversary()
+
+    d1 = pendulum.Date(1987, 4, 23)
+    d2 = pendulum.Date(2014, 9, 26)
+    d3 = pendulum.Date(2014, 4, 23)
+    assert not d2.is_anniversary(d1)
+    assert d3.is_anniversary(d1)
+
+
+def test_is_birthday():  # backward compatibility
+    d = pendulum.Date.today()
+    an_anniversary = d.subtract(years=1)
+    assert an_anniversary.is_birthday()
+    not_an_anniversary = d.subtract(days=1)
+    assert not not_an_anniversary.is_birthday()
+    also_not_an_anniversary = d.add(days=2)
+    assert not also_not_an_anniversary.is_birthday()
 
     d1 = pendulum.Date(1987, 4, 23)
     d2 = pendulum.Date(2014, 9, 26)

tests/datetime/test_comparison.py

@@ -237,15 +237,32 @@ def test_less_than_or_equal_with_timezone_false():
     assert not d1 <= d3
 
 
-def test_is_birthday():
+def test_is_anniversary():
     with pendulum.test(pendulum.now()):
         d = pendulum.now()
-        a_birthday = d.subtract(years=1)
-        assert a_birthday.is_birthday()
-        not_a_birthday = d.subtract(days=1)
-        assert not not_a_birthday.is_birthday()
-        also_not_a_birthday = d.add(days=2)
-        assert not also_not_a_birthday.is_birthday()
+        an_anniversary = d.subtract(years=1)
+        assert an_anniversary.is_anniversary()
+        not_an_anniversary = d.subtract(days=1)
+        assert not not_an_anniversary.is_anniversary()
+        also_not_an_anniversary = d.add(days=2)
+        assert not also_not_an_anniversary.is_anniversary()
+
+    d1 = pendulum.datetime(1987, 4, 23)
+    d2 = pendulum.datetime(2014, 9, 26)
+    d3 = pendulum.datetime(2014, 4, 23)
+    assert not d2.is_anniversary(d1)
+    assert d3.is_anniversary(d1)
+
+
+def test_is_birthday():  # backward compatibility
+    with pendulum.test(pendulum.now()):
+        d = pendulum.now()
+        an_anniversary = d.subtract(years=1)
+        assert an_anniversary.is_birthday()
+        not_an_anniversary = d.subtract(days=1)
+        assert not not_an_anniversary.is_birthday()
+        also_not_an_anniversary = d.add(days=2)
+        assert not also_not_an_anniversary.is_birthday()
 
     d1 = pendulum.datetime(1987, 4, 23)
     d2 = pendulum.datetime(2014, 9, 26)