corundum 0.0.13 → 0.0.15

data/README.md

@@ -1,10 +1,12 @@
 ## Corundum
 ### Foolproof rubygems
 
-The goal of Corundum is to be able to run 'rake release' and know that
-you're publishing something you won't be embarrassed by.  Any packaging is a
-tricky problem with lots of details.  Fortunately, those details can mostly
-be automated.
+With Corudum added as a developement dependancy to your gemspec, and configured
+(quickly) in your Rakefile you can do:
+
+    rake release
+
+and know that you're publishing something you won't be embarrassed by.
 
 ### (Yet Another Rubygems packager)
 
@@ -13,8 +15,26 @@ to generate code - it doesn't exist to build gems for you if you don't know
 how.  For that, check out Jeweler, and come back once you've understood what a
 .gemspec is and how it works.
 
+Really, writing a gem is pretty easy - you can do it in a gist if you want.  And releasing Gems isn't all that hard either - rubygems has good tools to package up gems and push them to gem servers.  So why Corundum?
+
+Because releasing a gem that will actually help the Ruby community at large is
+actually quite difficult.  There are lot of fiddly details to get wrong, and
+even experienced devs can be doofuses sometimes.  Corundum serves as a
+collection of safeguards against common errors in releasing gems - certainly
+every one that's happened to me.
+
 ### Using Corundum
 
+In your coolgem.gemspec:
+
+    spec.add_development_dependency "corundum"
+
+In you Gemfile:
+
+    gemspec
+
+(But you were doing that anyway, right?)
+
 Check out this Rakefile:
 
     require 'corundum/tasklibs'
@@ -43,8 +63,8 @@ Check out this Rakefile:
       end
     end
 
