xbel 0.2.0 → 0.2.1

data/README.markdown

@@ -1,23 +1,34 @@
 # xbel
 
-Introduces XBEL decorations for Nokogiri. Write support is still in
-development.
+Introduces XBEL decorations for Nokogiri.
 
 ## Installation
 
     gem install xbel
 
-## Use
+## Using
 
     require 'rubygems'
     require 'xbel'
 
-    xbel = XBEL.parse File.read('complex.xbel')
+### Reading
 
-    with_aliases = true # TODO...
-    xbel.root.bookmarks(with_aliases).each { |bm| system 'open', bm.href }
+    XBEL.open('test/wikipedia.xbel')[:f0].bookmarks.
+    map do |bookmark|
+      link_to bookmark.title, bookmark.href
+    end
 
-### Note on Patches/Pull Requests
+### Writing
+
+    xbel = XBEL.new
+    xbel.build_folder 'XBEL' do |folder|
+      folder.build_bookmark "boof's xbel", 'http://github.com/boof/xbel'
+    end
+    File.open('my.xbel', 'w') { |file| file << xbel }
+
+_Note: You can use all Nokogiri::XML::Node methods._
+
+## Patches/Pull Requests:
  
 1. Fork the project.
 2. Make your feature addition or bug fix.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

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

@@ -2,6 +2,10 @@ module Nokogiri::Decorators::XBEL
   module Bookmark
     include Entry
 
+    def self.extended(node)
+      node.initialize_decorator
+    end
+
     def modified
       if value = self['modified'] then Date.parse value end
     end

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

@@ -2,9 +2,13 @@ module Nokogiri::Decorators::XBEL
   module Folder
     include Entry
 
+    def self.extended(node)
+      node.initialize_decorator
+    end
+
     # Returns an instance of NodeSet with all valid children for this folder.
     def entries
-      xpath './alias', './bookmark', './folder', './separator'
+      xpath './alias | ./bookmark | ./folder | ./separator'
     end
     # Returns an instance of NodeSet with all aliases for this folder.
     def aliases
@@ -31,16 +35,17 @@ module Nokogiri::Decorators::XBEL
     end
 
     # Builds a bookmark with given attributes and add it.
-    def build_bookmark(title, attributes = {}, &block)
+    def build_bookmark(title, href, attributes = {}, &block)
       node = Nokogiri::XML::Node.new('bookmark', document)
-      assign_to node, attributes.merge('title' => title)
+      assign_to node, attributes.merge('title' => title, 'href' => href),
+          &block
 
       add_child node
     end
     # Builds a folder with given attributes and add it.
     def build_folder(title, attributes = {}, &block)
       node = Nokogiri::XML::Node.new('folder', document)
-      assign_to node, attributes.merge('title' => title)
+      assign_to node, attributes.merge('title' => title), &block
 
       add_child node
     end

data/lib/nokogiri/decorators/xbel.rb

@@ -1,9 +1,9 @@
 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 :Folder, "#{ File.dirname __FILE__ }/xbel/folder.rb"
   autoload :Alias, "#{ File.dirname __FILE__ }/xbel/alias.rb"
+  autoload :Seperator, "#{ File.dirname __FILE__ }/xbel/folder.rb"
 
   def self.extended(base)
     case base.name
@@ -13,16 +13,28 @@ module Nokogiri::Decorators::XBEL
       base.extend Bookmark
     when 'folder'
       base.extend Folder
-    when 'separator'
-      base.extend Separator
     when 'alias'
       base.extend Alias
+    when 'separator'
+      base.extend Separator
     when 'xbel'
       base.extend Folder
     end
   end
 
   module Entry
+
+    def initialize_decorator
+      @info = Hash.new do |info, owner|
+        if String === owner
+          info[owner] = at "./info/metadata[@owner='#{owner}']"
+        else
+          info[owner.to_s]
+        end
+      end
+    end
+    attr_reader :info
+
     def desc
       if node = at('./desc') then node.content end
     end

data/lib/xbel.rb

@@ -11,6 +11,10 @@ class XBEL < Nokogiri::XML::Document
     parse %Q'<!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="%i.%i"></xbel>' % [major, minor]
   end
 
