stickynotifications 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55dec5a3686fdff700936da1456b732dc442692b
-  data.tar.gz: 9ef8ec5972cf7db76716521cdca0e0cfcf85aa8a
+  metadata.gz: f6a227cb7d63bb6692127472222098ad3cd6927a
+  data.tar.gz: 3386c989ab211cbd45cd17881c1f5e5db5d3a428
 SHA512:
-  metadata.gz: dbc9518f95f703e851aef8d3e580c5edf28eefe9feebc70346a873e6383ab61c5890c15456f3ba92cf5fad0608ff9c115fcf0a7f071c2d2b87bc3431d6eeaa3d
-  data.tar.gz: 4663aca6528b47f7e2701373565d0879084e673e41362e8c9d9fe66f3385056082adf0c44e07dc62a26053e2de13764a739188ef0a8444e0844e736911832cf2
+  metadata.gz: 58df8d847f9e9e449e00cb2f0c8cd6b9b585f18064d762b4b063cb3c7a1b280e3d8cd34d76fda0850b325684dc87d17076be94a9bd922f54d3d171b79b6efda6
+  data.tar.gz: aae1cb77168dcee49c97b1f0d6f1612e4a148f2f9307d9d7c3aea0e9c433325e7145bf169761bb82740b98fb9b95615b81f82f73a910b07a84f99851bd4e4c03

data/bin/stickynotifications

@@ -2,5 +2,7 @@
 
 require 'stickynotifications'
 
+# @author "Brandon Pittman"
+# Starts Thor
 StickyNotifications.start(ARGV)
 

data/lib/stickynotifications/version.rb

@@ -1,3 +1,5 @@
+# Sets version for RubyGems
 module Stickynotifications
-  VERSION = "0.0.3"
+  # Sets version for RubyGems
+  VERSION = "0.0.4"
 end

data/lib/stickynotifications.rb

@@ -2,13 +2,22 @@ require "stickynotifications/version"
 require 'uri'
 require 'thor'
 
+# @author "Brandon Pittman"
+# All logic for StickyNotifications
 class StickyNotifications < Thor
+
   desc "new TEXT", "create new Sticky Notification with TEXT"
+  # Creates a new Sticky Notification
+  # @param sticky_text [String] the text of the Sticky Notification
   def new(sticky_text)
     %x{open "sticky-notifications://note?message=#{escape_string(sticky_text)}"}
   end
 
   no_commands do
+    # Escapes the Sticky Notification text for URLs. URI produces %20 for
+    # spaces instead of CGI's +.
+    # @param string_to_escape [String] the text to be escaped
+    # @return [String] parsed URL
     def escape_string(string_to_escape)
       URI.escape(string_to_escape)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stickynotifications
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - brandonpittman