-That's the whole thing.  'rake release' will push the current version of the
-gem, but only if we can go through a complete a correct QA process.
+That's the whole thing.  Now 'rake release' will push the current version of
+the gem, but only if we can go through a complete a correct QA process.
 (Incidentally, that's the Rakefile for Corundum itself.)
 
 The other goal with Corundum is to present all of these tools as
@@ -54,3 +74,5 @@ to do
     task :default => :release
 
 Then 'rake' will do your releases.
+
+Digging in, the first thing to look at is {Corundum::Toolkit}

data/lib/corundum.rb

@@ -1,117 +1,6 @@
-require 'corundum/tasklib'
-require 'corundum/configuration_store'
-
-#require 'rubygems'
-#require 'rubygems/installer'
+require 'corundum/configuration-store'
+require 'corundum/core'
+require 'mattock/tasklib'
 
 module Corundum
-  extend Rake::DSL
-
-  class Toolkit < TaskLib
-    settings(
-      :gemspec => nil,
-      :gemspec_path => nil,
-      :corundum_dir => "corundum",
-      :finished_dir => nil,
-      :package_dir => "pkg",
-      :doc_dir => "rubydoc",
-      :browser => Corundum.user_preferences["browser"],
-      :finished_files => nested.nil_fields(:build, :qa, :package, :release, :press),
-      :files => nested.nil_fields(:code, :test, :docs),
-      :rubyforge => nested.nil_fields(:group_id, :package_id, :release_name, :home_page, :project_page),
-      :email => nested(
-        :servers => [ nested({ :server => "ruby-lang.org", :helo => "gmail.com" }) ],
-        :announce_to_email => "ruby-talk@ruby-lang.org"
-    ),
-      :file_lists => nested(:code => FileList['lib/**/*.rb'],
-                            :test => FileList['test/**/*.rb','spec/**/*.rb','features/**/*.rb'],
-                            :docs => FileList['doc/**/*.rb'],
-                            :project => FileList['Rakefile'],
-                            :all => nil)
-    )
-
-    def load_gemspec
-      @gemspec_path ||= guess_gemspec
-      @gemspec ||= Gem::Specification::load(gemspec_path)
-      return gemspec
-    end
-
-    def resolve_configuration
-      load_gemspec
-
-      self.finished_dir ||= File::join(corundum_dir, "finished")
-      @finished_files.build ||= File::join( package_dir, "#{gemspec.full_name}.gem")
-
-      @finished_files.qa ||= File::join( finished_dir, "qa_#{gemspec.version}")
-      @finished_files.release ||= File::join( finished_dir, "release_#{gemspec.version}")
-      @finished_files.press ||= File::join( finished_dir, "press_#{gemspec.version}")
-
-      @files.code ||= gemspec.files.grep(%r{^lib/})
-      @files.test ||= gemspec.files.grep(%r{^spec/})
-      @files.docs ||= gemspec.files.grep(%r{^doc/})
-
-      @file_lists.project << gemspec_path
-      @file_lists.all  ||=
-        file_lists.code +
-        file_lists.test +
-        file_lists.docs
-
-      @rubyforge.group_id ||= gemspec.rubyforge_project
-      @rubyforge.package_id ||= gemspec.name.downcase
-      @rubyforge.release_name ||= gemspec.full_name
-      @rubyforge.home_page ||= gemspec.homepage
-      @rubyforge.project_page ||= "http://rubyforge.org/project/#{gemspec.rubyforge_project}/"
-    end
-
-    def guess_gemspec
-      speclist = Dir[File.expand_path("*.gemspec", Rake::original_dir)]
-      if speclist.length == 0
-        puts "Found no *.gemspec files"
-        exit 1
-      elsif speclist.length > 1
-        puts "Found too many *.gemspec files: #{speclist.inspect}"
-        exit 1
-      end
-      speclist[0]
-    end
-
-    def define
-      in_namespace do
-        directory finished_dir
-
-        desc "Run preflight checks"
-        task :preflight
-
-        desc "Run quality assurance tasks"
-        task :qa => [:preflight, finished_files.qa]
-        file finished_files.qa =>
-        [finished_dir] + file_lists.project + file_lists.code + file_lists.test do |task|
-          Rake::Task[:qa].invoke #because I don't want this to be needed if it's not
-          touch task.name
-        end
-
-        desc "Build the package"
-        task :build => [finished_files.qa, :preflight, finished_files.build]
-        file finished_files.build =>
-        [finished_dir] + file_lists.code + file_lists.project do |task|
-          Rake::Task[:build].invoke
-          touch task.name
-        end
-
-        desc "Push package out to the world"
-        task :release => [finished_files.build, :preflight, finished_files.release]
-        file finished_files.release => [finished_dir] do |task|
-          Rake::Task[:release].invoke
-          touch task.name
-        end
-
-        desc "Announce publication"
-        task :press => [finished_files.release, finished_files.press]
-        file finished_files.press => [finished_dir] do |task|
-          Rake::Task[:press].invoke
-          touch task.name
-        end
-      end
-    end
-  end
 end

data/lib/corundum/configuration-store.rb

@@ -0,0 +1,16 @@
+require 'mattock/configuration-store'
+module Corundum
+  def self.configuration_store
+    @configuration_store ||=
+      Mattock::ConfigurationStore.new("corundum",
+                                      File::expand_path("../default_configuration", __FILE__))
+  end
+
+  def self.register_project(rakefile)
+    configuration_store.register_search_path(rakefile)
+  end
+
+  def self.user_preferences
+    configuration_store.user_preferences
+  end
+end

data/lib/corundum/core.rb

@@ -0,0 +1,128 @@
+require 'corundum'
+require 'mattock/tasklib'
+
+module Corundum
+  #This is the core tasklib for Corundum.  It defines a series of lifecycle
+  #steps that define the release process.  The real work is done by other
+  #Tasklibs that hook into the lifecycle.
+  #
+  #The lifecycle steps (as implied by the Rakefile definition) are:
+  #
+  #[ preflight ] simple tests before we do anything at all
+  #[ qa ]
+  #    quality assurance - make sure everything is acceptable
+  #    before we build the gem
+  # [build] construct the actual gem
+  # [release] push the gem out to the world
+  # [press] send out notifications that the gem has been published
+  class Core < Mattock::TaskLib
+    settings(
+      :gemspec => nil,
+      :gemspec_path => nil,
+      :corundum_dir => "corundum",
+      :finished_dir => nil,
+      :package_dir => "pkg",
+      :doc_dir => "rubydoc",
+      :browser => Corundum.user_preferences["browser"],
+      :finished_files => nested.nil_fields(:build, :qa, :package, :release, :press),
+      :files => nested.nil_fields(:code, :test, :docs),
+      :rubyforge => nested.nil_fields(:group_id, :package_id, :release_name, :home_page, :project_page),
+      :email => nested(
+        :servers => [ nested({ :server => "ruby-lang.org", :helo => "gmail.com" }) ],
+        :announce_to_email => "ruby-talk@ruby-lang.org"
+    ),
+      :file_lists => nested(:code => FileList['lib/**/*.rb'],
+                            :test => FileList['test/**/*.rb','spec/**/*.rb','features/**/*.rb'],
+                            :docs => FileList['doc/**/*.rb'],
+                            :project => FileList['Rakefile'],
+                            :all => nil)
+    )
+
+    def load_gemspec
+      @gemspec_path ||= guess_gemspec
+      @gemspec ||= Gem::Specification::load(gemspec_path)
+      return gemspec
+    end
+
+    def resolve_configuration
+      load_gemspec
+
+      self.finished_dir ||= File::join(corundum_dir, "finished")
+      @finished_files.build ||= File::join( package_dir, "#{gemspec.full_name}.gem")
+
+      @finished_files.qa ||= File::join( finished_dir, "qa_#{gemspec.version}")
+      @finished_files.release ||= File::join( finished_dir, "release_#{gemspec.version}")
+      @finished_files.press ||= File::join( finished_dir, "press_#{gemspec.version}")
+
+      @files.code ||= gemspec.files.grep(%r{^lib/})
+      @files.test ||= gemspec.files.grep(%r{^spec/})
+      @files.docs ||= gemspec.files.grep(%r{^doc/})
+
+      @file_lists.project << gemspec_path
+      @file_lists.all  ||=
+        file_lists.code +
+        file_lists.test +
+        file_lists.docs
+
+      @rubyforge.group_id ||= gemspec.rubyforge_project
+      @rubyforge.package_id ||= gemspec.name.downcase
+      @rubyforge.release_name ||= gemspec.full_name
+      @rubyforge.home_page ||= gemspec.homepage
+      @rubyforge.project_page ||= "http://rubyforge.org/project/#{gemspec.rubyforge_project}/"
+    end
+
+    def guess_gemspec
+      speclist = Dir[File.expand_path("*.gemspec", Rake::original_dir)]
+      if speclist.length == 0
+        puts "Found no *.gemspec files"
+        exit 1
+      elsif speclist.length > 1
+        puts "Found too many *.gemspec files: #{speclist.inspect}"
+        exit 1
+      end
+      speclist[0]
+    end
+
+    def define
+      in_namespace do
+        directory finished_dir
+
+        desc "Run preflight checks"
+        task :preflight
+
+        desc "Run quality assurance tasks"
+        task :qa => [:preflight, finished_files.qa]
+        file finished_files.qa =>
+        [finished_dir] + file_lists.project + file_lists.code + file_lists.test do |task|
+          Rake::Task[:qa].invoke #because I don't want this to be needed if it's not
+          touch task.name
+        end
+
+        desc "Build the package"
+        task :build => [finished_files.qa, :preflight, finished_files.build]
+        file finished_files.build =>
+        [finished_dir] + file_lists.code + file_lists.project do |task|
+          Rake::Task[:build].invoke
+          touch task.name
+        end
+
+        desc "Push package out to the world"
+        task :release => [finished_files.build, :preflight, finished_files.release]
+        file finished_files.release => [finished_dir] do |task|
+          Rake::Task[:release].invoke
+          touch task.name
+        end
+
+        desc "Announce publication"
+        task :press => [finished_files.release, finished_files.press]
+        file finished_files.press => [finished_dir] do |task|
+          Rake::Task[:press].invoke
+          touch task.name
+        end
+      end
+    end
+  end
+
+  #deprecated name for Core
+  Toolkit = Core
+end

data/lib/corundum/documentation-task.rb

@@ -1,7 +1,7 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 
 module Corundum
-  class DocumentationTask < TaskLib
+  class DocumentationTask < Mattock::TaskLib
     setting :title
     setting :browser
     setting :gemspec

data/lib/corundum/documentation/yardoc.rb

@@ -14,6 +14,14 @@ module Corundum
              :files =>  nested(:code => [], :docs => []),
              :extra_files =>  [] )
 
