Update MOTD package: improve package description and update configura…

…tion

README.md

@@ -5,15 +5,12 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/lexiandev/laravel-motd/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/lexiandev/laravel-motd/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/lexiandev/laravel-motd.svg?style=flat-square)](https://packagist.org/packages/lexiandev/laravel-motd)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+This is a simple package to display MOTD messages to your users, it can
+be used to display updates, maintenance messages, or any other message
+you want to display to your users.
 
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-motd.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-motd)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+When using the package, simply call the `get` method on the motd model
+and it'll return the **newest** message that is not expired.
 
 ## Installation
 
@@ -26,34 +23,33 @@ composer require lexiandev/laravel-motd
 You can publish and run the migrations with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-motd-migrations"
+php artisan vendor:publish --tag="motd-migrations"
 php artisan migrate
 ```
 
 You can publish the config file with:
 
 ```bash
-php artisan vendor:publish --tag="laravel-motd-config"
+php artisan vendor:publish --tag="motd-config"
 ```
 
 This is the contents of the published config file:
 
 ```php
 return [
+    /**
+     * The default text that will be displayed if no MOTD is set.
+     * Default: Null; no message will be returned.
+     */
+    'default_message' => null,
 ];
 ```
 
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag="laravel-motd-views"
-```
-
 ## Usage
 
 ```php
-$motd = new Lexiandev\Motd();
-echo $motd->echoPhrase('Hello, Lexiandev!');
+$motd = new Motd();
+return $motd->get();
 ```
 
 ## Testing
@@ -67,7 +63,7 @@ composer test
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
 ## Contributing
-
+    
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Security Vulnerabilities

config/motd.php

@@ -2,5 +2,9 @@
 
 // config for Lexiandev/Motd
 return [
-
+    /**
+     * The default text that will be displayed if no MOTD is set.
+     * Default: Null; no message will be returned.
+     */
+    'default_message' => null,
 ];

database/migrations/create_motd_table.php.stub → database/migrations/create_motds_table.php.stub

@@ -8,7 +8,7 @@ return new class extends Migration
 {
     public function up()
     {
-        Schema::create('laravel_motd_table', function (Blueprint $table) {
+        Schema::create('motds', function (Blueprint $table) {
             $table->id();
 
             $table->string('message');

src/Models/motd.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Lexiandev\Motd\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Motd extends Model
+{
+    protected $table = 'motds';
+
+    protected $fillable = [
+        'message',
+        'start_date',
+        'end_date',
+    ];
+
+    protected $dates = [
+        'start_date',
+        'end_date',
+    ];
+
+    public function get()
+    {
+        $query = $this->where('start_date', '<=', now())
+            ->where('end_date', '>=', now())
+            ->orderBy('created_at', 'desc') // Order by created_at in descending order
+            ->first(); // Retrieve only the newest message
+
+        if ($query) {
+            return $query->message;
+        } else {
+            return config('motd.default_message');
+        }
+    }
+
+    public function set($message, $start_date, $end_date)
+    {
+        // Convert unix timestamps to Carbon instances
+        $start_date = \Carbon\Carbon::createFromTimestamp($start_date);
+        $end_date = \Carbon\Carbon::createFromTimestamp($end_date);
+
+        $this->create([
+            'message' => $message,
+            'start_date' => $start_date,
+            'end_date' => $end_date,
+        ]);
+
+        return true;
+    }
+}

src/MotdServiceProvider.php

@@ -19,7 +19,7 @@ public function configurePackage(Package $package): void
             ->name('laravel-motd')
             ->hasConfigFile()
             ->hasViews()
-            ->hasMigration('create_laravel-motd_table')
+            ->hasMigration('create_motds_table')
             ->hasCommand(MotdCommand::class);
     }
 }