versioneer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3672df4599ece68c07bd90b81ee88ffbfaad7e5
-  data.tar.gz: c2e742df40e00c93dc2fda05e60cb99eb85d77ff
+  metadata.gz: ee701908cb03f1d4b141322c9b585cc7437cad97
+  data.tar.gz: 5e0dd2d56aa57ac5117547d082f007b7ada3c8c6
 SHA512:
-  metadata.gz: ce76334fbc57eb035b24faaece27228acbc5dfa408737645a1737921eb6d2391818c44f9e45e2c388f54b28c67b08dfb8537392a7acba2fa5e06b125fb62704d
-  data.tar.gz: 9abfe251e0fd6d9b5f2b9a3e1ad1e0cda86b0e324af2a388ee7ef618c5583e821a91f609e70eccad66f5e9e8d725efa06ea3f707dd80b29ada133d4a85fc035e
+  metadata.gz: 6efc9941ce943f798bdf8e9f86d59120b6f68146c6d4b2b503afe863158300cb88f2e48a4769d3d179778886c655408db991af487e29d6e0f763bec15deebdb7
+  data.tar.gz: fdc891bfbc2218b5ab83a31af1a27bc5883da759f424b151b081009b233ab2e2319598d7105adaadb2bce18978110dbcdbd6ceb5fa8f0b6ce3da9fba5285baed

data/.versioneer.yml

@@ -3,7 +3,7 @@
 
 type: Git
 bump_segment: minor
+environment: development
 prereleases:
   - alpha
   - beta
-  - beta

data/README.md

@@ -27,7 +27,9 @@ Project versions update automatically based on VCS changes and where the code ha
 
 ## Usage
 
-* [Configuration options are documented in the Wiki.](https://github.com/binarybabel/gem-versioneer/wiki)
+* Available from [Command-Line](#command-line) or [Ruby](#ruby-project-rails-rack-rubygem-etc)
+* Project-level configuration using a `.versioneer.yml` file
+  * [Wiki Documentation](https://github.com/binarybabel/gem-versioneer/wiki)
 * The Versioneer environment is selected from the following system variables:
    * _Any value other than "production" is assumed to be "development"_
 
@@ -37,23 +39,23 @@ ENV['VERSIONEER_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['ENV']
 
 ### Command-Line
 
-CLI usage defaults to "production" mode.
-
 ```
-$ git tag -am 'Release 0.1' v0.1
-...
-$ versioneer
+$ git tag -am 'Release' v0.1
+$ versioneer print
 0.1
 ...
 $ git commit --allow-empty -m 'Some changes.'
-...
-$ versioneer
-0.2.rc1
+$ versioneer status
+DEVELOPMENT -> 0.2.beta1    
+ PRODUCTION -> 0.2.rc1    
 ...
 $ versioneer --help
 ```
 
-### Ruby Project (Rails, Rack, etc.)
+### Ruby Project (Rails, Rack, RubyGem, etc.)
+
+Generic installation, adapt as necessary. See the
+[Versioneer Wiki](https://github.com/binarybabel/gem-versioneer/wiki) for more.
 
 * Add Versioneer to your Gemfile
 
@@ -75,15 +77,18 @@ Generating config
 * Modify your project's version variable
 
 ```
+$ vim config/version.rb
+
 require 'versioneer'
 module MyApp
-  VERSION = Versioneer::Config.new(Rails.root).version.to_s
+  # Configure versioneer with the project's root path:
+  VERSION = Versioneer::Config.new(File.expand_path('../../', __FILE__)).to_s
 end
 ```
 
 ## Settings & Customization
 
-**[Check out the Versioneer Wiki for more information](https://github.com/binarybabel/gem-versioneer/wiki)**
+**[Please refer to the Versioneer Wiki for full documentation.](https://github.com/binarybabel/gem-versioneer/wiki)**
 
 ## Contributing
 

data/Rakefile

@@ -12,12 +12,11 @@ task :default => :test
 load 'changelog.rake'
 
 task :relock do
+  ENV['VERSIONEER_ENV'] = 'development'
   system './bin/versioneer unlock > /dev/null'
   system './bin/versioneer lock'
-  puts '...'
-  puts "Preparing to build Gem version #{`./bin/versioneer print`}..."
-  puts 'Press Ctrl-C now to cancel'
-  system 'sleep 5'
 end
 
-Rake::Task[:build].enhance [:relock]
+Rake::Task[:build].enhance [:relock] do
+  system './bin/versioneer unlock > /dev/null'
+end

data/bin/versioneer

@@ -83,12 +83,11 @@ case (cmd = ARGV.shift)
   when 'lock'
     v.lock!(ARGV.shift)
     puts "+ #{Versioneer::Config::DEFAULT_LOCK}"
-    puts "Locked at version: #{v}"
-    puts 'Will output this version without querying VCS.'
+    puts "Version: #{v}"
   when 'unlock'
     v.unlock!
     puts "- #{Versioneer::Config::DEFAULT_LOCK}"
-    puts "Unlocked. #{v.environment.capitalize} now: #{v}"
+    puts "#{v.environment.capitalize} version now: #{v}"
   when 'init'
     init_file = Versioneer::Config::DEFAULT_FILE
     if File.exist?(init_file)

data/lib/versioneer/config.rb

@@ -16,13 +16,13 @@ module Versioneer
         @config_base = base_dir_or_config_file
         @config_file = File.join(base_dir_or_config_file, DEFAULT_FILE)
         unless File.exist?(@config_file)
-          raise MissingConfigError, "#{self.class.name} file does not exist. (#{@config_file})"
+          raise MissingConfigError, "Versioneer config file does not exist. (#{@config_file})"
         end
       elsif File.exist?(base_dir_or_config_file)
         @config_file = base_dir_or_config_file
         @config_base = File.dirname(@config_file)
       else
-        raise RuntimeError, "#{self.class.name} file does not exist. (#{base_dir_or_config_file})"
+        raise RuntimeError, "Versioneer base path does not exist. (#{base_dir_or_config_file})"
       end
 
       params = YAML.load_file(@config_file)

data/lib/versioneer/git.rb

@@ -6,9 +6,9 @@ module Versioneer
 
     def initialize(file_within_repo, options=nil)
       super
-      unless file_within_repo.is_a? Dir and Dir.join('.git').exist?
+      unless Dir.exist?(File.join(file_within_repo, '.git'))
         unless H.lines? `git ls-files #{file_within_repo} --error-unmatch #{H.cl_no_stderr}`
-          raise InvalidRepoError, 'Not a git repo.'
+          raise InvalidRepoError, "Not inside a Git repo. (#{file_within_repo})"
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: versioneer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - BinaryBabel OSS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-01 00:00:00.000000000 Z
+date: 2017-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler