YAVM 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f61250eb85d9a2e91c9e678d3a778af73077f1c
+  data.tar.gz: ce292887c4595dbeb3076e714dfe02aadebff7fa
+SHA512:
+  metadata.gz: 8807b0ea3cfd119a4e50230f0fb8622216d2c5f7522975599f14338fa116bdda25a0f9743f6bd68283f026ba4fea174384b638cdda4593e942e0b00e8c92378e
+  data.tar.gz: dc0afe74765d1e989fb5a39f5e18d48bc29fa20cbb20d52009b71b4c4f57afaccad86398b1c8e4c70b56dbda374ed5c952637f541bd32b84515ba43585a97fa9

data/README.md

@@ -0,0 +1,93 @@
+# YAVM: Yet Another Version Manager
+
+A tiny gem for managing project version numbers.
+
+Heavily inspired by the `semver` gem, this is a tiny utility for managing version numbers,
+which includes support for multiple version format stores:
+
+* The `semver` gem's `.semver` file
+* node.js `package.json` files
+* bower `bower.json` files
+* ruby `.gemspec` files
+
+With planned support for:
+
+* Python distutils package support
+
+# Usage
+
+*Exhaustive usage patterns can be found at `version help`*
+
+``` shell
+# Install
+$ gem install yavm
+
+# In a language/framework without a supported versioning system:
+$ version init
+$ version                # => 0.0.0
+
+# In an existing project with supported versioning:
+version                  # => 0.2.0
+
+# Basic Usage
+$ version inc minor      # => 0.3.0
+$ version inc major      # => 1.0.0
+$ version special pre4   # => 1.0.0-pre4
+$ version special        # => 1.0.0
+$ version meta 20141113  # => 1.0.0            (meta not displayed by default)
+$ version tag            # => v1.0.0+20141113  (useful for version control)
+$ version format "%M.%m" # => 1.0
+```
+
+## Available Format Tags
+
+Tag | Meaning
+----|---------------------
+%M  | **M**ajor
+%m  | **M**inor
+%p  | **P**atch
+%s  | **S**pecial
+%t  | Me**t**a
+%%  | Literal % Character
+
+## Conflict Resolution
+
+If your project contains multiple supported version "stores", YAVM will keep them in sync.
+If they go out of sync outside of YAVM, you will be prompted to pick the canonical/authoritative
+version, and all other stores will be updated.
+
+``` text
+$ version
+Multiple version stores are in use, and aren't consistent.
+  Please select the authoritative version:
+
+WARNING: File munging is dangerous. A manual resolution might be safer.
+
+     1: 1.0.0           [.semver file]
+     2: 1.0.3           [bower.json file]
+     3: 0.0.0           [gemspec: ./yavm.gemspec]
+
+Selection: 2
+Now on 1.0.3
+```
+
+# Roadmap
+
+## Features
+
+- [x] show version
+- [x] increment
+- [x] set special
+- [x] set meta
+- [x] formatting
+- [x] tags
+- [x] help
+- [x] package.json support
+- [x] bower.json support
+- [ ] when changing version, show new one
+- [ ] programmatic interface
+- [ ] tests
+- [ ] handle invalid version info (see Version#parse)
+- [ ] 'version init'
+- [ ] quick mode (when finding versions - short circuit once one is found)
+- [ ] raise sensible exceptions

data/bin/version

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+lib = File.expand_path('../../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+
+require 'yavm/command_line'
+
+begin
+  command_line = YAVM::CommandLine.new
+  command_line.invoke!
+rescue Docopt::Exit => e
+  puts e.message
+end

data/lib/yavm.rb

@@ -0,0 +1,25 @@
+lib = File.dirname(__FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'yavm/version'
+require 'yavm/stores'
+
+module YAVM
+
+  def find(quiet = true)
+    versions = YAVM::Stores.locate_versions
+
+    if versions.equal?
+      return versions.first
+    else
+      return nil if quiet
+
+      raise RuntimeError, ''
+
+    end
+
+  end
+
+  module_function :find
+
+end

data/lib/yavm/README.md

@@ -0,0 +1,93 @@
+# YAVM: Yet Another Version Manager
+
+A tiny gem for managing project version numbers.
+
+Heavily inspired by the `semver` gem, this is a tiny utility for managing version numbers,
+which includes support for multiple version format stores:
+
+* The `semver` gem's `.semver` file
+* node.js `package.json` files
+* bower `bower.json` files
+* ruby `.gemspec` files
+
+With planned support for:
+
+* Python distutils package support
+
+# Usage
+
+*Exhaustive usage patterns can be found at `version help`*
+
+``` shell
+# Install
+$ gem install yavm
+
+# In a language/framework without a supported versioning system:
+$ version init
+$ version                # => 0.0.0
+
+# In an existing project with supported versioning:
+version                  # => 0.2.0
+
+# Basic Usage
+$ version inc minor      # => 0.3.0
+$ version inc major      # => 1.0.0
+$ version special pre4   # => 1.0.0-pre4
+$ version special        # => 1.0.0
+$ version meta 20141113  # => 1.0.0            (meta not displayed by default)
+$ version tag            # => v1.0.0+20141113  (useful for version control)
+$ version format "%M.%m" # => 1.0
+```
+
+## Available Format Tags
+
+Tag | Meaning
+----|---------------------
+%M  | **M**ajor
+%m  | **M**inor
+%p  | **P**atch
+%s  | **S**pecial
+%t  | Me**t**a
+%%  | Literal % Character
+
+## Conflict Resolution
+
+If your project contains multiple supported version "stores", YAVM will keep them in sync.
+If they go out of sync outside of YAVM, you will be prompted to pick the canonical/authoritative
+version, and all other stores will be updated.
+
+``` text
+$ version
+Multiple version stores are in use, and aren't consistent.
+  Please select the authoritative version:
+
+WARNING: File munging is dangerous. A manual resolution might be safer.
+
+     1: 1.0.0           [.semver file]
+     2: 1.0.3           [bower.json file]
+     3: 0.0.0           [gemspec: ./yavm.gemspec]
+
+Selection: 2
+Now on 1.0.3
+```
+
+# Roadmap
+
+## Features
+
+- [x] show version
+- [x] increment
+- [x] set special
+- [x] set meta
+- [x] formatting
+- [x] tags
+- [x] help
+- [x] package.json support
+- [x] bower.json support
+- [ ] when changing version, show new one
+- [ ] programmatic interface
+- [ ] tests
+- [ ] handle invalid version info (see Version#parse)
+- [ ] 'version init'
+- [ ] quick mode (when finding versions - short circuit once one is found)
+- [ ] raise sensible exceptions

data/lib/yavm/command_line.rb

@@ -0,0 +1,150 @@
+require 'docopt'
+require 'yavm/stores'
+
+module YAVM
+  class CommandLine
+
+    def initialize
+      @invocation = File.basename($0)
+    end
+
+    def invoke!
+      @args    = Docopt::docopt(doc)
+      command  = @args.select { |a, v| commands.include?(a) && v }.keys.first
+      command  = 'show' if command.nil?
+
+      versions = YAVM::Stores.locate_versions
+
+      if versions.empty? && !@args['init']
+        puts "There doesn't seem to be any versioning information on this project."
+        puts "Use native versioning tools (see docs for support), or run `#{@invocation} init`"
+        puts "to use the default versioning method."
+        exit(1)
+      end
+
+      # Commands which use the version information require it to be consistent
+      if version_commands.include? command
+        choose_authoritative!(versions) unless versions.equal?
+        version = versions.first
+      end
+
+      case command
+      when 'show'
+        puts "#{version}"
+
+      when 'inc'
+        if @args['major']
+          version.major += 1
+          version.minor = version.patch = 0
+          version.special = version.meta = nil
+
+        elsif @args['minor']
+          version.minor += 1
+          version.patch = 0
+          version.special = version.meta = nil
+
+        elsif @args['patch']
+          version.patch += 1
+          version.special = version.meta = nil
+
+        end
+
+        versions.set_all!(version)
+
+      when 'special'
+        version.special = @args['<string>']
+
+        versions.set_all!(version)
+
+      when 'meta'
+        version.meta = @args['<string>']
+
+        versions.set_all!(version)
+
+      when 'format'
+        puts "#{version.format(@args['<string>'])}"
+
+      when 'tag'
+        puts "#{version.tag}"
+
+      when 'help'
+        Docopt::Exit.set_usage(nil)
+        raise Docopt::Exit, doc.strip
+      end
+
+    end
+
+    private
+
+    def choose_authoritative!(versions)
+      puts "Multiple version stores are in use, and aren't consistent."
+      puts "  Please select the authoritative version:\n\n"
+      puts "WARNING: File munging is dangerous. A manual resolution might be safer.\n\n"
+
+      selection = ''
+
+      while selection.is_a? String
+        versions.each_with_index do |version, index|
+          puts "   %3s: %-15s [%s]" % [index+1, version, version.store.name]
+        end
+
+        print "\nSelection: "
+        selection = STDIN.gets.chomp
+
+        if selection.to_i.to_s == selection && (1..versions.size) === selection.to_i
+          selection = selection.to_i
+          break
+        end
+      end
+
+      authoritative_version = versions[selection.to_i - 1]
+
+      versions.set_all!(authoritative_version)
+
+      puts "Now on #{authoritative_version}"
+      exit(0)
+
+    end
+
+    def doc
+      <<-DOCOPT.gsub(/^ {6}/, '')
+      YAVM. Yet Another Version Manager
+
+      Usage:
+        #{@invocation}
+        #{@invocation} inc (major|minor|patch)
+        #{@invocation} special [<string>]
+        #{@invocation} meta [<string>]
+        #{@invocation} format <string>
+        #{@invocation} tag
+        #{@invocation} help
+
+      Options:
+        inc          Increment a specific version number
+        special      Set a special (eg: pre-release) suffix
+        meta         Set a metadata version suffix
+        format       Display version in specific format (%M, %m, %p, %s, %t)
+        tag          Equivalent to format 'v%M.%m.%p%s'
+        help         Show this screen.
+
+      DOCOPT
+    end
+
+    #
+    # A list of arguments which should be considered commands.
+    # We should only ever see one of these at a time, typically.
+    #
+    def commands
+      version_commands + support_commands
+    end
+
+    def version_commands
+      ['show', 'inc', 'special', 'meta', 'format', 'tag']
+    end
+
+    def support_commands
+      ['help']
+    end
+
+  end
+end

data/lib/yavm/stores.rb

@@ -0,0 +1,31 @@
+require 'yavm/versions'
+
+require 'yavm/stores/semver'
+require 'yavm/stores/package'
+require 'yavm/stores/bower'
+require 'yavm/stores/gem_spec'
+
+module YAVM
+  module Stores
+
+    def stores
+      [
+        YAVM::Stores::Semver,
+        YAVM::Stores::Package,
+        YAVM::Stores::Bower,
+        YAVM::Stores::GemSpec,
+      ]
+    end
+
+    def locate_versions
+      versions = stores.map do |store|
+        store = store.new
+        next store.to_version if store.exists?
+      end
+
+      YAVM::Versions.new(versions)
+    end
+
+    module_function :locate_versions, :stores
+  end
+end

data/lib/yavm/stores/base.rb

@@ -0,0 +1,46 @@
+require 'json'
+
+module YAVM
+  module Stores
+
+    class Base
+      def name
+        self.class.name
+      end
+      #
+      # If the file for the store exists.
+      # Only 1 file must match the glob.
+      #
+      def exists?
+        Dir[glob].length == 1
+      end
+
+      #
+      # Fetch the matched filename for this store
+      #
+      def filename
+        Dir[glob].first if exists?
+      end
+
+    end
+
+    class GenericJSON < YAVM::Stores::Base
+
+      def data
+        @data ||= JSON.parse(IO.read(filename))
+      end
+
+      def to_version
+        Version.new(self, version_key)
+      end
+
+      def set!(new_version)
+        @data = update_version_key(new_version.to_s)
+        File.open(filename, 'w') { |f| f.write JSON.pretty_generate(data) }
+      end
+
+    end
+
+
+  end
+end

data/lib/yavm/stores/bower.rb

@@ -0,0 +1,26 @@
+require 'yavm/stores/base'
+
+module YAVM
+  module Stores
+    class Bower < YAVM::Stores::GenericJSON
+
+      def name
+        'bower.json file'
+      end
+
+      def glob
+        './bower.json'
+      end
+
+      def version_key
+        data['version']
+      end
+
+      def update_version_key(what)
+        data['version'] = what
+        return data
+      end
+
+    end
+  end
+end

data/lib/yavm/stores/gem_spec.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'yavm/version'
+require 'yavm/stores/base'
+
+module YAVM
+  module Stores
+    class GemSpec < YAVM::Stores::Base
+
+      def name
+        "gemspec: #{filename}"
+      end
+
+      def glob
+        './*.gemspec'
+      end
+
+      def spec
+        @spec ||= Gem::Specification.load(filename)
+      end
+
+      def to_version
+        Version.new(self, spec.version.to_s.gsub('.pre.', '-'))
+      end
+
+      #
+      # Munge the existing file to replace the version identifier.
+      # This might be a bit brittle.
+      #
+      def set!(new_version)
+        current_spec = IO.read(filename)
+        spec_token   = current_spec.match(/Gem::Specification.new do \|(?<token>[^\|]+)\|/m)['token']
+        new_spec     = current_spec.gsub(/^(\s+#{spec_token}\.version\s+=\s+)("|')([^"']+)(\2)/, "\\1\\2#{new_version}\\4")
+
+        File.open(filename, 'w') { |f| f.write new_spec }
+      end
+
+    end
+  end
+end

data/lib/yavm/stores/package.rb

@@ -0,0 +1,26 @@
+require 'yavm/stores/base'
+
+module YAVM
+  module Stores
+    class Package < YAVM::Stores::GenericJSON
+
+      def name
+        'npm package.json'
+      end
+
+      def glob
+        './package.json'
+      end
+
+      def version_key
+        data['version']
+      end
+
+      def update_version_key(what)
+        data['version'] = what
+        return data
+      end
+
+    end
+  end
+end

data/lib/yavm/stores/semver.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+require 'yavm/stores/base'
+
+module YAVM
+  module Stores
+    class Semver < YAVM::Stores::Base
+
+      def name
+        '.semver file'
+      end
+
+      def glob
+        './.semver'
+      end
+
+      def data
+        @data ||= YAML.load_file(filename)
+      end
+
+      def to_version
+        Version.new(self, data)
+      end
+
+      def set!(new_version)
+        File.open(filename, 'w') { |f| f.write new_version.to_yaml }
+      end
+
+    end
+  end
+end

data/lib/yavm/version.rb

@@ -0,0 +1,88 @@
+require 'forwardable'
+require 'ostruct'
+
+module YAVM
+  class Version
+    extend ::Forwardable
+
+    attr_accessor :store
+
+    def initialize(store, vobject = nil)
+      self.store = store
+
+      if vobject
+        case vobject
+        when String
+          parse(vobject)
+        when Hash
+          load(vobject)
+        end
+      end
+    end
+
+    def to_s
+      format('%M.%m.%p%s')
+    end
+
+    def to_hash
+      @_version.marshal_dump
+    end
+
+    def to_yaml
+      @_version.marshal_dump.to_yaml
+    end
+
+    def tag
+      format('v%M.%m.%p%s%t')
+    end
+
+    def format(string = '')
+      string = string.dup
+
+      string.gsub!('%M', major.to_s)
+      string.gsub!('%m', minor.to_s)
+      string.gsub!('%p', patch.to_s)
+      string.gsub!('%s', special ? "-#{special}" : '')
+      string.gsub!('%t', meta ? "+#{meta}" : '')
+      string.gsub!('%%', '%')
+
+      return string
+    end
+
+    def ==(other)
+      self.major == other.major &&
+      self.minor == other.minor &&
+      self.patch == other.patch &&
+      self.special == other.special
+    end
+
+    private
+
+    def parse(string)
+      match = string.match(/\A(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)(?:-(?<special>[a-z0-9]+))?(?:\+(?<meta>[a-z0-9]+))?\z/i)
+
+      @_version = Hash[ match.names.zip( match.captures ) ]
+      @_version = OpenStruct.new(@_version)
+      integerize!
+    end
+
+    def load(hash)
+      @_version = OpenStruct.new(hash)
+      integerize!
+    end
+
+    def integerize!
+      @_version.major = @_version.major.to_i
+      @_version.minor = @_version.minor.to_i
+      @_version.patch = @_version.patch.to_i
+    end
+
+    #
+    # Allows calling "version.minor" and the like on the Version instance
+    #
+    def_delegators :@_version,
+      :major,  :minor,  :patch,  :special,  :meta,
+      :major=, :minor=, :patch=, :special=, :meta=
+
+  end
+end

data/lib/yavm/versions.rb

@@ -0,0 +1,34 @@
+require 'forwardable'
+
+module YAVM
+  class Versions
+    extend ::Forwardable
+
+    def initialize(versions)
+      self.versions = versions.compact
+    end
+
+    # Set a given version to be the authoritative version for all defined stores
+    def set_all!(authoritative_version)
+      versions.each do |version|
+        version.store.set!(authoritative_version)
+      end
+    end
+
+    #
+    # Get a list of versions which aren't the same version
+    # as the first version, and boolean-ify that result
+    #
+    def equal?
+      versions.reject { |v| v == versions.first }.length.zero?
+    end
+
+    def_delegators :versions, :<<, :length, :size, :[],
+      :first, :each, :each_with_index, :empty?, :any?
+
+    private
+
+    attr_accessor :versions
+
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: YAVM
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lewis Eason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: A tiny gem for managing project version numbers
+email: me@lewiseason.co.uk
+executables:
+- version
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/version
+- lib/yavm.rb
+- lib/yavm/README.md
+- lib/yavm/command_line.rb
+- lib/yavm/stores.rb
+- lib/yavm/stores/base.rb
+- lib/yavm/stores/bower.rb
+- lib/yavm/stores/gem_spec.rb
+- lib/yavm/stores/package.rb
+- lib/yavm/stores/semver.rb
+- lib/yavm/version.rb
+- lib/yavm/versions.rb
+homepage: https://github.com/lewiseason/yavm
+licenses:
+- GPLv2
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Yet Another Version Manager
+test_files: []
+has_rdoc: