Skip to content

Commit

Permalink
update code style
Browse files Browse the repository at this point in the history
  • Loading branch information
BenjaminAbt committed Apr 1, 2024
1 parent 3c2b1e6 commit ad5f764
Show file tree
Hide file tree
Showing 19 changed files with 779 additions and 803 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,21 @@
using MyCSharp.HttpUserAgentParser.DependencyInjection;
using MyCSharp.HttpUserAgentParser.Providers;

namespace MyCSharp.HttpUserAgentParser.AspNetCore.DependencyInjection
namespace MyCSharp.HttpUserAgentParser.AspNetCore.DependencyInjection;

/// <summary>
/// Dependency injection extensions for ASP.NET Core environments
/// </summary>
public static class HttpUserAgentParserDependencyInjectionOptionsExtensions
{
/// <summary>
/// Dependency injection extensions for ASP.NET Core environments
/// Registers <see cref="HttpUserAgentParserAccessor"/> as <see cref="IHttpUserAgentParserAccessor"/>.
/// Requires a registered <see cref="IHttpUserAgentParserProvider"/>
/// </summary>
public static class HttpUserAgentParserDependencyInjectionOptionsExtensions
public static HttpUserAgentParserDependencyInjectionOptions AddHttpUserAgentParserAccessor(
this HttpUserAgentParserDependencyInjectionOptions options)
{
/// <summary>
/// Registers <see cref="HttpUserAgentParserAccessor"/> as <see cref="IHttpUserAgentParserAccessor"/>.
/// Requires a registered <see cref="IHttpUserAgentParserProvider"/>
/// </summary>
public static HttpUserAgentParserDependencyInjectionOptions AddHttpUserAgentParserAccessor(
this HttpUserAgentParserDependencyInjectionOptions options)
{
options.Services.AddSingleton<IHttpUserAgentParserAccessor, HttpUserAgentParserAccessor>();
return options;
}
options.Services.AddSingleton<IHttpUserAgentParserAccessor, HttpUserAgentParserAccessor>();
return options;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,36 @@
using Microsoft.AspNetCore.Http;
using MyCSharp.HttpUserAgentParser.Providers;

namespace MyCSharp.HttpUserAgentParser.AspNetCore
namespace MyCSharp.HttpUserAgentParser.AspNetCore;

/// <summary>
/// User Agent parser accessor. Implements <see cref="IHttpContextAccessor.HttpContext"/>
/// </summary>
/// <remarks>
/// Creates a new instance of <see cref="HttpUserAgentParserAccessor"/>
/// </remarks>
public class HttpUserAgentParserAccessor(IHttpUserAgentParserProvider httpUserAgentParser)
: IHttpUserAgentParserAccessor
{
private readonly IHttpUserAgentParserProvider _httpUserAgentParser = httpUserAgentParser;

/// <summary>
/// User Agent parser accessor
/// User agent of current <see cref="IHttpContextAccessor"/>
/// </summary>
public interface IHttpUserAgentParserAccessor
{
/// <summary>
/// User agent value
/// </summary>
string? GetHttpContextUserAgent(HttpContext httpContext);

/// <summary>
/// Returns current <see cref="HttpUserAgentInformation"/>
/// </summary>
HttpUserAgentInformation? Get(HttpContext httpContext);
}
public string? GetHttpContextUserAgent(HttpContext httpContext)
=> httpContext.GetUserAgentString();

/// <summary>
/// User Agent parser accessor. Implements <see cref="IHttpContextAccessor.HttpContext"/>
/// Returns current <see cref="HttpUserAgentInformation"/> of current <see cref="IHttpContextAccessor"/>
/// </summary>
public class HttpUserAgentParserAccessor : IHttpUserAgentParserAccessor
public HttpUserAgentInformation? Get(HttpContext httpContext)
{
private readonly IHttpUserAgentParserProvider _httpUserAgentParser;

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserAccessor"/>
/// </summary>
public HttpUserAgentParserAccessor(IHttpUserAgentParserProvider httpUserAgentParser)
string? httpUserAgent = GetHttpContextUserAgent(httpContext);
if (string.IsNullOrEmpty(httpUserAgent))
{
_httpUserAgentParser = httpUserAgentParser;
return null;
}

/// <summary>
/// User agent of current <see cref="IHttpContextAccessor"/>
/// </summary>
public string? GetHttpContextUserAgent(HttpContext httpContext)
=> httpContext.GetUserAgentString();

/// <summary>
/// Returns current <see cref="HttpUserAgentInformation"/> of current <see cref="IHttpContextAccessor"/>
/// </summary>
public HttpUserAgentInformation? Get(HttpContext httpContext)
{
string? httpUserAgent = GetHttpContextUserAgent(httpContext);
if (string.IsNullOrEmpty(httpUserAgent))
{
return null;
}

return _httpUserAgentParser.Parse(httpUserAgent);
}
return _httpUserAgentParser.Parse(httpUserAgent);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright © myCSharp.de - all rights reserved

using Microsoft.AspNetCore.Http;

namespace MyCSharp.HttpUserAgentParser.AspNetCore;

/// <summary>
/// User Agent parser accessor
/// </summary>
public interface IHttpUserAgentParserAccessor
{
/// <summary>
/// User agent value
/// </summary>
string? GetHttpContextUserAgent(HttpContext httpContext);

/// <summary>
/// Returns current <see cref="HttpUserAgentInformation"/>
/// </summary>
HttpUserAgentInformation? Get(HttpContext httpContext);
}
Original file line number Diff line number Diff line change
@@ -1,65 +1,58 @@
// Copyright © myCSharp.de - all rights reserved

using System;
using Microsoft.Extensions.Caching.Memory;
using MyCSharp.HttpUserAgentParser.Providers;

namespace MyCSharp.HttpUserAgentParser.MemoryCache
namespace MyCSharp.HttpUserAgentParser.MemoryCache;

/// <inheritdoc/>
/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProvider"/>.
/// </summary>
/// <param name="options">The options used to set expiration and size limit</param>
public class HttpUserAgentParserMemoryCachedProvider(
HttpUserAgentParserMemoryCachedProviderOptions options) : IHttpUserAgentParserProvider
{
private readonly Microsoft.Extensions.Caching.Memory.MemoryCache _memoryCache = new(options.CacheOptions);
private readonly HttpUserAgentParserMemoryCachedProviderOptions _options = options;

/// <inheritdoc/>
public class HttpUserAgentParserMemoryCachedProvider : IHttpUserAgentParserProvider
public HttpUserAgentInformation Parse(string userAgent)
{
private readonly Microsoft.Extensions.Caching.Memory.MemoryCache _memoryCache;
private readonly HttpUserAgentParserMemoryCachedProviderOptions _options;

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProvider"/>.
/// </summary>
/// <param name="options">The options used to set expiration and size limit</param>
public HttpUserAgentParserMemoryCachedProvider(HttpUserAgentParserMemoryCachedProviderOptions options)
{
_memoryCache = new Microsoft.Extensions.Caching.Memory.MemoryCache(options.CacheOptions);
_options = options;
}
CacheKey key = this.GetKey(userAgent);

/// <inheritdoc/>
public HttpUserAgentInformation Parse(string userAgent)
return _memoryCache.GetOrCreate(key, static entry =>
{
CacheKey key = this.GetKey(userAgent);

return _memoryCache.GetOrCreate(key, static entry =>
{
CacheKey key = (entry.Key as CacheKey)!;
entry.SlidingExpiration = key.Options.CacheEntryOptions.SlidingExpiration;
entry.SetSize(1);
CacheKey key = (entry.Key as CacheKey)!;
entry.SlidingExpiration = key.Options.CacheEntryOptions.SlidingExpiration;
entry.SetSize(1);

return HttpUserAgentParser.Parse(key.UserAgent);
});
}
return HttpUserAgentParser.Parse(key.UserAgent);
});
}

[ThreadStatic]
private static CacheKey? s_tKey;
[ThreadStatic]
private static CacheKey? s_tKey;

private CacheKey GetKey(string userAgent)
{
CacheKey key = s_tKey ??= new CacheKey();
private CacheKey GetKey(string userAgent)
{
CacheKey key = s_tKey ??= new CacheKey();

key.UserAgent = userAgent;
key.Options = _options;
key.UserAgent = userAgent;
key.Options = _options;

return key;
}
return key;
}

private class CacheKey : IEquatable<CacheKey> // required for IMemoryCache
{
public string UserAgent { get; set; } = null!;
private class CacheKey : IEquatable<CacheKey> // required for IMemoryCache
{
public string UserAgent { get; set; } = null!;

public HttpUserAgentParserMemoryCachedProviderOptions Options { get; set; } = null!;
public HttpUserAgentParserMemoryCachedProviderOptions Options { get; set; } = null!;

public bool Equals(CacheKey? other) => this.UserAgent == other?.UserAgent;
public override bool Equals(object? obj) => this.Equals(obj as CacheKey);
public bool Equals(CacheKey? other) => this.UserAgent == other?.UserAgent;
public override bool Equals(object? obj) => this.Equals(obj as CacheKey);

public override int GetHashCode() => this.UserAgent.GetHashCode();
}
public override int GetHashCode() => this.UserAgent.GetHashCode();
}
}
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
// Copyright © myCSharp.de - all rights reserved

using System;
using Microsoft.Extensions.Caching.Memory;

namespace MyCSharp.HttpUserAgentParser.MemoryCache
namespace MyCSharp.HttpUserAgentParser.MemoryCache;

/// <summary>
/// Provider options for <see cref="HttpUserAgentParserMemoryCachedProvider"/>
/// <remarks>
/// Default of <seealso cref="MemoryCacheOptions.SizeLimit"/> is 256.
/// Default of <seealso cref="MemoryCacheEntryOptions.SlidingExpiration"/> is 1 day
/// </remarks>
/// </summary>
public class HttpUserAgentParserMemoryCachedProviderOptions
{
/// <summary>
/// Provider options for <see cref="HttpUserAgentParserMemoryCachedProvider"/>
/// <remarks>
/// Default of <seealso cref="MemoryCacheOptions.SizeLimit"/> is 256.
/// Default of <seealso cref="MemoryCacheEntryOptions.SlidingExpiration"/> is 1 day
/// </remarks>
/// Cache options
/// </summary>
public MemoryCacheOptions CacheOptions { get; }

/// <summary>
/// Cache entry options
/// </summary>
public class HttpUserAgentParserMemoryCachedProviderOptions
public MemoryCacheEntryOptions CacheEntryOptions { get; }

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
/// </summary>
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheOptions cacheOptions)
: this(cacheOptions, null) { }

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
/// </summary>
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheEntryOptions cacheEntryOptions)
: this(null, cacheEntryOptions) { }

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
/// </summary>
public HttpUserAgentParserMemoryCachedProviderOptions(
MemoryCacheOptions? cacheOptions = null, MemoryCacheEntryOptions? cacheEntryOptions = null)
{
/// <summary>
/// Cache options
/// </summary>
public MemoryCacheOptions CacheOptions { get; }

/// <summary>
/// Cache entry options
/// </summary>
public MemoryCacheEntryOptions CacheEntryOptions { get; }

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
/// </summary>
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheOptions cacheOptions)
: this(cacheOptions, null) { }

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
/// </summary>
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheEntryOptions cacheEntryOptions)
: this(null, cacheEntryOptions) { }

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
/// </summary>
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheOptions? cacheOptions = null, MemoryCacheEntryOptions? cacheEntryOptions = null)
this.CacheEntryOptions = cacheEntryOptions ?? new MemoryCacheEntryOptions
{
// defaults
SlidingExpiration = TimeSpan.FromDays(1)
};

this.CacheOptions = cacheOptions ?? new MemoryCacheOptions
{
this.CacheEntryOptions = cacheEntryOptions ?? new MemoryCacheEntryOptions
{
// defaults
SlidingExpiration = TimeSpan.FromDays(1)
};
this.CacheOptions = cacheOptions ?? new MemoryCacheOptions
{
// defaults
SizeLimit = 256
};
}
// defaults
SizeLimit = 256
};
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@

using Microsoft.Extensions.DependencyInjection;

namespace MyCSharp.HttpUserAgentParser.DependencyInjection
namespace MyCSharp.HttpUserAgentParser.DependencyInjection;

/// <summary>
/// Options for dependency injection
/// </summary>
public class HttpUserAgentParserDependencyInjectionOptions
{
/// <summary>
/// Options for dependency injection
/// Services container
/// </summary>
public class HttpUserAgentParserDependencyInjectionOptions
{
/// <summary>
/// Services container
/// </summary>
public IServiceCollection Services { get; }
public IServiceCollection Services { get; }

/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserDependencyInjectionOptions"/>
/// </summary>
/// <param name="services"></param>
public HttpUserAgentParserDependencyInjectionOptions(IServiceCollection services)
{
Services = services;
}
/// <summary>
/// Creates a new instance of <see cref="HttpUserAgentParserDependencyInjectionOptions"/>
/// </summary>
/// <param name="services"></param>
public HttpUserAgentParserDependencyInjectionOptions(IServiceCollection services)
{
Services = services;
}
}
Loading

0 comments on commit ad5f764

Please sign in to comment.