ingreedy 0.0.7 → 0.0.8

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 1.9.3@ingreedy

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.7
+  - 2.2.3
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode
+    - rvm: rbx-2.1.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://www.rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# Usage
+
+```ruby
+result = Ingreedy.parse('1 lb. potatoes')
+print result.amount
+  #=> 1.0
+print result.unit
+  #=> :pound
+print result.ingredient
+  #=> "potatoes"
+```
+
+### I18n and custom dictionaries
+
+```ruby
+Ingreedy.dictionaries[:fr] = { 
+  units: { dash: ['pincée'] }, 
+  numbers: { 'une' => 1 }, 
+  prepositions: ['de'] 
+}
+
+Ingreedy.locale = :fr # Also automatically follows I18n.locale if available
+
+result = Ingreedy.parse('une pincée de sucre')
+print result.amount
+  #=> 1.0
+print result.unit
+  #=> :dash
+print result.ingredient
+  #=> "sucre"
+```
+
+[Live demo](http://hangryingreedytest.herokuapp.com/)
+
+# Pieces of Flair
+- [![Gem Version](https://badge.fury.io/rb/ingreedy.svg)](http://badge.fury.io/rb/ingreedy)
+- [![Build Status](https://secure.travis-ci.org/iancanderson/ingreedy.svg?branch=master)](http://travis-ci.org/iancanderson/ingreedy)
+- [![Code Climate](https://codeclimate.com/github/iancanderson/ingreedy.svg)](https://codeclimate.com/github/iancanderson/ingreedy)
+- [![Coverage Status](https://coveralls.io/repos/iancanderson/ingreedy/badge.svg)](https://coveralls.io/r/iancanderson/ingreedy)
+
+# Development
+
+Run the tests:
+```
+rspec spec
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/ingreedy.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path("../lib/ingreedy/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "ingreedy"
+  s.version     = Ingreedy::VERSION
+  s.licenses    = ["MIT"]
+  s.authors     = ["Ian C. Anderson"]
+  s.email       = ["ian@iancanderson.com"]
+
+  s.summary     = "Recipe parser"
+  s.description = <<-MSG
+    Natural language recipe ingredient parser that supports numeric amount,
+    units, and ingredient
+  MSG
+  s.homepage = "http://github.com/iancanderson/ingreedy"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = "lib"
+
+  s.add_dependency "parslet", "~> 1.7.0", ">= 1.7.0"
+
+  s.add_development_dependency "rake", "~> 0.9", ">= 0.9"
+  s.add_development_dependency "rspec", "~> 3.3.0", ">= 3.3.0"
+  s.add_development_dependency "coveralls", "~> 0.7.0", ">= 0.7.0"
+  s.add_development_dependency "pry"
+end

data/lib/ingreedy.rb

@@ -1,20 +1,24 @@
-path = File.expand_path(File.join(File.dirname(__FILE__), 'ingreedy'))
+path = File.expand_path(File.join(File.dirname(__FILE__), "ingreedy"))
 
-require File.join(path, 'case_insensitive_parser')
-require File.join(path, 'ingreedy_parser')
-require File.join(path, 'dictionary_collection')
+require File.join(path, "case_insensitive_parser")
+require File.join(path, "ingreedy_parser")
+require File.join(path, "dictionary_collection")
 
 module Ingreedy
-  class << self
-    attr_accessor :locale
+  def self.locale
+    @locale ||= nil
+  end
+
+  def self.locale=(locale)
+    @locale = locale
+  end
 
-    def parse(query)
-      parser = Parser.new(query)
-      parser.parse
-    end
+  def self.parse(query)
+    parser = Parser.new(query)
+    parser.parse
+  end
 
-    def dictionaries
-      @dictionaries ||= DictionaryCollection.new
-    end
+  def self.dictionaries
+    @dictionaries ||= DictionaryCollection.new
   end
 end

data/lib/ingreedy/amount_parser.rb

@@ -1,7 +1,6 @@
-require 'parslet'
+require "parslet"
 
 module Ingreedy
-
   class AmountParser < Parslet::Parser
     include CaseInsensitiveParser
 
@@ -10,16 +9,16 @@ module Ingreedy
     end
 
     rule(:integer) do
-      match('[0-9]').repeat(1)
+      match("[0-9]").repeat(1)
     end
 
     rule(:float) do
       integer.maybe >>
-      float_delimiter >> integer
+        float_delimiter >> integer
     end
 
     rule(:float_delimiter) do
-      str(',') | str('.')
+      str(",") | str(".")
     end
 
     rule(:fraction) do
@@ -28,16 +27,16 @@ module Ingreedy
 
     rule(:compound_simple_fraction) do
       (integer.as(:integer_amount) >> whitespace).maybe >>
-      simple_fraction.as(:fraction_amount)
+        simple_fraction.as(:fraction_amount)
     end
 
     rule(:simple_fraction) do
-      integer >> match('/') >> integer
+      integer >> match("/") >> integer
     end
 
     rule(:compound_vulgar_fraction) do
       (integer.as(:integer_amount) >> whitespace.maybe).maybe >>
-      vulgar_fraction.as(:fraction_amount)
+        vulgar_fraction.as(:fraction_amount)
     end
 
     rule(:vulgar_fraction) do
@@ -49,26 +48,26 @@ module Ingreedy
     end
 
     rule(:amount_unit_separator) do
-      whitespace | str('-')
+      whitespace | str("-")
     end
 
     rule(:amount) do
       fraction |
-      float.as(:float_amount) |
-      integer.as(:integer_amount) |
-      word_digit.as(:word_integer_amount) >> amount_unit_separator
+        float.as(:float_amount) |
+        integer.as(:integer_amount) |
+        word_digit.as(:word_integer_amount) >> amount_unit_separator
     end
 
     root(:amount)
 
     private
 
-      def word_digits
-        Ingreedy.dictionaries.current.numbers.keys
-      end
+    def word_digits
+      Ingreedy.dictionaries.current.numbers.keys
+    end
 
-      def vulgar_fractions
-        Ingreedy.dictionaries.current.vulgar_fractions.keys
-      end
+    def vulgar_fractions
+      Ingreedy.dictionaries.current.vulgar_fractions.keys
+    end
   end
 end

data/lib/ingreedy/case_insensitive_parser.rb

@@ -1,12 +1,10 @@
 module Ingreedy
   module CaseInsensitiveParser
-
     def stri(str)
       key_chars = str.split(//)
       key_chars.
-        collect! { |char| match["#{char.upcase}#{char.downcase}"] }.
+        map! { |char| match["#{char.upcase}#{char.downcase}"] }.
         reduce(:>>)
     end
-
   end
 end

data/lib/ingreedy/dictionaries/en.yml

@@ -0,0 +1,137 @@
+:units:
+  :cup:
+    - "cups"
+    - "cup"
+    - "c."
+    - "c"
+  :fluid_ounce:
+    - "fl. oz."
+    - "fl oz"
+    - "fluid ounce"
+    - "fluid ounces"
+  :gallon:
+    - "gal"
+    - "gal."
+    - "gallon"
+    - "gallons"
+  :ounce:
+    - "oz"
+    - "oz."
+    - "ounce"
+    - "ounces"
+  :pint:
+    - "pt"
+    - "pt."
+    - "pint"
+    - "pints"
+  :pound:
+    - "lb"
+    - "lb."
+    - "pound"
+    - "pounds"
+  :quart:
+    - "qt"
+    - "qt."
+    - "qts"
+    - "qts."
+    - "quart"
+    - "quarts"
+  :tablespoon:
+    - "tbsp."
+    - "tbsp"
+    - "T"
+    - "T."
+    - "tablespoon"
+    - "tablespoons"
+    - "tbs."
+    - "tbs"
+  :teaspoon:
+    - "tsp."
+    - "tsp"
+    - "t"
+    - "t."
+    - "teaspoon"
+    - "teaspoons"
+  :gram:
+    - "g"
+    - "g."
+    - "gr"
+    - "gr."
+    - "gram"
+    - "grams"
+  :kilogram:
+    - "kg"
+    - "kg."
+    - "kilogram"
+    - "kilograms"
+  :liter:
+    - "l"
+    - "l."
+    - "liter"
+    - "liters"
+  :milligram:
+    - "mg"
+    - "mg."
+    - "milligram"
+    - "milligrams"
+  :milliliter:
+    - "ml"
+    - "ml."
+    - "milliliter"
+    - "milliliters"
+  :pinch:
+    - "pinch"
+    - "pinches"
+  :dash:
+    - "dash"
+    - "dashes"
+  :touch:
+    - "touch"
+    - "touches"
+  :handful:
+    - "handful"
+    - "handfuls"
+  :stick:
+    - "stick"
+    - "sticks"
+  :clove:
+    - "cloves"
+    - "clove"
+  :can:
+    - "cans"
+    - "can"
+  :to_taste:
+    - "to taste"
+:numbers:
+  a: 1
+  an: 1
+  zero: 0
+  one: 1
+  two: 2
+  three: 3
+  four: 4
+  five: 5
+  six: 6
+  seven: 7
+  eight: 8
+  nine: 9
+  ten: 10
+  eleven: 11
+  twelve: 12
+  thirteen: 13
+  fourteen: 14
+  fifteen: 15
+  sixteen: 16
+  seventeen: 17
+  eighteen: 18
+  nineteen: 19
+  twenty: 20
+  thirty: 30
+  forty: 40
+  fifty: 50
+  sixty: 60
+  seventy: 70
+  eighty: 80
+  ninety: 9
+:prepositions:
+  - "of"

data/lib/ingreedy/dictionary.rb

@@ -3,7 +3,7 @@ module Ingreedy
     attr_reader :units, :numbers, :prepositions
 
     def initialize(entries = {})
-      @units = entries[:units] || raise('No units found in dictionary')
+      @units = entries[:units] || raise("No units found in dictionary")
       @numbers = entries[:numbers] || {}
       @prepositions = entries[:prepositions] || []
     end
@@ -11,24 +11,24 @@ module Ingreedy
     # https://en.wikipedia.org/wiki/Number_Forms
     def vulgar_fractions
       {
-        "\u00BC" => '1/4',
-        "\u00BD" => '1/2',
-        "\u00BE" => '3/4',
-        "\u2150" => '1/7',
-        "\u2151" => '1/9',
-        "\u2152" => '1/10',
-        "\u2153" => '1/3',
-        "\u2154" => '2/3',
-        "\u2155" => '1/5',
-        "\u2156" => '2/5',
-        "\u2157" => '3/5',
-        "\u2158" => '4/5',
-        "\u2159" => '1/6',
-        "\u215A" => '5/6',
-        "\u215B" => '1/8',
-        "\u215C" => '3/8',
-        "\u215D" => '5/8',
-        "\u215E" => '7/8'
+        "\u00BC" => "1/4",
+        "\u00BD" => "1/2",
+        "\u00BE" => "3/4",
+        "\u2150" => "1/7",
+        "\u2151" => "1/9",
+        "\u2152" => "1/10",
+        "\u2153" => "1/3",
+        "\u2154" => "2/3",
+        "\u2155" => "1/5",
+        "\u2156" => "2/5",
+        "\u2157" => "3/5",
+        "\u2158" => "4/5",
+        "\u2159" => "1/6",
+        "\u215A" => "5/6",
+        "\u215B" => "1/8",
+        "\u215C" => "3/8",
+        "\u215D" => "5/8",
+        "\u215E" => "7/8",
       }
     end
   end

data/lib/ingreedy/dictionary_collection.rb

@@ -1,5 +1,5 @@
-require 'yaml'
-require_relative 'dictionary'
+require "yaml"
+require_relative "dictionary"
 
 module Ingreedy
   class DictionaryCollection
@@ -26,7 +26,9 @@ module Ingreedy
     end
 
     def load_yaml(locale)
-      path = File.expand_path(File.join(File.dirname(__FILE__), 'dictionaries', "#{locale}.yml"))
+      path = File.expand_path(
+        File.join(File.dirname(__FILE__), "dictionaries", "#{locale}.yml"),
+      )
       YAML.load_file(path)
     rescue Errno::ENOENT
       raise "No dictionary found for :#{locale} locale"