booker 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51a33aad3cbed45ed09f6fa35f2046223dca0d5dd82fe15be7c49cb8aaa4c41d
-  data.tar.gz: 3054f0c7657e98c6c794b768ca9450992d3ee83b91526fc9cb88c5de6a4bc5ad
+  metadata.gz: a0f32b2a81f8c03acdc8c56ce6f9554a1229aced8a731d103fbfd53f1d03b5d3
+  data.tar.gz: 2d0386dcc31468311faaac5e5ec749d19623ad40f9f6b083a86b77cd9632be01
 SHA512:
-  metadata.gz: e6ced499e2b20d75987fc8c538b95bfb5a9912549b49848c0b6e827bc3c5f8dd3aed72c17c585b5080d16c60a48832d57f6a829d5ebf465f9068969418dc4898
-  data.tar.gz: fb1a648048fbe579ae1cdaee106da02fc1dc345874119fa0ef846dbc1d0631e63dbec150c5509b66a325ecce991969acf369ce5b096b9571d4c97269294bb66a
+  metadata.gz: 963773985475ebf1a6e9c2fa340ceb79a607e4dd052e7c0dab1507881c0cd736f881388e7bd0445e8381dd69d561ead3bc14a9d940aed1cd08c07eb3770dc593
+  data.tar.gz: 279afd708175be5626eea44dfe3733ad435f4bb527dc4c9995bb97027376df4551b84c464f9d9ac69150cecddeb440b15b3d03f7eb8b1d706ef26589e8d03e4b

data/lib/booker/cli.rb

@@ -13,10 +13,10 @@ module Booker
 
     # a bookmark id is "<source index>_<browser id>". safari uses a uuid where
     # chrome and firefox number theirs, so the second half is anything id-shaped
-    # rather than digits; bare digits stay valid for single-source configs
-    # written before the prefix existed. completion inserts urls now, but ids
-    # are still first class - --bookmark takes them, the picker returns them
-    BOOKMARK_ID = /\A(?:\d+_[a-z0-9-]+|[0-9_]+)\z/i
+    # rather than digits. a bare number is a search: `booker 2024` is looking
+    # for a year. completion inserts urls now, but ids are still first class -
+    # --bookmark takes them, the picker returns them
+    BOOKMARK_ID = /\A\d+_[a-z0-9-]+\z/i
 
     def initialize(args)
       parse args
@@ -83,7 +83,9 @@ module Booker
       case @mode
       when :bookmark
         pexit "Error: ".red + "booker --bookmark expects bookmark id" if args.empty?
-        open_bookmark(args)
+        # a bare number is an id from before ids carried their source, when
+        # there was only ever source 0
+        open_bookmark(args.map { |id| /\A\d+\z/.match?(id) ? "0_#{id}" : id })
       when :install
         installer.install(args.empty? ? %w[completion config bookmarks] : args)
       when :search
@@ -98,7 +100,9 @@ module Booker
       when :complete_raw
         Bookmarks.new(args.join(" ")).autocomplete_raw
       end
-    rescue OptionParser::InvalidOption => e
+    # ParseError rather than InvalidOption: `booker --list=x` is a
+    # NeedlessArgument, and every other subclass is just as much a usage error
+    rescue OptionParser::ParseError => e
       pexit "Error: ".red + e.message
     end
 
@@ -146,8 +150,10 @@ module Booker
     def open_search(term)
       puts "searching ".grn + term
       search = Config.default.searcher
-      term = term.tr(" ", "+")
-      openweb(search + term)  # No shell escape needed - it's a URL
+      # encoded, not just spaces to "+": a literal + reads back as a space, &
+      # ends the query and # starts a fragment, so `c++` searched for "c"
+      require "uri"
+      openweb(search + URI.encode_www_form_component(term))
     end
 
     # a term matching bookmarks is offered as a choice; one matching nothing is

data/lib/booker/config.rb

@@ -57,6 +57,10 @@ module Booker
 
   # configuration
   class Config
+    # raised by #write rather than replacing a file that exists but would not
+    # parse: the defaults in memory are a fallback, not the user's settings
+    class Unreadable < StandardError; end
+
     VALID = [:searcher, :bookmarks, :browser, :picker].freeze
     HOME = ENV.fetch("HOME", "/usr/local/").freeze
     YAMLCONF = (HOME + "/.booker.yml").freeze
@@ -71,7 +75,11 @@ module Booker
       def reset! = @default = nil
     end
 
-    def initialize
+    # quiet_missing is for --install, which is about to write the very file the
+    # warning would tell the user to go and create
+    def initialize(quiet_missing: false)
+      @quiet_missing = quiet_missing
+
       # the yaml file if there is one, and only work out the defaults when
       # there is not: discovery walks every chrome profile directory to answer
       # a question the config file has already answered
@@ -83,7 +91,7 @@ module Booker
 
       # prune bad config keys
       @config.each_key do |k|
-        if !VALID.include? k.to_sym
+        if !VALID.include? k
           warn "Failure:".red + " Bad key found in config file: #{k}"
           exit 1
         end
@@ -107,16 +115,27 @@ module Booker
 
     def read(file)
       # #write emits symbol keys, so they have to be permitted on the way back
-      YAML.safe_load_file(file, permitted_classes: [Symbol])
+      conf = YAML.safe_load_file(file, permitted_classes: [Symbol])
+      # an empty file is no config at all, which is fine to write over
+      return false if conf.nil?
+      raise Psych::Exception, "not a mapping" unless conf.is_a?(Hash)
+
+      # symbols throughout, whatever the file used: `searcher:` is how yaml is
+      # usually written, but the readers look up :searcher, so a config spelled
+      # the usual way passed validation and then read back as nil
+      conf.transform_keys { |k| k.to_s.to_sym }
     rescue Errno::ENOENT
-      warn "Warning: ".yel +
-        "YAML configuration file couldn't be found. Using defaults."
-      warn "Suggest: ".grn + "booker --install config"
+      unless @quiet_missing
+        warn "Warning: ".yel +
+          "YAML configuration file couldn't be found. Using defaults."
+        warn "Suggest: ".grn + "booker --install config"
+      end
       false
     rescue Psych::Exception
       # every psych failure means the same thing here - an unusable config to
       # fall back from rather than crash on. rescuing SyntaxError alone let
       # anchors through as an AliasesNotEnabled backtrace under psych 4
+      @unreadable = true
       warn "Warning: ".red +
         "YAML configuration file could not be read. Using defaults."
       false
@@ -124,6 +143,11 @@ module Booker
 
     # used for creating and updating the default configuration
     def write(k = nil, v = nil)
+      if @unreadable
+        raise Unreadable, "#{YAMLCONF} could not be read - fix or remove it, " \
+          "it was left as is"
+      end
+
       @config[k] = v unless k.nil? # update users yaml config file
       File.write(YAMLCONF, @config.to_yaml)
     end

data/lib/booker/installer.rb

@@ -242,6 +242,13 @@ module Booker
       yield if block_given?
     end
 
+    # every target that touches the config is about to write it, so the
+    # missing-file warning would only tell the user to do what they are doing.
+    # its own instance rather than Config.default: that memo is shared with the
+    # rest of the run, and whichever caller built it first would decide whether
+    # the warning shows for everyone
+    def config = @config ||= Config.new(quiet_missing: true)
+
     def home
       ENV["HOME"] || "/usr/local"
     end
@@ -283,12 +290,18 @@ module Booker
 
           input = gets
           raise "No input provided" if input.nil?
-          selection = input.chomp.to_i
+
+          # to_i alone read any typo as 0 - all sources - and a negative number
+          # as an index from the end of the list
+          selection = Integer(input.strip, 10, exception: false)
+          unless selection&.between?(0, bms.length)
+            raise "Invalid selection: #{input.strip.inspect}"
+          end
 
           if selection == 0
             # User selected "ALL" - save array of all paths
             puts "Selected: ".yel + "All sources (#{bms.length} bookmark files)"
-            Config.default.write(:bookmarks, bms)
+            config.write(:bookmarks, bms)
             puts "Success: ".grn + "config file updated to search all bookmark sources"
           else
             save_bookmarks(bms[selection - 1], "config file updated with your bookmarks")
@@ -302,7 +315,7 @@ module Booker
 
     def save_bookmarks(selected, message)
       puts "Selected: ".yel + selected
-      Config.default.write(:bookmarks, selected)
+      config.write(:bookmarks, selected)
       puts "Success: ".grn + message
     end
 
@@ -316,8 +329,10 @@ module Booker
     end
 
     def install_config
-      Config.default.write
+      config.write
       puts "Success: ".grn + "example config file written to ~/.booker"
+    rescue Config::Unreadable => e
+      pexit "Failure: ".red + e.message
     rescue
       pexit "Failure: ".red + "could not write example config file to ~/.booker"
     end

data/lib/booker/parsers.rb

@@ -50,22 +50,30 @@ module Booker
     class Chrome < Base
       def parse
         begin
-          local_bookmarks = JSON.parse(File.read(@file_path))
-          @chrome_bookmarks = local_bookmarks["roots"]["bookmark_bar"]["children"]
+          roots = JSON.parse(File.read(@file_path))["roots"].select { |_, r| r.is_a?(Hash) }
         rescue
           warn "Warning: ".yel + "Bookmarks file not found or invalid."
           warn "Suggest: ".grn + "booker --install bookmarks"
           return
         end
 
-        parse_recursive
+        # every root, not just the bar: "other bookmarks" is where chrome files
+        # anything saved without picking a folder, and "mobile bookmarks" is
+        # what sync brings over from a phone. the bar keeps the bare "|" it
+        # always had; the others are folders like any other, named by chrome
+        top = Folder.new([], "|")
+        roots.each do |key, root|
+          if key == "bookmark_bar"
+            parse_recursive(Folder.new(root["children"], "|"))
+          else
+            parse_folder(top, root)
+          end
+        end
       end
 
       private
 
-      def parse_recursive(root = nil)
-        root = Folder.new(@chrome_bookmarks, "|") if root.nil?
-
+      def parse_recursive(root)
         root.json.each { |x| parse_link(root.title, x) }
         root.json.each { |x| parse_folder(root, x) }
       end
@@ -143,15 +151,19 @@ module Booker
           # Recursive CTE query to build folder paths
           query = <<-SQL
             WITH RECURSIVE bookmark_tree(id, parent, title, url, path) AS (
-              -- Start with bookmarks toolbar root
+              -- Start with the children of every user-facing root: the menu is
+              -- where firefox saves a bookmark by default, so the toolbar alone
+              -- missed most of them. toolbar paths stay unprefixed, as before
               SELECT b.id, b.parent, b.title, p.url,
-                     CAST(b.title as TEXT) as path
+                     CAST(CASE r.guid
+                       WHEN 'toolbar_____' THEN b.title
+                       ELSE COALESCE(r.title, '') || '/' || b.title
+                     END as TEXT) as path
               FROM moz_bookmarks b
+              INNER JOIN moz_bookmarks r ON b.parent = r.id
               LEFT JOIN moz_places p ON b.fk = p.id
-              WHERE b.parent = (
-                SELECT id FROM moz_bookmarks
-                WHERE guid = 'toolbar_____'
-              )
+              WHERE r.guid IN
+                ('toolbar_____', 'menu________', 'unfiled_____', 'mobile______')
 
               UNION ALL
 
@@ -217,7 +229,14 @@ module Booker
         # sniff the head rather than reading the whole file: on the binary path
         # the contents are thrown away and plutil reads it again from disk, and
         # a real Bookmarks.plist grows with the user's bookmarks
-        head = File.binread(path, 512).to_s
+        head = begin
+          File.binread(path, 512).to_s
+        rescue Errno::EPERM, Errno::EACCES
+          # macOS privacy protection, when this process lacks Full Disk Access.
+          # the file is binary on a mac anyway, so leave it to plutil - which
+          # may have been granted access on its own (--install safari, [B])
+          ""
+        end
 
         # Already an XML plist (fixtures, non-macOS). Binary plists need plutil
         # (macOS-only); the JSON converter rejects <data>/<date> fields, so xml1.

data/lib/booker/picker.rb

@@ -12,7 +12,10 @@ module Booker
   module Picker
     # --delimiter/--with-nth hide the id column: it is noise on screen, and
     # hiding it also takes it out of the match, so typing "2_" does not pull up
-    # every bookmark from the second source. --no-sort keeps booker's ordering.
+    # every bookmark from the second source. fzf ranks by match score, so a
+    # literal "sofa" beats s..o..f..a scattered across a long url, and
+    # --tiebreak=index keeps booker's ordering among equal scores (and for the
+    # empty query, which fzf never sorts).
     #
     # deliberately no --multi: under it fzf reads tab as "mark this and move
     # down" - the one key booker's own completion trained everybody to press -
@@ -25,7 +28,7 @@ module Booker
       "fzf",
       "--height=40%",
       "--reverse",
-      "--no-sort",
+      "--tiebreak=index",
       "--delimiter=\t",
       "--with-nth=2..",
       "--prompt=bookmark> "

data/lib/booker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Booker
-  VERSION = "2.0.0"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: booker
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jeremy Warner
@@ -13,16 +13,22 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.23
 specification_version: 4
 summary: CLI bookmark manager for Chrome, Firefox, and Safari
 test_files: []