buildar 1.4.0.15 → 2.0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmIzNmVkZGIzNmE5NTRjYmQwNDkzNzIyMzExZjE3YzlhM2M5OTAxYg==
+  data.tar.gz: !binary |-
+    ZjdiZTg1ZDhkMjg2NmM3N2NkNzk4MDAyZmFkOTBjODYyZTY3ZDY3Ng==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGFmMmY3MjVjNWU1MTlmOGEzODBmYjAyYjRjZDFkMzg4OGEyNGFhNWNhYmEx
+    ZmUyMWVmZTdjZWUwOWIzNTBkZjVjNjYzODY2NDZhNDk5NGRhZTA3ZDM0NmVk
+    ZDdiMzJiYzA3MWVjOTYwOTc2Y2ZkNTE2OTM4ZmM5MGU1MmE5NGM=
+  data.tar.gz: !binary |-
+    MmY5MWE4Mjk4Mzg5ZWM1OWE3YWY1Mzg1ODAyMTBjMjY3MTFmODM4ZjJiNWFm
+    NjM2MTNmZDc3ZThmYmU4ZmUyYTA1NTY0NWRhMGMyYTQzYWQ2NTFjYjdiMGY5
+    YjUwOTQxYjI4Mjc3ZGJhYTFiNGIyYThkM2NhOTIyMGI4ODI0Yzc=

data/MANIFEST.txt

@@ -4,4 +4,3 @@ VERSION
 README.md
 rakefile.rb
 lib/buildar.rb
-lib/buildar/tasks.rb

data/README.md

@@ -10,19 +10,18 @@ With a set of options to integrate with your current project.
 Rake tasks
 ----------
 Core
-* `release` - `message` `build` `tag` `publish`
-* `build` - `test` `bump_build` build a .gem file inside pkg/
-* `test` - runs your tests using rake/testtask
-* `message` - capture a message from ENV['message'] or prompt STDIN
-* `install` - `build` uninstall, install built .gem
-* `version` - show the current project version
-* `buildar` - config check
-
-With rubygems.org integration
-* `publish` - `verify publish credentials` gem push
-
-With git integration
-* `tag` - `test` git tag according to current version, pushed to origin
+*     `release` - `build` `publish` `tag`
+*       `build` - `pre_build` gem build a pkg/.gem
+* `gem_package` - `pre_build` Gem::PackageTask builds a pkg/.gem
+*     `install` - `built` install built .gem
+* `install_new` - `build` install built .gem
+*     `version` - show the current project version
+*     `buildar` - config check
+*     `message` - capture a message from ENV['message'] or prompt STDIN
+*   `pre_build` - invoke `test` and `bump_build` conditionally
+*       `built` - `build`
+*     `publish` - `built` gem push
+*         `tag` - `message` git tag according to current version, pushed to origin
 
 With version file integration
 * `bump_build` - increment the 4th version number (1.2.3.4 -> 1.2.3.5)
@@ -35,7 +34,7 @@ With version file integration
 
 Tasks which depend on optional functionality will not fail if the option is disabled.  They are effectively skipped.
 
