buildar 0.3.2.2 → 1.0.0.1

data/MANIFEST.txt

@@ -1,3 +1,5 @@
 MANIFEST.txt
 VERSION
 rakefile.rb
+lib/buildar.rb
+lib/buildar/tasks.rb

data/VERSION

@@ -1 +1 @@
-0.3.2.2
+1.0.0.1

data/lib/buildar.rb

@@ -0,0 +1,114 @@
+# 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/raketasks.
+# 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
+  # Call this from the rakefile, like:
+  # Buildar.conf(__FILE__) do |b|
+  #   b.name = 'foo'
+  #   # ...
+  # end
+  #
+  def self.conf(rakefile = nil)
+    unless defined?(@@instance)
+      args = rakefile ? [File.dirname(rakefile)] : []
+      @@instance = Buildar.new(*args)
+    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)
+  #
+  def self.bump(position, version)
+    pos = [:major, :minor, :patch, :build].index(position) || position
+    places = version.split('.')
+    if pos >= places.length and pos <= places.length + 2
+      # add zeroes to places up to pos
+      # allows bump(:build, '0') #=> '0.0.0.1'
+      places.length.upto(pos) { |i| places[i] = 0 }
+    end
+    raise "bad position: #{pos} (for version #{version})" unless places[pos]
+    places.map.with_index { |place, i|
+      if i < pos
+        place
+      elsif i == pos
+        place.to_i + 1
+      else
+        0
+      end
+    }.join('.')
+  end
+
+  attr_accessor :root, :version_filename, :manifest_filename,
+                :use_git, :publish, :use_manifest_file
+  attr_reader :name
+
+  def initialize(root = nil, name = nil)
+    @root = root ? File.expand_path(root) : Dir.pwd
+    @name = name || File.split(@root).last
+    @version_filename = 'VERSION'
+    @use_manifest_file = true
+    @manifest_filename = 'MANIFEST.txt'
+    @use_git = true
+    @publish = { rubygems: true }
+  end
+
+  # previously, we did this in initialize
+  # now, give conf a chance to fix things up before calling self.version etc.
+  #
+  def gemspec
+    @gemspec ||= Gem::Specification.new do |s|
+      # Static assignments
+      s.summary     = "FIX"
+      s.description = "FIX"
+      s.authors     = ["FIX"]
+      s.email       = "FIX@FIX.COM"
+      s.homepage    = "http://FIX.COM/"
+      s.licenses    = ['FIX']
+      # s.has_rdoc    = true
+      # s.test_files  = ['FIX']
+
+      s.add_development_dependency "minitest", [">= 0"]
+      s.add_development_dependency     "rake", [">= 0"]
+      s.add_development_dependency  "buildar", ["> 0.4"]
+    end
+    # Make sure things tracked elsewhere stay updated
+    @gemspec.name = @name
+    @gemspec.files = self.manifest if @use_manifest_file
+    @gemspec.version = self.version
+    @gemspec
+  end
+
+  def version_file
+    File.join(@root, @version_filename)
+  end
+
+  def version
+    File.read(self.version_file).chomp
+  end
+
+  def write_version new_version
+    File.open(self.version_file, 'w') { |f| f.write(new_version) }
+  end
+
+  def manifest_file
+    File.join(@root, @manifest_filename)
+  end
+
+  def manifest
+    File.readlines(self.manifest_file).map { |line| line.chomp }
+  end
+end

data/lib/buildar/tasks.rb

@@ -0,0 +1,114 @@
+require 'buildar'
+require 'rubygems/package_task'
+
+# 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
+  unless ENV['message']
+    print "Enter a one-line message:\n> "
+    ENV['message'] = $stdin.gets.chomp
+  end
+end
+
+# roughly equivalent to `gem build foo.gemspec`
+# places .gem file in pkg/
+#
+task :build => [:test, :bump_build] do
+  # definine the task at runtime, rather than requiretime
+  # so that the gemspec will reflect any version bumping since requiretime
+  Gem::PackageTask.new(proj.gemspec).define
+  Rake::Task["package"].invoke
+end
+
+# 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
+    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
+}
+
+# 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.version}"
+    message = ENV['message'] || "auto-tagged #{tagname} by Rake"
+    sh "git tag -a '#{tagname}' -m '#{message}'"
+    sh "git push origin --tags"
+  end
+end
+
+# roughly, gem push foo-VERSION.gem
+#
+task :publish => [:verify_publish_credentials] do
+  if proj.publish[:rubygems]
+    fragment = "-#{proj.version}.gem"
+    pkg_dir = File.join(proj.root, 'pkg')
+    Dir.chdir(pkg_dir) {
+      candidates = Dir.glob "*#{fragment}"
+      # sanity check
+      case candidates.length
+      when 0
+        raise "could not find .gem matching #{fragment}"
+      when 1
+        sh "gem push #{candidates.first}"
+      else
+        raise "multiple candidates found matching #{fragment}"
+      end
+    }
+  end
+end
+
+# 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.version}"
+end
+
+# display Buildar's understanding of the manifest file
+#
+task :manifest do
+  puts proj.manifest.join("\n") if proj.use_manifest_file
+end
+
+# if the user wants a bump, make it a patch
+#
+task :bump => [:bump_patch]

