DATAREDIS-284 - Add support for zCard to ZSetOperations.

'zCard' has been introduced in addition to 'size' as it feels more natural for people using redis. 'size' in 'ZSetOperations' / 'BoundZsetOperations' now delegate to 'zCard'.

Original Pull Request: #55

Author: christophstrobl

src/main/java/org/springframework/data/redis/core/BoundZSetOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2011-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
  * ZSet (or SortedSet) operations bound to a certain key.
  * 
  * @author Costin Leau
+ * @author Christoph Strobl
  */
 public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
 
@@ -72,7 +73,21 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
 
 	Long count(double min, double max);
 
+	/**
+	 * Returns the number of elements of the sorted set.
+	 * 
+	 * @return
+	 * @see #zCard()
+	 */
 	Long size();
 
+	/**
+	 * Returns the number of elements of the sorted set.
+	 * 
+	 * @return
+	 * @since 1.3
+	 */
+	Long zCard();
+
 	Double score(Object o);
 }

src/main/java/org/springframework/data/redis/core/DefaultBoundZSetOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2011-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@
  * Default implementation for {@link BoundZSetOperations}.
  * 
  * @author Costin Leau
+ * @author Christoph Strobl
  */
 class DefaultBoundZSetOperations<K, V> extends DefaultBoundKeyOperations<K> implements BoundZSetOperations<K, V> {
 
@@ -126,8 +127,22 @@ public Long count(double min, double max) {
 		return ops.count(getKey(), min, max);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.core.BoundZSetOperations#size()
+	 */
+	@Override
 	public Long size() {
-		return ops.size(getKey());
+		return zCard();
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.core.BoundZSetOperations#zCard()
+	 */
+	@Override
+	public Long zCard() {
+		return ops.zCard(getKey());
 	}
 
 	public void unionAndStore(K otherKey, K destKey) {

src/main/java/org/springframework/data/redis/core/DefaultZSetOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2011-2014 the original author or authors.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@
  * Default implementation of {@link ZSetOperations}.
  * 
  * @author Costin Leau
+ * @author Christoph Strobl
  */
 class DefaultZSetOperations<K, V> extends AbstractOperations<K, V> implements ZSetOperations<K, V> {
 
@@ -325,9 +326,23 @@ public Long doInRedis(RedisConnection connection) {
 		}, true);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.core.ZSetOperations#size(java.lang.Object)
+	 */
+	@Override
 	public Long size(K key) {
-		final byte[] rawKey = rawKey(key);
+		return zCard(key);
+	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.core.ZSetOperations#zCard(java.lang.Object)
+	 */
+	@Override
+	public Long zCard(K key) {
+
+		final byte[] rawKey = rawKey(key);
 		return execute(new RedisCallback<Long>() {
 
 			public Long doInRedis(RedisConnection connection) {

src/main/java/org/springframework/data/redis/core/ZSetOperations.java

@@ -87,7 +87,23 @@ public interface TypedTuple<V> extends Comparable<Double> {
 
 	Long count(K key, double min, double max);
 
+	/**
+	 * Returns the number of elements of the sorted set stored with given {@code key}.
+	 * 
+	 * @see #zCard(Object)
+	 * @param key
+	 * @return
+	 */
 	Long size(K key);
 
+	/**
+	 * Returns the number of elements of the sorted set stored with given {@code key}.
+	 * 
+	 * @param key
+	 * @return
+	 * @since 1.3
+	 */
+	Long zCard(K key);
+
 	RedisOperations<K, V> getOperations();
 }

src/test/java/org/springframework/data/redis/core/DefaultZSetOperationsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,16 +15,16 @@
  */
 package org.springframework.data.redis.core;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertThat;
-import static org.springframework.data.redis.matcher.RedisTestMatchers.isEqual;
+import static org.junit.Assert.*;
+import static org.springframework.data.redis.matcher.RedisTestMatchers.*;
 
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.LinkedHashSet;
 import java.util.Set;
 
+import org.hamcrest.core.IsEqual;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -39,6 +39,7 @@
  * Integration test of {@link DefaultZSetOperations}
  * 
  * @author Jennifer Hickey
+ * @author Christoph Strobl
  * @param <K> Key type
  * @param <V> Value type
  */
@@ -191,4 +192,38 @@ public void testRemove() {
 		expected.add(value2);
 		assertThat(zSetOps.range(key, 0, -1), isEqual(expected));
 	}
+
+	@Test
+	public void zCardRetrievesDataCorrectly() {
+
+		K key = keyFactory.instance();
+		V value1 = valueFactory.instance();
+		V value2 = valueFactory.instance();
+		V value3 = valueFactory.instance();
+
+		Set<TypedTuple<V>> values = new HashSet<TypedTuple<V>>();
+		values.add(new DefaultTypedTuple<V>(value1, 1.7));
+		values.add(new DefaultTypedTuple<V>(value2, 3.2));
+		values.add(new DefaultTypedTuple<V>(value3, 0.8));
+		zSetOps.add(key, values);
+
+		assertThat(zSetOps.zCard(key), IsEqual.equalTo(3L));
+	}
+
+	@Test
+	public void sizeRetrievesDataCorrectly() {
+
+		K key = keyFactory.instance();
+		V value1 = valueFactory.instance();
+		V value2 = valueFactory.instance();
+		V value3 = valueFactory.instance();
+
+		Set<TypedTuple<V>> values = new HashSet<TypedTuple<V>>();
+		values.add(new DefaultTypedTuple<V>(value1, 1.7));
+		values.add(new DefaultTypedTuple<V>(value2, 3.2));
+		values.add(new DefaultTypedTuple<V>(value3, 0.8));
+		zSetOps.add(key, values);
+
+		assertThat(zSetOps.size(key), IsEqual.equalTo(3L));
+	}
 }