safari_bookmarks_parser 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 707f428c27b200d30b70df6ec9a5f33b681b91144460ae9c973041e3d5fb1af2
-  data.tar.gz: eb151045988fc6226db28cb3ffc562a3a18b4f1a28c52eb0526ecb0ffc978d87
+  metadata.gz: 64c367d9f7044efc558a5aeec069249c6152edfd35081e8cb1bb718bd0531c7c
+  data.tar.gz: 0c65ce14b8b0fb6705dec8eb61d0ac61ede0c039c0873af830fac68becb5cbdd
 SHA512:
-  metadata.gz: bcaebcb7129e64301411f88e6a2275f50c64be6d998406531246c34bf81a436b4ef3b524c5c1edca13a43dfac8c4579a12e68feffe94cd5b01068ba20eaa7086
-  data.tar.gz: 6db98a62641040b2ff3f0da81bd25f19eddf288650ebf9e5ccb1b729c36c211b9c4901b7cfc5dd32a709710bb8c2e28538a34202d3f55b1050fa4621f6330a69
+  metadata.gz: 39daa035d8e210d82ff706e229fee99f4ca705112275c5cc1b5517c1f30e07c67a39da0288cdc3a6bc48cec5ef9cd5f7395b96ee14a7c703dc603493fd1666d1
+  data.tar.gz: 0e81f0eb742de04011d38a42cc25d273d05775478a2a065ea0a190efad67d084724b148f684dab4c47e805feea10740849cacb1af2446270487138deb5616cb3

data/README.md

@@ -22,6 +22,12 @@ Dump `Bookmarks.plist`:
 $ safari_bookmarks_parser dump
 ```
 
+Dump `Bookmarks.plist` to `Bookmarks.json':
+
+```
+$ safari_bookmarks_parser dump -o Bookmarks.json
+```
+
 Dump `Bookmarks.plist` as list:
 
 ```
@@ -52,6 +58,28 @@ Dump other `Bookmarks.plist`:
 $ safari_bookmarks_parser dump /path/to/Bookmarks.plist
 ```
 
+### Dups
+
+Find duplicated bookmarks:
+
+```
+$ safari_bookmarks_parser dups
+```
+
+Find duplicated bookmarks excluding reading list:
+
+```
+$ safari_bookmarks_parser dups -R
+```
+
+### Empty
+
+Find empty folders:
+
+```
+$ safari_bookmarks_parser empty
+```
+
 ## Development
 
   - Run `bin/rubocop` to check syntax

data/lib/safari_bookmarks_parser.rb

@@ -5,9 +5,15 @@ require 'safari_bookmarks_parser/bookmark_folder'
 
 require 'safari_bookmarks_parser/parser'
 
+require 'safari_bookmarks_parser/services/find_duplicated_bookmarks'
+require 'safari_bookmarks_parser/services/find_empty_folders'
+
 require 'safari_bookmarks_parser/runner'
 
+require 'safari_bookmarks_parser/commands/base_command'
 require 'safari_bookmarks_parser/commands/dump_command'
+require 'safari_bookmarks_parser/commands/dups_command'
+require 'safari_bookmarks_parser/commands/empty_command'
 
 require 'safari_bookmarks_parser/version'
 

data/lib/safari_bookmarks_parser/bookmark_folder.rb

@@ -2,10 +2,11 @@
 
 module SafariBookmarksParser
   class BookmarkFolder
-    attr_reader :title, :children
+    attr_reader :title, :folder_names, :children
 
-    def initialize(title:, children: [])
+    def initialize(title:, folder_names:, children: [])
       @title = title
+      @folder_names = folder_names
       @children = children
     end
 
@@ -20,7 +21,7 @@ module SafariBookmarksParser
     end
 
     def to_h
-      { 'title' => title, 'children' => children.map(&:to_h) }
+      { 'title' => title, 'folder_names' => folder_names, 'children' => children.map(&:to_h) }
     end
 
     def to_json(options)

data/lib/safari_bookmarks_parser/commands/base_command.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'optparse'
+require 'yaml'
+
+module SafariBookmarksParser
+  module Commands
+    class BaseCommand
+      attr_reader :plist_path, :output_path, :output_format
+
+      def initialize(argv)
+        @plist_path = File.expand_path('~/Library/Safari/Bookmarks.plist')
+        @output_path = nil
+        @output_format = :json
+
+        parse_options(argv)
+        handle_argv(argv)
+      end
+
+      private
+
+      def format_to_text(obj)
+        case @output_format
+        when :json
+          JSON.pretty_generate(obj)
+        when :yaml
+          YAML.dump(obj)
+        end
+      end
+
+      def output_text(text)
+        if @output_path
+          File.write(@output_path, text)
+        else
+          puts text
+        end
+      end
+
+      def on_output_path(parser)
+        parser.on('-o', '--output-path=PATH', 'Output path (default: output to $stdout)') do |value|
+          @output_path = value
+        end
+      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 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
+    end
+  end
+end

data/lib/safari_bookmarks_parser/commands/dump_command.rb

@@ -1,41 +1,31 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'optparse'
-require 'yaml'
-
 module SafariBookmarksParser
   module Commands
-    class DumpCommand
-      attr_reader :plist_path, :output_path, :output_format, :output_style, :output_parts
+    class DumpCommand < BaseCommand
+      attr_reader :output_style, :output_parts
 
       def initialize(argv)
-        @plist_path = File.expand_path('~/Library/Safari/Bookmarks.plist')
-        @output_path = nil
-        @output_format = :json
         @output_style = :tree
         @output_parts = :all
 
-        @option_parser = nil
-
-        parse_options(argv)
-        handle_argv(argv)
+        super
       end
 
       def run
         plist_parser = Parser.parse(@plist_path)
 
-        result = result_for_output_parts(plist_parser)
-        result = result_for_output_style(result)
+        result = select_output_parts(plist_parser)
+        result = select_output_style(result)
 
-        text = format_result(result)
+        text = format_to_text(result)
 
         output_text(text)
       end
 
       private
 
-      def result_for_output_parts(plist_parser)
+      def select_output_parts(plist_parser)
         case @output_parts
         when :all
           plist_parser.root_folder
@@ -46,7 +36,7 @@ module SafariBookmarksParser
         end
       end
 
-      def result_for_output_style(result)
+      def select_output_style(result)
         case @output_style
         when :tree
           result.to_h
@@ -55,23 +45,6 @@ module SafariBookmarksParser
         end
       end
 
-      def format_result(result)
-        case @output_format
-        when :json
-          JSON.pretty_generate(result)
-        when :yaml
-          YAML.dump(result)
-        end
-      end
-
-      def output_text(text)
-        if @output_path
-          File.write(@output_path, text)
-        else
-          puts text
-        end
-      end
-
       def parse_options(argv)
         parser = OptionParser.new
 
@@ -84,24 +57,11 @@ module SafariBookmarksParser
         on_list(parser)
 
         on_reading_list_only(parser)
-        on_omit_reading_list(parser)
+        on_exclude_reading_list(parser)
 
         do_parse(parser, argv)
       end
 
-      def on_output_path(parser)
-        parser.on('-o', '--output-path=PATH', 'Output path (default: output to $stdout)') do |value|
-          @output_path = value
-        end
-      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
@@ -120,22 +80,12 @@ module SafariBookmarksParser
         end
       end
 