data/rakefile.rb

@@ -1,204 +1,20 @@
-require 'rubygems/package_task'
+require 'buildar/tasks'
 require 'rake/testtask'
 
-module Buildar
-  ##############################################
-  # Project-specific settings.  Edit as needed.
-  #
-  #
-  PROJECT_ROOT = File.dirname(__FILE__)
-  PROJECT_NAME = File.split(PROJECT_ROOT).last
-  VERSION_FILE = File.join(PROJECT_ROOT, 'VERSION')
-  MANIFEST_FILE = File.join(PROJECT_ROOT, 'MANIFEST.txt')
-
-  USE_GIT = true
-  GIT_COMMIT_VERSION = true   # commit version bump automatically
-  PUBLISH = {
-    rubygems: true,  # publish .gem to http://rubygems.org/
-  }
-
-  def self.gemspec
-    Gem::Specification.new do |s|
-      # Static assignments
-      s.name        = PROJECT_NAME
-      s.summary     = "FIX"
-      s.description = "FIX"
-      s.authors     = ["FIX"]
-      s.email       = "FIX@FIX.COM"
-      s.homepage    = "http://FIX.COM/"
-      s.licenses    = ['FIX']
-      s.has_rdoc    = true
-      # s.test_files  = ['FIX']
-
-      # Dynamic assignments
-      s.files       = manifest
-      s.version     = version
-      # s.date        = Time.now.strftime("%Y-%m-%d")
-
-      # s.add_runtime_dependency  "rest-client", ["~> 1"]
-      # s.add_runtime_dependency         "json", ["~> 1"]
-      s.add_development_dependency "minitest", [">= 0"]
-      s.add_development_dependency     "rake", [">= 0"]
-    end
-  end
-  #
-  #
-  # End project-specific settings.
-  ################################
-
-  def self.version
-    File.read(VERSION_FILE).chomp
-  end
-
-  def self.manifest
-    File.readlines(MANIFEST_FILE).map { |line| line.chomp }
-  end
-
-  def self.write_version new_version
-    File.open(VERSION_FILE, 'w') { |f| f.write(new_version) }
-  end
-
-  # e.g. bump(:minor, '1.2.3') #=> '1.3.0'
-  # only works for versions consisting of integers delimited by periods (dots)
-  #
-  def self.bump(position, version)
-    pos = [:major, :minor, :patch, :build].index(position) || position
-    places = version.split('.')
-    if pos >= places.length and pos <= places.length + 2
-      # add zeroes to places up to pos
-      # allows bump(:build, '0') #=> '0.0.0.1'
-      places.length.upto(pos) { |i| places[i] = 0 }
-    end
-    raise "bad position: #{pos} (for version #{version})" unless places[pos]
-    places.map.with_index { |place, i|
-      if i < pos
-        place
-      elsif i == pos
-        place.to_i + 1
-      else
-        0
-      end
-    }.join('.')
-  end
+Buildar.conf(__FILE__) do |b|
+  b.version_filename = 'VERSION'
+  b.manifest_filename = 'MANIFEST.txt'
+  b.use_git = true
+  b.publish[:rubygems] = true
+  b.gemspec.name = 'buildar'
+  b.gemspec.summary = 'Buildar crept inside your rakefile and scratched some tasks'
+  b.gemspec.description = 'Buildar helps automate the release process with versioning, building, packaging, and publishing.  Optional git integration'
+  b.gemspec.author = 'Rick Hull'
+  b.gemspec.homepage = 'https://github.com/rickhull/buildar'
+  b.gemspec.license = 'MIT'
+  b.gemspec.has_rdoc = true
 end
 
