blumilksoftware / heatmap Goto Github PK

Change how default time zone is added.

Proper documentation (hosted on GithubPages?) should be created for this package.

Adding some specific classes to "current" tile would be nice.

Instead of this:

it could render something like this:

At least these actions should be added to the repositoty:

• lint & test
• check PR title
• deploy documentation (when #3 would be finished)

Change the design to resemble a calendar

In this metatask I would like to prepare package to be published in Packagist.

AC:

• adjust repository name and library name
• think about how main namespace should be named
• add Packagist badges in readme (as in our other public PHP repositories)
• maybe something more?

I think that we could provide really simple set of tools to play with the package. We could add some index.html with simple script fetch prebuilt data.json (that could be gitignored) and simple index.php script with heatmap builder results saved to JSON file.

Current day tile is incorrectly marked as "future one".

Te replicate:

        $builder = new HeatmapBuilder(
            periodInterval: PeriodInterval::Weekly,
            period: new CarbonPeriod($firstEpisode->watched_at, "1 week", Carbon::now()->endOfYear()),
            arrayAccessIndex: "watched_at",
            decorator: new Decorator("sky"),
            alignedToEndOfPeriod: true,
        );

Screenshot:

Current week's tile receives $futureTileClass in tile's decorator. It should not.

I believe that there would be multiple problems with timezones within this package. It should be studied, discussed and refactored to handle timezones of provided data.

Bonus: probably we should update package to Carbon 3.

I would like to have an option to pass Eloquent models/queries with some parameters instead of sets of data. Blade components would be nice too.

We should discuss if this should be done here or maybe in another package (eg. laravel-heatmap).

Github has nice mechanism that extends number of tiles for year not to exact 365 days, but to first day of week:

I would like to add methods to align that in this package. Maybe something like this would be good approach:

public function forLastYear(bool $align = false): static

I would like to (at least):

• test package on PHP 8.2 and PHP 8.3
• think about minimal PHP version requirement
• bump PHPUnit to the newest
• bump codestyle version to the newest

Tests need to be fixed because they do not work properly without a time zone.