Minor adjustments.

Author: tomshaw

README.md

@@ -50,9 +50,79 @@ The calendar table command accepts two optional parameters. If no **start** year
 > Note: If the table has been pre-filled you will be given the option to truncate.
 
 ```
-php artisan calendar:table --start=1990 --end=2030
+php artisan calendar:table --start=2000 --end=2030
 ```
 
+Sure, here's a README.md section that explains the configuration options for your Laravel Calendar Table package:
+
+## Configuration
+
+The Laravel Calendar Table package provides several configuration options that you can adjust to suit your needs. You can find these options in the `config.php` file.
+
+### Table Name
+
+The `table_name` option allows you to define a custom table name for the database records. By default, it is set to `'date_dimension'`.
+
+```php
+'table_name' => 'date_dimension',
+```
+
+### Seasons
+
+The `seasons` array allows you to define the start month for each season. By default, it is configured for the meteorological seasons of the Northern Hemisphere:
+
+- Spring starts in March
+- Summer starts in June
+- Autumn starts in September
+- Winter starts in December
+
+If you are in the Southern Hemisphere, you should reconfigure the seasons to start approximately six months later:
+
+- Spring starts in September
+- Summer starts in December
+- Autumn starts in March
+- Winter starts in June
+
+```php
+'seasons' => [
+    'Spring' => 3,
+    'Summer' => 6,
+    'Autumn' => 9,
+    'Winter' => 12,
+],
+```
+
+### Fiscal Year Start Month
+
+The `fiscal_year_start_month` option allows you to define the start month of the fiscal year. The value should be an integer between 1 (January) and 12 (December). By default, it is set to 10, meaning the fiscal year starts in October. Adjust this setting to match your own fiscal year.
+
+```php
+'fiscal_year_start_month' => 10,
+```
+
+### Date Range
+
+The `date_range` array allows you to define the max start and end year range for populating the calendar table. 
+
+- `start_year`: This option defines the earliest year for the calendar table. Defaults to 20 years before the current year. 
+
+- `end_year`: This option defines the latest year for the calendar table. Defaults to 20 years after the current year.
+
+```php
+'date_range' => [
+    'start_year' => Carbon\Carbon::now()->subYears(20)->year,
+    'end_year' => Carbon\Carbon::now()->addYears(20)->year,
+],
+```
+
+## Requirements
+
+The package is compatible with Laravel 10 or later.
+
+## Support
+
+If you have any issues or questions please send a pull request.
+
 ## License
 
 The MIT License (MIT). Please see [License](LICENSE) for more information.

config/config.php

@@ -1,28 +1,13 @@
 <?php
 
-/**
- * Configuration file for the Laravel Calendar Table package.
- */
 return [
     /**
-     * User defined custom table name for database records.
+     * Defines the database table name.
      */
     'table_name' => 'date_dimension',
 
     /**
-     * The 'seasons' array defines the start month for each season.
-     *
-     * This configuration assumes the meteorological seasons of the Northern Hemisphere, where the seasons are defined as follows:
-     * - Spring starts in March (3rd month)
-     * - Summer starts in June (6th month)
-     * - Autumn starts in September (9th month)
-     * - Winter starts in December (12th month)
-     *
-     * Users in the Southern Hemisphere should reconfigure the seasons approximately six months offset from those of the Northern Hemisphere:
-     * - Spring starts in September
-     * - Summer starts in December
-     * - Autumn starts in March
-     * - Winter starts in June
+     * Defines the start month for each season.
      */
     'seasons' => [
         'Spring' => 3,
@@ -32,13 +17,15 @@
     ],
 
     /**
-     * The 'fiscal_year_start_month' option defines the start month of the fiscal year.
-     *
-     * Months are represented as numbers between 1 (January) and 12 (December).
-     *
-     * In this case, the fiscal year starts in October (10th month). This might be the case for a company or government that operates on a fiscal year that begins on October 1 and ends on September 30 of the following year.
-     *
-     * Users should adjust this setting to match their own fiscal year. For example, if the fiscal year starts in July, they would set this option to 7.
+     * Defines the start month of the fiscal year.
      */
     'fiscal_year_start_month' => 10,
+
+    /**
+     * Defines the valid year range to populate the table.
+     */
+    'date_range' => [
+        'start_year' => Carbon\Carbon::now()->subYears(20)->year,
+        'end_year' => Carbon\Carbon::now()->addYears(20)->year,
+    ],
 ];

src/Commands/CalendarTableCommand.php

@@ -26,9 +26,24 @@ class CalendarTableCommand extends Command
     protected $description = 'A Laravel command to sequence calendar table dates.';
 
     /**
-     * The database table name.
+     * The table name to be used.
      */
