bookmarks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb320228bd68d2c679651f8b0bef8ed3be77526a
+  data.tar.gz: 6049fb5986c41ae4ffb2eaf5618e6046b39d3bd7
+SHA512:
+  metadata.gz: 343aec86130060ee882d7eda260dbdbdd81fdddb525ac8e705d1f3978fe6a344083c60d56cf476ddf093064f7df8366d99c84a88e47c847be19aa74f5c60337e
+  data.tar.gz: 30fcb9a2a5bda9c3746758503cc183ef83da15b35ecb9b1312444a44449bc8ce025d379fc355fe994ea9c7b99ef74419fd8da3568bd3b0867b0ae488e9d94f86

data/Changelog.markdown

@@ -0,0 +1,4 @@
+version 0.1.0  (2013-xx-xx)
+===========================
+
+First release.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    bookmarks (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coco (0.7.1)
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rspec (2.14.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.1)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    tomparse (0.4.2)
+    yard (0.8.6.2)
+    yard-tomdoc (0.7.1)
+      tomparse (>= 0.4.0)
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bookmarks!
+  coco (>= 0.7.1)
+  rake
+  rspec
+  yard
+  yard-tomdoc

data/README.markdown

@@ -0,0 +1,70 @@
+Bookmarks [![Build Status](https://travis-ci.org/lkdjiin/bookmarks.png)](https://travis-ci.org/lkdjiin/bookmarks)
+================
+
+Description
+-----------
+
+Bookmarks is a library to parse or build a file of bookmarks, currently
+only files in netscape format, like the ones exported by Delicious.
+
+Install
+-------------------------
+
+On the CLI
+
+    gem install bookmarks
+
+or in a Gemfile
+
+    gem 'bookmarks'
+
+Usage
+--------------------------
+
+    require 'bookmarks'
+
+    # To parse a document.
+    document = Document.new
+    document.parse 'bookmarks_file.html'
+    document.total # => Number of bookmarks.
+    first_bookmark = document.bookmarks.first
+    first_bookmark.class # => NetscapeBookmark
+    first_bookmark.url # => Url of the bookmark.
+    first_bookmark.title # => Title of the bookmark.
+    first_bookmark.tags # => Tags of the bookmark.
+    first_bookmark.date # => Date of the bookmark.
+    first_bookmark.description # => Description of the bookmark.
+
+    # To build a document.
+    # ary is an array of NetscapeBookmark.
+    document.build do
+      ary.each {|e| e }
+    end
+    
+
+
+Dependencies
+--------------------------
+
+  * ruby >= 2.0.0
+
+Contributing
+-------------------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+License
+--------------------------
+
+
+
+Questions and/or Comments
+--------------------------
+
+Feel free to email [Xavier Nayrac](mailto:xavier.nayrac@gmail.com)
+with any questions, or contact me on [twitter](https://twitter.com/lkdjiin).

data/Rakefile

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Test Bookmarks'
+task :default => :spec
+
+desc 'Test Bookmarks with rspec'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color']
+end
+
+desc 'Check for code smells'
+task :reek do
+  puts 'Checking for code smells...'
+  files = Dir.glob 'lib/**/*.rb'
+  args = files.join(' ')
+  sh "reek --quiet #{args} | ./reek.sed"
+end
+
+desc 'Generate documentation'
+task :doc do
+  sh "yard --plugin tomdoc"
+end

data/TODO

@@ -0,0 +1,3 @@
+
+Vérifier
+* gemspec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/bookmarks/document.rb

@@ -0,0 +1,104 @@
+# -*- encoding: utf-8 -*-
+
+module Bookmarks
+
+  # Public: Document is your main interface to the file of bookmarks
+  # (called «document»).
+  class Document
+
+    # Public: Init a new Document.
+    #
+    # format - The Symbol format of the document (Optional).
+    #
+    # Examples
+    #
+    #   # The two following calls work the same way.
+    #   Document.new
+    #   Document.new format: :netscape
+    def initialize format: :netscape
+      @bookmarks_format = format
+      @document = ""
+      @bookmarks = []
+      @total = 0
+    end
+
+    # Public: Returns the Symbol format of the document. Currently
+    #   there is only one format available: `:netscape`.
+    attr_reader :bookmarks_format
+
+    # Public: Returns the String document.
+    attr_reader :document
+
+    # Public: Returns an Array of NetscapeBookmark bookmarks.
+    attr_reader :bookmarks
+
+    # Public: Returns the Integer numbers of bookmarks in the document.
+    attr_reader :total
+
+    # Public: Build a document, ie build a file of bookmarks.
+    #
+    # block - A block that enumerate all NetscapeBookmark to put
+    #         into the document.
+    #
+    # Examples
+    #
+    #   # ary is an array of NetscapeBookmark.
+    #   document.build do
+    #     ary.each {|e| e }
+    #   end
+    #
+    # Returns the String document.
+    def build &block
+      @document += FIRST_PART
+      block.call.each do |n|
+        @document += n.to_s + "\n"
+        @total += 1
+      end
+      @document += LAST_PART
+    end
+
+    # Public: Parse a file of bookmarks (netscape format). Bookmarks could
+    # then be retrieved with #bookmarks.
+    #
+    # file_path - Full String pathname of the file to parse.
+    #
+    # Returns the String document (see also #document).
+    def parse file_path
+      File.new(file_path).readlines.each {|line| parse_a_bookmark line }
+      @total = @bookmarks.size
+    end
+
+    private
+
+    # Parse a single line from a bookmarks file.
+    #
+    # line - String.
+    #
+    # Returns nothing.
+    def parse_a_bookmark line
+      if line =~ /^<DT>/
+        @bookmarks << NetscapeBookmark.from_string(line)
+      elsif line =~ /^<DD>/
+        @bookmarks.last.description = line[4..-1].chomp
+      end
+    end
+
+
+# First part of a bookmark's file in netscape format.
+FIRST_PART = <<CODE
+<!DOCTYPE NETSCAPE-Bookmark-file-1>
+<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
+<!-- This is an automatically generated file.
+It will be read and overwritten.
+Do Not Edit! -->
+<TITLE>Bookmarks</TITLE>
+<H1>Bookmarks</H1>
+<DL><p>
+CODE
+
+# Last part of a bookmark's file in netscape format.
+LAST_PART = "</DL><p>\n"
+
+  end
+
+end

data/lib/bookmarks/netscape_bookmark.rb

@@ -0,0 +1,94 @@
+# -*- encoding: utf-8 -*-
+
+module Bookmarks
+
+  # Public: A single bookmark in netscape format.
+  class NetscapeBookmark
+
+    # Public: Init a new NetscapeBookmark.
+    #
+    # url         - An optional String url.
+    # title       - An optional String title.
+    # date        - An optional Date/DateTime date.
+    # tags        - An optional String tags. Tags are comma separated.
+    # description - An optional String description.
+    def initialize url: "", title: "", date: nil, tags: "", description: ""
+      @url = url
+      @title = title
+      @date = date
+      @tags = tags
+      @description = description
+    end
+
+    # Public: Initialize a new NetscapeBookmark object from a line from
+    # a bookmarks file.
+    #
+    # line - String line from a bookmarks file.
+    #
+    # Returns a new NetscapeBookmark object.
+    def self.from_string line
+      url = /HREF="(.*?)"/.match(line)[1]
+      title = /HREF=.*>(.*)<\/A>$/.match(line)[1]
+      date = /ADD_DATE="(.*?)"/.match(line)[1]
+      date = Time.at(date.to_i).to_s
+      tags = /TAGS="(.*?)"/.match(line)[1]
+      title = prettify_title title, url
+      new url: url, title: title, date: date, tags: tags
+    end
+
+
+    # Public: Set/get the String url.
+    attr_accessor :url
+
+    # Public: Set/get the String title.
+    attr_accessor :title
+
+    # Public: Set/get the Date/DateTime date.
+    attr_accessor :date
+
+    # Public: Set/get the String tags.
+    attr_accessor :tags
+
+    # Public: Set/get the String description.
+    attr_accessor :description
+
+    # Public: Returns the bookmark as a String.
+    def to_s
+      str = "<DT><A HREF=\"#{@url}\" " +
+        "ADD_DATE=\"#{@date.nil? ? "" : @date.to_time.to_i}\" " +
+        "TAGS=\"#{@tags}\">" +
+        (@title.empty? ? 'None' : @title) + "</A>"
+      if @description.empty?
+        str
+      else
+        str + "\n<DD>#{@description}"
+      end
+    end
+
+    # In some case (which?) Delicious miss the title and we have a crapy
+    # 'None' instead of the original title. Bad news is the original title
+    # is lost. And there is no good news :) In such case, we build a new
+    # title from the url.
+    #
+    # Examples
+    #
+    #   # Before expand_title
+    #   @title # => 'None'
+    #   @url   # => "http://designmodo.com/flat-design-colors/"
+    #   # After expand_title
+    #   @title # => 'flat design colors'
+    #
+    # Returns String prettified title.
+    def self.prettify_title title, url
+      return title unless title == '' || title == 'None'
+      title = url
+      # Remove '/' at the end if it exists.
+      title = title.gsub(/\/$/, '')
+      # Keep the last element of the url.
+      title = title.match(/^.*\/(.*)/)[1]
+      # Substitute each '-' by a space.
+      title = title.gsub('-', ' ')
+    end
+
+  end
+end

data/lib/bookmarks.rb

@@ -0,0 +1,11 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+$BOOKMARKS_PATH = File.expand_path(File.expand_path(File.dirname(__FILE__)) + '/..')
+
+require 'bookmarks/document'
+require 'bookmarks/netscape_bookmark'
+
+# Public: Bookmarks is a library to parse or build a file of bookmarks.
+module Bookmarks
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: bookmarks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xavier Nayrac
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coco
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-tomdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Bookmarks is a library to parse or build a file of
+  bookmarks, currently only files in netscape format, like the ones
+  exported by Delicious.
+email: xavier.nayrac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bookmarks.rb
+- lib/bookmarks/document.rb
+- lib/bookmarks/netscape_bookmark.rb
+- Changelog.markdown
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- TODO
+- VERSION
+homepage: https://github.com/lkdjiin/bookmarks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Bookmarks is a library to parse or build a file of bookmarks.
+test_files: []
+has_rdoc: