corundum 0.0.1

data/lib/corundum.rb

@@ -0,0 +1,130 @@
+require 'corundum/tasklib'
+
+#require 'rubygems'
+#require 'rubygems/installer'
+
+module Corundum
+  extend Rake::DSL
+
+  class Toolkit < TaskLib
+    def default_configuration(namespace)
+      @configuration.marshal_load(
+        :namespace => namespace,
+        :finished_dir => "corundum",
+        :finished_files => OpenStruct.new,
+
+        :browser => "chromium",
+        :gemspec => nil,
+        :gemspec_path => nil,
+        :email => OpenStruct.new(
+          :servers => [ OpenStruct.new({ :server => "ruby-lang.org", :helo => "gmail.com" }) ],
+          :announce_to_email => "ruby-talk@ruby-lang.org"
+      ),
+        :package_dir => "pkg",
+        :files => OpenStruct.new(:code => nil, :test => nil, :docs => nil),
+        :file_lists => OpenStruct.new(:code => nil, :test => nil, :docs => nil, :all => nil),
+        :rubyforge => OpenStruct.new(),
+        :doc_dir => "rubydoc"
+      )
+    end
+
+    def load_gemspec
+      @configuration.gemspec_path ||= guess_gemspec
+      @configuration.gemspec ||= Gem::Specification::load(@configuration.gemspec_path)
+      return @configuration.gemspec
+    end
+
+    def resolve_configuration
+      load_gemspec
+
+      @configuration.finished_files.build ||= File::join(
+        @configuration.finished_dir, "build_#{@configuration.gemspec.version}")
+      @configuration.finished_files.qa ||= File::join(
+        @configuration.finished_dir, "qa_#{@configuration.gemspec.version}")
+      @configuration.finished_files.package ||= File::join(
+        @configuration.finished_dir, "package_#{@configuration.gemspec.version}")
+      @configuration.finished_files.release ||= File::join(
+        @configuration.finished_dir, "release_#{@configuration.gemspec.version}")
+      @configuration.finished_files.press ||= File::join(
+        @configuration.finished_dir, "press_#{@configuration.gemspec.version}")
+
+      @configuration.files.code ||= @configuration.gemspec.files.grep(%r{^lib/})
+      @configuration.files.test ||= @configuration.gemspec.files.grep(%r{^spec/})
+      @configuration.files.docs ||= @configuration.gemspec.files.grep(%r{^doc/})
+
+      @configuration.file_lists.code ||= FileList['lib/**/*.rb']
+      @configuration.file_lists.test ||= FileList['test/**/*.rb','spec/**/*.rb','features/**/*.rb']
+      @configuration.file_lists.docs ||= FileList['doc/**/*.rb']
+      @configuration.file_lists.all  ||=
+        @configuration.file_lists.code +
+        @configuration.file_lists.test +
+        @configuration.file_lists.docs
+
+      @configuration.rubyforge.group_id ||= @configuration.gemspec.rubyforge_project
+      @configuration.rubyforge.package_id ||= @configuration.gemspec.name.downcase
+      @configuration.rubyforge.release_name ||= @configuration.gemspec.full_name
+      @configuration.rubyforge.home_page ||= @configuration.gemspec.homepage
+      @configuration.rubyforge.project_page ||= "http://rubyforge.org/project/#{@configuration.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 @configuration.finished_dir
+
+        desc "Run preflight checks"
+        task :preflight
+
+        desc "Run quality assurance tasks"
+        task :qa => :preflight
+        file @configuration.finished_files.qa => [:qa, @configuration.finished_dir] do |task|
+          touch task.name
+        end
+
+        desc "Build the package"
+        task :build => @configuration.finished_files.qa
+        file @configuration.finished_files.build => [:build, @configuration.finished_dir] do |task|
+          touch task.name
+        end
+
+        desc "Push package out to the world"
+        task :release => @configuration.finished_files.build
+        file @configuration.finished_files.release => [:release, @configuration.finished_dir] do |task|
+          touch task.name
+        end
+
+        desc "Announce publication"
+        task :press => @configuration.finished_files.release
+        file @configuration.finished_files.press => [:press, @configuration.finished_dir] do |task|
+          touch task.name
+        end
+      end
+    end
+
+    def old_define
+
+      task @publishing.namespace => "#{@gem_building.namespace}:push"
+      task "#{@publishing.namespace}:docs" => "#{@documentation.namespace}:docs"
+      task "#{@publishing.namespace}:rubyforge" => ["#{@quality_assurance.namespace}:sign_off", "#{@gem_building.namespace}:package"]
+
+      require 'corundum/press'
+      Press.new(@press.namespace) do |press|
+        press.rubyforge = @rubyforge
+        press.gemspec = @configuration.gemspec
+        press.announce_to_email = @email.announce_to_email
+        press.email_servers = @email.servers
+      end
+    end
+  end
+end

