├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── build.gradle
└── src
├── main
└── java
│ └── com
│ └── github
│ └── racc
│ └── tscg
│ ├── ConfigExtractor.java
│ ├── ConfigExtractors.java
│ ├── ListExtractor.java
│ ├── ListExtractors.java
│ ├── Reflector.java
│ ├── TypesafeConfig.java
│ ├── TypesafeConfigImpl.java
│ ├── TypesafeConfigModule.java
│ ├── TypesafeConfigs.java
│ └── reflectors
│ ├── fastclasspathscanner
│ ├── FastClasspathScanningReflector.java
│ ├── FieldIdentifier.java
│ └── MethodIdentifier.java
│ └── reflections
│ └── ReflectionsReflector.java
└── test
├── java
└── com
│ └── github
│ └── racc
│ └── tscg
│ ├── TypesafeConfigModuleTest.java
│ └── test
│ ├── ConstructorInjectedPojo.java
│ ├── FieldInjectedPojo.java
│ ├── MethodInjectedPojo.java
│ ├── NestedPojo.java
│ ├── ProvidedPojo.java
│ └── TestPojo.java
└── resources
└── conf
└── test.conf
/.gitignore:
--------------------------------------------------------------------------------
1 | /bin/
2 | /build/
3 | /.gradle/
4 | /.settings/
5 | /.classpath
6 | /.project
7 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: java
2 | jdk:
3 | - oraclejdk8
4 | install: gradle -x signArchives assemble
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright 2015 Jason Then.
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Typesafe Config Guice
2 | Allows [Guice](https://github.com/google/guice) to @Inject configuration values into your application derived from [Typesafe Config](https://github.com/typesafehub/config).
3 |
4 | [](https://travis-ci.org/racc/typesafeconfig-guice)
5 |
6 | Available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22typesafeconfig-guice%22).
7 |
8 | ```xml
9 |
10 | com.github.racc
11 | typesafeconfig-guice
12 | 0.1.0
13 |
14 | ```
15 |
16 | ### Quickstart
17 | #### Step 1:
18 | Annotate configuration injection points (Constructors, Providers, Provider methods, Setter methods, Fields) with ```@TypesafeConfig("config.path.key")```
19 |
20 | #### Step 2:
21 | Bootstrap your application with Guice and the TypesafeConfigModule.
22 | Configuration values annotated with `@TypesafeConfig` will be scanned for on the classpath, and then bound from your supplied Typesafe Config file.
23 | ```java
24 | Config config = ConfigFactory.load("config.conf");
25 | Injector injector = Guice.createInjector(
26 | TypesafeConfigModule.fromConfigWithPackage(config, "com.my.package");
27 | // ... Add your other modules here
28 | );
29 | ```
30 |
31 | #### Step 3:
32 | Profit!
33 |
34 | ### Features
35 | - Plain Old Java Objects which follow JavaBean conventions (zero-args constructor, getters and setters) can be injected.
36 | - Supports injections of `java.time.Duration` objects with config parameters defined as "10 seconds", "10 minutes" etc.
37 | - Supports injections of `com.typesafe.config.ConfigMemorySize` objects with config parameters defined as "512k" or "2M" etc.
38 | - Supports injections of `boolean`, where the matching config parameter can be "true", "false", "yes" or "no".
39 | - Supports injections of List types of primitives: `boolean`, `int`, `double`, `long`, `string`, `java.time.Duration`, `com.typesafe.config.ConfigMemorySize`
40 | - Supports injections of `java.util.Map`
41 | - Supports injections of POJO Lists.
42 | - Extensive test coverage
43 |
44 | AUTHOR
45 | -----------
46 | Jason Then
47 |
48 | Any comments and feedback appreciated!
49 |
50 | LICENSE
51 | -----------
52 | Copyright 2018 Jason Then
53 |
54 | Licensed under the Apache License, Version 2.0 (the "License");
55 | you may not use this file except in compliance with the License.
56 | You may obtain a copy of the License at
57 |
58 | http://www.apache.org/licenses/LICENSE-2.0
59 |
60 | Unless required by applicable law or agreed to in writing, software
61 | distributed under the License is distributed on an "AS IS" BASIS,
62 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
63 | See the License for the specific language governing permissions and
64 | limitations under the License.
65 |
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'java'
2 | apply plugin: 'maven'
3 | apply plugin: 'signing'
4 |
5 | repositories {
6 | mavenCentral()
7 | }
8 |
9 | group = 'com.github.racc'
10 | archivesBaseName = "typesafeconfig-guice"
11 | version = '0.1.0'
12 |
13 | task javadocJar(type: Jar, dependsOn: javadoc) {
14 | classifier = 'javadoc'
15 | from 'build/docs/javadoc'
16 | }
17 |
18 | task sourcesJar(type: Jar) {
19 | from sourceSets.main.allSource
20 | classifier = 'sources'
21 | }
22 |
23 | artifacts {
24 | archives jar
25 | archives javadocJar
26 | archives sourcesJar
27 | }
28 |
29 | signing {
30 | sign configurations.archives
31 | }
32 |
33 | def uzer = hasProperty('ossrhUsername') ? ossrhUsername : System.getenv('ossrhUsername')
34 | def password = hasProperty('ossrhPassword') ? ossrhPassword : System.getenv('ossrhPassword')
35 |
36 | uploadArchives {
37 | repositories {
38 | mavenDeployer {
39 | beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
40 |
41 | repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
42 | authentication(userName: uzer, password: password)
43 | }
44 |
45 | snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
46 | authentication(userName: uzer, password: password)
47 | }
48 |
49 | pom.project {
50 | name 'TypesafeConfigGuice'
51 | packaging 'jar'
52 | description 'TypesafeConfigGuice allows TypesafeConfig values to be injected with Guice'
53 | url 'https://github.com/racc/typesafeconfig-guice'
54 |
55 | scm {
56 | url 'scm:git@github.com:racc/typesafeconfig-guice.git'
57 | connection 'scm:git@github.com:racc/typesafeconfig-guice.git'
58 | developerConnection 'scm:git@github.com:racc/typesafeconfig-guice.git'
59 | }
60 |
61 | licenses {
62 | license {
63 | name 'The Apache Software License, Version 2.0'
64 | url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
65 | distribution 'repo'
66 | }
67 | }
68 |
69 | developers {
70 | developer {
71 | id 'racc'
72 | name 'Jason Then'
73 | }
74 | }
75 | }
76 | }
77 | }
78 | }
79 |
80 | dependencies {
81 | compile 'com.typesafe:config:1.3.0'
82 | compile group: 'io.github.lukehutch', name: 'fast-classpath-scanner', version: '2.18.1'
83 | compile 'org.reflections:reflections:0.9.9'
84 | compile 'com.google.inject:guice:4.0:no_aop'
85 |
86 | testCompile 'junit:junit:4.12'
87 | }
88 |
--------------------------------------------------------------------------------
/src/main/java/com/github/racc/tscg/ConfigExtractor.java:
--------------------------------------------------------------------------------
1 | package com.github.racc.tscg;
2 |
3 | import com.typesafe.config.Config;
4 |
5 | /**
6 | * Extracts values from a particular {@link Config}.
7 | *
8 | * @author jason
9 | */
10 | interface ConfigExtractor {
11 |
12 | /**
13 | * @param config the {@link Config} to extract from
14 | * @param path the {@link Config} path
15 | * @return the extracted value
16 | */
17 | public Object extractValue(Config config, String path);
18 |
19 | /**
20 | * @return the types this {@link ConfigExtractor} will extract for.
21 | */
22 | public Class>[] getMatchingClasses();
23 | }
24 |
--------------------------------------------------------------------------------
/src/main/java/com/github/racc/tscg/ConfigExtractors.java:
--------------------------------------------------------------------------------
1 | package com.github.racc.tscg;
2 |
3 | import java.time.Duration;
4 | import java.util.HashMap;
5 | import java.util.Map;
6 | import java.util.Optional;
7 |
8 | import com.typesafe.config.Config;
9 | import com.typesafe.config.ConfigList;
10 | import com.typesafe.config.ConfigMemorySize;
11 | import com.typesafe.config.ConfigObject;
12 | import com.typesafe.config.ConfigValue;
13 |
14 | /**
15 | * An {@link Enum} of {@link ConfigExtractor}s to extract values out of a {@link Config}.
16 | *
17 | * @author jason
18 | */
19 | enum ConfigExtractors implements ConfigExtractor {
20 |
21 | BOOLEAN(boolean.class, Boolean.class) {
22 | @Override
23 | public Object extractValue(Config config, String path) {
24 | return config.getBoolean(path);
25 | }
26 | },
27 | BYTE(byte.class, Byte.class) {
28 | @Override
29 | public Object extractValue(Config config, String path) {
30 | return (byte) config.getInt(path);
31 | }
32 | },
33 | SHORT(short.class, Short.class) {
34 | @Override
35 | public Object extractValue(Config config, String path) {
36 | return (short) config.getInt(path);
37 | }
38 | },
39 | INTEGER(int.class, Integer.class) {
40 | @Override
41 | public Object extractValue(Config config, String path) {
42 | return config.getInt(path);
43 | }
44 | },
45 | LONG(long.class, Long.class) {
46 | @Override
47 | public Object extractValue(Config config, String path) {
48 | return config.getLong(path);
49 | }
50 | },
51 | FLOAT(float.class, Float.class) {
52 | @Override
53 | public Object extractValue(Config config, String path) {
54 | return (float) config.getDouble(path);
55 | }
56 | },
57 | DOUBLE(double.class, Double.class) {
58 | @Override
59 | public Object extractValue(Config config, String path) {
60 | return config.getDouble(path);
61 | }
62 | },
63 | STRING(String.class) {
64 | @Override
65 | public Object extractValue(Config config, String path) {
66 | return config.getString(path);
67 | }
68 | },
69 | ANY_REF(Object.class) {
70 | @Override
71 | public Object extractValue(Config config, String path) {
72 | return config.getAnyRef(path);
73 | }
74 | },
75 | CONFIG(Config.class) {
76 | @Override
77 | public Object extractValue(Config config, String path) {
78 | return config.getConfig(path);
79 | }
80 | },
81 | CONFIG_OBJECT(ConfigObject.class) {
82 | @Override
83 | public Object extractValue(Config config, String path) {
84 | return config.getObject(path);
85 | }
86 | },
87 | CONFIG_VALUE(ConfigValue.class) {
88 | @Override
89 | public Object extractValue(Config config, String path) {
90 | return config.getValue(path);
91 | }
92 | },
93 | CONFIG_LIST(ConfigList.class) {
94 | @Override
95 | public Object extractValue(Config config, String path) {
96 | return config.getList(path);
97 | }
98 | },
99 | DURATION(Duration.class) {
100 | @Override
101 | public Object extractValue(Config config, String path) {
102 | return config.getDuration(path);
103 | }
104 | },
105 | MEMORY_SIZE(ConfigMemorySize.class) {
106 | @Override
107 | public Object extractValue(Config config, String path) {
108 | return config.getMemorySize(path);
109 | }
110 | };
111 |
112 | private final Class>[] matchingClasses;
113 | private static final Map, ConfigExtractor> EXTRACTOR_MAP = new HashMap<>();
114 |
115 | static {
116 | for (ConfigExtractor extractor : ConfigExtractors.values()) {
117 | for (Class> clazz : extractor.getMatchingClasses()) {
118 | EXTRACTOR_MAP.put(clazz, extractor);
119 | }
120 | }
121 | }
122 |
123 | private ConfigExtractors(Class>... matchingClasses) {
124 | this.matchingClasses = matchingClasses;
125 | }
126 |
127 | public Class>[] getMatchingClasses() {
128 | return matchingClasses;
129 | }
130 |
131 | /**
132 | * @param config the {@link Config} to extract from
133 | * @param paramClass the class
134 | * @param path
135 | * @return the extracted config value, or empty if there was no matching {@link ConfigExtractor}.
136 | */
137 | static Optional