bkmrq 0.0.6 → 0.1.1

data/lib/bkmrq/extractors/opera.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module Extractors
+  # Chrome Bookmarks Extractor
+  class Opera
+    def self.extract
+      new.extract
+    end
+
+    def extract
+      File.read(bookmarks_path)
+    end
+
+    def bookmarks_path
+      case RbConfig::CONFIG['host_os']
+      when /mswin|msys|mingw|cygwin|bccwin|wince/i
+        File.expand_path('~/AppData/Roaming/Opera Software/Opera Stable/Bookmarks')
+      when /darwin|mac os/i
+        File.expand_path('~/Library/Application Support/Opera Software/Opera Stable/Bookmarks')
+      when /linux/i, /solaris|bsd/i
+        File.expand_path('~/.config/opera/Bookmarks')
+      else
+        raise Bkmrq::Extractors::Error, 'bkmrq is not supported on your OS.'
+      end
+    end
+  end
+end

data/lib/bkmrq/extractors/safari.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module Extractors
+  # Chrome Bookmarks Extractor
+  class Safari
+    def self.extract
+      new.extract
+    end
+
+    def extract
+      File.read(bookmarks_path)
+    end
+
+    def bookmarks_path
+      unless /darwin|mac os/i.match?(RbConfig::CONFIG['host_os'])
+        raise Bkmrq::Extractors::Error, 'bkmrq does not support Safari on your OS'
+      end
+
+      File.expand_path('~/Library/Safari/Bookmarks.plist')
+    end
+  end
+end

data/lib/bkmrq/filter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bkmrq
+  # TODO: Filters out bookmarks that matched the -x regex
+  class Filter
+    def self.run(parsed_file, opts)
+      return parsed_file if opts[:exclude].nil?
+
+      new.filter(parsed_file, opts[:exclude])
+    end
+
+    def filter(parsed_file, patterns); end
+  end
+end

data/lib/bkmrq/formatters/assets.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Formatters
+  # Markdown Formatter
+  module Assets
+    # Images
+    module Images
+      LIBRARY = 'https://raw.githubusercontent.com/sreedevk/bkmrq/development/assets/library.png'
+    end
+  end
+end

data/lib/bkmrq/formatters/csv.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Formatters
+  # Markdown Formatter
+  class Csv
+    attr_accessor :root
+
+    def initialize(tree)
+      @root = tree
+    end
+  end
+end

data/lib/bkmrq/formatters/formatters.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Application root module
+module Bkmrq
+  require_relative 'csv'
+  require_relative 'html'
+  require_relative 'json'
+  require_relative 'markdown'
+
+  # Formats to markdown/html/toml/json
+  class Formatters
+    def self.run(filtered_bookmarks, opts)
+      Object
+        .const_get("Formatters::#{opts[:format].capitalize}")
+        .format(filtered_bookmarks)
+    end
+  end
+end

data/lib/bkmrq/formatters/html.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../codegen/html_generator'
+
+module Formatters
+  # Html Formatter
+  class Html
+    def self.format(tree)
+      new.format!(tree)
+    end
+
+    def format!(tree)
+      format([], tree)
+    end
+
+    private
+
+    def format_directory(cache, node, level)
+      cache << Codegen::HtmlGenerator.div do
+        [
+          Codegen::HtmlGenerator.header(node.name, level),
+          node.children.map { |child_node| format([], child_node, level.next) }
+        ].flatten.join("\n")
+      end
+    end
+
+    def format_bookmark(cache, node)
+      cache << Codegen::HtmlGenerator.paragraph do
+        Codegen::HtmlGenerator.link(node.name, node.url)
+      end
+    end
+
+    def format(page_cache, node, level = 1)
+      page_cache.tap do |cache|
+        if node.is_a?(Bkmrq::Bookmark)
+          format_bookmark(cache, node)
+        elsif node.is_a?(Bkmrq::BookmarkDir) && node.children?
+          format_directory(cache, node, level)
+        end
+      end
+    end
+  end
+end