+    settings(:server_options => [],
+             :server => nested(
+               :port => 8888,
+               :docroot => "/tmp/yard",
+               :plugins => [])
+            )
+
+
     def document_inputs
       FileList["README*"] + files.code + files.docs + extra_files
     end
@@ -34,6 +42,14 @@ module Corundum
       end
       super
       self.options += [ "--output-dir", target_dir]
+
+
+      self.server_options += ["--reload"]
+      self.server_options += ["--port", server.port.to_s]
+      self.server_options += ["--docroot", server.docroot]
+      self.server.plugins.each do |plugin|
+        self.server_options += ["--plugin", plugin]
+      end
     end
 
     def define
@@ -41,6 +57,11 @@ module Corundum
         file entry_point => document_inputs do
           YARD::CLI::Yardoc.run( *(options) )
         end
+
+        desc "Start a live YARD server for editing inline docs"
+        task :live do
+          YARD::CLI::Server.run( *(server_options) )
+        end
       end
 
       super

data/lib/corundum/email.rb

@@ -1,7 +1,7 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 
 module Corundum
-  class Email < TaskLib
+  class Email < Mattock::TaskLib
     default_namespace :email
 
     setting(:rubyforge)

data/lib/corundum/gem_building.rb

@@ -1,7 +1,7 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 
 module Corundum
