embulk-filter-protobuf 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +16 -0
- data/LICENSE.txt +21 -0
- data/README.md +160 -0
- data/build.gradle +98 -0
- data/config/checkstyle/checkstyle.xml +128 -0
- data/config/checkstyle/default.xml +108 -0
- data/example/GenerateTestData.java +60 -0
- data/example/addressbook_proto2_syntax.proto +29 -0
- data/example/addressbook_proto3_syntax.proto +29 -0
- data/example/example_deserialize.csv +4 -0
- data/example/example_deserialize.yml +17 -0
- data/example/example_serialize.json +4 -0
- data/example/example_serialize.yml +19 -0
- data/example/generate_jar_from_proto +50 -0
- data/example/generate_test_data +23 -0
- data/gradle/wrapper/gradle-wrapper.jar +0 -0
- data/gradle/wrapper/gradle-wrapper.properties +6 -0
- data/gradlew +160 -0
- data/gradlew.bat +90 -0
- data/lib/embulk/filter/protobuf.rb +3 -0
- data/src/main/java/org/embulk/filter/protobuf/ColumnVisitorImpl.java +264 -0
- data/src/main/java/org/embulk/filter/protobuf/ProtobufFilterPlugin.java +155 -0
- data/src/test/java/org/embulk/filter/protobuf/TestColumnVisitorImpl.java +117 -0
- data/src/test/java/org/embulk/filter/protobuf/TestProtobufFilterPlugin.java +172 -0
- metadata +100 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 63116e07ab593343343b80b23d92b2ae1579f95c
|
4
|
+
data.tar.gz: 3ff516c4db1773e44a0d01bd3bc38d478f66bd2a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 48ee70d7f57710703a6a2a3d286b8983f099467b5dfe611b7457d39785d922205774d65ce6b2925767ceb7c153700c568fbc484fbe5f3d115cf928296d5bbc62
|
7
|
+
data.tar.gz: e14ec3930fca72a67d389a986aabd9160f6097ea601a0fb3004184d0ae1b086c6d9144c0deff7b29f52a67cc1c1ad0f598192bd22b13d3638b4e73062011872a
|
data/.gitignore
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
|
2
|
+
MIT License
|
3
|
+
|
4
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
5
|
+
a copy of this software and associated documentation files (the
|
6
|
+
"Software"), to deal in the Software without restriction, including
|
7
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
8
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
9
|
+
permit persons to whom the Software is furnished to do so, subject to
|
10
|
+
the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be
|
13
|
+
included in all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
16
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
17
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
18
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
19
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
20
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
21
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,160 @@
|
|
1
|
+
# Protobuf filter plugin for Embulk
|
2
|
+
|
3
|
+
An Embulk filter plugin for interconversion between Protocol Buffer message and JSON.
|
4
|
+
|
5
|
+
## Overview
|
6
|
+
|
7
|
+
* **Plugin type**: filter
|
8
|
+
|
9
|
+
## Configuration
|
10
|
+
|
11
|
+
* **serialize**, **deserialize**
|
12
|
+
- whether to serialize or deserialize (boolean, default: `false`)
|
13
|
+
- when `serialize: true`, convert JSON to encoded protobuf message
|
14
|
+
- when `deserialize: true`, convert encoded protobuf message to JSON
|
15
|
+
- either one must be `true` and exception is thrown when both are `true` or both are `false`
|
16
|
+
* **encoding**: encoding type, currently only Base64 is supported (string, required)
|
17
|
+
* **protobuf_jar_path**: jar path generated from your .proto
|
18
|
+
* **columns**: Input columns (array of hash, required)
|
19
|
+
- **name**: name of the column (string, required)
|
20
|
+
- **message**: package namespace of the message in `protobuf_jar_path`(string, required)
|
21
|
+
|
22
|
+
## Preparation
|
23
|
+
|
24
|
+
### Install protoc
|
25
|
+
|
26
|
+
See [official installation guide](https://github.com/google/protobuf/blob/master/src/README.md).
|
27
|
+
|
28
|
+
Since this plugin depends on [protobuf-3.1.0](https://github.com/google/protobuf/releases/tag/v3.1.0),
|
29
|
+
it is recommended that you install the same version.
|
30
|
+
|
31
|
+
### Get protobuf-java-x.x.x.jar
|
32
|
+
|
33
|
+
You can get protobuf-java-x.x.x.jar [here](https://mvnrepository.com/artifact/com.google.protobuf/protobuf-java).
|
34
|
+
|
35
|
+
For the same reason above, getting [protobuf-java-3.1.0](https://mvnrepository.com/artifact/com.google.protobuf/protobuf-java/3.1.0) is recommended.
|
36
|
+
|
37
|
+
### Generate jar from your .proto
|
38
|
+
|
39
|
+
Here take `addressbook.proto` as an example, which is used in [java tutorial of Protocol Buffer](https://developers.google.com/protocol-buffers/docs/javatutorial#defining-your-protocol-format).
|
40
|
+
|
41
|
+
Commands like below will generate `AddressBookProtos.jar`.
|
42
|
+
You can pass this `AddressBookProtos.jar` to `protobuf_jar_path` option in the config.
|
43
|
+
|
44
|
+
```sh
|
45
|
+
$ protoc --java_out=./ addressbook.proto
|
46
|
+
$ javac -classpath protobuf-java-3.1.0.jar com/example/tutorial/AddressBookProtos.java
|
47
|
+
$ jar cvf AddressBookProtos.jar com/example/tutorial/AddressBookProtos*.class
|
48
|
+
```
|
49
|
+
|
50
|
+
You should already have your `.proto` file,
|
51
|
+
so generate `.jar` file from your `.proto` and pass it to `protobuf_jar_path` option.
|
52
|
+
|
53
|
+
|
54
|
+
## Example
|
55
|
+
|
56
|
+
Run commands below.
|
57
|
+
|
58
|
+
```sh
|
59
|
+
$ ./gradlew package
|
60
|
+
$ cd example
|
61
|
+
$ ./generate_jar_from_proto
|
62
|
+
```
|
63
|
+
|
64
|
+
This will generate `example/AddressBookProtosProto2Syntax.jar` and `example/AddressBookProtosProto3Syntax.jar`
|
65
|
+
|
66
|
+
### Serialization Example (JSON -> encoded protobuf message)
|
67
|
+
|
68
|
+
See [example_serialize.yml](./example/example_serialize.yml) and [example_serialize.json](./example/example_serialize.json) for details.
|
69
|
+
|
70
|
+
input:
|
71
|
+
|
72
|
+
```json
|
73
|
+
// John as JSON generated from proto2-syntax .proto
|
74
|
+
{"name":"John Doe","id":1234,"email":"jdoe@example.com","phone":[{"number":"111-0000","type":"MOBILE"},
|
75
|
+
{"number":"555-4321","type":"HOME"}]}
|
76
|
+
// John as JSON generated from proto3-syntax .proto
|
77
|
+
{"name":"John Doe","id":1234,"email":"jdoe@example.com","phone":[{"number":"111-0000"},{"number":"555-4321","type":"HOME"}]}
|
78
|
+
// Jane as JSON generated from proto2-syntax .proto
|
79
|
+
{"name":"Jane Doe","id":1235,"phone":[{"number":"999-8888","type":"MOBILE"}]}
|
80
|
+
// Jane as JSON generated from proto3-syntax .proto
|
81
|
+
{"name":"Jane Doe","id":1235,"phone":[{"number":"999-8888"}]}
|
82
|
+
```
|
83
|
+
|
84
|
+
When you pass `example/AddressBookProtosProto2Syntax.jar` to `protobuf_jar_path`:
|
85
|
+
|
86
|
+
```sh
|
87
|
+
$ embulk run example/example_serialize.yml
|
88
|
+
CghKb2huIERvZRDSCRoQamRvZUBleGFtcGxlLmNvbSIMCggxMTEtMDAwMBAAIgwKCDU1NS00MzIxEAE=
|
89
|
+
CghKb2huIERvZRDSCRoQamRvZUBleGFtcGxlLmNvbSIKCggxMTEtMDAwMCIMCgg1NTUtNDMyMRAB
|
90
|
+
CghKYW5lIERvZRDTCSIMCgg5OTktODg4OBAA
|
91
|
+
CghKYW5lIERvZRDTCSIKCgg5OTktODg4OA==
|
92
|
+
```
|
93
|
+
|
94
|
+
When you pass `example/AddressBookProtosProto3Syntax.jar` to `protobuf_jar_path`:
|
95
|
+
|
96
|
+
```sh
|
97
|
+
$ embulk run example/example_serialize.yml
|
98
|
+
CghKb2huIERvZRDSCRoQamRvZUBleGFtcGxlLmNvbSIKCggxMTEtMDAwMCIMCgg1NTUtNDMyMRAB
|
99
|
+
CghKb2huIERvZRDSCRoQamRvZUBleGFtcGxlLmNvbSIKCggxMTEtMDAwMCIMCgg1NTUtNDMyMRAB
|
100
|
+
CghKYW5lIERvZRDTCSIKCgg5OTktODg4OA==
|
101
|
+
CghKYW5lIERvZRDTCSIKCgg5OTktODg4OA==
|
102
|
+
```
|
103
|
+
|
104
|
+
Using `.jar` generated from proto3-syntax `.proto`,
|
105
|
+
json with or without enum default values are converted to the same encoded string
|
106
|
+
because default values is not presented in message in proto3.
|
107
|
+
|
108
|
+
See [Default Values in proto3 language guide](https://developers.google.com/protocol-buffers/docs/proto3#default).
|
109
|
+
|
110
|
+
### Deserialization Example (encoded protobuf message -> JSON)
|
111
|
+
|
112
|
+
See [example_deserialize.yml](./example/example_deserialize.yml) and [example_deserialize.csv](./example/example_deserialize.csv) for more details.
|
113
|
+
|
114
|
+
input:
|
115
|
+
|
116
|
+
```
|
117
|
+
// John as encoded generated from proto2-syntax .proto
|
118
|
+
CghKb2huIERvZRDSCRoQamRvZUBleGFtcGxlLmNvbSIMCggxMTEtMDAwMBAAIgwKCDU1NS00MzIxEAE=
|
119
|
+
// John as encoded generated from proto3-syntax .proto
|
120
|
+
CghKb2huIERvZRDSCRoQamRvZUBleGFtcGxlLmNvbSIKCggxMTEtMDAwMCIMCgg1NTUtNDMyMRAB
|
121
|
+
// Jane as encoded generated from proto3-syntax .proto
|
122
|
+
CghKYW5lIERvZRDTCSIMCgg5OTktODg4OBAA
|
123
|
+
// Jane as encoded generated from proto3-syntax .proto
|
124
|
+
CghKYW5lIERvZRDTCSIKCgg5OTktODg4OA==
|
125
|
+
```
|
126
|
+
|
127
|
+
When you pass `example/AddressBookProtosProto2Syntax.jar` to `protobuf_jar_path`:
|
128
|
+
|
129
|
+
```sh
|
130
|
+
$ embulk run example/example_deserialize.yml
|
131
|
+
{"name":"John Doe","id":1234,"email":"jdoe@example.com","phone":[{"number":"111-0000","type":"MOBILE"},{"number":"555-4321","type":"HOME"}]}
|
132
|
+
{"name":"John Doe","id":1234,"email":"jdoe@example.com","phone":[{"number":"111-0000"},{"number":"555-4321","type":"HOME"}]}
|
133
|
+
{"name":"Jane Doe","id":1235,"phone":[{"number":"999-8888","type":"MOBILE"}]}
|
134
|
+
{"name":"Jane Doe","id":1235,"phone":[{"number":"999-8888"}]}
|
135
|
+
```
|
136
|
+
|
137
|
+
When you pass `example/AddressBookProtosProto3Syntax.jar` to `protobuf_jar_path`:
|
138
|
+
|
139
|
+
```sh
|
140
|
+
$ embulk run example/example_deserialize.yml
|
141
|
+
{"name":"John Doe","id":1234,"email":"jdoe@example.com","phone":[{"number":"111-0000"},{"number":"555-4321","type":"HOME"}]}
|
142
|
+
{"name":"John Doe","id":1234,"email":"jdoe@example.com","phone":[{"number":"111-0000"},{"number":"555-4321","type":"HOME"}]}
|
143
|
+
{"name":"Jane Doe","id":1235,"phone":[{"number":"999-8888"}]}
|
144
|
+
{"name":"Jane Doe","id":1235,"phone":[{"number":"999-8888"}]}
|
145
|
+
```
|
146
|
+
|
147
|
+
Here again, encoded messages with or without default values are converted to the same JSON.
|
148
|
+
This is because of the same reason mentioned above.
|
149
|
+
|
150
|
+
## TODO
|
151
|
+
|
152
|
+
* Support other encoding method (Base16, Base32, ...)
|
153
|
+
* Allow JSON type for input in serialization
|
154
|
+
and output in deserialiazation
|
155
|
+
|
156
|
+
## Build
|
157
|
+
|
158
|
+
```
|
159
|
+
$ ./gradlew gem # -t to watch change of files and rebuild continuously
|
160
|
+
```
|
data/build.gradle
ADDED
@@ -0,0 +1,98 @@
|
|
1
|
+
plugins {
|
2
|
+
id "com.jfrog.bintray" version "1.1"
|
3
|
+
id "com.github.jruby-gradle.base" version "0.1.5"
|
4
|
+
id "java"
|
5
|
+
id "checkstyle"
|
6
|
+
}
|
7
|
+
import com.github.jrubygradle.JRubyExec
|
8
|
+
repositories {
|
9
|
+
mavenCentral()
|
10
|
+
jcenter()
|
11
|
+
}
|
12
|
+
configurations {
|
13
|
+
provided
|
14
|
+
}
|
15
|
+
|
16
|
+
version = "0.1.0"
|
17
|
+
|
18
|
+
sourceCompatibility = 1.7
|
19
|
+
targetCompatibility = 1.7
|
20
|
+
|
21
|
+
dependencies {
|
22
|
+
// compile "YOUR_JAR_DEPENDENCY_GROUP:YOUR_JAR_DEPENDENCY_MODULE:YOUR_JAR_DEPENDENCY_VERSION"
|
23
|
+
compile "org.embulk:embulk-core:0.8.15"
|
24
|
+
provided "org.embulk:embulk-core:0.8.15"
|
25
|
+
compile "com.google.protobuf:protobuf-java:3.1.0"
|
26
|
+
compile "com.google.protobuf:protobuf-java-util:3.1.0"
|
27
|
+
testCompile "junit:junit:4.+"
|
28
|
+
testCompile "org.embulk:embulk-core:0.8.15:tests"
|
29
|
+
testCompile files("example/AddressBookProtosProto3Syntax.jar")
|
30
|
+
}
|
31
|
+
|
32
|
+
task classpath(type: Copy, dependsOn: ["jar"]) {
|
33
|
+
doFirst { file("classpath").deleteDir() }
|
34
|
+
from (configurations.runtime - configurations.provided + files(jar.archivePath))
|
35
|
+
into "classpath"
|
36
|
+
}
|
37
|
+
clean { delete "classpath" }
|
38
|
+
|
39
|
+
checkstyle {
|
40
|
+
configFile = file("${project.rootDir}/config/checkstyle/checkstyle.xml")
|
41
|
+
toolVersion = '6.14.1'
|
42
|
+
}
|
43
|
+
checkstyleMain {
|
44
|
+
configFile = file("${project.rootDir}/config/checkstyle/default.xml")
|
45
|
+
ignoreFailures = true
|
46
|
+
}
|
47
|
+
checkstyleTest {
|
48
|
+
configFile = file("${project.rootDir}/config/checkstyle/default.xml")
|
49
|
+
ignoreFailures = true
|
50
|
+
}
|
51
|
+
task checkstyle(type: Checkstyle) {
|
52
|
+
classpath = sourceSets.main.output + sourceSets.test.output
|
53
|
+
source = sourceSets.main.allJava + sourceSets.test.allJava
|
54
|
+
}
|
55
|
+
|
56
|
+
task gem(type: JRubyExec, dependsOn: ["gemspec", "classpath"]) {
|
57
|
+
jrubyArgs "-rrubygems/gem_runner", "-eGem::GemRunner.new.run(ARGV)", "build"
|
58
|
+
script "${project.name}.gemspec"
|
59
|
+
doLast { ant.move(file: "${project.name}-${project.version}.gem", todir: "pkg") }
|
60
|
+
}
|
61
|
+
|
62
|
+
task gemPush(type: JRubyExec, dependsOn: ["gem"]) {
|
63
|
+
jrubyArgs "-rrubygems/gem_runner", "-eGem::GemRunner.new.run(ARGV)", "push"
|
64
|
+
script "pkg/${project.name}-${project.version}.gem"
|
65
|
+
}
|
66
|
+
|
67
|
+
task "package"(dependsOn: ["gemspec", "classpath"]) << {
|
68
|
+
println "> Build succeeded."
|
69
|
+
println "> You can run embulk with '-L ${file(".").absolutePath}' argument."
|
70
|
+
}
|
71
|
+
|
72
|
+
task gemspec {
|
73
|
+
ext.gemspecFile = file("${project.name}.gemspec")
|
74
|
+
inputs.file "build.gradle"
|
75
|
+
outputs.file gemspecFile
|
76
|
+
doLast { gemspecFile.write($/
|
77
|
+
Gem::Specification.new do |spec|
|
78
|
+
spec.name = "${project.name}"
|
79
|
+
spec.version = "${project.version}"
|
80
|
+
spec.authors = ["Yusuke NISHIOKA"]
|
81
|
+
spec.summary = %[Protobuf filter plugin for Embulk]
|
82
|
+
spec.description = %[An Embulk filter plugin for interconversion between Protocol Buffer message and JSON.]
|
83
|
+
spec.email = ["yusuke.nishioka.0713@gmail.com"]
|
84
|
+
spec.licenses = ["MIT"]
|
85
|
+
spec.homepage = "https://github.com/ysk24ok/embulk-filter-protobuf"
|
86
|
+
|
87
|
+
spec.files = `git ls-files`.split("\n") + Dir["classpath/*.jar"]
|
88
|
+
spec.test_files = spec.files.grep(%r"^(test|spec)/")
|
89
|
+
spec.require_paths = ["lib"]
|
90
|
+
|
91
|
+
#spec.add_dependency 'YOUR_GEM_DEPENDENCY', ['~> YOUR_GEM_DEPENDENCY_VERSION']
|
92
|
+
spec.add_development_dependency 'bundler', ['~> 1.0']
|
93
|
+
spec.add_development_dependency 'rake', ['>= 10.0']
|
94
|
+
end
|
95
|
+
/$)
|
96
|
+
}
|
97
|
+
}
|
98
|
+
clean { delete "${project.name}.gemspec" }
|
@@ -0,0 +1,128 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<!DOCTYPE module PUBLIC
|
3
|
+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
4
|
+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
5
|
+
<module name="Checker">
|
6
|
+
<!-- https://github.com/facebook/presto/blob/master/src/checkstyle/checks.xml -->
|
7
|
+
<module name="FileTabCharacter"/>
|
8
|
+
<module name="NewlineAtEndOfFile">
|
9
|
+
<property name="lineSeparator" value="lf"/>
|
10
|
+
</module>
|
11
|
+
<module name="RegexpMultiline">
|
12
|
+
<property name="format" value="\r"/>
|
13
|
+
<property name="message" value="Line contains carriage return"/>
|
14
|
+
</module>
|
15
|
+
<module name="RegexpMultiline">
|
16
|
+
<property name="format" value=" \n"/>
|
17
|
+
<property name="message" value="Line has trailing whitespace"/>
|
18
|
+
</module>
|
19
|
+
<module name="RegexpMultiline">
|
20
|
+
<property name="format" value="\{\n\n"/>
|
21
|
+
<property name="message" value="Blank line after opening brace"/>
|
22
|
+
</module>
|
23
|
+
<module name="RegexpMultiline">
|
24
|
+
<property name="format" value="\n\n\s*\}"/>
|
25
|
+
<property name="message" value="Blank line before closing brace"/>
|
26
|
+
</module>
|
27
|
+
<module name="RegexpMultiline">
|
28
|
+
<property name="format" value="\n\n\n"/>
|
29
|
+
<property name="message" value="Multiple consecutive blank lines"/>
|
30
|
+
</module>
|
31
|
+
<module name="RegexpMultiline">
|
32
|
+
<property name="format" value="\n\n\Z"/>
|
33
|
+
<property name="message" value="Blank line before end of file"/>
|
34
|
+
</module>
|
35
|
+
<module name="RegexpMultiline">
|
36
|
+
<property name="format" value="Preconditions\.checkNotNull"/>
|
37
|
+
<property name="message" value="Use of checkNotNull"/>
|
38
|
+
</module>
|
39
|
+
|
40
|
+
<module name="TreeWalker">
|
41
|
+
<module name="EmptyBlock">
|
42
|
+
<property name="option" value="text"/>
|
43
|
+
<property name="tokens" value="
|
44
|
+
LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF,
|
45
|
+
LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT, STATIC_INIT"/>
|
46
|
+
</module>
|
47
|
+
<module name="EmptyStatement"/>
|
48
|
+
<module name="EmptyForInitializerPad"/>
|
49
|
+
<module name="EmptyForIteratorPad">
|
50
|
+
<property name="option" value="space"/>
|
51
|
+
</module>
|
52
|
+
<module name="MethodParamPad">
|
53
|
+
<property name="allowLineBreaks" value="true"/>
|
54
|
+
<property name="option" value="nospace"/>
|
55
|
+
</module>
|
56
|
+
<module name="ParenPad"/>
|
57
|
+
<module name="TypecastParenPad"/>
|
58
|
+
<module name="NeedBraces"/>
|
59
|
+
<module name="LeftCurly">
|
60
|
+
<property name="option" value="nl"/>
|
61
|
+
<property name="tokens" value="CLASS_DEF, CTOR_DEF, INTERFACE_DEF, METHOD_DEF"/>
|
62
|
+
</module>
|
63
|
+
<module name="LeftCurly">
|
64
|
+
<property name="option" value="eol"/>
|
65
|
+
<property name="tokens" value="
|
66
|
+
LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR,
|
67
|
+
LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE"/>
|
68
|
+
</module>
|
69
|
+
<module name="RightCurly">
|
70
|
+
<property name="option" value="alone"/>
|
71
|
+
</module>
|
72
|
+
<module name="GenericWhitespace"/>
|
73
|
+
<module name="WhitespaceAfter"/>
|
74
|
+
<module name="NoWhitespaceBefore"/>
|
75
|
+
|
76
|
+
<module name="UpperEll"/>
|
77
|
+
<module name="DefaultComesLast"/>
|
78
|
+
<module name="ArrayTypeStyle"/>
|
79
|
+
<module name="MultipleVariableDeclarations"/>
|
80
|
+
<module name="ModifierOrder"/>
|
81
|
+
<module name="OneStatementPerLine"/>
|
82
|
+
<module name="StringLiteralEquality"/>
|
83
|
+
<module name="MutableException"/>
|
84
|
+
<module name="EqualsHashCode"/>
|
85
|
+
<module name="InnerAssignment"/>
|
86
|
+
<module name="InterfaceIsType"/>
|
87
|
+
<module name="HideUtilityClassConstructor"/>
|
88
|
+
|
89
|
+
<module name="MemberName"/>
|
90
|
+
<module name="LocalVariableName"/>
|
91
|
+
<module name="LocalFinalVariableName"/>
|
92
|
+
<module name="TypeName"/>
|
93
|
+
<module name="PackageName"/>
|
94
|
+
<module name="ParameterName"/>
|
95
|
+
<module name="StaticVariableName"/>
|
96
|
+
<module name="ClassTypeParameterName">
|
97
|
+
<property name="format" value="^[A-Z][0-9]?$"/>
|
98
|
+
</module>
|
99
|
+
<module name="MethodTypeParameterName">
|
100
|
+
<property name="format" value="^[A-Z][0-9]?$"/>
|
101
|
+
</module>
|
102
|
+
|
103
|
+
<module name="AvoidStarImport"/>
|
104
|
+
<module name="RedundantImport"/>
|
105
|
+
<module name="UnusedImports"/>
|
106
|
+
<module name="ImportOrder">
|
107
|
+
<property name="groups" value="*,javax,java"/>
|
108
|
+
<property name="separated" value="true"/>
|
109
|
+
<property name="option" value="bottom"/>
|
110
|
+
<property name="sortStaticImportsAlphabetically" value="true"/>
|
111
|
+
</module>
|
112
|
+
|
113
|
+
<module name="WhitespaceAround">
|
114
|
+
<property name="allowEmptyConstructors" value="true"/>
|
115
|
+
<property name="allowEmptyMethods" value="true"/>
|
116
|
+
<property name="ignoreEnhancedForColon" value="false"/>
|
117
|
+
<property name="tokens" value="
|
118
|
+
ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN,
|
119
|
+
BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE,
|
120
|
+
LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
|
121
|
+
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
|
122
|
+
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE,
|
123
|
+
LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL,
|
124
|
+
PLUS, PLUS_ASSIGN, QUESTION, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN,
|
125
|
+
STAR, STAR_ASSIGN, TYPE_EXTENSION_AND"/>
|
126
|
+
</module>
|
127
|
+
</module>
|
128
|
+
</module>
|
@@ -0,0 +1,108 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
+
<!DOCTYPE module PUBLIC
|
3
|
+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
4
|
+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
5
|
+
<!--
|
6
|
+
This is a subset of ./checkstyle.xml which allows some loose styles
|
7
|
+
-->
|
8
|
+
<module name="Checker">
|
9
|
+
<module name="FileTabCharacter"/>
|
10
|
+
<module name="NewlineAtEndOfFile">
|
11
|
+
<property name="lineSeparator" value="lf"/>
|
12
|
+
</module>
|
13
|
+
<module name="RegexpMultiline">
|
14
|
+
<property name="format" value="\r"/>
|
15
|
+
<property name="message" value="Line contains carriage return"/>
|
16
|
+
</module>
|
17
|
+
<module name="RegexpMultiline">
|
18
|
+
<property name="format" value=" \n"/>
|
19
|
+
<property name="message" value="Line has trailing whitespace"/>
|
20
|
+
</module>
|
21
|
+
<module name="RegexpMultiline">
|
22
|
+
<property name="format" value="\n\n\n"/>
|
23
|
+
<property name="message" value="Multiple consecutive blank lines"/>
|
24
|
+
</module>
|
25
|
+
<module name="RegexpMultiline">
|
26
|
+
<property name="format" value="\n\n\Z"/>
|
27
|
+
<property name="message" value="Blank line before end of file"/>
|
28
|
+
</module>
|
29
|
+
|
30
|
+
<module name="TreeWalker">
|
31
|
+
<module name="EmptyBlock">
|
32
|
+
<property name="option" value="text"/>
|
33
|
+
<property name="tokens" value="
|
34
|
+
LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF,
|
35
|
+
LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT, STATIC_INIT"/>
|
36
|
+
</module>
|
37
|
+
<module name="EmptyStatement"/>
|
38
|
+
<module name="EmptyForInitializerPad"/>
|
39
|
+
<module name="EmptyForIteratorPad">
|
40
|
+
<property name="option" value="space"/>
|
41
|
+
</module>
|
42
|
+
<module name="MethodParamPad">
|
43
|
+
<property name="allowLineBreaks" value="true"/>
|
44
|
+
<property name="option" value="nospace"/>
|
45
|
+
</module>
|
46
|
+
<module name="ParenPad"/>
|
47
|
+
<module name="TypecastParenPad"/>
|
48
|
+
<module name="NeedBraces"/>
|
49
|
+
<module name="LeftCurly">
|
50
|
+
<property name="option" value="nl"/>
|
51
|
+
<property name="tokens" value="CLASS_DEF, CTOR_DEF, INTERFACE_DEF, METHOD_DEF"/>
|
52
|
+
</module>
|
53
|
+
<module name="LeftCurly">
|
54
|
+
<property name="option" value="eol"/>
|
55
|
+
<property name="tokens" value="
|
56
|
+
LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR,
|
57
|
+
LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE"/>
|
58
|
+
</module>
|
59
|
+
<module name="RightCurly">
|
60
|
+
<property name="option" value="alone"/>
|
61
|
+
</module>
|
62
|
+
<module name="GenericWhitespace"/>
|
63
|
+
<module name="WhitespaceAfter"/>
|
64
|
+
<module name="NoWhitespaceBefore"/>
|
65
|
+
|
66
|
+
<module name="UpperEll"/>
|
67
|
+
<module name="DefaultComesLast"/>
|
68
|
+
<module name="ArrayTypeStyle"/>
|
69
|
+
<module name="MultipleVariableDeclarations"/>
|
70
|
+
<module name="ModifierOrder"/>
|
71
|
+
<module name="OneStatementPerLine"/>
|
72
|
+
<module name="StringLiteralEquality"/>
|
73
|
+
<module name="MutableException"/>
|
74
|
+
<module name="EqualsHashCode"/>
|
75
|
+
<module name="InnerAssignment"/>
|
76
|
+
<module name="InterfaceIsType"/>
|
77
|
+
<module name="HideUtilityClassConstructor"/>
|
78
|
+
|
79
|
+
<module name="MemberName"/>
|
80
|
+
<module name="LocalVariableName"/>
|
81
|
+
<module name="LocalFinalVariableName"/>
|
82
|
+
<module name="TypeName"/>
|
83
|
+
<module name="PackageName"/>
|
84
|
+
<module name="ParameterName"/>
|
85
|
+
<module name="StaticVariableName"/>
|
86
|
+
<module name="ClassTypeParameterName">
|
87
|
+
<property name="format" value="^[A-Z][0-9]?$"/>
|
88
|
+
</module>
|
89
|
+
<module name="MethodTypeParameterName">
|
90
|
+
<property name="format" value="^[A-Z][0-9]?$"/>
|
91
|
+
</module>
|
92
|
+
|
93
|
+
<module name="WhitespaceAround">
|
94
|
+
<property name="allowEmptyConstructors" value="true"/>
|
95
|
+
<property name="allowEmptyMethods" value="true"/>
|
96
|
+
<property name="ignoreEnhancedForColon" value="false"/>
|
97
|
+
<property name="tokens" value="
|
98
|
+
ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN,
|
99
|
+
BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE,
|
100
|
+
LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
|
101
|
+
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
|
102
|
+
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE,
|
103
|
+
LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL,
|
104
|
+
PLUS, PLUS_ASSIGN, QUESTION, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN,
|
105
|
+
STAR, STAR_ASSIGN, TYPE_EXTENSION_AND"/>
|
106
|
+
</module>
|
107
|
+
</module>
|
108
|
+
</module>
|