added Iterable interface to Ref type

Author: Byron

Diff for: lib/git/objects/commit.py

@@ -140,7 +140,7 @@ def iter_items(cls, repo, ref, path='', **kwargs):
 			``skip`` is the number of commits to skip
 
 		Returns
-			git.Commit[]
+			iterator yielding Commit items
 		"""
 		options = {'pretty': 'raw'}
 		options.update(kwargs)

Diff for: lib/git/refs.py

@@ -8,9 +8,9 @@
 """
 from objects.base import Object
 from objects.utils import get_object_type_by_name
-from utils import LazyMixin
+from utils import LazyMixin, Iterable
 
-class Ref(LazyMixin):
+class Ref(LazyMixin, Iterable):
 	"""
 	Represents a named reference to any object
 	"""
@@ -73,7 +73,7 @@ def name(self):
 		return '/'.join(tokens[2:])
 
 	@classmethod
-	def list_items(cls, repo, common_path = "refs", **kwargs):
+	def iter_items(cls, repo, common_path = "refs", **kwargs):
 		"""
 		Find all refs in the repository
 
@@ -102,15 +102,15 @@ def list_items(cls, repo, common_path = "refs", **kwargs):
 		options.update(kwargs)
 
 		output = repo.git.for_each_ref(common_path, **options)
-		return cls._list_from_string(repo, output)
+		return cls._iter_from_stream(repo, iter(output.splitlines()))
 
 	@classmethod
-	def _list_from_string(cls, repo, text):
+	def _iter_from_stream(cls, repo, stream):
 		""" Parse out ref information into a list of Ref compatible objects
 		Returns git.Ref[] list of Ref objects """
 		heads = []
 
-		for line in text.splitlines():
+		for line in stream:
 			heads.append(cls._from_string(repo, line))
 
 		return heads
@@ -158,14 +158,14 @@ def commit(self):
 		return self.object
 
 	@classmethod
-	def list_items(cls, repo, common_path = "refs/heads", **kwargs):
+	def iter_items(cls, repo, common_path = "refs/heads", **kwargs):
 		"""
 		Returns
-			git.Head[]
+			Iterator yielding Head items
 			
 		For more documentation, please refer to git.base.Ref.list_items
 		"""
-		return super(Head,cls).list_items(repo, common_path, **kwargs)
+		return super(Head,cls).iter_items(repo, common_path, **kwargs)
 
 	def __repr__(self):
 		return '<git.Head "%s">' % self.name
@@ -215,14 +215,14 @@ def tag(self):
 		return None
 
 	@classmethod
-	def list_items(cls, repo, common_path = "refs/tags", **kwargs):
+	def iter_items(cls, repo, common_path = "refs/tags", **kwargs):
 		"""
 		Returns
-			git.Tag[]
+			Iterator yielding commit items
 			
 		For more documentation, please refer to git.base.Ref.list_items
 		"""
-		return super(TagRef,cls).list_items(repo, common_path, **kwargs)
+		return super(TagRef,cls).iter_items(repo, common_path, **kwargs)
 
 
 # provide an alias