robojerk/Libation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Address #625 comments and refactor

Browse source
This commit is contained in:
Mbucari 2023-06-13 08:54:00 -06:00
parent b4aa220051
commit 2c4705de6e
20 changed files with 126 additions and 174 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Source/LibationSearchEngine/BookRule.cs
View file

@ -1,21 +0,0 @@
using DataLayer;
using System;
using System.Collections.ObjectModel;
namespace LibationSearchEngine;
public class BookRule : IIndexRule
{
public FieldType FieldType { get; }
public Func<Book, string> ValueGetter { get; }
public ReadOnlyCollection<string> FieldNames { get; }
public BookRule(FieldType fieldType, Func<Book, string> valueGetter, params string[] fieldNames)
{
ValueGetter = valueGetter;
FieldType = fieldType;
FieldNames = new ReadOnlyCollection<string>(fieldNames);
}
public string GetValue(LibraryBook libraryBook) => ValueGetter(libraryBook.Book);
}

22
Source/LibationSearchEngine/IIndexRule.cs
View file

@ -1,22 +0,0 @@
using DataLayer;
using System.Collections.ObjectModel;
namespace LibationSearchEngine;
public enum FieldType
{
Bool,
String,
Number,
ID,
Raw
}
public interface IIndexRule
{
/// <summary> This rule's value type. </summary>
FieldType FieldType { get; }
/// <summary> All aliases of this search index rule </summary>
ReadOnlyCollection<string> FieldNames { get; }
string GetValue(LibraryBook libraryBook);
}

42
Source/LibationSearchEngine/IndexRule.cs Normal file
View file

@ -0,0 +1,42 @@
using DataLayer;
using Dinah.Core;
using System;
using System.Collections.ObjectModel;
using System.Linq;
namespace LibationSearchEngine;
public enum FieldType
{
Bool,
String,
Number,
ID,
Raw
}
public class IndexRule
{
public FieldType FieldType { get; }
public Func<LibraryBook, string> GetValue { get; }
public ReadOnlyCollection<string> FieldNames { get; }
public IndexRule(FieldType fieldType, Func<LibraryBook, string> valueGetter, params string[] fieldNames)
{
ArgumentValidator.EnsureNotNull(valueGetter, nameof(valueGetter));
ArgumentValidator.EnsureNotNull(fieldNames, nameof(fieldNames));
ArgumentValidator.EnsureGreaterThan(fieldNames.Length, $"{nameof(fieldNames)}.{nameof(fieldNames.Length)}", 0);
var fieldNamesValidated
= fieldNames
.Select((n, i) => ArgumentValidator.EnsureNotNullOrWhiteSpace(n, $"{nameof(fieldNames)}[{i}]")
.Trim());
GetValue = valueGetter;
FieldType = fieldType;
FieldNames = new ReadOnlyCollection<string>(fieldNamesValidated.ToList());
}
public override string ToString()
=> FieldNames.Count == 1
? $"{FieldNames.First()}"
: $"{FieldNames.First()} ({string.Join(", ", FieldNames.Skip(1))})";
}

17
Source/LibationSearchEngine/IndexRuleCollection.cs
View file

