xbel 0.2.3 → 0.2.4

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/lib/nokogiri/decorators/xbel.rb

@@ -35,6 +35,10 @@ module Nokogiri::Decorators::XBEL
     end
     attr_reader :info
 
+    def attributes=(attributes)
+      attributes.each { |key, value| send "#{ key }=", value }
+    end
+
     # Returns description of node.
     def desc
       if node = at('./desc') then node.content end
@@ -77,7 +81,12 @@ module Nokogiri::Decorators::XBEL
     end
     # Sets addition date.
     def added=(value)
-      set_attribute 'added', value.to_s
+      set_attribute 'added', case value
+      when Time; value.strftime '%Y-%m-%d'
+      when String; value
+      else
+        raise ArgumentError
+      end
     end
 
     # Returns nil.

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

@@ -34,31 +34,31 @@ module Nokogiri::Decorators::XBEL
       super
     end
 
-    def build(type, attributes = {}, &block)
-      child = Nokogiri::XML::Node.new(type.to_s, document)
-      assign_to child, attributes, &block
+    def build(type, attributes = {})
+      node = Nokogiri::XML::Node.new(type.to_s, document)
+      node.attributes = attributes
 
-      add_child child
+      yield node if block_given?
+
+      node
     end
 
     # Builds a bookmark with given attributes and add it.
-    def build_bookmark(title, href, attributes = {}, &block)
-      build :bookmark,
-          attributes.merge(:title => title, :href => href),
-          &block
+    def add_bookmark(title, href, attributes = {}, &block)
+      attributes = attributes.merge :title => title, :href => href
+      add_child build(:bookmark, attributes, &block)
     end
     # Builds a folder with given attributes and add it.
-    def build_folder(title, attributes = {}, &block)
-      build :folder,
-          attributes.merge(:title => title),
-          &block
+    def add_folder(title, attributes = {}, &block)
+      attributes = attributes.merge :title => title
+      add_child build(:folder, attributes, &block)
     end
     # Builds an alias with given attributes and add it.
-    def build_alias(ref)
-      child = Nokogiri::XML::Node.new('alias', document)
-      child.ref = (Entry === ref) ? ref.id : ref.to_s
+    def add_alias(ref)
+      node = Nokogiri::XML::Node.new 'alias', document
+      node.ref = (Entry === ref) ? ref.id : ref.to_s
 
-      add_child child
+      add_child node
     end
     # Builds a saperator with given attributes and add it.
     def add_separator
@@ -67,18 +67,21 @@ module Nokogiri::Decorators::XBEL
 
     protected
 
-      def assign_to(node, attributes) #:nodoc:
-        attributes[:id] ||= "#{ id }." << xpath('./bookmark | ./folder').
+      def generate_id
+        "#{ id }#{ document.div_id_er }" << xpath('./bookmark | ./folder').
             inject(0) { |next_id, child|
                 succ_num_id = child.id[/(\d+)$/, 1].to_i.succ
                 succ_num_id > next_id ? succ_num_id : next_id
             }.to_s
+      end
 
-        attributes.each do |key, value|
-          node.send "#{ key }=", value
+      def add_child(node)
+        if Entry === node
+          node.id ||= generate_id
+          node.added = Time.now
         end
 
-        yield node if block_given?
+        super
       end
 
   end

data/lib/xbel.rb

@@ -5,11 +5,22 @@ require 'nokogiri/decorators/xbel'
 
 class XBEL < Nokogiri::XML::Document
   extend Forwardable
-  def_delegators :root, :title, :title=, :desc, :desc=
+  def_delegators :root,
+      :title, :title=,
+      :desc, :desc=,
+      :id, :id=
+
+  attr_accessor :div_id_er
+
+  TEMPLATE = %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="1.0" id="0"></xbel>'
+  DIV_ID_ER = '_'
 
   # Returns an instance of XBEL.
-  def self.new(major = 1, minor = 0)
-    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]
+  def self.new(attributes = {})
+    xbel = parse TEMPLATE
+    xbel.attributes = attributes
+
+    xbel
   end
 
   # Reads file at <tt>path</tt> into <tt>parse</tt>.
@@ -24,6 +35,8 @@ class XBEL < Nokogiri::XML::Document
     super
     decorators(Nokogiri::XML::Node) << Nokogiri::Decorators::XBEL
     decorate!
+
+    @div_id_er = DIV_ID_ER
   end
 
   # Returns node with given <tt>id</tt>.
@@ -31,6 +44,13 @@ class XBEL < Nokogiri::XML::Document
     root.at("//*[@id='#{ id }']")
   end
 
+  def attributes=(attributes)
+    version = attributes.delete(:version) and self.version = version
+    div_id_er = attributes.delete(:div_id_er) and self.div_id_er = div_id_er
+
+    root.attributes = attributes
+  end
+
   # Returns an array of version numbers.
   def version
     root.attribute('version').value.split('.').map { |n| n.to_i }

