Fixed formatting on TODO.rst

sigmavirus24 · sigmavirus24 · commit 5708490ba8bd · 2012-09-28T13:53:46.000-04:00
Added the first iterator! Also a test for it.
diff --git a/TODO.rst b/TODO.rst
@@ -12,10 +12,10 @@ unittests
 - We're currently at ~92% coverage. I want to get each module close to if not 
   above 90% coverage before December. 100% by next year (at the latest).
 
-    + The major hurtle now are github3.github and github3.repos. Both contain 
-      functions/functionality that will be very difficult to design test cases 
-      for, e.g., creating a pull request, creating a pull request from an 
-      existing issue, creating a commit object, etc.
+  + The major hurtle now are github3.github and github3.repos. Both contain 
+    functions/functionality that will be very difficult to design test cases 
+    for, e.g., creating a pull request, creating a pull request from an 
+    existing issue, creating a commit object, etc.
 
 .. links
 
@@ -48,61 +48,61 @@ Plan
 
     ::
 
-        def iter_issues(self, milestone=None, state=None, assignee=None,
-            mentioned=None, labels=None, sort=None, direction=None,
-            since=None, count=-1):
-            """Iterates over issues on this repo based upon parameters passed.
-
-            :param milestone: (optional), 'none', or '*'
-            :type milestone: int
-            :param state: (optional), accepted values: ('open', 'closed')
-            :type state: str
-            :param assignee: (optional), 'none', '*', or login name
-            :type assignee: str
-            :param mentioned: (optional), user's login name
-            :type mentioned: str
-            :param labels: (optional), comma-separated list of labels, e.g.
-                'bug,ui,@high' :param sort: accepted values:
-                ('created', 'updated', 'comments', 'created')
-            :type labels: str
-            :param direction: (optional), accepted values: ('open', 'closed')
-            :type direction: str
-            :param since: (optional), ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
-            :type since: str
-            :param int count: (optional), numer of issues to iterate over, -1
-                iterates over all issues
-            """
-            def issues_left():
-                return count == -1 or count > 0
-
-            url = self._build_url('issues', base_url=self._api)
-
-            params = {}
-            if milestone in ('*', 'none') or isinstance(milestone, int):
-                params['milestone'] = str(milestone).lower()
-
-            if assignee:
-                params['assignee'] = assignee
-
-            if mentioned:
-                params['mentioned'] = mentioned
-
-            params.update(issue_params(None, state, labels, sort, direction,
-                since))
-
-            count = int(count)
-
-            while issues_left() and url:
-                response = self._get(url)
-                json = self._json(response, 200)
-                for i in json:
-                    yield Issue(i, self)
-                    count -= 1
-                    if count == 0:
-                        break
-
-                rel_next = response.links.get('rel_next', {})
-                url = rel_next.get('url', '')
-
-    Naturally, ``issues_left()`` will not be nested into each iterator,  but 
-    for the purposes of this example, it is easier to define it there.
+      def iter_issues(self, milestone=None, state=None, assignee=None,
+          mentioned=None, labels=None, sort=None, direction=None,
+          since=None, count=-1):
+          """Iterates over issues on this repo based upon parameters passed.
+
+          :param milestone: (optional), 'none', or '*'
+          :type milestone: int
+          :param state: (optional), accepted values: ('open', 'closed')
+          :type state: str
+          :param assignee: (optional), 'none', '*', or login name
+          :type assignee: str
+          :param mentioned: (optional), user's login name
+          :type mentioned: str
+          :param labels: (optional), comma-separated list of labels, e.g.
+              'bug,ui,@high' :param sort: accepted values:
+              ('created', 'updated', 'comments', 'created')
+          :type labels: str
+          :param direction: (optional), accepted values: ('open', 'closed')
+          :type direction: str
+          :param since: (optional), ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+          :type since: str
+          :param int count: (optional), numer of issues to iterate over, -1
+              iterates over all issues
+          """
+          def issues_left():
+              return count == -1 or count > 0
+
+          url = self._build_url('issues', base_url=self._api)
+
+          params = {}
+          if milestone in ('*', 'none') or isinstance(milestone, int):
+              params['milestone'] = str(milestone).lower()
+
+          if assignee:
+              params['assignee'] = assignee
+
+          if mentioned:
+              params['mentioned'] = mentioned
+
+          params.update(issue_params(None, state, labels, sort, direction,
+              since))
+
+          count = int(count)
+
+          while issues_left() and url:
+              response = self._get(url)
+              json = self._json(response, 200)
+              for i in json:
+                  yield Issue(i, self)
+                  count -= 1
+                  if count == 0:
+                      break
+
+              rel_next = response.links.get('rel_next', {})
+              url = rel_next.get('url', '')
+
+  Naturally, ``issues_left()`` will not be nested into each iterator,  but for 
+  the purposes of this example, it is easier to define it there.
diff --git a/github3/issues.py b/github3/issues.py
@@ -297,6 +297,15 @@ def is_closed(self):
             return True
         return False
 
+    def iter_comments(self, number=-1):
+        """Iterate over the comments on this issue.
+
+        :param int number: (optional), number of comments to iterate over
+        :returns: iterator of :class:`IssueComment <IssueComment>`
+        """
+        url = self._build_url('comments', base_url=self._api)
+        return self._iter(int(number), url, IssueComment)
+
     def list_comments(self):
         """List comments on this issue.
 
diff --git a/github3/models.py b/github3/models.py
@@ -142,6 +142,22 @@ def _api(self):
     def _api(self, uri):
         self._uri = urlparse(uri)
 
+    def _iter(self, count, url, cls):
+        def remaining():
+            return count == -1 or count > 0
+
+        while remaining() and url:
+            response = self._get(url)
+            json = self._json(response, 200)
+            for i in json:
+                yield cls(i, self)
+                count -= 1
+                if not remaining():
+                    break
+
+            rel_next = response.links.get('rel_next', {})
+            url = rel_next.get('url', '')
+
     @property
     def ratelimit_remaining(self):
         """Number of requests before GitHub imposes a ratelimit."""
diff --git a/tests/test_issues.py b/tests/test_issues.py
@@ -57,6 +57,9 @@ def test_milestone(self):
         if self.issue.milestone:
             expect(self.issue.milestone).isinstance(Milestone)
 
+    def test_iter_comments(self):
+        expect(self.issue.iter_comments().next()).isinstance(IssueComment)
+
     def test_list_comments(self):
         self.expect_list_of_class(self.issue.list_comments(), IssueComment)
 
