searchlink 2.3.81 → 2.3.82

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce66d54f12c512c8e3e4508cf86d9dfde5e0be920a7bfe30bdc6071caceba54d
-  data.tar.gz: 744eb155302ed0901f3eba23ed8c50b73e8834040389662cfd4ae715843041e3
+  metadata.gz: 499667c8dd4020230af00d6a9a989382fbddaca1acb785ddd32cd0ab66035269
+  data.tar.gz: b2fe70d89c47cb5e14a591c5354212f2e97736f87ae95dcdd27d84706109850b
 SHA512:
-  metadata.gz: c9210886c698b4e82e7bb6d5b56732febef66c612ebe90351e66e0a4fcd9b6494ecac4b2bac5422b288bde4b25ba2d40b7bcb8737af467e757fafc19c8827a69
-  data.tar.gz: a36ba8e0be0f29f3f4cc31558ecdc0ba76b35e48cd2ecdd1a0ff35b9ce014dbfcc5063084111b1b26694e335b82ba86e391d63a855623cb6297c00e6560c3324
+  metadata.gz: 39c83199e303d8a2e258096c5f9a0182dbea1fd2ffbe485c9d6e89eec1d98cd4e282d87669278854d44a4daa5514bd31c85b6fd9ad9865524581152d9efd78c3
+  data.tar.gz: 459bee4c106e470de91b6644a4a690ad3296bdc7e5c59de6678fe2f3e4fd5f02f1795efd191d0e91e201c4449e7a063f636deaa6e594f59a4219ba8aeee8c651

data/lib/searchlink/config.rb

@@ -32,7 +32,9 @@ module SL
 
     def initialize(opt = {})
       SL.printout = opt[:echo] || false
-      unless File.exist? config_file
+      if File.exist? config_file
+        write_new_plugin_config
+      else
         default_config = <<~ENDCONFIG
           # set to true to have an HTML comment included detailing any errors
           # Can be disabled per search with `--d`, or enabled with `++d`.
@@ -80,22 +82,6 @@ module SL
           # E.g. [](!g Search Text)
           empty_uses_page_title: false
 
-          # Formatting for social links, use %service%, %user%, and %url%
-          # E.g. "%user% on %service%" => "ttscoff on Twitter"
-          #      "%service%/%user%" => "Twitter/ttscoff"
-          #      "%url%" => "twitter.com/ttscoff"
-          social_template: "%service%/%user%"
-
-          # append affiliate link info to iTunes urls, empty quotes for none
-          # example:
-          # itunes_affiliate: "&at=10l4tL&ct=searchlink"
-          itunes_affiliate: "&at=10l4tL&ct=searchlink"
-
-          # to create Amazon affiliate links, set amazon_partner to your amazon
-          # affiliate tag
-          #    amazon_partner: "bretttercom-20"
-          amazon_partner: "bretttercom-20"
-
           # To create custom abbreviations for Google Site Searches,
           # add to (or replace) the hash below.
           # "abbreviation" => "site.url",
@@ -129,35 +115,14 @@ module SL
             dev: developer.apple.com
             nq: http://nerdquery.com/?media_only=0&query=$term&search=1&category=-1&catid=&type=and&results=50&db=0&prefix=0
             gs: http://scholar.google.com/scholar?btnI&hl=en&q=$term&btnG=&as_sdt=80006
-          # Remove or comment (with #) history searches you don't want
-          # performed by `!h`. You can force-enable them per search, e.g.
-          # `!hsh` (Safari History only), `!hcb` (Chrome Bookmarks only),
-          # etc. Multiple types can be strung together: !hshcb (Safari
-          # History and Chrome bookmarks).
-          history_types:
-          - safari_bookmarks
-          - safari_history
-          # - chrome_history
-          # - chrome_bookmarks
-          # - firefox_bookmarks
-          # - firefox_history
-          # - edge_bookmarks
-          # - edge_history
-          # - brave_bookmarks
-          # - brave_history
-          # - arc_history
-          # - arc_bookmarks
-          # Pinboard search
-          # You can find your api key here: https://pinboard.in/settings/password
-          pinboard_api_key: ''
-          # Generate an access token at https://app.bitly.com/settings/api/
-          bitly_access_token: ''
-          bitly_domain: 'bit.ly'
-          # Custom Google API key to use Google search (free for 100 queries/day)
-          google_api_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 
         ENDCONFIG
 
+        default_config = get_plugin_configs(default_config)
+
+        puts default_config
+        Process.exit 0
+
         File.open(config_file, "w") do |f|
           f.puts default_config
         end
@@ -222,15 +187,107 @@ module SL
 
       # use notification center to show progress
       config["notifications"] ||= false
-      config["pinboard_api_key"] ||= false
-      config["google_api_key"] ||= false
 
       SL.line_num = nil
       SL.match_column = nil
       SL.match_length = nil
       SL.config = config
+
+      add_plugin_configs(config)
+    end
+
+    # Add plugin configurations to config object
+    #
+    # @param config [Hash] Hash of plugin configurations
+    #
+    # @note applies configurations to SL.config
+    #
+    def add_plugin_configs(config)
+      SL::Searches.plugins[:search].each_value do |plugin|
+        next unless plugin.key?(:config) && !plugin[:config].nil? && !plugin[:config].empty?
+
+        plugin[:config].each do |cfg|
+          SL.config[cfg[:key]] = config[cfg[:key]] if config.key?(cfg[:key])
+        end
+      end
+    end
+
+    # Add new keys to config if don't exist
+    def write_new_plugin_config
+      default_config = IO.read(config_file)
+      new_config = ""
+      SL::Searches.plugins[:search].each_value do |plugin|
+        next unless plugin.key?(:config) && !plugin[:config].nil? && !plugin[:config].empty?
+
+        plugin[:config].each do |cfg|
+          next if default_config =~ /^(# *)?#{cfg[:key]}:/
+
+          new_config += get_plugin_config(cfg)
+        end
+      end
+
+      return if new_config.empty?
+
+      File.open(config_file, "w") { |f| f.puts default_config + new_config }
+    end
+
+    #
+    # Get plugin configs
+    #
+    # @param default_config [String] Existing configuration
+    #
+    # @return [String] default_config with plugin configurations added
+    #
+    def get_plugin_configs(default_config)
+      SL::Searches.plugins[:search].each_value do |plugin|
+        next unless plugin.key?(:config) && !plugin[:config].nil? && !plugin[:config].empty?
+
+        plugin[:config].each do |cfg|
+          new_config = get_plugin_config(cfg)
+
+          default_config += new_config
+        end
+      end
+      default_config
+    end
+
+    #
+    # Get a single plugin configuration
+    #
+    # @param cfg [Hash] Hash of single plugin config
+    #
+    # @return [String] String representation of config
+    #
+    def get_plugin_config(cfg)
+      key = cfg[:key]
+      value = cfg[:value]
+      required = cfg[:required]
+      description = cfg[:description]
+      description = "\n#{description}" if description
+      description = description.word_wrap(60, "# ") if description
+      key = required ? key : "# #{key}"
+      if value.is_a?(Array)
+        array_value = "\n"
+        value.each do |v|
+          array_value += required ? "- #{v.yaml_val}" : "# - #{v.yaml_val}\n"
+        end
+        value = array_value
+      elsif value.is_a?(Hash)
+        hash_value = "\n"
+        value.each do |k, v|
+          hash_value += required ? "  #{k}: #{v.yaml_val}" : "#  #{k}: #{v.yaml_val}"
+        end
+        value = hash_value
+      else
+        value = value.yaml_val
+      end
+      new_config = ""
+      new_config += description if description
+
+      new_config + "#{key}: #{value}"
     end
 
+    # Reset configuration
     def restore_prev_config
       @prev_config&.each do |k, v|
         SL.config[k] = v

data/lib/searchlink/parse.rb

@@ -261,7 +261,11 @@ module SL
             el_rx = /(\s*(?:[-+*]|\d+\.)?\s+)?(!\S+ )?(\w.*?)$/
             if l =~ el_rx
               els = l.match(el_rx)
-              search = els[2] ? els[2].strip : (m[6] ? m[6] : "!g")
+              search = if els[2]
+                  els[2].strip
+                else
+                  m[6] || "!g"
+                end
               "#{els[1]}[#{els[3].strip}](#{search})"
             else
               l
@@ -305,6 +309,7 @@ module SL
 
           line.gsub!(/\[(.*?)\]\((.*?)\)/) do |match|
             this_match = Regexp.last_match
+
             SL.match_column = this_match.begin(0) - @cursor_difference
             @match_string = this_match.to_s
             SL.match_length = @match_string.length

data/lib/searchlink/searches/amazon.rb

@@ -9,6 +9,14 @@ module SL
           trigger: "a",
           searches: [
             ["a", "Amazon Search"]
+          ],
+          config: [
+            {
+              key: "amazon_partner",
+              value: "bretttercom-20",
+              description: "To create Amazon affiliate links, set amazon_partner to your amazon affiliate tag.",
+              required: true
+            }
           ]
         }
       end

