buildar 3.0.0.1 → 3.0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d66f1821b6fed8ae765cb0863bcc94d2e1d26e4f
-  data.tar.gz: 9abd4f6724a248baf196221945d443f630aa32b7
+  metadata.gz: a290c0a56acbb29c1c8afc792b47eca64966a483
+  data.tar.gz: 76fa4de94bf9708fbfb94a737965590f480235fa
 SHA512:
-  metadata.gz: 7b675e519283d5a47c67a87e8709961f590febc2e64dad02e4406fc3ef29413cc99ecf57e8fb09b08cc9f84b9b4579fe9ffa880fd29cec0c695c287340fbe20e
-  data.tar.gz: 4ffdd5035cbf607a5b719e6c8f551575a5c9cf09da3892d48c0a92bcfb4e6d4c8ef5f5e6c12d90debde397b0bd5765342c7af60528c26a2e65cabae8824977bb
+  metadata.gz: ddd306d90efb9e04b610db960f3ca9aea44b07bb70be7af4df3b0966d4109ee39344cf9f309feb03764c82ed8ea983fce44ce8a471322c82c0a60e2394e69a94
+  data.tar.gz: d99d227d9e0f66c5b236c1febbd6b124921618bd7f615588056a68735b31151b6ba6e61f39dea7e2036da8de74c7a73efa921dccf2c24a0c052689f227a10fe3

data/README.md

