Forked from apiDiff.
A tool to identify API breaking changes between two versions of a Java library. apiTimeLife analyses libraries hosted on the distributed version control system git.
The project has been maintained by Francisco Handrick under supervision of Professor Rodrigo Bonifácio (CIC UNB).
The following Breaking Changes (BC) are supported:
| Element | Breaking Changes (BC) |
|---|---|
| Method | Move Method, Rename Method, Remove Method, Push Down Method, Inline Method, Change in Parameter List, Change in Exception List, Change in Return Type Method, Lost Visibility, Add Final Modifier, Remove Static Modifier |
The refactorings catalog is reused from apiDiff.
- Detecting changes in all versions in a CSV file:
String csvFile = "googleTinkcommits.csv";
String prologFile = "googletink";
APITimeLine diff = new APITimeLine("google/tink", "https://github.com/google/tink.git");
diff.setPath("/home/francisco/github");
diff.createPrologFile(csvFile,prologFile);- CSV File and one of the final Prolog file :
2ec8d120b70290766ea34333ec2dace5795ad5bb
f2df5dfbe6e3112c758a67eab4e3d8c4aa864304
bbe5e49ab9a999acfeea0965d6b7aacc3de08520
359f3cec5efce26fe0a56ec35965945936dbb104
e76fa741bd25114a34e690911ddd2501670458a8
068112c13712e04ca035d7232873ca0a3e60d0a6
7e4426207f60a6657a3a8fd1672cd8fbe01334c4
99edf8dfe462bff711095d881c00fcd3cb2da224
/* facts */
/* metohod(1... - Move Method */
/* metohod(2... - Rename Method */
/* metohod(3... - Remove Method */
/* metohod(4... - Push Down Method */
/* metohod(5... - Inline Method */
/* metohod(6... - Change in Parameter List Method */
/* metohod(7... - Change in Exception LIst Method*/
/* metohod(8... - Change in Return TYpe Method */
/* metohod(9... - Lost Visibility Method */
/* metohod(10... - Add Final Modifier */
/* metohod(11... - Remove Static Modifier */
method(7,"EcdsaSignJce(final ECPrivateKey priv, String signatureAlgorithm, EcdsaEncoding encoding)","com.google.crypto.tink.subtle.EcdsaSignJce").
method(3,"EcdsaSignJce(final ECPrivateKey priv, String signatureAlgorithm)","com.google.crypto.tink.subtle.EcdsaSignJce").
method(3,"EcdsaVerifyJce(final ECPublicKey pubKey, String signatureAlgorithm)","com.google.crypto.tink.subtle.EcdsaVerifyJce").
- Filtering Packages according to their names:
Classifier.INTERNAL: Elements that are in packages with the term "internal".
Classifier.TEST: Elements that are in packages with the terms "test"|"tests", or is in source file "src/test", or ends with "test.java"|"tests.java".
Classifier.EXAMPLE: Elements that are in packages with the terms "example"|"examples"|"sample"|"samples"|"demo"|"demos"
Classifier.EXPERIMENTAL: Elements that are in packages with the term "experimental".
Classifier.NON_API: Internal, test, example or experimental elements.
Classifier.API: Elements that are not non-APIs.APITimeLife is available in the Maven Central Repository:
<dependency>
<groupId>com.github.fhandrick</groupId>
<artifactId>apiTimeLIfe</artifactId>
<version>1.0.0</version>
</dependency>