xbel 0.1.0 → 0.1.1

data/.watchr

@@ -0,0 +1,47 @@
+require 'open3'
+
+Dir.chdir File.dirname(__FILE__)
+
+watch(/(?:lib|test).*\.rb$/)  { |something|
+
+  Dir['lib/**/*.rb'].inject(true) do |check, path|
+    Open3.popen3('ruby', '-c', path) { |_, o, stderr|
+      errors = stderr.read
+
+      if errors.empty? then check
+      else
+        puts errors
+        false
+      end
+    }
+  end and begin
+  
+    messages = Dir['test/**/test_*.rb'].inject([]) do |messages, path|
+      if path !~ /test_helper\.rb$/
+        Open3.popen3('rake test') do |_, o, e|
+          puts e.read, message = o.read
+
+          result = message.split($/).last
+          tests, assertions, failures, errors =
+              result.split(', ').map! { |r| r.to_i }
+
+          failures ||= 0
+          errors ||= 0
+
+          unless failures.zero? and errors.zero?
+#            Open3.popen3(bad_message) { |i, *| i << message[0, 160] }
+          else
+#            system(good_message)
+          end
+
+          messages << message
+        end
+      end
+
+      messages
+    end
+
+
+  end
+
+}

data/README.markdown

@@ -0,0 +1,21 @@
+# xbel
+
+Introduces XBEL decorations for Nokogiri. Write support is still in
+development.
+
+## Installation
+
+    gem install xbel
+
+### Note on Patches/Pull Requests
+ 
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a
+   future version unintentionally.
+4. Commit, do not mess with rakefile, version, or history.
+5. Send me a pull request.
+
+### Copyright
+
+Copyright (c) 2009 Florian Aßmann. See LICENSE for details.

data/Rakefile

@@ -8,7 +8,7 @@ begin
     gem.summary = %Q{Ruby API for XBEL based on Nokogiri and Watchr.}
     gem.description = %Q{}
     gem.email = "florian.assmann@email.de"
-    gem.homepage = "http://github.com/boof/xbel"
+    gem.homepage = "http://xbel.monkey-patch.me"
     gem.authors = ["Florian Aßmann"]
     gem.add_development_dependency "shoulda", ">= 0"
     gem.add_dependency 'watchr', '>= 0'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/nokogiri/decorators/xbel.rb

@@ -0,0 +1,68 @@
+module Nokogiri::Decorators::XBEL
+
+  autoload :Folder, "#{ File.dirname __FILE__ }/xbel/folder.rb"
+  autoload :Seperator, "#{ File.dirname __FILE__ }/xbel/folder.rb"
+  autoload :Bookmark, "#{ File.dirname __FILE__ }/xbel/bookmark.rb"
+  autoload :Alias, "#{ File.dirname __FILE__ }/xbel/alias.rb"
+
+  def self.extended(base)
+    case base.name
+    when 'title'
+    when 'desc'
+    when 'bookmark'
+      base.extend Bookmark
+    when 'folder'
+      base.extend Folder
+    when 'separator'
+      base.extend Separator
+    when 'alias'
+      base.extend Alias
+    when 'xbel'
+      base.extend Folder
+    end
+  end
+
+  module Entry
+    def desc
+      if node = at('./desc') then node.content end
+    end
+    def desc=(value)
+      node = at './desc'
+      node ||= add_child Nokogiri::XML::Node.new('desc', document)
+
+      node.content = value
+    end
+    alias_method :description, :desc
+    alias_method :description=, :desc=
+
+    def title
+      if node = at('./title') then node.content end
+    end
+    def title=(value)
+      node = at './title'
+      node ||= add_child Nokogiri::XML::Node.new('title', document)
+
+      node.content = value
+    end
+    alias_method :to_s, :title
+
+    def id
+      if id = attribute('id') then id.content end
+    end
+    def id=(value)
+      set_attribute 'id', value.to_s
+    end
+
+    def added
+      if value = attribute('added') then Date.parse value.content end
+    end
+    def added=(value)
+      set_attribute 'added', value.to_s
+    end
+
+    def alias?; end
+    def bookmark?; end
+    def folder?; end
+  end
+
+end

data/lib/nokogiri/decorators/xbel/alias.rb

