ingredient_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cd55a427f0fe20d91ab4d7fba6c5d2256413f50
+  data.tar.gz: b94e059db2fd760fafceb3e2338423668b71cd03
+SHA512:
+  metadata.gz: 30febba279bb04f2c4376e14c4e77a5d403d8491b7bd856d4183aa17ca1ed74e739aeca26a1ad61270bfffaece09a4cf7eb9149647e952be948c4f3100fd22dd
+  data.tar.gz: b5beeaab0c79b26ea37677345b67fb2804ff4da9279e17fcafc0cd586f037eb4f8a0fc5295bdb10d71b904e8bc75a534f9ac653c1f35be6d0c0bd7450420ecfa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ingredient_parser.gemspec
+gemspec
+
+group :tools do
+  gem 'byebug'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Luke Rodgers
+
+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,51 @@
+# IngredientParser
+
+[![Build Status](https://travis-ci.org/lukeasrodgers/ingredient_parser.svg?branch=master)](https://travis-ci.org/lukeasrodgers/ingredient_parser)
+
+Basic recipe ingredient parser using [parslet](https://github.com/kschiess/parslet).
+
+It is not, and will never be, perfect. If it can't separate out a name from an amount, it will fallback to just returning the whole string as the name.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ingredient_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ingredient_parser
+
+## Usage
+
+```ruby
+2.1.2 :002 > ingr = IngredientParser.parse('10 tablespoons of bananas')
+ => #<IngredientParser::Ingredient:0x007f92652c2938 @name="bananas", @amount="10 tablespoons">
+2.1.2 :003 > ingr.name
+ => "bananas"
+2.1.2 :004 > ingr.amount
+ => "10 tablespoons"
+2.1.2 :005 >
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lukeasrodgers/ingredient_parser.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ingredient_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ingredient_parser.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ingredient_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ingredient_parser"
+  spec.version       = IngredientParser::VERSION
+  spec.authors       = ["Luke Rodgers"]
+  spec.email         = ["lukeasrodgers@gmail.com"]
+
+  spec.summary       = %q{Basic recipe ingredient parser.}
+  spec.homepage      = "https://github.com/lukeasrodgers/ingredient_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'parslet', '~> 1.6' 
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ingredient_parser.rb

@@ -0,0 +1,26 @@
+require 'parslet'
+
+require "ingredient_parser/version"
+require 'ingredient_parser/parser'
+require 'ingredient_parser/ingredient'
+
+module Parslet
+  class ParseFailed < StandardError
+    alias_method :parse_failure_cause, :cause
+
+    def cause
+      nil
+    end
+  end
+end
+
+module IngredientParser
+  extend self
+
+  @parser = Parser.new
+
+  def self.parse(str)
+    parsed = @parser.parse(str)
+    Ingredient.new(parsed[:name], parsed[:amount])
+  end
+end

data/lib/ingredient_parser/ingredient.rb

@@ -0,0 +1,26 @@
+module IngredientParser
+  class Ingredient
+    attr_reader :name, :amount
+    def initialize(name, amount)
+      @name = normalize(name)
+      @amount = normalize(amount)
+    end
+
+    private
+
+    def normalize(value)
+      case value
+      when NilClass
+        nil
+      when Parslet::Slice
+        value.str.strip
+      when String
+        if value.empty?
+          nil
+        else
+          value.strip
+        end
+      end
+    end
+  end
+end

data/lib/ingredient_parser/parser.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module IngredientParser
+  class Parser < Parslet::Parser
+    rule(:integer) { match('[0-9]').repeat(1) >> space? }
+
+    rule(:space) { match('\s').repeat(1) }
+    rule(:space?) { space.maybe }
+
+    rule(:half) { match('½') >> space? }
+
+    rule(:quantity) { integer | half }
+    rule(:quantity?) { quantity.maybe }
+
+    rule(:weighted) { match('[0-9]').repeat(1) >> weighted_separator >> weight }
+
+    rule(:hyphen) { str('-') }
+    rule(:space_separator) { match('\s') }
+    rule(:weighted_separator) { space_separator | hyphen }
+    rule(:weight) { pound | ounce | gram | kilogram }
+    rule(:pound) { str('pound') | str('lb') | str('lb.') }
+    rule(:ounce) { str('ounce') | str('oz') | str('oz.') }
+    rule(:gram) { str('gram') | str('g') | str('g.') }
+    rule(:kilogram) { str('kilogram') | str('kg') | str('kg.') | str('kilo') | str('k') }
+
+    rule(:litre) { str('litre') | str('liter') }
+    rule(:pint) { str('pint') }
+    rule(:cup) { str('cup') }
+    rule(:tablespoon) { str('tablespoon') | str('T') >> space | str('tbsp') >> str('.').maybe }
+    rule(:teaspoon) { str('teaspoon') | str('t') >> space | str('tsp') >> str('.').maybe }
+
+    rule(:volume) { litre | pint | cup | tablespoon | teaspoon}
+
+    rule(:measurement) { (weight >> str('s').maybe) | (volume >> str('s').maybe) }
+
+    rule(:large) { str('large') }
+    rule(:small) { str('small') }
+    rule(:medium) { str('medium') }
+    rule(:adjective) { large | small | medium }
+
+    rule(:quantified) { weighted | measurement | adjective }
+    rule(:quantified?) { quantified.maybe }
+
+    rule(:package) { str('package') >> str('s').maybe }
+    rule(:container) { str('container') >> str('s').maybe }
+    rule(:bottle) { str('bottle') >> str('s').maybe }
+    rule(:tin) { str('tin') >> str('s').maybe }
+    rule(:abstract_container) { package | bottle | tin | container }
+    rule(:abstract_container?) { space? >> abstract_container.maybe }
+
+    rule(:amount) { quantity? >> quantified? >> abstract_container? }
+    rule(:amount?) { amount.maybe }
+
+    rule(:name) { any.repeat(1) }
+
+    rule(:expression) { amount?.as(:amount) >> str('of').maybe >> name.as(:name) }
+    root(:expression)
+  end
+end

data/lib/ingredient_parser/version.rb

@@ -0,0 +1,3 @@
+module IngredientParser
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ingredient_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Rodgers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- lukeasrodgers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ingredient_parser.gemspec
+- lib/ingredient_parser.rb
+- lib/ingredient_parser/ingredient.rb
+- lib/ingredient_parser/parser.rb
+- lib/ingredient_parser/version.rb
+homepage: https://github.com/lukeasrodgers/ingredient_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Basic recipe ingredient parser.
+test_files: []