fundler 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9e5cc9979b9b7356a8341a8bd13674dece28c55
-  data.tar.gz: 0251f3debe730d261e4f47dcf035e3f2f8be4129
+  metadata.gz: da0902defdfad3f010e5eaccb203cb54c36d71c6
+  data.tar.gz: 8154e8189a025975c2703612b5ab45ecba37b59a
 SHA512:
-  metadata.gz: d9f874b856944b3f6d20a16a0d91abc0e49cfec0363f941b5e4cf135c96f9dbb16acde8e693ce403e45c9e05fb2c96544f22d0983b493207e151b1f2d69c5b79
-  data.tar.gz: cbbf396c02cc8b21d71ebd26914dcc63e5c6805e60fe3c021a22663428ad478508081efbcda8ebdaca549a6e41d579fb772eaee0ab143b63094bc28a18f9c2d2
+  metadata.gz: 5d9adfc90611ab96b05781356f0467a2d2309224f87ba78ccb9bc5f4ad20f0ca6b0e561c93f73fa6658702e749ecf0fdf7bd9cef56ae68942f6ceebac817aa17
+  data.tar.gz: 638b975cd75a57ad254ca5782afb9e5f2b72f79de16dd3f543f10e127e7c72b0e758279bb8ab554f6030a5fc8f47391d219b301921e3bad71eeab001a565bc15

data/bin/fundler

@@ -11,7 +11,7 @@ class FundlerProgram
   attr_reader   :input
 
   def err msg
-    $stderr.puts "* error: #{msg}"
+    $stderr.puts "* : #{msg}"
     exit 1
   end
 
@@ -29,51 +29,59 @@ class FundlerProgram
     @debug = false
 
     # Parser
+    options = {}
     optparse = OptionParser.new do |opts|
       opts.banner = "Usage: #{opts.program_name} [OPTIONS] "
-      opts.define_head 'file name cleaner'
+      opts.define_head 'Fundler: file name cleaner and bookmarks utility'
+      opts.program_name = 'Fundler'
       opts.separator  ''
 
       opts.on('-d', '--debug', "Turn on debugging.") do
         @debug = true
       end
 
-      opts.on('-o', '--output FILE', String,
-              "Where to output the merged ruby script.") do |f|
-        @output = File.open(f, 'w') unless '-' == f
-      end
+      #opts.on('-o', '--output FILE', String,
+      #        "Where to output the merged ruby script.") do |f|
+      #  @output = File.open(f, 'w') unless '-' == f
+      #end
 
       opts.on('-c', '--clean_names',
               'clean, squeeze, downcase the filenames in pwd') do
         debug "Cleaning the pwd: #{fundler.pwd}"
         fundler.clean
       end
+
       opts.on('-l', '--list', 'listing files in pwd') do
         debug "List files in #{fundler.pwd}"
         fundler.list
       end
       
-      opts.on('-b', '--bookmarks', 'a glance on firefox bookmarksdir') do
+      opts.on('-b', '--bookmarks FORMAT', String,
+              'drop firefox bookmarks in txt, html, markdown, json') do |format|
         debug "Bookmarks util"
-        fundler.bookmarks
+        options[:format] = format
+        fundler.bookmarks(format)
       end
+
       opts.on_tail('-V', '--version', 'Show the version.') do
-        $stderr.puts "#{opts.program_name} version: #{Fundler::VERSION}"
-        exit
+        err "#{opts.program_name} version: #{Fundler::VERSION}"
       end
 
       opts.on_tail('-h', '--help', 'This Help.') do
-        $stderr.puts opts
-        exit
+        err opts
       end
     end
 
-    arguments = optparse.parse!
+    begin
+      arguments = optparse.parse!(ARGV)
+    rescue OptionParser::ParseError
+      err optparse.help
+    end
 
-    if arguments.size == 0
-      # err "Argument needed!\n#{optparse.banner}"
+    if arguments.size == 0 
+      #err "Argument needed!\n#{optparse.banner}"
     elsif arguments.size > 1
-      err "You can only specify one directory a time"
+      err "You can only specify one format a time"
     end
 
     if '-' == arguments.first
@@ -96,7 +104,6 @@ class FundlerProgram
 end
 
 #if __FILE__ == $0
-  p Time.now
   FundlerProgram.new.run
 #end
 

data/lib/fundler.rb

@@ -13,13 +13,10 @@ class Fundler
   def pwd
     get_pwd
   end
-  def bookmarks
-    drop_bookmarks
+  def bookmarks(format)
+    drop_bookmarks(format)
   end
   def list
     get_list
   end
-  def drop_bookmarks_file(format = :plain)
-    drop_bookmarks(format)
-  end
 end

