xbel 0.2.1 → 0.2.2

data/.gitignore

@@ -15,7 +15,8 @@ tmtags
 
 ## PROJECT::GENERAL
 coverage
-rdoc
+doc
+.yardoc
 pkg
 
 ## PROJECT::SPECIFIC

data/Rakefile

@@ -40,12 +40,11 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "xbel #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
 end

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/nokogiri/decorators/xbel.rb

@@ -3,7 +3,7 @@ module Nokogiri::Decorators::XBEL
   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"
+  autoload :Separator, "#{ File.dirname __FILE__ }/xbel/separator.rb"
 
   def self.extended(base)
     case base.name
@@ -35,9 +35,11 @@ module Nokogiri::Decorators::XBEL
     end
     attr_reader :info
 
+    # Returns description of node.
     def desc
       if node = at('./desc') then node.content end
     end
+    # Sets description of node.
     def desc=(value)
       node = at './desc'
       node ||= add_child Nokogiri::XML::Node.new('desc', document)
@@ -47,9 +49,11 @@ module Nokogiri::Decorators::XBEL
     alias_method :description, :desc
     alias_method :description=, :desc=
 
+    # Returns title fo node.
     def title
       if node = at('./title') then node.content end
     end
+    # Sets title for node.
     def title=(value)
       node = at './title'
       node ||= add_child Nokogiri::XML::Node.new('title', document)
@@ -58,22 +62,29 @@ module Nokogiri::Decorators::XBEL
     end
     alias_method :to_s, :title
 
+    # Returns id for node.
     def id
       if id = attribute('id') then id.content end
     end
+    # Sets id for node.
     def id=(value)
       set_attribute 'id', value.to_s
     end
 
+    # Returns addition date.
     def added
       if value = attribute('added') then Date.parse value.content end
     end
+    # Sets addition date.
     def added=(value)
       set_attribute 'added', value.to_s
     end
 
+    # Returns nil.
     def alias?; end
+    # Returns nil.
     def bookmark?; end
+    # Returns nil.
     def folder?; end
   end
 

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

@@ -4,19 +4,27 @@ module Nokogiri::Decorators::XBEL
     def_delegators :entry,
         :description, :title, :to_s, :id, :added, :bookmark?, :folder?
 
+    # Returns reference to bookmark or folder id.
     def ref
       attribute('ref').content
     end
-    def ref=(value)
-      set_attribute 'ref', value.to_s
+    # Sets reference of bookmark or folder id.
+    def ref=(bookmark_or_folder_id)
+      set_attribute 'ref', bookmark_or_folder_id.to_s
     end
     alias_method :reference, :ref
     alias_method :reference=, :ref=
 
+    # Returns referenced bookmark or folder.
     def entry
       at %Q'//*[@id="#{ ref }"]'
     end
+    # Sets referenced bookmark or folder.
+    def entry=(bookmark_or_folder)
+      self.ref = bookmark_or_folder.id
+    end
 
+    # Returns true.
     def alias?
       true
     end

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

@@ -6,28 +6,36 @@ module Nokogiri::Decorators::XBEL
       node.initialize_decorator
     end
 
+    # Returns modification date.
     def modified
       if value = self['modified'] then Date.parse value end
     end
+    # Sets modification date.
     def modified=(value)
       self['modified'] = value.to_s
     end
+    # Returns visit date.
     def visited
       if value = self['visited'] then Date.parse value end
     end
+    # Sets visit date.
     def visited=(value)
       self['visited'] = value.to_s
     end
+    # Sets visit to today.
     def visit
       self.visited = Date.today
     end
+    # Returns href value.
     def href
       if value = self['href'] then value end
     end
+    # Sets href value.
     def href=(value)
       self.modified = Date.today
       self['href'] = value
     end
+    # Returns true.
     def bookmark?
       true
     end

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

@@ -6,19 +6,19 @@ module Nokogiri::Decorators::XBEL
       node.initialize_decorator
     end
 
