zenweb-autolink 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2012-06-28
+
+* 1 major enhancement:
+
+  * First working version of autolinking pages based on their titles

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/zenweb-autolink.rb
+test/test_zenweb_autolink.rb
+test_site/Rakefile
+test_site/_config.yml
+test_site/_layouts/site.erb
+test_site/page2.html.md
+test_site/page3.html.autolink.md
+test_site/zenweb.html.md

data/README.txt

@@ -0,0 +1,72 @@
+= zenweb-autolink
+
+* Source :: http://github.com/tamc/zenweb-autolink
+
+== DESCRIPTION:
+
+A plugin for zenweb that automatically generates links between pages.
+
+For example: If a page has a title attribute 'my page about zebweb' then
+any other page that contains text like 'see my page about zenweb' would
+have some of the text replaced with a link to that page: 
+'see <a href='/zenweb.html'>my page about zenweb</a>'
+
+== FEATURES/PROBLEMS:
+
+* Only replaces text with links if the text is part of a paragraph or 
+  list (i.e., won't create links in titles or inside other links)
+* Works on any html
+* But, doesn't allow you to specify when links do or don't occur
+
+== SYNOPSIS:
+
+See test_site directory for an example of its usage.
+
+
+1 Add `require 'zenweb-autolink'`
+2 Make sure some of your pages have title attributes (i.e., they have a
+  _config.yml file or config block that has title: tile at the top)
+3 Add the extension .autolink to pages that you want the autolinker to operate on
+  (it is best to put the extension immediately after the '.html' extension)
+
+== REQUIREMENTS:
+
+* Zenweb 3.0.0.b3 or later
+
+== INSTALL:
+
+  sudo gem install zenweb-autolink  
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Tom Counsell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :minitest
+Hoe.plugin :git
+
+Hoe.spec 'zenweb-autolink' do
+  developer 'tamc', 'tamc@greenonblack.com'
+  self.extra_deps << ['zenweb','3.0.0.b3']
+  self.extra_deps << ['nokogiri', '~> 1.5.2']
+end
+
+# vim: syntax=ruby

data/lib/zenweb-autolink.rb

@@ -0,0 +1,79 @@
+require 'zenweb'
+require 'nokogiri'
+
+class ZenwebAutolink
+  VERSION = '0.0.1'
+end
+
+module Zenweb
+  class Site
+
+    # Returns all pages in the site that have a title
+    # configured.
+    def pages_with_titles
+      html_pages.select {|page| page.config["title"] }
+    end
+
+    # Returns all the pages in the site that have a title
+    # as an array of arrays, where each array's first 
+    # element is a regular expression matching the page's
+    # title and the second element is that page itself.
+    # these are sorted so that the longest title is first
+    # e.g., [[/\blong title/i,page1],[/\btitle\b/i,page2]]
+    # FIXME: In the end may want to memoize this
+    def pages_with_titles_as_sorted_regular_expressions
+      pages_with_titles.sort_by do |page|
+        page.title.size
+      end.reverse.map do |page|
+        [/\b#{Regexp.escape(page.title)}\b/i, page]
+      end
+    end
+  end
+
+  class Page
+  
+    # Autolinks any text in the page that matches the 
+    # title of another page on the site
+    def render_autolink page, content
+      autolinked_html content
+    end
+
+    # Take the html and creates links to from any text
+    # that matches a page's title to that page. Note that
+    # it is reasonably intelligent and only makes the 
+    # link if the text isn't already linked and is inside
+    # a span, b, p or li element.
+    # FIXME: Make it possible to override the elements
+    # in which it is acceptable to autolink
+    def autolinked_html(html)
+      nodes = Nokogiri::HTML::fragment(html)
+      acceptable_nodes_for_autolinking = %w{p li b em i}
+        nodes.traverse do |node|
+        next unless node.text?
+        next unless acceptable_nodes_for_autolinking.include?(node.parent.name)
+        node.replace(autolinked_html_fragment(node.text))
+      end
+      nodes.to_html
+    end
+    
+    # Takes a fragment of text and creates links from any 
+    # text that matches a page's title in that text. It 
+    # matches the longest titles first.
+    # FIXME: Need a way of dealing with duplicate titles
+    def autolinked_html_fragment(text)
+      links = []
+      site.pages_with_titles_as_sorted_regular_expressions.each do |regexp,page|
+        next if page == self
+        next if page.title.length > text.length
+        text.gsub!(regexp) do |match|
+          links << "<a href='#{page.url}'>#{match}</a>"
+          "%!#{links.size-1}!%"
+        end
+      end
+      text.gsub!(/%!(\d+)!%/) do |match|
+        links[$1.to_i]
+      end
+      text
+    end
+  end
+end

data/test/test_zenweb_autolink.rb

@@ -0,0 +1,50 @@
+require "test/unit"
+require "zenweb-autolink"
+
+class TestZenwebAutolink < Test::Unit::TestCase
+
+  attr_accessor :site, :page
+
+  def setup
+    @old_working_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__),'..','test_site'))
+    self.site = Zenweb::Site.new
+    site.scan
+    site.wire
+    self.page = site.html_pages.find { |p| p.title == 'Example Page 3' }
+  end
+
+  def teardown
+    Dir.chdir(@old_working_dir)
+  end
+
+  def test_pages_with_titles
+    assert_equal 3, site.pages_with_titles.size
+  end
+
+  def test_pages_with_titles_as_sorted_regular_expressions
+    regular_expresions = site.pages_with_titles_as_sorted_regular_expressions
+    assert_equal '/\bExample\\ Page\\ 2\b/i', regular_expresions.first.first.inspect
+    assert_kind_of Zenweb::Page, regular_expresions.first.last
+    assert_equal '/\bZenweb\b/i', regular_expresions.last.first.inspect
+  end
+
+  def test_autolinked_html_fragment
+    actual = page.autolinked_html_fragment("zenweb")
+    expected = "<a href='/zenweb.html'>zenweb</a>"
+    assert_equal expected, actual
+  end
+
+  def test_autolinked_html
+    actual = page.autolinked_html("<h1>zenweb</h1><p>zenweb</p>")
+    expected = '<h1>zenweb</h1><p><a href="/zenweb.html">zenweb</a></p>'
+    assert_equal expected, actual
+  end
+
+  def test_render_autolink
+    actual = page.render
+    expected = %r|<p>Not really much here to see except a link to <a href="/page2\.html">example page 2</a>\.</p>|
+    assert actual =~ expected
+  end
+
+end

data/test_site/Rakefile

@@ -0,0 +1,3 @@
+require 'zenweb'
+require_relative '../lib/zenweb-autolink'
+Rake.application.rake_require "zenweb/tasks"

data/test_site/_config.yml

@@ -0,0 +1 @@
+layout: site

data/test_site/_layouts/site.erb

@@ -0,0 +1,7 @@
+---
+layout: nil
+...
+<html>
+  <head><title><%= page.title || "No title" %> </title></head>
+  <body><%= content %></body>
+</html>

data/test_site/page2.html.md

@@ -0,0 +1,5 @@
+---
+title: Example Page 2
+...
+
+This is my Résumé.

data/test_site/page3.html.autolink.md

@@ -0,0 +1,5 @@
+---
+title: Example Page 3
+...
+
+Not really much here to see except a link to example page 2.

data/test_site/zenweb.html.md

@@ -0,0 +1,5 @@
+---
+title: Zenweb
+...
+
+Not really much here to see.

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: zenweb-autolink
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tamc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zenweb
+  requirement: &70219613929400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.0.0.b3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219613929400
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70219613928960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219613928960
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70219613928520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70219613928520
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70219613928080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70219613928080
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &70219613927640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70219613927640
+description: ! "A plugin for zenweb that automatically generates links between pages.\n\nFor
+  example: If a page has a title attribute 'my page about zebweb' then\nany other
+  page that contains text like 'see my page about zenweb' would\nhave some of the
+  text replaced with a link to that page: \n'see <a href='/zenweb.html'>my page about
+  zenweb</a>'"
+email:
+- tamc@greenonblack.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/zenweb-autolink.rb
+- test/test_zenweb_autolink.rb
+- test_site/Rakefile
+- test_site/_config.yml
+- test_site/_layouts/site.erb
+- test_site/page2.html.md
+- test_site/page3.html.autolink.md
+- test_site/zenweb.html.md
+- .gemtest
+homepage: http://github.com/tamc/zenweb-autolink
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: zenweb-autolink
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A plugin for zenweb that automatically generates links between pages
+test_files:
+- test/test_zenweb_autolink.rb