data/lib/corundum/email.rb

@@ -0,0 +1,92 @@
+require 'corundum/tasklib'
+
+module Corundum
+  class Email < TaskLib
+    def default_namespace
+      :email
+    end
+
+    def receive_tasklibs(toolkit)
+      @toolkit = toolkit
+    end
+
+    def default_configuration(namespace, toolkit_config)
+      @configuration.namespace = namespace
+      @configuration.rubyforge = toolkit_config.rubyforge
+      @configuration.email_servers = []
+      @configuration.gemspec = toolkit_config.gemspec
+      @configuration.announce_to_email = nil
+      @configuration.urls = OpenStruct.new
+    end
+
+    def resolve_configuration
+      @configuration.urls.home_page ||=
+        @configuration.gemspec.homepage
+
+      @configuration.urls.project_page ||=
+        @configuration.rubyforge.project_page
+
+    end
+
+    def announcement
+      changes = ""
+      begin
+        File::open("./Changelog", "r") do |changelog|
+          changes = "Changes:\n\n"
+          changes += changelog.read
+        end
+      rescue Exception
+      end
+
+      urls = "Project: #{@configuration.urls.project_page}\n" +
+      "Homepage: #{@configuration.urls.home_page}"
+
+      subject = "#{@configuration.gemspec.name} #{@configuration.gemspec.version} Released"
+      title = "#{@configuration.gemspec.name} version #{@configuration.gemspec.version} has been released!"
+      body = "#{@configuration.gemspec.description}\n\n#{changes}\n\n#{urls}"
+
+      return subject, title, body
+    end
+
+    def define
+      desc 'Announce release on email'
+      task @configuration.namespace => ["#{@configuration.namespace.to_s}:rubyforge", "#{@configuration.namespace.to_s}:email"]
+      namespace @configuration.namespace do
+        file "email.txt" do |t|
+          require 'mailfactory'
+
+          subject, title, body= announcement
+
+          mail = MailFactory.new
+          mail.To = @configuration.announce_to_email
+          mail.From = @configuration.gemspec.email
+          mail.Subject = "[ANN] " + subject
+          mail.text = [title, body].join("\n\n")
+
+          File.open(t.name, "w") do |mailfile|
+            mailfile.write mail.to_s
+          end
+        end
+
+        task :email => "email.txt" do
+          require 'net/smtp'
+
+          @configuration.email_servers.each do |server_config|
+            begin
+              File::open("email.txt", "r") do |email|
+                Net::SMTP.start(server_config[:server], 25, server_config[:helo], server_config[:username], server_config[:password]) do |smtp|
+                  smtp.data do |mta|
+                    mta.write(email.read)
+                  end
+                end
+              end
+              break
+            rescue Object => ex
+              puts ex.message
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/corundum/gem_building.rb

@@ -0,0 +1,34 @@
+require 'corundum/tasklib'
+
+module Corundum
+  class GemBuilding < TaskLib
+    def receive_tasklibs(toolkit)
+      @toolkit = toolkit
+    end
+
+    def default_configuration(namespace, toolkit_config)
+      @configuration.namespace = namespace || :package
+      @configuration.gemspec = toolkit_config.gemspec
+      @configuration.qa_finished_file = toolkit_config.finished_files.qa
+      @configuration.package_dir = "pkg"
+    end
+
+    def define
+      require 'rubygems/package_task'
+
+      in_namespace do
+        package = Gem::PackageTask.new(@configuration.gemspec) do |t|
+          t.need_tar_gz = true
+          t.need_tar_bz2 = true
+          t.package_dir = @configuration.package_dir
+        end
+
+        task(:package).prerequisites.each do |package_type|
+          file package_type => @configuration.qa_finished_file
+        end
+      end
+
+      task :build => in_namespace("gem")
+    end
+  end
+end

data/lib/corundum/gemcutter.rb

