Merge pull request #149 from jacebrowning/release/v1.3

Release v1.3

Author: jacebrowning

.pylint.ini

@@ -1,6 +1,6 @@
 [MESSAGES CONTROL]
 
-disable=locally-disabled,fixme,too-few-public-methods,too-many-public-methods,invalid-name,global-statement,too-many-ancestors,missing-docstring,no-member
+disable=locally-disabled,fixme,too-few-public-methods,too-many-public-methods,invalid-name,global-statement,too-many-ancestors,missing-docstring,no-member,too-many-arguments
 
 [FORMAT]
 

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Revision History
 
+## 1.3 (2017/02/03)
+
+- Added `init` command to generate sample configuration files.
+- Added support for post-install scripts on dependencies.
+- Updated configuration format to support `null` for links.
+
 ## 1.2 (2017/01/08)
 
 - Added preliminary Windows support (@StudioEtrange).

CONTRIBUTING.md

@@ -5,9 +5,9 @@
 ### Requirements
 
 * Make:
-    * Windows: https://cygwin.com/install.html
-    * Mac: https://developer.apple.com/xcode
-    * Linux: https://www.gnu.org/software/make (likely already installed)
+    * Windows: http://mingw.org/download/installer
+    * Mac: http://developer.apple.com/xcode
+    * Linux: http://www.gnu.org/software/make
 * Pandoc: http://johnmacfarlane.net/pandoc/installing.html
 * Graphviz: http://www.graphviz.org/Download.php
 

LICENSE.md

@@ -2,7 +2,7 @@
 
 **The MIT License (MIT)**
 
-Copyright © 2016, Jace Browning
+Copyright © 2017, Jace Browning
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -75,8 +75,8 @@ watch: install .clean-test ## Continuously run all CI tasks when files chanage
 
 .PHONY: demo
 demo: install
-	$(BIN)/gitman install
-	$(BIN)/gitman update
+	$(BIN)/gitman install --force  # some scripts have intentional errors
+	$(BIN)/gitman update --force  # some scripts have intentional errors
 	$(BIN)/gitman list
 	$(BIN)/gitman lock
 	$(BIN)/gitman uninstall
@@ -120,7 +120,7 @@ $(PIP): $(PYTHON)
 	@ touch $@
 
 $(PYTHON):
-	$(SYS_PYTHON) -m venv --clear $(ENV)
+	$(SYS_PYTHON) -m venv $(ENV)
 
 # CHECKS #######################################################################
 
@@ -132,15 +132,15 @@ PYDOCSTYLE := $(BIN)/pydocstyle
 check: pylint pycodestyle pydocstyle ## Run linters and static analysis
 
 .PHONY: pylint
-pylint: install ## Check for code issues
+pylint: install
 	$(PYLINT) $(PACKAGES) $(CONFIG) --rcfile=.pylint.ini
 
 .PHONY: pycodestyle
-pycodestyle: install ## Check for code conventions
+pycodestyle: install
 	$(PYCODESTYLE) $(PACKAGES) $(CONFIG) --config=.pycodestyle.ini
 
 .PHONY: pydocstyle
-pydocstyle: install ## Check for docstring conventions
+pydocstyle: install
 	$(PYDOCSTYLE) $(PACKAGES) $(CONFIG)
 
 # TESTS ########################################################################
@@ -152,7 +152,7 @@ COVERAGE_SPACE := $(BIN)/coverage.space
 RANDOM_SEED ?= $(shell date +%s)
 
 PYTEST_CORE_OPTS := -ra -vv
-PYTEST_COV_OPTS := --cov=$(PACKAGE) --no-cov-on-fail --cov-report=term-missing --cov-report=html
+PYTEST_COV_OPTS := --cov=$(PACKAGE) --no-cov-on-fail --cov-report=term-missing:skip-covered --cov-report=html
 PYTEST_RANDOM_OPTS := --random --random-seed=$(RANDOM_SEED)
 
 PYTEST_OPTS := $(PYTEST_CORE_OPTS) $(PYTEST_COV_OPTS) $(PYTEST_RANDOM_OPTS)
@@ -162,24 +162,24 @@ FAILURES := .cache/v/cache/lastfailed
 REPORTS ?= xmlreport
 
 .PHONY: test
-test: test-all
+test: test-all ## Run unit and integration tests
 
 .PHONY: test-unit
