Merge pull request #46 from jacebrowning/release/v0.4

Release v0.4

Author: jacebrowning

.pylintrc

@@ -1,22 +1,15 @@
 [MESSAGES CONTROL]
 
-# I0011: Locally disabling warning
-# W0142: Used * or ** magic
-# W0511: TODO in comments
-# RO903: Too few public methods
-# R0904: Too many public methods
-# C0103: Invalid constant name
-# R0901: Too many ancestors
-disable=I0011,W0142,W0511,R0903,R0904,C0103,R0901
-
-[REPORTS]
-
-reports=no
-
-msg-template={msg_id}:{line:3d},{column}:{msg}
+disable=locally-disabled,fixme,too-few-public-methods,too-many-public-methods,invalid-name,global-statement,too-many-ancestors
 
 [FORMAT]
 
 max-line-length=80
 
 ignore-long-lines=^.*((https?:)|(pragma:)|(TODO:)).*$
+
+[REPORTS]
+
+reports=no
+
+msg-template={msg_id} ({symbol}):{line:3d},{column}: {msg}

.travis.yml

@@ -4,12 +4,16 @@ language: python
 python:
 - 3.3
 - 3.4
+- 3.5
 
 cache: pip
 
 before_install:
 - sudo add-apt-repository ppa:git-core/ppa -y
 - sudo apt-get update
+env:
+  global:
+  - RANDOM_SEED=12345
 
 install:
 - sudo apt-get install git; git --version

CHANGES.md

@@ -1,6 +1,15 @@
 Revision History
 ================
 
+0.4 (2015/09/18)
+----------------
+
+- Replaced 'install' command with 'update'.
+- Updated 'install' command to use locked dependency versions.
+- Now sorting sources after a successful 'update'.
+- Now requiring '--force' to 'uninstall' with uncommitted changes.
+- Updated 'list' command to show full shell commands.
+
 0.3.1 (2015/09/09)
 ------------------
 
@@ -9,34 +18,34 @@ Revision History
 0.3 (2015/06/26)
 ----------------
 
-- Add '--no-clean' option to disable removing untracked files.
-- Add support for `rev-parse` dates as the dependency `rev`.
+- Added '--no-clean' option to disable removing untracked files.
+- Added support for `rev-parse` dates as the dependency `rev`.
 
 0.2.5 (2015/06/15)
 ------------------
 
-- Hide warnings with '--quiet' option.
+- Added '--quiet' option to hide warnings.
 
 0.2.4 (2015/05/19)
 ------------------
 
-- Hide YORM logging bellow warnings.
+- Now hiding YORM logging bellow warnings.
 
 0.2.3 (2015/05/17)
 ------------------
 
-- Upgrade to YORM v0.4
+- Upgraded to YORM v0.4.
 
 0.2.2 (2015/05/04)
 ------------------
 
-- Require YORM < v0.4
+- Specified YORM < v0.4.
 
 0.2.1 (2015/03/12)
 ------------------
 
-- Automatically track dependencies that are on branches.
-- Require '--force' when there are untracked files.
+- Added automatic remote branch tracking in dependencies.
+- Now requiring '--force' when there are untracked files.
 
 0.2 (2015/03/10)
 ----------------

Makefile

@@ -9,7 +9,7 @@ PYTHON_MAJOR ?= 3
 PYTHON_MINOR ?= 4
 
 # Test settings
-UNIT_TEST_COVERAGE := 77
+UNIT_TEST_COVERAGE := 72
 INTEGRATION_TEST_COVERAGE := 52
 COMBINED_TEST_COVERAGE := 94
 
@@ -82,6 +82,11 @@ $(ALL_FLAG): $(SOURCES)
 .PHONY: ci
 ci: check test tests
 
+.PHONY: watch
+watch: depends-dev .clean-test
+	@ rm -rf $(FAILED_FLAG)
+	$(SNIFFER)
+
 # Development Installation #####################################################
 
 .PHONY: env