@@ -0,0 +1,25 @@
+module Nokogiri::Decorators::XBEL
+  module Alias
+    extend Forwardable
+    def_delegators :entry,
+        :description, :title, :to_s, :id, :added, :bookmark?, :folder?
+
+    def ref
+      attribute('ref').content
+    end
+    def ref=(value)
+      set_attribute 'ref', value.to_s
+    end
+    alias_method :reference, :ref
+    alias_method :reference=, :ref=
+
+    def entry
+      at %Q'//*[@id="#{ ref }"]'
+    end
+
+    def alias?
+      true
+    end
+
+  end
+end

data/lib/nokogiri/decorators/xbel/bookmark.rb

@@ -0,0 +1,32 @@
+module Nokogiri::Decorators::XBEL
+  module Bookmark
+    include Entry
+
+    def modified
+      if value = attribute('modified') then Date.parse value.content end
+    end
+    def modified=(value)
+      set_attribute 'modified', value.to_s
+    end
+    def visited
+      if value = attribute('visited') then Date.parse value.content end
+    end
+    def visited=(value)
+      set_attribute 'visited', value.to_s
+    end
+    def visit
+      self.visited = Date.today
+    end
+    def href
+      if value = attribute('href') then value.content end
+    end
+    def href=(value)
+      self.modified = Date.today
+      set_attribute 'href', value
+    end
+    def bookmark?
+      true
+    end
+
+  end
+end

data/lib/nokogiri/decorators/xbel/folder.rb

@@ -0,0 +1,59 @@
+module Nokogiri::Decorators::XBEL
+  module Folder
+    include Entry
+
+    def entries
+      xpath './alias', './bookmark', './folder', './separator'
+    end
+    def aliases
+      xpath './alias'
+    end
+    def bookmarks
+      xpath './bookmark'
+    end
+    def folders
+      xpath './folder'
+    end
+
+    def folder?
+      true
+    end
+
+    def add_child(node)
+      node.added = Date.today if node.is_a? Entry
+      super
+    end
+
+    def build_bookmark(attributes = {}, &block)
+      node = Nokogiri::XML::Node.new('bookmark', document)
+      assign_to node, attributes
+
+      add_child node
+    end
+    def build_folder(attributes = {}, &block)
+      node = Nokogiri::XML::Node.new('folder', document)
+      assign_to node, attributes
+
+      add_child node
+    end
+    def build_alias(ref)
+      node = Nokogiri::XML::Node.new('alias', document)
+      node.ref = (Entry === ref) ? ref.id : ref.to_s
+
+      add_child node
+    end
+    def add_seperator
+      add_child Nokogiri::XML::Node.new('separator', document)
+    end
+
+    protected
+
+      def assign_to(node, attributes)
+        attributes.each do |key, value|
+          node.send "#{ key }=", value
+        end
+        yield node if block_given?
+      end
+
+  end
+end

data/lib/nokogiri/decorators/xbel/seperator.rb

@@ -0,0 +1,9 @@
+module Nokogiri::Decorators::XBEL
+  module Separator
+
+    def to_s
+      ''
+    end
+
+  end
+end

data/lib/xbel/writer.rb

@@ -0,0 +1,41 @@
+class XBEL::Writer
+  DOCTYPE = '<!DOCTYPE xbel PUBLIC "+//IDN python.org//DTD XML Bookmark Exchange Language 1.0//EN//XML" "http://www.python.org/topics/xml/dtds/xbel-1.0.dtd">'
+
+  attr_reader :document, :lockfile_path, :path
+  def new(document, path)
+    @document, @path = document, path
+    @lockfile_path = "#{ path }.lock"
+  end
+
+  def write
+    synchronize do
+      File.open path, 'w' do |file|
+        file.puts DOCTYPE
+        file << document
+      end
+    end
+  end
+
+  protected
+
+    def locked?(path)
+      File.exists? lockfile_path
+    end
+    def lock
+      File.open(lockfile_path, 'w') { |*| yield }
+    ensure
+      File.unlink lockfile_path
+    end
+
+    def synchronize
+      current_thread = Thread.current
+
+      while locked?
+        watch(lockfile_path, :delete) { |*| current_thread.run }
+        current_thread.sleep
+      end
+
+      lock { yield }
+    end
+
+end

data/test/complex.xbel

@@ -0,0 +1,165 @@
+<?xml version="1.0"?>
+<!DOCTYPE xbel PUBLIC "+//IDN python.org//DTD XML Bookmark Exchange
+Language 1.0//EN//XML"
+"http://www.python.org/topics/xml/dtds/xbel-1.0.dtd">
+<xbel version="1.0">
+  <title>Some of David's Bookmarks</title>
+
+  <folder>
+    <title>HTTP Clients</title>
+
+    <bookmark href="http://www.netscape.com/download/" id="bookmark-1">
+      <title>Netscape</title>
+
+      <desc>Netscape 6.2 is the latest update to the Internet
+      browsing, email and instant messagin software suite from
+      Netscape.</desc>
+    </bookmark>
+
+    <bookmark href="http://www.opera.com/">
+      <title>Opera</title>
+
+      <desc>Opera -- Simply the Best Internet Experience</desc>
+    </bookmark>
+
+    <alias ref="bookmark-5"></alias>
+
+    <bookmark href="http://www.microsoft.com/ie/">
+      <title>Microsoft Internet Explorer</title>
+
+      <desc>Internet Explorer 6 sets a new standard in privacy,
+      reliability, and flexibility. Come see how Internet Explorer
+      is leading the way on the Web.</desc>
+    </bookmark>
+
+    <bookmark href="http://lynx.browser.org/">
+      <title>Lynx</title>
+
+      <desc>Lynx is a fully-featured World Wide Web (WWW) client
+      for users running cursor-addressable, character-cell display
+      devices (e.g., vt100 terminals, vt100 emulators running on
+      PCs or Macs, or any other character-cell display). It will
+      display Hypertext Markup Language (HTML) documents containing
+      links to files on the local system, as well as files on
+      remote systems running http, gopher, ftp, wais, nntp, finger,
+      or cso/ph/qi servers, and services accessible via logins to
+      telnet, tn3270 or rlogin accounts. Current versions of Lynx
+      run on Unix, VMS, Windows95/NT, 386DOS and OS/2 EMX.</desc>
+    </bookmark>
+
+    <bookmark href="http://www.w3.org/Amaya/" id="bookmark-5">
+      <title>Amaya</title>
+
+      <desc>Amaya is a browser/authoring tool that allows you to
+      publish documents on the Web. It is used to demonstrate and
+      test many of the new developments in Web protocols and data
+      formats. Given the very fast moving nature of Web technology,
+      Amaya has a central role to play. It is versatile and
+      extensible and is available on both Unix and Windows '95/NT
+      platforms.</desc>
+    </bookmark>
+
+    <alias ref="bookmark-1"></alias>
+
+  </folder>
+
+  <folder>
+    <title>Extensible Markup Language (XML)</title>
+
+    <bookmark
+    href="http://www.sciam.com/1999/0599issue/0599bosak.html">
+      <title>Scientific American: Feature Article: XML and the
+      Second Generation Web: May 1999</title>
+
+      <desc>The combination of hypertext and a global Internet
+      started a revolution. A new ingredient, XML, is poised to
+      finish the job. by Jon Bosak and Tim Bray</desc>
+
+    </bookmark>
+
+    <bookmark
+    href="http://www.sciam.com/2001/0501issue/0501berners-lee.html">
+
+      <title>Scientific American: Feature Article: The Semantic
+      Web: May 2001</title>
+
+      <desc>A new form of Web content that is meaningful to
+      computers will unleash a revolution of new possibilities . by
+      TIM BERNERS-LEE, JAMES HENDLER and ORA LASSILA</desc>
+    </bookmark>
+
+    <bookmark href="http://www.w3.org/XML/1999/XML-in-10-points">
+
+      <title>XML in 10 Points</title>
+    </bookmark>
+
+    <folder>
+      <title>Building XML Documents</title>
+
+      <bookmark
+      href="http://www.webreview.com/2000/08_04/webauthors/08_04_00_4.shtml">
+
+        <title>Well-Formed XML Documents (webreview.com)</title>
+
+        <desc>Still trying to tame the XML beast? Begin with this
+        tutorial that will show you in clear terms how to build a
+        simple XML document that is well-formed and valid.</desc>
+      </bookmark>
+    </folder>
+
+    <folder>
+      <title>RSS</title>
+
+      <bookmark
+      href="http://www.webreference.com/authoring/languages/xml/rss/intro/">
+
+        <title>Introduction to RSS - WebReference.com</title>
+
+        <desc>Rich Site Summary (RSS) is a lightweight XML format
+        designed for sharing headlines and other Web
+        content.</desc>
+      </bookmark>
+
+      <bookmark
+      href="http://www.WebReview.com/1999/10_29/webauthors/10_29_99_2a.shtml">
+
+        <title>WebReview.com: RSS Delivers the XML Promise</title>
+
+        <desc>RSS is a content syndication format that uses the
+        power of XML to share data over the Internet.</desc>
+      </bookmark>
+    </folder>
+
+    <folder>
+      <title>Extensible Stylesheet Language (XSL)</title>
+
+      <bookmark
+      href="http://www.webreview.com/2001/08_03/developers/index01.shtml">
+
+        <title>WebReview.com: August 3, 2001: Introduction to
+        XSLT</title>
+
+        <desc>An introduction to XSLT</desc>
+      </bookmark>
+    </folder>
+
+    <folder>
+      <title>Recommended Books</title>
+
+      <bookmark href="http://www.oreilly.com/catalog/learnxml/">
+        <title>Learning XML : (Guide to) Creating Self-Describing
+        Data</title>
+
+        <desc>Eric T. Ray, (O'Reilly)</desc>
+      </bookmark>
+
+      <bookmark
+      href="http://www.amazon.com/exec/obidos/ASIN/0789725045/">
+        <title>XML By Example</title>
+
+        <desc>Benoit Marchal</desc>
+      </bookmark>
+    </folder>
+  </folder>
+</xbel>
+

data/test/test_xbel.rb

@@ -10,7 +10,7 @@ class TestXBEL < Test::Unit::TestCase
       assert_equal [1, 0], xbel.version
     end
     should "have title 'Some of David's Bookmarks'" do
-      assert_equal %Q"Some of David's Bookmarks", xbel.title
+      assert_equal %Q{Some of David's Bookmarks}, xbel.title
     end
     should "return all root folders" do
       results = xbel.root.folders
@@ -21,7 +21,9 @@ class TestXBEL < Test::Unit::TestCase
     should "return all bookmarks of 'HTTP Clients'" do
       results = xbel.root.folders.first.bookmarks
       results = results.map { |entry| entry.title }
-      expect = ['Netscape', 'Opera', 'Microsoft Internet Explorer', 'Lynx', 'Amaya']
+      expect = [
+          'Netscape', 'Opera', 'Microsoft Internet Explorer', 'Lynx', 'Amaya'
+      ]
       assert_equal expect, results
     end
     should "return aliased bookmark" do

data/xbel.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{xbel}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Florian A\303\237mann"]
+  s.date = %q{2009-10-28}
+  s.description = %q{}
+  s.email = %q{florian.assmann@email.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".watchr",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/nokogiri/decorators/xbel.rb",
+     "lib/nokogiri/decorators/xbel/alias.rb",
+     "lib/nokogiri/decorators/xbel/bookmark.rb",
+     "lib/nokogiri/decorators/xbel/folder.rb",
+     "lib/nokogiri/decorators/xbel/seperator.rb",
+     "lib/xbel.rb",
+     "lib/xbel/writer.rb",
+     "test/complex.xbel",
+     "test/helper.rb",
+     "test/test_xbel.rb",
+     "xbel.gemspec"
+  ]
+  s.homepage = %q{http://xbel.monkey-patch.me}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby API for XBEL based on Nokogiri and Watchr.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_xbel.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<watchr>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<watchr>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<watchr>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xbel
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Florian A\xC3\x9Fmann"
@@ -50,19 +50,28 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
+- .watchr
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
+- lib/nokogiri/decorators/xbel.rb
+- lib/nokogiri/decorators/xbel/alias.rb
+- lib/nokogiri/decorators/xbel/bookmark.rb
+- lib/nokogiri/decorators/xbel/folder.rb
+- lib/nokogiri/decorators/xbel/seperator.rb
 - lib/xbel.rb
+- lib/xbel/writer.rb
+- test/complex.xbel
 - test/helper.rb
 - test/test_xbel.rb
+- xbel.gemspec
 has_rdoc: true
-homepage: http://github.com/boof/xbel
+homepage: http://xbel.monkey-patch.me
 licenses: []
 
 post_install_message: 

data/README.rdoc

@@ -1,18 +0,0 @@
-= xbel
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 Florian Aßmann. See LICENSE for details.