Add calculations for number of months in a given year

fisharebest · Sep 17, 2018 · 7c7d340 · 7c7d340
1 parent fe3d1e2
commit 7c7d340
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 CHANGE LOG
 ==========
 
+## 2.5.0 (2018-09-17)
+ - Calculate number of months in a given year
+
 ## 2.4.0 (2018-01-15)
  - PHP error messages changed slightly in 7.2.0
 

diff --git a/src/ArabicCalendar.php b/src/ArabicCalendar.php
@@ -111,11 +111,14 @@ public function jdToYmd($julian_day)
     }
 
     /**
-     * Determine the number of months in a year.
+     * Determine the number of months in a year (if given),
+     * or the maximum number of months in any year.
+     *
+     * @param int|null $year
      *
      * @return int
      */
-    public function monthsInYear()
+    public function monthsInYear($year = null)
     {
         return 12;
     }

diff --git a/src/CalendarInterface.php b/src/CalendarInterface.php
@@ -81,11 +81,14 @@ public function jdStart();
     public function jdToYmd($julian_day);
 
     /**
-     * Determine the number of months in a year.
+     * Determine the number of months in a year (if given),
+     * or the maximum number of months in any year.
+     *
+     * @param int|null $year
      *
      * @return int
      */
-    public function monthsInYear();
+    public function monthsInYear($year = null);
 
     /**
      * Convert a year/month/day to a Julian day number.

diff --git a/src/FrenchCalendar.php b/src/FrenchCalendar.php
@@ -119,11 +119,14 @@ public function jdToYmd($julian_day)
     }
 
     /**
-     * Determine the number of months in a year.
+     * Determine the number of months in a year (if given),
+     * or the maximum number of months in any year.
+     *
+     * @param int|null $year
      *
      * @return int
      */
-    public function monthsInYear()
+    public function monthsInYear($year = null)
     {
         return 13;
     }

diff --git a/src/JewishCalendar.php b/src/JewishCalendar.php
@@ -298,12 +298,19 @@ public function jdToYmd($julian_day)
     }
 
     /**
-     * Determine the number of months in a year.
+     * Determine the number of months in a year (if given),
+     * or the maximum number of months in any year.
+     *
+     * @param int|null $year
      *
      * @return int
      */
-    public function monthsInYear()
+    public function monthsInYear($year = null)
     {
+        if ($year !== null && !$this->isLeapYear($year)) {
+            return 12;
+        }
+
         return 13;
     }
 

diff --git a/src/JulianCalendar.php b/src/JulianCalendar.php
@@ -130,11 +130,14 @@ public function jdToYmd($julian_day)
     }
 
     /**
-     * Determine the number of months in a year.
+     * Determine the number of months in a year (if given),
+     * or the maximum number of months in any year.
+     *
+     * @param int|null $year
      *
      * @return int
      */
-    public function monthsInYear()
+    public function monthsInYear($year = null)
     {
         return 12;
     }

diff --git a/src/PersianCalendar.php b/src/PersianCalendar.php
@@ -135,11 +135,14 @@ public function jdToYmd($julian_day)
     }
 
     /**
-     * Determine the number of months in a year.
+     * Determine the number of months in a year (if given),
+     * or the maximum number of months in any year.
+     *
+     * @param int|null $year
      *
      * @return int
      */
-    public function monthsInYear()
+    public function monthsInYear($year = null)
     {
         return 12;
     }

diff --git a/test/GregorianCalendarTest.php b/test/GregorianCalendarTest.php
@@ -258,7 +258,7 @@ public function testJdToYmdReciprocity()
      */
     public function testYmdToJdInvalidMonth()
     {
-        $calendar = new ArabicCalendar();
+        $calendar = new GregorianCalendar();
         $calendar->ymdToJd(4, 14, 1);
     }
 }
diff --git a/test/JewishCalendarTest.php b/test/JewishCalendarTest.php
@@ -52,7 +52,20 @@ public function testConstants()
         $this->assertSame(347998, $this->jewish->jdStart());
         $this->assertSame(PHP_INT_MAX, $this->jewish->jdEnd());
         $this->assertSame(7, $this->jewish->daysInWeek());
+    }
+
+    /**
+     * Test the leap year calculations.
+     *
+     * @covers \Fisharebest\ExtCalendar\JewishCalendar::monthsInYear
+     *
+     * @return void
+     */
+    public function testMonthsInYear()
+    {
         $this->assertSame(13, $this->jewish->monthsInYear());
+        $this->assertSame(12, $this->jewish->monthsInYear(5767));
+        $this->assertSame(13, $this->jewish->monthsInYear(5768));
     }
 
     /**
@@ -298,21 +311,7 @@ public function testJdToYmdReciprocity()
         }
     }
 
-    /**
-     * Test the conversion of a YMD date to JD when the month is not a valid number.
-     *
-     * @covers \Fisharebest\ExtCalendar\JewishCalendar::ymdToJd
-     *
-     * @expectedException        \InvalidArgumentException
-     * @expectedExceptionMessage Month 14 is invalid for this calendar
-     */
-    public function testYmdToJdInvalidMonth()
-    {
-        $calendar = new ArabicCalendar();
-        $calendar->ymdToJd(4, 14, 1);
-    }
-
-    /**
+   /**
      * Test the conversion of numbers into Hebrew numerals.
      *
      * @large This test can take several seconds to run.

diff --git a/test/JulianCalendarTest.php b/test/JulianCalendarTest.php
@@ -258,7 +258,7 @@ public function testJdToYmdReciprocity()
      */
     public function testYmdToJdInvalidMonth()
     {
-        $calendar = new ArabicCalendar();
+        $calendar = new JulianCalendar();
         $calendar->ymdToJd(4, 14, 1);
     }
 }
diff --git a/test/PersianCalendarTest.php b/test/PersianCalendarTest.php
@@ -326,7 +326,7 @@ public function testJdToYmdReciprocity()
      */
     public function testYmdToJdInvalidMonth()
     {
-        $calendar = new ArabicCalendar();
+        $calendar = new PersianCalendar();
         $calendar->ymdToJd(4, 14, 1);
     }
 }