@@ -163,39 +168,44 @@ check: pep8 pep257 pylint
 
 .PHONY: pep8
 pep8: depends-ci
-	$(PEP8) $(PACKAGE) --config=.pep8rc
+	$(PEP8) $(PACKAGE) tests --config=.pep8rc
 
 .PHONY: pep257
 pep257: depends-ci
-# D102: docstring missing (checked by PyLint)
-# D202: No blank lines allowed *after* function docstring
-	$(PEP257) $(PACKAGE) --ignore=D102,D202
+# D102/D103: docstring missing (checked by PyLint)
+# D202: No blank lines allowed *after* function docstring (personal preference)
+# D203: 1 blank line required before class (deprecated warning)
+	$(PEP257) $(PACKAGE) tests --ignore=D102,D103,D202,D203
 
 .PHONY: pylint
 pylint: depends-ci
-	$(PYLINT) $(PACKAGE) --rcfile=.pylintrc  --disable=C0111
+# These warnings shouldn't fail builds, but warn in editors:
+# C0111: Line too long
+# R0913: Too many arguments
+# R0914: Too many local variables
+	$(PYLINT) $(PACKAGE) tests --rcfile=.pylintrc --disable=missing-docstring,too-many-statements
 
 .PHONY: fix
 fix: depends-dev
 	$(PEP8RADIUS) --docformatter --in-place
 
 # Testing ######################################################################
 
-TIMESTAMP := $(shell date +%s)
+RANDOM_SEED ?= $(shell date +%s)
 
 PYTEST_CORE_OPTS := --doctest-modules --verbose -r X --maxfail=3
 PYTEST_COV_OPTS := --cov=$(PACKAGE) --cov-report=term-missing --no-cov-on-fail
-PYTEST_RANDOM_OPTS := --random --random-seed=$(TIMESTAMP)
+PYTEST_RANDOM_OPTS := --random --random-seed=$(RANDOM_SEED)
 
 PYTEST_OPTS := $(PYTEST_CORE_OPTS) $(PYTEST_COV_OPTS) $(PYTEST_RANDOM_OPTS)
 PYTEST_OPTS_FAILFAST := $(PYTEST_OPTS) --failed --exitfirst
 
-FAILED := .pytest/failed
+FAILED_FLAG := .pytest/failed
 
 .PHONY: test test-unit
 test: test-unit
 test-unit: depends-ci
-	@ if test -e $(FAILED); then $(MAKE) test-all; fi
+	@ if test -e $(FAILED_FLAG); then $(MAKE) test-all; fi
 	@ $(COVERAGE) erase
 	$(PYTEST) $(PYTEST_OPTS) $(PACKAGE)
 ifndef TRAVIS
@@ -204,39 +214,34 @@ endif
 
 .PHONY: test-int
 test-int: depends-ci
-	@ if test -e $(FAILED); then $(MAKE) test-all; fi
+	@ if test -e $(FAILED_FLAG); then $(MAKE) test-all; fi
 	@ $(COVERAGE) erase
 	TEST_INTEGRATION=1 $(PYTEST) $(PYTEST_OPTS_FAILFAST) tests
 ifndef TRAVIS
-	@ rm -rf $(FAILED)  # next time, don't run the previously failing test
+	@ rm -rf $(FAILED_FLAG)  # next time, don't run the previously failing test
 	$(COVERAGE) html --directory htmlcov --fail-under=$(INTEGRATION_TEST_COVERAGE)
 endif
 
 .PHONY: tests test-all
 tests: test-all
 test-all: depends-ci
-	@ if test -e $(FAILED); then $(PYTEST) --failed $(PACKAGE) tests; fi
+	@ if test -e $(FAILED_FLAG); then $(PYTEST) --failed $(PACKAGE) tests; fi
 	@ $(COVERAGE) erase
 	TEST_INTEGRATION=1 $(PYTEST) $(PYTEST_OPTS_FAILFAST) $(PACKAGE) tests
 ifndef TRAVIS
