Clean up and remove last bits of old codebase.

Author: John Hann

Demo.lhs

@@ -1,6 +1,6 @@
 MIT License:
 
-Copyright (c) 2005 Evan Martin <[email protected]>
+Copyright (c) 2005 NoWait, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

LICENSE

@@ -1,6 +1,3 @@
--- Memcached interface.
--- Copyright (C) 2005 Evan Martin <[email protected]>
-
 module Network.Memcache (
     module Network.Memcache.Server,
     Protocol.Expiry(..),
@@ -14,5 +11,3 @@ import Network.Memcache.Server
 import qualified Network.Memcache.Memcache as Memcache
 import Network.Memcache.Helpers
 import Network.Memcache.Cluster
-
--- vim: set ts=2 sw=2 et :

NEWS

@@ -7,7 +7,6 @@ module Network.Memcache.Cluster (
 import Network.Memcache.Server
 import Network.Memcache.Key
 import Network.Memcache.Memcache
-import qualified Network.Memcache.Protocol as P
 
 import Data.List (foldl')
 
@@ -26,12 +25,12 @@ type Distribute = [Server AutoConnection] -> String -> Server AutoConnection
 
 -- this seems ok for short keys
 -- TODO: prevent empty list of servers from getting here
-simple :: String -> [Server AutoConnection] -> Server AutoConnection
-simple k (s : []) = s
-simple k ss       = head . snd $ splitAt idx ss
+simple :: Distribute
+simple (s : []) _ = s -- single server special case
+simple ss k       = head . snd $ splitAt idx ss
   where
-    hash = foldl' (\c i -> i + c * 31) 0 . map fromEnum
     idx = (hash . toKey) k `mod` length ss
+    hash = foldl' (\c i -> i + c * 31) 0 . map fromEnum
 
 instance Memcache Cluster where
   get cl k     = get (getServer cl k) k
@@ -42,4 +41,5 @@ instance Memcache Cluster where
   incr cl k    = incr (getServer cl k) k
   decr cl k    = decr (getServer cl k) k
 
+getServer :: (Key k) => Cluster -> k -> Server AutoConnection
 getServer cl key = distribute cl (servers cl) (toKey key)

Network/Memcache.hs

@@ -1,12 +1,5 @@
--- Memcached interface.
--- Copyright (C) 2005 Evan Martin <[email protected]>
-
 module Network.Memcache.Protocol where
 
--- TODO:
---  - use exceptions where appropriate for protocol errors
---  - expiration time in store
-
 import qualified Network
 import Network.Memcache.Key
 import Network.Memcache.Serializable
@@ -49,7 +42,6 @@ data Expiry =
   Seconds Word32 | -- ^ Limited at run-time to 2592000 seconds (30 days).
   Date UTCTime
   deriving (Show)
--- figure out how to limit seconds to the memcached limit of 30 days.
 
 newtype Connection = Connection { sHandle :: Handle }
 
@@ -108,16 +100,19 @@ incDec cmd (Connection handle) key delta = do
     "NOT_FOUND" -> return Nothing
     x           -> return $ Just (read x)
 
+get :: (Key k, Serializable s) => Connection -> k -> IO (Maybe s)
 get (Connection handle) key = do
   hPutCommand handle ["get", toKey key]
-  val <- getOneValue handle
-  case val of
+  mval <- getOneValue handle
+  case mval of
     Nothing -> return Nothing
     Just val -> do
       hGetNetLn handle
       hGetNetLn handle
       return $ deserialize val
 
+-- TODO: consider throwing instead of returning bool
+delete :: (Key k) => Connection -> k -> IO Bool
 delete (Connection handle) key = do
   hPutCommand handle ["delete", toKey key]
   response <- hGetNetLn handle
@@ -130,11 +125,13 @@ expiryToWord expiry = do
     Date d    -> floor (utcTimeToPOSIXSeconds d)
     Seconds s -> safeMemcachedSeconds s
 
+thirtyDays :: Word32
 thirtyDays = 30 * 24 * 60 * 60
 
 -- | Prevents accidental converstion to Unix time by memcached
 safeMemcachedSeconds :: Word32 -> Word32
 safeMemcachedSeconds seconds = min seconds thirtyDays
 
+showFlags :: Maybe Flags -> String
 showFlags Nothing = "0"
 showFlags (Just f) = show f

Network/Memcache/Cluster.hs

@@ -1,22 +1,8 @@
--- Memcached interface.
--- Copyright (C) 2005 Evan Martin <[email protected]>
-
 module Network.Memcache.Serializable(Serializable, serialize, deserialize) where
 
 import Data.ByteString (ByteString)
 import Codec.Binary.UTF8.Light (encode, decode)
 
--- It'd be nice to use "show" for serialization, but when we
--- serialize a String we want to serialize it without the quotes.
-
--- TODO:
---  - allow serializing bytes as Ptr
---    to do this, add a "putToHandle", etc. method in Serializable
---    where the default uses serialize, but for Ptr uses socket stuff.
-
---import Foreign.Marshal.Utils
---import Foreign.Storable (Storable, sizeOf)
-
 class Serializable a where
   serialize    :: a -> ByteString
   deserialize  :: ByteString -> Maybe a

Network/Memcache/Protocol.hs

@@ -15,9 +15,8 @@ module Network.Memcache.Server (
 import qualified Network.Memcache.Protocol as P
 import qualified Network.Memcache.Memcache as MC
 
-import Control.Exception (finally, bracket)
+import Control.Exception (bracket)
 import Network (HostName, PortNumber)
-import Control.Applicative
 
 {- TODO:
     - consider some of these updates:
@@ -32,26 +31,27 @@ import Control.Applicative
 -- mc <- connect "my-mc-server"
 -- Reference: https://github.com/memcached/memcached/blob/master/doc/protocol.txt
 data Server c where
-  Disconnected {
+  Disconnected :: {
     dExpiry :: P.Expiry, -- ^ expiration
     dFlags :: Maybe P.Flags -- ^ extra bits stored with each key-value
-  } :: Server NoConnection
-  Connected {
+  } -> Server NoConnection
+  Connected :: {
     cConn :: P.Connection, -- ^ connection
     cExpiry :: P.Expiry, -- ^ expiration
     cFlags :: Maybe P.Flags -- ^ extra bits stored with each key-value
     -- ^ Note: must be memcached 1.2.1 and higher to support 32 bits
-  } :: Server P.Connection
-  AutoConnected {
+  } -> Server P.Connection
+  AutoConnected :: {
     aConn :: AutoConnection,
     aExpirty :: P.Expiry,
     aFlags :: Maybe P.Flags
-  } :: Server AutoConnection
+  } -> Server AutoConnection
 
 data NoConnection
 data AutoConnection = AutoConnection HostName (Maybe PortNumber)
 
-defaultPort = 11211 :: PortNumber
+defaultPort :: PortNumber
+defaultPort = 11211
 
 configure :: P.Expiry -> Maybe P.Flags -> Server NoConnection
 configure = Disconnected

Network/Memcache/Serializable.hs

@@ -1,20 +1,7 @@
--- Memcached interface.
--- Copyright (C) 2005 Evan Martin <[email protected]>
-
 module Network.Memcache.ServerPool where
 
 import qualified Network.Memcache.Server as S
 
 -- TODO: make sense of this or refactor it
--- TODO: consider implementing ketama:
---   http://www.last.fm/user/RJ/journal/2007/04/10/rz_libketama_-_a_consistent_hashing_algo_for_memcache_clients
--- TODO: a simple algorithm for now:
---   let server = hash key `mod` length serverlist
--- TODO: inject hash algorithm here instead of as a Key class method:
---    1. create a Distribution class
---    2. implement (instance) a simple algorithm or a ketama algorithm
-
-data Server = Server (S.Server S.NoConnection) Int
-data Pool = Pool (String -> Int)
 
--- vim: set ts=2 sw=2 et :
+data Pool = Pool [S.Server]

Network/Memcache/Server.hs

@@ -0,0 +1,3 @@
+# Haskell emcached Client
+
+TODO

Network/Memcache/ServerPool.hs

@@ -1,17 +1,17 @@
 name:                memcached
 version:             0.2.2
 stability:           Alpha
-synopsis:            haskell bindings for memcached
-description:         haskell bindings for memcached
+synopsis:            Haskell Memcached client
+description:         Haskell Memcached client
 category:            Network
 license:             OtherLicense
 license-file:        LICENSE
-author:              Evan Martin <martine@danga.com>
-maintainer:          Janrain <hackage@janrain.com>
-homepage:            http://github.com/olegkat/haskell-memcached
+author:              John Hann <john@nowait.com>
+maintainer:          John Hann <john@nowait.com>
+homepage:            http://github.com/nowaitapp/haskell-memcached
 build-type:          Simple
 
-tested-with:         GHC==6.8.2, GHC==6.10
+tested-with:         GHC==7.10.2
 
 build-depends:
   base >3 && <5,