@@ -2,8 +2,8 @@
 [![Dependency Status](https://gemnasium.com/rickhull/buildar.svg)](https://gemnasium.com/rickhull/buildar)
 [![Security Status](https://hakiri.io/github/rickhull/buildar/master.svg)](https://hakiri.io/github/rickhull/buildar/master/shield)
 
-Buildar
-=======
+# Buildar
+
 Buildar provides a set of rake tasks to help automate releasing your gem:
 * Versioning
 * Building / Packaging
@@ -11,45 +11,49 @@ Buildar provides a set of rake tasks to help automate releasing your gem:
 
 With a set of options to integrate with your current project.
 
-Rake tasks
-----------
-Core
-*     `release` - `build` `publish` `tag`
-*       `build` - `pre_build` gem build a pkg/.gem
-* `gem_package` - `pre_build` Gem::PackageTask builds a pkg/.gem
-*     `publish` - `built` gem push
-*     `buildar` - config check
-
-Aux
-*   `pre_build` - invoke `test` and `bump:build` conditionally
-*       `built` - `build` conditionally
-*     `install` - `built` gem install .gem
-* `install_new` - `build` install built .gem
-*     `version` - show the current project version
-
-With git integration
-*     `tag` - `message` git tag current version, push to origin
-* `message` - capture a message from ENV['message'] or prompt STDIN
-
-With version file integration
-* `bump:build` - increment the 4th version number (1.2.3.4 -> 1.2.3.5)
-* `bump:patch` - increment the 3rd version number (1.2.3.4 -> 1.2.4.0)
-* `bump:minor` - increment the 2nd version number (1.2.3.4 -> 1.3.0.0)
-* `bump:major` - increment the 1st version number (1.2.3.4 -> 2.0.0.0)
-* `release:patch` - `bump:patch` `release`
-* `release:minor` - `bump:minor` `release`
-* `release:major` - `bump:major` `release`
+## Rake tasks
+
+### Core
+
+* **`release`**     - *`build`*, *`publish`*, *`tag`*
+* **`build`**       - *`prebuild`*, `gem build`
+* **`gem_package`** - *`pre_build`*, build with `Gem::PackageTask`
+* **`publish`**     - *`built`*, `gem push`
+* **`buildar`**     - config check
+
+### Aux
+
+* **`pre_build`** - invoke *`test`* and *`bump:build`* conditionally
+* **`built`**     - invoke *`build`* conditionally
+* **`install`**   - *`built`*, `gem install`
+* **`install_new`** - *`build`*, `gem install`
+* **`version`**     - show the current project version
+
+### With git integration
+
+* **`tag`**     - *`message`*, `git tag` current version, `git push` to origin
+* **`message`** - capture a message from `ENV['message']` or prompt STDIN
+
+### With version file integration
+
+* **`bump:build`** - increment the 4th version number (1.2.3.4 -> 1.2.3.5)
+* **`bump:patch`** - increment the 3rd version number (1.2.3.4 -> 1.2.4.0)
+* **`bump:minor`** - increment the 2nd version number (1.2.3.4 -> 1.3.0.0)
+* **`bump:major`** - increment the 1st version number (1.2.3.4 -> 2.0.0.0)
+* **`release:patch`** - *`bump:patch`*, *`release`*
+* **`release:minor`** - *`bump:minor`*, *`release`*
+* **`release:major`** - *`bump:major`*, *`release`*
 
 [Just show me the tasks](https://github.com/rickhull/buildar/blob/master/lib/buildar.rb#L73)
 
-Install
--------
+## Install
+
 ```shell
 $ gem install buildar     # sudo as necessary
 ```
 
-Usage
------
+## Usage
+
 Edit your Rakefile.  Add to the top:
 
 ```ruby
@@ -60,10 +64,15 @@ Buildar.new do |b|
 end
 ```
 
-That is basically the minimal Rakefile needed for Buildar to operate, assuming you have a valid gemspec file named `example.gemspec`.
+That is basically the minimal Rakefile needed for Buildar to operate, assuming
+you have a valid gemspec file named `example.gemspec`.
+
+
+Let's try a Buildar task, **`release`**:
 
 ```
 $ rake release
+
 gem build example.gemspec
 WARNING:  no email specified
 Successfully built RubyGem
@@ -76,8 +85,8 @@ Pushing gem to https://rubygems.org...
 Successfully registered gem: example (1.2.3)
 ```
 
-Without a gemspec file
-----------------------
+### Without a gemspec file
+
 ```ruby
 Buildar.new do |b|
   b.gemspec.name = 'example'
@@ -92,24 +101,30 @@ end
 
 From [examples/no_gemspec_file.rb](https://github.com/rickhull/buildar/blob/master/examples/no_gemspec_file.rb)
 
-Dogfood
--------
+### Dogfood
+
 Here is Buildar's [Rakefile](https://github.com/rickhull/buildar/blob/master/Rakefile):
 
 ```ruby
-require 'buildar'
+begin
+  require 'buildar'
 
-Buildar.new do |b|
-  b.gemspec_file = 'buildar.gemspec'
-  b.version_file = 'VERSION'
-  b.use_git      = true
+  Buildar.new do |b|
+    b.gemspec_file = 'buildar.gemspec'
+    b.version_file = 'VERSION'
+    b.use_git      = true
+  end
+
+rescue LoadError => e
+  warn "buildar failed to load: #{e}"
 end
 ```
 
-With `b.version_file` and `b.use_git`
+Let's try **`release:patch`**, this time with `b.version_file` and `b.use_git`:
 
 ```
 $ rake release:patch message="added version task; demonstrating Usage"
+
 bumping 2.0.0.9 to 2.0.1.0
 git commit VERSION -m "Buildar version:bump_patch to 2.0.1.0"
 [master 5df1ff8] Buildar version:bump_patch to 2.0.1.0
@@ -134,28 +149,39 @@ To https://github.com/rickhull/buildar.git
 * [new tag]         v2.0.1.1 -> v2.0.1.1
 ```
 
-Use a VERSION file
-------------------
+### Use a VERSION file
+
 * Buildar can manage your version numbers with `b.version_file`
-* The version only matters in the context of a release.  For internal development, git SHAs vastly outclass version numbers.
-* "The right version number" for the next release is a function of the current release version and the magnitude (or breakiness) of the change
+* The version only matters in the context of a release.  For internal
+  development, git SHAs vastly outclass version numbers.
+* "The right version number" for the next release is a function of the current
+  release version and the magnitude (or breakiness) of the change
 * http://guides.rubygems.org/patterns/#semantic-versioning
 * http://semver.org/
 * Automate everything
 
 The [VERSION](https://github.com/rickhull/buildar/blob/master/VERSION) file at your project root should look something like
+
 ```
 1.2.3.4
 ```
 
-Buildar will be able to `bump:major` `bump:minor` `bump:patch` and `bump:build`.  This helps with a repeatable, identifiable builds: `build` invokes `bump:build` etc.
+Buildar will be able to **`bump:major`**, **`bump:minor`**, **`bump:patch`**,
+and **`bump:build`**.  This helps with a repeatable, identifiable builds:
+**`build`** invokes **`bump:build`** etc.
 
-Every build bumps the build number.  Since the build operates off of your potentially dirty working copy, and not some commit SHA, there is no guarantee that things haven't changed between builds, even if "nothing is supposed to have changed".  This guarantees that you can't have 2 builds floating around with the same version number but different contents.
+Every build bumps the build number.  Since the build operates off of your
+potentially dirty working copy, and not some commit SHA, there is no guarantee
+that things haven't changed between builds, even if "nothing is supposed to
+have changed".  This guarantees that you can't have 2 builds floating around
+with the same version number but different contents.
 
-Typically you'll want to let Buildar manage the build number, and you manage the major, minor, and patch numbers with:
-* `release:major` - `bump:major`
-* `release:minor` - `bump:minor`
-* `release:patch` - `bump:patch`
+Typically you'll want to let Buildar manage the build number, and you manage
+the major, minor, and patch numbers with:
+
+* **`release:major`** - *`bump:major`*
+* **`release:minor`** - *`bump:minor`*
+* **`release:patch`** - *`bump:patch`*
 
 To make your app or lib aware of its version via this file, simply:
 
@@ -165,15 +191,16 @@ To make your app or lib aware of its version via this file, simply:
 module Foo
   def self.version
     file = File.expand_path('../../VERSION', __FILE__)
-	File.read(file).chomp
+    File.read(file).chomp
   end
 end
 ```
 
-`b.version_file` defaults to nil, so if you don't set it, you'll have to keep your gemspec's version attribute updated.
+`b.version_file` defaults to nil, so if you don't set it, you'll have to keep
+your gemspec's version attribute updated.
+
+### Gemspec file tricks
 
-Gemspec file tricks
--------------------
 With
 ```ruby
 Buildar.new do |b|
@@ -181,18 +208,18 @@ Buildar.new do |b|
   b.version_file = 'VERSION'
 ```
 
-You'll need to keep your gemspec file in synch with the version_file.  Here's [how Buildar does it](https://github.com/rickhull/buildar/blob/master/buildar.gemspec):
+You'll need to keep your gemspec file in synch with `b.version_file`.
+Here's [how Buildar does it](https://github.com/rickhull/buildar/blob/master/buildar.gemspec):
+
 ```ruby
 # Gem::Specification.new do |s|
   # ...
-  # dynamic setup
-  this_dir = File.expand_path('..', __FILE__)
-  version_file = File.join(this_dir, 'VERSION')
-  manifest_file = File.join(this_dir, 'MANIFEST.txt')
-
-  # dynamic assignments
-  s.version  = File.read(version_file).chomp
-  s.files = File.readlines(manifest_file).map { |f| f.chomp }
+  s.version  = File.read(File.join(__dir__, 'VERSION')).chomp
+  s.files =
+    File.readlines(File.join(__dir__, 'MANIFEST.txt')).map { |f| f.chomp }
 ```
 
-I also like to maintain a [MANIFEST.txt](https://github.com/rickhull/buildar/blob/master/MANIFEST.txt) -- the canonical list of files belonging to the project -- outside of the gemspec.
+Buildar maintains a
+[MANIFEST.txt](https://github.com/rickhull/buildar/blob/master/MANIFEST.txt)
+-- the canonical list of files belonging to the project --
+outside of the gemspec.

data/VERSION

@@ -1 +1 @@
-3.0.0.1
+3.0.0.2

data/lib/buildar.rb

@@ -4,8 +4,7 @@ require 'rake/tasklib'
 
 class Buildar < Rake::TaskLib
   def self.version
-    file = File.expand_path('../../VERSION', __FILE__)
-    File.read(file).chomp
+    File.read(File.join(__dir__, '..', 'VERSION')).chomp
   end
 
   # e.g. bump(:minor, '1.2.3') #=> '1.3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildar
 version: !ruby/object:Gem::Version
-  version: 3.0.0.1
+  version: 3.0.0.2
 platform: ruby
 authors:
 - Rick Hull