Rename EnvironmentVariableFixture to EnvironmentVariable.

6 files changed, 32 insertions, 19 deletions

diff --git a/NEWS b/NEWS
index 550c979..2bf0a82 100644
--- a/NEWS
+++ b/NEWS
@@ -8,6 +8,10 @@ IN DEVELOPMENT
 
 CHANGES:
 
+* EnvironmentVariableFixture renamed to EnvironmentVariable. Still available
+  under old, deprecated name.
+  (Jonathan Lange, #893539)
+
 * EnvironmentVariableFixture now upcalls via super().
   (Jonathan Lange, #881120)
 
diff --git a/README b/README
index e00bcd8..8ced198 100644
--- a/README
+++ b/README
@@ -266,13 +266,13 @@ In addition to the Fixture, FunctionFixture and MethodFixture classes fixtures
 includes a number of precanned fixtures. The API docs for fixtures will list
 the complete set of these, should the dcs be out of date or not to hand.
 
-EnvironmentVariableFixture
-++++++++++++++++++++++++++
+EnvironmentVariable
++++++++++++++++++++
 
 Isolate your code from environmental variables, delete them or set them to a
 new value.
 
-  >>> fixture = fixtures.EnvironmentVariableFixture('HOME')
+  >>> fixture = fixtures.EnvironmentVariable('HOME')
 
 LoggerFixture
 +++++++++++++
diff --git a/lib/fixtures/__init__.py b/lib/fixtures/__init__.py
index 1d1948b..c86545f 100644
--- a/lib/fixtures/__init__.py
+++ b/lib/fixtures/__init__.py
@@ -39,6 +39,7 @@ Most users will want to look at TestWithFixtures and Fixture, to start with.
 __version__ = (0, 3, 8, 'beta', 0)
 
 __all__ = [
+    'EnvironmentVariable',
     'EnvironmentVariableFixture',
     'Fixture',
     'FunctionFixture',
@@ -56,6 +57,7 @@ __all__ = [
 
 from fixtures.fixture import Fixture, FunctionFixture, MethodFixture
 from fixtures._fixtures import (
+    EnvironmentVariable,
     EnvironmentVariableFixture,
     LoggerFixture,
     MonkeyPatch,
diff --git a/lib/fixtures/_fixtures/__init__.py b/lib/fixtures/_fixtures/__init__.py
index 082c936..59f93f9 100644
--- a/lib/fixtures/_fixtures/__init__.py
+++ b/lib/fixtures/_fixtures/__init__.py
@@ -17,6 +17,7 @@
 """Included fixtures."""
 
 __all__ = [
+    'EnvironmentVariable',
     'EnvironmentVariableFixture',
     'LoggerFixture',
     'MonkeyPatch',
@@ -28,7 +29,10 @@ __all__ = [
     ]
 
 
-from fixtures._fixtures.environ import EnvironmentVariableFixture
+from fixtures._fixtures.environ import (
+    EnvironmentVariable,
+    EnvironmentVariableFixture,
+    )
 from fixtures._fixtures.logger import LoggerFixture
 from fixtures._fixtures.monkeypatch import MonkeyPatch
 from fixtures._fixtures.popen import PopenFixture
diff --git a/lib/fixtures/_fixtures/environ.py b/lib/fixtures/_fixtures/environ.py
index a0f36cc..5494429 100644
--- a/lib/fixtures/_fixtures/environ.py
+++ b/lib/fixtures/_fixtures/environ.py
@@ -14,6 +14,7 @@
 # limitations under that license.
 
 __all__ = [
+    'EnvironmentVariable',
     'EnvironmentVariableFixture'
     ]
 
@@ -22,11 +23,11 @@ import os
 from fixtures import Fixture
 
 
-class EnvironmentVariableFixture(Fixture):
+class EnvironmentVariable(Fixture):
     """Isolate a specific environment variable."""
 
     def __init__(self, varname, newvalue=None):
-        """Create an EnvironmentVariableFixture.
+        """Create an EnvironmentVariable fixture.
 
         :param varname: the name of the variable to isolate.
         :param newvalue: A value to set the variable to. If None, the variable
@@ -35,12 +36,12 @@ class EnvironmentVariableFixture(Fixture):
         During setup the variable will be deleted or assigned the requested
         value, and this will be restored in cleanUp.
         """
-        Fixture.__init__(self)
+        super(EnvironmentVariable, self).__init__()
         self.varname = varname
         self.newvalue = newvalue
 
     def setUp(self):
-        super(EnvironmentVariableFixture, self).setUp()
+        super(EnvironmentVariable, self).setUp()
         varname = self.varname
         orig_value = os.environ.get(varname)
         if orig_value is not None:
@@ -52,3 +53,6 @@ class EnvironmentVariableFixture(Fixture):
             os.environ[varname] = self.newvalue
         else:
             os.environ.pop(varname, '')
+
+
+EnvironmentVariableFixture = EnvironmentVariable
diff --git a/lib/fixtures/tests/_fixtures/test_environ.py b/lib/fixtures/tests/_fixtures/test_environ.py
index c08d510..a213586 100644
--- a/lib/fixtures/tests/_fixtures/test_environ.py
+++ b/lib/fixtures/tests/_fixtures/test_environ.py
@@ -17,59 +17,58 @@ import os
 
 import testtools
 
-import fixtures
-from fixtures import EnvironmentVariableFixture, TestWithFixtures
+from fixtures import EnvironmentVariable, TestWithFixtures
 
 
-class TestEnvironmentVariableFixture(testtools.TestCase, TestWithFixtures):
+class TestEnvironmentVariable(testtools.TestCase, TestWithFixtures):
 
     def test_setup_ignores_missing(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR')
         os.environ.pop('FIXTURES_TEST_VAR', '')
         self.useFixture(fixture)
         self.assertEqual(None, os.environ.get('FIXTURES_TEST_VAR'))
 
     def test_setup_sets_when_missing(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR', 'bar')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR', 'bar')
         os.environ.pop('FIXTURES_TEST_VAR', '')
         self.useFixture(fixture)
         self.assertEqual('bar', os.environ.get('FIXTURES_TEST_VAR'))
 
     def test_setup_deletes(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR')
         os.environ['FIXTURES_TEST_VAR'] = 'foo'
         self.useFixture(fixture)
         self.assertEqual(None, os.environ.get('FIXTURES_TEST_VAR'))
 
     def test_setup_overrides(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR', 'bar')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR', 'bar')
         os.environ['FIXTURES_TEST_VAR'] = 'foo'
         self.useFixture(fixture)
         self.assertEqual('bar', os.environ.get('FIXTURES_TEST_VAR'))
 
     def test_cleanup_deletes_when_missing(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR')
         os.environ.pop('FIXTURES_TEST_VAR', '')
         with fixture:
             os.environ['FIXTURES_TEST_VAR'] = 'foo'
         self.assertEqual(None, os.environ.get('FIXTURES_TEST_VAR'))
         
     def test_cleanup_deletes_when_set(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR', 'bar')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR', 'bar')
         os.environ.pop('FIXTURES_TEST_VAR', '')
         with fixture:
             os.environ['FIXTURES_TEST_VAR'] = 'foo'
         self.assertEqual(None, os.environ.get('FIXTURES_TEST_VAR'))
 
     def test_cleanup_restores_when_missing(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR')
         os.environ['FIXTURES_TEST_VAR'] = 'bar'
         with fixture:
             os.environ.pop('FIXTURES_TEST_VAR', '')
         self.assertEqual('bar', os.environ.get('FIXTURES_TEST_VAR'))
         
     def test_cleanup_restores_when_set(self):
-        fixture = EnvironmentVariableFixture('FIXTURES_TEST_VAR')
+        fixture = EnvironmentVariable('FIXTURES_TEST_VAR')
         os.environ['FIXTURES_TEST_VAR'] = 'bar'
         with fixture:
             os.environ['FIXTURES_TEST_VAR'] = 'quux'