-test-unit: install ## Run the unit tests
+test-unit: install
 	@- mv $(FAILURES) $(FAILURES).bak
 	$(PYTEST) $(PYTEST_OPTS) $(PACKAGE) --junitxml=$(REPORTS)/unit.xml
 	@- mv $(FAILURES).bak $(FAILURES)
 	$(COVERAGE_SPACE) $(REPOSITORY) unit
 
 .PHONY: test-int
-test-int: install ## Run the integration tests
+test-int: install
 	@ if test -e $(FAILURES); then TEST_INTEGRATION=true $(PYTEST) $(PYTEST_OPTS_FAILFAST) tests; fi
 	@ rm -rf $(FAILURES)
 	TEST_INTEGRATION=true $(PYTEST) $(PYTEST_OPTS) tests --junitxml=$(REPORTS)/integration.xml
 	$(COVERAGE_SPACE) $(REPOSITORY) integration
 
 .PHONY: test-all
-test-all: install ## Run all the tests
+test-all: install
 	@ if test -e $(FAILURES); then TEST_INTEGRATION=true $(PYTEST) $(PYTEST_OPTS_FAILFAST) $(PACKAGES); fi
 	@ rm -rf $(FAILURES)
 	TEST_INTEGRATION=true $(PYTEST) $(PYTEST_OPTS) $(PACKAGES) --junitxml=$(REPORTS)/overall.xml
@@ -199,23 +199,23 @@ PDOC_INDEX := docs/apidocs/$(PACKAGE)/index.html
 MKDOCS_INDEX := site/index.html
 
 .PHONY: doc
-doc: uml pdoc mkdocs ## Run documentation generators
+doc: uml pdoc mkdocs ## Generate documentaiton
 
 .PHONY: uml