-    # Returns an instance of NodeSet with all valid children for this folder.
+    # Returns an instance of NodeSet with possible children in this folder.
     def entries
       xpath './alias | ./bookmark | ./folder | ./separator'
     end
-    # Returns an instance of NodeSet with all aliases for this folder.
+    # Returns an instance of NodeSet with all aliases in this folder.
     def aliases
       xpath './alias'
     end
-    # Returns an instance of NodeSet with all bookmarks for this folder.
+    # Returns an instance of NodeSet with all bookmarks in this folder.
     def bookmarks
       xpath './bookmark'
     end
-    # Returns an instance of NodeSet with all folders for this folder.
+    # Returns an instance of NodeSet with all folders in this folder.
     def folders
       xpath './folder'
     end
@@ -56,8 +56,8 @@ module Nokogiri::Decorators::XBEL
 
       add_child node
     end
-    # Builds a seperator with given attributes and add it.
-    def add_seperator
+    # Builds a saperator with given attributes and add it.
+    def add_separator
       add_child Nokogiri::XML::Node.new('separator', document)
     end
 

data/lib/nokogiri/decorators/xbel/{seperator.rb → separator.rb}

@@ -1,8 +1,9 @@
 module Nokogiri::Decorators::XBEL
   module Separator
 
+    # Returns a single space.
     def to_s
-      ''
+      ' '
     end
 
   end

data/lib/xbel.rb

@@ -7,21 +7,26 @@ class XBEL < Nokogiri::XML::Document
   extend Forwardable
   def_delegators :root, :title, :title=, :desc, :desc=
 
+  # 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]
   end
 
-  def self.open(path)
-    parse File.read(path.to_s)
+  # Reads file at <tt>path</tt> into <tt>parse</tt>.
+  # @yield [XBEL]
+  # @see Nokogiri.parse
+  def self.open(path, &block)
+    parse File.read(path.to_s), &block
   end
 
-  # Use <tt>XBEL.parse(string)</tt> create an instance.
+  # Calls <tt>Nokogiri#initialize</tt> and decorates XBEL nodes.
   def initialize(*args)
     super
     decorators(Nokogiri::XML::Node) << Nokogiri::Decorators::XBEL
     decorate!
   end
 
+  # Returns node with given <tt>id</tt>.
   def [](id)
     root.at("//*[@id='#{ id }']")
   end

data/test/test_xbel.rb

@@ -52,11 +52,18 @@ context 'XBEL' do
     should('be a folder') { topic.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
+    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
 
     context 'Bookmark' do
       setup { topic.bookmarks.first }
@@ -100,6 +107,15 @@ context 'XBEL' do
       should('be an alias') { topic.alias? }
 
       should('reference its folder') { topic.entry == topic.parent }
+      should('set reference by entry') do
+        topic.entry = topic.document[:b1]
+        topic.ref == 'b1'
+      end
+    end
+
+    context 'Separator' do
+      setup { topic.entries.find { |e| e.name == 'separator' } }
+      asserts('to_s') { topic.to_s }.equals ' '
     end
 
   end

data/test/wikipedia.xbel

@@ -16,9 +16,12 @@ PUBLIC "+//IDN python.org//DTD XML Bookmark Exchange Language 1.0//EN//XML"
             </info>
             <title>Wikimedia Foundation</title>
         </bookmark>
+        <alias ref="f0-1" />
+        <separator />
         <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 id="f0-1"></folder>
     </folder>
     <separator />
     <alias ref="b1" />

data/xbel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xbel}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   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-11}
+  s.date = %q{2009-11-12}
   s.description = %q{}
   s.email = %q{florian.assmann@email.de}
   s.extra_rdoc_files = [
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
      "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/nokogiri/decorators/xbel/separator.rb",
      "lib/xbel.rb",
      "test/helper.rb",
      "test/test_xbel.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xbel
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - "Florian A\xC3\x9Fmann"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-11 00:00:00 +01:00
+date: 2009-11-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,7 +53,7 @@ files:
 - 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/nokogiri/decorators/xbel/separator.rb
 - lib/xbel.rb
 - test/helper.rb
 - test/test_xbel.rb