-	@ rm -rf $(FAILED)  # next time, don't run the previously failing test
+	@ rm -rf $(FAILED_FLAG)  # next time, don't run the previously failing test
 	$(COVERAGE) html --directory htmlcov --fail-under=$(COMBINED_TEST_COVERAGE)
 endif
 
 .PHONY: read-coverage
 read-coverage:
 	$(OPEN) htmlcov/index.html
 
-.PHONY: watch
-watch: depends-dev .clean-test
-	@ rm -rf $(FAILED)
-	$(SNIFFER)
-
 # Cleanup ######################################################################
 
 .PHONY: clean
 clean: .clean-dist .clean-test .clean-doc .clean-build
-	rm -rf $(ALL)
+	rm -rf $(ALL_FLAG)
 
 .PHONY: clean-env
 clean-env: clean
@@ -274,7 +279,7 @@ register-test: doc
 	$(PYTHON) setup.py register --strict --repository https://testpypi.python.org/pypi
 
 .PHONY: upload-test
-upload-test: .git-no-changes register-test
+upload-test: register-test
 	$(PYTHON) setup.py sdist upload --repository https://testpypi.python.org/pypi
 	$(PYTHON) setup.py bdist_wheel upload --repository https://testpypi.python.org/pypi
 	$(OPEN) https://testpypi.python.org/pypi/$(PROJECT)
@@ -291,7 +296,7 @@ upload: .git-no-changes register
 
 .PHONY: .git-no-changes
 .git-no-changes:
-	@if git diff --name-only --exit-code;         \
+	@ if git diff --name-only --exit-code;        \
 	then                                          \
 		echo Git working copy is clean...;        \
 	else                                          \

README.md

@@ -57,18 +57,28 @@ $ echo .gdm >> .gitignore
 Basic Usage
 ===========
 
-Get the specified versions of all dependencies:
+See the available commands:
 
 ```
-$ gdm install
+$ gdm --help
+```
+
+Updating Dependencies
+---------------------
+
+Get the latest versions of all dependencies:
+
+```
+$ gdm update
 ```
 
 which will essentially:
 
 1. create a working tree at _root_/`location`/`dir`
 2. fetch from `repo` and checkout the specified `rev`
-3. symbolicly link each `location`/`dir` from _root_/`link` (optional)
+3. symbolically link each `location`/`dir` from _root_/`link` (optional)
 4. repeat for all nested working trees containing a configuration file
+5. record the actual commit SHAs that were checked out
 
 where `rev` can be:
 
@@ -77,13 +87,25 @@ where `rev` can be:
 * a branch: `master`
 * a `rev-parse` date: `'develop@{2015-06-18 10:30:59}'`
 
-To display the specific versions installed:
+Restoring Previous Versions
+---------------------------
+
+Display the specific revisions that are currently installed:
 
 ```
 $ gdm list
 ```
 
-To remove all installed dependencies:
+Reinstall these specific versions at a later time:
+
+```
+$ gdm install
+```
+
+Deleting Dependencies
+---------------------
+
+Remove all installed dependencies:
 
 ```
 $ gdm uninstall

gdm/__init__.py

@@ -3,18 +3,21 @@
 import sys
 
 __project__ = 'GDM'
-__version__ = '0.3.1'
+__version__ = '0.4'
 
 CLI = 'gdm'
-VERSION = __project__ + '-' + __version__
-DESCRIPTION = 'A very basic language-agnostic "dependency manager" using Git.'
+VERSION = __project__ + ' v' + __version__
+DESCRIPTION = "A language-agnostic \"dependency manager\" using Git."
 
 PYTHON_VERSION = 3, 3
 
 if not sys.version_info >= PYTHON_VERSION:  # pragma: no cover (manual test)
     exit("Python {}.{}+ is required.".format(*PYTHON_VERSION))
 
 try:
-    from .commands import install, uninstall
+    from .commands import install
+    from .commands import update
+    from .commands import display as list  # pylint: disable=redefined-builtin
+    from .commands import delete as uninstall
 except ImportError:  # pragma: no cover (manual test)
     pass