How kijuky/enumeratum-scalikejdbc works
Main Components
• Module Specific Implementations: There are three clear modules:
• enumeratum-scalikejdbc35 (for scalikejdbc 3.5.0, mainly Play 2.8/2.9 with Scala2)
• enumeratum-scalikejdbc4 (for scalikejdbc 4.0.x, mainly Play2.9/Scala3)
• enumeratum-scalikejdbc43 (for scalikejdbc 4.3.x, mainly Play 3.0/Scala3)
• Test Suites for Each Module: Each module contains its own tests (in the src/test directories) to ensure correct behavior for each version.
Relationships and Interactions
• Each module is essentially a variant of the same functionality, but separated to choose the right artifact based on the scalikejdbc version.
• The modules depend on external libraries:
• The enumeratum library itself, which provides the enumeration definitions and helper methods like findValues.
• The scalikejdbc library, which is used for the actual JDBC operations and which consumes the custom type binders provided by this library.
Architectural Patterns and Design Principles
• Modularity: The project is modularized into different subdirectories (modules) for different scalikejdbc versions. This separation emphasizes the Single Responsibility Principle for compatibility.
• Extension/Integration: The design uses Scala’s object and trait mechanisms to extend enumeratum functionality. The companion objects and the provided factory methods for type binders hint at a plug-in style integration.
• Testing: A robust test suite exists for each module, reinforcing TDD and ensuring each module behaves as expected across different Scala versions.
Relevant Technologies and Frameworks
• Scala as the programming language.
• SBT for build configuration (noted by build.sbt, project/ directory, and version files).
• External libraries: enumeratum and scalikejdbc.