-    protected string $tableName;
+    protected string $tableName = 'date_dimension';
+
+    /**
+     * The fiscal year start month.
+     */
+    protected int $fiscalYearStartMonth = 10;
+
+    /**
+     * The seasons start month array.
+     */
+    protected array $seasons = [
+        'Spring' => 3,
+        'Summer' => 6,
+        'Autumn' => 9,
+        'Winter' => 12,
+    ];
 
     /**
      * Create a new command instance.
@@ -39,7 +54,7 @@ public function __construct()
     {
         parent::__construct();
 
-        $this->tableName = config('calendar-table.table_name', 'date_dimension');
+        $this->tableName = config('calendar-table.table_name', $this->tableName);
     }
 
     /**
@@ -62,19 +77,25 @@ public function handle(): void
         $endYear = (int) $endYear;
 
         if (! $this->isValidYear($startYear)) {
-            $this->error('Invalid start year format.');
+            $this->error("Invalid start year: {$startYear}");
+
+            return;
         }
 
         if (! $this->isValidYear($endYear)) {
-            $this->error('Invalid end year format.');
+            $this->error("Invalid end year: {$endYear}");
+
+            return;
         }
 
         if ($startYear > $endYear) {
             $this->error('Starting year is greater than ending.');
+
+            return;
         }
 
         if ($this->count()) {
-            if ($this->confirm('Table is currently filled would you like to run the truncate command')) {
+            if ($this->confirm('Table is currently filled would you like to truncate the table?')) {
                 $this->truncate();
             } else {
                 return;
@@ -112,7 +133,7 @@ public function truncate(): void
      *
      * @return int The number of records in the table.
      */
-    public function count()
+    public function count(): int
     {
         return DB::table($this->tableName)->count();
     }
@@ -153,52 +174,35 @@ public function insert(int $startYear, int $endYear): void
     }
 
     /**
-     * Checks if the input is a valid year.
+     * Check if the year is valid.
      *
-     * This function checks if the input is a numeric value and if it falls within the range of 1000 to 9999,
-     * which covers all valid 4-digit years. If both conditions are met, the function returns true;
-     * otherwise, it returns false.
+     * This function checks if the year is within the valid range.
      *
-     * @param  int  $input  The input to be validated.
-     * @return bool Returns true if the input is a valid year, false otherwise.
+     * @param  int  $year  The year to be checked.
+     * @return bool True if the year is valid, false otherwise.
      */
-    public function isValidYear(int $input)
+    public function isValidYear(int $year): bool
     {
-        // Check if the input is a numeric value
-        if (is_numeric($input)) {
-            // Convert the input to an integer
-            $year = intval($input);
-
-            // Check if the year is in the valid range
-            if ($year >= 1000 && $year <= 9999) {
-                return true;
-            }
+        $startYear = config('calendar-table.date_range.start_year', Carbon::now()->subYears(20)->year);
+        $endYear = config('calendar-table.date_range.end_year', Carbon::now()->addYears(20)->year);
+        if ($year >= $startYear && $year <= $endYear) {
+            return true;
         }
 
         return false;
     }
 
     /**
-     * Determines the season for a given date.
+     * Determine the season for a given date.
      *
-     * This function determines the season for a given date based on the start month of each season.
-     * The function iterates through the seasons array and returns the first season where the start month is less than or equal to the current month.
-     * If no season is found, the function returns 'Winter' as the default season.
+     * This function determines the season for a given date based on the start month of the season.
      *
      * @param  Carbon  $date  The date for which the season is to be determined.
      * @return string The season for the given date.
      */
     public function determineSeason(Carbon $date): string
     {
-        $seasons = config('calendar-table.seasons', [
-            'Spring' => 3,
-            'Summer' => 6,
-            'Autumn' => 9,
-            'Winter' => 12,
-        ]);
-
-        // Reverse the seasons array so we can find the first season where the start month is less than or equal to the current month
-        $seasons = array_reverse($seasons, true);
+        $seasons = array_reverse(config('calendar-table.seasons', $this->seasons), true);
 
         foreach ($seasons as $season => $startMonth) {
             if ($date->month >= $startMonth) {
@@ -210,12 +214,9 @@ public function determineSeason(Carbon $date): string
     }
 
     /**
-     * Determines the fiscal year and quarter for a given date.
+     * Determine the fiscal year and quarter for a given date.
      *
      * This function determines the fiscal year and quarter for a given date based on the start month of the fiscal year.
-     * The function calculates the fiscal year based on the month of the date and the start month of the fiscal year.
-     * If the month of the date is greater than or equal to the start month of the fiscal year, the fiscal year is incremented by 1.
-     * The fiscal quarter is calculated based on the month of the date and the start month of the fiscal year.
      *
      * @param  Carbon  $date  The date for which the fiscal year and quarter are to be determined.
      * @return array An array containing the fiscal year and quarter for the given date.
@@ -225,7 +226,7 @@ public function fiscalYearQuarter(Carbon $date): array
         $fiscalYear = $date->year;
         $fiscalQuarter = ceil($date->month / 3);
 
-        $fiscalYearStartMonth = config('calendar-table.fiscal_year_start_month', 10);
+        $fiscalYearStartMonth = config('calendar-table.fiscal_year_start_month', $this->fiscalYearStartMonth);
         if ($date->month >= $fiscalYearStartMonth) {
             $fiscalYear++;
             $fiscalQuarter = ceil(($date->month - $fiscalYearStartMonth + 1) / 3);

tests/CommandTest.php

@@ -64,7 +64,7 @@ public function test_it_asks_to_truncate_database_when_filled()
 
         // Arrange: Insert data into the database expect confirmation
         $this->artisan($this->consoleCommand)
-            ->expectsQuestion('Table is currently filled would you like to run the truncate command', 'yes')
+            ->expectsQuestion('Table is currently filled would you like to truncate the table?', 'yes')
             ->assertExitCode(0);
     }
 }