pinpress 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa24927875f4c63b7ff399e51e7077cc3f54b959
-  data.tar.gz: 8095783fe3adeedd8abfb09c73961cec1121549f
+  metadata.gz: 271e0acf9b01155f4eb894e840347967bb5795c7
+  data.tar.gz: eb6f48a7cdc0f339fd1dea648daeebd9dacb6588
 SHA512:
-  metadata.gz: 1fe7ae484f60118e98172d0ce4e48460dddfb6e9a05f9629304ea0ee74ea0d4e50a4355115f3c0287f03c1d58ef78fd7906f7b1b8dc595f09fdbaac9eb5acd06
-  data.tar.gz: e30951147d3927fb627979ca0140b1603fda9a13885b23967470adc30b4aa90e7370662f754d76fa9750aeb3c5d0739b2a8e12fed7236f5647cd6ddf10567052
+  metadata.gz: 8c92541fd0e817f807199cc9a9de82bb32bb52e7943905e2747b58ca99b5c42d6054e810e04a2a0350336d8795fb13e5efd56c73967f5e4385fa3fe39310aa90
+  data.tar.gz: e2241935876943ce235bc5e608560ea506e4a0084568dc7896acb9e67582edb2001e0e242010e1ad8165821b9dee2b591528ddd8f293692fb3fd5face023828a

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 1.4.0 (2014-05-13)
+
+* Modified last_run logic to exist on each template
+* Fixed a few small bugs related to template selection
+
 # 1.3.3 (2014-05-13)
 
 * Fixed a bug with datetimestamps in `pins last` and `tags last`

data/README.md

@@ -42,7 +42,7 @@ SYNOPSIS
     pinpress [global options] command [command options] [arguments...]
 
 VERSION
-    1.3.3
+    1.4.0
 
 GLOBAL OPTIONS
     --help    - Show this message
@@ -97,6 +97,7 @@ 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"))
+* `-m`: the PinPress template to use
 * `-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
 
@@ -156,6 +157,7 @@ based on the [Tag Template](#tag-templates "Tag Templates") provided.
 Pinpress also provides some flags that allow a user to define specific tags to
 grab:
 
+* `-m`: the PinPress template to use
 * `-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"))
 
@@ -210,20 +212,20 @@ config file -- as an example:
 
 ```yaml
 pin_templates:
-- name: pinpress_default
-  opener: "<ul>\n"
-  item: >
-    <li>
-    <b><a title="<%= description %>" href="<%= href %>" target="_blank">
-    <%= description %></a>.</b>
-    <%= extended %>
-    </li>
-  closer: "</ul>"
+  pinpress_default
+    opener: "<ul>\n"
+    item: >
+      <li>
+      <b><a title="<%= description %>" href="<%= href %>" target="_blank">
+      <%= description %></a>.</b>
+      <%= extended %>
+      </li>
+    closer: "</ul>"
+  # ... other templates ...
 ```
 
 A Pin Template can have several different sub-keys:
 
-* `name` (**required**): the name of the template
 * `opener` (*optional*): the text that should exist above the pins
 * `closer` (*optional*): the text that should exist below the pins
 * `item` (**required**): the formatted text that should be output for every pin
@@ -247,7 +249,7 @@ filled by a pin's values:
 Pin Templates can be used in two ways: they can either be called dynamically:
 
 ```bash
-$ pinpress pins template_name
+$ pinpress pins -m template_name
 ```
 
 ...or a default template can be specified in `~/.pinpress`:
@@ -259,15 +261,16 @@ pinpress:
   default_pin_template: pinpress_default
   # ... other keys ...
 pin_templates:
-- name: pinpress_default
-  opener: "<ul>\n"
-  item: >
-    <li>
-    <b><a href="<%= href %>">
-    <%= description %></a>.</b>
-    <%= extended %>
-    </li>
-  closer: "</ul>"
+  pinpress_default
+    opener: "<ul>\n"
+    item: >
+      <li>
+      <b><a title="<%= description %>" href="<%= href %>" target="_blank">
+      <%= description %></a>.</b>
+      <%= extended %>
+      </li>
+    closer: "</ul>"
+  # ... other templates ...
 ```
 
 So, knowing the above, both:
@@ -279,7 +282,7 @@ $ pinpress pins
 ...and:
 
 ```bash
-$ pinpress pins pinpress_default
+$ pinpress pins -m pinpress_default
 ```
 
 ...will output pin data in the format specified by that template:
@@ -312,13 +315,12 @@ They, too, are defined in `~/.pinpress`:
 
 ```yaml
 tag_templates:
-- name: pinpress_default
-  item: "<%= tag %> (<%= count %>),"
+  pinpress_default
+    item: "<%= tag %> (<%= count %>),"
 ```
 
 A Tag Template makes use of the same sub-keys as Pin Template:
 
-* `name` (**required**): the name of the template
 * `opener` (*optional*): the text that should exist above the tag string
 * `closer` (*optional*): the text that should exist below the tag string
 * `item` (**required**): the formatted text that should be output for every tag
@@ -336,7 +338,7 @@ range used)
 Pin Templates can be used in two ways: they can either be called dynamically:
 
 ```bash
-$ pinpress tags template_name
+$ pinpress tags -m template_name
 ```
 
 ...or a default template can be specified in `~/.pinpress`:
@@ -350,8 +352,9 @@ pinpress:
 pin_templates:
   # ... other keys ...
 tag_templates:
-- name: pinpress_default
-  item: "<%= tag %> (<%= count %>),"
+  pinpress_default
+    item: "<%= tag %> (<%= count %>),"
+  # ... other templates ...
 ```
 
 So, knowing the above, both:
@@ -363,7 +366,7 @@ $ pinpress tags
 ...and:
 
 ```bash
-$ pinpress tags pinpress_default
+$ pinpress tags -m pinpress_default
 ```
 
 ...will output tag data in the format specified by that template:
@@ -420,35 +423,33 @@ pinpress:
   log_level: WARN
   version: 1.1.1
   api_token: bachya:1234567890987654321
-  last_pins_run: 2014-04-29
-  last_tags_run: 2014-04-29
 pin_templates:
-- name: pinpress_default
-  opener: >
-    <em>The weekly Link Mash is a curated selection of tools, stories, and
-    other links that I found during my travels on the web. All of my curated
-    links can be found on <a title="Bachya's Pinboard: Link Mash"
-    href="https://pinboard.in/u:bachya/t:link-mash/" target="_blank">
-    my Pinboard</a>; you can also find the Link Mash archives <a
-    href="http://www.bachyaproductions.com/tag/link-mash/">here</a>.
-    </em>
-    <ul>
-  item: >
-    <li>
-    <b><a title="<%= description %>" href="<%= href %>" target="_blank">
-    <%= description %></a>.</b>
-    <%= extended %>
-    </li>
-  closer: >
-    </ul>
-    <hr/>
-    <em>This Link Mash was generated by <a title="PinPress"
-    href="https://github.com/bachya/pinpress" target="_blank">PinPress</a>,
-    a simple tool to generate text templates from <a title="Pinboard"
-    href="https://pinboard.in" target="_blank">Pinboard</a> data.</em>"
+  pinpress_default
+    opener: >
+      <em>The weekly Link Mash is a curated selection of tools, stories, and
+      other links that I found during my travels on the web. All of my curated
+      links can be found on <a title="Bachya's Pinboard: Link Mash"
+      href="https://pinboard.in/u:bachya/t:link-mash/" target="_blank">
+      my Pinboard</a>; you can also find the Link Mash archives <a
+      href="http://www.bachyaproductions.com/tag/link-mash/">here</a>.
+      </em>
+      <ul>
+    item: >
+      <li>
+      <b><a title="<%= description %>" href="<%= href %>" target="_blank">
+      <%= description %></a>.</b>
+      <%= extended %>
+      </li>
+    closer: >
+     </ul>
+     <hr/>
+     <em>This Link Mash was generated by <a title="PinPress"
+     href="https://github.com/bachya/pinpress" target="_blank">PinPress</a>,
+     a simple tool to generate text templates from <a title="Pinboard"
+     href="https://pinboard.in" target="_blank">Pinboard</a> data.</em>"
 tag_templates:
-- name: pinpress_default
-  item: "<%= tag %>,"
+  pinpress_default
+    item: "<%= tag %>,"
 ```
 
 # Known Issues & Future Releases

data/bin/pinpress

@@ -92,11 +92,11 @@ end
 # ======================================================
 # Error (runs when an exception is raised)
 # ======================================================
-# on_error do |exception|
-#   messenger.error(exception.to_s)
-#   exit!(1)
-#   true
-# end
+on_error do |exception|
+  messenger.error(exception.to_s)
+  exit!(1)
+  true
+end
 
 # ======================================================
 # Commands
@@ -130,6 +130,7 @@ end
 desc 'Get pins from Pinboard'
 command :pins do |c|
   c.flag([:e], desc: 'The end date to pull pins to')
+  c.flag([:m], desc: 'The pin template to use')
   c.flag([:n], desc: 'The number of results to return')
   c.flag([:s], desc: 'The start date to pull pins from')
   c.flag([:t], desc: 'The tags to use (e.g., "ruby,pinboard")')
@@ -140,7 +141,7 @@ command :pins do |c|
 
     # Figure out the template to use based on the passed argument (if any)
     # and/or the presence of a default template.
-    template = PinPress.init_template(args[0], PinPress::Template::TYPE_PIN)
+    template_name, template = PinPress.init_template(options[:m], PinPress::Template::TYPE_PIN)
 
     # Assuming a valid template is found, transform CLI flags into options for
     # the Pinboard gem.
@@ -154,7 +155,7 @@ command :pins do |c|
     puts output if output
 
     # Save the last-run date to the configuration file.
-    configuration.pinpress.last_pins_run = Time.now.utc.iso8601
+    configuration.pin_templates[template_name.to_sym].last_run = Time.now.utc.iso8601
     configuration.save
   end
 
@@ -163,12 +164,12 @@ command :pins do |c|
     last.action do |global_options, options, args|
       PinPress.verbose = global_options[:v]
 
-      last_run_date = configuration.pinpress.last_pins_run
-      if last_run_date
-        # Figure out the template to use based on the passed argument (if any)
-        # and/or the presence of a default template.
-        template = PinPress.init_template(args[0], PinPress::Template::TYPE_PIN)
+      # Figure out the template to use based on the passed argument (if any)
+      # and/or the presence of a default template.
+      template_name, template = PinPress.init_template(options[:m], PinPress::Template::TYPE_PIN)
 
+      last_run_date = configuration.pin_templates[template_name.to_sym].last_run
+      if last_run_date
         # Set one option: the start date. Set it to the last-run date + 1.
         opts = {}
         opts.merge!(fromdt: DateTime.parse(last_run_date) + 1)
@@ -179,7 +180,7 @@ command :pins do |c|
         puts output if output
 
         # Save the last-run date to the configuration file.
-        configuration.pinpress.last_pins_run = Time.now.utc.iso8601
+        configuration.pin_templates[template_name.to_sym].last_run = Time.now.utc.iso8601
         configuration.save
       else
         messenger.warn("`pinpress pins` hasn't been run before.")
@@ -196,20 +197,45 @@ end
 desc 'Get tags from Pinboard'
 command :tags do |c|
   c.flag([:e], desc: 'The end date to pull pins to')
+  c.flag([:m], desc: 'The template to use')
   c.flag([:t], desc: 'The tags to use (e.g., "ruby,pinboard")')
   c.flag([:s], desc: 'The start date to pull pins from')
 
+  c.desc 'Gets unique tags based on the passed criteria'
+  c.action do |global_options, options, args|
+    PinPress.verbose = global_options[:v]
+
+    # Figure out the template to use based on the passed argument (if any)
+    # and/or the presence of a default template.
+    template_name, template = PinPress.init_template(options[:m], PinPress::Template::TYPE_TAG)
+
+    # Assuming a valid template is found, transform CLI flags into options for
+    # the Pinboard gem.
+    opts = {}
+    opts.merge!(todt: Chronic.parse(options[:e])) if options[:e]
+    opts.merge!(fromdt: Chronic.parse(options[:s])) if options[:s]
+    opts.merge!(PinPress.merge_common_options(options))
+
+    # Request tag data from Pinboard and output the return data.
+    output = PinPress.tag_yield(template, opts)
+    puts output if output
+
+    # Save the last-run date to the configuration file.
+    configuration.tag_templates[template_name.to_sym].last_run = Time.now.utc.iso8601
+    configuration.save
+  end
+
   c.desc 'Gets all tags from the last run date + 1'
   c.command :last do |last|
     last.action do |global_options, options, args|
-      last_run_date = configuration.pinpress.last_tags_run
+      # Figure out the template to use based on the passed argument (if any)
+      # and/or the presence of a default template.
+      template_name, template = PinPress.init_template(options[:m], PinPress::Template::TYPE_TAG)
+
+      last_run_date = configuration.tag_templates[template_name.to_sym].last_run
       if last_run_date
         PinPress.verbose = global_options[:v]
 
-        # Figure out the template to use based on the passed argument (if any)
-        # and/or the presence of a default template.
-        template = PinPress.init_template(args[0], PinPress::Template::TYPE_TAG)
-
         # Set one option: the start date. Set it to the last-run date + 1.
         opts = {}
         opts.merge!(fromdt: DateTime.parse(last_run_date) + 1)
@@ -220,37 +246,13 @@ command :tags do |c|
         puts output if output
 
         # Save the last-run date to the configuration file.
-        configuration.pinpress.last_tags_run = Time.now.utc.iso8601
+        configuration.tag_templates[template_name.to_sym].last_run = Time.now.utc.iso8601
         configuration.save
       else
         messenger.warn("`pinpress tags` hasn't been run before.")
       end
     end
   end
-
-  c.desc 'Gets unique tags based on the passed criteria'
-  c.action do |global_options, options, args|
-    PinPress.verbose = global_options[:v]
-
-    # Figure out the template to use based on the passed argument (if any)
-    # and/or the presence of a default template.
-    template = PinPress.init_template(args[0], PinPress::Template::TYPE_TAG)
-
-    # Assuming a valid template is found, transform CLI flags into options for
-    # the Pinboard gem.
-    opts = {}
-    opts.merge!(todt: Chronic.parse(options[:e])) if options[:e]
-    opts.merge!(fromdt: Chronic.parse(options[:s])) if options[:s]
-    opts.merge!(PinPress.merge_common_options(options))
-
-    # Request tag data from Pinboard and output the return data.
-    output = PinPress.tag_yield(template, opts)
-    puts output if output
-
-    # Save the last-run date to the configuration file.
-    configuration.pinpress.last_tags_run = Time.now.utc.iso8601
-    configuration.save
-  end
 end
 
 # ------------------------------------------------------

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.3.3'
+  VERSION = '1.4.0'
 end

data/lib/pinpress.rb

@@ -45,11 +45,10 @@ module PinPress
   def get_template(template_name, template_type)
     case template_type
     when PinPress::Template::TYPE_PIN
-      templates = configuration.pin_templates
+      configuration.pin_templates[template_name.to_sym]
     when PinPress::Template::TYPE_TAG
-      templates = configuration.tag_templates
+      configuration.tag_templates[template_name.to_sym]
     end
-    templates.find { |t| t[:name] == template_name }
   end
 
   # "Initializes" a passed template:
@@ -65,14 +64,15 @@ module PinPress
     tag_t_sym = :default_tag_template
     s = (template_type == PinPress::Template::TYPE_PIN ? pin_t_sym : tag_t_sym)
     default_template = configuration.pinpress[s]
-    if PinPress.is_template?(explicit_template, template_type)
+    
+    if explicit_template && PinPress.is_template?(explicit_template, template_type)
       messenger.debug("Using explicit template: #{ explicit_template }")
-      return PinPress.get_template(explicit_template, template_type)
+      return explicit_template, PinPress.get_template(explicit_template, template_type)
     elsif PinPress.is_template?(default_template, template_type)
       messenger.debug("Using default template: #{ default_template }")
-      return PinPress.get_template(default_template, template_type)
+      return default_template, PinPress.get_template(default_template, template_type)
     else
-      fail 'Invalid template defined and/or no default template specified'
+      fail 'Invalid template specified and/or no default template defined'
     end
   end
 
@@ -132,7 +132,7 @@ module PinPress
     when PinPress::Template::TYPE_TAG
       templates = configuration.tag_templates
     end
-    !templates.find { |t| t[:name] == template_name }.nil?
+    !templates[template_name.to_sym].nil?
   end
 
   # Present a list of installed templates to the user

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinpress
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Aaron Bach