TwP-webby 0.9.3 → 0.9.4

data/lib/webby/link_validator.rb

@@ -56,18 +56,18 @@ class LinkValidator
     @log.info "validating #{fn}"
 
     dir = ::File.dirname(fn)
-    @doc = Hpricot(::File.read(fn))
+    doc = Hpricot(::File.read(fn))
 
     ::Webby.site.xpaths.each do |xpath|
       @attr_name = nil
 
-      @doc.search(xpath).each do |element|
-        @attr_name ||= @attr_rgxp.match(xpath)[1]
-        uri = URI.parse(element.get_attribute(@attr_name))
-        validate_uri(uri, dir)
+      doc.search(xpath).each do |element|
+        attr_name ||= @attr_rgxp.match(xpath)[1]
+        uri = URI.parse(element.get_attribute(attr_name))
+        validate_uri(uri, dir, doc)
       end
     end
-    @doc = @attr_name = nil
+    return nil # side effect of original implementation
   end
 
   # Validate the the page the _uri_ refers to actually exists. The directory
@@ -80,54 +80,15 @@ class LinkValidator
   # will only take place if the LinkValidator was created with the :external
   # flag set to true.
   #
-  def validate_uri( uri, dir )
-    # for relative URIs, we can see if the file exists in the output folder
-    if uri.relative?
-      return validate_anchor(uri, @doc) if uri.path.empty?
-
-      path = if uri.path =~ %r/^\//
-          ::File.join(::Webby.site.output_dir, uri.path)
-        else
-          ::File.join(dir, uri.path)
-        end
-      path = ::File.join(path, 'index.html') if ::File.extname(path).empty?
-
-      uri_str = path.dup
-      (uri_str << '#' << uri.fragment) if uri.fragment
-      return if @valid_uris.include? uri_str
-
-      if test ?f, path
-        valid = if uri.fragment
-            validate_anchor(uri, Hpricot(::File.read(path)))
-          else true end
-        @valid_uris << uri_str if valid
-      else
-        @log.error "invalid URI '#{uri.to_s}'"
-      end
-
-    # if the URI responds to the open mehod, then try to access the URI
-    elsif uri.respond_to? :open
-      return unless @validate_externals
-      return if @valid_uris.include? uri.to_s
+  def validate_uri( uri, dir, doc )
+    # do not retry external uris that have already been validated
+    return if @valid_uris.include? uri.to_s
 
-      if @invalid_uris.include? uri.to_s
-        @log.error "could not open URI '#{uri.to_s}'"
-        return
-      end
-
-      begin
-        uri.open {|_| nil}
-        @valid_uris << uri.to_s
-      rescue Exception
-        @log.error "could not open URI '#{uri.to_s}'"
-        @invalid_uris << uri.to_s
-      end 
+    return validate_relative_uri(uri, dir, doc) if uri.relative?
+    return validate_external_uri(uri, dir, doc) if uri.respond_to? :open
 
     # otherwise, post a warning that the URI could not be validated
-    else
-      return if @valid_uris.include? uri.to_s
-      @log.warn "could not validate URI '#{uri.to_s}'"
-    end
+    @log.warn "could not validate URI '#{uri.to_s}'"
   end
 
   # Validate that the anchor fragment of the URI exists in the given
@@ -146,6 +107,53 @@ class LinkValidator
     else true end
   end
 
+  # Validate that the file pointed to by the relative URI exists in the output
+  # directory. If the URI has an anchor, validate that the anchor exists as
+  # well.
+  #
+  def validate_relative_uri( uri, dir, doc )
+    return validate_anchor(uri, doc) if uri.path.empty?
+
+    path = if uri.path =~ %r/^\//
+        ::File.join(::Webby.site.output_dir, uri.path)
+      else
+        ::File.join(dir, uri.path)
+      end
+    path = ::File.join(path, 'index.html') if ::File.extname(path).empty?
+
+    uri_str = path.dup
+    (uri_str << '#' << uri.fragment) if uri.fragment
+    return if @valid_uris.include? uri_str
+
+    if test ?f, path
+      valid = if uri.fragment
+          validate_anchor(uri, Hpricot(::File.read(path)))
+        else true end
+      @valid_uris << uri_str if valid
+    else
+      @log.error "invalid URI '#{uri.to_s}'"
+    end
+  end
+
+  # Validate that an external URI can be opened
+  #
+  def validate_external_uri( uri, dir, doc )
+    return unless @validate_externals
+
+    if @invalid_uris.include? uri.to_s
+      @log.error "could not open URI '#{uri.to_s}'"
+      return
+    end
+
+    begin
+      uri.open {|_| nil}
+      @valid_uris << uri.to_s
+    rescue Exception
+      @log.error "could not open URI '#{uri.to_s}'"
+      @invalid_uris << uri.to_s
+    end 
+  end
+
 end  # class LinkValidator
 end  # module Webby
 

