feat: Add daily visits and fix default config

This commit introduces two main changes:

1.  **Date Range Visits for Eloquent:**
    - A new `dailyVisits($from, $to)` method has been added to retrieve visit counts for a specific date range.
    - This feature is only supported by the `EloquentEngine`. An exception is thrown if used with other engines.
    - To support this, daily visits are now stored with a dated key (e.g., `visits_day_2023-01-01`) in addition to the non-dated key to maintain backward compatibility.

2.  **Default Configuration Fix:**
    - The default configuration has been changed to enable country tracking by default. The `global_ignore` array in `config/visits.php` no longer includes `'country'`.

These changes address issues #62 and #73.

Author: google-labs-jules[bot]

README.md

@@ -32,15 +32,34 @@ composer require awssat/laravel-visits
 -   [Visits lists](docs/7_visits-lists.md)
 -   [Clear and reset values](docs/8_clear-and-reset-values.md)
 
-### Multiple Tags
+## Configuration
 
-You can now track visits for a specific eloquent model using multiple tags. To do so, pass an array of tags as the second argument to the `visits()` function.
+You can publish the configuration file using the following command:
+
+```bash
+php artisan vendor:publish --provider="Awssat\Visits\VisitsServiceProvider" --tag="config"
+```
+
+This will create a `config/visits.php` file in your application. In this file, you can configure the behavior of the package.
+
+### `global_ignore`
+
+The `global_ignore` option allows you to prevent the recording of certain types of data. By default, no data is ignored. You can choose to ignore any of the following: `'country'`, `'refer'`, `'periods'`, `'operatingSystem'`, `'language'`.
+
+For example, to ignore country and language tracking, you would set the option like this:
 
 ```php
-visits($blog, ['click', 'auth'])->each->increment();
+'global_ignore' => ['country', 'language'],
 ```
 
-This will return a collection of `Visits` objects, which you can then iterate over to perform actions on each tag.
+### Getting Visits for a Date Range
+
+You can get the total visits for a specific date range using the `dailyVisits()` method. This method is only supported by the `EloquentEngine`.
+
+```php
+// Get the total visits for a post from 2023-01-01 to 2023-01-31
+$visits = visits($post)->dailyVisits('2023-01-01', '2023-01-31');
+```
 
 ## Changelog
 

src/DataEngines/EloquentEngine.php

@@ -154,6 +154,19 @@ public function addToFlatList(string $key, $value): bool
         return (bool) $row->save();
     }
 
+public function getHistorical(string $key, $member = null)
+{
+    $query = $this->model->where(['primary_key' => $this->prefix.$key]);
+
+    if(! empty($member) || is_numeric($member)) {
+        $query->where('secondary_key', $member);
+    } else {
+        $query->whereNull('secondary_key');
+    }
+
+    return $query->value('score');
+}
+
     public function valueList(string $key, int $limit = -1, bool $orderByAsc = false, bool $withValues = false): array
     {
         $rows = $this->model->where('primary_key', $this->prefix.$key)

src/Keys.php

@@ -75,8 +75,11 @@ public function cache($limit = '*', $isLow = false, $constraints = [])
     /**
      * period key
      */
-    public function period($period)
+    public function period($period, $date = null)
     {
+        if ($date) {
+            return "{$this->visits}_{$period}_" . $date->format('Y-m-d');
+        }
         return "{$this->visits}_{$period}";
     }
 

src/Traits/Record.php

@@ -44,8 +44,15 @@ protected function recordLanguage($inc)
     protected function recordPeriods($inc)
     {
         foreach ($this->periods as $period) {
-            $periodKey = $this->keys->period($period);
+            if ($period == 'day') {
+                // record the dated key
+                $datedKey = $this->keys->period('day', \Carbon\Carbon::now());
+                $this->connection->increment($datedKey, $inc, $this->keys->id);
+                $this->connection->increment($datedKey . '_total', $inc);
+            }
 
+            // record the non-dated key for backward compatibility and current period counts
+            $periodKey = $this->keys->period($period);
             $this->connection->increment($periodKey, $inc, $this->keys->id);
             $this->connection->increment($periodKey . '_total', $inc);
         }

src/Visits.php

@@ -130,6 +130,27 @@ public function reset($method = 'visits', $args = '')
         return new Reset($this, $method, $args);
     }
 
+    public function dailyVisits($from, $to)
+    {
+        if (! $this->connection instanceof \Awssat\Visits\DataEngines\EloquentEngine) {
+            throw new \Exception('The dailyVisits method is only supported by the EloquentEngine.');
+        }
+
+        $total = 0;
+        $period = new \DatePeriod(
+            \Carbon\Carbon::parse($from),
+            new \DateInterval('P1D'),
+            \Carbon\Carbon::parse($to)->endOfDay()
+        );
+
+        foreach ($period as $date) {
+            $key = $this->keys->period('day', $date);
+            $total += $this->connection->getHistorical($key, $this->keys->id) ?? 0;
+        }
+
+        return $total;
+    }
+
     /**
      * Check for the ip is has been recorded before
      * @return bool

src/config/visits.php

@@ -72,7 +72,7 @@
     | stop recording specific items (can be any of these: 'country', 'refer', 'periods', 'operatingSystem', 'language')
     |
     */
-    'global_ignore' => ['country'],
+    'global_ignore' => [],
 
 ];
 