@ -2,27 +2,26 @@
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
namespace LibationSearchEngine;
public class IndexRuleCollection : IEnumerable<IIndexRule>
[DebuggerDisplay("Count = {rules.Count,nq}")]
public class IndexRuleCollection : IEnumerable<IndexRule>
{
private readonly List<IIndexRule> rules = new();
private readonly List<IndexRule> rules = new();
public IEnumerable<string> IdFieldNames => rules.Where(x => x.FieldType is FieldType.ID).SelectMany(r => r.FieldNames);
public IEnumerable<string> BoolFieldNames => rules.Where(x => x.FieldType is FieldType.Bool).SelectMany(r => r.FieldNames);
public IEnumerable<string> StringFieldNames => rules.Where(x => x.FieldType is FieldType.String).SelectMany(r => r.FieldNames);
public IEnumerable<string> NumberFieldNames => rules.Where(x => x.FieldType is FieldType.Number).SelectMany(r => r.FieldNames);
public void Add(FieldType fieldType, Func<LibraryBook, string> getter, params string[] fieldNames)
=> rules.Add(new LibraryBookRule(fieldType, getter, fieldNames));
public void Add(FieldType fieldType, Func<Book, string> getter, params string[] fieldNames)
=> rules.Add(new BookRule(fieldType, getter, fieldNames));
=> rules.Add(new IndexRule(fieldType, getter, fieldNames));
public T GetRuleByFieldName<T>(string fieldName) where T : IIndexRule
=> (T)rules.SingleOrDefault(r => r.FieldNames.Any(n => n.Equals(fieldName, StringComparison.OrdinalIgnoreCase)));
public IndexRule GetRuleByFieldName(string fieldName)
=> rules.SingleOrDefault(r => r.FieldNames.Any(n => n.Equals(fieldName, StringComparison.OrdinalIgnoreCase)));
public IEnumerator<IIndexRule> GetEnumerator() => rules.GetEnumerator();
public IEnumerator<IndexRule> GetEnumerator() => rules.GetEnumerator();
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
}

21
Source/LibationSearchEngine/LibraryBookRule.cs
View file

@ -1,21 +0,0 @@
using DataLayer;
using System;
using System.Collections.ObjectModel;
namespace LibationSearchEngine;
public class LibraryBookRule : IIndexRule
{
public FieldType FieldType { get; }
public Func<LibraryBook, string> ValueGetter { get; }
public ReadOnlyCollection<string> FieldNames { get; }
public LibraryBookRule(FieldType fieldType, Func<LibraryBook, string> valueGetter, params string[] fieldNames)
{
ValueGetter = valueGetter;
FieldType = fieldType;
FieldNames = new ReadOnlyCollection<string>(fieldNames);
}
public string GetValue(LibraryBook libraryBook) => ValueGetter(libraryBook);
}

15
Source/LibationSearchEngine/LuceneExtensions.cs
View file