-[Just show me the file](https://github.com/rickhull/buildar/blob/master/lib/buildar/tasks.rb)
+[Just show me the tasks](https://github.com/rickhull/buildar/blob/master/lib/buildar.rb#L73)
 
 Install
 -------

data/VERSION

@@ -1 +1 @@
-1.4.0.15
+2.0.0.4

data/lib/buildar.rb

@@ -1,40 +1,13 @@
-# Buildar is effectively a hand-rolled singleton.  Yes, a NIH miserable excuse
-# for a global.
-# Look, we want to be able to call Buildar.conf in the project rakefile, but
-# we need that data accessible here and inside lib/buildar/tasks.
-# So we need a "global".
-# But if we use a class-based singleton, it's namespaced.
-# And it can't be set to nil, for example.
-#
-class Buildar
+require 'rake'
+require 'rake/clean'
+require 'rake/tasklib'
+
+class Buildar < Rake::TaskLib
   def self.version
     file = File.expand_path('../../VERSION', __FILE__)
     File.read(file).chomp
   end
 
-  # Call this from the rakefile, like:
-  #   Buildar.conf(__FILE__) do |b|
-  #     b.name = 'foo'
-  #     # ...
-  #   end
-  #
-  def self.conf(rakefile = nil)
-    unless defined?(@@instance)
-      root = rakefile ? File.expand_path('..', rakefile) : nil
-      @@instance = Buildar.new root
-    end
-    yield @@instance if block_given?
-  end
-
-  # Confirming singleton.
-  # Only buildar/raketasks should need to call this
-  # Use conf inside project/Rakefile
-  #
-  def self.instance
-    raise "no instance; call Buildar.conf" unless defined?(@@instance)
-    @@instance
-  end
-
   # e.g. bump(:minor, '1.2.3') #=> '1.3.0'
   # only works for versions consisting of integers delimited by periods (dots)
   #
@@ -58,85 +31,189 @@ class Buildar
     }.join('.')
   end
 
-  attr_accessor :root, :name,
-                :use_git, :publish,
-                :use_gemspec_file, :gemspec_filename,
-                :use_version_file, :version_filename
-
-  attr_writer :gemspec_filename
+  attr_accessor :gemspec_file, :version_file, :use_git, :pkg_dir, :ns
 
-  def initialize(root = nil)
-    @root = root ? File.expand_path(root) : Dir.pwd
-    @name = File.split(@root).last
+  def initialize
+    @gemspec_file = nil
+    @version_file = nil
     @use_git = false
-    @publish = { rubygems: false }
-    @use_gemspec_file = true
-    @use_version_file = false
-    @version_filename = 'VERSION'
+    @pkg_dir = 'pkg'
+    @ns = ''
+
+    if block_given?
+      yield self
+      define
+    end
   end
 
   def gemspec
-    @use_gemspec_file ? self.hard_gemspec : self.soft_gemspec
+    if @gemspec_file
+      Gem::Specification.load @gemspec_file
+    else
+      @gemspec ||= Gem::Specification.new
+      @gemspec.version = self.read_version if @version_file
+      @gemspec
+    end
   end
 
-  def soft_gemspec
-    @soft_gemspec ||= Gem::Specification.new
-    @soft_gemspec.name = @name
-    @soft_gemspec.version = self.version if @use_version_file
-    @soft_gemspec
+  def read_version
+    raise "no @version_file" unless @version_file
+    File.read(@version_file).chomp
   end
 
-  # load every time; cache locally if you must
-  #
-  def hard_gemspec
-    Gem::Specification.load self.gemspec_file
+  def write_version(new_version)
+    raise "no @version_file" unless @version_file
+    File.open(@version_file, 'w') { |f| f.write(new_version) }
   end
 
-  def gemspec_file
-    File.join(@root, self.gemspec_filename)
+  def gem_file
+    File.join(@pkg_dir, "#{gemspec.name}-#{gemspec.version}.gem")
   end
 
-  # @name.gemspec is the default, but don't set this in the constructor
-  # it's common to set the name after intialization.  e.g. via Buildar.conf
-  # so set the default on first invocation.  After that, it's an accessor.
-  #
-  def gemspec_filename
-    @gemspec_filename ||= "#{@name}.gemspec"
-    @gemspec_filename
-  end
+  def define
+    directory @pkg_dir
+    CLOBBER.include @pkg_dir
 
-  def gemspec_location
-    @use_gemspec_file ? self.gemspec_filename : 'Rakefile'
-  end
+    if @ns and !@ns.empty?
+      namespace @ns do
+        define_tasks
+      end
+    else
+      define_tasks
+    end
 
-  def version
-    File.read(self.version_file).chomp
-  end
+    #
+    # tasks to be kept out of any optional namespace
+    #
+
+    desc "config check"
+    task :buildar do
+      spacer = " " * 14
+      gemspec = self.gemspec
+      puts
+      puts <<EOF
+     Project: #{gemspec.name} #{gemspec.version}
+Gemspec file: #{@gemspec_file}
+Version file: #{@version_file}
+     Use git: #{@use_git}
+ Package dir: #{@pkg_dir}
+       Files: #{gemspec.files.join("\n#{spacer}")}
+  Built gems: #{Dir[@pkg_dir +  '/*.gem'].join("\n#{spacer}")}
+# using Buildar #{Buildar.version}
+EOF
+      puts
+    end
 
-  def write_version new_version
-    File.open(self.version_file, 'w') { |f| f.write(new_version) }
+    if @version_file
+      # tasks :bump_major, :bump_minor, :bump_patch, :bump_build
+      # commit the version file if @use_git
+      #
+      [:major, :minor, :patch, :build].each { |v|
+        desc "increment the #{v} number in #{@version_file}"
+        namespace :bump do
+          task v do
+            old_version = self.read_version
+            new_version = self.class.bump(v, old_version)
+
+            puts "bumping #{old_version} to #{new_version}"
+            self.write_version new_version
+
+            if @use_git
+              msg = "Buildar version:bump_#{v} to #{new_version}"
+              sh "git commit #{@version_file} -m #{msg.inspect}"
+            end
+          end
+        end
+      }
+    end
   end
 
-  def version_file
-    File.join(@root, @version_filename)
-  end
+  def define_tasks
+    desc "invoke :test and :bump_build conditionally"
+    task :pre_build do
+      Rake::Task[:test].invoke if Rake::Task.task_defined? :test
+      Rake::Task['bump:build'].invoke if @version_file
+    end
 
-  def available_version
-    return self.version if @use_version_file
-    version = self.gemspec.version
-    raise "gemspec.version is missing" if !version or version.to_s.empty?
-    version
-  end
+    # can't make this a file task, because the version could be bumped
+    # as a dependency, changing the target file
+    #
+    desc "build a .gem in #{@pkg_dir}/ using `gem build`"
+    task :build => :pre_build do
+      if @gemspec_file
+        sh "gem build #{@gemspec_file}"
+        mv File.basename(self.gem_file), self.gem_file
+      else
+        Rake::Task[:gem_package].invoke
+      end
+    end
 
-  def version_location
-    @use_version_file ? self.version_filename : self.gemspec_filename
-  end
+    # roughly equivalent to `gem build self.gemspec`
+    # operates with a hard or soft gemspec
+    #
+    desc "build a .gem in #{@pkg_dir}/ using Gem::PackageTask"
+    task :gem_package => :pre_build do
+      # definine the task at runtime, rather than requiretime
+      # so that the gemspec will reflect any version bumping since requiretime
+      require 'rubygems/package_task'
+      Gem::PackageTask.new(self.gemspec).define
+      Rake::Task["package"].invoke
+    end
 
-  # where we expect a built gem to land
-  #
-  def gemfile
-    path = File.join(@root, 'pkg', "#{@name}-#{self.available_version}.gem")
-    raise "gemfile #{path} does not exist" unless File.exists?(path)
-    path
+    # desc "used internally; make sure we have .gem for the current version"
+    task :built do
+      Rake::Task[:build].invoke unless File.exists? self.gem_file
+    end
+
+    desc "publish the current version to rubygems.org"
+    task :publish => :built do
+      sh "gem push #{self.gem_file}"
+    end
+
+    desc "build, publish" << (@use_git ? ", tag " : '')
+    task :release => [:build, :publish] do
+      Rake::Task[:tag].invoke if @use_git
+    end
+
+    desc "install the current version"
+    task :install => :built do
+      sh "gem install #{self.gem_file}"
+    end
+
+    desc "build a new version and install"
+    task :install_new => [:build, :install]
+
+    #
+    # Optional tasks
+    #
+
+    if @version_file
+      [:major, :minor, :patch].each { |v|
+        namespace :release do
+          desc "increment the #{v} number and release"
+          task v => ["bump:#{v}", :release]
+        end
+      }
+    end
+
+    if @use_git
+      desc "annotated git tag with version and message"
+      task :tag => :message do
+        Rake::Task[:test].invoke if Rake::Task.defined? :test
+        tagname = "v#{self.gemspec.version}"
+        message = ENV['message'] || "auto-tagged #{tagname} by Buildar"
+        sh "git tag -a #{tagname.inspect} -m #{message.inspect}"
+        sh "git push origin --tags"
+      end
+
+      # right now only :tag depends on this, but maybe others in the future?
+      # desc "used internally; make sure ENV['message'] is populated"
+      task :message do
+        if !ENV['message'] or ENV['message'].empty?
+          print "This task requires a message:\n> "
+          ENV['message'] = $stdin.gets.chomp
+        end
+      end
+    end
   end
 end

data/rakefile.rb

@@ -1,14 +1,8 @@
-require 'buildar/tasks'
-require 'rake/testtask'
+require 'buildar'
 
-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
-
-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
+#  b.ns = 'gem'
 end

metadata

@@ -1,32 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: buildar
 version: !ruby/object:Gem::Version
-  version: 1.4.0.15
-  prerelease: 
+  version: 2.0.0.4
 platform: ruby
 authors:
 - Rick Hull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-07-11 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'
+  type: :runtime
+  prerelease: false
 description: Buildar helps automate the release process with versioning, building,
   packaging, and publishing.  Optional git integration.
 email: 
@@ -40,30 +37,28 @@ files:
 - README.md
 - rakefile.rb
 - lib/buildar.rb
-- lib/buildar/tasks.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.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Buildar crept inside your rakefile and scratched upon the tasking post
 test_files: []

data/lib/buildar/tasks.rb

@@ -1,141 +0,0 @@
-require 'buildar'
-
-# shortcut to Buildar's data from the project rakefile
-#
-def proj
-  Buildar.instance
-end
-
-# the reason you're here
-#
-task :release => [:message, :build, :tag, :publish]
-
-# these are handy
-#
-task :release_patch => [:bump_patch, :release]
-task :release_minor => [:bump_minor, :release]
-task :release_major => [:bump_major, :release]
-
-# make sure ENV['message'] is populated
-#
-task :message do
-  if !ENV['message'] or ENV['message'].empty?
-    print "This task requires a message:\n> "
-    ENV['message'] = $stdin.gets.chomp
-  end
-end
-
-# uses Gem::PackageTask to build via Gem API
-# roughly equivalent to `gem build foo.gemspec`
-# operates with a hard or soft gemspec
-#
-task :gem_package => [:test, :bump_build] do
-  # definine the task at runtime, rather than requiretime
-  # so that the gemspec will reflect any version bumping since requiretime
-  require 'rubygems/package_task'
-  Gem::PackageTask.new(proj.gemspec).define
-  Rake::Task["package"].invoke
-end
-
-# if proj.use_gemspec_file
-# exactly equiavlent to `gem build #{proj.gemspec_filename}`
-# otherwise fall back to :gem_package
-#
-task :build => [:test, :bump_build] do
-  if proj.use_gemspec_file
-    sh "gem build #{proj.gemspec_filename}"
-    target_file = "#{proj.name}-#{proj.available_version}.gem"
-    if File.exists? target_file
-      sh "mv #{target_file} pkg/#{target_file}"
-    else
-      puts "warning: expected #{target_file} but didn't find it"
-    end
-  else
-    Rake::Task[:gem_package].invoke
-  end
-end
-
-# build, install
-#
-task :install => [:build] do
-  sh "gem install #{proj.gemfile}"
-end
-
-# if proj.use_version_file
-# tasks :bump_major, :bump_minor, :bump_patch, :bump_build
-# commit the version file if proj.use_git
-#
-[:major, :minor, :patch, :build].each { |v|
-  task "bump_#{v}" do
-    if proj.use_version_file
-      old_version = proj.version
-      new_version = Buildar.bump(v, old_version)
-      puts "bumping #{old_version} to #{new_version}"
-      proj.write_version new_version
-      if proj.use_git
-        msg = "rake bump_#{v} to #{new_version}"
-        sh "git commit #{proj.version_file} -m '#{msg}'"
-      end
-    end
-  end
-}
-
-# if proj.use_git
-# create annotated git tag based on VERSION and ENV['message'] if available
-# push tags to origin
-#
-task :tag => [:test] do
-  if proj.use_git
-    tagname = "v#{proj.available_version}"
-    message = ENV['message'] || "auto-tagged #{tagname} by Rake"
-    sh %Q{git tag -a "#{tagname}" -m "#{message}"}
-    sh "git push origin --tags"
-  end
-end
-
-# if proj.publish[:rubygems]
-# roughly, gem push foo-VERSION.gem
-#
-task :publish => [:verify_publish_credentials] do
-  sh "gem push #{proj.gemfile}" if proj.publish[:rubygems]
-end
-
-# if proj.publish[:rubygems]
-# just make sure the ~/.gem/credentials file is readable
-#
-task :verify_publish_credentials do
-  if proj.publish[:rubygems]
-    creds = '~/.gem/credentials'
-    fp = File.expand_path(creds)
-    raise "#{creds} does not exist" unless File.exists?(fp)
-    raise "can't read #{creds}" unless File.readable?(fp)
-  end
-end
-
-# display project name and version
-#
-task :version do
-  puts "#{proj.name} #{proj.available_version}"
-end
-
-# if the user wants a bump, make it a patch; not used internally
-#
-task :bump => [:bump_patch]
-
-# config check
-#
-task :buildar do
-  puts
-  puts <<EOF
-          Project: #{proj.name} #{proj.version}
-             Root: #{proj.root}
- Use gemspec file: #{proj.use_gemspec_file}
-   Gemspec source: #{proj.gemspec_location}
- Use version file: #{proj.use_version_file}
-   Version source: #{proj.version_location}
-          Use git: #{proj.use_git}
-          Publish: #{proj.publish.keys}
-# using Buildar #{Buildar.version}
-EOF
-  puts
-end