data/lib/fundler/bookmarks_reader.rb

@@ -1,105 +1,18 @@
 # coding: utf-8
-require 'sqlite3'
-
-=begin rdoc
-
-== Schema
-http://people.mozilla.org/~dietrich/places-erd.png
-
-== References
-http://stackoverflow.com/questions/464516/firefox-bookmarks-sqlite-structure
-https://developer.mozilla.org/en-US/docs/Places
-https://developer.mozilla.org/en-US/docs/Retrieving_part_of_the_bookmarks_tree
-https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/nsINavBookmarksService
-http://davidkoepi.wordpress.com/2010/11/27/firefoxforensics/
-
-== Queries
-
-select moz_places.url, moz_bookmarks.title 
-from moz_places,moz_bookmarks 
-where moz_places.id = moz_bookmarks.fk and moz_bookmarks.title != '';
 
-select keyword,url 
-from moz_keywords 
-left join moz_bookmarks on (moz_keywords.id = keyword_id) 
-left join moz_places on (fk = moz_places.id);
+require 'sqlite3'
+require 'json'
+require_relative 'fundler_utils'
 
-select moz_places.url, datetime((moz_historyvisits.visit_date/1000000), ‘unixepoch’, ‘localtime’), moz_historyvisits.visit_type 
-from moz_places, moz_historyvisits 
-where moz_historyvisits.place_id = moz_places.id 
-order by moz_historyvisits.visit_date desc;
-=end
+#TODO: make private methods... well, private!
 
 module BookmarksReader
 
+  include QueryConstants
+
   attr_reader :db
 
   MOZILLA_FIREFOX_CONF_DIR = File.expand_path('~') + '/.mozilla/firefox/'
-   
-  # all bookmarks
-  BOOKMARKS_QUERY = <<-SQL
-    SELECT DISTINCT
-        moz_places.url AS url,
-        moz_bookmarks.title AS title,
-        moz_items_annos.content AS description
-    FROM
-        moz_places,
-        moz_bookmarks,
-        moz_items_annos,
-        moz_anno_attributes
-    WHERE
-        moz_anno_attributes.name = 'bookmarkProperties/description' AND
-        moz_items_annos.anno_attribute_id = moz_anno_attributes.id AND
-        moz_items_annos.item_id = moz_bookmarks.id AND
-        moz_places.id = moz_bookmarks.fk AND
-        moz_places.id IN (
-                SELECT DISTINCT fk 
-                FROM moz_bookmarks
-                WHERE parent IN (
-                    SELECT moz_bookmarks.id
-                    FROM moz_bookmarks, moz_bookmarks_roots
-                    WHERE moz_bookmarks_roots.root_name = 'tags'
-                    AND moz_bookmarks.parent = moz_bookmarks_roots.folder_id
-                )
-            )
-    ORDER BY UPPER(moz_bookmarks.title) ASC
-  SQL
-  
-  # tag.id|tag.title
-  QUERY_FOR_TAGS = <<-SQL
-    SELECT id, title FROM moz_bookmarks WHERE parent = 4;
-  SQL
-  
-  # all bookmarks with the "given" tag.id
-  QUERY_BY_TAG = <<-SQL
-    SELECT moz_places.id, moz_places.url, moz_places.title, moz_bookmarks.parent    
-    FROM moz_places    
-    LEFT OUTER JOIN moz_bookmarks    
-    ON moz_places.id = moz_bookmarks.fk    
-    WHERE moz_bookmarks.parent = @tag_id;
-  SQL
-
-  # bookmark.id|bookmark.fk|bookmark.title
-  # ...
-  #=> 1933|1387|SQLite Home Page
-  # ...
-  QUERY_FOR_SIMPLE_BOOKMARKS = <<-SQL
-    SELECT id,fk,title FROM moz_bookmarks WHERE parent = 2;
-  SQL
-
-  # select the link between bookmars and tags
-  # fk_id = 1387
-  #=> 1934|1387|1144
-  QUERY_FOR_LINK = <<-SQL
-    SELECT id,fk,parent FROM moz_bookmarks WHERE title is null AND fk = @fk_id;
-  SQL
-
-  # tag.id|tag.title
-  # parent = 1144
-  #=> 1144|coding
-  QUERY_FOR_TAG_BY_ID = <<-SQL
-    SELECT id, title FROM moz_bookmarks WHERE parent = 4 AND id = @parent;
-  SQL
 
   def find_bookmarks_by_tag(tag_id)
     query = QUERY_BY_TAG
@@ -124,28 +37,49 @@ module BookmarksReader
     db.get_first_row(query)
   end
 
+  def stored_bookmarks
+    # humm... I don't like this choice
+    @stored_bookmarks ||= get_bookmarks_with_tags
+  end
+
+  def bookmarks_count
+    stored_bookmarks.size
+  end
+
   def get_bookmarks_with_tags
-    bookmarks = []
-    result = {}
-    db.execute(QUERY_FOR_SIMPLE_BOOKMARKS) do |bookmark|
-      bookmarks << bookmark
-    end
-    bookmarks.each do |bookmark|
-      bookmark_id, bookmark_fk, bookmark_title = bookmark
-      if bookmark_fk
-        link_query = QUERY_FOR_LINK.sub(/@fk_id/, bookmark_fk.to_s)
-        links = db.execute(link_query) 
-        links.each do |link|
-          link_id, link_fk, link_parent = link
-          tag_query = QUERY_FOR_TAG_BY_ID.gsub(/@parent/, link_parent.to_s)
-          db.execute(tag_query) do |tag|
-            tag_id, tag_title = tag
-            result[bookmark_id] =  "[#{tag_title}] #{bookmark_title}"
+    all = []
+    @stored_bookmarks = {}
+    if db
+      db.execute(QUERY_FOR_SIMPLE_BOOKMARKS) do |bookmark|
+        all << bookmark
+      end
+      all.each do |bookmark|
+        bookmark_id, bookmark_fk, bookmark_title = bookmark
+        if bookmark_fk
+          link_query = QUERY_FOR_LINK.sub(/@fk_id/, bookmark_fk.to_s)
+          links = db.execute(link_query) 
+          links.each do |link|
+            link_id, link_fk, link_parent = link
+            tag_query = QUERY_FOR_TAG_BY_ID.gsub(/@parent/, link_parent.to_s)
+            db.execute(tag_query) do |tag|
+              tag_id, tag_title = tag
+              @stored_bookmarks[bookmark_id] = { tag: tag_title, title: bookmark_title }
+            end
           end
         end
       end
     end
-    result
+    @stored_bookmarks.extend(HashBookmarksUtil)
+  end
+
+  def get_bookmarks_with_url_title_descr_tag
+    unless stored_bookmarks.empty?
+      db.execute(BOOKMARKS_QUERY).each do |bookmark|
+        url, title, id, description = bookmark
+        @stored_bookmarks[id].merge!({url: url, description: description})
+      end
+    end
+    @stored_bookmarks
   end
 
   # +drop_bookmarks+ browse the home directory of the current user,
@@ -154,18 +88,17 @@ module BookmarksReader
   def drop_bookmarks(format = :txt)
     output = []
     if db
-      rows = db.execute(BOOKMARKS_QUERY)
-      rows.each_with_index do |row, index|
-        case format
+      get_bookmarks_with_url_title_descr_tag.each_with_index do |row, index|
+        case format.intern
         when :txt
-          output << "#{index}: #{row.join(' | ')}"
+          output << "#{index}: #{row}"
           output << '---'
         when :html
           puts "TODO"
         when :markdown
           puts "TODO"
         when :json
-          puts "TODO"
+          output << row.to_json
         else
           # exit 1
         end

data/lib/fundler/fundler_utils.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # ---
 
 require 'fileutils'
@@ -47,4 +48,115 @@ module ExitCodeMatchers
       "expect block to call exit(#{code})"
     end
   end
-end
+end # ExitCodeMatchers
+
+=begin rdoc
+
+== Schema
+http://people.mozilla.org/~dietrich/places-erd.png
+
+== References
+http://stackoverflow.com/questions/464516/firefox-bookmarks-sqlite-structure
+https://developer.mozilla.org/en-US/docs/Places
+https://developer.mozilla.org/en-US/docs/Retrieving_part_of_the_bookmarks_tree
+https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/nsINavBookmarksService
+http://davidkoepi.wordpress.com/2010/11/27/firefoxforensics/
+
+== Queries
+
+select moz_places.url, moz_bookmarks.title 
+from moz_places,moz_bookmarks 
+where moz_places.id = moz_bookmarks.fk and moz_bookmarks.title != '';
+
+select keyword,url 
+from moz_keywords 
+left join moz_bookmarks on (moz_keywords.id = keyword_id) 
+left join moz_places on (fk = moz_places.id);
+
+select moz_places.url, datetime((moz_historyvisits.visit_date/1000000), ‘unixepoch’, ‘localtime’), moz_historyvisits.visit_type 
+from moz_places, moz_historyvisits 
+where moz_historyvisits.place_id = moz_places.id 
+order by moz_historyvisits.visit_date desc;
+=end
+
+module QueryConstants
+
+  # all bookmarks
+  BOOKMARKS_QUERY = <<-SQL
+    SELECT DISTINCT
+        moz_places.url AS url,
+        moz_bookmarks.title AS title,
+        moz_bookmarks.id AS id,
+        moz_items_annos.content AS description
+    FROM
+        moz_places,
+        moz_bookmarks,
+        moz_items_annos,
+        moz_anno_attributes
+    WHERE
+        moz_anno_attributes.name = 'bookmarkProperties/description' AND
+        moz_items_annos.anno_attribute_id = moz_anno_attributes.id AND
+        moz_items_annos.item_id = moz_bookmarks.id AND
+        moz_places.id = moz_bookmarks.fk AND
+        moz_places.id IN (
+                SELECT DISTINCT fk 
+                FROM moz_bookmarks
+                WHERE parent IN (
+                    SELECT moz_bookmarks.id
+                    FROM moz_bookmarks, moz_bookmarks_roots
+                    WHERE moz_bookmarks_roots.root_name = 'tags'
+                    AND moz_bookmarks.parent = moz_bookmarks_roots.folder_id
+                )
+            )
+    ORDER BY UPPER(moz_bookmarks.title) ASC
+  SQL
+  
+  # tag.id|tag.title
+  QUERY_FOR_TAGS = <<-SQL
+    SELECT id, title FROM moz_bookmarks WHERE parent = 4;
+  SQL
+  
+  # all bookmarks with the "given" tag.id
+  QUERY_BY_TAG = <<-SQL
+    SELECT moz_places.id, moz_places.url, moz_places.title, moz_bookmarks.parent    
+    FROM moz_places    
+    LEFT OUTER JOIN moz_bookmarks    
+    ON moz_places.id = moz_bookmarks.fk    
+    WHERE moz_bookmarks.parent = @tag_id;
+  SQL
+
+  # bookmark.id|bookmark.fk|bookmark.title
+  # ...
+  #=> 1933|1387|SQLite Home Page
+  # ...
+  QUERY_FOR_SIMPLE_BOOKMARKS = <<-SQL
+    SELECT id,fk,title FROM moz_bookmarks WHERE parent = 2;
+  SQL
+
+  # select the link between bookmars and tags
+  # fk_id = 1387
+  #=> 1934|1387|1144
+  QUERY_FOR_LINK = <<-SQL
+    SELECT id,fk,parent FROM moz_bookmarks WHERE title is null AND fk = @fk_id;
+  SQL
+
+  # tag.id|tag.title
+  # parent = 1144
+  #=> 1144|coding
+  QUERY_FOR_TAG_BY_ID = <<-SQL
+    SELECT id, title FROM moz_bookmarks WHERE parent = 4 AND id = @parent;
+  SQL
+
+end # QueryConstants
+
+module HashBookmarksUtil
+  def sort_bookmarks_by(field)
+    if [:tag, :tile].include?(field.intern) 
+      self.sort_by do |key, value|
+        value[field.intern]
+      end
+    else
+      self
+    end
+  end
+end # HashBookmarksUtil

data/lib/fundler/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 class Fundler
   # The version of the Fundler Utility.
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/spec/fundler_bookmarks_spec.rb

@@ -2,6 +2,7 @@ require 'fundler_spec_helper'
 
 class TestBookmarksFundler
   describe Fundler do
+
     context 'bookmarks functions' do
       let(:fundler) { Fundler.new }
       before(:each) do
@@ -12,10 +13,21 @@ class TestBookmarksFundler
         FileUtils::rm_rf 'test'
       end
       
-      it 'finds bookmarks file' do
+      it 'drop txt bookmarks file' do
         FileUtils::cd './test' do
-          fundler.drop_bookmarks_file(:txt)
+          fundler.bookmarks(:txt)
           expect(fundler.all_files).to include('bookmarks_dump.txt')
+          file_line_count = File.foreach('bookmarks_dump.txt').inject(0) { |c, line| c+=1 }
+          expect(fundler.bookmarks_count).to eq (file_line_count/2)
+        end
+      end
+
+      it 'drop json bookmarks file' do
+        FileUtils::cd './test' do
+          fundler.bookmarks(:json)
+          expect(fundler.all_files).to include('bookmarks_dump.json')
+          file_line_count = File.foreach('bookmarks_dump.json').inject(0) { |c, line| c+=1 }
+          expect(fundler.bookmarks_count).to eq (file_line_count)
         end
       end
 
@@ -23,6 +35,10 @@ class TestBookmarksFundler
         expect { fundler.get_bookmarks_with_tags }.to_not raise_error
       end
 
+      it 'get bookmarks url, title, descr and tag' do
+        expect { fundler.get_bookmarks_with_url_title_descr_tag }.to_not raise_error
+      end
     end # context
+
   end # describe
 end # TestBookmarksFundler

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fundler
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - zeroed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3