+  def self.open(path)
+    parse File.read(path.to_s)
+  end
+
   # Use <tt>XBEL.parse(string)</tt> create an instance.
   def initialize(*args)
     super
@@ -18,6 +22,10 @@ class XBEL < Nokogiri::XML::Document
     decorate!
   end
 
+  def [](id)
+    root.at("//*[@id='#{ id }']")
+  end
+
   # Returns an array of version numbers.
   def version
     root.attribute('version').value.split('.').map { |n| n.to_i }

data/test/helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'riot'
+require 'pathname'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_xbel.rb

@@ -23,65 +23,101 @@ end
 context 'XBEL' do
 
   setup do
-    path = File.join "#{ File.dirname __FILE__ }", 'wikipedia.xbel'
-    @xbel = XBEL.parse File.read(path)
+    root = Pathname.new File.dirname(__FILE__)
+    XBEL.open root.join('wikipedia.xbel')
   end
 
-  asserts('version') { @xbel.version }.equals [1, 0]
+  asserts('version') { topic.version }.equals [1, 0]
 
-  asserts("title") { @xbel.title }.equals %q"Lesezeichen!"
-  should('delegate title to root') { @xbel.root.title == @xbel.title }
+  asserts('title') { topic.title }.equals 'Lesezeichen!'
+  should('delegate title accessor to root') do
+    topic.title = 'Bookmarks!'
+
+    topic.title == topic.root.title and
+    topic.title == 'Bookmarks!'
+  end
 
   context 'Alias' do
-    setup { @alias = @xbel.root.aliases.first }
-    should('be an alias') { @alias.alias? }
+    setup { topic.root.aliases.first }
+    should('be an alias') { topic.alias? }
+
+    should('have a reference') do
+      topic.ref and
+      topic.ref == topic.reference
+    end
   end
 
   context 'Folder' do
-    setup { @folder = @xbel.root.folders.first }
+    setup { topic[:f0] }
+    should('be a folder') { topic.folder? }
 
-    asserts('title') { @folder.title }.equals 'Wiki'
-    asserts('entries') { @folder.entries }.kind_of Nokogiri::XML::NodeSet
-    asserts('bookmarks') { @folder.bookmarks }.kind_of Nokogiri::XML::NodeSet
-    asserts('aliases') { @folder.bookmarks }.kind_of Nokogiri::XML::NodeSet
-    should('be a folder') { @folder.folder? }
+    asserts('title') { topic.title }.equals 'Wiki'
+    # TODO: check type with <name>?
+    asserts('entries') { topic.entries }.kind_of Nokogiri::XML::NodeSet
+    asserts('bookmarks') { topic.bookmarks }.kind_of Nokogiri::XML::NodeSet
+    asserts('aliases') { topic.aliases }.kind_of Nokogiri::XML::NodeSet
+    asserts('folders') { topic.folders }.kind_of Nokogiri::XML::NodeSet
 
     context 'Bookmark' do
-      setup { @bookmark = @folder.bookmarks.first }
+      setup { topic.bookmarks.first }
+      should('be a bookmark') { topic.bookmark? }
 
-      asserts('modified attribute') { @bookmark.modified }.kind_of Date
-      asserts('visited') { @bookmark.visited }.kind_of Date
-      asserts('visit') { @bookmark.visit; @bookmark.visited }.equals Date.today
-      should('be a bookmark') { @bookmark.bookmark? }
+      asserts('modified') { topic.modified }.kind_of Date
+
+      asserts('visited') { topic.visited }.kind_of Date
+      asserts('visit') do
+        topic.visit
+        topic.visited
+      end.equals Date.today
     end
     context 'new Bookmark' do
       setup do
-        @bookmark = @folder.build_bookmark 'Bookmark',
-            :href => 'http://www.github.com/boof/xbel', :description => 'desc'
+        topic.build_bookmark "boof's xbel", 'http://www.github.com/boof/xbel',
+            :description => 'Ruby API for XBEL based on Nokogiri.'
       end
+      should('be a bookmark') { topic.bookmark? }
 
-      asserts('added attribute') { @bookmark.added }.equals Date.today
-      asserts('title attribute') { @bookmark.title }.equals 'Bookmark'
-      asserts('href attribute') { @bookmark.href }.
+      asserts('added') { topic.added }.equals Date.today
+      asserts('title') { topic.title }.equals 'boof\'s xbel'
+      asserts('href') { topic.href }.
           equals 'http://www.github.com/boof/xbel'