@@ -0,0 +1,110 @@
+require 'corundum/tasklib'
+
+module Corundum
+  class GemCutter < TaskLib
+    def receive_tasklibs(toolkit, build)
+      @toolkit = toolkit
+      @build = build
+    end
+
+    def default_configuration(namespace, toolkit_config, build_config)
+      @configuration.namespace = namespace || :gemcutter
+      @configuration.gemspec = toolkit_config.gemspec
+      @configuration.build_finished_path = toolkit_config.finished_files.build
+      @configuration.gem_path = nil
+      @configuration.gem_name = nil
+      @configuration.package_dir = build_config.package_dir
+    end
+
+    def resolve_configuration
+      @configuration.gem_path ||=
+        File::join(@configuration.package_dir, @configuration.gemspec.file_name)
+
+      @configuration.gem_name ||= @configuration.gemspec.full_name
+    end
+
+    module CommandTweaks
+      def setup_args(args = nil)
+        args ||= []
+        handle_options(args)
+      end
+
+      def gem_list=(list)
+        @configuration.gems = list
+      end
+
+      def get_all_gem_names
+        return @configuration.gems if defined?(@configuration.gems)
+        super
+      end
+
+      def get_one_gem_name
+        return @configuration.gems.first if defined?(@configuration.gems)
+        super
+      end
+    end
+
+    def get_command(klass, args=nil)
+      cmd = klass.new
+      cmd.extend(CommandTweaks)
+      cmd.setup_args(args)
+      cmd
+    end
+
+    def define
+      in_namespace do
+        task :uninstall do |t|
+          when_writing("Uninstalling #{@configuration.gem_name}") do
+            require "rubygems/commands/uninstall_command"
+            uninstall = get_command Gem::Commands::UninstallCommand
+            uninstall.options[:args] = [@configuration.gem_path]
+            uninstall.execute
+          end
+        end
+
+        task :install => [@configuration.gem_path] do |t|
+          when_writing("Installing #{@configuration.gem_path}") do
+            require "rubygems/commands/install_command"
+            install = get_command Gem::Commands::InstallCommand
+            install.options[:args] = [@configuration.gem_path]
+            install.execute
+          end
+        end
+
+        task :reinstall => [:uninstall, :install]
+
+        task :dependencies_available do
+          checker = Gem::SpecFetcher.new
+          @configuration.gemspec.runtime_dependencies.each do |dep|
+            fulfilling = checker.find_matching(dep,false,false,false)
+            if fulfilling.empty?
+              fail "Dependency #{dep} is unfulfilled remotely"
+            else
+              puts "Remotely fulfilled: #{dep}" if verbose
+            end
+          end
+        end
+
+        task :is_unpushed do
+          checker = Gem::SpecFetcher.new
+          dep = Gem::Dependency.new(@configuration.gemspec.name, "= #{@configuration.gemspec.version}")
+          fulfilling = checker.find_matching(dep,false,false,true)
+          unless fulfilling.empty?
+            fail "Gem #{@configuration.gemspec.full_name} is already pushed"
+          end
+        end
+
+        desc 'Push a gem up to Gemcutter'
+        task :push => [:dependencies_available, :is_unpushed] do
+          require "rubygems/commands/push_command"
+          push = get_command(Gem::Commands::PushCommand)
+          push.options[:args] = [@configuration.gem_path]
+          push.execute
+        end
+        task :push => @configuration.build_finished_path
+      end
+      task :release => in_namespace(:push)
+      task :preflight => in_namespace(:dependencies_available, :is_unpushed)
+    end
+  end
+end

data/lib/corundum/gemspec_sanity.rb

@@ -0,0 +1,32 @@
+require 'corundum/tasklib'
+
+module Corundum
+  class GemspecSanity < TaskLib
+    def default_namespace
+      :gemspec_sanity
+    end
+
+    def receive_tasklibs(toolkit)
+      @toolkit = toolkit
+    end
+
+    def default_configuration(namespace, toolkit_config)
+      @configuration.namespace = namespace
+      @configuration.gemspec = toolkit_config.gemspec
+    end
+
+    def define
+      in_namespace do
+        task :files_exist do
+          missing = @configuration.gemspec.files.find_all do |path|
+            not File::exists?(path)
+          end
+
+          fail "Files mentioned in gemspec are missing: #{missing.join(", ")}" unless missing.empty?
+        end
+      end
+
+      task :preflight => in_namespace(:files_exist)
+    end
+  end
+end

data/lib/corundum/rspec.rb

