flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Allow matching of folders based on parsed date (#2074)

Browse Source 
- For: #1748
This commit is contained in:
Dermot Duffy
2025-05-31 14:12:09 -07:00
committed by GitHub
parent dc63dcdab9
commit c55a0f00fd
6 changed files with 248 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/card-controller/folders/ha/media-matcher.test.ts
+90 -21
View File
@@ -2,8 +2,12 @@ import { renderTemplate } from 'ha-nunjucks';
import { describe, expect, it, vi } from 'vitest';
import { MediaMatcher } from '../../../../src/card-controller/folders/ha/media-matcher';
import { Matcher } from '../../../../src/config/schema/folders';
import { BrowseMedia } from '../../../../src/ha/browse-media/types';
import {
BrowseMediaMetadata,
RichBrowseMedia,
} from '../../../../src/ha/browse-media/types';
import { createHASS } from '../../../test-utils';
import { sub } from 'date-fns';
vi.mock('ha-nunjucks');
@@ -11,9 +15,9 @@ describe('MediaMatcher', () => {
describe('match', () => {
const createMediaItem = (
title: string,
can_expand: boolean,
can_expand = false,
media_class = 'image',
): BrowseMedia => ({
): RichBrowseMedia<BrowseMediaMetadata> => ({
title,
media_class,
media_content_type: media_class === 'directory' ? 'directory' : 'image/jpeg',
@@ -25,7 +29,7 @@ describe('MediaMatcher', () => {
it('should return false if foldersOnly is true and media.can_expand is false', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test File', false);
const media = createMediaItem('Test File');
expect(
mediaMatcher.match(createHASS(), media, { matchers: [], foldersOnly: true }),
).toBe(false);
@@ -41,13 +45,13 @@ describe('MediaMatcher', () => {
it('should return true if matchers array is empty', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media', false);
const media = createMediaItem('Test Media');
expect(mediaMatcher.match(createHASS(), media, { matchers: [] })).toBe(true);
});
it('should return true if matchers array is undefined', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media', false);
const media = createMediaItem('Test Media');
expect(mediaMatcher.match(createHASS(), media, { matchers: undefined })).toBe(
true,
);
@@ -56,21 +60,21 @@ describe('MediaMatcher', () => {
describe('with title matcher', () => {
it('should return true when title matches exactly', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Exact Title', false);
const media = createMediaItem('Exact Title');
const matchers: Matcher[] = [{ type: 'title', title: 'Exact Title' }];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
});
it('should return false when title does not match exactly', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('DOES NOT MATCH', false);
const media = createMediaItem('DOES NOT MATCH');
const matchers: Matcher[] = [{ type: 'title', title: 'Exact Title' }];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(false);
});
it('should return true when title matches regexp and extracted value matches matcher.title', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Prefix-ImportantPart-Suffix', false);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
type: 'title',
@@ -83,7 +87,7 @@ describe('MediaMatcher', () => {
it('should return false when title matches regexp but extracted value does not match matcher.title', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Prefix-ImportantPart-Suffix', false);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
type: 'title',
@@ -96,7 +100,7 @@ describe('MediaMatcher', () => {
it('should return true when title matches regexp with an explicit title value', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Prefix-ImportantPart-Suffix', false);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
type: 'title',
@@ -109,7 +113,7 @@ describe('MediaMatcher', () => {
it('should return false when title does not match regexp', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Unrelated Title', false);
const media = createMediaItem('Unrelated Title');
const matchers: Matcher[] = [
{
type: 'title',
@@ -122,7 +126,7 @@ describe('MediaMatcher', () => {
it('should return false when regexp is provided but does not extract the required group', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Prefix-ImportantPart-Suffix', false);
const media = createMediaItem('Prefix-ImportantPart-Suffix');
const matchers: Matcher[] = [
{
type: 'title',
@@ -135,7 +139,7 @@ describe('MediaMatcher', () => {
it('should return true when no regexp and no matcher.title (matches any title)', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Any Title Will Do', false);
const media = createMediaItem('Any Title Will Do');
const matchers: Matcher[] = [{ type: 'title' }];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);
});
@@ -145,7 +149,7 @@ describe('MediaMatcher', () => {
it('should return true when template value matches', () => {
const mediaMatcher = new MediaMatcher();
const title = 'Any Title Will Do';
const media = createMediaItem(title, false);
const media = createMediaItem(title);
vi.mocked(renderTemplate).mockReturnValue(true);
@@ -181,7 +185,7 @@ describe('MediaMatcher', () => {
it('should return false when template value does not match', () => {
const mediaMatcher = new MediaMatcher();
const title = 'Any Title Will Do';
const media = createMediaItem(title, false);
const media = createMediaItem(title);
vi.mocked(renderTemplate).mockReturnValue(false);
@@ -218,7 +222,7 @@ describe('MediaMatcher', () => {
describe('with or matcher', () => {
it('should return true if at least one sub-matcher matches', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media', false);
const media = createMediaItem('Test Media');
const matcher: Matcher = {
type: 'or',
matchers: [
@@ -233,7 +237,7 @@ describe('MediaMatcher', () => {
it('should return false if no sub-matcher matches', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media', false);
const media = createMediaItem('Test Media');
const matcher: Matcher = {
type: 'or',
matchers: [
@@ -247,9 +251,74 @@ describe('MediaMatcher', () => {
});
});
describe('with date matcher', () => {
it('should not match without metadata', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media');
const matcher: Matcher = {
type: 'date',
since: { days: 1 },
};
expect(mediaMatcher.match(createHASS(), media, { matchers: [matcher] })).toBe(
false,
);
});
it.each([
[
{
type: 'date' as const,
since: { days: 2, minutes: 1 },
},
],
[
{
type: 'date' as const,
since: { days: 2, hours: 1 },
},
],
[
{
type: 'date' as const,
since: { months: 1 },
},
],
[
{
type: 'date' as const,
since: { years: 1 },
},
],
])('should match with date more recent than matcher %s', (matcher: Matcher) => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media');
media._metadata = {
startDate: sub(new Date(), { days: 1 }),
};
expect(mediaMatcher.match(createHASS(), media, { matchers: [matcher] })).toBe(
true,
);
});
it('should not match with date less recent than matcher', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media');
media._metadata = {
startDate: sub(new Date(), { days: 2 }),
};
const matcher: Matcher = {
type: 'date',
since: { days: 1 },
};
expect(mediaMatcher.match(createHASS(), media, { matchers: [matcher] })).toBe(
false,
);
});
});
it('should return false if one of multiple matchers fails', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media One', false);
const media = createMediaItem('Test Media One');
const matchers: Matcher[] = [
{ type: 'title', title: 'Test Media One' }, // Pass
{ type: 'title', title: 'Test Media Two' }, // Fail
@@ -259,7 +328,7 @@ describe('MediaMatcher', () => {
it('should return true if all multiple matchers pass', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media One', false);
const media = createMediaItem('Test Media One');
const matchers: Matcher[] = [
{ type: 'title', title: 'Test Media One' },
{
@@ -273,7 +342,7 @@ describe('MediaMatcher', () => {
it('should ignore matchers of unknown types', () => {
const mediaMatcher = new MediaMatcher();
const media = createMediaItem('Test Media', false);
const media = createMediaItem('Test Media');
const matchers: Matcher[] = [{ type: 'unknownMatcherType' as 'title' }];
expect(mediaMatcher.match(createHASS(), media, { matchers })).toBe(true);