data/lib/bkmrq/formatters/json.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../bookmark'
+
+module Formatters
+  # Json Formatter
+  class Json
+    def self.format(tree)
+      new.format!(tree)
+    end
+
+    def format!(tree)
+      Oj.dump(format([], tree))
+    end
+
+    private
+
+    def format(page_cache, node)
+      page_cache.tap do |cache|
+        if node.is_a?(Bkmrq::Bookmark)
+          cache << { name: node.name, url: node.url, type: :bookmark }
+        elsif node.is_a?(Bkmrq::BookmarkDir) && node.children?
+          cache << { name: node.name, children: node.children.map { |child_node| format([], child_node) }, type: :dir }
+        end
+      end
+    end
+  end
+end

data/lib/bkmrq/formatters/markdown.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../bookmark'
+require_relative '../codegen/markdown_generator'
+
+# Formatters
+module Formatters
+  require_relative 'assets'
+
+  # Markdown Formatter
+  class Markdown
+    def self.format(tree)
+      new.format!(tree)
+    end
+
+    def format!(tree)
+      format((method(:add_doc_title) >> method(:add_header_image)).call([]), tree)
+    end
+
+    private
+
+    def format_dir(cache, node, level)
+      cache.push(Codegen::MarkdownGenerator.title(node.name, level))
+      node.children.each do |child_node|
+        format(cache, child_node, level.next)
+      end
+    end
+
+    def format(page_cache, node, level = 1)
+      page_cache.tap do |cache|
+        if node.is_a?(Bkmrq::BookmarkDir) && node.children?
+          format_dir(cache, node, level)
+        elsif node.is_a?(Bkmrq::Bookmark)
+          cache.push(Codegen::MarkdownGenerator.line(Codegen::MarkdownGenerator.link(node.name, node.url)))
+        else
+          raise Bkmrq::Extractors::Error, "Invalid IR Tree Node Detected: #{node.class}"
+        end
+      end
+    end
+
+    def add_doc_title(page_cache)
+      text = "#{ENV.fetch('USER', 'Bkmrq User').capitalize}'s Bookmarks"
+      page_cache.push(Codegen::MarkdownGenerator.title(text))
+    end
+
+    def add_header_image(page_cache)
+      page_cache.push(Codegen::MarkdownGenerator.image(Assets::Images::LIBRARY, 'library'))
+    end
+  end
+end

data/lib/bkmrq/parsers/brave.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'oj'
+require_relative '../bookmark'
+
+module Parsers
+  # Brave Bookmarks Parser
+  class Brave
+    attr_accessor :rawdata
+
+    def initialize(rawdata)
+      @rawdata = rawdata
+    end
+
+    def run
+      Oj.load(rawdata).fetch('roots', {}).then { |roots| parse(Bkmrq::BookmarkDir.new('*'), roots.values) }
+    end
+
+    private
+
+    def bookmark?(node)
+      node['type'].eql?('url')
+    end
+
+    def folder?(node)
+      node['type'].eql?('folder')
+    end
+
+    def parse_bookmark(node, dir)
+      dir.add_child Bkmrq::Bookmark.new(node.slice('guid', 'name', 'url', 'date_added', 'id').transform_keys(&:to_sym))
+    end
+
+    def parse_folder(node, dir)
+      Bkmrq::BookmarkDir.new(node['name']).tap do |new_base_dir|
+        dir.add_child(new_base_dir)
+        parse(new_base_dir, node['children'])
+      end
+    end
+
+    def parse(base_dir, tree)
+      base_dir.tap do |dir|
+        tree.map do |node|
+          if bookmark?(node)
+            parse_bookmark(node, dir)
+          elsif folder?(node) && node['children'].any?
+            parse_folder(node, dir)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bkmrq/parsers/chrome.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'oj'
+require_relative '../bookmark'
+
+module Parsers
+  # Chrome Bookmarks Parser
+  class Chrome
+    attr_accessor :rawdata
+
+    def initialize(rawdata)
+      @rawdata = rawdata
+    end
+
+    def run
+      Oj.load(rawdata).fetch('roots', {}).then { |roots| parse(Bkmrq::BookmarkDir.new('*'), roots.values) }
+    end
+
+    private
+
+    def bookmark?(node)
+      node['type'].eql?('url')
+    end
+
+    def folder?(node)
+      node['type'].eql?('folder')
+    end
+
+    def parse_bookmark(node, dir)
+      dir.add_child Bkmrq::Bookmark.new(node.slice('guid', 'name', 'url', 'date_added', 'id').transform_keys(&:to_sym))
+    end
+
+    def parse_folder(node, dir)
+      Bkmrq::BookmarkDir.new(node['name']).tap do |new_base_dir|
+        dir.add_child(new_base_dir)
+        parse(new_base_dir, node['children'])
+      end
+    end
+
+    def parse(base_dir, tree)
+      base_dir.tap do |dir|
+        tree.map do |node|
+          if bookmark?(node)
+            parse_bookmark(node, dir)
+          elsif folder?(node) && node['children'].any?
+            parse_folder(node, dir)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bkmrq/parsers/chromium.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'oj'
+require_relative '../bookmark'
+
+module Parsers
+  # Chromium Bookmarks Parser
+  class Chromium
+    attr_accessor :rawdata
+
+    def initialize(rawdata)
+      @rawdata = rawdata
+    end
+
+    def run
+      Oj.load(rawdata).fetch('roots', {}).then { |roots| parse(Bkmrq::BookmarkDir.new('*'), roots.values) }
+    end
+
+    private
+
+    def bookmark?(node)
+      node['type'].eql?('url')
+    end
+
+    def folder?(node)
+      node['type'].eql?('folder')
+    end
+
+    def parse_bookmark(node, dir)
+      dir.add_child Bkmrq::Bookmark.new(node.slice('guid', 'name', 'url', 'date_added', 'id').transform_keys(&:to_sym))
+    end
+
+    def parse_folder(node, dir)
+      Bkmrq::BookmarkDir.new(node['name']).tap do |new_base_dir|
+        dir.add_child(new_base_dir)
+        parse(new_base_dir, node['children'])
+      end
+    end
+
+    def parse(base_dir, tree)
+      base_dir.tap do |dir|
+        tree.map do |node|
+          if bookmark?(node)
+            parse_bookmark(node, dir)
+          elsif folder?(node) && node['children'].any?
+            parse_folder(node, dir)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bkmrq/parsers/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../error'
+
+module Parsers
+  # Extranctor Errors
+  class Error < Bkmrq::Error
+    def initialize(message)
+      @input = message
+      super("[BKMRQ ERR] #{input}")
+    end
+  end
+end

