ritual 0.0.5 → 0.1.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.1.0 2011-01-17
+
+ * Subtasks are now public, and namespaced under repo: and gem:.
+ * Add remove_task and replace_task, for customizing the subtasks.
+
 == 0.0.5 2010-08-25
 
  * Support more than 3 version components via version.increment(n).

data/lib/ritual.rb

@@ -1,8 +1,6 @@
 require 'date'
 require 'fileutils'
-
-desc "Build and install the gem."
-task :install => %w'ritual:build_gem ritual:install_gem'
+require 'ritual/lib'
 
 desc "Select a major version bump."
 task :major do
@@ -20,16 +18,13 @@ task :patch do
 end
 
 desc "Bump the selected version component and do the release ritual."
-task :release => %w'ritual:check_release_args ritual:bump ritual:tag ritual:push ritual:build_gem ritual:push_gem'
+task :release => %w'repo:bump repo:tag repo:push gem:build gem:push'
 
-# Private helper tasks.
-namespace :ritual do
-  task :check_release_args do
+namespace :repo do
+  desc "Bump and commit the version file and changelog."
+  task :bump do
     Ritual.component or
       raise "Please select a version component to bump, e.g.: rake patch release"
-  end
-
-  task :bump do
     version.increment(Ritual.component)
     changelog.set_latest_version(version)
     version.write
@@ -38,137 +33,44 @@ namespace :ritual do
     puts "Bumped to version #{version}."
   end
 
+  desc "Tag the release with the current version."
   task :tag do
     sh "git tag v#{version}"
   end
 
+  desc "Push updates upstream."
   task :push do
     sh "git push origin master"
   end
+end
 
-  task :build_gem do
+namespace :gem do
+  desc "Build the gem."
+  task :build do
     sh "gem build #{library_name}.gemspec"
   end
 
-  task :push_gem do
+  desc "Push the gem to the gem server."
+  task :push do
     sh "gem push #{library_name}-#{version}.gem"
   end
 
-  task :install_gem do
+  desc "Install the gem. May require running with sudo."
+  task :install => :build do
     sh "gem install #{library_name}-#{version}.gem"
   end
 end
 
-module Ritual
-  class << self
-    attr_accessor :component
-
-    def library_name
-      ENV['LIB'] || default_library_name
-    end
-
-    def default_library_name
-      gemspecs = Dir['*.gemspec']
-      names = gemspecs.map{|path| File.basename(path, '.gemspec')}
-      if names.size.zero?
-        abort "cannot find any gemspecs"
-      elsif names.size > 1
-        abort "choose a gemspec: LIB=#{names.join('|')}"
-      end
-      names.first
-    end
-  end
-
-  class Version
-    def initialize(library_name)
-      @library_name = library_name
-      @value ||= read
-    end
-
-    attr_reader :value, :library_name
-
-    def to_s
-      value.to_s
-    end
-
-    def read
-      File.exist?(path) or
-        write([0, 0, 0])
-      load path
-      self.module::VERSION
-    end
-
-    def write(value=self.value)
-      FileUtils.mkdir_p File.dirname(path)
-      open(path, 'w') do |file|
-        file.puts <<-EOS.gsub(/^ *\|/, '')
-          |module #{module_name}
-          |  VERSION = #{value.inspect}
-          |
-          |  class << VERSION
-          |    include Comparable
-          |
-          |    def to_s
-          |      join('.')
-          |    end
-          |  end
-          |end
-        EOS
-      end
-    end
-
-    def increment(component)
-      (value.size..component).each{|i| value[i] = 0}
-      value[component] += 1
-      (component+1 ... value.size).each{|i| value[i] = 0}
-    end
-
-    def path
-      "lib/#{library_name}/version.rb"
-    end
-
-    def module_name
-      library_name.gsub(/(?:\A|_)(.)/){$1.upcase}
-    end
-
-    def module
-      Object.const_defined?(module_name) or
-        Object.const_set(module_name, Module.new)
-      Object.const_get(module_name)
-    end
-  end
-
-  class Changelog
-    def path
-      'CHANGELOG'
-    end
-
-    def set_latest_version(version)
-      File.exist?(path) or
-        raise "Don't release without a CHANGELOG!"
-      text = File.read(path)
-      heading = "#{version} #{Date.today.strftime('%Y-%m-%d')}"
-      text.sub!(/^(== )LATEST$/i, "\\1#{heading}") or
-        raise "No LATEST entry in CHANGELOG - did you forget to update it?"
-      open(path, 'w'){|f| f.print text}
-    end
-  end
-end
-
-#
-# Global API
-#
-
 def library_name
   Ritual.library_name
 end
 
 def version
