Merge pull request #1 from dephell/init-all-rules

Add all rules and tests from DepHell

Author: orsinium

.editorconfig

@@ -0,0 +1,27 @@
+
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# https://editorconfig.org
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[*.{md,rst,txt}]
+indent_style = space
+indent_size = 4
+
+[*.{ini,toml}]
+indent_style = space
+indent_size = 4
+
+[*.{json,yml,yaml}]
+indent_style = space
+indent_size = 2

.gitignore

@@ -0,0 +1,17 @@
+.pytest_cache/
+__pycache__/
+*.pyc
+
+*.egg-info/
+dist/
+build/
+pip-wheel-metadata/
+
+.tox
+.mypy_cache
+
+.dephell_cache/
+.dephell_report/
+
+README.rst
+setup.py

.travis.yml

@@ -0,0 +1,32 @@
+language: python
+
+before_install:
+  # show a little bit more information about environment
+  - sudo apt-get install -y tree
+  - env
+  - tree
+  # install DepHell
+  # https://github.com/travis-ci/travis-ci/issues/8589
+  - curl https://raw.githubusercontent.com/dephell/dephell/master/install.py | /opt/python/3.6/bin/python
+  - dephell inspect self
+install:
+  - dephell venv create --env=$ENV --python="/opt/python/$TRAVIS_PYTHON_VERSION/bin/python"
+  - dephell deps install --env=$ENV
+script:
+  - dephell venv run --env=$ENV
+
+matrix:
+  include:
+    - python: "3.5"
+      env: ENV=pytest
+    - python: "3.6"
+      env: ENV=pytest
+    - python: "3.7-dev"
+      env: ENV=pytest
+    - python: "pypy3.5"
+      env: ENV=pytest
+
+    - python: "3.6"
+      env: ENV=flake8
+    - python: "3.6"
+      env: ENV=typing

README.md