-uml: install docs/*.png ## Generate UML diagrams for classes and packages
+uml: install docs/*.png
 docs/*.png: $(MODULES)
 	$(PYREVERSE) $(PACKAGE) -p $(PACKAGE) -a 1 -f ALL -o png --ignore tests
 	- mv -f classes_$(PACKAGE).png docs/classes.png
 	- mv -f packages_$(PACKAGE).png docs/packages.png
 
 .PHONY: pdoc
-pdoc: install $(PDOC_INDEX)  ## Generate API documentaiton with pdoc
+pdoc: install $(PDOC_INDEX)
 $(PDOC_INDEX): $(MODULES)
 	$(PDOC) --html --overwrite $(PACKAGE) --html-dir docs/apidocs
 	@ touch $@
 
 .PHONY: mkdocs
-mkdocs: install $(MKDOCS_INDEX) ## Build the documentation site with mkdocs
+mkdocs: install $(MKDOCS_INDEX)
 $(MKDOCS_INDEX): mkdocs.yml docs/*.md
 	ln -sf `realpath README.md --relative-to=docs` docs/index.md
 	ln -sf `realpath CHANGELOG.md --relative-to=docs/about` docs/about/changelog.md
@@ -224,7 +224,7 @@ $(MKDOCS_INDEX): mkdocs.yml docs/*.md
 	$(MKDOCS) build --clean --strict
 
 .PHONY: mkdocs-live
-mkdocs-live: mkdocs ## Launch and continuously rebuild the mkdocs site
+mkdocs-live: mkdocs
 	eval "sleep 3; open http://127.0.0.1:8000" &
 	$(MKDOCS) serve
 

README.md

@@ -31,7 +31,13 @@ $ python setup.py install
 
 ## Setup
 
-Create a configuration file (`gitman.yml` or `.gitman.yml`) in the root of your working tree:
+Generate a sample configuration file:
+
+```sh
+$ gitman init
+```
+
+or manually create one (`gitman.yml` or `.gitman.yml`) in the root of your working tree:
 
 ```yaml
 location: vendor/gitman
@@ -43,6 +49,11 @@ sources:
   repo: https://github.com/jonreid/XcodeCoverage
   rev: master
   link: Tools/XcodeCoverage
+- name: trufflehog
+  repo: https://github.com/dxa4481/truffleHog
+  rev: master
+  scripts:
+  - chmod a+x truffleHog.py
 ```
 
 Ignore the dependency storage location:
@@ -69,11 +80,12 @@ $ gitman update
 
 which will essentially:
 
-1. create a working tree at `<root>`/`<location>`/`<name>`
-2. fetch from `repo` and checkout the specified `rev`
-3. symbolically link each `<location>`/`<name>` from `<root>`/`<link>` (if specified)
-4. repeat for all nested working trees containing a configuration file
-5. record the actual commit SHAs that were checked out (with `--lock` option)
+1. Create a working tree at `<root>`/`<location>`/`<name>`
+2. Fetch from `repo` and checkout the specified `rev`
+3. Symbolically link each `<location>`/`<name>` from `<root>`/`<link>` (if specified)
+4. Repeat for all nested working trees containing a configuration file
+5. Record the actual commit SHAs that were checked out (with `--lock` option)
+6. Run optional post-install scripts for each dependency
 
 where `rev` can be:
 

bin/verchew

@@ -36,7 +36,7 @@ from collections import OrderedDict
 from subprocess import Popen, PIPE, STDOUT
 import logging
 
-__version__ = '0.5'
+__version__ = '1.0'
 
 PY2 = sys.version_info[0] == 2
 CONFIG_FILENAMES = ['.verchew', '.verchewrc', 'verchew.ini', '.verchew.ini']
@@ -190,12 +190,19 @@ def show(text, start='', end='\n', head=False):
         sys.stdout.flush()
 
 
-def _(word, utf8=None, tty=None):
+def _(word, is_tty=None, supports_utf8=None, supports_ansi=None):
     """Format and colorize a word based on available encoding."""
     formatted = word
 
-    style_support = sys.stdout.encoding == 'UTF-8' if utf8 is None else utf8
-    color_support = sys.stdout.isatty() if tty is None else tty
+    if is_tty is None:
+        is_tty = hasattr(sys.stdout, 'isatty') and sys.stdout.isatty()
+    if supports_utf8 is None:
+        supports_utf8 = sys.stdout.encoding == 'UTF-8'
+    if supports_ansi is None:
+        supports_ansi = sys.platform != 'win32' or 'ANSICON' in os.environ
+
+    style_support = supports_utf8
+    color_support = is_tty and supports_ansi
 
     if style_support:
         formatted = STYLE.get(word, word)

docs/interfaces/api.md

@@ -2,6 +2,14 @@
 
 All of the [command-line interface](cli.md) functionality is available from the Python package by importing `gitman`.
 
+## Init
+
+To generate a sample configuration for a new project, call:
+
+```python
+gitman.init()
+```
+
 ## Install
 
 To clone/checkout the specified dependencies, call:
@@ -15,7 +23,8 @@ with optional arguments:
 - `*names`: optional list of dependency directory names to filter on
 - `root`: specifies the path to the root working tree
 - `depth`: number of levels of dependencies to traverse
-- `force`: indicates uncommitted changes can be overwritten
+- `force`: indicates uncommitted changes can be overwritten and
+           script errors can be ignored
 - `fetch`: indicates the latest branches should always be fetched
 - `clean`: indicates untracked files should be deleted from dependencies
 
@@ -33,7 +42,8 @@ with optional arguments:
 - `root`: specifies the path to the root working tree
 - `depth`: number of levels of dependencies to traverse
 - `recurse`: indicates nested dependencies should also be updated
-- `force`: indicates uncommitted changes can be overwritten
+- `force`: indicates uncommitted changes can be overwritten and
+           script errors can be ignored
 - `clean`: indicates untracked files should be deleted from dependencies
 - `lock`: indicates actual dependency versions should be recorded
 

docs/interfaces/cli.md

@@ -2,6 +2,14 @@
 
 After setting up `gitman` with a [configuration file](../index.md#setup), various commands can be run to manage these Git-controlled source dependencies.
 
+## Init
+
+To generate a sample configuration for a new project, run:
+
+```sh
+$ gitman init
+```
+
 ## Install
 
 To clone/checkout the specified dependencies, run:
@@ -34,7 +42,7 @@ It will only fetch from the repository if needed. To always fetch, run:
 gitman install --fetch
 ```
 
-It will exit with an error if there are any uncommitted changes in dependencies. To overwrite all changes, run:
+It will exit with an error if there are any uncommitted changes in dependencies or a post-install script fails. To overwrite all changes or ignore script failures, run:
 
 ```sh
 gitman install --force

docs/interfaces/plugin.md

@@ -16,7 +16,7 @@ Delete all untracked files in dependencies by instead running:
 git deps --clean
 ```
 
-Git will exit with an error if there are any uncommitted changes in dependencies. To overwrite all changes, run:
+Git will exit with an error if there are any uncommitted changes in dependencies or a post-install script fails. To overwrite all changes or ignore script failures, run:
 
 ```sh
 git deps --force