buildar 2.0.1.1 → 2.0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7159f298473d67c99917653ce4f01ccebce8e974
+  data.tar.gz: a93ff135b37d1c84458f3181fc01f3e4c334bfbe
+SHA512:
+  metadata.gz: a71a3632bc33993caf133f50b1a7f80b9fe27602a7f40fcdd7f6805bbb0ee16eb63f85359aedd0eea885af33b366a3476f9153f7a23ebe8e0432599941bbab52
+  data.tar.gz: 863ed9cbbd1a3461d41c3efec012b3911466f9054f518848367e72dc634cecb921a253c10de4a2040ec4213bdb75e187336b67dde5a9bc774bf715243f24e5b6

data/MANIFEST.txt

@@ -2,5 +2,5 @@ buildar.gemspec
 MANIFEST.txt
 VERSION
 README.md
-rakefile.rb
+Rakefile
 lib/buildar.rb

data/README.md

@@ -1,3 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/buildar.svg)](http://badge.fury.io/rb/buildar)
+[![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 provides a set of rake tasks to help automate releasing your gem:
@@ -36,8 +40,6 @@ With version file integration
 * `release:minor` - `bump:minor` `release`
 * `release:major` - `bump:major` `release`
 
-Tasks which depend on optional functionality will not fail if the option is disabled.  They are effectively skipped.
-
 [Just show me the tasks](https://github.com/rickhull/buildar/blob/master/lib/buildar.rb#L73)
 
 Install
@@ -51,86 +53,102 @@ Usage
 Edit your Rakefile.  Add to the top:
 
 ```ruby
-require 'buildar/tasks'
+require 'buildar'
 
-Buildar.conf(__FILE__) do |b|
-  b.name = 'Example'             # optional, inferred from directory
-  # ...
-end
-
-# make sure you have a task named :test, even if it's empty
-task :test do
-  # ...
+Buildar.new do |b|
+  b.gemspec_file = 'example.gemspec'
 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`.
+
+```
+$ rake release
+gem build example.gemspec
+WARNING:  no email specified
+Successfully built RubyGem
+Name: example
+Version: 1.2.3
+File: example-1.2.3.gem
+mv example-1.2.3.gem pkg/example-2.0.1.1.gem
+gem push pkg/example-1.2.3.gem
+Pushing gem to https://rubygems.org...
+Successfully registered gem: example (1.2.3)
+```
 
 Without a gemspec file
 ----------------------
 ```ruby
-Buildar.conf(__FILE__) do |b|
-  b.name = 'Example'
-  b.use_gemspec_file = false
-  b.use_version_file = false
-  b.use_git = false
-  b.publish[:rubygems] = false
-
+Buildar.new do |b|
+  b.gemspec.name = 'example'
   b.gemspec.summary  = 'Example of foo lorem ipsum'
   b.gemspec.author   = 'Buildar'
   b.gemspec.license  = 'MIT'
   b.gemspec.description = 'Foo bar baz quux'
   b.gemspec.files = ['Rakefile']
-  b.gemspec.version = 2.0
+  b.gemspec.version = '1.2.3'
 end
 ```
-From [examples/no_gemspec_file.rb](https://github.com/rickhull/buildar/blob/master/examples/no_gemspec_file.rb)
 
-Someone told me this breaks [Bundler](https://github.com/bundler/bundler), so maybe just use a gemspec file, k?
+From [examples/no_gemspec_file.rb](https://github.com/rickhull/buildar/blob/master/examples/no_gemspec_file.rb)
 
 Dogfood
 -------
-Here is Buildar's [rakefile.rb](https://github.com/rickhull/buildar/blob/master/rakefile.rb):
+Here is Buildar's [Rakefile](https://github.com/rickhull/buildar/blob/master/Rakefile):
 
 ```ruby
-require 'buildar/tasks'
-require 'rake/testtask'
-
-Buildar.conf(__FILE__) do |b|
-  b.name = 'buildar'
-  b.use_version_file  = true
-  b.version_filename  = 'VERSION'
-  b.use_git           = true
-  b.publish[:rubygems] = true
-end
+require 'buildar'
 
-Rake::TestTask.new :test do |t|
-  t.pattern = 'test/*.rb'
+Buildar.new do |b|
+  b.gemspec_file = 'buildar.gemspec'
+  b.version_file = 'VERSION'
+  b.use_git      = true
 end
 ```
 
-You can use it as a starting point.
+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
+1 file changed, 1 insertion(+), 1 deletion(-)
+bumping 2.0.1.0 to 2.0.1.1
+git commit VERSION -m "Buildar version:bump_build to 2.0.1.1"
+[master 73d9bdb] Buildar version:bump_build to 2.0.1.1
+1 file changed, 1 insertion(+), 1 deletion(-)
+gem build buildar.gemspec
+WARNING:  no email specified
+Successfully built RubyGem
+Name: buildar
+Version: 2.0.1.1
+File: buildar-2.0.1.1.gem
+mv buildar-2.0.1.1.gem pkg/buildar-2.0.1.1.gem
+gem push pkg/buildar-2.0.1.1.gem
+Pushing gem to https://rubygems.org...
+Successfully registered gem: buildar (2.0.1.1)
+git tag -a "v2.0.1.1" -m "added version task; demonstrating Usage"
+git push origin --tags
+To https://github.com/rickhull/buildar.git
+* [new tag]         v2.0.1.1 -> v2.0.1.1
+```
 
 Use a VERSION file
 ------------------
-* Buildar can manage your version numbers with `b.use_version_file = true`
+* 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
+* http://guides.rubygems.org/patterns/#semantic-versioning
 * http://semver.org/
 * Automate everything
 
-Enable and configure a version file:
-```ruby
-  b.use_version_file = true
-  b.version_filename = 'VERSION'
-```
-
-The VERSION file should look something like
+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` depends on `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.
 
@@ -145,11 +163,6 @@ To make your app or lib aware of its version via this file, simply:
 # e.g. lib/foo.rb
 #################
 module Foo
-  # use a method, not a constant like VERSION
-  # if you use a constant, then you're doing an extra file read at requiretime
-  # and that hurts production.  This method should not be called in production.
-  # It's here more for deployment and sysadmin purposes.  Memoize as needed.
-  #
   def self.version
     file = File.expand_path('../../VERSION', __FILE__)
 	File.read(file).chomp
@@ -157,17 +170,15 @@ module Foo
 end
 ```
 
-If you stick with the default `b.use_version_file = false` then you need to make sure 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
 -------------------
-I like to let Buildar manage my [VERSION](https://github.com/rickhull/buildar/blob/master/VERSION) file, and I also like to maintain my [MANIFEST.txt](https://github.com/rickhull/buildar/blob/master/MANIFEST.txt) -- the canonical list of files belonging to the project -- outside of [buildar.gemspec](https://github.com/rickhull/buildar/blob/master/buildar.gemspec).
-
 With
 ```ruby
-Buildar.conf(__FILE__) do |b|
-  b.use_gemspec_file = true
-  b.use_version_file = true
+Buildar.new do |b|
+  b.gemspec_file = 'example.gemspec'
+  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):
@@ -184,24 +195,4 @@ You'll need to keep your gemspec file in synch with the version_file.  Here's [h
   s.files = File.readlines(manifest_file).map { |f| f.chomp }
 ```
 
-Integrate with git
-------------------
-Enable git integration with `b.use_git = true`.  This empowers `tag` and `bump`:
-* `tag` is a `release` dependency.  It depends on `test` git tag -a $tagname -m $message
-* `bump` and friends will commit VERSION changes
-
-Publish to rubygems.org
------------------------
-Enable `publish` to rubygems.org with `b.publish[:rubygems] = true`.
-
-Testing it out
---------------
-```shell
-rake buildar  # print Buildar's config / smoketest
-rake version  # print the Buildar's understanding of the version
-rake build    # build a .gem file in pkg/
-rake install  # build, uninstall, install
-rake release  # build the .gem and push it rubygems.org
-```
-
-`release` depends on `publish` which depends on `verify_publish_credentials` which will fail if you don't have `~/.gem/credentials`.  In that case, sign up for an account at http://rubygems.org/ and follow the instructions to get your credentials file setup.
+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.

data/{rakefile.rb → Rakefile}

@@ -4,5 +4,4 @@ Buildar.new do |b|
   b.gemspec_file = 'buildar.gemspec'
   b.version_file = 'VERSION'
   b.use_git      = true
-#  b.ns = 'gem'
 end

data/VERSION

@@ -1 +1 @@
-2.0.1.1
+2.0.2.1

data/buildar.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   # static stuff
   s.name     = 'buildar'
-  s.summary  = 'Buildar crept inside your rakefile and scratched upon the tasking post'
+  s.summary  = 'Buildar crept inside your Rakefile and scratched upon the tasking post'
   s.author   = 'Rick Hull'
   s.homepage = 'https://github.com/rickhull/buildar'
   s.license  = 'MIT'

data/lib/buildar.rb

@@ -75,9 +75,7 @@ class Buildar < Rake::TaskLib
     CLOBBER.include @pkg_dir
 
     if @ns and !@ns.empty?
-      namespace @ns do
-        define_tasks
-      end
+      namespace(@ns) { define_tasks }
     else
       define_tasks
     end
@@ -91,9 +89,9 @@ class Buildar < Rake::TaskLib
       spacer = " " * 14
       gemspec = self.gemspec
       puts
+      puts "     Project: #{gemspec.name} #{gemspec.version}"
+      puts "Gemspec file: #{@gemspec_file}" if @gemspec_file
       puts <<EOF
-     Project: #{gemspec.name} #{gemspec.version}
-Gemspec file: #{@gemspec_file}
 Version file: #{@version_file}
      Use git: #{@use_git}
  Package dir: #{@pkg_dir}
@@ -118,7 +116,7 @@ EOF
             puts "bumping #{old_version} to #{new_version}"
             self.write_version new_version
 
-            if @use_git
+            if @use_git and v != :build
               msg = "Buildar version:bump_#{v} to #{new_version}"
               sh "git commit #{@version_file} -m #{msg.inspect}"
             end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: buildar
 version: !ruby/object:Gem::Version
-  version: 2.0.1.1
-  prerelease: 
+  version: 2.0.2.1
 platform: ruby
 authors:
 - Rick Hull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '8'
 description: Buildar helps automate the release process with versioning, building,
@@ -34,35 +31,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- buildar.gemspec
 - MANIFEST.txt
-- VERSION
 - README.md
-- rakefile.rb
+- Rakefile
+- VERSION
+- buildar.gemspec
 - lib/buildar.rb
 homepage: https://github.com/rickhull/buildar
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: Buildar crept inside your rakefile and scratched upon the tasking post
+specification_version: 4
+summary: Buildar crept inside your Rakefile and scratched upon the tasking post
 test_files: []