-
-#######
-# Tasks
-#
-#
-
-# i.e. task :test, runs your test files
-#
 Rake::TestTask.new :test do |t|
-  t.pattern = 'test/*.rb' # FIX for your layout
-end
-
-# display project name and version
-#
-task :version do
-  puts "#{Buildar::PROJECT_NAME} #{Buildar.version}"
-end
-
-# make sure ENV['message'] is populated
-#
-task :message do
-  unless ENV['message']
-    print "Enter a one-line message:\n> "
-    ENV['message'] = $stdin.gets.chomp
-  end
-end
-
-# if USE_GIT:
-# create annotated git tag based on VERSION and ENV['message'] if available
-# push tags to origin
-#
-task :tag => [:test] do
-  if Buildar::USE_GIT
-    message = ENV['message'] || "auto-tagged #{tagname} by Rake"
-    sh "git tag -a 'v#{Buildar.version}' -m '#{message}'"
-    sh "git push origin --tags"
-  end
+  t.pattern = 'test/*.rb'
 end
-
-# display Buildar's understanding of the MANIFEST.txt file
-#
-task :manifest do
-  puts Buildar.manifest.join("\n")
-end
-
-# roughly equivalent to `gem build foo.gemspec`
-# places .gem file in pkg/
-#
-task :build => [:test, :bump_build] do
-  # definine the task at runtime, rather than requiretime
-  # so that the gemspec will reflect any version bumping since requiretime
-  #
-  Gem::PackageTask.new(Buildar.gemspec).define
-  Rake::Task["package"].invoke
-end
-
-# e.g. task :bump_build, with VERSION 1.2.3.4, updates VERSION to 1.2.3.5
-# if USE_GIT and GIT_COMMIT_VERSION: add VERSION and commit
-#
-[:major, :minor, :patch, :build].each { |v|
-  task "bump_#{v}" do
-    old_version = Buildar.version
-    new_version = Buildar.bump(v, old_version)
-    puts "bumping #{old_version} to #{new_version}"
-    Buildar.write_version new_version
-    if Buildar::USE_GIT and Buildar::GIT_COMMIT_VERSION
-      msg = "rake bump_#{v} to #{new_version}"
-      sh "git commit #{Buildar::VERSION_FILE} -m '#{msg}'"
-    end
-  end
-}
-
-# not used internally, but if the user wants a bump, make it a patch
-#
-task :bump => [:bump_patch]
-
-# just make sure the ~/.gem/credentials file is readable
-#
-task :verify_publish_credentials do
-  if Buildar::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
-
-
-# roughly, gem push foo-VERSION.gem
-#
-task :publish => [:verify_publish_credentials] do
-  if Buildar::PUBLISH[:rubygems]
-    fragment = "-#{Buildar.version}.gem"
-    pkg_dir = File.join(Buildar::PROJECT_ROOT, 'pkg')
-    Dir.chdir(pkg_dir) {
-      candidates = Dir.glob "*#{fragment}"
-      case candidates.length
-      when 0
-        raise "could not find .gem matching #{fragment}"
-      when 1
-        sh "gem push #{candidates.first}"
-      else
-        raise "multiple candidates found matching #{fragment}"
-      end
-    }
-  end
-end
-
-# if USE_GIT: git push origin
-#
-task :gitpush do
-  # may prompt
-  sh "git push origin" if Buildar::USE_GIT
-end
-
-task :release => [:message, :build, :tag, :publish, :gitpush]
-
-task :release_patch => [:bump_patch, :release]
-task :release_minor => [:bump_minor, :release]
-task :release_major => [:bump_major, :release]

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: buildar
 version: !ruby/object:Gem::Version
-  version: 0.3.2.2
+  version: 1.0.0.1
   prerelease: 
 platform: ruby
 authors:
-- FIX
+- Rick Hull
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -43,7 +43,24 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: FIX
+- !ruby/object:Gem::Dependency
+  name: buildar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Buildar helps automate the release process with versioning, building,
+  packaging, and publishing.  Optional git integration
 email: FIX@FIX.COM
 executables: []
 extensions: []
@@ -52,9 +69,11 @@ files:
 - MANIFEST.txt
 - VERSION
 - rakefile.rb
-homepage: http://FIX.COM/
+- lib/buildar.rb
+- lib/buildar/tasks.rb
+homepage: https://github.com/rickhull/buildar
 licenses:
-- FIX
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -76,5 +95,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: FIX
+summary: Buildar crept inside your rakefile and scratched some tasks
 test_files: []