pinpress 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c8ccd16e480f7916a9d5f37fc1e53d8a202a166
-  data.tar.gz: 0f614a325332b9e23fbdc8acc9299f3056eb4422
+  metadata.gz: 7cd530fc5ddd3f35de2e05761e796e86ba44fae9
+  data.tar.gz: 692a163f694f782fe1957e034fb46e2af85df559
 SHA512:
-  metadata.gz: eefacf5d7d8198bf79bcf1ed739e1dd5892ab5b17b799a7a0d08eb91f3e964cdc703b1aa8d57b2512837409c1ff00f5caa991bfedb3fdadb8794d6a0711c526c
-  data.tar.gz: abb18bfae40f56fe623be3684d3ead5c510fe0812fc6aba9da6c403c0117f4e1815a13153c74b51f0bc13fef3122850ff42e15c88d91242256a366304aeb96df
+  metadata.gz: a8bcd4d8a61d2350470a29f242c488e8a44500e2a02cfa2d6340ef342ee733a70acd9a2c30ffc25b70f10edf5892e1c770df0c12314c8ba53eae68979f649e08
+  data.tar.gz: ab778b6492687ed954aa334c9582c10583b121d608c0e65dd84c92f6660892d114eb0ee6d588ed84b1b2af0d367123d3caaff933c904d3e082cf920674c2ef17

data/HISTORY.md

@@ -1,6 +1,10 @@
-# 1.0.2 (2014-04-17)
+# 1.1.0 (2014-04-17)
 
-* Fixed a configuration version bug
+* Added default tags
+* Added default number of results
+* Rubocop refactoring
+* Documentation
+* Several bugfixes
 
 # 1.0.1 (2014-04-17)
 

data/README.md

@@ -9,7 +9,7 @@ PinPress is a simple CLI to create templates (HTML, Markdown, or otherwise) of P
 
 Every two weeks, I create a "link mash" for my website; this link mash consists of URLs that I find interesting and want to share with my readers. Previously, I would save those interesting URLs to an Evernote note and, every two weeks, manually create my link mash for use in Wordpress. <barf/>
 
-When I began using [Pinboard](http://pinboard.in "Pinboard") to save interesting links, I knew I needed a better method. This tool is the result: **Pin**board + Word**press**.
+When I began using [Pinboard](http://pinboard.in "Pinboard") to save interesting links, I knew I needed a better method. This tool is the result: **Pin** board + Word **press**.
 
 # Prerequisites
 
@@ -34,7 +34,7 @@ SYNOPSIS
     pinpress [global options] command [command options] [arguments...]
 
 VERSION
-    1.0.2
+    1.1.0
 
 GLOBAL OPTIONS
     --help    - Show this message
@@ -73,97 +73,13 @@ $ pinpress init
 
 Initialization will prompt you to enter your Pinboard API token. Once, entered, this (and other pertinent data) will be stored in `~/.pinpress`.
 
-# Getting Pins
-
-```
-$ pinpress pins
-# => <ul><li><b><a title="Using Drafts for Remote CLI" href="https://gist.github.com/hiilppp/10993803" target="_blank">Using Drafts for Remote CLI</a>.</b> As a text file is added to a directory to which this AppleScript is associated as Folder Action, the content of the received file is executed as shell script and the generated output sent to an iOS device.</li></ul>
-```
-
-This simple command will return all pins from the user's account and output them based on the [Pin Template](https://github.com/bachya/PinPress#pin-templates "Pin Templates") provided.
-
-Pinpress also provides some flags that allow a user to define specific pins to 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"))
-* `-n`: the number of pins to return (e.g., 20)
-* `-t`: a CSV list of tags to grab (e.g., "tag1,tag2")
-
-## Getting Pins From a Date Forward
-
-```
-$ pinpress pins -s 2014-01-01
-```
-
-...returns all pins from January 1, 2014 to the current day.
-
-## Getting Pins Until a Date
-
-```
-$ pinpress pins -e 2014-01-01
-```
-
-...returns all pins up to January 1, 2014.
-
-## Getting Pins Between a Date Range
-
-```
-$ pinpress pins -s 2014-01-01 -e 2014-01-31
-```
-
-## Getting Tagged Pins
-
-```
-$ pinpress pins -t "ruby,cli"
-```
-
-...returns all pins tagged "ruby" *and* "cli".
-
-# Getting Tags
-
-Pinpress can also work with tags in a Pinboard account:
-
-```
-$ pinpress tags
-# => cli (1),github (1),applescript (1),osx (1),link-mash (1)
-```
-
-This simple command will return all tags from the user's account and output them based on the [Tag Template](https://github.com/bachya/PinPress#tag-templates "Tag Templates") provided.
-
-Pinpress also provides some flags that allow a user to define specific tags to 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"))
-
-## Getting Tags From a Date Forward
-
-```
-$ pinpress tags -s 2014-01-01
-```
-
-...returns all tags used from January 1, 2014 to the current day. Note that for each tag returned, the data includes both the tag name and the number of times it was used.
-
-## Getting Tags Until a Date
-
-```
-$ pinpress tags -e 2014-01-01
-```
-
-...returns all tags used up to January 1, 2014.
-
-## Getting Tags Between a Date Range
-
-```
-$ pinpress tags -s 2014-01-01 -e 2014-01-31
-```
-
 # Templates
 
-The first stop on the PinPress journey is templates. Templates are used to define how data should be output and are defined in `~/.pinpress` and come in two forms: **Pin Templates** and **Tag Templates**. 
+The first stop on the PinPress journey is templates. Templates are used to define how data should be output and are defined in `~/.pinpress`. They come in two forms: **Pin Templates** and **Tag Templates**. 
 
 ## Pin Templates
 
-Pin Templates define how a pin should be output.
+Pin Templates define how a pin from Pinboard should be output.
 
 ### Schema
 
@@ -176,7 +92,7 @@ pin_templates:
   closer: "</ul>"
   item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
     description %></a>.</b> <%= extended %></li>"
-  item_separator: "\n"
+  /Users/abach/.pinpress: "\n"
 ```
 
 A Pin Template can have several different sub-keys:
@@ -185,7 +101,6 @@ A Pin Template can have several different sub-keys:
 * `opener` (*optional*): the text that should exist above the pins
 * `closer` (*optional*): the text that should exist above the pins
 * `item` (**required**): the formatted text that should be output for every pin
-* `item_separator` (**required**): the text that should exist between each pin ("item")
 
 ### Available Tokens
 
@@ -218,18 +133,10 @@ pinpress:
   # ... other keys ...
 pin_templates:
 - name: pinpress_default
-  opener: "<ul>"
+  opener: "<ul>\n"
   closer: "</ul>"
   item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-    description %></a>.</b> <%= extended %></li>"
-  item_separator: "\n"
-```
-
-Using this example, here's what's output:
-
-```
-$ pinpress pins -s 'yesterday'
-# => <ul><li><b><a title="Using Drafts for Remote CLI" href="https://gist.github.com/hiilppp/10993803" target="_blank">Using Drafts for Remote CLI</a>.</b> As a text file is added to a directory to which this AppleScript is associated as Folder Action, the content of the received file is executed as shell script and the generated output sent to an iOS device.</li></ul>
+    description %></a>.</b> <%= extended %></li>\N"
 ```
 
 ## Tag Templates
@@ -244,7 +151,7 @@ They, too, are defined in `~/.pinpress`:
 tag_templates:
 - name: pinpress_default
   item: "<%= tag %> (<%= count %>)"
-  item_separator: ","
+  /Users/abach/.pinpress: ","
 ```
 
 A Pin Template can have several different sub-keys:
@@ -253,7 +160,6 @@ A Pin Template can have several different sub-keys:
 * `opener` (*optional*): the text that should exist above the pins
 * `closer` (*optional*): the text that should exist above the pins
 * `item` (**required**): the formatted text that should be output for every pin
-* `item_separator` (**required**): the text that should exist between each pin ("item")
 
 ### Available Tokens
 
@@ -282,17 +188,100 @@ pin_templates:
   # ... other keys ...
 tag_templates:
 - name: pinpress_default
-  item: "<%= tag %> (<%= count %>)"
-  item_separator: ","
+  item: "<%= tag %> (<%= count %>),"
+```
+
+# Getting Pins
+
+```
+$ pinpress pins
+# => <ul><li><b><a title="Using Drafts for Remote CLI" href="https://gist.github.com/hiilppp/10993803" target="_blank">Using Drafts for Remote CLI</a>.</b> As a text file is added to a directory to which this AppleScript is associated as Folder Action, the content of the received file is executed as shell script and the generated output sent to an iOS device.</li></ul>
+```
+
+This simple command will return all pins from the user's account and output them based on the [Pin Template](https://github.com/bachya/PinPress#pin-templates "Pin Templates") provided.
+
+Pinpress also provides some flags that allow a user to define specific pins to 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"))
+* `-n`: the number of pins to return (e.g., 20)
+* `-t`: a CSV list of tags to grab (e.g., "tag1,tag2")
+
+## Getting Pins From a Date Forward
+
+```
+$ pinpress pins -s 2014-01-01
+```
+
+...returns all pins from January 1, 2014 to the current day.
+
+## Getting Pins Until a Date
+
 ```
+$ pinpress pins -e 2014-01-01
+```
+
+...returns all pins up to January 1, 2014.
+
+## Getting Pins Between a Date Range
 
-Using this example, here's what's output:
+```
+$ pinpress pins -s 2014-01-01 -e 2014-01-31
+```
+
+## Getting Tagged Pins
 
 ```
-$ pinpress tags -s 'yesterday'
+$ pinpress pins -t "ruby,cli"
+```
+
+...returns all pins tagged "ruby" *and* "cli".
+
+# Getting Tags
+
+Pinpress can also work with tags in a Pinboard account:
+
+```
+$ pinpress tags
 # => cli (1),github (1),applescript (1),osx (1),link-mash (1)
 ```
 
+This simple command will return all tags from the user's account and output them based on the [Tag Template](https://github.com/bachya/PinPress#tag-templates "Tag Templates") provided.
+
+Pinpress also provides some flags that allow a user to define specific tags to 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"))
+
+## Getting Tags From a Date Forward
+
+```
+$ pinpress tags -s 2014-01-01
+```
+
+...returns all tags used from January 1, 2014 to the current day. Note that for each tag returned, the data includes both the tag name and the number of times it was used.
+
+## Getting Tags Until a Date
+
+```
+$ pinpress tags -e 2014-01-01
+```
+
+...returns all tags used up to January 1, 2014.
+
+## Getting Tags Between a Date Range
+
+```
+$ pinpress tags -s 2014-01-01 -e 2014-01-31
+```
+
+# Other Configuration Options
+
+In addition to `default_pin_template` and `default_tag_template`, you can place some other special keys in the `pinpress` section of `~/.pinpress`:
+
+* `default_tags`: the default tags to be used when getting pins (e.g., `'ruby,pinboard'`). This can be overridden by using the `-t` flag.
+* `default_num_results`: the default number of results to return (e.g., '5'). This can be overridden by using the `-n` flag.
+
 # Known Issues & Future Releases
 
 Check out the Pinpress roadmap via the [Trello Board](https://trello.com/b/lmuC8TT0/pinpress "Pinpress Trello Board").

data/features/2.initialization.feature

@@ -7,23 +7,31 @@ Feature: Initialization
     Given no file located at "/tmp/pp/.pinpress"
     When I run `pinpress init` interactively
       And I type ""
-      And I type "12345"
+      And I type "bachya:12345"
     Then the exit status should be 0
       And the file "/tmp/pp/.pinpress" should contain:
       """
       ---
       pinpress:
         config_location: "/tmp/pp/.pinpress"
-        default_template: pinpress_default
+        default_pin_template: pinpress_default
+        default_tag_template: pinpress_default
         log_level: WARN
-        version: 1.0.1
-        api_token: '12345'
-      templates:
+        version: 1.1.0
+        api_token: bachya:12345
+      pin_templates:
       - name: pinpress_default
-        opener: "<ul>"
-        item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-          description %></a>.</b> <%= extended %></li>"
+        opener: |
+          <ul>
+        item: |
+          <li>
+          <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+          <%= extended %>
+          </li>
         closer: "</ul>"
+      tag_templates:
+      - name: pinpress_default
+        item: "<%= tag %> (<%= count %>),"
       """
 
   Scenario: Reinitialization (refuse)
@@ -32,16 +40,24 @@ Feature: Initialization
     ---
     pinpress:
       config_location: "/tmp/pp/.pinpress"
-      default_template: pinpress_default
+      default_pin_template: pinpress_default
+      default_tag_template: pinpress_default
       log_level: WARN
-      version: 1.0.1
-      api_token: '12345'
-    templates:
+      version: 1.1.0
+      api_token: bachya:12345
+    pin_templates:
     - name: pinpress_default
-      opener: "<ul>"
-      item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-        description %></a>.</b> <%= extended %></li>"
+      opener: |
+        <ul>
+      item: |
+        <li>
+        <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+        <%= extended %>
+        </li>
       closer: "</ul>"
+    tag_templates:
+    - name: pinpress_default
+      item: "<%= tag %> (<%= count %>),"
     """
     When I run `pinpress init` interactively
       And I type ""
@@ -53,37 +69,53 @@ Feature: Initialization
     ---
     pinpress:
       config_location: "/tmp/pp/.pinpress"
-      default_template: pinpress_default
+      default_pin_template: pinpress_default
+      default_tag_template: pinpress_default
       log_level: WARN
-      version: 1.0.1
-      api_token: '12345'
-    templates:
+      version: 1.1.0
+      api_token: bachya:12345
+    pin_templates:
     - name: pinpress_default
-      opener: "<ul>"
-      item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-        description %></a>.</b> <%= extended %></li>"
+      opener: |
+        <ul>
+      item: |
+        <li>
+        <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+        <%= extended %>
+        </li>
       closer: "</ul>"
+    tag_templates:
+    - name: pinpress_default
+      item: "<%= tag %> (<%= count %>),"
     """
     When I run `pinpress init` interactively
       And I type "y"
       And I type ""
-      And I type "12345"
+      And I type "bachya:12345"
     Then the exit status should be 0
       And the file "/tmp/pp/.pinpress" should contain:
       """
       ---
       pinpress:
         config_location: "/tmp/pp/.pinpress"
-        default_template: pinpress_default
+        default_pin_template: pinpress_default
+        default_tag_template: pinpress_default
         log_level: WARN
-        version: 1.0.1
-        api_token: '12345'
-      templates:
+        version: 1.1.0
+        api_token: bachya:12345
+      pin_templates:
       - name: pinpress_default
-        opener: "<ul>"
-        item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-          description %></a>.</b> <%= extended %></li>"
+        opener: |
+          <ul>
+        item: |
+          <li>
+          <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+          <%= extended %>
+          </li>
         closer: "</ul>"
+      tag_templates:
+      - name: pinpress_default
+        item: "<%= tag %> (<%= count %>),"
       """
         
   Scenario: Reinitialization (from scratch)
@@ -92,34 +124,50 @@ Feature: Initialization
     ---
     pinpress:
       config_location: "/tmp/pp/.pinpress"
-      default_template: pinpress_default
+      default_pin_template: pinpress_default
+      default_tag_template: pinpress_default
       log_level: WARN
-      version: 1.0.1
-      api_token: '12345'
-    templates:
+      version: 1.1.0
+      api_token: bachya:12345
+    pin_templates:
     - name: pinpress_default
-      opener: "<ul>"
-      item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-        description %></a>.</b> <%= extended %></li>"
+      opener: |
+        <ul>
+      item: |
+        <li>
+        <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+        <%= extended %>
+        </li>
       closer: "</ul>"
+    tag_templates:
+    - name: pinpress_default
+      item: "<%= tag %> (<%= count %>),"
     """
     When I run `pinpress init -s` interactively
       And I type ""
-      And I type "12345"
+      And I type "bachya:12345"
     Then the exit status should be 0
       And the file "/tmp/pp/.pinpress" should contain:
       """
       ---
       pinpress:
         config_location: "/tmp/pp/.pinpress"
-        default_template: pinpress_default
+        default_pin_template: pinpress_default
+        default_tag_template: pinpress_default
         log_level: WARN
-        version: 1.0.1
-        api_token: '12345'
-      templates:
+        version: 1.1.0
+        api_token: bachya:12345
+      pin_templates:
       - name: pinpress_default
-        opener: "<ul>"
-        item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-          description %></a>.</b> <%= extended %></li>"
+        opener: |
+          <ul>
+        item: |
+          <li>
+          <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+          <%= extended %>
+          </li>
         closer: "</ul>"
+      tag_templates:
+      - name: pinpress_default
+        item: "<%= tag %> (<%= count %>),"
       """

data/features/3.templates.feature

@@ -8,26 +8,33 @@ Feature: Templates
     ---
     pinpress:
       config_location: "/tmp/pp/.pinpress"
-      default_template: pinpress_default
+      default_pin_template: pinpress_default
+      default_tag_template: pinpress_default
       log_level: WARN
-      version: 1.0.1
-      api_token: '12345'
-    templates:
+      version: 1.1.0
+      api_token: bachya:12345
+    pin_templates:
     - name: pinpress_default
-      opener: "<ul>"
-      item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-        description %></a>.</b> <%= extended %></li>"
+      opener: |
+        <ul>
+      item: |
+        <li>
+        <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+        <%= extended %>
+        </li>
       closer: "</ul>"
-    - name: secondary
-      item: "* <%= href %>"
+    tag_templates:
+    - name: pinpress_default
+      item: "<%= tag %> (<%= count %>),"
     """
-    When I run `pinpress template` interactively
+    When I run `pinpress templates` interactively
     Then the exit status should be 0
     And the output should contain:
     """
-    ---> AVAILABLE TEMPLATES
+    ---> AVAILABLE PIN TEMPLATES:
+    # 1. pinpress_default
+    ---> AVAILABLE TAG TEMPLATES:
     # 1. pinpress_default
-    # 2. secondary
     """
     
   Scenario: List Templates (explicit)
@@ -36,78 +43,31 @@ Feature: Templates
     ---
     pinpress:
       config_location: "/tmp/pp/.pinpress"
-      default_template: pinpress_default
+      default_pin_template: pinpress_default
+      default_tag_template: pinpress_default
       log_level: WARN
-      version: 1.0.1
-      api_token: '12345'
-    templates:
+      version: 1.1.0
+      api_token: bachya:12345
+    pin_templates:
     - name: pinpress_default
-      opener: "<ul>"
-      item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-        description %></a>.</b> <%= extended %></li>"
+      opener: |
+        <ul>
+      item: |
+        <li>
+        <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+        <%= extended %>
+        </li>
       closer: "</ul>"
-    - name: secondary
-      item: "* <%= href %>"
-    """
-    When I run `pinpress template list` interactively
-    Then the exit status should be 0
-      And the output should contain:
-      """
-      ---> AVAILABLE TEMPLATES
-      # 1. pinpress_default
-      # 2. secondary
-      """
-    
-  Scenario: Choose Default Template
-    Given a file located at "/tmp/pp/.pinpress" with the contents:
-    """
-    ---
-    pinpress:
-      config_location: "/tmp/pp/.pinpress"
-      default_template: pinpress_default
-      log_level: WARN
-      version: 1.0.1
-      api_token: '12345'
-    templates:
+    tag_templates:
     - name: pinpress_default
-      opener: "<ul>"
-      item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-        description %></a>.</b> <%= extended %></li>"
-      closer: "</ul>"
-    - name: secondary
-      item: "* <%= href %>"
+      item: "<%= tag %> (<%= count %>),"
     """
-    When I run `pinpress template default` interactively
-      And I type "4"
-      And I type "0"
-      And I type "asd"
-      And I type "2"
+    When I run `pinpress templates list` interactively
     Then the exit status should be 0
       And the output should contain:
       """
-      ---> CHOOSE A DEFAULT TEMPLATE
-      # Current Default Template: pinpress_default
-      # Choose a New Template:
+      ---> AVAILABLE PIN TEMPLATES:
+      # 1. pinpress_default
+      ---> AVAILABLE TAG TEMPLATES:
       # 1. pinpress_default
-      # 2. secondary
-      # Invalid choice: 4
-      # Invalid choice: 0
-      # Invalid choice: asd
-      # New default template chosen: secondary
-      """
-      And the file "/tmp/pp/.pinpress" should contain:
       """
-      ---
-      pinpress:
-        config_location: "/tmp/pp/.pinpress"
-        default_template: secondary
-        log_level: WARN
-        version: 1.0.1
-        api_token: '12345'
-      templates:
-      - name: pinpress_default
-        opener: "<ul>"
-        item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-          description %></a>.</b> <%= extended %></li>"
-        closer: "</ul>"
-      """

data/features/4.pins.feature

@@ -8,18 +8,24 @@ Feature: Templates
     ---
     pinpress:
       config_location: "/tmp/pp/.pinpress"
-      default_template: pinpress_default
+      default_pin_template: pinpress_default
+      default_tag_template: pinpress_default
       log_level: WARN
-      version: 1.0.1
-      api_token: '12345'
-    templates:
+      version: 1.1.0
+      api_token: bachya:12345
+    pin_templates:
     - name: pinpress_default
-      opener: "<ul>"
-      item: "<li><b><a title=\"<%= description %>\" href=\"<%= href %>\" target=\"_blank\"><%=
-        description %></a>.</b> <%= extended %></li>"
+      opener: |
+        <ul>
+      item: |
+        <li>
+        <b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+        <%= extended %>
+        </li>
       closer: "</ul>"
-    - name: secondary
-      item: "* <%= href %>"
+    tag_templates:
+    - name: pinpress_default
+      item: "<%= tag %> (<%= count %>),"
     """
     When I run `pinpress pins` interactively
     Then the exit status should be 1

data/lib/PinPress.rb

@@ -10,49 +10,12 @@ module PinPress
     # Stores whether initalization has completed.
     # @return [Boolean]
     attr_reader :initialized
-    
+
     # Stores whether verbose output is turned on.
     # @return [Boolean]
     attr_accessor :verbose
   end
 
-  # Presents the user with a list of templates and
-  # allows them to choose one.
-  # @return [void]
-  def self.choose_default_template
-    templates = configuration.templates
-    if !templates.nil?
-      messenger.section('CHOOSE A DEFAULT TEMPLATE')
-      messenger.success("Current Default Template: #{ configuration.pinpress[:default_template] }")
-      messenger.info("Choose a New Template:")
-      templates.each_with_index do |template, index|
-        messenger.info("#{ index + 1}. #{ template[:name] }")
-      end
-
-      # Loop through the possible template choices and collect the user's
-      # input. If a valid choice is made, set the default; otherwise,
-      # force the user to pick.
-      valid_choice_made = false
-      until valid_choice_made
-        choice = messenger.prompt("Choose from the list above")
-        array_index = choice.to_i - 1
-        
-        if array_index >= 0 && !templates[array_index].nil?
-          default_template_name = templates[array_index][:name]
-          configuration.pinpress[:default_template] = default_template_name
-          configuration.save
-        
-          messenger.success("New default template chosen: #{ default_template_name }")
-          valid_choice_made = true
-        else
-          messenger.error("Invalid choice: #{ choice }")
-        end
-      end
-    else
-      messenger.warn('No templates defined...')
-    end
-  end
-
   def self.execute_template(template_type, template_name)
     template_hash = PinPress.get_template_by_name(template_type, template_name)
     if !template_hash.nil?
@@ -72,23 +35,19 @@ module PinPress
     case template_type
     when Template::TEMPLATE_TYPE_PIN
       default_t_name = configuration.pinpress[:default_pin_template]
-      if template_name.nil?
-        t = configuration.pin_templates.find { |t| t[:name] == default_t_name }
-      else
-        t = configuration.pin_templates.find { |t| t[:name] == template_name }
-      end
+      templates = configuration.pin_templates
     when Template::TEMPLATE_TYPE_TAG
       default_t_name = configuration.pinpress[:default_tag_template]
-      if template_name.nil?
-        t = configuration.tag_templates.find { |t| t[:name] == default_t_name }
-      else
-        t = configuration.tag_templates.find { |t| t[:name] == template_name }
-      end
+      templates = configuration.tag_templates
     else
       fail 'Invalid template type given'
     end
 
-    t
+    if template_name.nil?
+      return templates.find { |t| t[:name] == default_t_name }
+    else
+      return templates.find { |t| t[:name] == template_name }
+    end
   end
 
   # Initializes PinPress by downloading and
@@ -96,56 +55,69 @@ module PinPress
   # @param [Boolean] from_scratch
   # @return [void]
   def self.init(from_scratch = false)
-    messenger.section_block('INITIALIZING') {
-      if from_scratch
-        configuration.reset
-        configuration.add_section(:pinpress)
-        configuration.add_section(:pin_templates)
-        configuration.add_section(:tag_templates)
-
-        default_pin_template = {
-          name: 'pinpress_default',
-          opener: '<ul>',
-          item: '<li><b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b> <%= extended %></li>',
-          item_separator: "\n",
-          closer: '</ul>'
-        }
-
-        default_tag_template = {
-          name: 'pinpress_default',
-          item: "<%= tag %> (<%= count %>),",
-          item_separator: ","
-        }
-
-        configuration.data['pin_templates'] = [default_pin_template]
-        configuration.data['tag_templates'] = [default_tag_template]
-        
-        configuration.pinpress.merge!({
-          config_location: configuration.config_path,
-          default_pin_template: 'pinpress_default',
-          default_tag_template: 'pinpress_default',
-          log_level: 'WARN',
-          version: PinPress::VERSION,
-        })
-      end
+    messenger.section('INITIALIZING...')
+    if from_scratch
+      configuration.reset
+      configuration.add_section(:pinpress)
+      configuration.add_section(:pin_templates)
+      configuration.add_section(:tag_templates)
+
+      default_pin_template = {
+        name: 'pinpress_default',
+        opener: "<ul>\n",
+        item: %q(<li>
+<b><a title="<%= description %>" href="<%= href %>" target="_blank"><%= description %></a>.</b>
+<%= extended %>
+</li>) + "\n",
+        closer: '</ul>'
+      }
 
-      pm = CLIUtils::Prefs.new(PinPress::PREF_FILES['INIT'], configuration)
-      pm.ask
-      configuration.ingest_prefs(pm)
+      default_tag_template = {
+        name: 'pinpress_default',
+        item: '<%= tag %> (<%= count %>),'
+      }
 
-      messenger.debug { "Configuration values after pref collection: #{ configuration.data }" }
-      configuration.save
-      @initialized = true
+      configuration.data['pin_templates'] = [default_pin_template]
+      configuration.data['tag_templates'] = [default_tag_template]
+
+      configuration.pinpress.merge!(
+        config_location: configuration.config_path,
+        default_pin_template: 'pinpress_default',
+        default_tag_template: 'pinpress_default',
+        log_level: 'WARN',
+        version: PinPress::VERSION
+      )
+    end
+
+    pm = CLIUtils::Prefs.new(PinPress::PREF_FILES['INIT'], configuration)
+    pm.ask
+    configuration.ingest_prefs(pm)
+
+    messenger.debug {
+      "Configuration values after pref collection: #{ configuration.data }"
     }
+    configuration.save
+    @initialized = true
   end
 
   # Present a list of installed templates to the user
   # @return [void]
   def self.list_templates
-    templates = configuration.templates
-    if !templates.nil?
-      messenger.section('AVAILABLE TEMPLATES')
-      templates.each_with_index do |template, index|
+    pin_templates = configuration.pin_templates
+    tag_templates = configuration.tag_templates
+
+    messenger.section('AVAILABLE PIN TEMPLATES:')
+    if !pin_templates.nil?
+      pin_templates.each_with_index do |template, index|
+        messenger.info("#{ index + 1 }. #{ template[:name] }")
+      end
+    else
+      messenger.warn('No templates defined...')
+    end
+
+    messenger.section('AVAILABLE TAG TEMPLATES:')
+    if !tag_templates.nil?
+      tag_templates.each_with_index do |template, index|
         messenger.info("#{ index + 1 }. #{ template[:name] }")
       end
     else

data/lib/PinPress/constants.rb

@@ -1,3 +1,5 @@
+# The PinPress module, which wraps everything
+# in this gem.
 module PinPress
   # The default local filepath of the Siftter Redux config file
   CONFIG_FILEPATH = File.join(ENV['HOME'], '.pinpress')
@@ -6,19 +8,25 @@ module PinPress
   LOG_FILEPATH = File.join(ENV['HOME'], '.pinpress_log')
 
   # The Gem's description
-  DESCRIPTION = 'A Pinboard application that allows for the creation of "pin templates" in almost any conceivable format.'
+  DESCRIPTION = %q(A Pinboard application that allows for the creation of
+                   pin and tag templates in almost any conceivable format.)
 
   # The last version to require a config update
-  NEWEST_CONFIG_VERSION = '1.0.0'
+  NEWEST_CONFIG_VERSION = '1.1.0'
 
   # Hash of preference files
   PREF_FILES = {
-    'INIT' => File.join(File.dirname(__FILE__), '..', '..', 'res/preference_prompts.yaml')
+    'INIT' => File.join(
+      File.dirname(__FILE__),
+      '..',
+      '..',
+      'res/preference_prompts.yaml'
+    )
   }
 
   # The Gem's summary
   SUMMARY = 'A simple CLI to create HTML templates of Pinboard data.'
 
   # The Gem's version
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/PinPress/templates/pin_template.rb

@@ -1,5 +1,7 @@
 module PinPress
+  # A template for a pin; even though
+  # currently empty, allows for future
+  # flexibility.
   class PinTemplate < Template
-
   end
-end
+end

data/lib/PinPress/templates/tag_template.rb

@@ -1,5 +1,7 @@
 module PinPress
+  # A template for a tag; even though
+  # currently empty, allows for future
+  # flexibility.
   class TagTemplate < Template
-    
   end
-end
+end

data/lib/PinPress/templates/template.rb

@@ -1,16 +1,41 @@
 module PinPress
+  # A template for outputting Pinboard data
   class Template
+    # Defines a pin template
+    # @return [Fixnum]
     TEMPLATE_TYPE_PIN = 1
+
+    # Defines a tag template
+    # @return [Fixnum]
     TEMPLATE_TYPE_TAG = 2
 
+    # Holds the "closer" (the string that
+    # should come after all template items
+    # are output)
+    # @return [String]
     attr_accessor :closer
+
+    # Holds the string that defines what
+    # an item should look like.
+    # @return [String]
     attr_accessor :item
-    attr_accessor :item_separator
+
+    # Holds the name of the template.
+    # @return [String]
     attr_accessor :name
+
+    # Holds the "opener" (the string that
+    # should come before all template items
+    # are output)
+    # @return [String]
     attr_accessor :opener
 
+    # Initializes this class by ingesting
+    # passed parameters.
+    # @param [Hash]
+    # @return [void]
     def initialize(params = {})
       params.each { |key, value| send("#{ key }=", value) }
     end
   end
-end
+end

data/{PinPress.gemspec → pinpress.gemspec}

@@ -1,28 +1,19 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pinpress/constants'
-
-Gem::Specification.new do |spec| 
+require File.join([File.dirname(__FILE__), 'lib', 'pinpress', 'constants.rb'])
+Gem::Specification.new do |spec|
   spec.name             = 'pinpress'
   spec.version          = PinPress::VERSION
-  spec.authors          = ['Aaron Bach']
-  spec.email            = ['bachya1208@googlemail.com']
+  spec.authors          = ["Aaron Bach"]
+  spec.email            = ["bachya1208@googlemail.com"]
   spec.summary          = PinPress::SUMMARY
   spec.description      = PinPress::DESCRIPTION
-  spec.homepage         = 'https://github.com/bachya/PinPress'
+  spec.homepage         = 'http://www.bachyaproductions.com/pinpress-joining-pinboard-wordpress/'
   spec.license          = 'MIT'
-  spec.platform         = Gem::Platform::RUBY
 
-  spec.require_paths    = ["lib"]
-  spec.files            = `git ls-files`.split("\n")
+  spec.files            = `git ls-files -z`.split("\x0")
   spec.executables      = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files       = spec.files.grep(%r{^(test|spec|features)/})
-  
-  spec.license          = 'MIT'
-  spec.rdoc_options     = ['--charset=UTF-8']
-  spec.extra_rdoc_files = %w[README.md HISTORY.md LICENSE]
-  
+  spec.require_paths    = ["lib"]
+
   spec.add_development_dependency('rake', '10.1.1')
   spec.add_development_dependency('rdoc', '4.1.1')
   spec.add_development_dependency('aruba', '0.5.4')
@@ -31,3 +22,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('gli','2.9.0')
   spec.add_runtime_dependency('pinboard', '0.1.1')
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinpress
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Aaron Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,24 +108,21 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.1.1
-description: A Pinboard application that allows for the creation of "pin templates"
-  in almost any conceivable format.
+description: |-
+  A Pinboard application that allows for the creation of
+                     pin and tag templates in almost any conceivable format.
 email:
 - bachya1208@googlemail.com
 executables:
 - PinPress
 extensions: []
-extra_rdoc_files:
-- README.md
-- HISTORY.md
-- LICENSE
+extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
 - HISTORY.md
 - LICENSE
-- PinPress.gemspec
 - README.md
 - Rakefile
 - bin/PinPress
@@ -140,17 +137,17 @@ files:
 - lib/PinPress/templates/pin_template.rb
 - lib/PinPress/templates/tag_template.rb
 - lib/PinPress/templates/template.rb
+- pinpress.gemspec
 - res/preference_prompts.yaml
 - res/sample_config.yaml
 - test/default_test.rb
 - test/test_helper.rb
-homepage: https://github.com/bachya/PinPress
+homepage: http://www.bachyaproductions.com/pinpress-joining-pinboard-wordpress/
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--charset=UTF-8"
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement