rwnx / hardwire Goto Github PK

Now that we're publishing docs over at https://rwnx.github.io/hardwire/ I think we should reformat and document with this in mind.

Suggestions/Improvements:

• The top level modules don't make it clear what the Root namespace is for (it's for documentation!)
• Some of the methods don't give clear examples or expected usage
• Some of the internal workings should be hidden (e.g. REGISTRATIONS should probably be considered private)

Currently the feedback for compile errors is limited to looking at a missing/undefined Type(Tag) or not understanding why something isn't allowed to return a type.

Ideally, I want hardwire to tell you exactly what's wrong as early as possible

Cataloging my thoughts here as a feature request.

Currently Tags are all required to resolve. They're not really that different from a long delimited string.
It would be really cool if we could have more complex Tag combinations, like optionals or OR logic

Ideally we can look at move advanced parsing, brackets, grouping, etc. (primary&red)|(secondary).

There two types I can see:

resolving a union/optional

Resolving X or Y from a container is probably the one that's more useful - I think that could be accomplished by defining a type that includes both signatures. This is probably only possible with macros:

class Tags::Dependency::THISORTHAT
  include Tags::Dependency::THIS
  include Tags::Dependency::THAT
end

# then resolve with the union tag
self.resolve Dependency, Tags::Dependency::THISORTHAT

# This should work in signatures:
# Dependency, "this"
# Dependency, "that"

Registering as optional types

This should be possible with type unions, since tags resolve to actual types.
e.g.

# registering to two different tags -----
register Dependency, "this|that"
# I'm not sure
# output to:

self.resolve(type: Dependency, tag1: Tags::Dependency::THIS | Tags::Dependency::THAT)
end