-  class GemBuilding < TaskLib
+  class GemBuilding < Mattock::TaskLib
     setting(:gemspec)
     setting(:qa_finished_file)
     setting(:package_dir, "pkg")

data/lib/corundum/gemcutter.rb

@@ -1,7 +1,7 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 
 module Corundum
-  class GemCutter < TaskLib
+  class GemCutter < Mattock::TaskLib
     default_namespace :gemcutter
 
     setting(:gem_path, nil)

data/lib/corundum/gemspec_sanity.rb

@@ -1,7 +1,7 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 
 module Corundum
-  class GemspecSanity < TaskLib
+  class GemspecSanity < Mattock::TaskLib
     default_namespace :gemspec_sanity
 
     setting(:gemspec)

data/lib/corundum/github-pages.rb

@@ -1,4 +1,4 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 require 'mattock/task'
 
 module Corundum
@@ -37,7 +37,7 @@ module Corundum
     end
   end
 
-  class GithubPages < TaskLib
+  class GithubPages < Mattock::TaskLib
     default_namespace :publish_docs
 
     setting(:target_dir, "gh-pages")
@@ -102,7 +102,10 @@ module Corundum
             chain.add Mattock::CommandLine.new("grep", "-q", "'#{branch}'")
           end
           t.command = Mattock::PrereqChain.new do |chain|
-            chain.add git_command("checkout", "-t", branch)
+            chain.add git_command("checkout", "-b", branch)
+            chain.add git_command("branch", "--set-upstream", branch, "origin/" + branch)
+            chain.add Mattock::CommandLine.new("rm", "-f", '.git/index')
+            chain.add git_command("clean", "-fdx")
           end
         end
 
@@ -118,19 +121,22 @@ module Corundum
 
         task :pull => [repo_dir, :on_branch] do
           FileUtils.cd target_dir do
-            git("pull")
+            git("pull", "-X", "ours")
           end
         end
 
         task :cleanup_repo => repo_dir do
           Mattock::CommandLine.new("rm", "-f", File::join(repo_dir, "hooks", "*")).must_succeed!
+          File::open(File::join(repo_dir, ".gitignore"), "w") do |file|
+            file.write ".sw?"
+          end
         end
 
         file target_dir => [:on_branch, :cleanup_repo]
 
-        task :pre_publish => [repo_dir, target_dir, :pull]
+        task :pre_publish => [repo_dir, target_dir]
 
-        task :clobber_target => :on_branch do
+        task :clobber_target => [:on_branch, :pull] do
           Mattock::CommandLine.new(*%w{rm -rf}) do |cmd|
             cmd.options << target_dir + "/*"
           end.must_succeed!

data/lib/corundum/questionable-content.rb

