xbel 0.1.1 → 0.1.2

data/.document

@@ -1,4 +1,4 @@
-README.rdoc
+README.markdown
 lib/**/*.rb
 bin/*
 features/**/*.feature

data/README.markdown

@@ -7,6 +7,16 @@ development.
 
     gem install xbel
 
+## Use
+
+    require 'rubygems'
+    require 'xbel'
+
+    xbel = XBEL.parse File.read('complex.xbel')
+
+    with_aliases = true # TODO...
+    xbel.root.bookmarks(with_aliases).each { |bm| system 'open', bm.href }
+
 ### Note on Patches/Pull Requests
  
 1. Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

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

@@ -2,53 +2,63 @@ module Nokogiri::Decorators::XBEL
   module Folder
     include Entry
 
+    # Returns an instance of NodeSet with all valid children for this folder.
     def entries
       xpath './alias', './bookmark', './folder', './separator'
     end
+    # Returns an instance of NodeSet with all aliases for this folder.
     def aliases
       xpath './alias'
     end
+    # Returns an instance of NodeSet with all bookmarks for this folder.
     def bookmarks
       xpath './bookmark'
     end
+    # Returns an instance of NodeSet with all folders for this folder.
     def folders
       xpath './folder'
     end
 
+    # Returns true.
     def folder?
       true
     end
 
+    # Adds a entry and sets added attribute.
     def add_child(node)
       node.added = Date.today if node.is_a? Entry
       super
     end
 
+    # Builds a bookmark with given attributes and add it.
     def build_bookmark(attributes = {}, &block)
       node = Nokogiri::XML::Node.new('bookmark', document)
       assign_to node, attributes
 
       add_child node
     end
+    # Builds a folder with given attributes and add it.
     def build_folder(attributes = {}, &block)
       node = Nokogiri::XML::Node.new('folder', document)
       assign_to node, attributes
 
       add_child node
     end
+    # Builds an alias with given attributes and add it.
     def build_alias(ref)
       node = Nokogiri::XML::Node.new('alias', document)
       node.ref = (Entry === ref) ? ref.id : ref.to_s
 
       add_child node
     end
+    # Builds a seperator with given attributes and add it.
     def add_seperator
       add_child Nokogiri::XML::Node.new('separator', document)
     end
 
     protected
 
-      def assign_to(node, attributes)
+      def assign_to(node, attributes) #:nodoc:
         attributes.each do |key, value|
           node.send "#{ key }=", value
         end

data/lib/xbel/writer.rb

@@ -1,4 +1,4 @@
-class XBEL::Writer
+class XBEL::Writer #:nodoc:
   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

data/lib/xbel.rb

@@ -11,6 +11,7 @@ class XBEL < Nokogiri::XML::Document
 
   autoload :Writer, 'xbel/writer'
 
+  # Use <tt>XBEL.parse(string)</tt> create an instance.
   def initialize(*args)
     super
     decorators(Nokogiri::XML::Node) << Nokogiri::Decorators::XBEL
@@ -19,14 +20,18 @@ class XBEL < Nokogiri::XML::Document
 #    self.root = '<xbel version="1.0"></xbel>'
   end
 
+  # Returns an array of version numbers.
   def version
     root.attribute('version').value.split('.').map { |n| n.to_i }
   end
+  # Sets version numbers.
   def version=(*numbers)
     root.attribute('version').value = numbers.join '.'
   end
 
+  # Writes XBEL to path.
   def write(path)
+    # TODO: should start locking write process
     Writer.new(self, path).write
   end
 

data/xbel.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xbel}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   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.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - "Florian A\xC3\x9Fmann"