data/lib/webby/tasks/create.rake

@@ -13,7 +13,10 @@ namespace :create do
       page, title, dir = Webby::Builder.new_page_info
       page = Webby::Builder.create(page, :from => template,
                  :locals => {:title => title, :directory => dir})
-      exec(::Webby.editor, page) unless ::Webby.editor.nil?
+      unless ::Webby.editor.nil?
+        args = [::Webby.editor.split, page].flatten
+        exec(*args)
+      end
     end
   end  # each
 

data/lib/webby/tasks/validate.rake

@@ -1,7 +1,7 @@
 
 namespace :validate do
 
-  desc 'Validate hyperlinks (exclude exteranl sites)'
+  desc 'Validate hyperlinks (exclude external sites)'
   task :internal => :build do
     Webby::LinkValidator.validate(:external => false)
   end

data/lib/webby.rb

@@ -10,7 +10,7 @@ require 'date'
 module Webby
 
   # :stopdoc:
-  VERSION = '0.9.3'   # :nodoc:
+  VERSION = '0.9.4'   # :nodoc:
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   YAML_SEP = '---'
@@ -42,9 +42,9 @@ module Webby
       :blog_dir      => 'blog',
       :tumblog_dir   => 'tumblog',
 
-      # Items for running the heel webserver
+      # Items for running the embedded webserver
       :use_web_server => true,
-      :heel_port      => 4331,
+      :web_port      => 4331,
 
       # Items used to deploy the website
       :user       => ENV['USER'] || ENV['USERNAME'],
@@ -192,6 +192,17 @@ module Webby
     Logging::Logger['Webby'].warn msg
   end
 
+  # Scan the <code>layouts/</code> folder and the <code>content/</code>
+  # folder and create a new Resource object for each file found there.
+  #
+  def self.load_files
+    ::Find.find(site.layout_dir, site.content_dir) do |path|
+      next unless test ?f, path
+      next if path =~ ::Webby.exclude
+      Resources.new path
+    end
+  end
+
 end  # module Webby
 
 

data/spec/data/html/anchor.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Anchor</title>
+  </head>
+  <body>
+    <a href="#anchor"></a>
+    <a id="anchor"></a>
+  </body>
+</html>

data/spec/data/html/external.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Anchor</title>
+  </head>
+  <body>
+    <a href="http://www.google.com"></a>
+  </body>
+</html>

data/spec/data/html/invalid-relative.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Anchor</title>
+  </head>
+  <body>
+    <a href="/invalid.html"></a>
+  </body>
+</html>

data/spec/data/html/relative-anchor.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Anchor</title>
+  </head>
+  <body>
+    <a href="/anchor.html#anchor"></a>
+  </body>
+</html>

data/spec/data/html/relative-invalid-anchor.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Anchor</title>
+  </head>
+  <body>
+    <a href="/anchor.html#invalid"></a>
+  </body>
+</html>

data/spec/data/html/relative.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Anchor</title>
+  </head>
+  <body>
+    <a href="/anchor.html"></a>
+  </body>
+</html>

data/spec/spec_helper.rb

@@ -7,6 +7,13 @@ require 'rubygems'
 require 'fileutils'
 require 'stringio'
 
+begin
+  require 'fake_web'
+  $test_externals = true
+rescue LoadError
+  $test_externals = false
+end
+
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib webby]))
 

data/spec/webby/filters/maruku_spec.rb

