Using document_id as arg name to match Google's implementation. (#49)

* Using document_id as arg name to match Google's implementation. * Adding a test and a README entry for the document_id kwarg.

Author: brycethornton

README.md

@@ -57,6 +57,7 @@ mock_db.collection('users').document('alovelace').update({'favourite.color': 're
 mock_db.collection('users').document('alovelace').update({'associates': ['Charles Babbage', 'Michael Faraday']})
 mock_db.collection('users').document('alovelace').collection('friends')
 mock_db.collection('users').document('alovelace').delete()
+mock_db.collection('users').document(document_id: 'alovelace').delete()
 mock_db.collection('users').add({'first': 'Ada', 'last': 'Lovelace'}, 'alovelace')
 mock_db.get_all([mock_db.collection('users').document('alovelace')])
 mock_db.document('users/alovelace')

mockfirestore/collection.py

@@ -14,12 +14,12 @@ def __init__(self, data: Store, path: List[str],
  self._path = path
  self.parent = parent
 
- def document(self, name: Optional[str] = None) -> DocumentReference:
+ def document(self, document_id: Optional[str] = None) -> DocumentReference:
  collection = get_by_path(self._data, self._path)
- if name is None:
- name = generate_random_string()
- new_path = self._path + [name]
- if name not in collection:
+ if document_id is None:
+ document_id = generate_random_string()
+ new_path = self._path + [document_id]
+ if document_id not in collection:
  set_by_path(self._data, new_path, {})
  return DocumentReference(self._data, new_path, parent=self)
 

tests/test_collection_reference.py

@@ -489,3 +489,11 @@ def test_collection_addDocument(self):
 
  with self.assertRaises(AlreadyExists):
  fs.collection('foo').add(doc_content)
+
+ def test_collection_useDocumentIdKwarg(self):
+ fs = MockFirestore()
+ fs._data = {'foo': {
+ 'first': {'id': 1}
+ }}
+ doc = fs.collection('foo').document(document_id='first').get()
+ self.assertEqual({'id': 1}, doc.to_dict())