git-notary 2.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a17c292adcdd3e4821201d5e2c17b642e1c68ea
+  data.tar.gz: d4a0c4a561aae9ab080845a686c4b9a02622b031
+SHA512:
+  metadata.gz: 5107946ffb9a6803da3abc80790a8eac7fb088ad21323b7fa675ca6330218a3f30797f25a68ec1057b33fd08d9897a65d9d00c425c3cfa0a4d41da37b319dd62
+  data.tar.gz: 9090feb3adfd11b1850cf532adca3c82407830789f21035543629c6de5ef0fa55c2419143ad5e35b982b20192d651b6b433f49851da62eee038c39e5b95a02a8

data/.gitignore

@@ -0,0 +1,2 @@
+auto/**
+*.tex

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+Copyright © 2016 Chris Olstrom <chris@olstrom.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.org

@@ -0,0 +1,127 @@
+#+TITLE: git-notary
+#+SUBTITLE: a versioning experiment for git
+#+LATEX: \pagebreak
+
+* Overview
+
+~git-notary~ generates canonical version tags from versioning notes.
+
+** Why would I want this?
+
+~git-notary~ may be helpful if you want to use Semantic Versioning in a project
+with many contributors and some manner of branch-oriented workflow. Tracking
+versioning information with a ~VERSION~ file seems like a great idea, but has
+some quirks.
+
+** An Example Scenario
+
+Consider the following (simplified) scenario:
+
+#+BEGIN_EXAMPLE
+  ,*   e44e210 - (HEAD -> develop) Merge branch 'bar' into develop
+  |\
+  | * e1793f3 - (bar) PATCH
+  | * f231d3b - MAJOR 
+  | * 5c69653 - MAJOR
+  ,* |   67543e1 - Merge branch 'foo' into develop
+  |\ \
+  | |/
+  |/|
+  | * ea81623 - (foo) MAJOR
+  | * 8b773db - PATCH
+  | * 6613b79 - MINOR
+  |/
+  ,* 21c36f3 - (master) MINOR
+  ,* 64357c2 - MINOR
+  ,* 9ebfd7d - MINOR
+  ,* cc5d832 - PATCH
+  ,* ebc851f - MINOR
+  ,* a75790f - PATCH
+  ,* 572a9e8 - MAJOR
+  ,* a990127 - (tag: 0.0.0) INITIAL
+#+END_EXAMPLE
+
+In this example, two branches (~foo~ and ~bar~) were created from ~master~
+(~21c36f3~). Both branches know that ~1.4.0~ is the latest tag (at the time they
+branched). Let's assume these branches do not conflict with each other.
+
+With a ~VERSION~ file, a project generally chooses one of two places to update it:
+
+- Updates occur in the branch. In this case, once either branch is merged, the
+  other is in conflict with it.
+- Updates occur in the trunk. In this case, the trunk now contains code that did
+  not originate in a branch. Again, the first merged is safe, but the other is
+  in a conflicting state.
+
+If ~foo~ merges first, the expected version post-merge is ~2.0.0~.
+
+If ~bar~ merges first, the expected version is ~3.0.1~.
+
+At ~e44e210~ (~HEAD~ of ~develop~), the final version should be ~4.0.1~, but if
+the merge order were reversed, it should be ~4.0.0~. This gets worse as the
+number of active branches increases.
+
+* Assumptions
+
+- Versioning is important.
+- Versions should communicate scope of change.
+- Humans can signal the scope of their own changes.
+- Machines can figure out the rest.
+
+* Installation
+
+Download the latest release of ~git-notary~ and place it somewhere in your ~$PATH~.
+#+LATEX: \pagebreak
+
+* Usage
+
+** Add new versioning information
+
+#+BEGIN_SRC shell
+  git-notary new <version> [object] [namespace]
+#+END_SRC
+
+Where <version> is one of (major, minor, patch).
+
+** Undo a version
+
+#+BEGIN_SRC shell
+  git-notary undo [object] [namespace]
+#+END_SRC
+
+** Fetch versioning notes
+
+#+BEGIN_SRC shell
+  git-notary fetch [remote] [namespace]
+#+END_SRC
+
+** Push versioning notes
+
+#+BEGIN_SRC shell
+  git-notary push [remote] [namespace]
+#+END_SRC
+
+** Extract Notes
+
+#+BEGIN_SRC shell
+  git-notary notes [branch] [base] [namespace]
+#+END_SRC
+
+** Compute Versions from Notes
+
+#+BEGIN_SRC shell
+  git-notary notes | git-notary versions [initial]
+#+END_SRC
+
+** Generate Tags from Versions
+
+#+BEGIN_SRC shell
+  git-notary notes | git-notary versions | git-notary tags [--apply]
+#+END_SRC
+
+* License
+
+~git-notary~ is available under the [[https://tldrlegal.com/license/mit-license][MIT License]]. See ~LICENSE.txt~ for the full text.
+
+* Contributors
+- [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]

data/bin/git-notary

@@ -0,0 +1,245 @@
+#!/bin/sh
+
+GIT_NOTARY_VERSION=2.1.3
+GIT_NOTARY_NAMESPACE=${GIT_NOTARY_NAMESPACE:-'versioning'}
+
+# notes [branch] [base] [namespace]
+notes() {
+    BRANCH=${1-'develop'}
+    BASE=${2:-$(git describe --tags --abbrev=0)}
+    NAMESPACE=${3:-${GIT_NOTARY_NAMESPACE}}
+
+    git rev-list --topo-order ${BASE}..${BRANCH} --reverse | while read OBJECT; do
+        printf "${OBJECT} "
+        git notes --ref=${NAMESPACE} show ${OBJECT} 2> /dev/null || echo
+    done | grep -E '(MAJOR|MINOR|PATCH)$'
+}
+
+# squash
+squash() {
+    while read OBJECT_CHANGE; do
+        OBJECT=$(echo ${OBJECT_CHANGE} | awk '{ print $1 }')
+        CHANGE=$(echo ${OBJECT_CHANGE} | awk '{ print $2 }')
+
+        case ${CHANGE} in
+            MAJOR)
+                RESULT=MAJOR;;
+            MINOR)
+                test "${RESULT}" != MAJOR && RESULT=MINOR;;
+            PATCH)
+                test -z "${RESULT}" && RESULT=PATCH;;
+        esac
+    done
+
+    test ! -z "${RESULT}" && echo ${OBJECT} ${RESULT}
+}
+
+# squeeze <up|down>
+squeeze() {
+    case ${1} in
+        d|down|f|first|o|old*)
+            DIRECTION=DOWN;;
+        u|up|l|last|n|new*)
+            DIRECTION=UP;;
+        *)
+            echo 'git-notary squeeze requires a direction (up or down)' >&2
+            exit 23;;
+    esac
+
+    while read OBJECT_CHANGE; do
+        OBJECT=$(echo ${OBJECT_CHANGE} | awk '{ print $1 }')
+        CHANGE=$(echo ${OBJECT_CHANGE} | awk '{ print $2 }')
+
+        if test "${CHANGE}" != "${LAST_CHANGE}"; then
+            case ${DIRECTION} in
+                DOWN)
+                    echo ${OBJECT} ${CHANGE};;
+                UP)
+                    test ! -z "${LAST_OBJECT}" && echo ${LAST_OBJECT} ${LAST_CHANGE};;
+            esac
+        fi
+
+        LAST_OBJECT=${OBJECT}
+        LAST_CHANGE=${CHANGE}
+    done
+
+    test "${DIRECTION}" = UP && echo ${LAST_OBJECT} ${LAST_CHANGE}
+}
+
+# versions [initial]
+versions() {
+    set -o errexit
+    VERSION=${1:-$(git describe --tags --abbrev=0)}
+
+    MAJOR=$(echo ${VERSION} | awk -F . '{ print $1 }')
+    MINOR=$(echo ${VERSION} | awk -F . '{ print $2 }')
+    PATCH=$(echo ${VERSION} | awk -F . '{ print $3 }')
+
+    next() {
+        echo ${1} + 1 | bc
+    }
+
+    while read OBJECT_CHANGE; do
+        OBJECT=$(echo ${OBJECT_CHANGE} | awk '{ print $1 }')
+        CHANGE=$(echo ${OBJECT_CHANGE} | awk '{ print $2 }')
+
+        case ${CHANGE} in
+            MAJOR)
+                MAJOR=$(next ${MAJOR})
+                MINOR=0
+                PATCH=0
+                ;;
+            MINOR)
+                MINOR=$(next ${MINOR})
+                PATCH=0
+                ;;
+            PATCH)
+                PATCH=$(next ${PATCH})
+                ;;
+        esac
+
+        VERSION=${MAJOR}.${MINOR}.${PATCH}
+        echo ${OBJECT} ${VERSION}
+    done
+}
+
+# tags [--apply]
+tags() {
+    while read OBJECT_TAG; do
+        OBJECT=$(echo ${OBJECT_TAG} | awk '{ print $1 }')
+        TAG=$(echo ${OBJECT_TAG} | awk '{ print $2 }')
+
+        if test "${1}" = '--apply'; then
+            git tag ${TAG} ${OBJECT}
+        else
+            echo git tag ${TAG} ${OBJECT}
+        fi
+    done
+}
+
+# fetch [remote] [namespace]
+fetch() {
+    REMOTE=${1:-'origin'}
+    NAMESPACE=${2:-${GIT_NOTARY_NAMESPACE}}
+
+    git fetch ${REMOTE} refs/notes/${NAMESPACE}:refs/notes/${NAMESPACE}
+}
+
+# push [remote] [namespace]
+push() {
+    REMOTE=${1:-'origin'}
+    NAMESPACE=${2:-${GIT_NOTARY_NAMESPACE}}
+
+    git push --no-verify ${REMOTE} refs/notes/${NAMESPACE}
+}
+
+# new <major|minor|patch> [object] [namespace]
+new() {
+    CHANGE=$(echo ${1} | tr [:lower:] [:upper:])
+    OBJECT=${2:-HEAD}
+    NAMESPACE=${3:-${GIT_NOTARY_NAMESPACE}}
+
+    if echo ${CHANGE} | grep -qE '^(MAJOR|MINOR|PATCH)$'; then
+        git notes --ref=${NAMESPACE} add --message ${CHANGE} ${OBJECT}
+    else
+        echo MAJOR MINOR and PATCH are valid. ${CHANGE} is not.
+        exit 23
+    fi
+}
+
+# delta (--squash) [object] [base] [namespace]
+delta() {
+    if test "${1}" = '--squash'; then
+       SQUASH=true
+       shift
+    fi
+
+    OBJECT=${1:-HEAD}
+    BASE=${2:-$(git describe --tags --abbrev=0)}
+    NAMESPACE=${3:-${GIT_NOTARY_NAMESPACE}}
+
+    if test "${SQUASH}" = 'true'; then
+        NEW=$(git-notary notes ${OBJECT} ${BASE} ${NAMESPACE} | git-notary squash | git-notary versions | awk '{ print $2 }')
+    else
+        NEW=$(git-notary notes ${OBJECT} ${BASE} ${NAMESPACE} | git-notary versions | tail -1 | awk '{ print $2 }')
+    fi
+
+    LATEST_TAG_ON_BASE=$(git describe --tags --abbrev=0 ${BASE})
+    OLD=${LATEST_TAG_ON_BASE:-'0.0.0'}
+    echo "${OLD} -> ${NEW}"
+}
+
+# undo [object] [namespace]
+undo() {
+    OBJECT=${1:-HEAD}
+    NAMESPACE=${2:-${GIT_NOTARY_NAMESPACE}}
+
+    git notes --ref=${NAMESPACE} remove ${OBJECT}
+}
+
+# version
+version() {
+    echo "git-notary ${GIT_NOTARY_VERSION}"
+}
+
+# help
+help() {
+    cat <<EOF
+$(version)
+usage:
+       git-notary new <major|minor|patch> [object] [namespace]
+       git-notary undo [object] [namespace]
+       git-notary delta [--squash] [object] [base] [namespace]
+
+       git-notary fetch [remote] [namespace]
+       git-notary push [remote] [namespace]
+
+       git-notary notes [branch] [base] [namespace]
+       git-notary versions [initial]
+       git-notary tags [--apply]
+EOF
+}
+
+# notary <command> [args]
+notary() {
+    COMMAND=${1}
+    shift
+    case ${COMMAND} in
+        N|notes)
+            notes ${@};;
+        V|versions)
+            versions ${@};;
+        T|tags)
+            tags ${@};;
+        S|squash)
+            squash ${@};;
+        Z|squeeze)
+            squeeze ${@};;
+        n|new)
+            new ${@};;
+        u|undo)
+            undo ${@};;
+        d|delta)
+            delta ${@};;
+        P|push)
+            push ${@};;
+        f|fetch)
+            fetch ${@};;
+        M|major)
+            new MAJOR ${@};;
+        m|minor)
+            new MINOR ${@};;
+        p|patch)
+            new PATCH ${@};;
+        v|version|-v|--version)
+            version;;
+        h|help|-h|--help)
+            help;;
+        *)
+            help
+            exit 1
+            ;;
+    esac
+}
+
+notary ${@}

data/git-notary.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |gem|
+  gem.name     = 'git-notary'
+  gem.version  = `git describe --tags --abbrev=0`.chomp
+  gem.license  = 'MIT'
+  gem.author   = 'Chris Olstrom'
+  gem.email    = 'chris@olstrom.com'
+  gem.homepage = 'https://github.com/colstrom/git-notary'
+  gem.summary  = 'generates canonical version tags from versioning notes'
+  gem.files    = `git ls-files`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+end

data/hooks/pre-commit

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+while read LOCAL_REF LOCAL_SHA REMOTE_REF REMOTE_SHA; do
+    if git-notary notes ${LOCAL_SHA} develop > /dev/null; then
+        BRANCH_HAS_NOTES=true
+    else
+        BRANCH_HAS_NOTES=false
+        break
+    fi
+done
+
+test ${BRANCH_HAS_NOTES} = true

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: git-notary
+version: !ruby/object:Gem::Version
+  version: 2.1.3
+platform: ruby
+authors:
+- Chris Olstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: chris@olstrom.com
+executables:
+- git-notary
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.org
+- bin/git-notary
+- git-notary.gemspec
+- hooks/pre-commit
+homepage: https://github.com/colstrom/git-notary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: generates canonical version tags from versioning notes
+test_files: []
+has_rdoc: