corundum 0.0.6 → 0.0.7

data/lib/corundum/rubyforge.rb

@@ -1,21 +1,15 @@
 require 'corundum/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
-    def default_namespace
-      :rubyforge
-    end
+    default_namespace :rubyforge
 
-    def default_configuration(toolkit)
-      setting(:ns,  ns)
-      setting(:rubyforge,  nested(:package_id => nil, :group_id => nil, :release_name => nil))
-      setting(:package_dir,  nil)
-      setting(:gemspec,  nil)
-    end
+    setting(:rubyforge,  nested(:package_id => nil, :group_id => nil, :release_name => nil))
+    setting(:package_dir,  nil)
+    setting(:gemspec,  nil)
 
     def define
       desc "Publish the gem and its documentation to Rubyforge and Gemcutter"

data/lib/corundum/simplecov.rb

@@ -1,33 +1,45 @@
 require 'corundum/tasklib'
+require 'corundum/browser-task'
 
 module Corundum
-  class SimpleCov < TaskLib
-    def default_namespace
-      :coverage
+  class RSpecReportTask < RSpecTask
+    def command_task
+      @command_task ||= file task_name do
+        decorated(command).must_succeed!
+      end
     end
+  end
+
+  class SimpleCov < TaskLib
+    default_namespace :coverage
+
+    setting(:test_lib)
+    setting(:browser)
+    setting(:code_files)
+    setting(:all_files)
+
+    setting(:report_path, nil)
+    setting(:config_path, nil)
+
+    setting(:report_dir, "doc/coverage")
+    setting(:config_file, ".simplecov")
+    setting(:filters, ["./spec"])
+    setting(:threshold, 80)
+    setting(:groups, {})
+    setting(:coverage_filter, proc do |path|
+      /\.rb$/ =~ path
+    end)
 
     def default_configuration(toolkit, testlib)
-      setting(:test_lib, testlib)
-      setting(:browser, toolkit.browser)
-      setting(:report_dir, "doc/coverage")
-      setting(:report_path, nil)
-      setting(:config_file, ".simplecov")
-      setting(:config_path, nil)
-      setting(:filters, ["./spec"])
-
-      setting(:coverage_filter, proc do |path|
-        /\.rb$/ =~ path
-      end)
-
-      setting(:threshold, 80)
-      setting(:groups, {})
-      setting(:code_files, toolkit.files.code)
-      setting(:all_files,  toolkit.file_lists.project + toolkit.file_lists.code + toolkit.file_lists.test)
+      self.test_lib = testlib
+      self.browser = toolkit.browser
+      self.code_files = toolkit.files.code
+      self.all_files =  toolkit.file_lists.project + toolkit.file_lists.code + toolkit.file_lists.test
     end
 
     def resolve_configuration
-      @config_path ||= File::expand_path(config_file, Rake::original_dir)
-      @report_path ||= File::join(report_dir, "index.html")
+      self.config_path ||= File::expand_path(config_file, Rake::original_dir)
+      self.report_path ||= File::join(report_dir, "index.html")
     end
 
     def filter_lines
@@ -59,27 +71,27 @@ module Corundum
 
         task :example_config do
           $stderr.puts "Try this in #{config_path}"
+          $stderr.puts "(You can just do #$0 > #{config_path})"
           $stderr.puts
           puts config_file_contents
         end
 
         task :config_exists do
-          File::exists?(File::join(Rake::original_dir, ".simplecov")) or fail "No .simplecov"
+          File::exists?(File::join(Rake::original_dir, ".simplecov")) or fail "No .simplecov (try: rake #{self[:example_config]})"
         end
 
         directory File::dirname(report_path)
-        file report_path => all_files do
-          options = @test_lib.custom_options do |options|
-            options.rspec_opts += %w{-r simplecov}
-          end
-          sh @test_lib.full_command(options)
+        RSpecReportTask.new(@test_lib) do |t|
+          t.task_name = report_path
+          t.rspec_opts += %w{-r simplecov}
         end
+        file report_path => all_files
 
         task :generate_report => [:preflight, report_path]
 
         desc "View coverage in browser"
-        task :view => report_path do
-          sh "#{browser} #{report_path}"
+        BrowserTask.new(self) do |t|
+          t.index_html = report_path
         end
 
         task :verify_coverage => :generate_report do

data/lib/corundum/tasklib.rb

@@ -1,57 +1,7 @@
-require 'ostruct'
-require 'rake/tasklib'
-require 'corundum/configurable'
+require 'mattock/tasklib'
 
 module Corundum