@@ -0,0 +1,135 @@
+require 'corundum/tasklib'
+require 'rspec/core'
+
+module Corundum
+  #TODO: this should take two command generators as arguments: the test runner,
+  #and the coverage tool - then the various tasks are the result of the
+  #collaboration of those two.
+  #
+  class RSpec < TaskLib
+    def receive_tasklibs(toolkit)
+      @toolkit = toolkit
+    end
+
+    def default_configuration(namespace, toolkit_config)
+      @configuration.task_options = OpenStruct.new(
+        :pattern => nil,
+        :ruby_opts => nil,
+        :rspec_opts => nil,
+        :warning => false,
+        :verbose => true,
+        :fail_on_error => true,
+        :ruby_opts => [],
+        :rspec_opts => %w{--format documentation --out last_run --color --format documentation},
+        :failure_message => "Spec examples failed.",
+        :files_to_run => nil
+      )
+
+      @configuration.namespace = namespace || :rspec
+      @configuration.gemspec_path = toolkit_config.gemspec_path
+      @configuration.qa_finished_path = toolkit_config.qa_finished_path
+    end
+
+    def resolve_configuration
+      @configuration.task_options.rspec_configs = @configuration.task_options.rspec_opts
+      @configuration.task_options.rspec_opts = []
+      @configuration.task_options.rspec_path ||= 'rspec'
+      @configuration.task_options.rspec_path = %x"which #{@configuration.task_options.rspec_path}".chomp
+      @configuration.task_options.pattern    ||= './spec{,/*/**}/*_spec.rb'
+      @configuration.task_options.files_to_run ||= "spec"
+    end
+
+    #XXX some point in the future, there needs to be a composible command
+    #object
+    def ruby_command(options)
+      cmd_parts = []
+      cmd_parts << RUBY
+      cmd_parts << options.ruby_opts
+      cmd_parts << "-w" if options.warning?
+      if /^1\.8/ =~ RUBY_VERSION
+        cmd_parts << "-S"
+      end
+      return cmd_parts
+    end
+
+    def runner_command(options)
+      cmd_parts = []
+      cmd_parts << options.rspec_path
+      cmd_parts << options.rspec_opts
+      cmd_parts << options.files_to_run
+      return cmd_parts
+    end
+
+    def full_command(options)
+      cmd_parts = ruby_command(options) + runner_command(options)
+      return cmd_parts.flatten.compact.reject{|part| part.nil? or part.empty?}.join(" ")
+    end
+
+    def custom_options
+      options = @configuration.task_options.dup
+      yield(options)
+      return options
+    end
+
+    def define_spec_task(name)
+      options = if block_given?
+                  custom_options{|options| yield(options) if block_given?}
+                else
+                  @configuration.task_options
+                end
+      task name do
+        RakeFileUtils.send(:verbose, verbose) do
+          if options.files_to_run.empty?
+            puts "No examples matching #{options.pattern} could be found"
+          else
+            begin
+              cmd = full_command(options)
+              puts cmd if options.verbose
+              success = system(cmd)
+            rescue
+              puts options.failure_message if options.failure_message
+            end
+            raise("ruby #{cmd} failed") if options.fail_on_error unless success
+          end
+        end
+      end
+    end
+
+    def define
+      desc "Run failing examples if any exist, otherwise, run the whole suite"
+      task @configuration.namespace => "#{@configuration.namespace}:quick"
+
+      in_namespace do
+        desc "Always run every spec"
+        define_spec_task(:all)
+
+        desc "Generate specifications documentation"
+        define_spec_task(:doc) do |t|
+          t.rspec_opts = %w{-o /dev/null -f d -o doc/Specifications}
+          t.failure_message = "Failed generating specification docs"
+          t.verbose = false
+        end
+
+        desc "Run only failing examples listed in last_run"
+        define_spec_task(:quick) do |t|
+          examples = []
+          begin
+            File.open("last_run", "r") do |fail_list|
+              fail_list.lines.grep(%r{^\s*\d+\)\s*(.*)}) do |line|
+                examples << $1.gsub(/'/){"[']"}
+              end
+            end
+          rescue
+          end
+          unless examples.empty?
+            t.rspec_opts << "--example"
+            t.rspec_opts << "\"#{examples.join("|")}\""
+          end
+          t.failure_message = "Spec examples failed."
+        end
+      end
+
+      task :qa => in_namespace(:doc)
+    end
+  end
+end