The tests ignored in this commit have been failing for some time--both
under the Maven build and now under the new Gradle build. See
https://travis-ci.org/ethereum/ethereumj/builds/45100679 for an example
CI build that reflects these failures.
Rather than tracking down and fixing each issue, this commit ignores
each of these known failures such that subsequent refactorings and
changes can be made with the benifit of running the tests that do work
and knowing that no new failures have crept in.
Apply Gradle's 'maven' plugin in order to support `./gradlew install`
task, similar to `mvn install` for building and copying artifacts to the
users local ~/.m2 repository.
After porting the build from Maven to Gradle (see prior commits), the
org.ethereum.serpent.ParserGenerator class is no longer necessary as the
configuration of the antlr compiler that happened in this class now
happens directly in build.gradle. This class is thus removed in this
commit.
The plexus FileUtils class introduced by the antlr4 Maven plugin had
also been used in several locations in the codebase, probably just for
reasons of convenience. These uses have been replaced with Spring's
FileSystemUtils in order to allow for dropping the dependency on the
antlr4 Maven plugin entirely.
ethereumj-core depends on elements specific to the JUnit 4.11 API, but (for
reasons that can only be assumed dubious) json-simple:1.1.1 transitively
includes JUnit 4.10. At the command line, Gradle handles this cleanly,
and gives ethereumj-core's direct dependence on 4.11 the precedence it
deserves. However, IDEA gets confused and gives 4.10 precedence. This
change explicitly excludes the transitive dependency from
json-simple->junit:4.10, eliminating the issue completely.
Previously, sources generated from the serpent antlr grammar in
ethereumj-core/src/main/antlr4 were output into the build/generated-src
directory by default. This worked from the command line without issue,
but caused issues within IDEA, because the entirety of the 'build'
directory is excluded from compilation by default when working with a
Gradle-based project in IDEA.
This change simplifies the arrangement by writing these antlr-generated
sources to the src/gen/java. A .gitignore file has been added to ensure
that transient source files don't accidentally get checked in. A readme
file has been added to explain the situation to the uninitiated.
Prior to this change, the affected classes had Javadoc containing a url
as the first sentence. There were several issues with this:
- The url used was inconsistent, varying between www.etherj.com,
www.ethereumj.com and www.ethergit.com
- Use of a url in the first sentence of a Javadoc comment is not
consistent with Javadoc idioms. The first sentence should be the
a short, self-contained description--in this case, the description of
the class. If no such description is yet available, it is best to
simply omit all text, leaving any tags (such as @author or @since).
- Information about the project that this code belongs to should be
expressed in the license header for each file. Currently, most files
in ethereumj do not have license headers. This can be added in a
later commit.
- @since is recognized by Javadoc processor; "created on:" is not
- Remove hh:mm information as it is unnecessary
- Replace slashes in dates with dots, e.g. 26/12/2014 => 26.12.2014
- Do not align assignments on equals signs
- Use spaces before opening curly braces
- Add spaces between parameters as necessary
- Insert newlines between method declarations
- Other minor changes
This formatting pass is not comprehensive. For the most part, it does
not deal with Javadoc formatting, line wrapping, parameter alignment
rules or a number of other items that can be addressed later.
Chris Beams
skype me: roman.mandeleil
ligi
alon muroch
Dirk Jäckel