version_info 0.7.0 → 0.7.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    version_info (0.6.4)
+    version_info (0.7.1)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -3,24 +3,27 @@
 ### Overview
 
   VersionIinfo is a powerful and very lightweight gem to manage version data in your Ruby projects or other gems.
+
   VersionIinfo can manage a serie of predefined segments to build your version tag with the tipical structure X.X.X.X.
-  The values are stored in a yaml file, and supports custom values. Also, rake & thor tasks are   avaiable to simplify yaml file creation and update.
+  Their values are stored in a yaml file, and supports custom values. 
+
+  Also rake & thor tasks are avaiable to simplify yaml file creation and update.
 
   Feel free to contact me about bugs/features
 
 ### Usage
 
-
 Include VersionInfo in your main project module (or class):
 
     require 'version_info'
 
     module MyProject
       include VersionInfo
-
     end
 
-From here, is better to use the builtin rake tasks (see it fordward). Here is how VersionInfo works and their user options:
+From here, is better to use the builtin rake/thor tasks (see it fordward). Here is how VersionInfo works and their user options:
+
+After you included VersionIinfo, a new class MyProject::Version is defined (it inherit from VersionIinfo::Data). Also a new constant MyProject::VERSION is created holding an object of class MyProject::VersionIinfo.
 
 VersionInfo use yaml file to store version data:
 
@@ -38,8 +41,7 @@ Anyway, you can change this:
       VERISION.file_name = '/path/to/my_file.yaml'      
     end
 
-Note you can put any custom data. In order to get the version tag, VersionInfo reserve some special keys
-for use as the "segments" of the version tag:
+Note you can put any custom data. In order to get the version tag, VersionInfo reserve some special keys for use as the "segments" of the version tag. Here the source code:
 
     module VersionInfo
 
@@ -52,7 +54,7 @@ for use as the "segments" of the version tag:
 
 Usingh the previous version_info.yml:
 
-    puts MyProject::VERSION
+    puts MyProject::VERSION.tag
 
     => 0.1.0
 
@@ -63,31 +65,39 @@ Also you can bump any segment. With the same sample:
 
     => 1.0.0
 
-Note the other (lower) segments are reset to 0 after bump.
+Note the other (lower weight) segments are reset to 0 after bump.
 
-
-### Rake tasks
+### Rake / Thor tasks
 
 Put in your rake file:
 
-    VersionInfo::Tasks.install(:class => MyProject) # pass here the thing where you included VersionInfo
+    VersionInfo::RakeTasks.install(:class => MyProject) # use the thing where you included VersionInfo
 
 And you get a few tasks with a namespace vinfo:
 
     rake -T
     =>
     rake vinfo:build  # Bumps version segment BUILD
-    rake vinfo:inspect  # Inspect all current version keys
+    rake vinfo:inspect  # Show complete version info
     rake vinfo:major  # Bumps version segment MAJOR
     rake vinfo:minor  # Bumps version segment MINOR
     rake vinfo:patch  # Bumps version segment PATCH
-    rake vinfo:pre    # Bumps version segment PRE
     rake vinfo:show   # Show current version tag and create version_info.yml if missing
 
-Note vinfo:inspect allows you check your custom keys also.
+Or, if you prefer Thor:
+
+    VersionInfo::ThorTasks.install(:class => MyProject) # use the thing where you included VersionInfo
+
+    thor list
+    =>
+
+    vinfo
+    -----
+    thor vinfo:bump SEGMENT=patch  # bumps segment: [major, minor, patch, build]...
+    thor vinfo:inspect             # Show complete version info
+    thor vinfo:show                # Show version tag and create version_info.yml...
 
 ### Install
 
     gem install version_info
 
-

data/lib/version_info/version_info.yml

@@ -1,4 +1,4 @@
 --- 
 major: 0
 minor: 7
-patch: 0
+patch: 1

data/spec/version_info/test_file.rb

@@ -1,7 +1,6 @@
 require 'version_info'
 
 module TestFile
-  include VersionInfo
 
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Jorge L. Cangas