bkmrq 0.0.6 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7604f5591402564df015fe49292a7f0a796449d06da7e0629fafdbd8eba00917
-  data.tar.gz: 91969416823b5f17a9b776a41f4e9441960a6d7b748ec9d0e2b9cd6f130e2060
+  metadata.gz: 52e4d9801b5317a0b8f27cdffc18d50cf95e00e468f28574996491c51930fd3b
+  data.tar.gz: d62d04d10c4695b913dd6b5c7a6db0f4d58af0f39838420dfd894e5865690f4c
 SHA512:
-  metadata.gz: f08759adf91f263b6671581bd431d985396b596a79ca1e2f1f93b1fcadda4b36e20f25740c8d9854ef6a1100e3592adb6a0f12de5ed072e9c84dbfa8832baa68
-  data.tar.gz: d2208c4a470c2a8e093100c3542ad0ea9b26191760d9059c30fda5fab30d14bb9c49c45d2ea31b232c766564b7758d07435f8c7e5df0d51944cce88bb5c247a8
+  metadata.gz: 43ec26e9947af243651a640b9a48b22a54a72266e378b338f30037451a29c56751de3bae5c9b2d00a4b8e546cfa6ec7cb655dfd3155ca3f9111ff9d0d9f8300d
+  data.tar.gz: ca6ac79634e312e52cbe32c3acc9682316cdd213cbd3c4a5ca23dd7c23b58db8bd0cee326bbe097edc474ac8a73ead924c88a69d8e25e3432d154eb145e1aad9

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'oj'
+gem 'progress_bar'
+
+group :development do
+  gem 'rspec', '~> 3.12.0'
+  gem 'rubocop', '~> 1.59.0'
+  gem 'rubocop-performance', '~> 1.15.2'
+  gem 'rubocop-rspec', '~> 2.18.1'
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    highline (2.1.0)
+    json (2.6.3)
+    oj (3.14.1)
+    options (2.3.2)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    progress_bar (1.3.3)
+      highline (>= 1.6, < 3)
+      options (~> 2.3.0)
+    rainbow (3.1.1)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    rubytree (2.0.2)
+      json (~> 2.0, > 2.3.1)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  oj
+  progress_bar
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  rubytree
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Sreedev Kodichath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# bkmrq
+bkmrq `(pronounced bookmark)` 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. Specify format and location to easily transfer bookmarks, perfect for backups and sharing.
+
+# Disclaimer
+This project is still under development. If you would like to contribute, please checkout [CONTRIBUTING.md]().  
+Bkmrq Currently only supports the following browsers  
+- Brave (Default Profile Only)
+- Chromium (Default Profile Only)
+- Chrome (Default Profile Only)
+
+The following formats are supported for exporting bookmarks
+- markdown
+- json
+- html
+
+# Installation
+Running Bkmrq requires ruby installed (>= 3.0.0)
+
+```bash
+  gem install bkmrq
+```
+
+# Usage
+```
+        ___  __
+       / _ )/ /__ __ _  _______ _
+      / _  /  '_//  ' \/ __/ _ `/
+     /____/_/\_\/_/_/_/_/  \_, /
+                            /_/
+    # 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
+
+    # OPTIONS:
+    -o, --to=FILEPATH                 save the export file to <FILEPATH>
+    -b, --browser=BROWSER             export bookmarks from <BROWSER>
+    -f, --format=FILEFORMAT           export bookmarks to <FORMAT> File.
+    -x, --exclude=XPATTERNS           exclude bookmarks or folders containing <KEYWORDS>
+    -v, --version                    Print Version
+    -h, --help                       Print help docs
+```
+
+# Examples
+An example markdown file generated using this gemfile is available [here](https://github.com/sreedevk/bookmarks/blob/main/README.md)
+
+Export bookmarks from `Brave Browser` in `markdown` format to `brave_bookmarks.md` file  
+```bash
+$ bkmrq -b brave -f markdown -o brave_bookmarks.md
+```
+
+Export bookmarks from `Brave Browser` in `json` format to `brave_bookmarks.json` file  
+```bash
+$ bkmrq -b brave -f json -o brave_bookmarks.json
+```

data/bin/bkmrq

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'bkmrq/cli'
-Bkmrq::Cli.new(ARGV)
+
+require 'bkmrq'
+Bkmrq.init

data/bkmrq.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'bkmrq'
+  s.version = '0.1.1'
+  s.licenses = ['MIT']
+  s.summary = 'Cross browser multi-format bookmarks exporter'
+  s.description = <<~DESC
+    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.
+  DESC
+  s.authors = ['sreedev <sreedevpadmakumar@gmail.com>']
+  s.email = 'sreedevpadmakumar@gmail.com'
+  s.homepage = 'https://rubygems.org/gems/bkmrq'
+  s.metadata = { 'source_code_uri' => 'https://github.com/sreedevk/bkmrq' }
+  s.executables = ['bkmrq']
+  s.require_paths = ['lib']
+  s.files = [
+    Dir['lib/**/*'].keep_if { |file| File.file?(file) },
+    %w[Gemfile Gemfile.lock LICENSE README.md bkmrq.gemspec]
+  ].flatten
+
+  # Dependencies
+  s.add_dependency 'oj', '~> 3.14.1'
+  s.add_dependency 'progress_bar', '~> 1.3.3'
+end

data/lib/bkmrq/application.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Application Container
+module Bkmrq
+  require_relative 'extractors/extractors'
+  require_relative 'parsers/parsers'
+  require_relative 'filter'
+  require_relative 'formatters/formatters'
+  require_relative 'writer'
+
+  # Application Core
+  class Application
+    attr_accessor :opts
+
+    def initialize(opts: {})
+      @opts = opts
+    end
+
+    def export!
+      Bkmrq::Extractors.run(opts)
+                       .then { |extracted_file| Bkmrq::Parsers.run(extracted_file, opts) }
+                       .then { |parsed_file| Bkmrq::Filter.run(parsed_file, opts) }
+                       .then { |filtered_bookmarks| Bkmrq::Formatters.run(filtered_bookmarks, opts) }
+                       .then { |formatted_bookmarks| Bkmrq::Writer.run(formatted_bookmarks, opts) }
+    end
+  end
+end

data/lib/bkmrq/bookmark.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Bkmrq
+  # Common Bookmark Format for All Browsers
+  class Bookmark
+    attr_accessor :guid, :url, :name, :created_at, :id, :path
+
+    def initialize(opts)
+      @guid = opts[:guid]
+      @name = opts[:name]
+      @path = opts[:path]
+      @url = opts[:url]
+      @created_at = opts[:created_at]
+      @id = opts[:id]
+    end
+  end
+
+  # Bookmark Directory
+  class BookmarkDir
+    attr_accessor :children, :name
+
+    def initialize(name)
+      @name = name
+      @children = Set[]
+    end
+
+    def add_child(child)
+      @children << child
+    end
+
+    def children?
+      @children.any?
+    end
+  end
+end

data/lib/bkmrq/cli/app.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'arg_parser'
+require_relative '../application'
+
+module Bkmrq
+  module Cli
+    # Cli Application Interface
+    class App
+      def self.run!
+        Bkmrq::Application
+          .new(opts: Bkmrq::Cli::ArgParser.parse!)
+          .export!
+      end
+    end
+  end
+end

data/lib/bkmrq/cli/arg_parser.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../../bkmrq'
+require_relative '../ui'
+
+module Bkmrq
+  module Cli
+    # Argument Parser
+    module ArgParser
+      def self.assign_or_raise_arg(options, key, value)
+        raise OptionParser::MissingArgument if value.blank?
+
+        options[key] = value
+      end
+
+      def self.filepath_opt(parser)
+        parser.on(
+          '-o',
+          '--to [FILEPATH]',
+          'save the export file to <FILEPATH>'
+        )
+      end
+
+      def self.browser_opt(parser)
+        parser.on(
+          '-b',
+          '--browser [BROWSER]',
+          %i[chrome chromium brave firefox safari opera],
+          'export bookmarks from <BROWSER>'
+        )
+      end
+
+      def self.format_opt(parser)
+        parser.on(
+          '-f',
+          '--format [FILEFORMAT]',
+          %i[markdown json csv html],
+          'export bookmarks to <FORMAT> File.'
+        )
+      end
+
+      def self.exclude_patterns_opt(parser)
+        parser.on(
+          '-x',
+          '--exclude [XPATTERNS]',
+          'exclude bookmarks or folders containing <KEYWORDS>'
+        )
+      end
+
+      def self.banner(parser)
+        parser.banner = Bkmrq::Ui::BANNER
+        parser.separator Bkmrq::Ui::USAGE
+        parser.separator "\n\s\s\s\s# OPTIONS:\n"
+      end
+
+      def self.version(parser)
+        parser.on('-v', '--version', 'print bkmrq version') do
+          puts "bkmrq v#{Bkmrq::VERSION}"
+          exit
+        end
+      end
+
+      def self.help(parser)
+        parser.on('-h', '--help', 'print bkmrq help docs') do
+          puts parser
+          exit
+        end
+      end
+
+      def self.generate_opt_parser
+        OptionParser.new do |parser|
+          banner(parser)
+          filepath_opt(parser)
+          browser_opt(parser)
+          format_opt(parser)
+          exclude_patterns_opt(parser)
+          version(parser)
+          help(parser)
+        end
+      end
+
+      def self.parse!(parsed = {})
+        parsed.tap do |options|
+          generate_opt_parser.parse!(ARGV, into: options)
+        end
+      end
+    end
+  end
+end

data/lib/bkmrq/codegen/html_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Codegen
+  class HtmlGenerator
+    def self.link(text, url)
+      "<a href=\"#{url}\" target=\"_blank\" rel=\"noopener noreferrer\">#{text}</a>"
+    end
+
+    def self.header(text, level)
+      level = 6 if level > 6
+      "<h#{level}>#{text}</h#{level}>"
+    end
+
+    def self.div
+      <<-HTML
+      <div>#{yield}</div>
+      HTML
+    end
+
+    def self.paragraph
+      <<-HTML
+      <p>#{yield}</p>
+      HTML
+    end
+  end
+end

data/lib/bkmrq/codegen/markdown_generator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Codegenerator module
+module Codegen
+  # Generator for markdown
+  class MarkdownGenerator
+    def self.image(url, alt_text)
+      "![#{alt_text}](#{url})"
+    end
+
+    def self.title(text, level = 1, id = nil)
+      (('#' * level) + " #{text}") + (id ? "{##{id}}" : '')
+    end
+
+    def self.strikethrough(text)
+      "--#{text}--"
+    end
+
+    def self.highlight(text)
+      "==#{text}=="
+    end
+
+    def self.tasklist(items, completed_indices = [])
+      items
+        .map
+        .with_index { |item, index| "- [#{completed_indices.include?(index) ? 'x' : ''}] #{item}" }
+        .join("\n")
+    end
+
+    def self.ordered_list(items)
+      items
+        .map.with_index { |item, index| "#{index.next}. #{item}" }
+        .join("\n")
+    end
+
+    def self.bold(text)
+      "**#{text}**"
+    end
+
+    def self.blockquote(text)
+      "> #{text}"
+    end
+
+    def self.code(text)
+      "`#{text}`"
+    end
+
+    def self.italic(text)
+      "*#{text}*"
+    end
+
+    def self.horizontal_rule
+      '---'
+    end
+
+    def self.link(text, url)
+      "[#{text}](#{url})"
+    end
+
+    def self.line(text)
+      "#{text}  "
+    end
+
+    def self.unordered_list(items)
+      items
+        .map { |item| "- #{item}" }
+        .join("\n")
+    end
+
+    def self.codeblock(text, source_lang = '')
+      <<~CDB
+        ```#{source_lang}
+        #{text}
+        ```
+      CDB
+    end
+  end
+end

