linky 0.0.1

data/README.markdown

@@ -0,0 +1,20 @@
+# Linky
+
+A simple gem for safely linking keywords within HTML (i.e., it's more than a `gsub`). Built on top of Nokogiri. 
+
+## Installation
+
+    $ gem install linky
+
+## Usage
+
+Call the `Linky.link` method: 
+
+    require 'linky'
+    html = "<p>link all occurances of the word "more."</p><div>some more text</div>"
+    Linky.link "more", "http://more.com", html, :class => "linky"
+    # returns "<p>link the word "<a href="http://more.com" class="linky">more</a>."</p><div>some <a href="http://more.com" class="linky">more</a> text</div>"
+
+## Docs
+
+Docs are on "rdoc.info":http://rdoc.info

data/lib/linky/linky.rb

@@ -0,0 +1,53 @@
+class Linky
+  class << self
+    # Link a keyword to a target within some HTML. 
+    #   * keyword: what you want linked
+    #   * target: where you want it linked to
+    #   * html: the html you want to look for the keyword in
+    #   * options: any extra attributes (besides href) that you want on the link.
+    #
+    # Here's an example:
+    #
+    #     require 'linky'
+    #     html = "<p>link all occurances of the word "more."</p><div>some more text</div>"
+    #     Linky.link "more", "http://more.com", html, :class => "linky"
+    #     # returns "<p>link the word "<a href="http://more.com" class="linky">more</a>."</p><div>some <a href="http://more.com" class="linky">more</a> text</div>"
+    def link(keyword, target, html, options={})
+      options = options.map {|k,v| %{#{k}="#{v}"}}.join " " 
+      block = proc {|keyword| %{<a href="#{target}" #{options}>#{keyword}</a>}}
+      html_fragment = Nokogiri::HTML::DocumentFragment.parse html
+      real_link keyword.to_s, html_fragment, &block
+      html_fragment.to_html
+    end
+
+    private
+    def real_link(needle, haystack, &block)
+      # if we've drilled down all the way to a raw text node,
+      # and it contains the needle we're looking for
+      if haystack.text? && (match = haystack.content.match(/(#{needle})/i))
+        
+        # call the block to determine what we'll replace the needle with
+        new_needle = block.call match[0]
+       
+        # break the string into three parts
+        prefix, keyword, postfix = break_on_boundary match[0], haystack.to_s 
+        
+        haystack.content = prefix
+        haystack.add_next_sibling Nokogiri::HTML::DocumentFragment.parse(new_needle)
+        if !postfix.nil? and !postfix.empty?
+          haystack.next_sibling.add_next_sibling Nokogiri::HTML::DocumentFragment.parse(postfix)
+          haystack.next_sibling.next_sibling.content = postfix
+        end
+      elsif haystack.name != "a" && haystack.respond_to?(:children)
+        haystack.children.each do |child|
+          real_link needle, child, &block 
+        end
+      end
+    end
+
+    def break_on_boundary(boundary, string)
+      match = string.match /^(.*)(#{boundary})(.*)$/
+      return match[1], match[2], match[3]
+    end
+  end
+end

data/lib/linky.rb

@@ -0,0 +1,2 @@
+require 'nokogiri'
+require 'linky/linky'

data/spec/linky_spec.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift './lib'
+require 'linky'
+
+describe Linky, "#link" do
+  before do
+    @keyword = :keyword
+    @html = "<p>some html with keyword and Keyword and <a href='#'>keyword</a></p>"
+  end
+
+  it "should require a keyword, a target, some html, and potentially options" do
+    proc {Linky.link}.should raise_error
+    proc {Linky.link :keyword}.should raise_error
+    proc {Linky.link :keyword, "http://link.to_somewhere"}.should raise_error
+    proc {Linky.link :keyword, "http://link.to.somewhere", @html, :class => "autolinked"}.should_not raise_error
+  end
+
+  it "should link any keywords not already linked" do
+    new_html = Linky.link(@keyword, "http://link.to.somewhere", @html, :class => "autolinked")
+    new_html.should == "<p>some html with <a href=\"http://link.to.somewhere\" class=\"autolinked\">keyword</a> and Keyword and <a href=\"#\">keyword</a></p>"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: linky
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 113
+        segments: 
+        - 1
+        - 4
+        - 3
+        - 1
+        version: 1.4.3.1
+  type: :runtime
+  version_requirements: *id001
+description: A library for safely linking keywords to urls within HTML content.
+email: moonmaster9000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- lib/linky.rb
+- lib/linky/linky.rb
+- spec/linky_spec.rb
+has_rdoc: true
+homepage: http://github.com/moonmaster9000/linky
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A library for safely linking keywords to urls within HTML content.
+test_files: 
+- spec/linky_spec.rb