data/test/test_xbel.rb

@@ -1,142 +1,172 @@
 require 'helper'
 
-context 'New XBEL' do
-
-  asserts 'version' do
-    XBEL.new.version
-  end.equals [1, 0]
-  asserts 'user defined version' do
-    XBEL.new(2, 2).version
-  end.equals [2, 2]
-  asserts 'set version' do
-    xbel = XBEL.new
-    xbel.version = 1, 1
-
-    xbel.version
-  end.equals [1, 1]
-  should 'be empty' do
-    XBEL.new.root.content.empty?
-  end
-
-end
-
 context 'XBEL' do
-
-  setup do
-    root = Pathname.new File.dirname(__FILE__)
-    XBEL.open root.join('wikipedia.xbel')
+  setup { XBEL }
+
+  context 'build with defaults' do
+    setup { topic.new }
+
+    asserts 'version' do
+      topic.version
+    end.equals [1, 0]
+    asserts 'version set' do
+      topic.version = 1, 1
+      topic.version
+    end.equals [1, 1]
+    should 'be empty' do
+      topic.root.content.empty?
+    end
+    should 'have an id divider' do
+      String === topic.div_id_er and
+      topic.div_id_er.length > 0
+    end
+  end
+  context 'built with attributes' do
+    setup { topic.new :version => [2, 2], :div_id_er => '/', :id => 'custom' }
+
+    asserts 'user defined version' do
+      topic.version
+    end.equals [2, 2]
+    asserts 'div_id_er' do
+      topic.div_id_er
+    end.equals '/'
+    asserts 'id' do
+      topic.id
+    end.equals 'custom'
+
+    asserts 'id of added folder' do
+      topic.root.add_folder('foo').id
+    end.equals 'custom/0'
   end
 
-  asserts('version') { topic.version }.equals [1, 0]
+  context 'loaded from wikipedia.xbel' do
+    setup do
+      root = Pathname.new File.dirname(__FILE__)
+      topic.open root.join('wikipedia.xbel')
+    end
 
-  asserts('title') { topic.title }.equals 'Lesezeichen!'
-  should('delegate title accessor to root') do
-    topic.title = 'Bookmarks!'
+    asserts('version') { topic.version }.equals [1, 0]
 
-    topic.title == topic.root.title and
-    topic.title == 'Bookmarks!'
-  end
+    asserts('title') { topic.title }.equals 'Lesezeichen!'
+    should('delegate title accessor to root') do
+      topic.title = 'Bookmarks!'
 
-  context 'Alias' do
-    setup { topic.root.aliases.first }
-    should('be an alias') { topic.alias? }
-
-    should('have a reference') do
-      topic.ref and
-      topic.ref == topic.reference
+      topic.title == topic.root.title and
+      topic.title == 'Bookmarks!'
     end
-  end
 
-  context 'Folder' do
-    setup { topic[:f0] }
-    should('be a folder') { topic.folder? }
+    context 'Alias' do
+      setup { topic.root.aliases.first }
+      should('be an alias') { topic.alias? }
 
-    asserts('title') { topic.title }.equals 'Wiki'
-    asserts('entries names') do
-      topic.entries.map { |e| e.name }.uniq.sort
-    end.equals %w[ alias bookmark folder separator ]
-    should('return bookmarks') do
-      not topic.bookmarks.any? { |b| b.name != 'bookmark' }
-    end
-    should('return aliases') do
-      not topic.aliases.any? { |b| b.name != 'alias' }
+      should('have a reference') do
+        topic.ref and
+        topic.ref == topic.reference
+      end
     end
-    should('return folders') do
-      not topic.folders.any? { |b| b.name != 'folder' }
+
+    context 'root' do
+      setup { topic.root }
+      context 'new Bookmark' do
+        setup do
+          topic.add_bookmark "boof's xbel", 'http://www.github.com/boof/xbel',
+              :description => 'Ruby API for XBEL based on Nokogiri.'
+        end
+        asserts('next id') { topic.id }.equals 'test_2'
+      end
     end
 
-    context 'Bookmark' do
-      setup { topic.bookmarks.first }
-      should('be a bookmark') { topic.bookmark? }
+    context 'Folder' do
+      setup { topic[:test_1] }
+      should('be a folder') { topic.folder? }
 
-      asserts('modified') { topic.modified }.kind_of Date
+      asserts('title') { topic.title }.equals 'Wiki'
+      asserts('entries names') do
+        topic.entries.map { |e| e.name }.uniq.sort
+      end.equals %w[ alias bookmark folder separator ]
+      should('return bookmarks') do
+        not topic.bookmarks.any? { |b| b.name != 'bookmark' }
+      end
+      should('return aliases') do
+        not topic.aliases.any? { |b| b.name != 'alias' }
+      end
+      should('return folders') do
+        not topic.folders.any? { |b| b.name != 'folder' }
+      end
 
