tee_reverser 0.0.5 → 0.1.0

data/lib/tee_reverser/execute.rb

@@ -1,4 +1,5 @@
 module TeeReverser
+	# This method runs the program. 
 	def self.execute
 	Yummly.configure do |config|
 		  config.app_id = "bddcbcff"

data/lib/tee_reverser/pantry.rb

@@ -1,14 +1,23 @@
 require 'CSV'
-
-class Pantry #establishes user ingredients
+# This class is responsible for parsing the user ingredients, delivered
+# in a .txt file, and putting it into an array that Reverser can
+# work with.
+class Pantry
+	# This is the user-provided filepath name that parse will use to 
+	# generate an array.
 	attr_accessor :filepath
+	# This is where the pantry ingredients array will be stored.
 	attr_reader :list
 
+	# This method creates a new Pantry object that takes the filepath
+	# of a text file, and is described by an array of the contents. 
 	def initialize(filepath)
 		@filepath = filepath
 		@list = []
 	end
 
+	# This method opens the filepath given and produces a 
+	# one-dimensional array called list. 
 	def parse
 		CSV.foreach(self.filepath) {|row| @list << row}
 		@list.flatten!

data/lib/tee_reverser/recipe_list.rb

@@ -1,13 +1,22 @@
-class RecipeList #funnels Yummly results into workable hash
+# This class is responsible for funneling the data pulled from Yummly
+# and processing it into a hash that Reverser can process. 
+class RecipeList 
+	# This is what we get from Yummly.
 	attr_accessor :result
+	# This is what we'll be generating from Yummly data. 
 	attr_reader :recipehash
 
+# This method defines a new RecipeList, which is receives a data object
+# generated from the Yummly API, and produces a hash with recipe names
+# for the keys, and an array of ingredients for the values. 
 	def initialize(result)
 		@result = result
 		@recipehash = {}
-		# @recipehash = {"General Tso\u2019s Tofu"=>["sherry wine", "green bell pepper", "canola oil", "soy sauce", "green onions", "ginger", "firm tofu", "red pepper flakes", "red bell pepper", "white onion", "egg substitute", "sugar", "white vinegar", "vegetable stock", "minced garlic", "cornstarch", 0], "General Tso\u2019s Chicken and Broccoli"=>["brown rice", "sauce", "broccoli", "chicken", 0], "Laura\u2019s General Tso's Seitan"=>["soy sauce", "gingerroot", "seitan", "eggs", "garlic cloves", "vegetable oil", "sugar", "chiles", "water", "rice", "distilled white vinegar", "cornstarch", 0]}
 	end
 
+# This method builds the working hash from Yummly data, and 
+# initializes the last entry in the value array with a score
+# of 0. 
 	def listbuilder
 	recipes = result.collect {|recipe| recipe.name}
 	elements = result.collect {|recipe| recipe.ingredients}

data/lib/tee_reverser/reverser.rb

@@ -1,14 +1,27 @@
+# This class is responsible for comparing the list generated from Pantry
+# and the hash generated from RecipeList, and delivering the recipes with 
+# the maximum number of ingredient matches. 
+
 class Reverser
-	include Enumerable
-	attr_accessor :pantrylist, :tee
+
+	# This is the array of ingredients that we receive from performing Pantry.parse.
+	attr_accessor :pantrylist
+	# This is the hash of recipes/ingredients that we processed (via Yummly) with RecipeList.
+	attr_accessor :tee
+	# This is a hash of recipes, sorted by score, in the form of an Array. 
 	attr_reader :eat
 
+	# This creates a new Reverser object, which is described by a sorted hash in the form
+	# of an Array of Arrays.
 	def initialize(pantrylist, tee)
 		@pantrylist = pantrylist
 		@tee = tee
 		@eat = Hash.new
 	end
 
+# This method is responsible for first, comparing our ingredients with 
+# the recipes' ingredients, and then updating the recipe hash with 
+# the corresponding match scores, and then sorting the hash by that score. 
 	def reverse	
 		@tee.each do |k,v|
  		templist = v.join(" ")
@@ -19,6 +32,8 @@ class Reverser
  		@eat = @tee.sort_by{|k,v| v[-1]}
  	end
 
+# This method concludes the Execute method, and churns out the top 2 
+# recipe picks for the end user to pick from.
  	def choose
  		puts "Your best options are #{@eat[-1][0]}, and #{@eat[-2][0]}. You already have #{@eat[-1][-1][-1]}, and #{@eat[-2][-1][-1]} ingredients for each of those, respectively."
  		puts " "

data/lib/tee_reverser/version.rb

@@ -1,6 +1,4 @@
-# encoding: UTF-8
-# Copyright © 2013, stevenbxu
-
 module TeeReverser
+	# The latest and greatest. As of 2013-12-09.  
   VERSION = "0.0.5"
 end

data/lib/tee_reverser.rb

@@ -1,17 +1,18 @@
 require 'yummly'
-
-##
-#== TeeReverser: (Tee => Eet...eat!)
+# TeeReverser: (Tee => Eet...eat!)
+# Author::    Steven Xu (mailto: steven.b.xu at gmail.com)
+# Copyright:: Copyright (c) 2013, Steven Xu
+# License::   Distributes under the same terms as Ruby
 #
 # TeeReverser is a gem that assists in the complex decision making
-# process that is cooking. Given a text file with a list of ingredients
-# that you own in your very own pantry, and a desired dish that you wish
+# process that is deciding what to cook. Given a text file with a list of ingredients
+# that you own in your very own pantry, as well as a desired dish that you wish
 # to make, TeeReverser returns two recipes from Yummly.com that 
-# contain the largest number of ingredients in your pantry -- thereby 
-# saving you an average of four seconds of decision making every time! 
-
+# have the best match with your pantry -- thereby saving you an average of 
+# four seconds of decision making every time! 
+#
 # To run, require 'tee_reverser' and enter TeeReverser.execute in the command
-# line. 
+# line. TeeReverser requires the Yummly and CSV gems to run. 
 
 module TeeReverser
 	require 'tee_reverser/reverser.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tee_reverser
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -25,7 +25,7 @@ files:
 - lib/tee_reverser/version.rb
 homepage: http://rubygems.org/gems/tee_reverser
 licenses:
-- ! '?'
+- Distributes under the same terms as ruby.
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -42,10 +42,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- gems Yummly and CSV
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Basic functions finished, initial tests completed.
+summary: Choosing a recipe, made...simpler?
 test_files: []