-  @version ||= Ritual::Version.new(library_name)
+  @version ||= Ritual.version_file
 end
 
 def changelog
-  @changelog ||= Ritual::Changelog.new
+  @changelog ||= Ritual.changelog
 end
 
 def spec_task(*args, &block)
@@ -187,3 +89,42 @@ def rdoc_task(*args, &block)
   require 'rake/rdoctask'
   Rake::RDocTask.new(*args, &block)
 end
+
+def remove_task(name)
+  Rake.application.instance_variable_get(:@tasks).delete(name) or
+    raise ArgumentError, "task not found: #{name}"
+end
+
+def replace_task(name, *args, &block)
+  remove_task name
+  task(name, *args, &block)
+end
+
+module Ritual
+  class << self
+    attr_accessor :component
+
+    def library_name
+      ENV['LIB'] || default_library_name
+    end
+
+    def default_library_name
+      gemspecs = Dir['*.gemspec']
+      names = gemspecs.map{|path| File.basename(path, '.gemspec')}
+      if names.size.zero?
+        abort "cannot find any gemspecs"
+      elsif names.size > 1
+        abort "choose a gemspec: LIB=#{names.join('|')}"
+      end
+      names.first
+    end
+
+    def version_file
+      @version ||= VersionFile.new("lib/#{library_name}/version.rb", library_name)
+    end
+
+    def changelog
+      @changelog ||= Changelog.new('CHANGELOG')
+    end
+  end
+end

data/lib/ritual/changelog.rb

@@ -0,0 +1,21 @@
+module Ritual
+  class Changelog
+    Error = Class.new(RuntimeError)
+
+    def initialize(path)
+      @path = path
+    end
+
+    attr_reader :path
+
+    def set_latest_version(version)
+      File.exist?(path) or
+        raise Error, "Don't release without a CHANGELOG!"
+      text = File.read(path)
+      heading = "#{version} #{Date.today.strftime('%Y-%m-%d')}"
+      text.sub!(/^(== )LATEST$/i, "\\1#{heading}") or
+        raise Error, "No LATEST entry in CHANGELOG - did you forget to update it?"
+      open(path, 'w'){|f| f.print text}
+    end
+  end
+end

data/lib/ritual/lib.rb

@@ -0,0 +1,5 @@
+module Ritual
+  autoload :Changelog, 'ritual/changelog'
+  autoload :VersionFile, 'ritual/version_file'
+  autoload :VERSION, 'ritual/version'
+end

data/lib/ritual/version.rb

@@ -1,5 +1,5 @@
 module Ritual
-  VERSION = [0, 0, 5]
+  VERSION = [0, 1, 0]
 
   class << VERSION
     include Comparable

data/lib/ritual/version_file.rb

@@ -0,0 +1,61 @@
+module Ritual
+  class VersionFile
+    def initialize(path, library_name)
+      @path = path
+      @library_name = library_name
+      @value ||= read
+    end
+
+    attr_reader :path, :library_name, :value
+
+    def to_s
+      value.join('.')
+    end
+
+    def write
+      FileUtils.mkdir_p File.dirname(path)
+      open(path, 'w') do |file|
+        file.puts <<-EOS.gsub(/^ *\|/, '')
+          |module #{module_name}
+          |  VERSION = #{value.inspect}
+          |
+          |  class << VERSION
+          |    include Comparable
+          |
+          |    def to_s
+          |      join('.')
+          |    end
+          |  end
+          |end
+        EOS
+      end
+    end
+
+    def increment(component)
+      (value.size..component).each{|i| value[i] = 0}
+      value[component] += 1
+      (component+1 ... value.size).each{|i| value[i] = 0}
+    end
+
+    private
+
+    def read
+      if File.exist?(path)
+        File.read(path) =~ /^\s*VERSION\s*=\s*(\[.*?\])/ and
+          eval $1
+      else
+        [0, 0, 0]
+      end
+    end
+
+    def module
+      Object.const_defined?(module_name) or
+        Object.const_set(module_name, Module.new)
+      Object.const_get(module_name)
+    end
+
+    def module_name
+      library_name.gsub(/(?:\A|_)(.)/){$1.upcase}
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ritual
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 5
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - George Ogata
@@ -14,10 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 -04:00
+date: 2011-01-17 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: |
   Adds tasks and helpers to your Rakefile to manage releases in a
   lightweight manner.
@@ -31,7 +45,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/ritual/changelog.rb
+- lib/ritual/lib.rb
 - lib/ritual/version.rb
+- lib/ritual/version_file.rb
 - lib/ritual.rb
 - LICENSE
 - README.markdown
@@ -47,16 +64,20 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3
@@ -65,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rakefile release tasks and helpers.