@@ -0,0 +1,58 @@
+require 'mattock/tasklib'
+
+module Corundum
+  class QuestionableContent < Mattock::Tasklib
+    default_namespace :content
+    setting :type, :debugging
+    settings :words => ["p", "debugger"], :limit => 0 #ok
+    setting :comments, false
+    setting :accept_token, /#ok/
+    setting :files
+
+    def default_configuration(core)
+      self.files = core.file_lists.code
+    end
+
+    def define
+      in_namespace do
+        task type do
+          word_regexp = %r{#{words.map{|word| "\\b#{word}\\b"}.join("|")}}
+          line_regexp = comments ? %r{\A\s*#.*#{word_regexp}} : word_regexp
+          unless accept_token.nil?
+            line_regexp = /#{line_regexp}(?:.(?!#{accept_token}))*\s*\Z/
+
+          end
+
+          found_words = Hash.new do |h,k|
+            h[k] = 0
+          end
+
+          files_with_words = Hash.new do |h,k|
+            h[k] = {}
+          end
+
+
+          files.each do |filename|
+            File::open(filename) do |file|
+              file.grep(line_regexp) do |line|
+                line.scan(word_regexp) do |word|
+                  files_with_words[filename][word] = true
+                  found_words[word] += 1
+                end
+              end
+            end
+          end
+
+          total = found_words.values.inject{|acc, num| acc + num} || 0
+
+          if total > limit
+            require 'pp'
+            report = PP::pp([files_with_words, found_words], "")
+            fail "Exceeded limits on words: #{words.join(",")}.  Full report:\n#{report}"
+          end
+        end
+      end
+      task :qa => in_namespace(type)
+    end
+  end
+end

data/lib/corundum/rubyforge.rb

@@ -1,10 +1,10 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 
 #Big XXX: this totally isn't done.  It's some notes against ever wanting to
 #publish announcements to rubyforge ever again
 
 module Corundum
-  class Publishing < TaskLib
+  class Publishing < Mattock::TaskLib
     default_namespace :rubyforge
 
     setting(:rubyforge,  nested(:package_id => nil, :group_id => nil, :release_name => nil))

data/lib/corundum/tasklibs.rb

@@ -9,3 +9,4 @@ require 'corundum/version_control/monotone'
 require 'corundum/version_control/git'
 require 'corundum/documentation'
 require 'corundum/github-pages'
+require 'corundum/questionable-content'

data/lib/corundum/version_control.rb

@@ -1,7 +1,7 @@
-require 'corundum/tasklib'
+require 'mattock/tasklib'
 
 module Corundum
-  class VersionControl < TaskLib
+  class VersionControl < Mattock::TaskLib
     default_namespace :version_control
 
     required_fields(:gemspec, :build_finished_file, :gemspec_files, :tag)

metadata

@@ -2,7 +2,7 @@
 name: corundum
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors: 
 - Judson Lester
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-06 00:00:00 Z
+date: 2012-03-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: corundum
@@ -92,6 +92,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 4
         version: 0.5.4
   type: :runtime
   prerelease: false
@@ -105,9 +109,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
+        - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: *id008
@@ -129,7 +133,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.2
+        version: 0.2.10
   type: :runtime
   prerelease: false
   version_requirements: *id010
@@ -193,6 +197,9 @@ extra_rdoc_files:
 - doc/coverage/assets/0.5.3/loading.gif
 - doc/coverage/assets/0.5.3/jquery-1.6.2.min.js
 files: 
+- lib/corundum.rb
+- lib/corundum/configuration-store.rb
+- lib/corundum/core.rb
 - lib/corundum/browser-task.rb
 - lib/corundum/github-pages.rb
 - lib/corundum/rspec.rb
@@ -200,7 +207,6 @@ files:
 - lib/corundum/email.rb
 - lib/corundum/gemspec_sanity.rb
 - lib/corundum/gemcutter.rb
-- lib/corundum/tasklib.rb
 - lib/corundum/documentation.rb
 - lib/corundum/documentation-task.rb
 - lib/corundum/documentation/yardoc.rb
@@ -209,13 +215,12 @@ files:
 - lib/corundum/tasklibs.rb
 - lib/corundum/simplecov.rb
 - lib/corundum/rubyforge.rb
+- lib/corundum/questionable-content.rb
 - lib/corundum/version_control.rb
 - lib/corundum/version_control/monotone.rb
 - lib/corundum/version_control/git.rb
-- lib/corundum/configuration_store.rb
 - lib/corundum/default_configuration/preferences.yaml
 - lib/corundum/default_configuration/templates/doc_assembly/index.html.erb
-- lib/corundum.rb
 - README.md
 - spec/smoking_spec.rb
 - spec_help/spec_helper.rb
@@ -279,7 +284,7 @@ licenses:
 post_install_message: Another tidy package brought to you by Judson
 rdoc_options: 
 - --title
-- corundum-0.0.13 RDoc
+- corundum-0.0.15 RDoc
 require_paths: 
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -287,7 +292,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 908238461
+      hash: 522495789
       segments: 
       - 0
       version: "0"

data/lib/corundum/configuration_store.rb

@@ -1,38 +0,0 @@
-require 'valise'
-
-module Corundum
-  class ConfigurationStore
-    def initialize
-      @valise = Valise::Set.define do
-        rw "~/.corundum"
-        rw "/usr/share/corundum"
-        rw "/etc/corundum"
-        ro from_here("default_configuration")
-
-        handle "preferences.yaml", :yaml, :hash_merge
-      end
-
-      @loaded ||= Hash.new{|h,k| h[k] = @valise.find(k).contents}
-    end
-
-    attr_reader :loaded, :valise
-
-    def register_search_path(from_file)
-      directory = File::expand_path("../.corundum", from_file)
-      @valise.prepend_search_root(Valise::SearchRoot.new(directory))
-      loaded.clear
-    end
-  end
-
-  def self.configuration_store
-    @configuration_store ||= ConfigurationStore.new
-  end
-
-  def self.register_project(rakefile)
-    configuration_store.register_search_path(rakefile)
-  end
-
-  def self.user_preferences
-    configuration_store.loaded["preferences.yaml"]
-  end
-end

data/lib/corundum/tasklib.rb

@@ -1,7 +0,0 @@
-require 'mattock/tasklib'
-
-module Corundum
-  #TODO Add functionality or refactor away
-  class TaskLib < Mattock::TaskLib
-  end
-end