@ -17,7 +17,7 @@ namespace LibationSearchEngine
document.Add(new Field(name.ToLowerInvariant(), value, Field.Store.YES, Field.Index.ANALYZED));
}
internal static void RemoveRule(this Document document, IIndexRule rule)
internal static void RemoveRule(this Document document, IndexRule rule)
{
// fields are key value pairs. MULTIPLE FIELDS CAN POTENTIALLY HAVE THE SAME KEY.
// ie: must remove old before adding new else will create unwanted duplicates.
@ -25,20 +25,9 @@ namespace LibationSearchEngine
document.RemoveFields(name.ToLowerInvariant());
}
internal static void AddIndexRule(this Document document, IIndexRule rule, LibraryBook libraryBook)
internal static void AddIndexRule(this Document document, IndexRule rule, LibraryBook libraryBook)
{
string value = rule.GetValue(libraryBook);
addIndexRule(document, rule, value);
}
internal static void AddIndexRule(this Document document, BookRule rule, Book libraryBook)
{
addIndexRule(document, rule, rule.ValueGetter(libraryBook));
}
private static void addIndexRule(Document document, IIndexRule rule, string value)
{
if (value is null) return;
foreach (var name in rule.FieldNames)

64
Source/LibationSearchEngine/SearchEngine.cs
View file

@ -33,34 +33,34 @@ namespace LibationSearchEngine
// use these common fields in the "all" default search field
public static IndexRuleCollection FieldIndexRules { get; } = new IndexRuleCollection
{
{ FieldType.ID, Book => Book.AudibleProductId.ToLowerInvariant(), nameof(Book.AudibleProductId), "ProductId", "Id", "ASIN" },
{ FieldType.Raw, Book => Book.AudibleProductId, _ID_ },
{ FieldType.String, Book => Book.Title, nameof(Book.Title), "ProductId", "Id", "ASIN" },
{ FieldType.String, Book => Book.AuthorNames(), "AuthorNames", "Author", "Authors" },
{ FieldType.String, Book => Book.NarratorNames(), "NarratorNames", "Narrator", "Narrators" },
{ FieldType.String, Book => Book.Publisher, nameof(Book.Publisher) },
{ FieldType.String, Book => Book.SeriesNames(), "SeriesNames", "Narrator", "Series" },
{ FieldType.String, Book => string.Join(", ", Book.SeriesLink.Select(s => s.Series.AudibleSeriesId)), "SeriesId" },
{ FieldType.String, Book => Book.CategoriesIds() is null ? null : string.Join(", ", Book.CategoriesIds()), nameof(Book.Category), "Categories", "CategoriesId", "CategoryId", "CategoriesNames" },
{ FieldType.String, Book => Book.UserDefinedItem.Tags, TAGS.FirstCharToUpper() },
{ FieldType.String, Book => Book.Locale, "Locale", "Region" },
{ FieldType.ID, lb => lb.Book.AudibleProductId.ToLowerInvariant(), nameof(Book.AudibleProductId), "ProductId", "Id", "ASIN" },
{ FieldType.Raw, lb => lb.Book.AudibleProductId, _ID_ },
{ FieldType.String, lb => lb.Book.Title, nameof(Book.Title), "ProductId", "Id", "ASIN" },
{ FieldType.String, lb => lb.Book.AuthorNames(), "AuthorNames", "Author", "Authors" },
{ FieldType.String, lb => lb.Book.NarratorNames(), "NarratorNames", "Narrator", "Narrators" },
{ FieldType.String, lb => lb.Book.Publisher, nameof(Book.Publisher) },
{ FieldType.String, lb => lb.Book.SeriesNames(), "SeriesNames", "Narrator", "Series" },
{ FieldType.String, lb => string.Join(", ", lb.Book.SeriesLink.Select(s => s.Series.AudibleSeriesId)), "SeriesId" },
{ FieldType.String, lb => lb.Book.CategoriesIds() is null ? null : string.Join(", ", lb.Book.CategoriesIds()), nameof(Book.Category), "Categories", "CategoriesId", "CategoryId", "CategoriesNames" },
{ FieldType.String, lb => lb.Book.UserDefinedItem.Tags, TAGS.FirstCharToUpper() },
{ FieldType.String, lb => lb.Book.Locale, "Locale", "Region" },
{ FieldType.String, lb => lb.Account, "Account", "Email" },
{ FieldType.Bool, Book => Book.HasPdf().ToString(), "HasDownloads", "HasDownload", "Downloads" , "Download", "HasPDFs", "HasPDF" , "PDFs", "PDF" },
{ FieldType.Bool, Book => (Book.UserDefinedItem.Rating.OverallRating > 0f).ToString(), "IsRated", "Rated" },
{ FieldType.Bool, Book => isAuthorNarrated(Book).ToString(), "IsAuthorNarrated", "AuthorNarrated" },
{ FieldType.Bool, Book => Book.IsAbridged.ToString(), nameof(Book.IsAbridged), "Abridged" },
{ FieldType.Bool, Book => (Book.UserDefinedItem.BookStatus == LiberatedStatus.Liberated).ToString(), "IsLiberated", "Liberated" },
{ FieldType.Bool, Book => (Book.UserDefinedItem.BookStatus == LiberatedStatus.Error).ToString(), "LiberatedError" },
{ FieldType.Bool, Book => Book.IsEpisodeChild().ToString(), "Podcast", "Podcasts", "IsPodcast", "Episode", "Episodes", "IsEpisode" },
{ FieldType.Bool, lb => lb.Book.HasPdf().ToString(), "HasDownloads", "HasDownload", "Downloads" , "Download", "HasPDFs", "HasPDF" , "PDFs", "PDF" },
{ FieldType.Bool, lb => (lb.Book.UserDefinedItem.Rating.OverallRating > 0f).ToString(), "IsRated", "Rated" },
{ FieldType.Bool, lb => isAuthorNarrated(lb.Book).ToString(), "IsAuthorNarrated", "AuthorNarrated" },
{ FieldType.Bool, lb => lb.Book.IsAbridged.ToString(), nameof(Book.IsAbridged), "Abridged" },
{ FieldType.Bool, lb => (lb.Book.UserDefinedItem.BookStatus == LiberatedStatus.Liberated).ToString(), "IsLiberated", "Liberated" },
{ FieldType.Bool, lb => (lb.Book.UserDefinedItem.BookStatus == LiberatedStatus.Error).ToString(), "LiberatedError" },
{ FieldType.Bool, lb => lb.Book.IsEpisodeChild().ToString(), "Podcast", "Podcasts", "IsPodcast", "Episode", "Episodes", "IsEpisode" },
{ FieldType.Bool, lb => lb.AbsentFromLastScan.ToString(), "AbsentFromLastScan", "Absent" },
// all numbers are padded to 8 char.s
// This will allow a single method to auto-pad numbers. The method will match these as well as date: yyyymmdd
{ FieldType.Number, Book => Book.LengthInMinutes.ToLuceneString(), nameof(Book.LengthInMinutes), "Length", "Minutes" },
{ FieldType.Number, Book => (Book.LengthInMinutes / 60).ToLuceneString(), "Hours" },
{ FieldType.Number, Book => Book.Rating.OverallRating.ToLuceneString(), "ProductRating", "Rating" },
{ FieldType.Number, Book => Book.UserDefinedItem.Rating.OverallRating.ToLuceneString(), "UserRating", "MyRating" },
{ FieldType.Number, Book => Book.DatePublished?.ToLuceneString() ?? "", nameof(Book.DatePublished) },
{ FieldType.Number, Book => Book.UserDefinedItem.LastDownloaded.ToLuceneString(), nameof(UserDefinedItem.LastDownloaded), "LastDownload" },
{ FieldType.Number, lb => lb.Book.LengthInMinutes.ToLuceneString(), nameof(Book.LengthInMinutes), "Length", "Minutes" },
{ FieldType.Number, lb => (lb.Book.LengthInMinutes / 60).ToLuceneString(), "Hours" },
{ FieldType.Number, lb => lb.Book.Rating.OverallRating.ToLuceneString(), "ProductRating", "Rating" },
{ FieldType.Number, lb => lb.Book.UserDefinedItem.Rating.OverallRating.ToLuceneString(), "UserRating", "MyRating" },
{ FieldType.Number, lb => lb.Book.DatePublished?.ToLuceneString() ?? "", nameof(Book.DatePublished) },
{ FieldType.Number, lb => lb.Book.UserDefinedItem.LastDownloaded.ToLuceneString(), nameof(UserDefinedItem.LastDownloaded), "LastDownload" },
{ FieldType.Number, lb => lb.DateAdded.ToLuceneString(), nameof(LibraryBook.DateAdded) }
};
#endregion
@ -132,14 +132,14 @@ namespace LibationSearchEngine
});
// update single document entry
public void UpdateLiberatedStatus(Book book)
public void UpdateLiberatedStatus(LibraryBook book)
=> updateDocument(
book.AudibleProductId,
book.Book.AudibleProductId,
d =>
{
var lib = FieldIndexRules.GetRuleByFieldName<BookRule>("IsLiberated");
var libError = FieldIndexRules.GetRuleByFieldName<BookRule>("LiberatedError");
var lastDl = FieldIndexRules.GetRuleByFieldName<BookRule>(nameof(UserDefinedItem.LastDownloaded));
var lib = FieldIndexRules.GetRuleByFieldName("IsLiberated");
var libError = FieldIndexRules.GetRuleByFieldName("LiberatedError");
var lastDl = FieldIndexRules.GetRuleByFieldName(nameof(UserDefinedItem.LastDownloaded));
d.RemoveRule(lib);
d.RemoveRule(libError);
@ -150,12 +150,12 @@ namespace LibationSearchEngine
d.AddIndexRule(lastDl, book);
});
public void UpdateUserRatings(Book book)
public void UpdateUserRatings(LibraryBook book)
=>updateDocument(
book.AudibleProductId,
book.Book.AudibleProductId,
d =>
{
var rating = FieldIndexRules.GetRuleByFieldName<BookRule>("UserRating");
var rating = FieldIndexRules.GetRuleByFieldName("UserRating");
d.RemoveRule(rating);
d.AddIndexRule(rating, book);