data/lib/bkmrq/parsers/firefox.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+module Parsers
+  # Brave Bookmarks Parser
+  class Firefox
+    attr_accessor :rawdata
+
+    def initialize(rawdata)
+      @rawdata = rawdata
+    end
+
+    def run
+      Oj.load(rawdata)
+        .then { |parsed_bookmarks| parsed_bookmarks['roots'] }
+    end
+  end
+end

data/lib/bkmrq/parsers/opera.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+module Parsers
+  # Brave Bookmarks Parser
+  class Opera
+    attr_accessor :rawdata
+
+    def initialize(rawdata)
+      @rawdata = rawdata
+    end
+
+    def run
+      Oj.load(rawdata)
+        .then { |parsed_bookmarks| parsed_bookmarks['roots'] }
+    end
+  end
+end

data/lib/bkmrq/parsers/parsers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Main Module
+module Bkmrq
+  require_relative 'brave'
+  require_relative 'chrome'
+  require_relative 'chromium'
+  require_relative 'firefox'
+  require_relative 'opera'
+  require_relative 'safari'
+  require_relative 'error'
+
+  # Parse Raw Browser Bookmarks
+  module Parsers
+    def self.run(rawdata, opts)
+      Object
+        .const_get("Parsers::#{opts[:browser].capitalize}")
+        .new(rawdata)
+        .run
+    end
+  end
+end

data/lib/bkmrq/parsers/safari.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+module Parsers
+  # Brave Bookmarks Parser
+  class Safari
+    attr_accessor :rawdata
+
+    def initialize(rawdata)
+      @rawdata = rawdata
+    end
+
+    def run
+      Oj.load(rawdata)
+        .then { |parsed_bookmarks| parsed_bookmarks['roots'] }
+    end
+  end
+end

