pinpress 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16c3a1261457d78a7a116bca2aa115a42f75f279
-  data.tar.gz: b3ccd701978f3b4bfdc7c85d76db03d0a423fa38
+  metadata.gz: a18271b52fbf91d439eb277c0209d80339d19c8c
+  data.tar.gz: 0513753afd1a9279d7d233fa641e9f87841691b7
 SHA512:
-  metadata.gz: 77281608528aea4c3945c48a2eea792228b0d2769730226316c04845a7031e7a666c9fb6b707bad172cfd16a62487164b61a99832fb0140becb026239e33a175
-  data.tar.gz: 9112abaf1f90bf2b5b8da67ea995152a5c37b29d62644e6bdb0ee4a64bfdffdeb4cfb1d74064f1c2468fbc8128a329ec0a2c1c925e0065ed33ae1184c02c913a
+  metadata.gz: 56b51a77a71eb554ed33fd00b9b339479e9750cb5ca03cdf9bce5ca821df18dfa7e6dab4b20757062662e5841711708fa7582956d10133503168ac6cacb9158c
+  data.tar.gz: b44f2e29926a453d9421a7f2926ea1cd1a330b31138faee87ab37d2537a77e413d4b1e0ef1ad4b4410644ddb3f28dbab4343e7306f44384888d94b3e70568b60

data/HISTORY.md

@@ -1,3 +1,9 @@
+# 1.6.0 (2014-09-15)
+
+* Added `-a` flag to automatically create hyperlinks from URLs in pin descriptions
+* Added `-l` flag to prompt user to build hyperlinks around URLs in pin descriptions
+* Added `-c` flag to automatically copy output to system clipboard
+
 # 1.5.2 (2014-06-07)
 
 * Fixed a small bug with running `tags last`

data/README.md

@@ -42,7 +42,7 @@ SYNOPSIS
     pinpress [global options] command [command options] [arguments...]
 
 VERSION
-    1.5.2
+    1.6.0
 
 GLOBAL OPTIONS
     --help    - Show this message
@@ -68,11 +68,18 @@ SYNOPSIS
     pinpress [global options] pins [command options]
 
 COMMAND OPTIONS
+    -a     - Auto-links any URLs found in a pin description
+    -c     - Copy final output to the system clipboard
     -e arg - The end date to pull pins to (default: none)
+    l      - Allows the user to create <a> links around detected URLs
     -m arg - The pin template to use (default: none)
     -n arg - The number of results to return (default: none)
     -s arg - The start date to pull pins from (default: none)
     -t arg - The tags to use (e.g., "ruby,pinboard") (default: none)
+
+COMMANDS
+    <default> -
+    last      - Gets all pins from the last run date + 1
 ```
 
 # Initialization
@@ -102,6 +109,9 @@ grab:
 * `-n`: the number of pins to return (e.g., 20)
 * `-t`: a CSV list of tags (e.g., "tag1,tag2") that must exist for the returned pins
 
+By default, pin template text will be output to the terminal; you can use the
+`-c` switch to output it to the system clipboard instead.
+
 ## Getting Pins From a Date Forward
 
 ```bash
@@ -162,6 +172,9 @@ grab:
 * `-s`: the start date to use (uses [Chronic](https://github.com/mojombo/chronic "Chronic"), which allows dates like "last Tuesday")
 * `-e`: the end date to use (also uses [Chronic](https://github.com/mojombo/chronic "Chronic"))
 
+By default, pin template text will be output to the terminal; you can use the
+`-c` switch to output it to the system clipboard instead.
+
 ## Getting Tags From a Date Forward
 
 ```bash
@@ -376,6 +389,105 @@ $ pinpress tags -m pinpress_default
 link-mash (15),app (2),ios (3),productivity (1),launch-center-pro (1),drafts (2),
 ```
 
+# URL Linking
+
+I often run into the situation where I want to take a URL from a pin's description
+and add an `<a>` tag around it (since Pinboard doesn't allow you to embed the HTML
+within the pin description itself). PinPress provides two mechanisms to accomplish
+this: automatic linking and manual linking.
+
+## Automatic URL Linking
+
+### Using It
+
+To use automatic linking, simply use the `-a` switch when running PinPress.
+
+Alternatively, to always use automatic linking, include a `auto_link` key/value
+in `~/.pinpress`:
+
+```yaml
+pinpress:
+  auto_link: true
+```
+
+Note that the `auto_link` configuration key can be overridden by using a different
+URL linking switch (such as `-l`).
+
+### How It Works
+
+Using this method, PinPress will scan each pin that is being requested for URLs.
+Upon finding a URL, PinPress will automatically wrap it in an `<a>` tag.
+
+For example, given a description that looks like this:
+
+```html
+...this is some text with a URL: http://www.google.com.
+```
+
+...PinPress will modify the description such that the following is output
+instead:
+
+```html
+...this is some text with a URL: <a href="http://www.google.com" target="_blank">http://www.google.com</a>.
+```
+
+Finally, this link gets stored in `~/.pinpress`:
+
+```yaml
+links:
+  # This ID is a combination of the URL
+  # and the pin in which it is found.
+  853d65b7e76a57955040e97902fc2b3c:
+    title: Pin with Google
+    url: http://www.google.com
+    link_text: http://www.google.com
+```
+
+This happens for two reasons:
+
+1. Going forward, any request that returns this pin will use the data found
+in `~/.pinpress` (so that it doesn't have to be recalculated).
+2. If you want to modify the text that gets used for this link in this pin,
+you can do it here.
+
+## Manual URL Linking
+
+### Using It
+
+To use automatic linking, simply use the `-l` switch when running PinPress.
+
+Alternatively, to always use automatic linking, include a `manual_link` key/value
+in `~/.pinpress`:
+
+```yaml
+pinpress:
+  manual_link: true
+```
+
+Note that the `manual_link` configuration key can be overridden by using a different
+URL linking switch (such as `-a`).
+
+### How It Works
+
+This method is similar to automatic linking in that it will search each pin in the
+output for URLs in its description. When found, the user is prompted to enter the
+text that will create the link.
+
+For example, given a description that looks like this:
+
+```html
+Check out https://gifyoutube.com/!
+```
+
+...imagine that the user types in `GIF Youtube`; the result will look like this:
+
+```html
+Check out <a href="https://gifyoutube.com/" target="_blank">GIF Youtube</a>!
+```
+
+Like automatic linking, the results of this URL/pin combo are stored in
+`~/.pinpress` for easy lookup and future editing.
+
 # Other Configuration Options
 
 ## Global Keys
@@ -388,10 +500,20 @@ pinpress:
   # ...other keys...
 
   # The default pins template to use
-  default_pin_template
+  default_pin_template: template_name
 
   # The default tags template to use
-  default_tag_template
+  default_tag_template: template_name
+
+  # Automatic URL linking; note that this
+  # cannot exist eat the same time as manual
+  # URL linking
+  auto_link: true
+
+  # Manual URL linking; note that this
+  # cannot exist eat the same time as auto
+  # URL linking
+  manual_link: true
 
   # ...other keys...
 ```
@@ -434,8 +556,9 @@ pinpress:
   default_pin_template: pinpress_default
   default_tag_template: pinpress_default
   log_level: WARN
-  version: 1.5.0
+  version: 1.6.0
   api_token: bachya:1234567890987654321
+  manual_link: true
 pin_templates:
 - pinpress_default:
     opener: |

data/bin/pinpress

@@ -32,10 +32,13 @@
 #--------------------------------------------------------------------
 require 'chronic'
 require 'cliutils'
+require 'digest/md5'
 require 'gli'
 require 'htmlentities'
+require 'pbcopy'
 require 'pinboard'
 require 'pinpress'
+require 'uri'
 
 include CLIUtils::Configuration
 include CLIUtils::Messaging
@@ -135,6 +138,10 @@ command :pins do |c|
   c.flag([:s], desc: 'The start date to pull pins from')
   c.flag([:t], desc: 'The tags to use (e.g., "ruby,pinboard")')
 
+  c.switch([:a], desc: 'Auto-links any URLs found in a pin description')
+  c.switch([:c], desc: 'Copy final output to the system clipboard')
+  c.switch([:l], desc: 'Allows the user to create <a> links around detected URLs')
+
   c.desc 'Gets pins from Pinboard'
   c.action do |global_options, options, args|
     PinPress.verbose = global_options[:v]
@@ -152,7 +159,17 @@ command :pins do |c|
 
     # Request pin data from Pinboard and output the return data.
     output = PinPress.pin_yield(template, opts)
-    puts output if output
+
+    # If the `-c` switch is used, copy the output to the system clipboard;
+    # otherwise, simply output it to the termianl.
+    # puts output if output
+    if output
+      if options[:c]
+        output | pbcopy
+      else
+        puts output
+      end
+    end
 
     # Save the last-run date to the configuration file.
     configuration.pin_templates.find { |t| t.keys[0] == template_name.to_sym}.values[0].last_run = Time.now.utc.iso8601
@@ -181,7 +198,17 @@ command :pins do |c|
 
       # Request pin data from Pinboard and output the return data.
       output = PinPress.pin_yield(template, opts)
-      puts output if output
+
+      # If the `-c` switch is used, copy the output to the system clipboard;
+      # otherwise, simply output it to the termianl.
+      # puts output if output
+      if output
+        if options[:c]
+          output | pbcopy
+        else
+          puts output
+        end
+      end
 
       # Save the last-run date to the configuration file.
       configuration.pin_templates.find { |t| t.keys[0] == template_name.to_sym}.values[0].last_run = Time.now.utc.iso8601
@@ -219,7 +246,17 @@ command :tags do |c|
 
     # Request tag data from Pinboard and output the return data.
     output = PinPress.tag_yield(template, opts)
-    puts output if output
+
+    # If the `-c` switch is used, copy the output to the system clipboard;
+    # otherwise, simply output it to the termianl.
+    # puts output if output
+    if output
+      if options[:c]
+        output | pbcopy
+      else
+        puts output
+      end
+    end
 
     # Save the last-run date to the configuration file.
     t_config = configuration.tag_templates.find { |t| t.keys[0] == template_name.to_sym}.values[0]
@@ -249,7 +286,17 @@ command :tags do |c|
 
       # Request tag data from Pinboard and output the return data.
       output = PinPress.tag_yield(template, opts)
-      puts output if output
+
+      # If the `-c` switch is used, copy the output to the system clipboard;
+      # otherwise, simply output it to the termianl.
+      # puts output if output
+      if output
+        if options[:c]
+          output | pbcopy
+        else
+          puts output
+        end
+      end
 
       # Save the last-run date to the configuration file.
       t_config = configuration.tag_templates.find { |t| t.keys[0] == template_name.to_sym}.values[0]

data/lib/pinpress.rb

@@ -16,6 +16,38 @@ module PinPress
     attr_accessor :verbose
   end
 
+  # Determines whether an invalid combination of linking options
+  # (auto and manual, via either a switch or a config parameter)
+  # has been given.
+  # @param [Hash] opts
+  # @return [Bool]
+  def conflicting_link_opts?(opts)
+    auto_link_flag = opts[:a]
+    auto_link_conf = configuration.pinpress.auto_link
+    manual_link_flag = opts[:l]
+    manual_link_conf = configuration.pinpress.manual_link
+    ((auto_link_conf && manual_link_conf) || (auto_link_flag && manual_link_flag))
+  end
+
+  # Determines which URL linking options to set. There are some
+  # basic rules:
+  #    1. You can't specify both switches or both config options simultaneously.
+  #    2. Switches will take priority.
+  #    3. Config options are a last resort
+  # @param [Hash] opts_hash
+  # @return [Hash]
+  def determine_link_opts(opts_hash)
+    opts = {}
+    if opts_hash[:a_switch] || opts_hash[:m_switch]
+      opts.merge!(auto_link: true) if opts_hash[:a_switch]
+      opts.merge!(link: true) if opts_hash[:m_switch]
+    else
+      opts.merge!(auto_link: true) if opts_hash[:a_config]
+      opts.merge!(link: true) if opts_hash[:m_config]
+    end
+    opts
+  end
+
   # Grabs Pinboard data (passed on passed options) and yields a block that
   # allows the user to act upon that returned data.
   # @param [Hash] pinboard_opts
@@ -34,7 +66,7 @@ module PinPress
       messenger.debug(e.to_s)
       puts e.to_s
       raise "Pinboard API failed; are you sure you've run " \
-           " `pinpress init` (and that your API key is correct)?"
+        " `pinpress init` (and that your API key is correct)?"
     end
   end
 
@@ -87,6 +119,7 @@ module PinPress
 
       # Add initial configuration info.
       configuration.add_section(:pinpress)
+      configuration.add_section(:links)
       configuration.pinpress = {
         config_location: configuration.config_path,
         default_pin_template: 'pinpress_default',
@@ -135,6 +168,54 @@ module PinPress
     !templates.find { |t| t.keys[0] == template_name.to_sym }.nil?
   end
 
+  def link_urls_in_desc(name, description, method)
+    fail "Unknown link creation methdo: #{ method.to_s }" unless [:AUTO, :MANUAL].include? method
+    urls = URI.extract(description, ['http', 'https'])
+    urls.each do |u|
+      link_text = nil
+      pin_id = Digest::MD5.hexdigest(description + u)
+
+      # I don't get why, but URL.extract is loose enough to include
+      # weird characters. This is my evolving regex to handle those.
+      u.sub!(/[()\.]+$/, '')
+
+      if configuration.links.send(pin_id)
+        # First, check the configuration file to see if we've stored
+        # this URL before (so that we can grab the saved value).
+        link_text = configuration.links.send(pin_id).link_text
+      else
+        if method == :AUTO
+          # If the configuration file doesn't have an entry for this
+          # link, no worries; create one.
+          link_text = u
+        elsif method == :MANUAL
+          # If the configuration file doesn't have an entry for this
+          # link, no worries; create one.
+          CLIUtils::PrettyIO.wrap = false
+          messenger.section('URL FOUND!')
+          messenger.info("URL:\t\t#{ u }")
+          messenger.info("TITLE:\t#{ name }")
+          messenger.info("POSITION:\t..." + description.scan(/.{0,40}#{ u }.{0,40}/)[0] + '...')
+          until !link_text.nil?
+            link_text = messenger.prompt('What do you want the link text to say?')
+            messenger.warn('Please provide some link text.') if link_text.nil?
+          end
+          CLIUtils::PrettyIO.wrap = true
+        end
+
+        # Store this newly created link info back in the configuration
+        # file.
+        configuration.links.merge!(pin_id => {
+          title: name,
+          url: u,
+          link_text: link_text
+        })
+      end
+      description.sub!(u, "<a href=\"#{ u }\" target=\"_blank\">#{ link_text }</a>")
+    end
+    description
+  end
+
   # Present a list of installed templates to the user
   # @return [void]
   def list_templates
@@ -144,10 +225,10 @@ module PinPress
       if templates
         templates.each_with_index do |template, index|
           template_name, template = template.first
-           puts "#{ index + 1 }.\tName:   ".blue + "#{ template_name }"
-           puts "Opener:".blue.rjust(22) + "\t#{ template[:opener] }".truncate(80)
-           puts "Item:".blue.rjust(22) + "\t#{ template[:item] }".truncate(80)
-           puts "Closer:".blue.rjust(22) + "\t#{ template[:closer] }".truncate(80)
+          puts "#{ index + 1 }.\tName:   ".blue + "#{ template_name }"
+          puts "Opener:".blue.rjust(22) + "\t#{ template[:opener] }".truncate(80)
+          puts "Item:".blue.rjust(22) + "\t#{ template[:item] }".truncate(80)
+          puts "Closer:".blue.rjust(22) + "\t#{ template[:closer] }".truncate(80)
         end
       else
         messenger.warn('No templates defined...')
@@ -158,6 +239,7 @@ module PinPress
   # Helper method to merge command line options that are relevant for both pin
   # and tag requests.
   # @param [Hash] options
+  # @raise StandardError if an invalid combo of linking options is given
   # @return [Hash]
   def merge_common_options(options, template_name, template_type)
     case template_type
@@ -179,6 +261,24 @@ module PinPress
     elsif section.default_tags
       opts.merge!(tag: section.default_tags.join(','))
     end
+
+    # These options are PinPress-related, not necessarily Pinboard-related;
+    # for the sake of convenience, they're included here.
+
+    # Auto-linking and prompting for link text don't go together, so make
+    # sure to let the user know if they include both.
+    if conflicting_link_opts?(options)
+      fail "You can't specify (a) both the `-a` and `-l` switches or " \
+        "(b) both the `auto_link` and `manual_link` configuration options."
+    else
+      link_opts = determine_link_opts({
+        a_switch: options[:a],
+        m_switch: options[:l],
+        a_config: configuration.pinpress.auto_link,
+        m_config: configuration.pinpress.manual_link
+      })
+      opts.merge!(link_opts) if link_opts
+    end
     opts
   end
 
@@ -189,13 +289,21 @@ module PinPress
   def pin_yield(template, opts)
     output = ''
     PinPress.execute_template(opts) do |data|
-      html_coder = HTMLEntities.new
-
       output += template[:opener] if template[:opener]
       data.each do |i|
+        name = HTMLEntities.new.encode(i[:description])
+
+        if opts[:link]
+          desc = link_urls_in_desc(name, i[:extended], :MANUAL)
+        elsif opts[:auto_link]
+          desc = link_urls_in_desc(name, i[:extended], :AUTO)
+        else
+          desc = i[:extended]
+        end
+
         href        = i[:href]
-        description = html_coder.encode(i[:description])
-        extended    = i[:extended]
+        description = name
+        extended    = desc
         tag         = i[:tag]
         time        = i[:time]
         replace     = i[:replace]
@@ -239,8 +347,8 @@ module PinPress
   # @return [void]
   def update_config_file
     m = "This version needs to make some config changes. Don't worry; " \
-        "when prompted, your current values for existing config options " \
-        "will be presented (so it'll be easier to fly through the upgrade)."
+      "when prompted, your current values for existing config options " \
+      "will be presented (so it'll be easier to fly through the upgrade)."
     messenger.info(m)
     messenger.prompt('Press enter to continue')
     PinPress.init(true)

data/lib/pinpress/constants.rb

@@ -28,5 +28,5 @@ module PinPress
   SUMMARY = 'A simple CLI to create HTML templates of Pinboard data.'
 
   # The Gem's version
-  VERSION = '1.5.2'
+  VERSION = '1.6.0'
 end

data/pinpress.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('cliutils', '~> 2')
   spec.add_runtime_dependency('gli', '2.9.0')
   spec.add_runtime_dependency('htmlentities', '4.3.1')
+  spec.add_runtime_dependency('pbcopy', '1.0.1')
   spec.add_runtime_dependency('pinboard', '0.1.1')
 end

data/support/sample_config.yaml

@@ -13,3 +13,4 @@ pin_templates:
 tag_templates:
 - name: pinpress_default
   item: "<%= tag %> (<%= count %>),"
+links: {}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinpress
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Aaron Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-07 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -122,6 +122,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: pbcopy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: pinboard
   requirement: !ruby/object:Gem::Requirement