Merge pull request #38 from Mordil/namespacing

Namespace global static factory methods under `Redis`

Author: Mordil

Sources/NIORedis/Extensions/NIO/ClientBootstrap.swift

@@ -0,0 +1,71 @@
+import struct Logging.Logger
+import NIO
+
+/// Top-level namespace for the `NIORedis` package.
+///
+/// To avoid a cluttered global namespace, named definitions that do not start with a `Redis` prefix
+/// are scoped within this namespace.
+public enum Redis { }
+
+// MARK: ClientBootstrap
+
+extension Redis {
+    /// Makes a new `ClientBootstrap` instance with a default Redis `Channel` pipeline
+    /// for sending and receiving messages in Redis Serialization Protocol (RESP) format.
+    ///
+    /// See `RESPEncoder`, `RESPDecoder`, and `CommandHandler`.
+    /// - Parameter using: The `EventLoopGroup` to build the `ClientBootstrap` on.
+    /// - Returns: A `ClientBootstrap` with the default configuration of a `Channel` pipeline for RESP messages.
+    public static func makeDefaultClientBootstrap(using group: EventLoopGroup) -> ClientBootstrap {
+        return ClientBootstrap(group: group)
+            .channelOption(
+                ChannelOptions.socket(SocketOptionLevel(SOL_SOCKET), SO_REUSEADDR),
+                value: 1
+            )
+            .channelInitializer { $0.pipeline.addHandlers([
+                MessageToByteHandler(RESPEncoder()),
+                ByteToMessageHandler(RESPDecoder()),
+                RedisCommandHandler()
+            ])}
+    }
+}
+
+// MARK: Connection Factory
+
+extension Redis {
+    /// Makes a new connection to a Redis instance.
+    ///
+    /// Example:
+    ///
+    ///     let elg = MultiThreadedEventLoopGroup(numberOfThreads: 1)
+    ///     let connection = Redis.makeConnection(
+    ///         to: .init(ipAddress: "127.0.0.1", port: 6379),
+    ///         using: elg
+    ///     )
+    ///
+    /// - Parameters:
+    ///     - socket: The `SocketAddress` information of the Redis instance to connect to.
+    ///     - password: The optional password to authorize the client with.
+    ///     - eventLoopGroup: The `EventLoopGroup` to build the connection on.
+    ///     - logger: The `Logger` instance to log with.
+    /// - Returns: A `RedisConnection` instance representing this new connection.
+    public static func makeConnection(
+        to socket: SocketAddress,
+        using group: EventLoopGroup,
+        with password: String? = nil,
+        logger: Logger = Logger(label: "NIORedis.RedisConnection")
+    ) -> EventLoopFuture<RedisConnection> {
+        let bootstrap = makeDefaultClientBootstrap(using: group)
+
+        return bootstrap.connect(to: socket)
+            .map { return RedisConnection(channel: $0, logger: logger) }
+            .flatMap { client in
+                guard let pw = password else {
+                    return group.next().makeSucceededFuture(client)
+                }
+
+                return client.send(command: "AUTH", with: [pw])
+                    .map { _ in return client }
+            }
+    }
+}

Sources/NIORedis/Extensions/NIO/EventLoopFuture.swift renamed to Sources/NIORedis/Extensions/SwiftNIO.swift

@@ -153,32 +153,3 @@ public final class RedisConnection: RedisClient {
         return promise.futureResult
     }
 }
-
-extension RedisConnection {
-    /// Makes a client connection to a Redis instance.
-    /// - Parameters:
-    ///     - socket: The `SocketAddress` information of the Redis instance to connect to.
-    ///     - password: The optional password to authorize the client with.
-    ///     - eventLoopGroup: The `EventLoopGroup` to build the connection on.
-    ///     - logger: The `Logger` instance to log with.
-    /// - Returns: A `RedisClient` instance representing this new connection.
-    public static func connect(
-        to socket: SocketAddress,
-        with password: String? = nil,
-        on eventLoopGroup: EventLoopGroup,
-        logger: Logger = Logger(label: "NIORedis.RedisConnection")
-    ) -> EventLoopFuture<RedisConnection> {
-        let bootstrap = ClientBootstrap.makeRedisDefault(using: eventLoopGroup)
-
-        return bootstrap.connect(to: socket)
-            .map { return RedisConnection(channel: $0, logger: logger) }
-            .flatMap { client in
-                guard let pw = password else {
-                    return eventLoopGroup.next().makeSucceededFuture(client)
-                }
-
-                return client.send(command: "AUTH", with: [pw])
-                    .map { _ in return client }
-            }
-    }
-}

Sources/NIORedis/Redis.swift

@@ -6,7 +6,7 @@ final class BasicCommandsTests: XCTestCase {
 
     override func setUp() {
         do {
-            connection = try RedisConnection.connect().wait()
+            connection = try Redis.makeConnection().wait()
         } catch {
             XCTFail("Failed to create RedisConnection! \(error)")
         }

Sources/NIORedis/RedisClient.swift

@@ -6,7 +6,7 @@ final class HashCommandsTests: XCTestCase {
 
     override func setUp() {
         do {
-            connection = try RedisConnection.connect().wait()
+            connection = try Redis.makeConnection().wait()
         } catch {
             XCTFail("Failed to create RedisConnection! \(error)")
         }

Tests/NIORedisTests/Commands/BasicCommandsTests.swift

@@ -6,7 +6,7 @@ final class ListCommandsTests: XCTestCase {
 
     override func setUp() {
         do {
-            connection = try RedisConnection.connect().wait()
+            connection = try Redis.makeConnection().wait()
         } catch {
             XCTFail("Failed to create RedisConnection! \(error)")
         }

Tests/NIORedisTests/Commands/HashCommandsTests.swift

@@ -6,7 +6,7 @@ final class SetCommandsTests: XCTestCase {
 
     override func setUp() {
         do {
-            connection = try RedisConnection.connect().wait()
+            connection = try Redis.makeConnection().wait()
         } catch {
             XCTFail("Failed to create RedisConnection! \(error)")
         }

Tests/NIORedisTests/Commands/ListCommandsTests.swift

@@ -10,7 +10,7 @@ final class SortedSetCommandsTests: XCTestCase {
 
     override func setUp() {
         do {
-            connection = try RedisConnection.connect().wait()
+            connection = try Redis.makeConnection().wait()
 
             var dataset: [(RESPValueConvertible, Double)] = []
             for index in 1...10 {

Tests/NIORedisTests/Commands/SetCommandsTests.swift

@@ -8,7 +8,7 @@ final class StringCommandsTests: XCTestCase {
 
     override func setUp() {
         do {
-            connection = try RedisConnection.connect().wait()
+            connection = try Redis.makeConnection().wait()
         } catch {
             XCTFail("Failed to create RedisConnection! \(error)")
         }