refactor!: Renamed spring module and added sample demo

subprojects/spring-lettucemod/gradle.properties → core/lettucemod-spring/gradle.properties

@@ -1,4 +1,4 @@
-project_description = Spring LettuceMod
+project_description = LettuceMod Spring
 
 sourceCompatibility        = 17
 targetCompatibility        = 17

subprojects/spring-lettucemod/spring-lettucemod.gradle → core/lettucemod-spring/lettucemod-spring.gradle

@@ -3,10 +3,4 @@ dependencies {
     api project(':lettucemod')
     api 'org.apache.commons:commons-pool2'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
-}
-
-eclipse {
-    project {
-        name = 'lettucemod-spring'
-    }
 }

subprojects/spring-lettucemod/src/main/java/com/redis/spring/lettucemod/RedisModulesAutoConfiguration.java → core/lettucemod-spring/src/main/java/com/redis/lettucemod/spring/RedisModulesAutoConfiguration.java

@@ -1,17 +1,18 @@
-package com.redis.spring.lettucemod;
+package com.redis.lettucemod.spring;
 
 import java.time.Duration;
 
 import org.apache.commons.pool2.impl.GenericObjectPool;
 import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.data.redis.RedisProperties;
 import org.springframework.boot.autoconfigure.data.redis.RedisProperties.Lettuce.Cluster.Refresh;
 import org.springframework.boot.autoconfigure.data.redis.RedisProperties.Pool;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.util.CollectionUtils;
 import org.springframework.util.StringUtils;
 
 import com.redis.lettucemod.RedisModulesClient;
@@ -31,7 +32,7 @@
 import io.lettuce.core.support.ConnectionPoolSupport;
 
 @Configuration(proxyBeanMethods = false)
-@EnableConfigurationProperties({ RedisProperties.class })
+@EnableConfigurationProperties(RedisProperties.class)
 public class RedisModulesAutoConfiguration {
 
 	@Bean
@@ -70,13 +71,10 @@ ClientResources clientResources() {
 		return DefaultClientResources.create();
 	}
 
-	@Bean(destroyMethod = "shutdown")
-	AbstractRedisClient client(RedisURI redisURI, RedisProperties properties, ClientResources clientResources) {
-		if (properties.getCluster() == null || CollectionUtils.isEmpty(properties.getCluster().getNodes())) {
-			RedisModulesClient client = RedisModulesClient.create(clientResources, redisURI);
-			client.setOptions(clientOptions(ClientOptions.builder(), properties).build());
-			return client;
-		}
+	@Bean(destroyMethod = "shutdown", name = "redisModulesClusterClient")
+	@ConditionalOnProperty(name = "spring.data.redis.cluster.nodes[0]")
+	RedisModulesClusterClient clusterClient(RedisURI redisURI, RedisProperties properties,
+			ClientResources clientResources) {
 		RedisModulesClusterClient client = RedisModulesClusterClient.create(clientResources, redisURI);
 		ClusterClientOptions.Builder builder = ClusterClientOptions.builder();
 		Refresh refreshProperties = properties.getLettuce().getCluster().getRefresh();
@@ -93,6 +91,15 @@ AbstractRedisClient client(RedisURI redisURI, RedisProperties properties, Client
 		return client;
 	}
 
+	@Bean(destroyMethod = "shutdown", name = "redisModulesClient")
+	@ConditionalOnMissingBean(name = "redisModulesClusterClient")
+	RedisModulesClient redisModulesClient(RedisURI redisURI, RedisProperties properties,
+			ClientResources clientResources) {
+		RedisModulesClient client = RedisModulesClient.create(clientResources, redisURI);
+		client.setOptions(clientOptions(ClientOptions.builder(), properties).build());
+		return client;
+	}
+
 	@Bean(name = "redisConnection", destroyMethod = "close")
 	@ConditionalOnBean(AbstractRedisClient.class)
 	StatefulRedisModulesConnection<String, String> redisConnection(AbstractRedisClient client) {

subprojects/spring-lettucemod/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports → core/lettucemod-spring/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -1,2 +1,2 @@
-com.redis.spring.lettucemod.RedisModulesAutoConfiguration
+com.redis.lettucemod.spring.RedisModulesAutoConfiguration
 org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration

subprojects/spring-lettucemod/src/test/java/com/redis/spring/lettucemod/AutoConfigurationTests.java → core/lettucemod-spring/src/test/java/com/redis/spring/lettucemod/AutoConfigurationTests.java

@@ -12,10 +12,14 @@
 import org.testcontainers.junit.jupiter.Testcontainers;
 
 import com.redis.lettucemod.RedisModulesClient;
+import com.redis.lettucemod.RedisModulesUtils;
 import com.redis.lettucemod.api.StatefulRedisModulesConnection;
+import com.redis.lettucemod.cluster.RedisModulesClusterClient;
 import com.redis.lettucemod.search.Suggestion;
+import com.redis.lettucemod.spring.RedisModulesAutoConfiguration;
 import com.redis.testcontainers.RedisStackContainer;
 
+import io.lettuce.core.AbstractRedisClient;
 import io.lettuce.core.resource.ClientResources;
 
 /**
@@ -37,12 +41,17 @@ class AutoConfigurationTests {
 	@Test
 	void defaultConfiguration() {
 		this.contextRunner.run((context) -> {
-			assertThat(context.getBean("client")).isInstanceOf(RedisModulesClient.class);
-			assertThat(context).hasSingleBean(RedisModulesClient.class);
+			assertThat(context).hasSingleBean(AbstractRedisClient.class);
+			if (context.containsBean("redisModulesClient")) {
+				assertThat(context.getBean("redisModulesClient")).isInstanceOf(RedisModulesClient.class);
+			}
+			if (context.containsBean("redisModulesClusterClient")) {
+				assertThat(context.getBean("redisModulesClusterClient")).isInstanceOf(RedisModulesClusterClient.class);
+			}
 			assertThat(context).hasSingleBean(StatefulRedisModulesConnection.class);
 			assertThat(context).hasSingleBean(ClientResources.class);
-			RedisModulesClient client = context.getBean(RedisModulesClient.class);
-			StatefulRedisModulesConnection<String, String> connection = client.connect();
+			AbstractRedisClient client = context.getBean(AbstractRedisClient.class);
+			StatefulRedisModulesConnection<String, String> connection = RedisModulesUtils.connection(client);
 			String key = "suggestIdx";
 			connection.sync().ftSugadd(key, Suggestion.of("rome", 1));
 			connection.sync().ftSugadd(key, Suggestion.of("romarin", 1));

samples/lettucemod-spring-demo/gradle.properties

@@ -0,0 +1,6 @@
+project_description = Spring LettuceMod Demo
+
+sourceCompatibility        = 17
+targetCompatibility        = 17
+testSourceCompatibility    = 17
+testTargetCompatibility    = 17

samples/lettucemod-spring-demo/lettucemod-spring-demo.gradle

@@ -0,0 +1,4 @@
+dependencies {
+	implementation 'org.springframework.boot:spring-boot-starter'
+	implementation project(':lettucemod-spring')
+}

samples/lettucemod-spring-demo/src/main/java/com/redis/spring/lettucemod/demo/LettucemodSpringDemoApplication.java

@@ -0,0 +1,13 @@
+package com.redis.spring.lettucemod.demo;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class LettucemodSpringDemoApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(LettucemodSpringDemoApplication.class, args);
+	}
+
+}

samples/lettucemod-spring-demo/src/main/java/com/redis/spring/lettucemod/demo/RedisService.java

@@ -0,0 +1,37 @@
+package com.redis.spring.lettucemod.demo;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.stereotype.Component;
+
+import com.redis.lettucemod.RedisModulesUtils;
+import com.redis.lettucemod.api.StatefulRedisModulesConnection;
+
+import io.lettuce.core.AbstractRedisClient;
+
+@Component
+public class RedisService implements InitializingBean {
+
+	private final Logger log = LoggerFactory.getLogger(getClass());
+
+	private final AbstractRedisClient client;
+
+	public RedisService(AbstractRedisClient client) {
+		this.client = client;
+	}
+
+	@Override
+	public void afterPropertiesSet() throws Exception {
+		log.info("Pinging Redis");
+		StatefulRedisModulesConnection<String, String> connection = RedisModulesUtils.connection(client);
+		String reply = connection.sync().ping();
+		if ("PONG".equalsIgnoreCase(reply)) {
+			log.info("Successfully pinged Redis (response: {})", reply);
+		} else {
+			log.error("Failed to ping Redis (response: {})", reply);
+		}
+
+	}
+
+}

samples/lettucemod-spring-demo/src/main/resources/application.properties

@@ -0,0 +1 @@
+spring.application.name=lettucemod-spring-demo

settings.gradle

@@ -18,7 +18,7 @@ apply plugin: 'org.kordamp.gradle.kordamp-parentbuild'
 rootProject.name = 'lettucemod'
 
 projects {
-    directories = ['subprojects']
+    directories = ['core', 'samples']
 
     plugins {
         all {
@@ -27,7 +27,7 @@ projects {
         path(':') {
             id 'org.kordamp.gradle.java-project'
         }
-        dirs(['subprojects']) {
+        dirs(['core', 'samples']) {
             id 'java-library'
             id 'org.springframework.boot'
             id 'io.spring.dependency-management'