stocker 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cad3c6130530b2dccbfcd4a5465692e46cd07cc
-  data.tar.gz: 7ff0c78354f8224e77d214849c836d9abd348d37
+  metadata.gz: f00ea506db2b41a91d8150cb70a0eef1fc9f7e80
+  data.tar.gz: e9e51799ae4440178ab9756c19691dc537d0b26c
 SHA512:
-  metadata.gz: 12997945db1f731e29c3792fe7f15a154bcb80b61a14660d3f82db73cfcd568e76c47f671f07e5e008e0cca0e32e44d865a1fe714f1f853390dda16fdd71f611
-  data.tar.gz: b74609f35482b4a732c2939c9a16af53de99677aeb5e648cdb592f4a1ebd7253413aa30f75b3e936f3bbf6cab6c47454237eaf79b1b8c44038bf845e80a93b70
+  metadata.gz: 29c7842503ab717578627c8f263c6f385d55a0d3e1237230137d306f888face329348849356bc5c8ce7cbf56ee6e200cf9d41efc2554045cb1d645cb3b18490b
+  data.tar.gz: acc57516bc9d1dc91c90766ea569369a973fa5a210e3f936a29142907e998013e534b487e818dbc6628e2fc27d4e858b73cbf71baa47dfc4bc53bc79cd5c577f

data/lib/stocker.rb

@@ -5,14 +5,21 @@ require 'yaml'
 require 'thor'
 require 'titleize'
 
+# Stocker is an app for managing an inventory of items. For example, an inventory of household items such as cleaning products, foodstuffs and how many bottles of beer you have.
 # @author Brandon Pittman
 module Stocker
+  # This is the "God" object that interacts with Thor's methods.
   class Generator < Thor
+    # This trap is so that if you <Ctrl-C> out of "Stocker#count" your terminal won't display an error.
     trap("SIGINT") { exit 0 }
 
     desc "new ITEM TOTAL", "Add ITEM with TOTAL on hand to inventory."
     option :url, :aliases => :u
     option :minimum, :aliases => :m, :default => 1
+    # Creates a new item in the inventory
+    # @param item [String] The item to add to the inventory
+    # @param total [String] How many of the new item on hand
+    # @return [Hash] Returns a hash of the updated inventory and writes YAML to .stocker.yaml
     def new(item, total)
         data = read_file
         data[item] = {'total' => total.to_i, 'min' => options[:minimum].to_i, 'url' => options[:url] || read_config['url'], 'checked' => Time.now}
@@ -20,6 +27,10 @@ module Stocker
     end
 
     desc "delete ITEM", "Delete ITEM from inventory."
+    # Deletes an item from the inventory.
+    # Stocker will attempt a "fuzzy match" of the item name.
+    # @param item [String] The item to delete from the inventory
+    # @return [Hash] Returns a hash of the updated inventory and writes YAML to .stocker.yaml
     def delete(item)
       data = read_file
       match_name(item)
@@ -28,6 +39,8 @@ module Stocker
     end
 
     desc "check", "Check for low stock items."
+    # Checks the total number of items on hand against their acceptable minimum values and opens the URLs of any items running low in stock.
+    # @return Opens a link in default web browser if URL is set for low stock item
     def check
       links = []
       read_file.each do |key, value|
@@ -42,6 +55,9 @@ module Stocker
     end
 
     desc "total ITEM TOTAL", "Set TOTAL of ITEM."
+    # Set total of existing item in Stocker's inventory
+    # @param item [String] item to update
+    # @param total [String] total on hand
     def total(item, total)
       data = read_file
       match_name(item)
@@ -51,6 +67,9 @@ module Stocker
     end
 
     desc "url ITEM URL", "Set URL of ITEM."
+    # Set URL of existing item in Stocker's inventory
+    # @param item [String] item to update
+    # @param url [String] URL of item
     def url(item, url)
       data = read_file
       match_name(item)
@@ -60,12 +79,17 @@ module Stocker
     end
 
     desc "buy ITEM", "Open link to buy ITEM"
+    # Open URL of item
+    # @param item [String] existing item in inventory
     def buy(item)
       match_name(item)
       `open -a Safari #{read_file[@@item]["url"]}`
     end
 
     desc "min ITEM MINIMUM", "Set minimum acceptable amount for ITEM."
+    # Set minimum acceptable amount of existing inventory item
+    # @param item [String] item to update
+    # @param min [String] acceptable minimum amount of item to always have on hand
     def min(item, min)
       data = read_file
       match_name(item)
@@ -74,6 +98,9 @@ module Stocker
     end
 
     desc "count", "Take an interactive inventory."
+    # Do a count update for all inventory items *interactively*.
+    # Stocker#count will loop through the inventory and ask you for the total on hand count for each item.
+    # When the counting is finished, Stocker will run Stocker#check and open the URLs of any low stock items.
     def count
       values = read_file
       values.each do |key, value|
@@ -85,6 +112,8 @@ module Stocker
     end
 
     desc "csv", "Write entire inventory as CSV."
+    # Output a CSV dump of the entire inventory. This is useful with `awk` and `sed`.
+    # @return [String] CSV of entire inventory
     def csv
       read_file.each { |key, value| puts "#{key.titlecase},#{value['total']},#{value['min']},#{value['url']},#{value['checked']}" }
     end
@@ -99,6 +128,7 @@ module Stocker
 
       example: I have 24 beers. I want to have at least 23 on hand at all times. I have 23 bags of chips, but I only need to have one at all times. The beer's difference is only one, but the chips' is 22. So even though I have more beer, it will show up below chips in the list.
     LONGDESC
+    # Print a list of all inventory items. Green items are well stocked. Yellow items are at minimum acceptable total. Red items are below minimum acceptable total.
     def list
       begin
         @header = [[set_color("Item", :white), set_color("Total", :white)], [set_color("=================", :white), set_color("=====", :white)]]
@@ -134,6 +164,9 @@ module Stocker
 
     desc "config", "Set configuration settings for stocker."
     option :url, :aliases => :u, :type => :string, :required => true
+    # Configure Stocker's default settings
+    # If the --url param is not passed, no configurations will be changed.
+    # @param --url [String] Sets the default URL that is set for newly created inventory items
     def config
       settings = read_config
       settings['url'] = options[:url] || 'http://amazon.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stocker
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Brandon Pittman