YAVM 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56bc64875e0c991017a57cd0b3e994ad36eb4c45
-  data.tar.gz: 02d71dbe311990e921e68fc3b7e9f7129de18462
+  metadata.gz: facb897561d347c7ffc318e9487ee3c7e5adde5d
+  data.tar.gz: 54c812978d0f7ac5da5d9bc57653908cf31a5262
 SHA512:
-  metadata.gz: 68751c151d42bcf8bf5bb3e423ccf219c32654743f72f227b89a29d7389dd4c83c6eab3d40aa3b73e2070ed9defa28acb865e7b4c89eaa9c93843630fdaf93bc
-  data.tar.gz: 940bae764ac8ba2f4ff64908185547360384013c47b321301ea2d7c15e105a815a271d39cec0095c71c337f67f75c6c510634d1ba2c7f5d9c505a7a3bac65d46
+  metadata.gz: 6e0a066aecde80ba4f9a547b3d1d04d3056bd3af37df82147b0b4fe852f40a8c723fd0744e5fd1f0a30210c2cc9d29c40483dc426be752a1d533616ed232521e
+  data.tar.gz: 76d9eea472c53de52d227e5bf2a72908ba77467a493347035694a28476127059f7d9535e0aebaea09c22f4b2e32dd014d53bd3c42f8fd2d3ac5e7572ed12f70b

data/README.md

@@ -1,5 +1,8 @@
 # YAVM: Yet Another Version Manager
 
