Add sangria-log4j module.

5 files changed, 256 insertions, 0 deletions

diff --git a/sangria-log4j/pom.xml b/sangria-log4j/pom.xml
new file mode 100644
index 0000000..b39995f
--- /dev/null
+++ b/sangria-log4j/pom.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.tavianator.sangria</groupId>
+        <artifactId>sangria</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>sangria-log4j</artifactId>
+    <packaging>jar</packaging>
+    <name>Sangria Log4j</name>
+    <description>Log4j Logger injection</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.tavianator.sangria</groupId>
+            <artifactId>sangria-contextual</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.inject</groupId>
+            <artifactId>guice</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+            <version>2.0-rc1</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>jsr305</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-integration</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <version>2.0-rc1</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/Log4jLoggerProvider.java b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/Log4jLoggerProvider.java
new file mode 100644
index 0000000..dae2323
--- /dev/null
+++ b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/Log4jLoggerProvider.java
@@ -0,0 +1,46 @@
+/****************************************************************************
+ * Sangria                                                                  *
+ * Copyright (C) 2014 Tavian Barnes <tavianator@tavianator.com>             *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ * http://www.apache.org/licenses/LICENSE-2.0                               *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ****************************************************************************/
+
+package com.tavianator.sangria.log4j;
+
+import javax.inject.Singleton;
+
+import com.google.inject.spi.InjectionPoint;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+import com.tavianator.sangria.contextual.ContextSensitiveProvider;
+
+/**
+ * Actual {@link Logger} provider implementation.
+ *
+ * @author Tavian Barnes (tavianator@tavianator.com)
+ * @version 1.0
+ * @since 1.0
+ */
+@Singleton
+class Log4jLoggerProvider implements ContextSensitiveProvider<Logger> {
+    @Override
+    public Logger getInContext(InjectionPoint injectionPoint) {
+        return LogManager.getLogger(injectionPoint.getDeclaringType().getRawType());
+    }
+
+    @Override
+    public Logger getInUnknownContext() {
+        return LogManager.getRootLogger();
+    }
+}
diff --git a/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/SangriaLog4jModule.java b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/SangriaLog4jModule.java
new file mode 100644
index 0000000..7f5baa3
--- /dev/null
+++ b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/SangriaLog4jModule.java
@@ -0,0 +1,39 @@
+/****************************************************************************
+ * Sangria                                                                  *
+ * Copyright (C) 2014 Tavian Barnes <tavianator@tavianator.com>             *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ * http://www.apache.org/licenses/LICENSE-2.0                               *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ****************************************************************************/
+
+package com.tavianator.sangria.log4j;
+
+import com.google.inject.AbstractModule;
+import org.apache.logging.log4j.Logger;
+
+import com.tavianator.sangria.contextual.ContextSensitiveBinder;
+
+/**
+ * Module for Log4j {@link Logger} injection.
+ *
+ * @author Tavian Barnes (tavianator@tavianator.com)
+ * @version 1.0
+ * @since 1.0
+ */
+public class SangriaLog4jModule extends AbstractModule {
+    @Override
+    protected void configure() {
+        ContextSensitiveBinder.create(binder())
+                .bind(Logger.class)
+                .toContextSensitiveProvider(Log4jLoggerProvider.class);
+    }
+}
diff --git a/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/package-info.java b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/package-info.java
new file mode 100644
index 0000000..7f07951
--- /dev/null
+++ b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/package-info.java
@@ -0,0 +1,25 @@
+/****************************************************************************
+ * Sangria                                                                  *
+ * Copyright (C) 2014 Tavian Barnes <tavianator@tavianator.com>             *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ * http://www.apache.org/licenses/LICENSE-2.0                               *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ****************************************************************************/
+
+/**
+ * {@code sangria-log4j}: Log4j {@link org.apache.logging.log4j.Logger} injection.
+ *
+ * @author Tavian Barnes (tavianator@tavianator.com)
+ * @version 1.0
+ * @since 1.0
+ */
+package com.tavianator.sangria.log4j;
diff --git a/sangria-log4j/src/test/java/com/tavianator/sangria/log4j/SangriaLog4jModuleTest.java b/sangria-log4j/src/test/java/com/tavianator/sangria/log4j/SangriaLog4jModuleTest.java
new file mode 100644
index 0000000..d91cf90
--- /dev/null
+++ b/sangria-log4j/src/test/java/com/tavianator/sangria/log4j/SangriaLog4jModuleTest.java
@@ -0,0 +1,80 @@
+/****************************************************************************
+ * Sangria                                                                  *
+ * Copyright (C) 2014 Tavian Barnes <tavianator@tavianator.com>             *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ * http://www.apache.org/licenses/LICENSE-2.0                               *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ****************************************************************************/
+
+package com.tavianator.sangria.log4j;
+
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.Guice;
+import com.google.inject.Injector;
+import com.google.inject.Provides;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.*;
+
+/**
+ * @author Tavian Barnes (tavianator@tavianator.com)
+ * @version 1.0
+ * @since 1.0
+ */
+public class SangriaLog4jModuleTest {
+    @Inject Logger logger;
+    @Inject Provider<Logger> provider;
+
+    @Before
+    public void setUp() {
+        Guice.createInjector(new SangriaLog4jModule()).injectMembers(this);
+    }
+
+    @Test
+    public void testLogger() {
+        assertThat(logger.getName(), equalTo(SangriaLog4jModuleTest.class.getName()));
+    }
+
+    @Test
+    public void testProvider() {
+        assertThat(provider.get().getName(), equalTo(LogManager.ROOT_LOGGER_NAME));
+    }
+
+    @Test
+    public void testProviderMethod() {
+        Injector injector = Guice.createInjector(new AbstractModule() {
+            @Override
+            protected void configure() {
+                install(new SangriaLog4jModule());
+            }
+
+            @Provides
+            String getLoggerName(Logger logger) {
+                return logger.getName();
+            }
+        });
+
+        assertThat(injector.getInstance(String.class), equalTo(LogManager.ROOT_LOGGER_NAME));
+    }
+
+    @Test
+    public void testDeDuplication() {
+        Guice.createInjector(new SangriaLog4jModule(), new SangriaLog4jModule());
+    }
+}