Skip to content
This repository has been archived by the owner on Jul 14, 2020. It is now read-only.

Commit

Permalink
Publish first version.
Browse files Browse the repository at this point in the history
  • Loading branch information
jan0sch committed Jun 29, 2017
1 parent 75eefdf commit a0e3ba2
Show file tree
Hide file tree
Showing 45 changed files with 4,622 additions and 0 deletions.
12 changes: 12 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Corporate Contributors
======================

- Copyright (c) 2014 - 2015 Wegtam UG (haftungsbeschränkt)
- Copyright (c) 2015 - 2017 Wegtam GmbH

Individual Contributors
=======================

- Jens Grassel
- André Schütz

26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# ChangeLog for the DFASDL utils package

All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Conventions when editing this file.

Please follow the listed conventions when editing this file:

* one subsection per version
* reverse chronological order (latest entry on top)
* write all dates in iso notation (`YYYY-MM-DD`)
* each version should group changes according to their impact:
* `Added` for new features.
* `Changed` for changes in existing functionality.
* `Deprecated` for once-stable features removed in upcoming releases.
* `Removed` for deprecated features removed in this release.
* `Fixed` for any bug fixes.
* `Security` to invite users to upgrade in case of vulnerabilities.

## Unreleased

## 1.0.0 (2017-06-29)

- initial public release

45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contribution Guide

This project has adopted the [Collective Code Construction Contract
(C4.2)](https://rfc.zeromq.org/spec:42) for contributing. Please read it
before sending patches.

Everyone is expected to follow the
[Scala Code of Conduct](http://www.scala-lang.org/conduct.html) when
dicussing the project on the available communication channels.
If you are being harassed, please contact us immediately so that we can
support you.

### Additions to C4.2

1. This project is licensed under GNU Affero General Public License 3.
See [LICENSE](LICENSE) for details.

2. Contributors are listed in the file [AUTHORS.md](AUTHORS.md). Add
yourself if you have contributed.

3. Please maintain the existing code style and try to keep your commits
small and focused. The project follows the at large the
[Scala Style Guide](http://docs.scala-lang.org/style/). Code is formatted
using [scalafmt](http://scalameta.org/scalafmt/) upon compilation. You
may also use a scalafmt plugin for your favourite editor/IDE.

4. Please rebase your branch if the project diverges from your branch.

5. Before a pull request is merged the commits done on the feature branch
SHOULD be squashed into a single commit.

6. Changes are documented in the file [CHANGELOG.md](CHANGELOG.md). Please
use the section `Unreleased` to note your changes.

## Release Guide

The changes in the section `Unreleased` in the [CHANGELOG.md](CHANGELOG.md)
file MUST be moved to a section named after the release and a new empty
`Unreleased` section MUST be created.

A release SHALL be accompanied by an annotated and signed tag
(`git tag -as NAME`) that holds a description of the changes that are
included in the release. This description SHOULD be same as in the file
[CHANGELOG.md](CHANGELOG.md).

661 changes: 661 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# DFASDL Utils

[ ![Download](https://api.bintray.com/packages/wegtam/dfasdl/dfasdl-utils/images/download.svg) ](https://bintray.com/wegtam/dfasdl/dfasdl-utils/_latestVersion)

The DFASDL is a language based upon [XML
Schema](http://www.w3.org/XML/Schema) that can be used to describe data
formats and additionally the semantics of it.

It is used by the Tensei-Data project to describe data structures and to
derive mappings and transformation functions between different structures
automatically.

This repository contains the utils module which provides helpful functions
and data types. It depends on the dfasdl-core package.

It is cross build for scala 2.11 and 2.12.

Releases are published on bintray and should be synced to maven central.

The api documentation is published using github pages and is available
online at: https://dfasdl.github.io/dfasdl-utils/

## System requirements

* Java 8
* Scala 2.12
* sbt

### Documentation

The documentation is generated via the sbt-site plugin. Use the `makeSite`
task in sbt to generate it.

### Tests

To execute the tests run the `test` task in sbt. Tests will be
automatically run before publishing.

### Benchmarks

The project includes benchmarks which can be run via sbt:

```text
> benchmarks/jmh:clean
...
> benchmarks/jmh:compile
...
> benchmarks/jmh:run -i 10 -wi 4 -f3 -t1
...
```

Be sure to compile the whole project before.

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
* Copyright (C) 2014 - 2017 Contributors as noted in the AUTHORS.md file
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

package org.dfasdl.utils.benchmarks

import org.dfasdl.utils.DataElementExtractors
import org.openjdk.jmh.annotations._

@State(Scope.Thread)
class DataElementExtractorsBenchmark extends DataElementExtractors {

}
Loading

0 comments on commit a0e3ba2

Please sign in to comment.