-      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
-        topic.build_bookmark "boof's xbel", 'http://www.github.com/boof/xbel',
-            :description => 'Ruby API for XBEL based on Nokogiri.'
+      context 'Bookmark' do
+        setup { topic.bookmarks.first }
+        should('be a bookmark') { topic.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
+          topic.add_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') { topic.added }.equals Date.today
+        asserts('title') { topic.title }.equals 'boof\'s xbel'
+        asserts('next id') { topic.id }.equals 'test_1_4'
+        asserts('href') { topic.href }.
+            equals 'http://www.github.com/boof/xbel'
+        asserts('description') { topic.description }.
+            equals 'Ruby API for XBEL based on Nokogiri.'
       end
-      should('be a bookmark') { topic.bookmark? }
 
-      asserts('added') { topic.added }.equals Date.today
-      asserts('title') { topic.title }.equals 'boof\'s xbel'
-      asserts('next id') { topic.id }.equals 'f0.2'
-      asserts('href') { topic.href }.
-          equals 'http://www.github.com/boof/xbel'
-      asserts('description') { topic.description }.
-          equals 'Ruby API for XBEL based on Nokogiri.'
-    end
+      context 'new Folder' do
+        setup { topic.add_folder 'sub', :desc => 'desc' }
+        should('be a folder') { topic.folder? }
 
-    context 'new Folder' do
-      setup { topic.build_folder 'sub', :desc => 'desc' }
-      should('be a folder') { topic.folder? }
+        asserts('added') { topic.added }.equals Date.today
+        asserts('title') { topic.title }.equals 'sub'
+        asserts('next id') { topic.id }.equals 'test_1_4'
+        asserts('desc') { topic.desc }.equals 'desc'
+      end
 
-      asserts('added') { topic.added }.equals Date.today
-      asserts('title') { topic.title }.equals 'sub'
-      asserts('next id') { topic.id }.equals 'f0.2'
-      asserts('desc') { topic.desc }.equals 'desc'
-    end
+      context 'new Alias' do
+        setup { topic.add_alias topic }
+        should('be an alias') { topic.alias? }
 
-    context 'new Alias' do
-      setup { topic.build_alias topic }
-      should('be an alias') { topic.alias? }
+        should('reference its folder') { topic.entry == topic.parent }
+        should('set reference by entry') do
+          topic.entry = topic.document[:test_1_3]
+          topic.ref == 'test_1_3'
+        end
+      end
 
-      should('reference its folder') { topic.entry == topic.parent }
-      should('set reference by entry') do
-        topic.entry = topic.document[:b1]
-        topic.ref == 'b1'
+      context 'Separator' do
+        setup { topic.entries.find { |e| e.name == 'separator' } }
+        asserts('to_s') { topic.to_s }.equals ' '
       end
-    end
 
-    context 'Separator' do
-      setup { topic.entries.find { |e| e.name == 'separator' } }
-      asserts('to_s') { topic.to_s }.equals ' '
     end
 
-  end
+    context 'Bookmark b0' do
+      setup { topic[:test_1_1] }
+      should('be a bookmark') { topic.bookmark? }
 
-  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 '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 }
+        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? }
+          should('be have an alias') { not topic.at('./alias').nil? }
+        end
       end
-    end
 
+    end
   end
 
 end

data/test/wikipedia.xbel

@@ -2,27 +2,27 @@
 <!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">
+<xbel version="1.0" id="test">
     <title>Lesezeichen!</title>
     <desc>Lernen von XBEL am Beispiel von zwei Lesezeichen und einer Verknüpfung</desc>
-    <folder id="f0" added="2007-11-10">
+    <folder id="test_1" 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">
+        <bookmark href="http://wikimediafoundation.org/" id="test_1_1" added="2007-11-11" modified="2007-11-14" visited="2007-11-14">
             <info>
                 <metadata owner="xbel">
-                    <alias ref="f0" />
+                    <alias ref="test_1" />
                 </metadata>
             </info>
             <title>Wikimedia Foundation</title>
         </bookmark>
-        <alias ref="f0-1" />
+        <alias ref="test_1_1" />
         <separator />
-        <bookmark href="http://de.wikipedia.org/" id="b1" added="2007-11-11" modified="2007-11-14" visited="2007-12-27">
+        <bookmark href="http://de.wikipedia.org/" id="test_1_2" added="2007-11-11" modified="2007-11-14" visited="2007-12-27">
             <title>Wikipedia</title>
         </bookmark>
-        <folder id="f0-1"></folder>
+        <folder id="test_1_3"></folder>
     </folder>
     <separator />
-    <alias ref="b1" />
+    <alias ref="test_1_2" />
 </xbel>

data/xbel.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xbel}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Florian A\303\237mann"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xbel
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - "Florian A\xC3\x9Fmann"