data/lib/searchlink/searches/bitly.rb

@@ -10,6 +10,19 @@ module SL
           searches: [
             ["bl", "bit.ly Shorten"],
             ["bitly", "bit.ly shorten"]
+          ],
+          config: [
+            {
+              key: "bitly_access_token",
+              value: "xxxx",
+              required: false,
+              description: "Generate an access token at https://app.bitly.com/settings/api/"
+            },
+            {
+              key: "bitly_domain",
+              value: "bit.ly",
+              required: false
+            }
           ]
         }
       end

data/lib/searchlink/searches/duckduckgo.rb

@@ -41,6 +41,8 @@ module SL
         terms = "%5C#{search_terms.url_encode}"
         page = Curl::Html.new("https://duckduckgo.com/?q=#{terms}", compressed: true)
 
+        return false if page.meta["refresh"].nil?
+
         locs = page.meta["refresh"].match(%r{/l/\?uddg=(.*?)$})
         locs = page.body.match(%r{/l/\?uddg=(.*?)'}) if locs.nil?
         locs = page.body.match(/url=(.*?)'/) if locs.nil?

data/lib/searchlink/searches/github.rb

@@ -12,6 +12,14 @@ module SL
             ["ghu", "GitHub User Search"],
             ["gist", "Gist Search"],
             ["giste", "Gist Embed"]
+          ],
+          config: [
+            {
+              key: "github_token",
+              value: "github_patxxxxxxx",
+              require: false,
+              description: "GitHub Personal Access Token (optional)"
+            }
           ]
         }
       end

data/lib/searchlink/searches/google.rb

@@ -12,6 +12,14 @@ module SL
           searches: [
             ["gg", "Google Search"],
             ["img", "First image from result"]
+          ],
+          config: [
+            {
+              key: "google_api_key",
+              value: "xxxxxx",
+              required: false,
+              description: "Custom Google API key to use Google search (free for 100 queries/day)"
+            }
           ]
         }
       end
@@ -43,6 +51,8 @@ module SL
           return SL.ddg(terms, link_text, google: false, image: image)
         end
 
+        return false if json["error"] || json["queries"]["request"][0]["totalResults"].to_i.zero? || json["items"].nil?
+
         unless json["queries"]["request"][0]["totalResults"].to_i.positive?
           SL.notify("no results", "Google returned no results, defaulting to DuckDuckGo")
           return SL.ddg(terms, link_text, google: false, image: image)

data/lib/searchlink/searches/history.rb

@@ -42,6 +42,32 @@ module SL
             ["heb", "Edge Bookmark Search"],
             ["hehb", nil],
             ["hebh", nil]
+          ],
+          config: [
+            {
+              description:
+                ["Remove or comment (with #) history searches you don't want",
+                 "performed by `!h`. You can force-enable them per search, e.g.",
+                 "`!hsh` (Safari History only), `!hcb` (Chrome Bookmarks only)",
+                 "etc. Multiple types can be strung together: !hshcb (Safari",
+                 "History and Chrome bookmarks)"].join(" "),
+              required: false,
+              key: "history_types",
+              value: %w[
+                safari_bookmarks
+                safari_history
+                chrome_history
+                chrome_bookmarks
+                firefox_bookmarks
+                firefox_history
+                edge_bookmarks
+                edge_history
+                brave_bookmarks
+                brave_history
+                arc_history
+                arc_bookmarks
+              ]
+            }
           ]
         }
       end

data/lib/searchlink/searches/itunes.rb

@@ -17,6 +17,14 @@ module SL
             ["itud", "iOS App Store Developer Link"],
             ["mas", "Mac App Store Search"],
             ["masd", "Mac App Store Developer Link"]
+          ],
+          config: [
+            {
+              description: "append affiliate link info to iTunes urls, empty quotes for none\nexample:\nitunes_affiliate: '&at=10l4tL&ct=searchlink'",
+              key: "itunes_affiliate",
+              value: "&at=10l4tL&ct=searchlink",
+              required: true
+            }
           ]
         }
       end

data/lib/searchlink/searches/lyrics.rb

@@ -21,6 +21,25 @@ module SL
             ["lyrice", "Song Lyrics Embed"],
             ["lyricjs", "Song Lyrics JS Embed"]
           ]
+          #
+          # # The config block is optional, but can be used to define any
+          # # configuration options that the plugin requires. New configuration
+          # # options that don't exist in current config will be appended
+          # config: [
+          #   {
+          #     # Description that will appear above the option in config.yaml
+          #     description: "Genius API"
+          #     # the configuration key
+          #     key: "genius_token",
+          #     # the default value
+          #     value: "''",
+          #     # whether the configuration is required. If
+          #     # false (meaning optional), it will be added
+          #     # with a # in front of the key in the config
+          #     # file, making it a comment.
+          #     required: false
+          #   }
+          # ]
         }
       end
 

data/lib/searchlink/searches/pinboard.rb

@@ -9,8 +9,16 @@ module SL
         {
           trigger: "pb",
           searches: [
-            ["pb", "Pinboard Bookmark Search"],
+            ["pb", "Pinboard Bookmark Search"]
           ],
+          config: [
+            {
+              description: "Pinboard API key.\nYou can find your api key here: https://pinboard.in/settings/password",
+              key: "pinboard_api_key",
+              value: "''",
+              required: true
+            }
+          ]
         }
       end
 
@@ -125,7 +133,7 @@ module SL
           bookmarks.each do |bm|
             text = [bm["description"], bm["extended"], bm["tags"]].join(" ")
 
-            return [bm["href"], bm["description"]] if text.matches_exact(search_terms)
+            return [bm["href"], bm["description"], link_text] if text.matches_exact(search_terms)
           end
 
           return false
@@ -148,16 +156,16 @@ module SL
           full_text = [bm["description"], bm["extended"], bm["tags"]].join(" ")
 
           score = if title_tags.matches_exact(search_terms)
-              14.0
-            elsif full_text.matches_exact(search_terms)
-              13.0
-            elsif full_text.matches_any(search_terms)
-              full_text.matches_score(search_terms)
-            else
-              0
-            end
+                    14.0
+                  elsif full_text.matches_exact(search_terms)
+                    13.0
+                  elsif full_text.matches_any(search_terms)
+                    full_text.matches_score(search_terms)
+                  else
+                    0
+                  end
 
-          return [bm["href"], bm["description"]] if score == 14
+          return [bm["href"], bm["description"], link_text] if score == 14
 
           next unless score.positive?
 
@@ -165,7 +173,7 @@ module SL
                          score: score,
                          href: bm["href"],
                          title: bm["description"],
-                         date: bm["time"],
+                         date: bm["time"]
                        })
         end
 

data/lib/searchlink/searches/social.rb

@@ -13,6 +13,15 @@ module SL
             ["@l", "LinkedIn Handle"],
             ["@m", "Mastodon Handle"],
           ],
+          config: [
+            description: "Formatting for social links, use %service%, %user%, and %url%
+            E.g. \"%user% on %service%\" => \"ttscoff on Twitter\"
+    \"%service%/%user%\" => \"Twitter/ttscoff\"
+    \"%url%\" => \"twitter.com/ttscoff\"",
+            key: "social_template",
+            value: "%service%/%user%",
+            required: true
+          ]
         }
       end
 

data/lib/searchlink/searches.rb

@@ -123,6 +123,7 @@ module SL
         plugins[type][title] = {
           trigger: settings.fetch(:trigger, title).normalize_trigger,
           searches: settings[:searches],
+          config: settings[:config],
           class: klass
         }
       end

data/lib/searchlink/string.rb

@@ -3,6 +3,30 @@
 module SL
   # String helpers
   class ::String
+    # Quote a YAML value if needed
+    def yaml_val
+      yaml = YAML.safe_load("key: '#{self}'")
+      YAML.dump(yaml).match(/key: (.*?)$/)[1]
+    end
+
+    # Word wrap a string not exceeding max width.
+    # CREDIT: Gavin Kistner, Dayne Broderson
+    #
+    def word_wrap!(col_width = 60, prefix = "")
+      replace dup.word_wrap(col_width, prefix)
+    end
+
+    # As with #word_wrap, but modifies the string in place.
+    #
+    # CREDIT: Gavin Kistner, Dayne Broderson
+    #
+    def word_wrap(col_width = 60, prefix = "")
+      str = dup
+      str.gsub!(/(\S{#{col_width}})(?=\S)/, "#{prefix}\\1")
+      str.gsub!(/(.{1,#{col_width}})(?:\s+|$)/, "#{prefix}\\1\n")
+      str
+    end
+
     # Scrub invalid characters from string
     def scrubup
       encode("utf-16", invalid: :replace).encode("utf-8").gsub(/\u00A0/, " ")
@@ -239,7 +263,6 @@ module SL
 
         SL.add_error("Invalid URL", "Could not remove SEO for #{url}")
         return self
-
       end
 
       path = url.path
@@ -269,7 +292,6 @@ module SL
         dead_switch = 0
 
         while title.downcase.gsub(/[^a-z]/i, "") =~ /#{site_re}/i
-
           break if dead_switch > 5
 
           seo_title_separators.each_with_index do |sep, i|
@@ -411,12 +433,12 @@ module SL
       (1..n).each do |j|
         (1..m).each do |i|
           d[i][j] = if s[i - 1] == t[j - 1] # adjust index into string
-                      d[i - 1][j - 1]       # no operation required
+                      d[i - 1][j - 1] # no operation required
                     else
                       [d[i - 1][j] + 1, # deletion
                        d[i][j - 1] + 1, # insertion
                        d[i - 1][j - 1] + 1 # substitution
-].min
+        ].min
                     end
         end
       end

data/lib/searchlink/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SL
-  VERSION = "2.3.81"
+  VERSION = "2.3.82"
 end
 
 # Main module
@@ -46,7 +46,7 @@ module SL
       }
       if defined? Secrets::GH_AUTH_TOKEN
         headers["Authorization"] = "Bearer #{Secrets::GH_AUTH_TOKEN}"
-      elsif SL.config['github_token']
+      elsif SL.config["github_token"]
         headers["Authorization"] = "Bearer #{SL.settings["github_token"]}"
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: searchlink
 version: !ruby/object:Gem::Version
-  version: 2.3.81
+  version: 2.3.82
 platform: ruby
 authors:
 - Brett Terpstra
 bindir: bin
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64