data/lib/bkmrq/ui.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Bkmrq
+  module Ui
+    BANNER = <<-BNR
+        ___  __
+       / _ )/ /__ __ _  _______ _
+      / _  /  '_//  ' \\/ __/ _ `/
+     /____/_/\\_\\/_/_/_/_/  \\_, /
+                            /_/
+    BNR
+
+    USAGE = <<-USG
+    # Examples
+    --------------------------------
+    # Export Bookmarks from Brave Browser in Markdown format
+    $ bkmrq export --to=brave_bookmarks.md --browser=brave --format=markdown
+
+    # Export Bookmarks from Chromium Browser
+    # in Markdown format & exclude bookmarks/folders with the word "php" and "java"
+    $ bkmrq export --to=chromium_books.md --browser=chromium --format=markdown --exclude="php,java"
+    --------------------------------
+
+    # Supported Browsers(--browser=)
+    - brave
+    - chromium
+    - chrome
+    - firefox
+    - opera
+    - safari (mac only)
+
+    # Supported Export Formats (--format=)
+    - markdown
+    - json
+    - html
+    - csv
+    USG
+  end
+end

data/lib/bkmrq/writer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bkmrq
+  # Writes output to file
+  class Writer
+    def self.run(formatted_bookmarks, opts)
+      File.open(opts[:to], 'w+') do |file|
+        file.puts(formatted_bookmarks)
+      end
+    end
+  end
+end

data/lib/bkmrq.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# Main Application Namespace
 module Bkmrq
-  require 'bkmrq/app'
-  require 'bkmrq/browser_config'
-  require 'bkmrq/cli'
-  require 'bkmrq/docs_template'
-  require 'bkmrq/manual'
+  require 'bkmrq/cli/app'
+  VERSION = '0.1.1'
+
+  def self.init
+    Bkmrq::Cli::App.run!
+  end
 end

metadata

@@ -1,30 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: bkmrq
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.1
 platform: ruby
 authors:
-- Sreedev Kodichath
+- sreedev <sreedevpadmakumar@gmail.com>
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
-dependencies: []
-description: Bkmrq Converts Bookmarks stored by your browser in JSON format to a readable
-  markdown format
+date: 2024-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.1
+- !ruby/object:Gem::Dependency
+  name: progress_bar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: |
+  The Bookmark Exporter CLI is a command-line tool for organizing and transferring
+  bookmarks across multiple browsers including Chrome, Firefox, Safari, and Opera.
+  With just a few simple commands, export bookmarks in JSON, Markdown, CSV, and HTML formats.
+  Ideal for automated scripts and command line users, it's fast and efficient.
 email: sreedevpadmakumar@gmail.com
 executables:
 - bkmrq
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
 - bin/bkmrq
+- bkmrq.gemspec
 - lib/bkmrq.rb
-- lib/bkmrq/app.rb
-- lib/bkmrq/browser_config.rb
-- lib/bkmrq/cli.rb
-- lib/bkmrq/docs_template.rb
-- lib/bkmrq/manual.rb
+- lib/bkmrq/application.rb
+- lib/bkmrq/bookmark.rb
+- lib/bkmrq/cli/app.rb
+- lib/bkmrq/cli/arg_parser.rb
+- lib/bkmrq/codegen/html_generator.rb
+- lib/bkmrq/codegen/markdown_generator.rb
+- lib/bkmrq/error.rb
+- lib/bkmrq/extractors/brave.rb
+- lib/bkmrq/extractors/chrome.rb
+- lib/bkmrq/extractors/chromium.rb
+- lib/bkmrq/extractors/error.rb
+- lib/bkmrq/extractors/extractors.rb
+- lib/bkmrq/extractors/firefox.rb
+- lib/bkmrq/extractors/opera.rb
+- lib/bkmrq/extractors/safari.rb
+- lib/bkmrq/filter.rb
+- lib/bkmrq/formatters/assets.rb
+- lib/bkmrq/formatters/csv.rb
+- lib/bkmrq/formatters/formatters.rb
+- lib/bkmrq/formatters/html.rb
+- lib/bkmrq/formatters/json.rb
+- lib/bkmrq/formatters/markdown.rb
+- lib/bkmrq/parsers/brave.rb
+- lib/bkmrq/parsers/chrome.rb
+- lib/bkmrq/parsers/chromium.rb
+- lib/bkmrq/parsers/error.rb
+- lib/bkmrq/parsers/firefox.rb
+- lib/bkmrq/parsers/opera.rb
+- lib/bkmrq/parsers/parsers.rb
+- lib/bkmrq/parsers/safari.rb
+- lib/bkmrq/ui.rb
+- lib/bkmrq/writer.rb
 homepage: https://rubygems.org/gems/bkmrq
 licenses:
 - MIT
@@ -45,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
-summary: Export your browser bookmarks to markdown!
+summary: Cross browser multi-format bookmarks exporter
 test_files: []