@@ -0,0 +1,120 @@
+## dephell_versioning
+
+[![travis](https://travis-ci.org/dephell/dephell_versioning.svg?branch=master)](https://travis-ci.org/dephell/dephell_versioning)
+[![appveyor](https://ci.appveyor.com/api/projects/status/github/dephell/dephell_versioning?svg=true)](https://ci.appveyor.com/project/orsinium/dephell-versioning)
+[![MIT License](https://img.shields.io/pypi/l/dephell-versioning.svg)](https://github.com/dephell/dephell_versioning/blob/master/LICENSE)
+
+Library for bumping project version.
+
+Available schemes:
+
++ `calver`
++ `comver`
++ `pep`
++ `roman`
++ `romver`
++ `semver`
++ `serial`
++ `zerover`
+
+Available rules (and aliases):
+
++ `init` -- initialize versioning
++ Main parts:
+  + `major` (`breaking`)
+  + `minor` (`feature`)
+  + `patch` (`fix`, `micro`)
++ Additional parts:
+  + `dev`
+  + `local`
+  + `post`
++ Pre-release management:
+  + `pre` (`rc`, `alpha`, `beta`)
+  + `premajor` (`prebreaking`)
+  + `preminor` (`prefeature`)
+  + `prepatch` (`prefix`, `premicro`)
+  + `release`
+
+Read more about schemes and rules in the documentation for [dephell project bump](https://dephell.readthedocs.io/en/latest/cmd-project-bump.html).
+
+## Installation
+
+install from [PyPI](https://pypi.org/project/dephell-versioning/):
+
+```bash
+python3 -m pip install --user dephell_versioning
+```
+
+## Usage
+
+Get available schemes, rules, and aliases:
+
+```python
+from dephell_versioning import get_aliases, get_rules, get_schemes
+get_schemes()
+# frozenset({'roman', 'pep', ..., 'comver'})
+
+get_rules()
+# frozenset({'local', 'minor', ..., 'dev', 'preminor'})
+
+get_aliases()
+# frozenset({'alpha', 'rc', ..., 'micro', 'breaking'})
+
+# get rules for some scheme:
+get_rules(scheme='calver')
+# frozenset({'major', 'patch', 'init'})
+
+# get aliases for specific rules:
+get_aliases(rules={'major', 'minor'})
+# frozenset({'feature', 'breaking'})
+
+```
+
+Bump version:
+
+```python
+from dephell_versioning import bump_version
+
+bump_version(version='1.2.3', rule='minor', scheme='semver')
+# '1.3.0'
+
+# pass aliase instead of rule:
+bump_version(version='1.2.3', rule='feature', scheme='semver')
+# '1.3.0'
+
+# start rule from `+` to attach local version number:
+bump_version(version='1.2.3', rule='+456', scheme='semver')
+# '1.2.3+456'
+
+# for `init` version is optional
+bump_version(version='', rule='init', scheme='semver')
+# '0.1.0'
+```
+
+Bump version in a python file:
+
+```python
+from dephell_versioning import bump_file
+from pathlib import Path
+
+# returns `True` if version was bumped
+bump_file(path=Path('dephell_versioning', '__init__.py'), old='0.1.0', new='0.1.1')
+# True
+
+# old version is optional: any version will be bumped if old isn't found
+bump_file(path=Path('dephell_versioning', '__init__.py'), old='', new='0.1.2')
+# True
+```
+
+Use [dephell_discover](https://github.com/dephell/dephell_discover) to find out the current version in a python project:
+
+```python
+from dephell_discover import Root
+from pathlib import Path
+root = Root(path=Path(), name='dephell_discover')
+
+# root.metainfo can be None if project isn't found in the given directory
+if root.metainfo:
+    print(root.metainfo.version)
+# '0.1.2'
+```

appveyor.yml

@@ -0,0 +1,37 @@
+# AppVeyor.com is a Continuous Integration service to build and run tests under Windows
+# https://www.tjelvarolsson.com/blog/how-to-continuously-test-your-python-code-on-windows-using-appveyor/
+# https://github.com/AndrewAnnex/SpiceyPy/blob/master/appveyor.yml
+build: false
+
+environment:
+  matrix:
+    - PYTHON: "C:\\Python35-x64"
+      PYTHON_VERSION: "3.5.x"
+      ARCH: "64"
+      WINDOWS_SDK_VERSION: "v7.1"
+      PLAT_NAME: "win-amd64"
+      PY_TAG: "cp35"
+
+    - PYTHON: "C:\\Python36-x64"
+      PYTHON_VERSION: "3.6.x"
+      ARCH: "64"
+      WINDOWS_SDK_VERSION: "v7.1"
+      PLAT_NAME: "win-amd64"
+      PY_TAG: "cp36"
+
+    - PYTHON: "C:\\Python37-x64"
+      PYTHON_VERSION: "3.7.x"
+      ARCH: "64"
+      WINDOWS_SDK_VERSION: "v7.1"
+      PLAT_NAME: "win-amd64"
+      PY_TAG: "cp37"
+
+init:
+  - "ECHO %PYTHON% %PYTHON_VERSION% %PYTHON_ARCH%"
+
+install:
+  - "%PYTHON%/Scripts/pip.exe install pytest"
+  - "%PYTHON%/Scripts/pip.exe install packaging"
+
+test_script:
+  - "%PYTHON%/Scripts/pytest"

dephell_versioning/__init__.py

@@ -0,0 +1,16 @@
+from ._core import bump_file, bump_version, get_aliases, get_rules, get_schemes
+from ._schemes import BaseScheme, SCHEMES
+
+
+__version__ = '0.1.0'
+
+
+__all__ = [
+    'BaseScheme',
+    'bump_file',
+    'bump_version',
+    'get_aliases',
+    'get_rules',
+    'get_schemes',
+    'SCHEMES',
+]

dephell_versioning/_core.py

@@ -0,0 +1,77 @@
+import re
+from pathlib import Path
+from typing import FrozenSet, Union, Set, Iterable
+
+from packaging.version import Version, VERSION_PATTERN
+
+from ._schemes import BaseScheme, SCHEMES
+
+
+REX_VERSION = re.compile(VERSION_PATTERN, re.VERBOSE | re.IGNORECASE)
+PREFIXES = {'__version__', 'VERSION', 'version'}
+
+
+def get_schemes() -> FrozenSet[str]:
+    return frozenset(SCHEMES)
+
+
+def get_rules(scheme: str = None) -> FrozenSet[str]:
+    if scheme is not None:
+        return SCHEMES[scheme].rules
+
+    rules = set()  # type: Set[str]
+    for scheme in SCHEMES.values():
+        rules.update(scheme.rules)
+    return frozenset(rules)
+
+
+def get_aliases(rules: Iterable[str] = None) -> FrozenSet[str]:
+    if rules is None:
+        return frozenset(BaseScheme.aliases)
+
+    result = set()  # type: Set[str]
+    for alias, rule in BaseScheme.aliases.items():
+        if rule in rules:
+            result.add(alias)
+    return frozenset(result)
+
+
+def bump_version(version: Union[Version, str], rule: str, scheme: str = 'semver') -> str:
+    scheme_manager = SCHEMES.get(scheme)
+    if scheme_manager is None:
+        raise LookupError('invalid scheme: {}'.format(scheme))
+    return scheme_manager.bump(version=version, rule=rule)
+
+
+def bump_file(path: Path, old: str, new: str) -> bool:
+    file_bumped = False
+    new_content = []
+    with path.open('r') as stream:
+        for line in stream:
+            prefix, sep, _version = line.partition('=')
+            if not sep:
+                new_content.append(line)
+                continue
+            if prefix.rstrip() not in PREFIXES:
+                new_content.append(line)
+                continue
+
+            # replace old version
+            if old:
+                new_line = line.replace(old, new, 1)
+                if new_line != line:
+                    new_content.append(new_line)
+                    file_bumped = True
+                    continue
+
+            # replace any version
+            new_line, count = REX_VERSION.subn(new, line)
+            if count == 1:
+                new_content.append(new_line)
+                file_bumped = True
+                continue
+
+            new_content.append(line)
+    if file_bumped:
+        path.write_text(''.join(new_content))
+    return file_bumped

dephell_versioning/_schemes/__init__.py

@@ -0,0 +1,38 @@
+from types import MappingProxyType
+
+from ._base import BaseScheme
+from ._calver import CalVerScheme
+from ._comver import ComVerScheme
+from ._pep import PEPScheme
+from ._roman import RomanScheme
+from ._romver import RomVerScheme
+from ._semver import SemVerScheme
+from ._serial import SerialScheme
+from ._zerover import ZeroVerScheme
+
+
+__all__ = [
+    'SCHEMES',
+
+    'BaseScheme',
+    'CalVerScheme',
+    'ComVerScheme',
+    'PEPScheme',
+    'RomanScheme',
+    'RomVerScheme',
+    'SemVerScheme',
+    'SerialScheme',
+    'ZeroVerScheme',
+]
+
+
+SCHEMES = MappingProxyType(dict(
+    calver=CalVerScheme(),
+    comver=ComVerScheme(),
+    pep=PEPScheme(),
+    roman=RomanScheme(),
+    romver=RomVerScheme(),
+    semver=SemVerScheme(),
+    serial=SerialScheme(),
+    zerover=ZeroVerScheme(),
+))