emeals 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c883efc225e72b90fe4943bcce321f9933664452
+  data.tar.gz: f7b246806d4fc330a5bf42235871ec8ae4615e48
+SHA512:
+  metadata.gz: 4f3596e65d12aeb0d1a58362eb83b408aa83fa05210b4b53b81fd63ecf921eebf1f39818edf17481bbb3f28cc0c1e39995888ad82cc68c2cbafc88e70586033f
+  data.tar.gz: 27e5874c713d6de1662e74a9d56cb4d54385eb794ee5369925db7f81e6e447fc9d5986c02153f8fb26c8ee8ba509a03a2b604608b69eb4ac5e2634e8aba1ed5f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+script:
+  - sudo apt-get install xpdf
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in emeals.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Moriarity
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+[![Build Status](https://travis-ci.org/mjm/emeals.png?branch=master)](https://travis-ci.org/mjm/emeals)
+
+# Emeals
+
+A library for reading menus from [eMeals][].
+
+[emeals]: http://emeals.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'emeals'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emeals
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/emeals.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'emeals/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "emeals"
+  gem.version       = Emeals::VERSION
+  gem.authors       = ["Matt Moriarity"]
+  gem.email         = ["matt@mattmoriarity.com"]
+  gem.description   = %q{A client for interpreting eMeals menus.}
+  gem.summary       = %q{eMeals Client}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/emeals.rb

@@ -0,0 +1,6 @@
+require "emeals/version"
+
+module Emeals
+end
+
+require "emeals/client"

data/lib/emeals/client.rb

@@ -0,0 +1,34 @@
+require 'emeals/menu'
+
+require 'fileutils'
+require 'tempfile'
+
+class Emeals::Client
+  def parse(filename_or_file)
+    temp_file = copy_to_temp_file(filename_or_file)
+    text = pdf_to_text(temp_file.path)
+
+    Emeals::Menu.parse(text)
+  end
+
+  private
+
+  def copy_to_temp_file(filename_or_file)
+    Tempfile.open(['menu', '.pdf']) do |temp|
+      temp.binmode
+      temp.write(filename_or_file.is_a?(String) ? File.read(filename_or_file) : filename_or_file.read)
+      temp
+    end
+  end
+
+  def pdf_to_text(filename)
+    system(pdf_to_text_path, '-raw', '-enc', 'UTF-8', filename)
+    File.read(filename.sub(/\.pdf$/, '.txt'))
+  end
+
+  def pdf_to_text_path
+    path = `which pdftotext`.chop
+    return '/opt/boxen/homebrew/bin/pdftotext' if path.empty?
+    path
+  end
+end

data/lib/emeals/dish.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+class Emeals::Dish
+  attr_accessor :name, :ingredients, :instructions
+
+  def initialize(name)
+    @name = name
+    @ingredients = []
+    @instructions = []
+  end
+end
+
+class Emeals::Quantity
+  UNITS = %w(teaspoon tablespoon cup oz lb bag clove).map(&:to_sym)
+  UNITS_WITH_PLURALS = UNITS + UNITS.map {|u| "#{u}s".to_sym }
+
+  attr_reader :amount, :unit
+
+  def initialize(amount, unit = nil)
+    @amount = to_amount(amount)
+    @unit   = unit && unit.to_sym
+  end
+
+  def ==(other)
+    other.amount == @amount && other.unit == @unit
+  end
+
+  private
+
+  def to_amount(str)
+    case str
+      when "\xC2\xBC"; '1/4'
+      when "\xC2\xBD"; '1/2'
+      else             str
+    end.to_r
+  end
+end
+
+class Emeals::Ingredient
+  attr_accessor :quantity, :description
+
+  def initialize(amount, unit, description)
+    @quantity = Emeals::Quantity.new(amount, unit)
+    @description = description
+  end
+
+  PARSE_REGEX = /((?:\d|\xC2\xBC|\xC2\xBD)+) (?:(#{Emeals::Quantity::UNITS_WITH_PLURALS.join("|")}) )?(.+)/
+
+  def self.parse(line)
+    if line =~ PARSE_REGEX
+      amount, unit, description = $1, $2, $3
+      new(amount, unit && unit.sub(/s$/, ''), description)
+    else
+      raise "tried to parse improperly formatted ingredient: #{line.inspect}"
+    end
+  end
+
+  def ==(other)
+    other.quantity == @quantity && other.description == @description
+  end
+end

data/lib/emeals/meal.rb

@@ -0,0 +1,135 @@
+# encoding:utf-8
+
+require 'emeals/dish'
+
+class Emeals::Meal
+  attr_reader :entree, :side, :flags, :times
+
+  def initialize(entree = nil, side = nil)
+    @entree = entree
+    @side = side
+    @flags = []
+    @times = {}
+  end
+
+  def parse!(meal_text)
+    parse_state = :header
+    names = []
+    entree_instructions = []
+    side_instructions = []
+    meal_text.split("\n").each do |line|
+      case parse_state
+        when :header
+          parse_flags(line)
+          parse_state = :names
+        when :names
+          if line =~ /Prep Cook Total/
+            entree_name, side_name = separate_entree_and_side_names(names)
+            @entree = Emeals::Dish.new(entree_name)
+            @side = Emeals::Dish.new(side_name)
+            parse_state = :times
+          else
+            names << line
+          end
+        when :times
+          parse_times(line)
+          parse_state = :entree_ingredients
+        when :entree_ingredients
+          if line.include? "-------"
+            parse_state = :side_ingredients
+          else
+            add_ingredients_to_dish(line, @entree)
+          end
+        when :side_ingredients
+          if line =~ /^[A-Z]/
+            entree_instructions << line
+            parse_state = :entree_instructions
+          else
+            add_ingredients_to_dish(line, @side)
+          end
+        when :entree_instructions
+          if line.include? "-------"
+            add_instructions_to_dish(entree_instructions, @entree)
+            parse_state = :side_instructions
+          else
+            entree_instructions << line
+          end
+        when :side_instructions
+          if line =~ /^Copyright/
+            side_instructions = side_instructions[0..-3]
+            break
+          else
+            side_instructions << line
+          end
+        else
+
+      end
+    end
+
+    add_instructions_to_dish(side_instructions, @side)
+    self
+  end
+
+  FLAGS = {
+      "Slow Cooker"    => :slow_cooker,
+      "On the Grill"   => :on_the_grill,
+      "Super Fast"     => :super_fast,
+      "Marinate Ahead" => :marinate_ahead
+  }
+
+  %w(slow_cooker on_the_grill super_fast marinate_ahead).each do |flag|
+    define_method "#{flag}?" do
+      @flags.include? flag.to_sym
+    end
+  end
+
+  private
+
+  def separate_entree_and_side_names(names)
+    case names.size
+      when 2
+        names
+      when 3
+        if names[1].length < names[0].length
+          [join_names(names[0..1]), names[2]]
+        else
+          [names[0], join_names(names[1..2])]
+        end
+      else
+        [join_names(names[0..1]), join_names(names[2..-1])]
+    end
+  end
+
+  def join_names(names)
+    names.join(" ").gsub('- ', '-')
+  end
+
+  def parse_flags(line)
+    FLAGS.each do |flag, sym|
+      @flags << sym if line.include? flag
+    end
+  end
+
+  def parse_times(line)
+    times = line.split(" ")
+    @times[:prep] = times.first
+    @times[:cook] = times[1]
+    @times[:total] = times[2..-1].join(" ")
+  end
+
+  INGREDIENT_REGEX = /(?:\d|\xC2\xBC|\xC2\xBD)+ .+?(?=, (?:\d|\xC2\xBC|\xC2\xBD)+|$)/
+
+  def add_ingredients_to_dish(line, dish)
+    if line =~ /^\d|\xC2\xBC|\xC2\xBD/
+      line.scan(INGREDIENT_REGEX).each do |match|
+        dish.ingredients << Emeals::Ingredient.parse(match)
+      end
+    else
+      dish.ingredients.last.description << " #{line}"
+    end
+  end
+
+  def add_instructions_to_dish(lines, dish)
+    dish.instructions = lines.join(" ").split(/\. ?/)
+  end
+end

data/lib/emeals/menu.rb

@@ -0,0 +1,34 @@
+require 'emeals/meal'
+
+class Emeals::Menu
+  attr_reader :count, :meals
+
+  def initialize
+    @count = 0
+    @meals = []
+  end
+
+  def parse!(menu_text)
+    buffer = []
+    add_to_buffer = false
+    menu_text.split("\n").each do |line|
+      if line =~ /Meal (\d+)/
+        unless buffer.empty? and !add_to_buffer
+          @count = @count + 1
+          @meals << Emeals::Meal.new.parse!(buffer.join("\n"))
+        end
+
+        add_to_buffer = @count < $1.to_i
+        buffer = add_to_buffer ? [line] : []
+        next unless add_to_buffer
+      else
+        buffer << line if add_to_buffer
+      end
+    end
+    self
+  end
+
+  def self.parse(menu_text)
+    new.parse!(menu_text)
+  end
+end

data/lib/emeals/version.rb

@@ -0,0 +1,3 @@
+module Emeals
+  VERSION = "0.0.1"
+end

data/spec/client_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+require 'emeals'
+
+describe Emeals::Client do
+  subject(:client) { Emeals::Client.new }
+  let(:menu_path) { File.join(File.dirname(__FILE__), 'fixtures', 'menu.pdf') }
+
+  before(:each) do
+    @menu = client.parse(menu_path)
+    @meals = @menu.meals
+  end
+
+  context "when given a File handle instead of a filename" do
+    it "completes successfully" do
+      File.open(menu_path) do |file|
+        expect(client.parse(file).count).to eq 7
+      end
+    end
+  end
+
+  it "counts the number of meals in the menu" do
+    expect(@menu.count).to eq 7
+  end
+
+  describe "entree names" do
+    it "reads the names of entrees when the side wraps to two lines" do
+      expect(@meals[5].entree.name).to eq "Baked Cod Provencal"
+    end
+
+    it "reads the names of entrees which wrap to two lines" do
+      expect(@meals.first.entree.name).to eq "Spicy Sausage and Egg Scramble"
+    end
+
+    it "reads the names of entrees when both the side and entree wrap to two lines" do
+      expect(@meals.last.entree.name).to eq "Peppery Grilled Ribeye Steaks"
+    end
+  end
+
+  describe "side names" do
+    it "reads the names of sides that are a single line" do
+      expect(@meals.first.side.name).to eq "Oregano Roasted Zucchini"
+    end
+
+    it "reads the names of sides that wrap to two lines" do
+      expect(@meals[5].side.name).to eq "Roasted Asparagus with Sun-Dried Tomatoes"
+    end
+
+    it "reads the names of sides when both the side and entree wrap to two lines" do
+      expect(@meals.last.side.name).to eq "Heirloom Tomato and Spinach Salad"
+    end
+  end
+
+  describe "flags" do
+    it "reads a meal with no flags correctly" do
+      expect(@meals.first.flags).to be_empty
+    end
+
+    it "reads the slow cooker flag correctly" do
+      expect(@meals[1].flags).to eq [:slow_cooker]
+      expect(@meals[1]).to be_slow_cooker
+    end
+
+    it "reads the on the grill flag correctly" do
+      expect(@meals[3].flags).to eq [:on_the_grill]
+      expect(@meals[3]).to be_on_the_grill
+    end
+
+    it "reads the super fast flag correctly" do
+      expect(@meals[5].flags).to eq [:super_fast]
+      expect(@meals[5]).to be_super_fast
+    end
+
+    it "reads the marinate ahead flag correctly" do
+      expect(@meals[6].flags).to eq [:marinate_ahead]
+      expect(@meals[6]).to be_marinate_ahead
+    end
+  end
+
+  describe "times" do
+    it "reads prep times correctly" do
+      expect(@meals.first.times[:prep]).to eq "10m"
+      expect(@meals[5].times[:prep]).to eq "15m"
+    end
+
+    it "reads cook times correctly" do
+      expect(@meals.first.times[:cook]).to eq "20m"
+      expect(@meals[1].times[:cook]).to eq "4h"
+    end
+
+    it "reads total times correctly" do
+      expect(@meals.first.times[:total]).to eq "30m"
+      expect(@meals[1].times[:total]).to eq "4h 10m"
+    end
+  end
+
+  describe "entree ingredients" do
+    include Emeals
+
+    let(:dish) { @meals.first.entree }
+
+    it "reads the correct number of ingredients" do
+      expect(dish.ingredients.size).to be 5
+    end
+
+    it "reads the correct descriptions of ingredients" do
+      expect(dish.ingredients[1].description).to eq "small onion, minced"
+      expect(dish.ingredients[3].description).to eq "kosher salt"
+      expect(dish.ingredients[4].description).to eq "pepper"
+    end
+
+    it "reads the correct quantities of ingredients" do
+      expect(dish.ingredients[0].quantity).to eq Emeals::Quantity.new('1/4', 'lb')
+      expect(dish.ingredients[1].quantity).to eq Emeals::Quantity.new('1/2')
+      expect(dish.ingredients[2].quantity).to eq Emeals::Quantity.new('4')
+    end
+  end
+
+  describe "side ingredients" do
+    include Emeals
+
+    let(:dish) { @meals[3].side }
+
+    it "reads the correct number of ingredients" do
+      expect(dish.ingredients.size).to be 5
+    end
+
+    it "reads the correct descriptions of ingredients" do
+      expect(dish.ingredients[0].description).to eq "(5-oz) bag baby spinach"
+      expect(dish.ingredients[1].description).to eq "drained and chopped roasted red bell peppers"
+      expect(dish.ingredients[2].description).to eq "pitted kalamata olives, cut in half"
+    end
+
+    it "reads the correct quantities of ingredients" do
+      expect(dish.ingredients[0].quantity).to eq Emeals::Quantity.new('1/2')
+      expect(dish.ingredients[3].quantity).to eq Emeals::Quantity.new('2')
+      expect(dish.ingredients[4].quantity).to eq Emeals::Quantity.new('1/4', 'cup')
+    end
+  end
+
+  describe "entree instructions" do
+    let(:dish) { @meals[2].entree }
+
+    it "reads the correct number of instructions" do
+      expect(dish.instructions.size).to be 7
+    end
+
+    it "reads the correct text of the instructions" do
+      expect(dish.instructions[0]).to eq "Preheat oven to 425 degrees"
+      expect(dish.instructions[4]).to eq "Dip fish in egg mixture; dredge in almond flour"
+      expect(dish.instructions[6]).to eq "Bake 8 minutes or until fish flakes with a fork"
+    end
+  end
+
+  describe "side instructions" do
+    let(:dish) { @meals[2].side }
+
+    it "reads the correct number of instructions" do
+      expect(dish.instructions.size).to be 7
+    end
+
+    it "reads the correct text of the instructions" do
+      expect(dish.instructions[0]).to eq "Preheat oven to 425 degrees"
+      expect(dish.instructions[1]).to eq "Toss zucchini, 1 tablespoon oil, salt and pepper on a large baking sheet; spread into a single layer"
+      expect(dish.instructions[6]).to eq "Bake 20 minutes or until center is set"
+    end
+
+    context "when the meal is the last on the page" do
+      let(:dish) { @meals[3].side }
+
+      it "reads the correct number of instructions" do
+        expect(dish.instructions.size).to be 1
+      end
+
+      it "reads the correct instruction text" do
+        expect(dish.instructions.first).to eq "Combine spinach, roasted bell peppers, olives, pepperoncini peppers and vinaigrette in a large bowl; toss well to coat"
+      end
+    end
+  end
+end