-  class TaskLib < Rake::TaskLib
-    include Configurable
-
-    def default_configuration(*tasklibs)
-    end
-
-    def resolve_configuration
-    end
-
-    def in_namespace(*tasknames)
-      if tasknames.empty?
-        if block_given?
-          if @namespace_name.nil?
-            yield
-          else
-            namespace @namespace_name do
-              yield
-            end
-          end
-        end
-      else
-        tasknames.map do |taskname|
-          [@namespace_name, taskname].compact.join(":")
-        end
-      end
-    end
-
-    def root_task
-      @namespace_name || :default
-    end
-
-    def default_namespace
-      nil
-    end
-
-    def [](taskname)
-      in_namespace(taskname).first
-    end
-
-    def initialize(*tasklibs)
-      setting(:namespace_name, default_namespace)
-
-      default_configuration(*tasklibs)
-
-      yield self if block_given?
-
-      resolve_configuration
-
-      define
-    end
+  #TODO Add functionality or refactor away
+  class TaskLib < Mattock::TaskLib
   end
 end

data/lib/corundum/tasklibs.rb

@@ -1,3 +1,4 @@
+require 'corundum'
 require 'corundum/rspec'
 require 'corundum/simplecov'
 require 'corundum/gemspec_sanity'
@@ -7,3 +8,4 @@ require 'corundum/email'
 require 'corundum/version_control/monotone'
 require 'corundum/version_control/git'
 require 'corundum/yardoc'
+require 'corundum/github-pages'

data/lib/corundum/version_control.rb

@@ -2,15 +2,15 @@ require 'corundum/tasklib'
 
 module Corundum
   class VersionControl < TaskLib
-    def default_namespace
-      :version_control
-    end
+    default_namespace :version_control
+
+    required_fields(:gemspec, :build_finished_file, :gemspec_files, :tag)
 
     def default_configuration(toolkit)
-      setting(:gemspec,  toolkit.gemspec)
-      setting(:build_finished_file,  toolkit.finished_files.build)
-      setting(:gemspec_files, toolkit.files.code + toolkit.files.test)
-      setting(:tag,  toolkit.gemspec.version.to_s)
+      self.gemspec =  toolkit.gemspec
+      self.build_finished_file =  toolkit.finished_files.build
+      self.gemspec_files = toolkit.files.code + toolkit.files.test
+      self.tag =  toolkit.gemspec.version.to_s
     end
 
     def define

data/lib/corundum/version_control/git.rb

@@ -2,35 +2,29 @@ require 'corundum/version_control'
 
 module Corundum
   class Git < VersionControl
-    def default_configuration(*args)
-      super
-      setting(:branch, nil)
-    end
+    setting(:branch, nil)
 
     def resolve_configuration
       @branch ||= guess_branch
     end
 
-
     def git_command(*args)
-      result = ""
-      pid = nil
-      command = "git --no-pager #{args.join(" ")}"
-      puts command if verbose
-      pipe = IO.popen(command)
-      pid = pipe.pid
-      Process::wait(pid)
-      result = pipe.read
-      pipe.close
-      unless $?.exitstatus == 0
-        fail "Git exited with status #{$?.exitstatus}: \n#{result}"
+      Mattock::CommandLine.new("git", "--no-pager") do |cmd|
+        args.each do |arg|
+          cmd.options += [*arg]
+        end
       end
-      return result.split("\n")
+    end
+
+    def git(*args)
+      result = git_command(*args).run
+      result.must_succeed!
+      return result.stdout.lines.to_a
     end
 
     def guess_branch
       puts "Guessing branch - configure Git > branch"
-      branch = git_command("branch").grep(/^\*/).first.sub(/\*\s*/,"").chomp
+      branch = git("branch").grep(/^\*/).first.sub(/\*\s*/,"").chomp
       puts "  Guessed: #{branch}"
       return branch
     end
@@ -40,28 +34,28 @@ module Corundum
 
       in_namespace do
         task :on_branch do
-          current_branch = git_command("branch").grep(/^\*/).first.sub(/\*\s*/,"").chomp
+          current_branch = git("branch").grep(/^\*/).first.sub(/\*\s*/,"").chomp
           unless current_branch == branch
             fail "Current branch \"#{current_branch}\" is not #{branch}"
           end
         end
 
         task :not_tagged => :on_branch do
-          tags = git_command("tag", "-l", tag)
+          tags = git("tag", "-l", tag)
           unless tags.empty?
             fail "Tag #{tag} already exists in branch #{branch}"
           end
         end
 
         task :workspace_committed => :on_branch do
-          diffs = git_command("diff", "--stat", "HEAD")
+          diffs = git("diff", "--stat", "HEAD")
           unless diffs.empty?
             fail "Workspace not committed:\n  #{diffs.join("  \n")}"
           end
         end
 
         task :gemspec_files_added => :on_branch do
-          list = git_command(%w{ls-tree -r HEAD})
+          list = git(%w{ls-tree -r HEAD})
           list.map! do |line|
             line.split(/\s+/)[3]
           end
@@ -73,29 +67,29 @@ module Corundum
         end
 
         task :is_pulled do
-          fetch = git_command("fetch", "--dry-run")
+          fetch = git("fetch", "--dry-run")
           unless fetch.empty?
             fail "Remote branch has unpulled changes"
           end
 
-          remote = git_command("config", "--get", "branch.#{branch}.remote").first
-          merge = git_command("config", "--get", "branch.#{branch}.merge").first.split("/").last
+          remote = git("config", "--get", "branch.#{branch}.remote").first.chomp
+          merge = git("config", "--get", "branch.#{branch}.merge").first.split("/").last.chomp
 
-          ancestor = git_command("merge-base", branch, "#{remote}/#{merge}").first
+          ancestor = git("merge-base", branch, "#{remote}/#{merge}").first.chomp
           remote_rev = File::read(".git/refs/remotes/#{remote}/#{merge}").chomp
 
           unless ancestor == remote_rev
-            fail "Unmerged changes with remote branch #{remote}/#{merge}"
+            fail "Unmerged changes with remote branch #{remote}/#{merge}\n#{ancestor.inspect}\n#{remote_rev.inspect}"
           end
         end
         task :is_checked_in => :is_pulled
 
         task :tag => :on_branch do
-          git_command("tag", tag)
+          git("tag", tag)
         end
 
         task :push => :on_branch do
-          git_command("push")
+          git("push")
         end
 
         task :check_in => [:push]

data/lib/corundum/version_control/monotone.rb

@@ -3,27 +3,19 @@ require 'strscan'
 
 module Corundum
   class Monotone < VersionControl
-    def default_configuration(*args)
-      super
-      setting(:branch, nil)
-    end
+
+    setting(:branch, nil)
 
     def resolve_configuration
       @branch ||= guess_branch
     end
 
     def mtn_automate(cmd, *args)
-      command = "mtn automate #{cmd} #{args.join(" ")}"
-      puts command if verbose
-      pipe = IO.popen(command)
-      pid = pipe.pid
-      Process.wait(pid)
-      result = pipe.read
-      pipe.close
-      unless $?.exitstatus == 0
-        fail "Monotone failed with exit status #{$?.exitstatus}: \n#{result}"
-      end
-      return result
+      result = Mattock::CommandLine.new("mtn", "automate", cmd) do |cmd|
+        cmd.options += args
+      end.run
+      result.must_succeed!
+      result.stdout
     end
 
     def parse_basic_io(string)

data/lib/corundum/yardoc.rb

@@ -1,33 +1,54 @@
 require 'corundum/tasklib'
-require 'yard/rake/yardoc_task'
+require 'yard'
 
 module Corundum
   class YARDoc < TaskLib
-    def default_namespace
-      :documentation
-    end
+    default_namespace :documentation
+
+    setting :gemspec
+    setting :options, nil
+    setting :browser
+    setting :yardoc_index, nil
+
+    setting(:target_dir, "yardoc")
+    setting(:readme, nil)
+    setting(:files, nested(:code => [], :docs => []))
+    setting(:extra_files, [])
 
     def default_configuration(toolkit)
-      setting(:gemspec, toolkit.gemspec)
-      setting(:doc_dir, "rubydoc")
-      setting(:files, nested(:code => [], :docs => []))
+      self.gemspec = toolkit.gemspec
+      toolkit.files.copy_settings_to(self.files)
+      self.browser = toolkit.browser
+    end
+
+    def resolve_configuration
+      self.options ||= gemspec.rdoc_options
+      self.options += [ "--output-dir", target_dir]
+      self.options += [ "--readme", readme ] if readme
+      self.options += files.code
+      unless files.docs.empty? and extra_files.empty?
+        self.options += [ "-" ] + files.docs  + extra_files
+      end
+      self.yardoc_index ||= File::join(target_dir, "index.html")
     end
 
     def define
-      directory doc_dir
+      directory target_dir
 
       in_namespace do
-        YARD::Rake::YardocTask.new(:docs) do |rd|
-          rd.options += gemspec.rdoc_options
-          rd.options += ["--output-dir", doc_dir]
-          rd.files += files.code
-          rd.files += files.docs
-          rd.files += gemspec.extra_rdoc_files
+        file yardoc_index =>
+        FileList["README*"] + files.code + files.docs + extra_files do
+          YARD::CLI::Yardoc.run( *(options) )
+        end
+
+        desc "Open up a browser to view your documentation"
+        BrowserTask.new(self) do |t|
+          t.index_html = yardoc_index
         end
       end
 
       desc "Generate documentation based on code using YARD"
-      task root_task => in_namespace("docs")
+      task root_task => yardoc_index
     end
   end
 end

data/spec/smoking_spec.rb

@@ -25,5 +25,3 @@ module Corundum
     end
   end
 end
-
-