-      asserts('description attribute') { @bookmark.description }.
-          equals 'desc'
+      asserts('description') { topic.description }.
+          equals 'Ruby API for XBEL based on Nokogiri.'
     end
 
     context 'new Folder' do
-      setup do
-        @subfolder = @folder.build_folder 'subfolder',
-            :id => 'id-2', :desc => 'description'
-      end
-      asserts('added attribute') { @subfolder.added }.equals Date.today
-      asserts('title attribute') { @subfolder.title }.equals 'subfolder'
-      asserts('id attribute') { @subfolder.id }.equals 'id-2'
-      asserts('desc attribute') { @subfolder.desc }.equals 'description'
+      setup { topic.build_folder 'sub', :id => 'id-2', :desc => 'desc' }
+      should('be a folder') { topic.folder? }
+
+      asserts('added') { topic.added }.equals Date.today
+      asserts('title') { topic.title }.equals 'sub'
+      asserts('id') { topic.id }.equals 'id-2'
+      asserts('desc') { topic.desc }.equals 'desc'
     end
 
     context 'new Alias' do
-      setup { @alias = @folder.build_alias @folder }
-      should('reference its folder') { @alias.entry == @folder }
+      setup { topic.build_alias topic }
+      should('be an alias') { topic.alias? }
+
+      should('reference its folder') { topic.entry == topic.parent }
+    end
+
+  end
+
+  context 'Bookmark b0' do
+    setup { topic[:b0] }
+    should('be a bookmark') { topic.bookmark? }
+    
+    context 'Info' do
+      setup { topic.info }
+      should('be a hash') { Hash === topic }
+
+      context 'metadata for xbel' do
+        setup { topic[:xbel] if topic }
+        should('be a node') { Nokogiri::XML::Node === topic }
+
+        should('be have an alias') { not topic.at('./alias').nil? }
+      end
     end
 
   end

data/test/wikipedia.xbel

@@ -1,20 +1,25 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!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">
+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>Lesezeichen!</title>
-  <desc>Lernen von XBEL am Beispiel von zwei Lesezeichen und einer Verknüpfung</desc>
-  <folder id="f0" added="2007-11-10">
-    <title>Wiki</title>
-    <desc>Webseiten von Autoren-Gemeinschaften</desc>
-    <bookmark href="http://wikimediafoundation.org/" id="b0" added="2007-11-11" modified="2007-11-14" visited="2007-11-14">
-      <title>Wikimedia Foundation</title>
-    </bookmark>
-    <bookmark href="http://de.wikipedia.org/" id="b1" added="2007-11-11" modified="2007-11-14" visited="2007-12-27">
-      <title>Wikipedia</title>
-    </bookmark>
-  </folder>
-  <separator />
-  <alias ref="b1" />
+    <title>Lesezeichen!</title>
+    <desc>Lernen von XBEL am Beispiel von zwei Lesezeichen und einer Verknüpfung</desc>
+    <folder id="f0" added="2007-11-10">
+        <title>Wiki</title>
+        <desc>Webseiten von Autoren-Gemeinschaften</desc>
+        <bookmark href="http://wikimediafoundation.org/" id="b0" added="2007-11-11" modified="2007-11-14" visited="2007-11-14">
+            <info>
+                <metadata owner="xbel">
+                    <alias ref="f0" />
+                </metadata>
+            </info>
+            <title>Wikimedia Foundation</title>
+        </bookmark>
+        <bookmark href="http://de.wikipedia.org/" id="b1" added="2007-11-11" modified="2007-11-14" visited="2007-12-27">
+            <title>Wikipedia</title>
+        </bookmark>
+    </folder>
+    <separator />
+    <alias ref="b1" />
 </xbel>

data/xbel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xbel}
-  s.version = "0.2.0"
+  s.version = "0.2.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-11-10}
+  s.date = %q{2009-11-11}
   s.description = %q{}
   s.email = %q{florian.assmann@email.de}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xbel
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Florian A\xC3\x9Fmann"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-10 00:00:00 +01:00
+date: 2009-11-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency