app_version 0.1.1 → 0.1.5

data/{README.rdoc → README.md}

@@ -1,4 +1,4 @@
-= App Version
+## App Version
 
 This is a simple plugin that makes it easy to manage the version number of your
 Rails application. The version numbers supported by this plugin look like
@@ -6,37 +6,39 @@ Rails application. The version numbers supported by this plugin look like
 
 The components of the version number are:
 
-  2          => major
-  0          => minor
-  1          => patch
-  M4         => milestone
-  (600)      => build number (usually Subversion revision)
-  branch     => the name of the branch this version is from.
-  coder      => the name of the user that made the release
-  2008-10-27 => the date of the release
+  	2          => major
+  	0          => minor
+  	1          => patch
+  	M4         => milestone
+  	(600)      => build number (usually Subversion revision)
+ 	branch     => the name of the branch this version is from.
+ 	coder      => the name of the user that made the release
+  	2008-10-27 => the date of the release
 
 Only the major and minor numbers are required. The rest can be omitted and the
 plugin will attempt to do the right thing.
 
-== Install
+### Install
 
-To install this plugin from gitHub run the following command:
+To install include in your Gemfile and execute bundler install
 
-./script/plugin install git://github.com/toland/app_version.git
+	gem 'app_version'
+
+Will then have the rake tasks below available.
 
 == Usage
 
 To use, simply place a file in RAILS_ROOT/config called version.yml with the
 following format:
 
-  major:     2
-  minor:     0
-  patch:     1
-  milestone: 4
-  build:     git-revcount
-  branch:    master
-  committer: coder
-  build_date: 2008-10-27
+  	major:     2
+  	minor:     0
+  	patch:     1
+  	milestone: 4
+  	build:     git-revcount
+  	branch:    master
+  	committer: coder
+  	build_date: 2008-10-27
 
 If the milestone or patch fields are less than 0 then they will not show up
 in the version string. The build field can be a build number or one of the
@@ -59,7 +61,7 @@ properly formatted version number. APP_VERSION also has +major+, +minor+,
 +patch+, +milestone+, +build+, +branch+, +committer+, and +build_date+
 methods to retrieve the individual components of the version number.
 
-== Capistrano Usage
+### Capistrano Usage
 
 When the app_version plugin is installed, it copies a templated edition of the
 version.yml file into /lib/templates/version.yml.erb, the initial file shows a
@@ -75,23 +77,25 @@ Both the standard and extended capistrano usage can co-exist in the same project
 the dynamic rendering of the version.yml only happens when using capistrano to
 deploy your app.
 
-== Rake tasks
+**Not Confirmed working in this version**
+
+### Rake tasks
 
 This plugin includes 4 new rake tasks:
 
-rake app:install    - will copy the version.yml and version.yml.erb into more user
-                      accessible locations (/config, and /lib/templates)
+	rake app:install    - will copy the version.yml and version.yml.erb into more user
+  	                    accessible locations (/config, and /lib/templates)
 
-rake app:uninstall  - will remove the files copied in the install task
+	rake app:uninstall  - will remove the files copied in the install task
 
-rake app:render     - will render the erb template into /config/version.yml
-                      in case you want to have dynamic values updated via a rake task.
-                      Note: certain examples expect the app to be in a git working directory.
+	rake app:render     - will render the erb template into /config/version.yml
+    	                  in case you want to have dynamic values updated via a rake task.
+        	              Note: certain examples expect the app to be in a git working directory.
 
-rake app:version    - will output the version number of the current rails
-                      application.
+	rake app:version    - will output the version number of the current rails
+                    	  application.
 
-= License
+## License
 
 This plugin is released under the terms of the Ruby license. See
 http://www.ruby-lang.org/en/LICENSE.txt.

data/lib/install.rb

@@ -1,9 +1,9 @@
 # copy the version.yml.erb to some user editable location for example, in lib
 
 targetTemplateDir = File.join(Rails.root.to_s, 'lib/templates')
-sourceTemplateFile = File.join(File.dirname(__FILE__), 'lib/templates/version.yml.erb')
+sourceTemplateFile = File.join(File.dirname(__FILE__), 'app_version/templates/version.yml.erb')
 
-sourceSampleFile = File.join(File.dirname(__FILE__), 'lib/templates/version.yml')
+sourceSampleFile = File.join(File.dirname(__FILE__), 'app_version/templates/version.yml')
 targetSampleDir = File.join(Rails.root.to_s, '/config')
 
 FileUtils.mkdir( targetTemplateDir, :verbose => true) unless File.exists?(targetTemplateDir)

data/lib/tasks/app_version_tasks.rake

@@ -9,12 +9,12 @@ namespace :app do
 
   desc 'Configure for initial install.'
   task :install do
-    require File.join(File.dirname(__FILE__), "../../install.rb")
+    require File.join(File.dirname(__FILE__), "../install.rb")
   end
 
   desc 'Clean up prior to removal.'
   task :uninstall do
-    require File.join(File.dirname(__FILE__), "../../uninstall.rb")
+    require File.join(File.dirname(__FILE__), "../uninstall.rb")
   end
 
   desc 'Render the version.yml from its template.'

data/lib/uninstall.rb

@@ -1,8 +1,8 @@
-targetTemplateDir = File.join(RAILS_ROOT, 'lib/templates')
+targetTemplateDir = File.join(Rails.root.to_s, 'lib/templates')
 
-targetTemplateFile = File.join(RAILS_ROOT, 'lib/templates/version.yml.erb')
-targetConfigSampleFile = File.join(RAILS_ROOT, '/config/version.yml')
-targetTemplateSampleFile = File.join(RAILS_ROOT, 'lib/templates/version.yml')
+targetTemplateFile = File.join(Rails.root.to_s, 'lib/templates/version.yml.erb')
+targetConfigSampleFile = File.join(Rails.root.to_s, '/config/version.yml')
+targetTemplateSampleFile = File.join(Rails.root.to_s, 'lib/templates/version.yml')
 
 if File.exist?(targetTemplateFile)          then FileUtils.rm( targetTemplateFile, :verbose => true) end
 if File.exist?(targetConfigSampleFile)      then FileUtils.rm( targetConfigSampleFile, :verbose => true) end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_version
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -45,7 +45,7 @@ files:
 - lib/tasks/app_version_tasks.rake
 - lib/uninstall.rb
 - Rakefile
-- README.rdoc
+- README.md
 - test/app_version_test.rb
 - test/version.yml
 homepage: ''