safari_bookmarks_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b79cf6a3fb83906b78ab06394d50c9cf2d15abed628a4951cc32a0d209aaed2
+  data.tar.gz: 590db97d372270a5880a857885fa8ac6a836b63e61c55a83844cd9f3a0de35c0
+SHA512:
+  metadata.gz: 75e07a0d4a48b2569b6164284f5f626bb6dba173a98678b6fe1a0875484eaa400a9673d76330ba9f34850507127474c3adaa8c01dd7b43fc4eb9e1bf518afc64
+  data.tar.gz: 44eece1dad295720cd00f30319fa9e37e837e7a66cd69bd7975d4900de542c84eaa384b31ddffea13d99034e1b4b6673feedeb3157e288395d323541ccc5a18c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 healthypackrat
+
+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,62 @@
+# safari\_bookmarks\_parser
+
+This gem provides a command to dump `~/Library/Safari/Bookmarks.plist` as JSON/YAML.
+
+## Installation
+
+```
+$ gem install safari_bookmarks_parser
+```
+
+## Usage
+
+### Dump
+
+Dump `Bookmarks.plist`:
+
+```
+$ safari_bookmarks_parser dump
+```
+
+Dump `Bookmarks.plist` as list:
+
+```
+$ safari_bookmarks_parser dump --list
+```
+
+Dump `Bookmarks.plist` as YAML:
+
+```
+$ safari_bookmarks_parser dump -f yaml
+```
+
+Dump Reading List only:
+
+```
+$ safari_bookmarks_parser dump -r
+```
+
+Dump without Reading List:
+
+```
+$ safari_bookmarks_parser dump -R
+```
+
+Dump other `Bookmarks.plist`:
+
+```
+$ safari_bookmarks_parser dump /path/to/Bookmarks.plist
+```
+
+## Development
+
+  - Run `bin/rubocop` to check syntax
+  - Run `bin/rspec` to test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/healthypackrat/safari_bookmarks_parser>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/safari_bookmarks_parser

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'safari_bookmarks_parser'
+
+begin
+  runner = SafariBookmarksParser::Runner.new(ARGV)
+  runner.run
+rescue SafariBookmarksParser::Error => e
+  warn e.message
+  exit 1
+end

data/lib/safari_bookmarks_parser.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'safari_bookmarks_parser/bookmark'
+require 'safari_bookmarks_parser/bookmark_folder'
+
+require 'safari_bookmarks_parser/parser'
+
+require 'safari_bookmarks_parser/runner'
+
+require 'safari_bookmarks_parser/commands/dump_command'
+
+require 'safari_bookmarks_parser/version'
+
+module SafariBookmarksParser
+  class Error < StandardError; end
+end

data/lib/safari_bookmarks_parser/bookmark.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SafariBookmarksParser
+  class Bookmark
+    attr_reader :url, :title, :folder_names
+
+    def initialize(url:, title:, folder_names:)
+      @url = url
+      @title = title
+      @folder_names = folder_names
+    end
+
+    def to_h
+      { 'url' => url, 'title' => title, 'folder_names' => folder_names }
+    end
+
+    def to_json(options)
+      to_h.to_json(options)
+    end
+  end
+end

data/lib/safari_bookmarks_parser/bookmark_folder.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SafariBookmarksParser
+  class BookmarkFolder
+    attr_reader :title, :children
+
+    def initialize(title:, children: [])
+      @title = title
+      @children = children
+    end
+
+    def empty?
+      to_a.empty?
+    end
+
+    def to_a
+      results = []
+      traverse(self, results)
+      results
+    end
+
+    def to_h
+      { 'title' => title, 'children' => children.map(&:to_h) }
+    end
+
+    def to_json(options)
+      to_h.to_json(options)
+    end
+
+    private
+
+    def traverse(node, results)
+      case node
+      when BookmarkFolder
+        node.children.each do |child|
+          traverse(child, results)
+        end
+      when Bookmark
+        results << node
+      end
+    end
+  end
+end

