Rewrite

[Blacksmoke16]

CLI

• Removed this
  • Will be reimplemented in another shard in a future PR

Config

• Common configuration logic will now reside in https://github.com/athena-framework/config
  • Defines the base config type
    • Components that require configuration should reopen the type to add to it
      • Athena::Routing::Config and Athena::Routing::Config::Cors is an example of this
    • A module is provided to make this a bit easier
      • Includes the required modules and defines the required methods
  • Defines the ConfigurationResolver service
    • Allows a component's configuration to be resolved from within a service
      • Aids testing
      • Abstracts where/how the configuration comes from/is obtained
    • Configuration types that should be resolvable should reopen the type and add a #resolve(_type) method typed to that object

DI

• DI is now its own independent shard https://github.com/athena-framework/di
  • Rename ServiceContainer#has to ServiceContainer#has?
  • Merge StructService and ClassService into a Service module now that Add method to get an array of types a module is directly included in crystal-lang/crystal#8133 is released
    • Allows for making types services while avoid superclass mismatch errors
  • Support optional services
    • Will inject the service with that named if it's registered, otherwise nil
  • Support referencing services within an array
    • Allows injecting a static array of services, versus all tagged

Routing

• Replaced HTTP::Handler architecture with an event dispatcher observer/mediator pattern.
  • https://github.com/athena-framework/event-dispatcher
• Switch controllers back to classes again
  • Required since injected services can be mutated after the proc is created. See Invalid memory access (signal 11) at address 0x841f13 crystal-lang/crystal#8584
• Strip some of the complexity from the routing code
  • Switches the goals of Athena to start off simple as a JSON REST API framework, adding in features as needed versus to handle everything at once.
  • Removes some compile time errors that aren't worth the complexity
    • Mainly just if a route param was defined but is missing from the action arguments
  • Removes the built in param converters
• Query parameters are now annotation based versus being included in the route definition
  • Keeps support for regex constraints
• Change how the raw POST body is accessed
  • No longer need an action argument called body
  • Now just type an action argument as HTTP::Request
• Provide access to the raw Response object
  • Just type an action argument as HTTP::Server::Response
• Remove direct dependencies on CrSerializer and Crylog
  • They'll be optional dependencies utilizing optional DI services
• Add a kemal/sinatra style DSL for defining routes
  • Should make defining routes a bit more user friendly
• Move the routing code out from the routing/ directory
  • Renames the main file from routing.cr to athena.cr
• Define a HEAD route for each GET route
• Param converters are now based on a module
  • #convert is not passed the HTTP::Request object in order to be more flexible

TODO

• Reimplement the CORS functionality
  • Possibly as a future PR since it'll require the configuration stuff
• Finish writing specs
• Update docs
  • Update deployment script to build docs for all required athena components