+[![Gem Version](https://badge.fury.io/rb/YAVM.svg)](http://badge.fury.io/rb/YAVM)
+[![Build Status](https://travis-ci.org/lewiseason/yavm.svg?branch=master)](https://travis-ci.org/lewiseason/yavm)
+
 A tiny gem for managing project version numbers.
 
 Heavily inspired by the `semver` gem, this is a tiny utility for managing version numbers,
@@ -12,7 +15,8 @@ which includes support for multiple version format stores:
 
 With planned support for:
 
-* Python distutils package support
+* Python distutils package
+* Possibly gem `::Version`
 
 # Usage
 
@@ -84,10 +88,10 @@ Now on 1.0.3
 - [x] help
 - [x] package.json support
 - [x] bower.json support
-- [ ] when changing version, show new one
+- [x] when changing version, show new one
 - [ ] programmatic interface
 - [ ] tests
 - [ ] handle invalid version info (see Version#parse)
-- [ ] 'version init'
+- [x] 'version init'
 - [ ] quick mode (when finding versions - short circuit once one is found)
 - [ ] raise sensible exceptions

data/features/initialization.feature

@@ -0,0 +1,24 @@
+Feature: Command Line Initialization
+  The command line interface should support initializing version stores and
+  enforce consistency.
+
+  Background:
+    Given I have a project called "project"
+
+  Scenario: Project with no version number
+    Given I run `version`
+    Then the exit status should be 1
+
+  Scenario: Initialize versioning on a project
+    Given I run `version init`
+    Then the exit status should be 0
+
+    When I run `version`
+    Then the output should contain "0.0.0"
+
+  Scenario: Don't initialize if the project already contains version information
+    Given I run `version init`
+    Then the exit status should be 0
+
+    When I run `version init`
+    Then the exit status should be 1

data/features/step_definitions/project.rb

@@ -0,0 +1,8 @@
+require 'fileutils'
+
+Given(/^I have a project called "(.*?)"$/) do |name|
+  @project_dir = "tmp/aruba/#{name}"
+
+  FileUtils.mkdir_p @project_dir
+  Dir.chdir @project_dir
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+require 'aruba/cucumber'
+
+Before do |scenario|
+  @dirs = ['tmp/aruba']
+  @cwd  = Dir.pwd
+end
+
+After do |scenario|
+  Dir.chdir @cwd
+end

data/lib/yavm/command_line.rb

@@ -2,23 +2,27 @@ require 'docopt'
 require 'yavm/stores'
 
 module YAVM
+  #
+  # Command line interface for the `version` command.
+  #
   class CommandLine
-
     def initialize
-      @invocation = File.basename($0)
+      @invocation = File.basename($PROGRAM_NAME)
     end
 
     def invoke!
-      @args    = Docopt::docopt(doc)
-      command  = @args.select { |a, v| commands.include?(a) && v }.keys.first
-      command  = 'show' if command.nil?
+      @args     = Docopt.docopt(doc)
+      command   = @args.select { |a, v| commands.include?(a) && v }.keys.first
+      command ||= 'show'
 
-      versions = YAVM::Stores.locate_versions
+      versions = 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."
+        puts <<-MESSAGE.gsub(/^ {10}/, '').strip
+          There doesn't seem to be any versioning information on this project.
+          Use native versioning tools (see docs for support), or run `#{@invocation} init`
+          to use the built-in versioning method.
+        MESSAGE
         exit(1)
       end
 
@@ -33,34 +37,59 @@ module YAVM
         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
+        version.increment :major if @args['major']
+        version.increment :minor if @args['minor']
+        version.increment :patch if @args['patch']
 
         versions.set_all!(version)
 
+        puts "#{version}"
+
       when 'special'
         version.special = @args['<string>']
-
         versions.set_all!(version)
 
+        puts "#{version}"
+
       when 'meta'
         version.meta = @args['<string>']
-
         versions.set_all!(version)
 
+        puts "#{version}"
+
+      when 'init'
+        # Check if a Semver store is already defined - we should never attempt
+        # to initialize a new one if an existing one is found.
+        if versions.map { |v| v.store.class }.include? YAVM::Stores::Semver
+          message = <<-MESSAGE.gsub(/^ {12}/, '').strip
+            A .semver file already exists at version #{version}
+            See `#{@invocation} help` for details on working with
+            the existing version file.
+          MESSAGE
+
+          fail message
+        end
+
+        store  = Stores::Semver.new
+        store.create!
+
+        semver = Version.new(store)
+        store.set!(semver)
+
+        versions = Stores.locate_versions
+
+        if version
+          puts <<-MESSAGE.gsub(/^ {12}/, '').strip
+            A version is already defined (#{version}),
+            I'll copy that to the new .semver file.
+
+          MESSAGE
+
+          versions.set_all!(version)
+        end
+
+        puts "#{version || semver}"
+
       when 'format'
         puts "#{version.format(@args['<string>'])}"
 
@@ -69,28 +98,28 @@ module YAVM
 
       when 'help'
         Docopt::Exit.set_usage(nil)
-        raise Docopt::Exit, doc.strip
+        fail 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"
+    def choose_authoritative!(versions) # rubocop:disable Metrics/AbcSize
+      puts "Multiple version stores are available, and aren't consistent."
+      puts "Please select the authoritative version:\n\n"
+      puts "WARNING: Munging can be 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]
+          puts format('   %3s: %-15s [%s]', index + 1, version, version.store.name)
         end
 
         print "\nSelection: "
         selection = STDIN.gets.chomp
 
+        # rubocop:disable Style/CaseEquality
         if selection.to_i.to_s == selection && (1..versions.size) === selection.to_i
           selection = selection.to_i
           break
@@ -103,7 +132,6 @@ module YAVM
 
       puts "Now on #{authoritative_version}"
       exit(0)
-
     end
 
     def doc
@@ -112,6 +140,7 @@ module YAVM
 
       Usage:
         #{@invocation}
+        #{@invocation} init
         #{@invocation} inc (major|minor|patch)
         #{@invocation} special [<string>]
         #{@invocation} meta [<string>]
@@ -121,6 +150,7 @@ module YAVM
 
       Options:
         inc          Increment a specific version number
+        init         Create a .semver file for tracking versioning
         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)
@@ -139,12 +169,11 @@ module YAVM
     end
 
     def version_commands
-      ['show', 'inc', 'special', 'meta', 'format', 'tag']
+      %w(show inc special meta init format tag)
     end
 
     def support_commands
-      ['help']
+      %w(help)
     end
-
   end
 end

data/lib/yavm/stores/semver.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'yaml'
 require 'yavm/stores/base'
 
@@ -13,6 +14,10 @@ module YAVM
         './.semver'
       end
 
+      def create!
+        FileUtils.touch '.semver'
+      end
+
       def data
         @data ||= YAML.load_file(filename)
       end

data/lib/yavm/version.rb

@@ -10,13 +10,13 @@ module YAVM
     def initialize(store, vobject = nil)
       self.store = store
 
-      if vobject
-        case vobject
-        when String
-          parse(vobject)
-        when Hash
-          load(vobject)
-        end
+      case vobject
+      when String
+        parse(vobject)
+      when Hash
+        load(vobject)
+      when nil
+        empty
       end
     end
 
@@ -37,7 +37,7 @@ module YAVM
       dump[:special] ||= ''
       dump[:meta]    ||= ''
 
-      return dump
+      dump
     end
 
     def to_yaml
@@ -51,6 +51,7 @@ module YAVM
     def format(string = '')
       string = string.dup
 
+      # ? http://stackoverflow.com/a/8132638
       string.gsub!('%M', major.to_s)
       string.gsub!('%m', minor.to_s)
       string.gsub!('%p', patch.to_s)
@@ -58,14 +59,36 @@ module YAVM
       string.gsub!('%t', meta ? "+#{meta}" : '')
       string.gsub!('%%', '%')
 
-      return string
+      string
     end
 
+    # rubocop:disable Style/RedundantSelf
     def ==(other)
       self.major == other.major &&
-      self.minor == other.minor &&
-      self.patch == other.patch &&
-      self.special == other.special
+        self.minor == other.minor &&
+        self.patch == other.patch &&
+        self.special == other.special
+    end
+
+    def increment(what)
+      case what
+      when :major
+        self.major += 1
+        self.minor  = 0
+        self.patch  = 0
+      when :minor
+        self.minor += 1
+        self.patch  = 0
+      when :patch
+        self.patch += 1
+      else
+        fail "Can't increment #{what}"
+      end
+
+      if [:major, :minor, :patch].include? what
+        self.special = nil
+        self.meta    = nil
+      end
     end
 
     private
@@ -75,10 +98,16 @@ module YAVM
       value.empty? ? nil : value
     end
 
+    def empty
+      @_version = OpenStruct.new ({
+        major: 0, minor: 0, patch: 0, special: '', meta: ''
+      })
+    end
+
     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 = Hash[match.names.zip(match.captures)]
       @_version = OpenStruct.new(@_version)
       integerize!
     end
@@ -98,8 +127,7 @@ module YAVM
     # Allows calling "version.minor" and the like on the Version instance
     #
     def_delegators :@_version,
-      :major,  :minor,  :patch,
-      :major=, :minor=, :patch=, :special=, :meta=
-
+                   :major,  :minor,  :patch,
+                   :major=, :minor=, :patch=, :special=, :meta=
   end
 end

data/lib/yavm/versions.rb

@@ -24,7 +24,7 @@ module YAVM
     end
 
     def_delegators :versions, :<<, :length, :size, :[],
-      :first, :each, :each_with_index, :empty?, :any?
+      :first, :each, :each_with_index, :empty?, :any?, :map
 
     private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: YAVM
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Lewis Eason
@@ -50,6 +50,66 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.18
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.18
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.18
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
 description: A tiny gem for managing project version numbers
 email: me@lewiseason.co.uk
 executables:
@@ -59,8 +119,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/version
+- features/initialization.feature
+- features/step_definitions/project.rb
+- features/support/env.rb
 - lib/yavm.rb
-- lib/yavm/README.md
 - lib/yavm/command_line.rb
 - lib/yavm/stores.rb
 - lib/yavm/stores/base.rb
@@ -94,5 +156,8 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Yet Another Version Manager
-test_files: []
+test_files:
+- features/initialization.feature
+- features/support/env.rb
+- features/step_definitions/project.rb
 has_rdoc: 

data/lib/yavm/README.md

@@ -1,93 +0,0 @@
-# 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