@@ -0,0 +1,31 @@
+
+require ::File.expand_path(
+    ::File.join(::File.dirname(__FILE__), %w[.. .. spec_helper]))
+
+# ---------------------------------------------------------------------------
+describe 'Webby::Filters::Maruku' do
+
+  it 'should regsiter the maruku filter handler' do
+    Webby::Filters._handlers['maruku'].should_not be_nil
+  end
+
+  if try_require('maruku')
+
+    it 'processes maruku markup into HTML' do
+      input = "## Heading Two\n\nAnd some text about this heading."
+      output = Webby::Filters._handlers['maruku'].call(input)
+
+      output.should == %Q{<h2 id='heading_two'>Heading Two</h2>\n\n<p>And some text about this heading.</p>}
+    end
+
+  else
+
+    it 'raises an error when maruku is used but not installed' do
+      input = "## Heading Two\n\nAnd some text about this heading."
+      lambda {Webby::Filters._handlers['maruku'].call(input)}.should raise_error(Webby::Error, "'maruku' must be installed to use the maruku filter")
+    end
+
+  end
+end
+
+# EOF

data/spec/webby/filters/textile_spec.rb

@@ -9,11 +9,22 @@ describe 'Webby::Filters::Textile' do
     Webby::Filters._handlers['textile'].should_not be_nil
   end
 
-  it 'processes textile markup into HTML' do
-    input = "p(foo). this is a paragraph of text"
-    output = Webby::Filters._handlers['textile'].call(input)
+  if try_require('redcloth')
+
+    it 'processes textile markup into HTML' do
+      input = "p(foo). this is a paragraph of text"
+      output = Webby::Filters._handlers['textile'].call(input)
+
+      output.should == %q{<p class="foo">this is a paragraph of text</p>}
+    end
+
+  else
+
+    it 'raises an error when RedCloth is used but not installed' do
+      input = "p(foo). this is a paragraph of text"
+      lambda {Webby::Filters._handlers['textile'].call(input)}.should raise_error(Webby::Error, "'RedCloth' must be installed to use the textile filter")
+    end
 
-    output.should == %q{<p class="foo">this is a paragraph of text</p>}
   end
 end
 

data/spec/webby/link_validator_spec.rb