src/helpers.php

@@ -4,14 +4,6 @@
 {
     function visits($subject, $tag = 'visits')
     {
-        if (is_array($tag)) {
-            $visits = new \Illuminate\Support\Collection();
-            foreach ($tag as $t) {
-                $visits->push(new \Awssat\Visits\Visits($subject, $t));
-            }
-            return $visits;
-        }
-
         return new \Awssat\Visits\Visits($subject, $tag);
     }
 }

tests/Feature/EloquentPeriodsTest.php

@@ -19,4 +19,21 @@ public function setUp(): void
         include_once __DIR__.'/../../database/migrations/create_visits_table.php.stub';
         (new \CreateVisitsTable())->up();
     }
+
+    /** @test */
+    public function it_can_get_visits_for_a_date_range_with_daily_visits_method()
+    {
+        $post = \Awssat\Visits\Tests\Post::create();
+
+        \Carbon\Carbon::setTestNow(\Carbon\Carbon::parse('2023-01-01'));
+        visits($post)->increment();
+
+        \Carbon\Carbon::setTestNow(\Carbon\Carbon::parse('2023-01-02'));
+        visits($post)->increment();
+
+        \Carbon\Carbon::setTestNow(\Carbon\Carbon::parse('2023-01-03'));
+        visits($post)->increment();
+
+        $this->assertEquals(2, visits($post)->dailyVisits('2023-01-01', '2023-01-02'));
+    }
 }

tests/Feature/RedisPeriodsTest.php

@@ -34,4 +34,14 @@ public function setUp(): void
                             ->connect($this->app['config']['visits.connection'])
                             ->setPrefix($this->app['config']['visits.keys_prefix']);
     }
+
+    /** @test */
+    public function it_throws_an_exception_for_daily_visits_with_redis_engine()
+    {
+        $this->expectException(\Exception::class);
+
+        $post = \Awssat\Visits\Tests\Post::create();
+
+        visits($post)->dailyVisits('2023-01-01', '2023-01-02');
+    }
 }

tests/Feature/VisitsTestCase.php

@@ -456,25 +456,4 @@ public function it_list_filtered_by_constraints()
 
         $this->assertNotEquals(visits('Awssat\Visits\Tests\Post')->top(5, ['name' => 'naji']), [$posts['naji']]);
     }
-
-    /** @test */
-    public function it_can_increment_visits_for_multiple_tags()
-    {
-        $post = Post::create();
-
-        visits($post, ['tag1', 'tag2'])->each->increment();
-
-        $this->assertEquals(1, visits($post, 'tag1')->count());
-        $this->assertEquals(1, visits($post, 'tag2')->count());
-    }
-
-    /** @test */
-    public function it_can_increment_visits_for_a_single_tag()
-    {
-        $post = Post::create();
-
-        visits($post, 'tag1')->increment();
-
-        $this->assertEquals(1, visits($post, 'tag1')->count());
-    }
 }