webby 0.7.4 → 0.8.0

data/lib/webby/webby_task.rb

@@ -1,15 +1,9 @@
-# $Id: webby_task.rb 106 2008-01-25 04:58:49Z tim_pease $
+# $Id: webby_task.rb 173 2008-02-27 02:58:43Z tim_pease $
 
-begin
-  require 'rake'
-  require 'rake/tasklib'
-rescue LoadError
-  require 'rubygems'
-  raise unless gem 'rake'
-  retry
-end
+require 'rake'
+require 'rake/tasklib'
 
-module Rake
+module Rake  # :nodoc:
 
 # The WebbyTask defines several rake tasks for working with Webby based
 # websites:
@@ -80,6 +74,8 @@ class WebbyTask < TaskLib
     end
   end
 
+  # TODO: modify creation task to handle folders of pages/partials
+
   # Scans the templates directory for any files, and creats a corresponding
   # task for creating a new page based on that template.
   #
@@ -87,25 +83,48 @@ class WebbyTask < TaskLib
     FileList["#{::Webby.site.template_dir}/*"].each do |template|
       name = template.pathmap '%n'
 
-      desc "create a new #{name}"
-      task name do |t|
-        raise "Usage:  rake #{t.name} path" unless ARGV.length == 2
+      # if the file is a partial template
+      if name =~ %r/^_(.*)/
+        name = $1
+        desc "create a new #{name}"
+        task name do |t|
+          raise "Usage:  rake #{t.name} path" unless ARGV.length == 2
 
-        page = t.application.top_level_tasks.pop
-        name = ::Webby::File.basename(page)
-        ext  = ::Webby::File.extname(page)
-        dir  = ::Webby::File.dirname(page)
+          page = t.application.top_level_tasks.pop
+          name = '_' + ::Webby::Resources::File.basename(page)
+          ext  = ::Webby::Resources::File.extname(page)
+          dir  = ::File.dirname(page)
+          dir  = '' if dir == '.'
 
-        if ::Webby.site.create_mode == 'directory'
-          page = ::File.join(::Webby.site.content_dir, name, 'index')
+          page = ::File.join(::Webby.site.content_dir, dir, name)
           page << '.' << (ext.empty? ? 'txt' : ext)
-        else
-          page = ::File.join(::Webby.site.content_dir, page)
-          page << '.txt' if ext.empty?
+
+          ::Webby::Builder.create page, :from => template
         end
 
-        ::Webby::Builder.create page, :from => template
-      end  # task
+      # otherwise it's a normal file
+      else
+        desc "create a new #{name}"
+        task name do |t|
+          raise "Usage:  rake #{t.name} path" unless ARGV.length == 2
+
+          page = t.application.top_level_tasks.pop
+          name = ::Webby::Resources::File.basename(page)
+          ext  = ::Webby::Resources::File.extname(page)
+          dir  = ::File.dirname(page)
+          dir  = '' if dir == '.'
+
+          if ::Webby.site.create_mode == 'directory'
+            page = ::File.join(::Webby.site.content_dir, dir, name, 'index')
+            page << '.' << (ext.empty? ? 'txt' : ext)
+          else
+            page = ::File.join(::Webby.site.content_dir, page)
+            page << '.txt' if ext.empty?
+          end
+
+          ::Webby::Builder.create page, :from => template
+        end  # task
+      end
     end  # each
   end
 

data/spec/spec_helper.rb

@@ -1,6 +1,17 @@
-# $Id: spec_helper.rb 83 2007-12-30 02:22:02Z tim_pease $
+# $Id: spec_helper.rb 155 2008-02-17 00:48:30Z tim_pease $
+
+# Equivalent to a header guard in C/C++
+# Used to prevent the spec helper from being loaded more than once
+unless defined? WEBBY_SPEC_HELPER
+WEBBY_SPEC_HELPER = true
+
+require 'rubygems'
+require 'fileutils'
 
 require File.expand_path(
     File.join(File.dirname(__FILE__), '..', 'lib', 'webby'))
 
+
+end  # unless defined?
+
 # EOF

data/spec/webby/{file_spec.rb → resources/file_spec.rb}

@@ -1,11 +1,11 @@
-# $Id: file_spec.rb 46 2007-11-27 03:31:29Z tim_pease $
+# $Id: file_spec.rb 167 2008-02-24 00:59:54Z tim_pease $
 
-require 'spec/spec_helper.rb'
-require 'fileutils'
+require ::File.join(::File.dirname(__FILE__), %w[.. .. spec_helper])
 
-describe Webby::File do
+# ---------------------------------------------------------------------------
+describe Webby::Resources::File do
 
-  FN = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lorem_ipsum.txt'))
+  FN = ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', 'lorem_ipsum.txt'))
   FN_YAML = FN.gsub %r/\.txt\z/, '_yaml.txt'
   LINES = [
     "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nulla orci\n",
@@ -21,22 +21,22 @@ describe Webby::File do
   ]
 
   before do
-    File.open(FN,'w') {|fd| fd.write LINES}
-    File.open(FN_YAML,'w') do |fd|
+    ::File.open(FN,'w') {|fd| fd.write LINES}
+    ::File.open(FN_YAML,'w') do |fd|
       fd.write "--- \n- one\n- two\n- three\n--- \n"
       fd.write LINES
     end
   end
 
   after do 
-    File.delete FN if File.exists?(FN)
-    File.delete FN_YAML if File.exists?(FN_YAML)
+    ::FileUtils.rm_f(FN)
+    ::FileUtils.rm_f(FN_YAML)
   end
 
   it 'should return nil for meta-data on regular files' do
     begin
-      fd = Webby::File.new FN, 'r'
-      fd.meta_data.should == nil
+      fd = Webby::Resources::File.new FN, 'r'
+      fd.meta_data.should be_nil
 
       fd.readlines.should == LINES
     ensure
@@ -45,16 +45,16 @@ describe Webby::File do
   end
 
   it 'should add meta-data to the top of a file' do
-    Webby::File.open(FN,'a+') do |fd|
-      fd.meta_data.should == nil
+    Webby::Resources::File.open(FN,'a+') do |fd|
+      fd.meta_data.should be_nil
       fd.meta_data = %w(one two three)
     end
 
-    Webby::File.open(FN,'r') do |fd|
+    Webby::Resources::File.open(FN,'r') do |fd|
       fd.meta_data.should == %w(one two three)
     end
 
-    File.open(FN_YAML, 'r') do |fd|
+    ::File.open(FN_YAML, 'r') do |fd|
       ary = LINES.dup
       ary.insert 0, [
         "--- \n",
@@ -68,23 +68,23 @@ describe Webby::File do
   end
 
   it 'should remove the meta-data when set to nil' do
-    Webby::File.open(FN_YAML,'a+') do |fd|
+    Webby::Resources::File.open(FN_YAML,'a+') do |fd|
       fd.meta_data.should == %w(one two three)
       fd.meta_data = nil
     end
 
-    Webby::File.open(FN_YAML,'r') do |fd|
-      fd.meta_data.should == nil
+    Webby::Resources::File.open(FN_YAML,'r') do |fd|
+      fd.meta_data.should be_nil
     end
 
-    File.open(FN_YAML, 'r') do |fd|
+    ::File.open(FN_YAML, 'r') do |fd|
       fd.readlines.should == LINES
     end
   end
 
   it 'should skip the meta-data when reading from the file' do
     begin
-      fd = Webby::File.new FN_YAML, 'r'
+      fd = Webby::Resources::File.new FN_YAML, 'r'
       fd.meta_data.should == %w(one two three)
 
       fd.getc.should == ?L;                        fd.seek 0
@@ -100,7 +100,6 @@ describe Webby::File do
       fd.close
     end
   end
-
-end  # describe Webby::File
+end  # describe Webby::Resources::File
 
 # EOF

data/tasks/ann.rake

@@ -0,0 +1,76 @@
+# $Id$
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  file PROJ.ann_file do
+    puts "Generating #{PROJ.ann_file}"
+    File.open(PROJ.ann_file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      PROJ.ann_paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts PROJ.ann_text if PROJ.ann_text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => PROJ.ann_file
+
+  desc "Send an email announcement"
+  task :email => PROJ.ann_file do
+    from = PROJ.ann_email[:from] || PROJ.email
+    to   = Array(PROJ.ann_email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{PROJ.ann_email[:domain]}>\n\n"
+    rfc822msg << File.read(PROJ.ann_file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      PROJ.ann_email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann_file
+
+# EOF

data/tasks/annotations.rake

@@ -5,23 +5,15 @@ if HAVE_BONES
 desc "Enumerate all annotations"
 task :notes do
   Bones::AnnotationExtractor.enumerate(
-      PROJ, "OPTIMIZE|FIXME|TODO", :tag => true)
+      PROJ, PROJ.annotation_tags.join('|'), :tag => true)
 end
 
 namespace :notes do
-  desc "Enumerate all OPTIMIZE annotations"
-  task :optimize do
-    Bones::AnnotationExtractor.enumerate(PROJ, "OPTIMIZE")
-  end
-
-  desc "Enumerate all FIXME annotations"
-  task :fixme do
-    Bones::AnnotationExtractor.enumerate(PROJ, "FIXME")
-  end
-
-  desc "Enumerate all TODO annotations"
-  task :todo do
-    Bones::AnnotationExtractor.enumerate(PROJ, "TODO")
+  PROJ.annotation_tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do
+      Bones::AnnotationExtractor.enumerate(PROJ, tag)
+    end
   end
 end
 

data/tasks/bones.rake

@@ -0,0 +1,40 @@
+# $Id$
+
+require 'pp'
+require 'stringio'
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if ARGV.length == 2
+      t.application.top_level_tasks.pop
+    end
+    sio = StringIO.new
+    sep = "\n" + ' '*27
+    fmt = "%23s => %s"
+
+    if atr
+      PP.pp(PROJ.send(atr.to_sym), sio, 49)
+      sio.seek 0
+      val = sio.read
+      val = val.split("\n").join(sep)
+
+      puts fmt % [atr, val]
+    else
+      h = PROJ.instance_variable_get(:@table)
+      h.keys.map {|k| k.to_s}.sort.each do |k|
+        sio.truncate 0
+        PP.pp(h[k.to_sym], sio, 49)
+        sio.seek 0
+        val = sio.read
+        val = val.split("\n").join(sep)
+
+        puts fmt % [k, val]
+      end
+    end
+  end
+
+end  # namespace :bones
+
+# EOF

data/tasks/doc.rake

@@ -31,7 +31,6 @@ namespace :doc do
     sh "#{RDOC} --ri -o ri ."
   end
 
-  desc 'Remove ri products'
   task :clobber_ri do
     rm_r 'ri' rescue nil
   end
@@ -44,6 +43,6 @@ task :doc => 'doc:rdoc'
 desc 'Remove all build products'
 task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
 
-remove_desc_for_task %w(doc:clobber_rdoc doc:clobber_ri)
+remove_desc_for_task %w(doc:clobber_rdoc)
 
 # EOF

data/tasks/gem.rake

@@ -12,6 +12,7 @@ namespace :gem do
     s.email = PROJ.email
     s.homepage = Array(PROJ.url).first
     s.rubyforge_project = PROJ.rubyforge_name
+    s.post_install_message = PROJ.post_install_message
 
     s.description = PROJ.description
 
@@ -62,9 +63,29 @@ namespace :gem do
     puts PROJ.spec.to_ruby
   end
 
-  Rake::GemPackageTask.new(PROJ.spec) do |pkg|
+  pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
     pkg.need_tar = PROJ.need_tar
     pkg.need_zip = PROJ.need_zip
+    pkg.package_files += PROJ.spec.files
+  end
+  Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
+
+  gem_file = if PROJ.spec.platform == Gem::Platform::RUBY
+      "#{pkg.package_name}.gem"
+    else
+      "#{pkg.package_name}-#{PROJ.spec.platform}.gem"
+    end
+
+  desc "Build the gem file #{gem_file}"
+  task :package => "#{pkg.package_dir}/#{gem_file}"
+
+  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.spec.files do
+    when_writing("Creating GEM") {
+      Gem::Builder.new(PROJ.spec).build
+      verbose(true) {
+        mv gem_file, "#{pkg.package_dir}/#{gem_file}"
+      }
+    }
   end
 
   desc 'Install the gem'
@@ -74,9 +95,15 @@ namespace :gem do
 
   desc 'Uninstall the gem'
   task :uninstall do
-    sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -x #{PROJ.name}"
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall -v '#{PROJ.version}' -i -x #{PROJ.name}"
+    end
   end
 
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
 end  # namespace :gem
 
 desc 'Alias to gem:package'

data/tasks/manifest.rake

@@ -6,18 +6,11 @@ namespace :manifest do
 
   desc 'Verify the manifest'
   task :check do
-    fn = 'Manifest.tmp'
-    files = []
-    exclude = Regexp.new(PROJ.exclude.join('|'))
-    Find.find '.' do |path|
-      path.sub! %r/^(\.\/|\/)/o, ''
-      next unless test ?f, path
-      next if path =~ exclude
-      files << path
-    end
+    fn = PROJ.manifest_file + '.tmp'
+    files = manifest_files
 
-    File.open(fn, 'w') {|fp| fp.puts files.sort}
-    lines = %x(#{DIFF} -du Manifest.txt #{fn}).split("\n")
+    File.open(fn, 'w') {|fp| fp.puts files}
+    lines = %x(#{DIFF} -du #{PROJ.manifest_file} #{fn}).split("\n")
     if HAVE_FACETS_ANSICODE and ENV.has_key?('TERM')
       lines.map! do |line|
         case line
@@ -34,19 +27,20 @@ namespace :manifest do
 
   desc 'Create a new manifest'
   task :create do
-    fn = 'Manifest.txt'
-    files = []
-    exclude = Regexp.new(PROJ.exclude.join('|'))
-    Find.find '.' do |path|
-      path.sub! %r/^(\.\/|\/)/o, ''
-      next unless test ?f, path
-      next if path =~ exclude
-      files << path
+    files = manifest_files
+    unless test(?f, PROJ.manifest_file)
+      files << PROJ.manifest_file
+      files.sort!
     end
+    File.open(PROJ.manifest_file, 'w') {|fp| fp.puts files}
+  end
 
-    files << fn unless test ?f, fn
-    File.open(fn, 'w') {|fp| fp.puts files.sort}
+  task :assert do
+    files = manifest_files
+    manifest = File.read(PROJ.manifest_file).split($/)
+    raise "ERROR: #{PROJ.manifest_file} is out of date" unless files == manifest
   end
+
 end  # namespace :manifest
 
 desc 'Alias to manifest:check'