data/lib/safari_bookmarks_parser/commands/dump_command.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'optparse'
+require 'yaml'
+
+module SafariBookmarksParser
+  module Commands
+    class DumpCommand
+      attr_reader :plist_path, :output_format, :output_style, :output_parts
+
+      def initialize(argv)
+        @plist_path = File.expand_path('~/Library/Safari/Bookmarks.plist')
+        @output_format = :json
+        @output_style = :tree
+        @output_parts = :all
+
+        @option_parser = nil
+
+        parse_options(argv)
+        handle_argv(argv)
+      end
+
+      def run
+        plist_parser = Parser.parse(@plist_path)
+
+        result = result_for_output_parts(plist_parser)
+        result = result_for_output_style(result)
+
+        output_result(result)
+      end
+
+      def result_for_output_parts(plist_parser)
+        case @output_parts
+        when :all
+          plist_parser.root_folder
+        when :bookmarks
+          plist_parser.root_folder_without_reading_list
+        when :reading_list
+          plist_parser.reading_list
+        end
+      end
+
+      def result_for_output_style(result)
+        case @output_style
+        when :tree
+          result.to_h
+        when :list
+          result.to_a.map(&:to_h)
+        end
+      end
+
+      def output_result(result)
+        case @output_format
+        when :json
+          puts JSON.pretty_generate(result)
+        when :yaml
+          puts YAML.dump(result)
+        end
+      end
+
+      private
+
+      def parse_options(argv)
+        parser = OptionParser.new
+
+        parser.banner = "Usage: #{parser.program_name} dump [options] [~/Library/Safari/Bookmarks.plist]"
+
+        on_output_format(parser)
+
+        on_tree(parser)
+        on_list(parser)
+
+        on_reading_list_only(parser)
+        on_omit_reading_list(parser)
+
+        do_parse(parser, argv)
+      end
+
+      def on_output_format(parser)
+        desc = "Output format (default: #{@output_format}; one of json or yaml)"
+        parser.on('-f', '--output-format=FORMAT', %w[json yaml], desc) do |value|
+          @output_format = value.to_sym
+        end
+      end
+
+      def on_tree(parser)
+        parser.on('--tree', 'Output as tree (default)') do
+          @output_style = :tree
+        end
+      end
+
+      def on_list(parser)
+        parser.on('--list', 'Output as list') do
+          @output_style = :list
+        end
+      end
+
+      def on_reading_list_only(parser)
+        parser.on('-r', 'Output reading list only') do
+          @output_parts = :reading_list
+        end
+      end
+
+      def on_omit_reading_list(parser)
+        parser.on('-R', 'Omit reading list') do
+          @output_parts = :bookmarks
+        end
+      end
+
+      def do_parse(parser, argv)
+        parser.parse!(argv)
+      rescue OptionParser::ParseError => e
+        raise Error, e.message
+      end
+
+      def handle_argv(argv)
+        @plist_path = argv.first if argv.any?
+      end
+
+      Runner.register_command(:dump, self)
+    end
+  end
+end

data/lib/safari_bookmarks_parser/parser.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'tempfile'
+
+require 'plist'
+
+module SafariBookmarksParser
+  def self.parse(binary_plist_path)
+    Parser.parse(binary_plist_path)
+  end
+
+  class Parser
+    READING_LIST_KEY = 'com.apple.ReadingList'
+
+    def self.parse(binary_plist_path)
+      new.parse(binary_plist_path)
+    end
+
+    attr_reader :root_folder, :root_folder_without_reading_list, :reading_list
+
+    def initialize
+      @root_folder = nil
+      @root_folder_without_reading_list = nil
+      @reading_list = nil
+    end
+
+    def parse(binary_plist_path)
+      root_node = parse_xml_plist(binary_plist_to_xml_plist(binary_plist_path))
+
+      parse_combined(root_node)
+      parse_splitted(root_node)
+
+      self
+    end
+
+    private
+
+    def parse_combined(root_node)
+      @root_folder = traverse(root_node)
+    end
+
+    def parse_splitted(root_node)
+      root_folder = traverse(root_node)
+
+      index = root_folder.children.find_index {|child| child.title == READING_LIST_KEY }
+      @reading_list = root_folder.children.delete_at(index) if index
+
+      @root_folder_without_reading_list = root_folder
+    end
+
+    def traverse(node, folder_names = [])
+      case node.fetch('WebBookmarkType')
+      when 'WebBookmarkTypeList'
+        accept_list(node, folder_names)
+      when 'WebBookmarkTypeLeaf'
+        accept_leaf(node, folder_names)
+      end
+    end
+
+    def accept_list(node, folder_names)
+      title = node.fetch('Title')
+
+      children = node.fetch('Children', []).map do |child|
+        traverse(child, folder_names + [title])
+      end.compact
+
+      BookmarkFolder.new(title: title, children: children)
+    end
+
+    def accept_leaf(node, folder_names)
+      url = node.fetch('URLString')
+      title = node.fetch('URIDictionary').fetch('title')
+
+      Bookmark.new(url: url, title: title, folder_names: folder_names)
+    end
+
+    def parse_xml_plist(xml_plist)
+      Plist.parse_xml(xml_plist)
+    end
+
+    def binary_plist_to_xml_plist(binary_plist_path)
+      Tempfile.open(['Bookmarks', '.xml']) do |tempfile|
+        command = ['plutil', '-convert', 'xml1', '-o', tempfile.path, binary_plist_path]
+
+        raise Error, "plutil returned #{$CHILD_STATUS.exitstatus}" unless system(*command)
+
+        tempfile.read
+      end
+    end
+  end
+end

data/lib/safari_bookmarks_parser/runner.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module SafariBookmarksParser
+  class Runner
+    class << self
+      def known_commands
+        @known_commands ||= {}
+      end
+
+      def register_command(command_name, command_class)
+        known_commands[command_name.to_sym] = command_class
+      end
+    end
+
+    def initialize(argv)
+      @argv = argv.dup
+
+      @parser = nil
+
+      parse_options(@argv)
+    end
+
+    def run
+      command_name = @argv.shift
+
+      if command_name
+        command_class = self.class.known_commands[command_name.to_sym]
+
+        raise Error, "unknown command: #{command_name}" unless command_class
+
+        command_class.new(@argv).run
+      else
+        show_help(@parser)
+      end
+    end
+
+    private
+
+    def show_help(parser)
+      puts parser
+      puts
+      puts <<~MESSAGE
+        Available commands are:
+
+          - dump
+      MESSAGE
+    end
+
+    def parse_options(argv)
+      parser = OptionParser.new
+
+      parser.banner = "Usage: #{parser.program_name} [options] command"
+
+      parser.version = VERSION
+
+      on_show_help(parser)
+      on_show_version(parser)
+
+      do_parse(parser, argv)
+
+      @parser = parser
+    end
+
+    def on_show_help(parser)
+      parser.on('-h', '--help', 'Show this message') do
+        show_help(parser)
+        exit
+      end
+    end
+
+    def on_show_version(parser)
+      parser.on('-v', '--version', 'Show version number') do
+        puts "#{parser.program_name} #{VERSION}"
+        exit
+      end
+    end
+
+    def do_parse(parser, argv)
+      parser.order!(argv)
+    rescue OptionParser::ParseError => e
+      raise Error, e.message
+    end
+  end
+end

data/lib/safari_bookmarks_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SafariBookmarksParser
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: safari_bookmarks_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- healthypackrat
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description:
+email:
+- healthypackrat@gmail.com
+executables:
+- safari_bookmarks_parser
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/safari_bookmarks_parser
+- lib/safari_bookmarks_parser.rb
+- lib/safari_bookmarks_parser/bookmark.rb
+- lib/safari_bookmarks_parser/bookmark_folder.rb
+- lib/safari_bookmarks_parser/commands/dump_command.rb
+- lib/safari_bookmarks_parser/parser.rb
+- lib/safari_bookmarks_parser/runner.rb
+- lib/safari_bookmarks_parser/version.rb
+homepage: https://github.com/healthypackrat/safari_bookmarks_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/healthypackrat/safari_bookmarks_parser
+  source_code_uri: https://github.com/healthypackrat/safari_bookmarks_parser
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- plutil
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Dump ~/Library/Safari/Bookmarks.plist as JSON/YAML
+test_files: []