bkmrq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 74e53ea64f34ff615830f694cb0ee20c81bdff858f231675a427bf10e17edb47
+  data.tar.gz: f0e3fe29ddd97c9a4623c924112dc26c10d2513179fad931b2c88398206f52e5
+SHA512:
+  metadata.gz: 51a26495b2828cd4a578ed3053644c722485f07231dd6fafef99f0b3055b7907c579e911e2ea101ecd7116cd986c8857e606c784156419448deaf212b584f741
+  data.tar.gz: 69f84df5c8c0e32e227e51cbe0e03fa5f869ec8c49994535006af0a1b9a388593a9e523c60b735a5058c7f17ebf170fbec14031d556a280a876fb97358d37d28

data/bin/bkmrq

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+
+SELFDIR=$(dirname "$0")
+ruby "${SELFDIR}/../lib/app.rb" "$*"

data/lib/app.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'cli'
+
+Bkmrq::Cli.new(ARGV)

data/lib/bkmrq.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'docs_template'
+require_relative 'browser_config'
+
+module Bkmrq
+  # Bookmarks Document Generator
+  class App
+    BLOCKLIST = ENV.fetch('BKMRQ_BLOCKLIST', '(pdf|google|file:)').split(',').map(&:strip)
+
+    def initialize(browser: :brave, bookmarks_input: nil)
+      @bookmarks_input = bookmarks_input || Bkmrq::BROWSER_CONFIG.dig(browser, :bookmark_file_path)
+    end
+
+    def export!
+      write_template
+      export(bookmarks['bookmark_bar'])
+      export(bookmarks['other'])
+      export(bookmarks['synced'])
+      output_file.close
+    end
+
+    private
+
+    def output_file
+      @output_file ||= ::File.open(
+        "bkmrq_export_#{String(Integer(Time.now))[0..-2]}.md",
+        'w+'
+      )
+    end
+
+    def bookmarks
+      @bookmarks ||= ::File.open(@bookmarks_input, 'r') do |file|
+        JSON.parse(file.read)['roots']
+      end
+    end
+
+    def write_template
+      %i[title subtitle header_image description]
+        .map(&Bkmrq::DocsTemplate.method(:public_send))
+        .map(&output_file.method(:write))
+    end
+
+    def export(marqs = bookmarks, level = 1)
+      return if skip_export?(marqs)
+
+      output_file.write(generate_formatted_entity(marqs, level))
+      marqs.fetch('children', []).empty? ||
+        marqs['children'].map { |child| export(child, level + 1) }
+    end
+
+    def skip_export?(bookmark_section)
+      [bookmark_section['name'], bookmark_section['name']].any? do |meta|
+        BLOCKLIST.any? { |pattern| !meta&.match(pattern).nil? }
+      end
+    end
+
+    def generate_formatted_entity(bookmark, level)
+      if bookmark['url'].nil?
+        generate_bookmark_title(bookmark, level)
+      else
+        generate_bookmark_link(bookmark, level)
+      end
+    end
+
+    def generate_bookmark_title(bookmark, level)
+      [
+        ' ' * level,
+        '#' * level,
+        "#{bookmark['name']}\n"
+      ].join(' ')
+    end
+
+    def generate_bookmark_link(bookmark, level)
+      [
+        ' ' * level,
+        "[#{bookmark['name']}](#{bookmark['url']})  \n"
+      ].join(' ')
+    end
+  end
+end

data/lib/browser_config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Bkmrq
+module Bkmrq
+  USER_HOME             = ENV.fetch('HOME', ::File.join('home', ENV['USER']))
+
+  BRAVE_BROWSER_CONFIG  = {
+    bookmark_file_path: File.join(
+      USER_HOME, '.config', 'BraveSoftware', 'Brave-Browser', 'Default', 'Bookmarks'
+    ),
+    root: 'roots'
+  }.freeze
+
+  CHROME_BROWSER_CONFIG = {
+    bookmark_file_path: File.join(USER_HOME, '.config', 'chromium', 'Default', 'Bookmarks'),
+    root: 'roots'
+  }.freeze
+
+  BROWSER_CONFIG = {
+    brave: BRAVE_BROWSER_CONFIG,
+    chrome: CHROME_BROWSER_CONFIG
+  }.freeze
+end

data/lib/cli.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'optparse'
+require 'pry'
+
+require_relative 'bkmrq'
+require_relative 'manual'
+
+module Bkmrq
+  # Cli
+  class Cli
+    def initialize(args)
+      @opts = {}
+      option_parser.parse!(sanitize_args(args), into: @opts)
+    end
+
+    private
+
+    def option_parser
+      @option_parser ||= OptionParser.new do |args|
+        # Option Parsing
+        Bkmrq::Manual.options_specs.map do |option_spec|
+          option_key = option_spec.pop
+          args.on(*option_spec) { |input| @opts.send(:[]=, option_key, input) }
+        end
+
+        # Manual Printing
+        args.banner = Bkmrq::Manual::BANNER
+        args.on_tail('-H', '--help', 'Bkmrq Manual') { puts args }
+      end
+    end
+
+    def sanitize_args(args)
+      args.reject(&:empty?).map(&:scrub).map(&:split).flatten
+    end
+  end
+end

data/lib/docs_template.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Bkmrq
+  # document output template
+  class DocsTemplate
+    FORMAT = {
+      title: "#{ENV['USER']}'s Web Browser Bookmarks",
+      subtitle: 'Bookmarks Exported Using Bkmrq',
+      header_image: 'https://user-images.githubusercontent.com/36154121/137836028-8dfe3001-4626-47a0-880f-d3dc7b719e27.jpeg',
+      description: <<-MD
+      This file was auto generated using the [bkmrq](https://github.com/sreedevk/bkmrq) gem.
+      MD
+    }.freeze
+
+    def self.title
+      "# #{FORMAT[:title]}  \n"
+    end
+
+    def self.subtitle
+      "## #{FORMAT[:subtitle]}  \n"
+    end
+
+    def self.header_image
+      "![](#{FORMAT[:header_image]})  \n"
+    end
+
+    def self.description
+      FORMAT[:description]
+    end
+  end
+end

data/lib/manual.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Bookmarks Manual
+module Bkmrq
+  # Package Manual
+  class Manual
+    BANNER = <<-MAN
+    Bkmrq - Export your bookmarks to markdown
+
+    # Supported Browsers
+    - brave
+    - chromium
+    MAN
+
+    def self.options_specs
+      [
+        browser_opt_specs,
+        input_file_opt_specs,
+        output_file_opt_specs,
+        edit_opt_specs
+      ]
+    end
+
+    def self.browser_opt_specs
+      [
+        '-B BROWSER',
+        '--browser BROWSER',
+        String,
+        'Browser (Loads Default Configs)', :browser
+      ]
+    end
+
+    def self.input_file_opt_specs
+      [
+        '-F FILE',
+        '--input-file FILE',
+        String,
+        'Bookmarks file generated by your browser. (JSON FORMAT ONLY)',
+        :'input-file'
+      ]
+    end
+
+    def self.output_file_opt_specs
+      [
+        '-O FILE',
+        '--output-file FILE',
+        String,
+        'Filepath for markdown generated by Bkmrq',
+        :'output-file'
+      ]
+    end
+
+    def self.edit_opt_specs
+      [
+        '-E',
+        '--edit',
+        'Load Generated Markdown in $EDITOR (will not persist generated output)',
+        :edit
+      ]
+    end
+
+    private_class_method :browser_opt_specs, :input_file_opt_specs, :output_file_opt_specs, :edit_opt_specs
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: bkmrq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sreedev Kodichath
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-04 00:00:00.000000000 Z
+dependencies: []
+description: Bkmrq Converts Bookmarks stored by your browser in JSON format to a readable
+  markdown format
+email: sreedevpadmakumar@gmail.com
+executables:
+- bkmrq
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/bkmrq
+- lib/app.rb
+- lib/bkmrq.rb
+- lib/browser_config.rb
+- lib/cli.rb
+- lib/docs_template.rb
+- lib/manual.rb
+homepage: https://rubygems.org/gems/bkmrq
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/sreedevk/bkmrq
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Export your browser bookmarks to markdown!
+test_files: []