versioneer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f1e3978f9d739b3a0e37ab2182cf0f692a8c1cb
+  data.tar.gz: 999abeeadab4361199558bfae40daf4db19cebe3
+SHA512:
+  metadata.gz: 78b06f745b17f73ea085e2c9f33c2225c085a541fdd1f21e15f03222f0adac8e115a56d05144f67b5842cb1fc872bd8bfb6f0d462e2ac30d5fb87e6acbaa5467
+  data.tar.gz: 59161c3239ceb2090c2563488862934adf507a8242d566c07f4ada062b8e8dcd0cc634a489455a95dd567c87128ce26a3813daa9fde012ed1efd30bc218b635d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in versioneer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 BinaryBabel OSS
+
+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.md

@@ -0,0 +1,66 @@
+# Versioneer
+
+[![Build Status](https://travis-ci.org/binarybabel/gem-versioneer.svg?branch=master)](https://travis-ci.org/binarybabel/gem-versioneer)
+[![Build status](https://ci.appveyor.com/api/projects/status/k3i9rbgy2q8xdl78/branch/master?svg=true)](https://ci.appveyor.com/project/babelop/gem-versioneer/branch/master)
+
+__Dynamic project versioning (alpha/beta/rc) from commits since last Git Tag.__
+
+Versioneer **determines a project's version** from the latest source-control tag, then **adjusts automatically** by adding/bumping prereleases based on changes made since the last tagged release.
+
+Integration tested on **UNIX/MacOS and Windows**.
+
+## Overview
+
+#### Non-production environments (default settings)
+
+* No changes since last VCS Tag (Ex. v0.1.0)
+  - **Same as Tag** `0.1.0`
+* Uncommitted changes
+  - **Minor Bump + Alpha** `0.2.alpha1`
+* First commit
+  - **Minor Bump + Beta** `0.2.beta1`
+* First commit with uncommitted changes
+  - **Minor Bump + Alpha2** `0.2.alpha2`
+
+#### In production
+
+* No changes since last VCS Tag (Ex. v0.1.0)
+  - **Same as Tag** `0.1.0`
+* Uncommitted changes
+  - **Ignored in Production** `0.1.0`
+* First commit past VCS Tag
+  - **Minor Bump + Release Candidate** `0.2.rc1`
+  - Optionally, patches can be used instead of "rc" in production:
+  - **Minor Bump + Patch** `0.1.1`
+
+## Usage
+
+### Ruby Project (Rails, Rack, etc.)
+
+TODO
+
+### Command-Line
+
+CLI usage defaults to "production" mode, unless otherwise given by ENV variable.
+
+```
+$ git tag -am 'Release 0.1' v0.1
+
+$ versioneer
+0.1
+
+$ git commit --allow-empty -m 'Some changes.'
+
+$versioneer
+0.2.rc1
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/binarybabel/gem-versioneer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/appveyor.yml

@@ -0,0 +1,17 @@
+branches:
+  only:
+    - master
+
+install:
+  - set PATH=C:\Ruby23\bin;%PATH%
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake

data/bin/versioneer

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'versioneer'
+puts Versioneer::Git.new(Dir.getwd, {
+    environment: 'production'
+}).to_s

data/lib/versioneer/base.rb

@@ -0,0 +1,101 @@
+module Versioneer
+  class Base
+    def initialize(file_within_repo, options=nil)
+      @file = file_within_repo
+      @directory = File.dirname(@file)
+      @environment = nil
+
+      @bump_segment = :minor
+      @prereleases = %w(alpha beta rc)
+      @release_pattern = /^v?([0-9\.]+$)/
+      @starting_release = Gem::Version.new('0.0')
+
+      if options.is_a? Hash
+        options.each do |k, v|
+          send("#{k}=", v)
+        end
+      end
+    end
+
+    attr_accessor :starting_release,
+                  :bump_segment,
+                  :prereleases
+
+    def environment
+      @environment || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['ENV'] || 'development'
+    end
+
+    attr_writer :environment
+
+    def to_s
+      version.to_s
+    end
+
+    def version
+      prerelease = nil
+      c = commits_since_release
+
+      if environment == 'production'
+        if bump_segment == :minor and prereleases[2].nil? and c > 0
+          # Use commits as addition to patch level, instead of release candidate.
+          return self.class.bump(release.release, :patch, nil, c)
+        else
+          prerelease = prereleases[2].to_s + c.to_s if c > 0
+        end
+      elsif filesystem_dirty?
+        prerelease = prereleases[0].to_s + (c+1).to_s
+      elsif c > 0
+        prerelease = prereleases[1].to_s + c.to_s
+      end
+
+      if prerelease
+        self.class.bump(release, bump_segment, prerelease)
+      else
+        release
+      end
+    end
+
+    def release
+      starting_release
+    end
+
+    attr_reader :release_pattern
+
+    def release_pattern=(v)
+      v = Regexp.new(v) if v.is_a? String
+      @release_pattern = v
+    end
+
+    def commits_since_release
+      0
+    end
+
+    def filesystem_dirty?
+      true
+    end
+
+    def self.bump(version, bump_segment, prerelease_suffix=nil, bump_count=1)
+      length = segment_to_i(bump_segment) + 1 unless bump_segment.nil?
+
+      if version.prerelease? or bump_segment.nil?
+        next_version = (version.release.segments + [prerelease_suffix]).compact.join('.')
+      else
+        next_version = version
+        bump_count.times do
+          segments = next_version.release.segments.slice(0, length)
+          while segments.size < length + 1 # Version.bump strips last segment
+            segments << 0
+          end
+          next_version = Gem::Version.new(segments.join('.')).bump
+        end
+        next_version = [next_version.to_s, prerelease_suffix].compact.join('.')
+      end
+
+      next_version
+    end
+
+    def self.segment_to_i(segment)
+      [:major, :minor, :patch].index(segment)
+    end
+  end
+end

data/lib/versioneer/gem_version.rb

@@ -0,0 +1,3 @@
+module Versioneer
+  GEM_VERSION = '0.1.0'
+end

data/lib/versioneer/git.rb

@@ -0,0 +1,67 @@
+require_relative 'helpers'
+
+module Versioneer
+  class Git < Base
+    def initialize(file_within_repo, options=nil)
+      super
+      unless file_within_repo.is_a? Dir and Dir.join('.git').exist?
+        unless H.lines? `git ls-files #{file_within_repo} --error-unmatch #{H.cl_no_stderr}`
+          raise InvalidRepoError, 'Not a git repo.'
+        end
+      end
+    end
+
+    def release
+      if (ref = release_ref)
+        Gem::Version.new(ref.match(release_pattern)[1])
+      else
+        super
+      end
+    end
+
+    def commits_since_release
+      offset = 0
+      unless (ref = release_ref)
+        unless (ref = first_ref)
+          return 0
+        end
+        offset = 1
+      end
+      H.num_of_lines(`git log #{ref}...HEAD --pretty=oneline #{H.cl_no_stderr}`) + offset
+    end
+
+    def filesystem_dirty?
+      H.lines? `git status -s`
+    end
+
+    protected
+
+    def release_ref
+      cmd = 'git describe --abbrev=0 --tags'
+      ref = `#{cmd} #{H.cl_no_stderr}`.chomp
+      return nil if ref.empty?
+      if ref.match(release_pattern)
+        ref
+      else
+        # Iterate through tags in date order for first match.
+        `git tag --sort=taggerdate`.split("\n").each do |tag|
+          tag.chomp!
+          if tag.match(release_pattern)
+            return tag
+          end
+        end
+      end
+    end
+
+    def first_ref
+      cmd = 'git rev-list HEAD | tail -n 1'
+      ref = `#{cmd} #{H.cl_no_stderr}`.chomp
+      return nil if ref.empty?
+      ref
+    end
+
+    private
+
+    H = Helpers
+  end
+end

data/lib/versioneer/helpers.rb

@@ -0,0 +1,50 @@
+module Versioneer
+  class Helpers
+    class << self
+
+      # Generic
+
+      def lines?(input)
+        num_of_lines(input) > 0
+      end
+
+      def num_of_lines(input)
+        return 0 unless input.is_a? String and not input.empty?
+        input.chomp.split("\n").size
+      end
+
+      # Platform Specific
+
+      def windows?
+        Gem.respond_to? :win_platform? and Gem.send(:win_platform?)
+      end
+
+      def platform
+        return :windows if windows?
+        :unix
+      end
+
+      def cl_no_stdout
+        {
+            unix: '>/dev/null',
+            windows: '>nul'
+        }.fetch(platform)
+      end
+
+      def cl_no_stderr
+        {
+            unix: '2>/dev/null',
+            windows: '2>nul'
+        }.fetch(platform)
+      end
+
+      def cl_silence
+        {
+            unix: '>/dev/null 2>&1',
+            windows: '>nul 2>&1'
+        }.fetch(platform)
+      end
+
+    end
+  end
+end

data/lib/versioneer/invalid_repo_error.rb

@@ -0,0 +1,5 @@
+module Versioneer
+  class InvalidRepoError < ArgumentError
+
+  end
+end

data/lib/versioneer.rb

@@ -0,0 +1,7 @@
+require 'versioneer/gem_version'
+require 'versioneer/invalid_repo_error'
+require 'versioneer/base'
+require 'versioneer/git'
+
+module Versioneer
+end

data/versioneer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'versioneer/gem_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'versioneer'
+  spec.version       = Versioneer::GEM_VERSION
+  spec.authors       = ['BinaryBabel OSS']
+  spec.email         = ['oss@binarybabel.net']
+  spec.homepage      = 'https://github.com/binarybabel/gem-versioneer'
+
+  spec.summary       = 'Dynamic project versioning (alpha/beta/rc) based on commits since last Git tag.'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['versioneer']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: versioneer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BinaryBabel OSS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- oss@binarybabel.net
+executables:
+- versioneer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/versioneer
+- lib/versioneer.rb
+- lib/versioneer/base.rb
+- lib/versioneer/gem_version.rb
+- lib/versioneer/git.rb
+- lib/versioneer/helpers.rb
+- lib/versioneer/invalid_repo_error.rb
+- versioneer.gemspec
+homepage: https://github.com/binarybabel/gem-versioneer
+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: Dynamic project versioning (alpha/beta/rc) based on commits since last Git
+  tag.
+test_files: []