-      def on_omit_reading_list(parser)
-        parser.on('-R', 'Omit reading list') do
+      def on_exclude_reading_list(parser)
+        parser.on('-R', 'Exclude 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

data/lib/safari_bookmarks_parser/commands/dups_command.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module SafariBookmarksParser
+  module Commands
+    class DupsCommand < BaseCommand
+      attr_reader :exclude_reading_list
+
+      def initialize(argv)
+        @exclude_reading_list = false
+
+        super
+      end
+
+      def run
+        plist_parser = Parser.parse(@plist_path)
+
+        bookmarks = bookmarks_to_process(plist_parser).to_a
+
+        duplicated_bookmark_groups = Services::FindDuplicatedBookmarks.call(bookmarks: bookmarks)
+
+        return if duplicated_bookmark_groups.empty?
+
+        duplicated_bookmark_groups = duplicated_bookmark_groups.map do |group|
+          group.map(&:to_h)
+        end
+
+        text = format_to_text(duplicated_bookmark_groups)
+
+        output_text(text)
+      end
+
+      private
+
+      def bookmarks_to_process(plist_parser)
+        if @exclude_reading_list
+          plist_parser.root_folder_without_reading_list
+        else
+          plist_parser.root_folder
+        end
+      end
+
+      def parse_options(argv)
+        parser = OptionParser.new
+
+        parser.banner = "Usage: #{parser.program_name} dups [options] [~/Library/Safari/Bookmarks.plist]"
+
+        on_output_path(parser)
+        on_output_format(parser)
+
+        on_exclude_reading_list(parser)
+
+        do_parse(parser, argv)
+      end
+
+      def on_exclude_reading_list(parser)
+        parser.on('-R', "Exclude reading list (default: #{@exclude_reading_list})") do
+          @exclude_reading_list = true
+        end
+      end
+
+      Runner.register_command(:dups, self)
+    end
+  end
+end

data/lib/safari_bookmarks_parser/commands/empty_command.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SafariBookmarksParser
+  module Commands
+    class EmptyCommand < BaseCommand
+      def run
+        plist_parser = Parser.parse(@plist_path)
+
+        empty_folders = Services::FindEmptyFolders.call(root_folder: plist_parser.root_folder)
+
+        return if empty_folders.empty?
+
+        text = format_to_text(empty_folders.map(&:to_h))
+
+        output_text(text)
+      end
+
+      private
+
+      def parse_options(argv)
+        parser = OptionParser.new
+
+        parser.banner = "Usage: #{parser.program_name} empty [options] [~/Library/Safari/Bookmarks.plist]"
+
+        on_output_path(parser)
+        on_output_format(parser)
+
+        do_parse(parser, argv)
+      end
+
+      Runner.register_command(:empty, self)
+    end
+  end
+end

data/lib/safari_bookmarks_parser/parser.rb

@@ -65,7 +65,7 @@ module SafariBookmarksParser
         traverse(child, folder_names + [title])
       end.compact
 
-      BookmarkFolder.new(title: title, children: children)
+      BookmarkFolder.new(title: title, folder_names: folder_names, children: children)
     end
 
     def accept_leaf(node, folder_names)
@@ -80,6 +80,8 @@ module SafariBookmarksParser
     end
 
     def binary_plist_to_xml_plist(binary_plist_path)
+      binary_plist_readable?(binary_plist_path)
+
       Tempfile.open(['Bookmarks', '.xml']) do |tempfile|
         command = ['plutil', '-convert', 'xml1', '-o', tempfile.path, binary_plist_path]
 
@@ -88,5 +90,16 @@ module SafariBookmarksParser
         tempfile.read
       end
     end
+
+    def binary_plist_readable?(binary_plist_path)
+      return if File.readable?(binary_plist_path)
+
+      message = <<~MESSAGE
+        Couldn't read #{binary_plist_path}
+        In "System Preferences" -> "Security & Privacy" -> "Privacy" -> "Full Disk Access", check "Terminal".
+      MESSAGE
+
+      raise Error, message
+    end
   end
 end

data/lib/safari_bookmarks_parser/runner.rb

@@ -45,6 +45,8 @@ module SafariBookmarksParser
         Available commands are:
 
           - dump
+          - dups
+          - empty
       MESSAGE
     end
 

data/lib/safari_bookmarks_parser/services/find_duplicated_bookmarks.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SafariBookmarksParser
+  module Services
+    class FindDuplicatedBookmarks
+      def self.call(bookmarks:)
+        cache = Hash.new {|hash, key| hash[key] = [] }
+
+        bookmarks.to_a.each do |bookmark|
+          key = bookmark.url.sub(%r{\Ahttps?://}, '')
+          cache[key] << bookmark
+        end
+
+        cache.select {|_, value| value.size > 1 }.values
+      end
+    end
+  end
+end

data/lib/safari_bookmarks_parser/services/find_empty_folders.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SafariBookmarksParser
+  module Services
+    class FindEmptyFolders
+      class << self
+        def call(root_folder:)
+          results = []
+
+          traverse(root_folder, results)
+
+          results
+        end
+
+        def traverse(node, results)
+          case node
+          when BookmarkFolder
+            if node.children.empty?
+              results << node
+            else
+              node.children.each do |child|
+                traverse(child, results)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/safari_bookmarks_parser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safari_bookmarks_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - healthypackrat
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -38,9 +38,14 @@ files:
 - lib/safari_bookmarks_parser.rb
 - lib/safari_bookmarks_parser/bookmark.rb
 - lib/safari_bookmarks_parser/bookmark_folder.rb
+- lib/safari_bookmarks_parser/commands/base_command.rb
 - lib/safari_bookmarks_parser/commands/dump_command.rb
+- lib/safari_bookmarks_parser/commands/dups_command.rb
+- lib/safari_bookmarks_parser/commands/empty_command.rb
 - lib/safari_bookmarks_parser/parser.rb
 - lib/safari_bookmarks_parser/runner.rb
+- lib/safari_bookmarks_parser/services/find_duplicated_bookmarks.rb
+- lib/safari_bookmarks_parser/services/find_empty_folders.rb
 - lib/safari_bookmarks_parser/version.rb
 homepage: https://github.com/healthypackrat/safari_bookmarks_parser
 licenses: