Skip to content

Latest commit

 

History

History
146 lines (104 loc) · 5.13 KB

README.md

File metadata and controls

146 lines (104 loc) · 5.13 KB
Raw

Java CI with Gradle

Introduction to this Commons Project

This project contains general purpose Java utilities for common CAASD's project needs. For example, this project contains:

  1. Literate classes for aviation concepts like: LatLong, Course, Speed, and Distance.
  2. Convenient map drawing capabilities using MapBuilder and MapImage (see more here)
  3. Useful "UUID-like" behaviors in TimeId and SmallTimeId
  4. Curve fitting tools for location data in: Position, KineticPosition, PositionRecord, KineticRecord, and PositionInterpolator
  5. Useful Data-structures: HashedLinkedSequence and MetricTree
  6. Convenience methods for working with flat config files and Properties objects in: PropertyUtils
  7. Classes for streaming data processing via functional programming: DataCleaner, FilteredConsumer, and CompositeConsumer.
  8. Classes for convenient and powerful Exception handling: ExceptionHandler, ErrorCatchingTask, and SequentialFileWriter
  9. Classes for powerful parallelism: Parallelizer
  10. Other general purpose utilities like: Histogram, FileLineIterator, and SingleUseTimer

Documentation by Topic

Users

This project is intended to assist anyone who codes in Java. However, this project was originally developed to "isolate" general purpose Java utilities from the Aviation Risk Identification and Assessment (ARIA) codebase.

Project Aspirations

  • Literate code. Classes should be easy to use. Their behavior should be obvious.
  • Well-tested code. Classes should be dependable.
  • Powerful code. We want to natively support most use cases.
  • As few dependencies as possible.

Early Open Sourcing checklist

  • Reconsider groupId -- Decision change from org.mitre.caasd to org.mitre
    • Execute change!
  • Add "CONTRIBUTION.md" rules
  • Add Roadmap
    • Releasing current Java 8 version
    • Then pivoting to Java 17
    • Removing pair and triple (only in Java 17+)
    • Add LatLongPath
  • Document CI/CD pipeline & strategy for (manually) publishing to maven central
  • (Re)Add code coverage

Tasks

  • Interpolator needs to work across the international date line (e.g. where longitudes have a cliff)

Adopting!

All official releases are available at Maven Central. The latest official release is version: 0.0.55

Gradle

dependencies {
  implementation("org.mitre:commons:0.0.55")
}

Maven

<dependency>
    <groupId>org.mitre</groupId>
    <artifactId>commons</artifactId>
    <version>0.055/version>
</dependency>

Accessing pre-release builds

Users who want to access the unreleased features within a SNAPSHOT build must download and build the source themselves. The build command is:

./gradlew build publishToMavenLocal

Contributing

Contributions are welcomed and encouraged. But please keep in mind the project's goals and our philosophy on dependencies.

Code Formatting

To keep source code formatting consistent this project uses:

  • The spotless build plugin
    • This plugin enforces a global code format during the build step (e.g. incorrect formatting breaks the build).
    • Auto-format your code using: ./gradlew :spotlessApply
  • A checkstyle.xml style sheet.
    • The spotless plugin has priority,
    • The goal of the style sheet is to configure your IDE so the spotless plugin and your IDE mostly agree on formatting

About Dependencies

  • We want the commons library to be hassle-free to use in YOUR java project.
  • Therefore commons:
    • Cannot encumber users by polluting their classpath.
    • Must not leak its dependencies onto downstream class paths.
    • Must not let its dependencies appear as part of the public API.
  • If you notice a violation of this aspiration, please submit an issue. Dependency wrangling is a terrible time sink. We don't want commons contributing to this headache.

Version History

Version 0.0.55

  • Added LatLongPath
  • Added CheckedConsumer and CheckedSupplier
  • Deprecated Pair and Triple because we modern projects should be using java records
  • Now formatting project code with The Palantir Java Formatter
  • Fixed issue with interpolating LatLong data near the international date line

Version 0.0.54

  • The initial public release of the project.

Older Versions

  • Brief release notes from versions that pre-date public-release are available here

Legal Statements

  • Copyright: The contents of this project is copyright The MITRE Corporation. See details here .
  • Open Source License: This project is released under the Apache License Version 2.0. See details here.