data/lib/bkmrq/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bkmrq
+  # Bookmark Error
+  class Error < StandardError
+    attr_accessor :input
+  end
+end

data/lib/bkmrq/extractors/brave.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module Extractors
+  # Chrome Bookmarks Extractor
+  class Brave
+    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/Local/BraveSoftware/Brave-Browser/User Data/Default/Bookmarks')
+      when /darwin|mac os/i
+        File.expand_path('~/Library/Application Support/BraveSoftware/Brave-Browser/Default/Bookmarks')
+      when /linux/i, /solaris|bsd/i
+        File.expand_path('~/.config/BraveSoftware/Brave-Browser/Default/Bookmarks')
+      else
+        raise Bkmrq::Extractors::Error, 'bkmrq is not supported on your OS.'
+      end
+    end
+  end
+end

data/lib/bkmrq/extractors/chrome.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module Extractors
+  # Chrome Bookmarks Extractor
+  class Chrome
+    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/Local/Google/Chrome/User Data/Default/Bookmarks')
+      when /darwin|mac os/i
+        File.expand_path('~/Library/Application Support/Google/Chrome/Default/Bookmarks')
+      when /linux/i, /solaris|bsd/i
+        File.expand_path('~/.config/google-chrome/Default/Bookmarks')
+      else
+        raise Bkmrq::Extractors::Error, 'bkmrq is not supported on your OS.'
+      end
+    end
+  end
+end

