corundum 0.0.15 → 0.0.16

data/README.md

@@ -8,71 +8,36 @@ With Corudum added as a developement dependancy to your gemspec, and configured
 
 and know that you're publishing something you won't be embarrassed by.
 
-### (Yet Another Rubygems packager)
+### What is it?
 
-Why is Corundum different from Jeweler or Hoe?  (or...) Corundum is built not
-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.
+Corundum is a set of Rake tasklibs built so that you can set up safeguards on
+your gem deployment so that your deploys won't distress your users.
 
-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?
+The tasklibs are built to be extremely flexible and terse, so that they can
+conform to your build process, rather than the other way around.
 
-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.
+### Why do I care?
 
-### Using Corundum
+Have you ever released a gem that:
 
-In your coolgem.gemspec:
+* Didn't pass its own specs?
+* Were poorly tested?
+* Depended on gems that weren't released yet?
+* Didn't include all their source files?
+* Included tons of files that weren't actually part of the gem?
+* Still had a p or debugger line hanging around?
+* Weren't commited and pushed to github?
+* Weren't tagged with their version on github?
 
-    spec.add_development_dependency "corundum"
+If so, Corundum is for you.
 
-In you Gemfile:
+Have you ever been irritated with a gem packaging system that
 
-    gemspec
+* Did the easy parts and left you to figure out the hard things?
+* Imposed it's own ideas about how to organize your gem?
+* Relied heavily on code generation?
+* Wouldn't let you use Rake as it was intended?
 
-(But you were doing that anyway, right?)
+If so, Corundum is for you.
 
-Check out this Rakefile:
-
-    require 'corundum/tasklibs'
-
-    module Corundum
-      tk = Toolkit.new do |tk|
-      end
-
-      tk.in_namespace do
-        sanity = GemspecSanity.new(tk)
-        rspec = RSpec.new(tk)
-        cov = SimpleCov.new(tk, rspec) do |cov|
-          cov.threshold = 55
-        end
-        gem = GemBuilding.new(tk)
-        cutter = GemCutter.new(tk,gem)
-        email = Email.new(tk)
-        vc = Git.new(tk) do |vc|
-          vc.branch = "master"
-        end
-        task tk.finished_files.build => vc["is_checked_in"]
-        docs = YARDoc.new(tk) do |yd|
-          yd.extra_files = ["Rakefile"]
-        end
-        pages = GithubPages.new(docs)
-      end
-    end
-
-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
-configurable Tasklibs, so the power of Rake remains available.  If you want
-to do
-
-    task :default => :release
-
-Then 'rake' will do your releases.
-
-Digging in, the first thing to look at is {Corundum::Toolkit}
+[Learn more](http://nyarly.github.com/corundum/)

data/doc/README

@@ -0,0 +1,57 @@
+== Corundum
+=== Foolproof rubygems
+
+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?
+
+Why is Corundum different from Jeweler or Hoe?  (or...) Corundum isn't built
+to generate code - it doesn't build gems for you if you don't know how or don't 
+care to.  For that, check out {http://rubygems.org/gems/jeweler Jeweler}, and 
+come back once you've understood what a .gemspec is and how it works.
+
+Because, 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 
+{https://github.com/jbarnette/hoe-doofus/blob/master/lib/hoe/doofus.rb#L16 
+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:
+
+{include:file:Rakefile.rb}
+
+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
+configurable Tasklibs, so the power of Rake remains available.  If you want
+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/default_configuration/templates/doc_assembly/index.html.erb

@@ -1,28 +1,40 @@
 <html>
   <head>
+    <link rel="stylesheet" href="stylesheet.css" type="text/css" />
+    <title><%= gemspec.name.sub(/./){|ch| ch.upcase} %> <%=gemspec.version %></title>
   </head>
   <body>
-    <div class="gem-details">
-      <h1><%= gemspec.name %></h1>
-      <h2><%= gemspec.summary %></h2>
-      <h2>(current version: <%= gemspec.version %>)</h2>
-      <p><%= gemspec.description.gsub(/\n\s*\n/, "</p><p>") %></p>
-    </div>
-    <div class="documentation-list">
-      <p>Documentation is in a few sections:</p>
-      <ul>
-        <% documenters.each_pair do |path, doccer| %>
-          <li><a href="<%= doccer.entry_link %>"><%= doccer.title%></a></li>
-        <% end %>
-      </ul>
-    </div>
-    <div class="credits">
-      <dl>
-        <% gemspec.authors.zip(gemspec.email).each do |author, email| %>
-          <dt><%= author %></dt>
-          <dd><%= email %></dd>
-        <% end %>
-      </dl>
+    <div class="wrapper">
+      <header>
+        <div class="headers">
+          <h1><%= gemspec.name.sub(/./){|ch| ch.upcase} %></h1>
+          <h2><%= gemspec.summary %></h2>
+          <h2>(current version: <%= gemspec.version %>)</h2>
+        </div>
+      </header>
+      <section>
+        <p><%= gemspec.description.gsub(/\n\s*\n/, "</p><p>") %></p>
+      </section>
+      <section class="documentation-list">
+        <p>Documentation is in a few sections:</p>
+        <ul>
+          <% documenters.each_pair do |path, doccer| %>
+            <li><a href="<%= doccer.entry_link %>"><%= doccer.title%></a></li>
+          <% end %>
+          <% external_docs.each_pair do |name, link| %>
+            <li><a href="<%= link %>"><%= name %></a></li>
+          <% end %>
+        </ul>
+      </section>
+      <section class="credits">
+        <h2>Authors</h2>
+        <dl>
+          <% gemspec.authors.zip(gemspec.email).each do |author, email| %>
+            <dt><%= author %></dt>
+            <dd><%= email %></dd>
+          <% end %>
+        </dl>
+      </section>
     </div>
   </body>
 </html>

data/lib/corundum/documentation/assembly.rb

@@ -1,20 +1,35 @@
 require 'corundum/documentation-task'
 require 'mattock/template-host'
+require 'compass'
 
 module Corundum
   class DocumentationAssembly < DocumentationTask
-    include Mattock::TemplateHost
+    include Mattock::TemplateTaskLib
 
     title 'Assembled Documentation'
 
     setting :sub_dir, "assembled"
     setting :documenters, []
     setting :extra_data, {}
+    setting :external_docs, {}
+    setting :stylesheet
+    setting :css_dir, "stylesheets"
+    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.valise = Corundum::configuration_store.valise
+
+      self.compass_config.http_stylesheets_path = css_dir
+      self.compass_config.project_path = template_path("doc_assembly/theme")
     end
 
     def resolve_configuration
@@ -22,6 +37,9 @@ module Corundum
       self.documenters = documenters.each_with_object({}) do |doccer, hash|
         hash[File::join(target_dir, doccer.sub_dir)] = doccer
       end
+      if unset?(stylesheet)
+        self.stylesheet = File::join(target_dir, "stylesheet.css")
+      end
     end
 
 
@@ -43,12 +61,15 @@ module Corundum
         #Colision of doc groups
         task :collect => documenters.keys
 
-        desc "Generate various documentation and collect it in one place"
-        file entry_point => [target_dir, :collect] do
-          File::open(entry_point, "w") do |file|
-            file.write(render("doc_assembly/index.html.erb"))
-          end
+        task :setup_compass do
+          Compass.add_configuration(compass_config.to_hash, __FILE__)
         end
+
+        template_task("doc_assembly/stylesheet.scss", stylesheet, Compass.sass_engine_options)
+        file stylesheet => [:setup_compass, target_dir]
+
+        template_task("doc_assembly/index.html.erb", entry_point)
+        file entry_point => [stylesheet, target_dir, :collect]
       end
       super
     end

data/lib/corundum/documentation/yardoc.rb

@@ -60,7 +60,7 @@ module Corundum
 
         desc "Start a live YARD server for editing inline docs"
         task :live do
-          YARD::CLI::Server.run( *(server_options) )
+          YARD::CLI::Server.run( *(options + server_options) )
         end
       end
 

data/lib/corundum/rspec-task.rb

@@ -11,7 +11,7 @@ module Corundum
 
     setting :runner_command
 
-    required_fields :pattern, :ruby_opts, :rspec_configs, :rspec_opts,
+    required_fields :pattern, :ruby_opts, :rspec_opts,
       :warning, :rspec_path, :rspec_opts, :failure_message, :files_to_run,
       :file_dependencies
 
@@ -21,7 +21,6 @@ module Corundum
     end
 
     def resolve_configuration
-      self.rspec_configs = rspec_opts
       self.rspec_path = %x"which #{rspec_path}".chomp
 
       ruby_command.options << ruby_opts if ruby_opts

data/lib/corundum/rspec.rb

@@ -9,13 +9,12 @@ module Corundum
     settings(
       :sub_dir => "rspec",
       :pattern => './spec{,/*/**}/*_spec.rb',
-      :rspec_configs => nil,
       :rspec_opts => nil,
       :warning => false,
       :verbose => true,
       :ruby_opts => [],
       :rspec_path => 'rspec',
-      :rspec_opts => %w{--format documentation --out last_run --color --format documentation},
+      :rspec_opts => [],
       :failure_message => "Spec examples failed.",
       :files_to_run => "spec"
     )
@@ -29,28 +28,38 @@ module Corundum
 
     def resolve_configuration
       #XXX Que?
-      self.rspec_configs = rspec_opts
-      self.rspec_opts = []
       self.rspec_path = %x"which #{rspec_path}".chomp
       self.file_dependencies = file_lists.code + file_lists.test + file_lists.project
       super
     end
 
+    def test_task(name)
+      RSpecTask.new(self, name) do |t|
+        yield(t) if block_given?
+      end
+    end
+
+    def doc_task(name)
+      RSpecReportTask.new(self, name) do |t|
+        yield(t) if block_given?
+      end
+    end
+
     def define
       super
       in_namespace do
         desc "Always run every spec"
-        RSpecTask.new(self, :all)
+        test_task(:all)
 
         desc "Generate specifications documentation"
-        RSpecReportTask.new(self, :doc) do |t|
+        doc_task(:doc) do |t|
           t.rspec_opts = %w{-o /dev/null -f h -o} + [t.doc_path]
           t.failure_message = "Failed generating specification docs"
         end
         file entry_path => :doc
 
         desc "Run only failing examples listed in last_run"
-        RSpecTask.new(self, :quick) do |t|
+        test_task(:quick) do |t|
           examples = []
           begin
             File.open("last_run", "r") do |fail_list|

data/lib/corundum/simplecov.rb

@@ -23,6 +23,8 @@ module Corundum
       /\.rb$/ =~ path
     end)
 
+    setting(:test_options, [])
+
     def default_configuration(toolkit, testlib)
       super(toolkit)
       self.test_lib = testlib
@@ -73,8 +75,8 @@ module Corundum
           File::read(config_path) =~ /coverage_dir.*#{target_dir}/ or fail ".simplecov doesn't refer to #{target_dir}"
         end
 
-        RSpecReportTask.new(@test_lib, :report => [:config_exists] + all_files) do |t|
-          t.rspec_opts += %w{-r simplecov}
+        @test_lib.doc_task(:report => [:config_exists] + all_files) do |t|
+          t.rspec_opts += test_options + %w{-r simplecov}
         end
         file entry_path => :report
 

metadata

@@ -1,150 +1,187 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: corundum
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.16
   prerelease: 
-  version: 0.0.15
 platform: ruby
-authors: 
+authors:
 - Judson Lester
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: corundum
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &79741460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79741460
+- !ruby/object:Gem::Dependency
   name: rake-rubygems
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &79740310 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79740310
+- !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &79739960 !ruby/object:Gem::Requirement
     none: true
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79739960
+- !ruby/object:Gem::Dependency
   name: yard
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &79739540 !ruby/object:Gem::Requirement
     none: true
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79739540
+- !ruby/object:Gem::Dependency
   name: mailfactory
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &79738860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+        segments:
         - 1
         - 4
         - 0
-        version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79738860
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &79738570 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+        segments:
         - 2
         - 0
-        version: "2.0"
   type: :runtime
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79738570
+- !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &79738230 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+        segments:
         - 0
         - 5
         - 4
-        version: 0.5.4
   type: :runtime
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79738230
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &79737910 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+        segments:
         - 1
         - 1
         - 0
-        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79737910
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &79737670 !ruby/object:Gem::Requirement
     none: true
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
+  version_requirements: *79737670
+- !ruby/object:Gem::Dependency
   name: mattock
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &79737300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+        segments:
+        - 0
+        - 2
+        - 11
+  type: :runtime
+  prerelease: false
+  version_requirements: *79737300
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: &79736970 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+        segments:
+        - 3
+        - 1
+  type: :runtime
+  prerelease: false
+  version_requirements: *79736970
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: &79736650 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.2.10
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.1
   type: :runtime
   prerelease: false
-  version_requirements: *id010
-description: "  A corundum is a synthetic gemstone - including synthetic rubies.  Ergo: a tool for synthesizing gems.\n\n  Corundum starts with the outlook that gemspecs are relatively easy to work with, and that the opinion of the RubyGems team is that they should be treated as a configuration file, not a code file.  Furthermore, Rake is a powerful, easy to use tool, and does admit the use of Ruby code to get the job done.\n\n  The hard part about publishing gems is getting them into a state you'll be proud of.  There's dozens of fiddly steps to putting together a gem fit for public consumption, and it's very easy to get some of them wrong.\n\n  Corundum is a collection of Rake tasklibs, therefore, that will perform the entire process of releasing gems, including QA steps up front through generating and publishing documentation.\n"
-email: 
+  version_requirements: *79736650
+description: ! "  A corundum is a synthetic gemstone - including synthetic rubies.
+  \ Ergo: a tool for synthesizing gems.\n\n  Corundum starts with the outlook that
+  gemspecs are relatively easy to work with, and that the opinion of the RubyGems
+  team is that they should be treated as a configuration file, not a code file.  Furthermore,
+  Rake is a powerful, easy to use tool, and does admit the use of Ruby code to get
+  the job done.\n\n  The hard part about publishing gems is getting them into a state
+  you'll be proud of.  There's dozens of fiddly steps to putting together a gem fit
+  for public consumption, and it's very easy to get some of them wrong.\n\n  Corundum
+  is a collection of Rake tasklibs, therefore, that will perform the entire process
+  of releasing gems, including QA steps up front through generating and publishing
+  documentation.\n"
+email:
 - nyarly@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- doc/README
 - doc/Specifications
 - doc/coverage/index.html
 - doc/coverage/assets/0.5.3/highlight.css
@@ -196,7 +233,7 @@ extra_rdoc_files:
 - doc/coverage/assets/0.5.3/jquery.timeago.js
 - doc/coverage/assets/0.5.3/loading.gif
 - doc/coverage/assets/0.5.3/jquery-1.6.2.min.js
-files: 
+files:
 - lib/corundum.rb
 - lib/corundum/configuration-store.rb
 - lib/corundum/core.rb
@@ -227,6 +264,7 @@ files:
 - spec_help/gem_test_suite.rb
 - spec_help/ungemmer.rb
 - spec_help/file-sandbox.rb
+- doc/README
 - doc/Specifications
 - doc/coverage/index.html
 - doc/coverage/assets/0.5.3/highlight.css
@@ -279,35 +317,34 @@ files:
 - doc/coverage/assets/0.5.3/loading.gif
 - doc/coverage/assets/0.5.3/jquery-1.6.2.min.js
 homepage: http://nyarly.github.com/corundum/
-licenses: 
+licenses:
 - MIT
 post_install_message: Another tidy package brought to you by Judson
-rdoc_options: 
+rdoc_options:
 - --title
-- corundum-0.0.15 RDoc
-require_paths: 
+- corundum-0.0.16 RDoc
+require_paths:
 - lib/
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 522495789
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 241424621
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: corundum
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Tools for synthesizing rubygems
-test_files: 
+test_files:
 - spec_help/gem_test_suite.rb