markio 0.0.3 → 0.1

data/README.md

@@ -1,33 +1,59 @@
 # Markio
 
-A ruby gem for parsing Netscape Bookmark File Format
-http://msdn.microsoft.com/en-us/library/aa753582(v=vs.85).aspx
+A Ruby Gem for parsing [Netscape Bookmark File Format](http://msdn.microsoft.com/en-us/library/aa753582\(v=vs.85\).aspx)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'markio'
+```ruby
+gem 'markio'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install markio
+```bash
+$ gem install markio
+```
 
 ## Usage
 
-    bookmarks = Markio::parse('/path/to/bookmarks.html')
-    bookmarks.each do |b|
-      b.title           # String
-      b.href            # String with bookmark URL
-      b.folders         # Array of strings - folders (tags)
-      b.add_date        # DateTime
-      b.last_visit      # DateTime
-      b.last_modified   # DateTime
-    end
+### Parsing bookmarks file
+
+```ruby
+bookmarks = Markio::parse(File.open('/path/to/bookmarks.html'))
+bookmarks.each do |b|
+  b.title           # String
+  b.href            # String with bookmark URL
+  b.folders         # Array of strings - folders (tags)
+  b.add_date        # DateTime
+  b.last_visit      # DateTime
+  b.last_modified   # DateTime
+end
+```
+
+### Building bookmarks file
+
+```ruby
+builder = Markio::Builder.new
+builder.bookmarks << Bookmark.create({
+  :title => "Google",
+  :href => "http://google.com"
+})
+file_contents = builder.build_string
+File.open('/path/to/bookmarks.html', 'w') { |f| f.write file_contents }
+```
+
+## TODO
+
+  - Builder output to file
+  - Builder should not ignore bookmark folders
 
 ## Contributing
 

data/lib/markio/bookmark.rb

@@ -16,7 +16,7 @@ class Markio::Bookmark
 
   def == other
     unless other.nil? or other.class != self.class
-      other.href == href
+      other.href == href and other.title == title
     end
   end
 end

data/lib/markio/builder.rb

@@ -23,6 +23,19 @@ class Markio::Builder
 
   def build
 
+    bookmarks = { nil => [] }
+    @bookmarks.each do |b|
+
+      if b.folders.any?
+        b.folders.each do |f|
+          bookmarks[f] ||= []
+          bookmarks[f] << b
+        end
+      else
+        bookmarks[nil] << b
+      end
+    end
+
     docparts = Nokogiri::HTML::DocumentFragment.parse ''
     Nokogiri::HTML::Builder.with(docparts) do |html|
       html.comment <<END
@@ -34,18 +47,34 @@ END
       html.title @title
       html.dl {
         html.p
-        @bookmarks.each do |b|
-          html.dt {
-            params = { :href => b.href }
-            params[:add_date] = b.add_date.to_time.to_i if b.add_date
-            params[:last_visit] = b.last_visit.to_time.to_i if b.last_visit
-            params[:last_modified] = b.last_modified.to_time.to_i if b.last_modified
-            html.a(b.title, params)
-          }
+        bookmarks.keys.each do |f|
+          unless f.nil?
+            html.dt {
+              html.h3 f
+              html.dl {
+                html.p
+                bookmarks[f].each { |b| build_bookmark html, b }
+              }
+            }
+          else
+            bookmarks[nil].each { |b| build_bookmark html, b }
+          end
         end
       }
     end
 
-    "<!DOCTYPE NETSCAPE-Bookmark-file-1>\n" << docparts.to_html
+  "<!DOCTYPE NETSCAPE-Bookmark-file-1>\n" << docparts.to_html
+  end
+
+  private
+
+  def build_bookmark(html, b)
+    html.dt {
+      params = { :href => b.href }
+      params[:add_date] = b.add_date.to_time.to_i if b.add_date
+      params[:last_visit] = b.last_visit.to_time.to_i if b.last_visit
+      params[:last_modified] = b.last_modified.to_time.to_i if b.last_modified
+      html.a(b.title, params)
+    }
   end
 end

data/lib/markio/parser.rb

@@ -12,7 +12,7 @@ module Markio
       traverse(@document, []) do |bookmark|
         bookmarks << bookmark
       end
-      bookmarks
+      consolidate bookmarks
     end
 
     private
@@ -55,5 +55,18 @@ module Markio
       Time.at(timestamp.to_i).to_datetime if timestamp
     end
 
+    def consolidate(bookmarks)
+      consolidated = []
+      bookmarks.each do |b|
+        index = consolidated.index b
+        unless index.nil?
+          consolidated[index].folders += b.folders
+        else
+          consolidated << b
+        end
+      end
+      consolidated
+    end
+
   end
 end

data/lib/markio/version.rb

@@ -1,3 +1,3 @@
 module Markio
-  VERSION = "0.0.3"
+  VERSION = "0.1"
 end

data/markio.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Tomas Varaneckas"]
   gem.email         = ["tomas.varaneckas@gmail.com"]
   gem.description   = %q{Import/export utility for Netscape Bookmark Format}
-  gem.summary       = %q{Import/export utility for Netscape Bookmark Format}
-  gem.homepage      = ""
+  gem.summary       = %q{Handles parsing and building Netscabe Bookmark Format in Ruby way.}
+  gem.homepage      = "https://github.com/spajus/markio"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/builder_spec.rb

@@ -32,12 +32,12 @@ module Markio
     it 'should be able to parse what it builds' do
       builder = Builder.new
       builder.bookmarks << Bookmark.create({
-        :title => "Test bookmark",
+        :title => "Test bookmark 1",
         :href => "http://test.com"
       })
       builder.bookmarks << Bookmark.create({
-        :title => "Test bookmark",
-        :href => "http://test.com",
+        :title => "Test bookmark 2",
+        :href => "http://test2.com",
         :add_date => Date.parse('2012-01-12 11:22:33').to_datetime,
         :last_visit => Date.parse('2012-01-13 10:20:30').to_datetime,
         :last_modified => Date.parse('2012-01-14 10:21:31').to_datetime
@@ -54,11 +54,11 @@ module Markio
       builder = Builder.new
       builder.bookmarks << Bookmark.create({
         :title => "Test bookmark",
-        :href => "http://test.com"
+        :href => "http://test1.com"
       })
       builder.bookmarks << Bookmark.create({
-        :title => "Test bookmark",
-        :href => "http://test.com",
+        :title => "Test bookmark 2",
+        :href => "http://test2.com",
         :add_date => Date.parse('2012-01-12 11:22:33').to_datetime,
         :last_visit => Date.parse('2012-01-13 10:20:30').to_datetime,
         :last_modified => Date.parse('2012-01-14 10:21:31').to_datetime
@@ -69,5 +69,53 @@ module Markio
       builder.bookmarks = bookmarks
       builder.build_string.should eq file_contents
     end
+
+    it 'should group bookmarks into folders' do
+      builder = Builder.new
+      builder.bookmarks << Bookmark.create({
+        :title => "Test bookmark 1",
+        :href => "http://test1.com",
+        :folders => ["One"]
+      })
+      builder.bookmarks << Bookmark.create({
+        :title => "Test bookmark 2",
+        :href => "http://test2.com",
+        :folders => ["Two"]
+      })
+      file_contents = builder.build_string
+      file_contents.should match "One"
+      file_contents.should match "Two"
+      bookmarks = Markio.parse file_contents
+      bookmarks.length.should eq builder.bookmarks.length
+      bookmarks.each do |b|
+        builder.bookmarks.should include b
+        b.folders.length.should eq 1
+      end
+    end
+    
+    it 'should work with multi-folder bookmarks' do
+      builder = Builder.new
+      builder.bookmarks << Bookmark.create({
+        :title => "Test bookmark 1",
+        :href => "http://test1.com",
+        :folders => ["One", "Shared"]
+      })
+      builder.bookmarks << Bookmark.create({
+        :title => "Test bookmark 2",
+        :href => "http://test2.com",
+        :folders => ["Two", "Shared"]
+      })
+      file_contents = builder.build_string
+      file_contents.should match "One"
+      file_contents.should match "Two"
+      file_contents.should match "Shared"
+      bookmarks = Markio.parse file_contents
+      bookmarks.length.should eq builder.bookmarks.length
+      bookmarks.each do |b|
+        builder.bookmarks.should include b
+        b.folders.length.should eq 2
+        b.folders.should include "Shared"
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markio
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -101,7 +101,7 @@ files:
 - spec/builder_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/spajus/markio
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -124,7 +124,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Import/export utility for Netscape Bookmark Format
+summary: Handles parsing and building Netscabe Bookmark Format in Ruby way.
 test_files:
 - spec/assets/corrupted.html
 - spec/assets/many_bookmarks.html