data/lib/bkmrq/extractors/chromium.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+require 'pry'
+
+module Extractors
+  # Chrome Bookmarks Extractor
+  class Chromium
+    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/Local/Chromium/User Data/Default/Bookmarks')
+      when /darwin|mac os/i
+        File.expand_path('~/Library/Application Support/Chromium/Default/Bookmarks')
+      when /linux/i, /solaris|bsd/i
+        File.expand_path('~/.config/chromium/Default/Bookmarks')
+      else
+        raise Bkmrq::Extractors::Error, 'bkmrq is not supported on your OS.'
+      end
+    end
+  end
+end

data/lib/bkmrq/extractors/error.rb

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

data/lib/bkmrq/extractors/extractors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Extractors
+module Bkmrq
+  require_relative 'error'
+  require_relative 'brave'
+  require_relative 'chrome'
+  require_relative 'chromium'
+  require_relative 'firefox'
+  require_relative 'opera'
+  require_relative 'safari'
+
+  # Extracts Bookmarks Cross Platform
+  module Extractors
+    def self.run(opts)
+      Object
+        .const_get("Extractors::#{opts[:browser].capitalize}")
+        .extract
+    end
+  end
+end

data/lib/bkmrq/extractors/firefox.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module Extractors
+  # Chrome Bookmarks Extractor
+  class Firefox
+    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/Mozilla/Firefox/Profiles/{PROFILE_FOLDER}/bookmarks.html')
+      when /darwin|mac os/i
+        File.expand_path('~/Library/Application Support/Firefox/Profiles/{PROFILE_FOLDER}/bookmarks.html')
+      when /linux/i, /solaris|bsd/i
+        File.expand_path('~/.mozilla/firefox/{PROFILE_FOLDER}/bookmarks.html')
+      else
+        raise Bkmrq::Extractors::Error, 'bkmrq is not supported on your OS.'
+      end
+    end
+  end
+end