@@ -0,0 +1,154 @@
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. spec_helper]))
+
+# ---------------------------------------------------------------------------
+describe Webby::LinkValidator do
+  before do
+    @validator = Webby::LinkValidator.new
+    @@old = Webby.site.output_dir
+    Webby.site.output_dir = Webby.datapath('html')
+  end
+
+  after do
+    Webby.site.output_dir = @@old
+  end
+
+  describe ".validate" do
+    it "passes options to a new validator" do
+      new_validator = stub('validator', :validate => true)
+      Webby::LinkValidator.should_receive(:new).with(:options).and_return(new_validator)
+      Webby::LinkValidator.validate(:options)
+    end
+
+    it "checks each file" do
+      #TODO: test fake site
+      files = ["a file", "another file"]
+      Dir.stub!(:glob).and_return(files)
+
+      validator = Webby::LinkValidator.new
+      files.each do |file|
+        validator.should_receive(:check_file).with(file)
+      end
+      validator.validate
+    end
+  end
+
+  describe "checking a file" do
+    describe "with an anchor" do
+      before do
+        @filename = Webby.datapath('html', 'anchor.html')
+      end
+
+      it "validates the anchor" do
+        @validator.should_receive(:validate_anchor)
+        @validator.check_file(@filename)
+      end
+
+      it "does not add the file to the valid uri list" do
+        lambda { @validator.check_file(@filename) }.should_not change(@validator.instance_variable_get('@valid_uris'), :size)
+      end
+
+      it "***CURRENTLY*** returns nil" do
+        @validator.check_file(@filename).should be_nil
+      end
+    end
+
+    describe "with a valid relative href" do
+      before do
+        @filename = Webby.datapath('html', 'relative.html')
+      end
+
+      it "adds the file to the valid uri list" do
+        lambda { @validator.check_file(@filename) }.should change(@validator.instance_variable_get('@valid_uris'), :size).by(1)
+      end
+
+      it "***CURRENTLY*** returns nil" do
+        @validator.check_file(@filename).should be_nil
+      end
+    end
+
+    describe "with an invalid relative href" do
+      before do
+        @filename = Webby.datapath('html', 'invalid-relative.html')
+      end
+
+      it "does not add the file to the invalid uri list" do
+        lambda { @validator.check_file(@filename) }.should_not change(@validator.instance_variable_get('@valid_uris'), :size)
+      end
+
+      it "***CURRENTLY*** returns nil" do
+        @validator.check_file(@filename).should be_nil
+      end
+    end
+
+    describe "with a valid relative href that contains an anchor" do
+      before do
+        @filename = Webby.datapath('html', 'relative-anchor.html')
+      end
+
+      it "adds the file to the valid uri list" do
+        lambda { @validator.check_file(@filename) }.should change(@validator.instance_variable_get('@valid_uris'), :size).by(1)
+      end
+
+      it "***CURRENTLY*** returns nil" do
+        @validator.check_file(@filename).should be_nil
+      end
+    end
+
+    describe "with a valid relative href that contains an invalid anchor" do
+      before do
+        @filename = Webby.datapath('html', 'relative-invalid-anchor.html')
+      end
+
+      it "does not the file to the valid uri list" do
+        lambda { @validator.check_file(@filename) }.should_not change(@validator.instance_variable_get('@valid_uris'), :size)
+      end
+
+      it "***CURRENTLY*** returns nil" do
+        @validator.check_file(@filename).should be_nil
+      end
+    end
+
+    if $test_externals
+      describe "with a valid external href" do
+        before do
+          FakeWeb.register_uri('http://www.google.com/', :string => 'google')
+          @filename = Webby.datapath('html', 'external.html')
+          @validator.validate_externals = true
+        end
+
+        it "adds the file to the valid uri list" do
+          lambda { @validator.check_file(@filename) }.should change(@validator.instance_variable_get('@valid_uris'), :size).by(1)
+        end
+
+        it "does not add the file to the invalid uri list" do
+          lambda { @validator.check_file(@filename) }.should_not change(@validator.instance_variable_get('@invalid_uris'), :size)
+        end
+
+        it "***CURRENTLY*** returns nil" do
+          @validator.check_file(@filename).should be_nil
+        end
+      end
+
+      describe "with an invalid external href" do
+        before do
+          FakeWeb.register_uri('http://www.google.com/', :string => 'google', :status => [ 404, "Not Found" ])
+          @filename = Webby.datapath('html', 'external.html')
+          @validator.validate_externals = true
+        end
+
+        it "does not add the file to the valid uri list" do
+          lambda { @validator.check_file(@filename) }.should_not change(@validator.instance_variable_get('@valid_uris'), :size)
+        end
+
+        it "adds the file to the invalid uri list" do
+          lambda { @validator.check_file(@filename) }.should change(@validator.instance_variable_get('@invalid_uris'), :size).by(1)
+        end
+
+        it "***CURRENTLY*** returns nil" do
+          @validator.check_file(@filename).should be_nil
+        end
+      end
+    end
+  end
+end

data/tasks/mswin32.rake

@@ -0,0 +1,38 @@
+
+require 'find'
+
+namespace 'gem:mswin32' do
+
+  win32_spec = PROJ.gem._spec.dup
+  win32_spec.platform = 'x86-mswin32'
+  win32_spec.files = PROJ.gem.files
+
+  pkg = Bones::GemPackageTask.new(win32_spec)
+  class << pkg
+    def package_dir_path() "#{package_dir}/#{package_name}-x86-mswin32"; end
+  end
+  pkg.define
+
+  file "#{pkg.package_dir_path}/#{pkg.gem_file}" => :unix2dos
+
+  task :unix2dos do
+    reject = %w[.gif .jpg .jpeg]
+    Find.find(File.join(pkg.package_dir_path, 'examples')) do |fn|
+      next unless test(?f, fn)
+      next if reject.include?(File.extname(fn))
+      sh %{unix2dos #{fn}}
+    end
+  end
+end  # namespace 'gem:mswin32'
+
+
+task :gem => 'gem:mswin32:package'
+task :clobber => 'gem:mswin32:clobber_package'
+
+remove_desc_for_task(%w[
+  gem:mswin32:clobber_package
+  gem:mswin32:package
+  gem:mswin32:repackage
+])
+
+# EOF

data/tasks/website.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 namespace :website do