|
1 | 1 | # SmartSelector |
2 | | -Autoc selection expression generator to map object to object and apply to IQueryable. |
| 2 | + |
| 3 | +Gerador/Source Generator para criar automaticamente projeções (`Expression<Func<TFrom, TDto>>`), métodos auxiliares e propriedades em DTOs, reduzindo drasticamente boilerplate em consultas LINQ / EF Core. |
| 4 | + |
| 5 | +## Principais Recursos |
| 6 | +- `[AutoSelect<TFrom>]`: gera expressão de seleção, método `From`, extensões `Select{Dto}` / `To{Dto}`. |
| 7 | +- `[AutoProperties]` ou `[AutoProperties<TFrom>]`: gera propriedades simples automaticamente (primitivos, string, bool, DateTime, enum, struct, coleções simples `IEnumerable<T>` desses tipos). |
| 8 | +- Flattening por convenção: nomes concatenados em PascalCase resolvem cadeias aninhadas (ex.: `CustomerAddressCountryRegionName` ? `a.Customer.Address.Country.Region.Name`). |
| 9 | +- Exclusão de propriedades: `Exclude = [ nameof(Entity.Prop) ]`. |
| 10 | +- Diagnósticos de compilação para uso incorreto, tipos incompatíveis e conflitos. |
| 11 | + |
| 12 | +## Instalação |
| 13 | +```xml |
| 14 | +<ItemGroup> |
| 15 | + <PackageReference Include="RoyalCode.SmartSelector" Version="x.y.z" /> |
| 16 | + <PackageReference Include="RoyalCode.SmartSelector.Generators" Version="x.y.z" OutputItemType="Analyzer" ReferenceOutputAssembly="false" /> |
| 17 | +</ItemGroup> |
| 18 | +``` |
| 19 | + |
| 20 | +## Exemplo 1 – Projeção Simples |
| 21 | +```csharp |
| 22 | +[AutoSelect<User>, AutoProperties] |
| 23 | +public partial class UserDetails { } |
| 24 | + |
| 25 | +// Uso |
| 26 | +var list = db.Users.SelectUserDetails().ToList(); |
| 27 | +var dto = UserDetails.From(user); |
| 28 | +var expr = UserDetails.SelectUserExpression; // reutilizável / componível |
| 29 | +``` |
| 30 | +Código gerado (essencial): |
| 31 | +```csharp |
| 32 | +public static Expression<Func<User, UserDetails>> SelectUserExpression => u => new UserDetails { Id = u.Id, Name = u.Name }; |
| 33 | +public static UserDetails From(User u) => (selectUserFunc ??= SelectUserExpression.Compile())(u); |
| 34 | +``` |
| 35 | + |
| 36 | +## Exemplo 2 – Objeto Aninhado + Exclusão |
| 37 | +```csharp |
| 38 | +[AutoSelect<Book>, AutoProperties(Exclude = [ nameof(Book.Sku) ])] |
| 39 | +public partial class BookDetails |
| 40 | +{ |
| 41 | + public ShelfDetails Shelf { get; set; } |
| 42 | +} |
| 43 | + |
| 44 | +[AutoProperties<Shelf>] |
| 45 | +public partial class ShelfDetails { } |
| 46 | +``` |
| 47 | +Trecho gerado: |
| 48 | +```csharp |
| 49 | +Shelf = new ShelfDetails { Id = a.Shelf.Id, Location = a.Shelf.Location }, |
| 50 | +Price = a.Price, |
| 51 | +// Sku excluído |
| 52 | +``` |
| 53 | + |
| 54 | +## Exemplo 3 – Flattening Profundo |
| 55 | +```csharp |
| 56 | +public class Order { public Customer Customer { get; set; } } |
| 57 | +// Customer -> Address -> Country -> Region |
| 58 | +[AutoSelect<Order>] |
| 59 | +public partial class OrderDetails |
| 60 | +{ |
| 61 | + public string CustomerAddressCountryRegionName { get; set; } |
| 62 | +} |
| 63 | +``` |
| 64 | +Trecho da expressão: |
| 65 | +```csharp |
| 66 | +CustomerAddressCountryRegionName = a.Customer.Address.Country.Region.Name |
| 67 | +``` |
| 68 | + |
| 69 | +## Regras de Flattening |
| 70 | +- Nome da propriedade = concatenação PascalCase dos segmentos do caminho. |
| 71 | +- Sem necessidade de atributos extras. |
| 72 | + |
| 73 | +## Tipos Suportados em AutoProperties |
| 74 | +- Primitivos numéricos, `bool`, `string`, `char`, `DateTime` / nullable simples |
| 75 | +- `enum`, `struct` |
| 76 | +- `IEnumerable<T>` onde `T` é suportado acima / enum / struct |
| 77 | + |
| 78 | +## Exclusões |
| 79 | +```csharp |
| 80 | +[AutoProperties<Product>(Exclude = [ nameof(Product.InternalCode), nameof(Product.Secret) ])] |
| 81 | +``` |
| 82 | + |
| 83 | +## Diagnósticos Principais |
| 84 | +- Tipos inválidos ou classe não `partial` (`RCSS000`). |
| 85 | +- Propriedade não encontrada (`RCSS001`). |
| 86 | +- Tipos incompatíveis (`RCSS002`). |
| 87 | +- Uso incorreto de atributos (`RCSS003`–`RCSS005`). |
| 88 | + |
| 89 | +## Limitações Resumidas |
| 90 | +- Sem renome/alias explícito ainda (`MapFrom`). |
| 91 | +- Sem transformações de tipo (formatters / custom converters). |
| 92 | +- Desambiguação de flattening limitada em colisões de prefixo. |
| 93 | + |
| 94 | +## Boas Práticas |
| 95 | +- Use `nameof` em `Exclude`. |
| 96 | +- Prefira consumir a expressão gerada para reutilização e composição LINQ. |
| 97 | +- Para caminhos muito longos, avalie DTOs aninhados por clareza. |
| 98 | + |
| 99 | +## FAQ Rápido |
| 100 | +| Pergunta | Resposta | |
| 101 | +|----------|----------| |
| 102 | +| Preciso configurar algo no runtime? | Não, pura geração de código. | |
| 103 | +| Funciona com EF Core? | Sim, a expressão é traduzível. | |
| 104 | +| Posso só gerar propriedades? | Sim: `[AutoProperties<TFrom>]`. | |
| 105 | +| Flattening precisa de atributo? | Não, é por nome. | |
| 106 | + |
| 107 | +## Mais Informações |
| 108 | +Documentação detalhada: ver `docs.md` no repositório. |
| 109 | + |
| 110 | +--- |
| 111 | +Happy coding! |
0 commit comments