herbalist 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Duff
+
+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.rdoc

@@ -0,0 +1,36 @@
+= herbalist
+
+Herbalist is a natural language measurements parser. It is built on top of the Alchemist[http://github.com/toastyapps/alchemist] gem and draws heavily from the Chronic[http://github.com/evaryont/chronic].
+
+== Installation
+
+    $ sudo gem sources -a http://gemcutter.org
+    $ sudo gem install herbalist
+
+== Usage
+
+    >> require 'herbalist'
+    >> Herbalist.parse("a quarter cup")
+    => #<Alchemist::NumericConversion @value=0.25, @exponent=1.0, @unit_name=:cup>
+    
+    >> Herbalist.parse("it was two and a half football fields")
+    => #<Alchemist::NumericConversion @value=2.5, @exponent=1.0, @unit_name=:football_fields>
+    
+    >> Herbalist.parse('twenty-one and a half Miles')
+    => #<Alchemist::NumericConversion @value=21.5, @exponent=1.0, @unit_name=:miles>
+    
+    >> Herbalist.parse('fifteen kilowatt Hours')
+    => #<Alchemist::NumericConversion @value=15.0, @exponent=1.0, @unit_name=:kilowatt_hours>
+
+== Limitations
+
+Parsing is limited to units that Alchemist can understand.
+
+== TODO
+
+-Allow parsing of units directly next to digits (ed 4m, 21.5L)
+-Add options to limit which type of units to parse (only volume or distance)
+
+== Copyright
+
+Copyright (c) 2009 John Duff. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "herbalist"
+    gem.summary = %Q{Herbalist is a natural language measurements parser.}
+    gem.description = %Q{Herbalist is a natural language measurements parser. It is built on top of the Alchemist[http://github.com/toastyapps/alchemist] gem and draws heavily from the Chronic[http://github.com/evaryont/chronic].}
+    gem.email = "duff.john@gmail.com"
+    gem.homepage = "http://github.com/jduff/herbalist"
+    gem.authors = ["jduff"]
+    
+    gem.add_dependency('alchemist', '>= 0.1.2')
+    gem.add_dependency('numerizer', '>= 0.1.1')
+    
+    gem.add_development_dependency('jeremymcanally-context')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "herbalist #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/herbalist.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{herbalist}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jduff"]
+  s.date = %q{2010-01-02}
+  s.description = %q{Herbalist is a natural language measurements parser. It is built on top of the Alchemist[http://github.com/toastyapps/alchemist] gem and draws heavily from the Chronic[http://github.com/evaryont/chronic].}
+  s.email = %q{duff.john@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "herbalist.gemspec",
+     "lib/herbalist.rb",
+     "lib/herbalist/herbalist.rb",
+     "test/test_helper.rb",
+     "test/test_herbalist.rb"
+  ]
+  s.homepage = %q{http://github.com/jduff/herbalist}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Herbalist is a natural language measurements parser.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/test_herbalist.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<alchemist>, [">= 0.1.2"])
+      s.add_runtime_dependency(%q<numerizer>, [">= 0.1.1"])
+      s.add_development_dependency(%q<jeremymcanally-context>, [">= 0"])
+    else
+      s.add_dependency(%q<alchemist>, [">= 0.1.2"])
+      s.add_dependency(%q<numerizer>, [">= 0.1.1"])
+      s.add_dependency(%q<jeremymcanally-context>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<alchemist>, [">= 0.1.2"])
+    s.add_dependency(%q<numerizer>, [">= 0.1.1"])
+    s.add_dependency(%q<jeremymcanally-context>, [">= 0"])
+  end
+end

data/lib/herbalist/herbalist.rb

@@ -0,0 +1,159 @@
+module Herbalist
+  # collect up all the possible unit types that Alchemist can handle
+  POSSIBLE_UNITS = Alchemist.conversion_table.collect{|k,v| v.keys}.flatten.uniq
+  MULTIWORD_UNITS = POSSIBLE_UNITS.collect{|u| u.to_s}.grep(/_/)
+  
+  class << self
+    def parse(text)
+      text = text.dup
+      puts "TEXT: #{text}" if Herbalist.debug
+      @tokens = self.tokenize(text).select { |token| token.tagged? }
+      puts "TOKENS: #{@tokens}" if Herbalist.debug
+      
+      return nil unless @tokens.length>1
+      
+      # at the moment all we handle is a number followed by a unit
+      last_number = nil
+      result = nil
+      @tokens.each do |token|
+        if last_number && (unit=token.get_tag(:unit))
+          result = last_number.send(unit.value)
+          break
+        elsif (num=token.get_tag(:number))
+          last_number = num.value
+        end
+      end
+      
+      return result
+    end
+    
+    def tokenize(text)
+      # cleanup the string before tokenizing
+      text = normalize(text)
+      @tokens = text.split(' ').collect { |word| Token.new(word) }
+      @tokens = Tag.scan(@tokens)
+    end
+    
+    private
+    def normalize(text)
+      # use Numerizer to convert any numbers in words to digets in the string
+      text = Numerizer.numerize(text)
+      puts "NUMERIZED: #{text}" if Herbalist.debug
+      
+      text = evaluate_fractions(text)
+      puts "FRACTIONED: #{text}" if Herbalist.debug
+      
+      text = normalize_multiword(text)
+      puts "MULTIWORDED: #{text}" if Herbalist.debug
+      return text
+    end
+    
+    # takes fractions in the string (1/4) and converts them to floats (0.25)
+    def evaluate_fractions(text)
+      text.gsub(/(\d+)\/(\d+)/) { ($1.to_f/$2.to_f).to_s }
+    end
+    
+    def normalize_multiword(text)
+      MULTIWORD_UNITS.each do |unit|
+        text = text.gsub(/#{unit.split('_').join(' ')}/i, unit)
+      end
+      text
+    end
+  end
+  
+  # based on the Token class found in Chronic
+  class Token
+     attr_accessor :word, :tags
+
+    def initialize(word)
+      @word = word
+      @tags = []
+    end
+
+    # Tag this token with the specified tag
+    def tag(new_tag)
+      @tags << new_tag
+    end
+
+    # Remove all tags of the given class
+    def untag(tag_type)
+      @tags = @tags.select { |m| m.type!=tag_type }
+    end
+
+    # Return true if this token has any tags
+    def tagged?
+      @tags.size > 0
+    end
+
+    # Return the Tag that matches the given class
+    def get_tag(tag_type)
+      matches = @tags.select { |m| m.type==tag_type }
+      return matches.first
+    end
+
+    # Print this Token in a pretty way
+    def to_s
+      "#{@word}(#{@tags.join(', ')})"
+    end
+  end
+  
+  
+  class Tag
+    attr_accessor :value, :type
+
+		def initialize(type, value)
+		  @type = type
+			@value = value
+		end
+		
+		# scan the given tokens and tag any matches
+		def self.scan(tokens)
+		  tokens.each do |token|
+		    if t = self.scan_for_numbers(token) then token.tag(t) end
+		    if t = self.scan_for_units(token) then token.tag(t) end
+	    end
+		  tokens
+	  end
+	  
+	  # check the token to see if if it is a number
+	  # then tag it
+	  def self.scan_for_numbers(token)
+	    if token.word =~ /(^|\W)(\d*\.\d+)($|\W)/ || token.word =~ /(^|\W)(\d+)($|\W)/
+	      return Tag.new(:number, $2.to_f)
+      end
+      return nil
+    end
+    
+    # check the token and see if it is a type of unit that Alchemist can handle
+    # then tag the token with that unit type
+    def self.scan_for_units(token)
+      return nil if token.get_tag(:number)
+      # all units
+      POSSIBLE_UNITS.each do |unit| 
+        if token.word.length<=2 # special matching for short forms ex. Mi
+          return Tag.new(:unit, unit) if token.word == unit.to_s
+        elsif token.word =~ /(^|\W)#{unit.to_s}($|\W)/i
+          return Tag.new(:unit, unit)
+        end
+      end
+      
+      # try si units with prefixes (kilo, deca etc)
+      Alchemist.unit_prefixes.each do |prefix, value|
+        if token.word =~ /^#{prefix.to_s}.+/i
+          Alchemist.si_units.each do |unit|
+            if unit.to_s=~/#{token.word.gsub(/^#{prefix.to_s}/i,'')}$/i
+              return Tag.new(:unit, "#{prefix}#{unit}") 
+            end
+          end
+        end
+      end
+
+      return nil
+    end
+    
+    def to_s
+      "#{type}-#{value}"
+    end
+  end
+
+end

data/lib/herbalist.rb

@@ -0,0 +1,22 @@
+require 'numerizer'
+require 'alchemist'
+
+require 'herbalist/herbalist'
+
+# reopen Alchemist and create an accessor for si_units
+# hopefully a future patch will mean we can remove this
+unless Alchemist.respond_to?(:si_units)
+  module Alchemist
+    def self.si_units
+      @@si_units
+    end
+  end
+end
+
+module Herbalist
+  class << self
+    attr_accessor :debug
+  end
+  
+  self.debug = false
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'context'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'herbalist'
+
+class Test::Unit::TestCase
+end

data/test/test_herbalist.rb

@@ -0,0 +1,81 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class HerbalistTest < Test::Unit::TestCase
+  # Herbalist.debug=true
+  
+  should "parse number of cups" do
+    assert_equal 1.cup, Herbalist.parse('1 cup')
+    assert_equal 2.cups, Herbalist.parse('2 cups')
+    assert_equal 2.5.cups, Herbalist.parse('2.5 cups')
+  end
+  
+  should "parse number of meters" do
+    assert_equal 1.meter, Herbalist.parse('1 meter')
+    assert_equal 2.meters, Herbalist.parse('2 meters')
+    assert_equal 2.5.meters, Herbalist.parse('2.5 meters')
+  end
+  
+  should "parse number of kilometers" do
+    assert_equal 1.kilometer, Herbalist.parse('1 kilometer')
+    assert_equal 2.kilometers, Herbalist.parse('2 kilometers')
+    assert_equal 2.5.kilometers, Herbalist.parse('2.5 kilometers')
+  end
+  
+  should "parse mixed case units" do
+    assert_equal 1.kilometer, Herbalist.parse('1 Kilometer')
+    assert_equal 2.kilometers, Herbalist.parse('2 KiloMeters')
+    assert_equal 2.5.miles, Herbalist.parse('2.5 Miles')
+  end
+  
+  should "parse numbers in words" do
+    assert_equal 1.kilometer, Herbalist.parse('one Kilometer')
+    assert_equal 15.kilometers, Herbalist.parse('fifteen Kilometers')
+    assert_equal 21.5.miles, Herbalist.parse('twenty-one and a half Miles')
+  end
+  
+  should "parse fractions in words" do
+    assert_equal 0.25.cup, Herbalist.parse('a quarter cup')
+    assert_equal 0.5.teaspoon, Herbalist.parse('a half teaspoon')
+    assert_equal 1.25.liters, Herbalist.parse('one and a quarter liters')
+  end
+  
+  should "parse multiword units" do
+    assert_equal 1.cubic_meter, Herbalist.parse('one Cubic Meter')
+    assert_equal 15.kilowatt_hours, Herbalist.parse('fifteen kilowatt Hours')
+    assert_equal 21.5.tropical_years, Herbalist.parse('21.5 tropical years')
+  end
+  
+  should "parse units from within a string of other text" do
+    assert_equal 1.cup, Herbalist.parse("1 Cup onion chopped")
+    assert_equal 1.25.ounces, Herbalist.parse("1 Package (1.25 ounces) taco seasoning mix")
+    assert_equal 16.ounces, Herbalist.parse("1 Can (16 ounces) tomatoes, undrained")
+    assert_equal 6.cups, Herbalist.parse("and 6 Cups turkey broth")
+    
+    assert_equal 2.5.football_fields, Herbalist.parse("it was two and a half football fields")
+    assert_equal 15.meters, Herbalist.parse("John ran 15 meters")
+  end
+  
+  should "not match can to ccandela units" do
+    assert_equal nil, Herbalist.parse("1 Can")
+  end
+  
+  should "ignore units of measure that alchemist does not understand" do
+    assert_equal nil, Herbalist.parse('2 awesomes')
+  end
+  
+  # add tests for all units Alchemist can handle
+  Alchemist.conversion_table.collect{|k,v| v.keys}.flatten.uniq.each do |unit|
+    should "parse #{unit}" do
+      assert_equal 1.send(unit), Herbalist.parse("1 #{unit}")
+      assert_equal 2.5.send(unit), Herbalist.parse("2.5 #{unit}")
+    end
+    
+    # tests for all multi word units
+    if (words = unit.to_s.split('_')).length > 1
+      should "parse multiword unit '#{words.join(' ')}'" do
+        assert_equal 1.send(unit), Herbalist.parse("1 #{words.join(' ')}")
+        assert_equal 2.5.send(unit), Herbalist.parse("2.5 #{words.join(' ')}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: herbalist
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- jduff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: alchemist
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: numerizer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeremymcanally-context
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Herbalist is a natural language measurements parser. It is built on top of the Alchemist[http://github.com/toastyapps/alchemist] gem and draws heavily from the Chronic[http://github.com/evaryont/chronic].
+email: duff.john@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- herbalist.gemspec
+- lib/herbalist.rb
+- lib/herbalist/herbalist.rb
+- test/test_helper.rb
+- test/test_herbalist.rb
+has_rdoc: true
+homepage: http://github.com/jduff/herbalist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Herbalist is a natural language measurements parser.
+test_files: 
+- test/test_helper.rb
+- test/test_herbalist.rb