diff --git a/.gitignore b/.gitignore index 82f1ad5..0bbd4a9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +/docs/ /lib/ /bin/ /.shards/ diff --git a/CHANGELOG.md b/CHANGELOG.md index d54ee29..a542e3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,5 @@ # Changelog -## [0.1.5] - 2024-04-09 - -### Changed - -- Integrate website into monorepo ([#365](https://github.com/athena-framework/athena/pull/365)) (George Dietrich) - ## [0.1.4] - 2023-10-09 _Administrative release, no functional changes_ @@ -43,7 +37,6 @@ _First release a part of the monorepo._ _Initial release._ -[0.1.5]: https://github.com/athena-framework/negotiation/releases/tag/v0.1.5 [0.1.4]: https://github.com/athena-framework/negotiation/releases/tag/v0.1.4 [0.1.3]: https://github.com/athena-framework/negotiation/releases/tag/v0.1.3 [0.1.2]: https://github.com/athena-framework/negotiation/releases/tag/v0.1.2 diff --git a/README.md b/README.md index 6a1e9e4..51b81a6 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,23 @@ Framework agnostic [content negotiation](https://tools.ietf.org/html/rfc7231#section-5.3) library based on [willdurand/Negotiation](https://github.com/willdurand/Negotiation). -## Getting Started +## Installation -Checkout the [Documentation](https://athenaframework.org/Negotiation). +1. Add the dependency to your `shard.yml`: + +```yaml +dependencies: + athena-negotiation: + github: athena-framework/negotiation + version: ~> 0.1.0 +``` + +2. Run `shards install` + +## Documentation + +If using the component on its own, checkout the [API documentation](https://athenaframework.org/Negotiation). +If using the component as part of Athena, also checkout the [external documentation](https://athenaframework.org/architecture/negotiation). ## Contributing diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 94b03ef..0000000 --- a/docs/README.md +++ /dev/null @@ -1,83 +0,0 @@ -The `Athena::Negotiation` component allows an application to support [content negotiation](https://tools.ietf.org/html/rfc7231#section-5.3). -The component has no dependencies and is framework agnostic; supporting various negotiators. - -## Installation - -First, install the component by adding the following to your `shard.yml`, then running `shards install`: - -```yaml -dependencies: - athena-negotiation: - github: athena-framework/negotiation - version: ~> 0.1.0 -``` - -## Usage - -The main type of [Athena::Negotiation][] is [ANG::AbstractNegotiator][] which is used to implement negotiators for each `Accept*` header. -`Athena::Negotiation` exposes class level getters for each negotiator; that return a lazily initialized singleton instance. -Each negotiator exposes two methods: [ANG::AbstractNegotiator#best][] and [ANG::AbstractNegotiator#ordered_elements][]. - -### Media Type - -```crystal -negotiator = ANG.negotiator - -accept_header = "text/html, application/xhtml+xml, application/xml;q=0.9" -priorities = ["text/html; charset=utf-8", "application/json", "application/xml;q=0.5"] - -accept = negotiator.best(accept_header, priorities).not_nil! - -accept.media_range # => "text/html" -accept.parameters # => {"charset" => "utf-8"} -``` - -The [ANG::Negotiator][] type returns an [ANG::Accept][], or `nil` if negotiating the best media type has failed. - -### Character Set - -```crystal -negotiator = ANG.charset_negotiator - -accept_header = "ISO-8859-1, utf-8; q=0.9" -priorities = ["iso-8859-1;q=0.3", "utf-8;q=0.9", "utf-16;q=1.0"] - -accept = negotiator.best(accept_header, priorities).not_nil! - -accept.charset # => "utf-8" -accept.quality # => 0.9 -``` - -The [ANG::CharsetNegotiator][] type returns an [ANG::AcceptCharset][], or `nil` if negotiating the best character set has failed. - -### Encoding - -```crystal -negotiator = ANG.encoding_negotiator - -accept_header = "gzip;q=1.0, identity; q=0.5, *;q=0" -priorities = ["gzip", "foo"] - -accept = negotiator.best(accept_header, priorities).not_nil! - -accept.coding # => "gzip" -``` - -The [ANG::EncodingNegotiator][] type returns an [ANG::AcceptEncoding][], or `nil` if negotiating the best encoding has failed. - -### Language - -```crystal -negotiator = ANG.language_negotiator - -accept_header = "en; q=0.1, fr; q=0.4, zh-Hans-CN; q=0.9, de; q=0.2" -priorities = ["de", "zh-Hans-CN", "en"] - -accept = negotiator.best(accept_header, priorities).not_nil! - -accept.language # => "zh" -accept.region # => "cn" -accept.script # => "hans" -``` - -The [ANG::LanguageNegotiator][] type returns an [ANG::AcceptLanguage][], or `nil` if negotiating the best language has failed. diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 08ced2d..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,31 +0,0 @@ -INHERIT: ../../../mkdocs-common.yml - -site_name: Negotiation -site_url: https://athenaframework.org/Negotiation/ -repo_url: https://github.com/athena-framework/negotiation - -nav: - - Introduction: README.md - - Back to Manual: project://. - - API: - - Aliases: aliases.md - - Top Level: top_level.md - - '*' - -plugins: - - search - - section-index - - literate-nav - - gen-files: - scripts: - - ../../../gen_doc_stubs.py - - mkdocstrings: - default_handler: crystal - custom_templates: ../../../docs/templates - handlers: - crystal: - crystal_docs_flags: - - ./docs/index.cr - - ./lib/athena-negotiation/src/athena-negotiation.cr - source_locations: - lib/athena-negotiation: https://github.com/athena-framework/negotiation/blob/v{shard_version}/{file}#L{line} diff --git a/shard.yml b/shard.yml index b15ac1f..1902808 100644 --- a/shard.yml +++ b/shard.yml @@ -1,6 +1,6 @@ name: athena-negotiation -version: 0.1.5 +version: 0.1.4 crystal: ~> 1.4 @@ -14,4 +14,4 @@ description: | Framework agnostic content negotiation library. authors: - - George Dietrich + - George Dietrich diff --git a/spec/negotiator_spec.cr b/spec/negotiator_spec.cr index 353942d..f267d92 100644 --- a/spec/negotiator_spec.cr +++ b/spec/negotiator_spec.cr @@ -71,9 +71,9 @@ struct NegotiatorTest < NegotiatorTestCase {"image/png, text/plain, audio/ogg", {"baz/asdf"}, nil}, {"image/png, text/plain, audio/ogg", {"audio/ogg"}, {"audio/ogg", nil}}, {"image/png, text/plain, audio/ogg", {"YO/SuP"}, nil}, - {"text/html; charset=utf-8, application/pdf", {"text/html; charset=utf-8"}, {"text/html", {"charset" => "utf-8"}}}, - {"text/html; charset=utf-8, application/pdf", {"text/html"}, nil}, - {"text/html, application/pdf", {"text/html; charset=utf-8"}, {"text/html", {"charset" => "utf-8"}}}, + {"text/html; charset=UTF-8, application/pdf", {"text/html; charset=UTF-8"}, {"text/html", {"charset" => "UTF-8"}}}, + {"text/html; charset=UTF-8, application/pdf", {"text/html"}, nil}, + {"text/html, application/pdf", {"text/html; charset=UTF-8"}, {"text/html", {"charset" => "UTF-8"}}}, # PHP"s PEAR HTTP2 assertions I took from the other lib. {php_pear_header, {"image/gif", "image/png", "application/xhtml+xml", "application/xml", "text/html", "image/jpeg", "text/plain"}, {"image/png", nil}}, diff --git a/src/abstract_negotiator.cr b/src/abstract_negotiator.cr index 1bddf8c..0f67a51 100644 --- a/src/abstract_negotiator.cr +++ b/src/abstract_negotiator.cr @@ -26,9 +26,9 @@ abstract class Athena::Negotiation::AbstractNegotiator(HeaderType) raise ex if strict end - accepted_priorities = priorities.map { |p| HeaderType.new p } + accepted_priorties = priorities.map { |p| HeaderType.new p } - matches = self.find_matches accepted_headers, accepted_priorities + matches = self.find_matches accepted_headers, accepted_priorties specific_matches = matches.reduce({} of Int32 => ANG::AcceptMatch) do |acc, match| ANG::AcceptMatch.reduce acc, match @@ -38,7 +38,7 @@ abstract class Athena::Negotiation::AbstractNegotiator(HeaderType) match = specific_matches.shift? - match.nil? ? nil : accepted_priorities[match.index] + match.nil? ? nil : accepted_priorties[match.index] end # Returns an array of `HeaderType` that the provided *header* allows, ordered so that the `#best` match is first. diff --git a/src/accept.cr b/src/accept.cr index d69e91a..8a4b6df 100644 --- a/src/accept.cr +++ b/src/accept.cr @@ -3,11 +3,11 @@ require "./base_accept" # Represents an [Accept](https://tools.ietf.org/html/rfc7231#section-5.3.2) header media type. # # ``` -# accept = ANG::Accept.new "application/json; q = 0.75; charset = utf-8" +# accept = ANG::Accept.new "application/json; q = 0.75; charset = UTF-8" # -# accept.header # => "application/json; q = 0.75; charset = utf-8" -# accept.normalized_header # => "application/json; charset=utf-8" -# accept.parameters # => {"charset" => "utf-8"} +# accept.header # => "application/json; q = 0.75; charset = UTF-8" +# accept.normalized_header # => "application/json; charset=UTF-8" +# accept.parameters # => {"charset" => "UTF-8"} # accept.quality # => 0.75 # accept.type # => "application" # accept.sub_type # => "json" diff --git a/src/athena-negotiation.cr b/src/athena-negotiation.cr index 12ddf3a..db3d0da 100644 --- a/src/athena-negotiation.cr +++ b/src/athena-negotiation.cr @@ -14,8 +14,95 @@ require "./exceptions/*" alias ANG = Athena::Negotiation # The `Athena::Negotiation` component allows an application to support [content negotiation](https://tools.ietf.org/html/rfc7231#section-5.3). +# The component has no dependencies and is framework agnostic; supporting various negotiators. +# +# ## Getting Started +# +# If using this component within the [Athena Framework][Athena::Framework], it is already installed and required for you. +# Checkout the [manual](../architecture/negotiation.md) for some additional information on how to use it within the framework. +# +# If using it outside of the framework, you will first need to add it as a dependency: +# +# ```yaml +# dependencies: +# athena-negotiation: +# github: athena-framework/negotiation +# version: ~> 0.1.0 +# ``` +# +# Then run `shards install`, being sure to require it via `require "athena-negotiation"`. +# +# ## Usage +# +# The main type of `Athena::Negotiation` is `ANG::AbstractNegotiator` which is used to implement negotiators for each `Accept*` header. +# `Athena::Negotiation` exposes class level getters for each negotiator; that return a lazily initialized singleton instance. +# Each negotiator exposes two methods: `ANG::AbstractNegotiator#best` and `ANG::AbstractNegotiator#ordered_elements`. +# +# ### Media Type +# +# ``` +# negotiator = ANG.negotiator +# +# accept_header = "text/html, application/xhtml+xml, application/xml;q=0.9" +# priorities = ["text/html; charset=UTF-8", "application/json", "application/xml;q=0.5"] +# +# accept = negotiator.best(accept_header, priorities).not_nil! +# +# accept.media_range # => "text/html" +# accept.parameters # => {"charset" => "UTF-8"} +# ``` +# +# The `ANG::Negotiator` type returns an `ANG::Accept`, or `nil` if negotiating the best media type has failed. +# +# ### Character Set +# +# ``` +# negotiator = ANG.charset_negotiator +# +# accept_header = "ISO-8859-1, UTF-8; q=0.9" +# priorities = ["iso-8859-1;q=0.3", "utf-8;q=0.9", "utf-16;q=1.0"] +# +# accept = negotiator.best(accept_header, priorities).not_nil! +# +# accept.charset # => "utf-8" +# accept.quality # => 0.9 +# ``` +# +# The `ANG::CharsetNegotiator` type returns an `ANG::AcceptCharset`, or `nil` if negotiating the best character set has failed. +# +# ### Encoding +# +# ``` +# negotiator = ANG.encoding_negotiator +# +# accept_header = "gzip;q=1.0, identity; q=0.5, *;q=0" +# priorities = ["gzip", "foo"] +# +# accept = negotiator.best(accept_header, priorities).not_nil! +# +# accept.coding # => "gzip" +# ``` +# +# The `ANG::EncodingNegotiator` type returns an `ANG::AcceptEncoding`, or `nil` if negotiating the best encoding has failed. +# +# ### Language +# +# ``` +# negotiator = ANG.language_negotiator +# +# accept_header = "en; q=0.1, fr; q=0.4, zh-Hans-CN; q=0.9, de; q=0.2" +# priorities = ["de", "zh-Hans-CN", "en"] +# +# accept = negotiator.best(accept_header, priorities).not_nil! +# +# accept.language # => "zh" +# accept.region # => "cn" +# accept.script # => "hans" +# ``` +# +# The `ANG::LanguageNegotiator` type returns an `ANG::AcceptLanguage`, or `nil` if negotiating the best language has failed. module Athena::Negotiation - VERSION = "0.1.5" + VERSION = "0.1.4" # Returns a lazily initialized `ANG::Negotiator` singleton instance. class_getter(negotiator) { ANG::Negotiator.new } diff --git a/src/base_accept.cr b/src/base_accept.cr index b9e02b8..f11d50e 100644 --- a/src/base_accept.cr +++ b/src/base_accept.cr @@ -10,7 +10,7 @@ abstract struct Athena::Negotiation::BaseAccept getter normalized_header : String # Returns any extension parameters included in the header `self` represents. - # E.x. `charset=utf-8` or `version=2`. + # E.x. `charset=UTF-8` or `version=2`. getter parameters : Hash(String, String) = Hash(String, String).new # Returns the [quality value](https://tools.ietf.org/html/rfc7231#section-5.3.1) of the header `self` represents.