corundum 0.3.9 → 0.4.0

data/lib/corundum/documentation.rb

@@ -1,2 +0,0 @@
-require 'corundum/documentation/assembly'
-require 'corundum/documentation/yardoc'

data/lib/corundum/documentation/assembly.rb

@@ -1,115 +0,0 @@
-require 'compass'
-require 'corundum/documentation-task'
-#require 'mattock/template-host'
-
-module Corundum
-  class DocumentationAssembly < DocumentationTask
-
-    title 'Assembled Documentation'
-
-    dir(:assembly_sub, "doc_assembly",
-        dir(:theme_dir, "theme",
-            dir(:theme_sass, "sass",
-               path(:root_stylesheet, "styles"))),
-        path(:index_source, "index.html"))
-
-    dir(:target, path(:stylesheet, "stylesheet.css"))
-
-    setting :templates
-
-    setting :sub_dir, "assembled"
-    setting :documenters, []
-    setting :extra_data, {}
-    setting :external_docs, {}
-    setting :css_dir, "stylesheets" #XXX
-    setting :compass_config, nested(
-      :http_path => "/",
-      :line_comments => false,
-      :preferred_syntax => :scss,
-      :http_stylesheets_path => nil,
-      :project_path => nil,
-      :images_dir => 'images',
-    )
-
-    def default_configuration(toolkit, *documenters)
-      super(toolkit)
-      self.documenters = documenters
-
-      self.compass_config.http_stylesheets_path = css_dir #XXX
-    end
-
-    def resolve_configuration
-      super
-      assembly_sub.absolute_path = assembly_sub.relative_path
-      target.absolute_path = target_dir
-
-      resolve_paths
-
-      if field_unset?(:templates)
-        self.templates = Corundum::configuration_store.valise.templates do |mapping|
-          case mapping
-          when "sass", "scss"
-            valise = Corundum::configuration_store.valise
-            options =
-              if Compass.respond_to? :sass_engine_options
-                Compass.sass_engine_options
-              else
-                require 'compass/core'
-                { :load_paths => [Compass::Core.base_directory("stylesheets")] }
-              end
-            options[:load_paths] = valise.sub_set("templates").map(&:to_s) + options[:load_paths]
-            { :template_options => options }
-          else
-            nil
-          end
-        end
-      end
-
-      self.compass_config.project_path = templates.find("doc_assembly/theme").full_path
-
-      self.documenters = documenters.each_with_object({}) do |doccer, hash|
-        hash[File::join(target_dir, doccer.sub_dir)] = doccer
-      end
-      if field_unset?(:stylesheet)
-        self.stylesheet = File::join(target_dir, "stylesheet.css")
-      end
-
-    end
-
-
-    def define
-      in_namespace do
-        subdir_regex = %r{^#{File::expand_path(target_dir)}}
-
-        documenters.each_pair do |subdir, doccer|
-          file subdir => [target_dir, doccer.entry_point] do
-            if subdir_regex =~ File::expand_path(doccer.target_dir)
-              fail "Documentation being rendered to #{doccer.target_dir}, inside of #{target_dir}"
-            end
-
-            FileUtils.rm_rf(subdir)
-            FileUtils.mv(doccer.target_dir, subdir)
-          end
-        end
-
-        #XXX Collision of doc groups
-        task :collect => documenters.keys
-
-        file stylesheet.abspath => [target.abspath] do |task|
-          template = templates.find(root_stylesheet.abspath).contents
-          File::open(task.name, "w") do |file|
-            file.write(template.render(nil, nil))
-          end
-        end
-
-        file entry_point => [stylesheet.abspath, target.abspath, :collect] do |task|
-          template = templates.find(index_source.abspath).contents
-          File::open(task.name, "w") do |file|
-            file.write(template.render(self, {}))
-          end
-        end
-      end
-      super
-    end
-  end
-end

data/lib/corundum/documentation/yardoc.rb

@@ -1,70 +0,0 @@
-require 'corundum/documentation-task'
-require 'yard'
-
-module Corundum
-  class YARDoc < DocumentationTask
-    title "YARD API documentation"
-    default_namespace :yardoc
-
-    setting :gemspec
-
-    settings(:options =>  nil,
-             :readme =>  nil,
-             :sub_dir =>  "yardoc",
-             :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
-
-    def default_configuration(toolkit)
-      super
-      self.gemspec = toolkit.gemspec
-      toolkit.files.copy_settings_to(self.files)
-      self.files.docs = []
-    end
-
-    def resolve_configuration
-      self.options ||= gemspec.rdoc_options
-      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
-      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
-      in_namespace do
-        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( *(options + server_options) )
-        end
-      end
-
-      super
-    end
-  end
-end

data/lib/corundum/email.rb

@@ -1,82 +0,0 @@
-require 'mattock/tasklib'
-
-module Corundum
-  class Email < Mattock::TaskLib
-    default_namespace :email
-
-    setting(:rubyforge)
-    setting(:email_servers, [])
-    setting(:gemspec)
-    setting(:announce_to_email, nil)
-    setting(:urls, nested.required_fields(:home_page, :project_page))
-
-    def default_configuration(toolkit)
-      super
-      self.rubyforge = toolkit.rubyforge
-      self.gemspec = toolkit.gemspec
-      self.urls.home_page = toolkit.gemspec.homepage
-      self.urls.project_page = toolkit.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: #{urls.project_page}\n" +
-      "Homepage: #{urls.home_page}"
-
-      subject = "#{gemspec.name} #{gemspec.version} Released"
-      title = "#{gemspec.name} version #{gemspec.version} has been released!"
-      body = "#{gemspec.description}\n\n#{changes}\n\n#{urls}"
-
-      return subject, title, body
-    end
-
-    def define
-      desc 'Announce release on email'
-      task root_task => in_namespace("rubyforge", "email")
-      in_namespace do
-        file "email.txt" do |t|
-          require 'mailfactory'
-
-          subject, title, body= announcement
-
-          mail = MailFactory.new
-          mail.To = announce_to_email
-          mail.From = 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'
-
-          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/github-pages.rb

@@ -1,153 +0,0 @@
-require 'mattock/tasklib'
-require 'mattock/task'
-
-module Corundum
-  class GitTask < Mattock::Rake::CommandTask
-    setting(:subcommand)
-    setting(:arguments, [])
-
-    def command
-      cmd("git", "--no-pager") do |cmd|
-        cmd.options << subcommand
-        arguments.each do |arg|
-          cmd.options += [*arg]
-        end
-      end
-    end
-  end
-
-  class InDirCommandTask < Mattock::Rake::CommandTask
-    setting :target_dir
-
-    def default_configuration(parent)
-      super
-      parent.copy_settings_to(self)
-    end
-
-    def needed?
-      return true unless File.directory? target_dir
-      Dir.chdir target_dir do
-        super
-      end
-    end
-
-    def action(*args)
-      Dir.chdir target_dir do
-        super
-      end
-    end
-  end
-
-  class GithubPages < Mattock::CommandTaskLib
-    default_namespace :publish_docs
-
-    setting(:target_dir, "gh-pages")
-    setting(:source_dir)
-    setting(:docs_index)
-
-    nil_fields :repo_dir
-
-    def branch
-      "gh-pages"
-    end
-
-    def default_configuration(doc_gen)
-      super
-      self.source_dir = doc_gen.target_dir
-      self.docs_index = doc_gen.entry_point
-    end
-
-    def resolve_configuration
-      super
-      self.repo_dir ||= File::join(target_dir, ".git")
-    end
-
-    def git_command(*args)
-      cmd("git", "--no-pager") do |cmd|
-        args.each do |arg|
-          cmd.options += [*arg]
-        end
-      end
-    end
-
-    def git(*args)
-      result = git_command(*args).run
-      result.must_succeed!
-      result.stdout.lines.to_a
-    end
-
-    def define
-      in_namespace do
-        file repo_dir do
-          fail "Refusing to clobber existing #{target_dir}" if File.exists?(target_dir)
-
-          url = git("config", "--get", "remote.origin.url").first
-          git("clone", url.chomp, target_dir)
-        end
-
-        InDirCommandTask.define_task(self, :remote_branch => repo_dir) do |t|
-          t.verify_command = git_command | cmd("grep", "-q", branch)
-          t.command = git_command("checkout", "-b", branch) &
-            cmd("rm -rf *") &
-            git_command(%w{commit -a -m} + ["'Creating pages'"]) &
-            git_command("push", "origin", branch) &
-            git_command("branch", "--set-upstream", branch, "origin/" + branch)
-        end
-
-        InDirCommandTask.define_task(self, :local_branch => :remote_branch) do |t|
-          t.verify_command = git_command(%w{branch}) | cmd("grep", "-q", "'#{branch}'")
-          t.command = git_command("checkout", "-b", branch) &
-            git_command("branch", "--set-upstream", branch, "origin/" + branch) &
-            cmd("rm", "-f", '.git/index') &
-            git_command("clean", "-fdx")
-        end
-
-        InDirCommandTask.define_task(self, :on_branch => [:remote_branch, :local_branch]) do |t|
-          t.verify_command = git_command(%w{branch}) | cmd("grep", "-q", "'^[*] #{branch}'")
-          t.command = git_command("checkout", branch)
-        end
-
-        task :pull => [repo_dir, :on_branch] do
-          FileUtils.cd target_dir do
-            git("pull", "-X", "ours")
-          end
-        end
-
-        task :cleanup_repo => repo_dir do
-          cmd("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]
-
-        task :clobber_target => [:on_branch, :pull] do
-          cmd(*%w{rm -rf}) do |cmd|
-            cmd.options << target_dir + "/*"
-          end.must_succeed!
-        end
-
-        task :assemble_docs => [docs_index, :pre_publish, :clobber_target] do
-          cmd(*%w{cp -a}) do |cmd|
-            cmd.options << source_dir + "/*"
-            cmd.options << target_dir
-          end.must_succeed!
-        end
-
-        task :publish => [:assemble_docs, :on_branch] do
-          FileUtils.cd target_dir do
-            git("add", ".")
-            git("commit", "-m", "'Corundum auto-publish'")
-            git("push", "origin", branch)
-          end
-        end
-      end
-
-      desc "Push documentation files to Github Pages"
-      task root_task => self[:publish]
-    end
-  end
-end