numerouno 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+== 0.0.1 2009-05-07
+
+* 1 major enhancement:
+  * Initial release
+  * mmmm...has that new gem smell

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/numerouno.rb
+lib/numerouno-parsing.rb
+lib/numerouno/combiner.rb
+lib/numerouno/parser.rb
+lib/numerouno/search.rb
+script/console
+script/destroy
+script/generate
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,72 @@
+= Numerouno
+
+* http://github.com/brentsnook/numerouno
+
+English natural language parser for numbers.
+
+* Parse 'five' to return 5
+* Parse 'seven hundred and fifty two billion, four hundred and twenty million, sixty thousand and forty two' to return 752,420,060,042
+* Parse 'siebenundzwanzig' to have it fail because it doesn't recognise German.
+
+Recognises numbers in the trillions.
+
+== Installation
+
+Whoah, hang on there. Not up on Rubyforge yet but hopefully soon. When it is:
+
+  sudo gem install numerouno
+
+=== Building the Gem yourself
+
+Grab the code from github:
+
+  git clone git://github.com/brentsnook/numerouno.git
+  cd numerouno
+  rake install_gem
+
+== Use
+
+Just require numerouno to add magical number parsing powers to your strings:
+
+  require 'numerouno'
+  'sixty five'.as_number
+
+Or if you're a sook who doesn't like the idea of String being opened up:
+
+  require 'numerouno-parsing'
+  Numerouno.parse 'sixty five'
+
+== How does it all work?
+
+The English language has explicit rules for expressing numbers. Numeruno attempts to recognise strings based on these rules.
+
+Check out http://wiki.github.com/brentsnook/numerouno for details.
+
+== What is it good for?
+
+The main serving suggestion is to toss it with Chronic[http://chronic.rubyforge.org/] and Cucumber[http://cukes.info/] for an even tastier BDD salad.
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Brent Snook http://fuglylogic.com
+
+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/Rakefile

@@ -0,0 +1,26 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/numerouno'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('numerouno', Numerouno::VERSION) do |p|
+  p.developer 'Brent Snook', 'brent@fuglylogic.com'
+  p.summary = %q{English natural language parser for numbers.}
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name = p.name
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['rspec', '>= 1.2.4'],
+    ['cucumber', '>= 0.3.1']
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec, :features]

data/lib/numerouno/combiner.rb

@@ -0,0 +1,65 @@
+module Numerouno
+
+  module CombinerMethods
+    
+    def combine numbers
+      Combiner.new numbers  
+    end
+      
+  end  
+
+  class Combiner
+    
+    def of_power power
+      @power = power
+      self  
+    end
+      
+    def apply!
+      @numbers.each_with_index do |number, index|
+        @current = index
+        if number_is_correct_power?
+          apply :*, to_left if should_multiply?
+          apply :+, to_right if should_add?
+        end 
+      end
+      
+      @numbers.compact!
+    end
+    
+    private
+
+    def initialize numbers
+      @numbers = numbers
+    end
+       
+    def should_multiply?
+      @current > 0 and @power > 10
+    end 
+    
+    def should_add?
+      @current < (@numbers.length - 1) and number > @numbers[to_right]
+    end 
+    
+    def apply operation, index
+      @numbers[@current] = number.send operation, @numbers[index]
+      @numbers[index] = nil
+    end
+    
+    def to_left
+      @current - 1
+    end  
+    
+    def to_right
+      @current + 1
+    end
+    
+    def number_is_correct_power?
+      number and (number % @power == 0) and number < (@power * 10)
+    end 
+    
+    def number
+      @numbers[@current]
+    end   
+  end
+end

data/lib/numerouno/parser.rb

@@ -0,0 +1,25 @@
+module Numerouno  
+  module Parser
+    
+    extend CombinerMethods
+    extend SearchMethods
+    
+    def self.number_from string
+      numbers = numbers_within string 
+      numbers.empty? ? raise(NoNumberFoundError, "No number found in string: #{string}") :
+        total(numbers)
+    end
+  
+    private
+  
+    def self.total numbers
+      [10, 100, 1000, 1000000, 1000000000, 1000000000000].each do |power|
+        combine(numbers).of_power(power).apply!
+      end
+      numbers.inject(0){|sum, add| sum + add}
+    end  
+
+  end
+
+  class NoNumberFoundError < StandardError; end
+end

data/lib/numerouno/search.rb

@@ -0,0 +1,94 @@
+module Numerouno
+  
+  module SearchMethods
+    
+    def numbers_within string
+      Search.new(string).find_all
+    end
+    
+  end  
+  
+  class Search
+
+    # the mapping between number strings and numbers needs to be ordered
+    # this is to avoid the wrong mapping being picked up
+    # i.e /seven/ would match 'seventy' before /seventy/ 
+    NUMBER_STRINGS = [
+      ['sixty', 60],
+      ['seventy', 70],
+      ['eighty', 80],
+      ['ninety', 90],
+      ['fourteen', 14],
+      ['sixteen', 16],
+      ['seventeen', 17],
+      ['eighteen', 18],
+      ['nineteen', 19],
+        
+      ['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],
+      ['fifteen', 15],
+      ['twenty', 20],
+      ['thirty', 30],
+      ['forty', 40],
+      ['fifty', 50],
+      
+      ['hundred', 100],
+      ['thousand', 1000],
+      ['million', 1000000],
+      ['billion', 1000000000],
+      ['trillion', 1000000000000]
+    ]
+    
+    NUMBER_LOOKUP = NUMBER_STRINGS.inject(Hash.new) do |hash, map|
+      hash[map[0]] = map[1]
+      hash
+    end
+    
+    def initialize string
+      @string = string
+      @numbers = []
+    end  
+    
+    def find_all
+      search until string_exhausted?
+      @numbers.compact
+    end
+    
+    private
+    
+    def search
+      if match = next_match
+        @string = string_without match
+        @numbers[match.pre_match.length] = NUMBER_LOOKUP[match.to_s]
+      else
+        @string = ''
+      end
+    end
+    
+    def string_without match
+      match.pre_match + (' ' * match.to_s.length) + match.post_match
+    end  
+    
+    def next_match
+      NUMBER_STRINGS.collect do |number_string, number|
+        @string.match number_string
+      end.compact.first
+    end
+    
+    def string_exhausted?
+      @string.sub(' ', '').empty?
+    end  
+  end
+end  

data/lib/numerouno-parsing.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+[
+  'combiner',
+  'search',
+  'parser'
+].each {|file| require "numerouno/#{file}"}
+
+module Numerouno
+  VERSION = '0.0.1'
+  
+  def self.parse string
+    Parser.number_from string
+  end  
+end

data/lib/numerouno.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), 'numerouno-parsing')
+
+module Numerouno
+
+  module StringExtensions
+  
+    def as_number
+      Numerouno.parse self
+    end
+  end
+     
+end
+
+String.send :include, Numerouno::StringExtensions

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/numerouno.rb'}"
+puts "Loading numerouno gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: numerouno
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brent Snook
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ""
+email: 
+- brent@fuglylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/numerouno.rb
+- lib/numerouno-parsing.rb
+- lib/numerouno/combiner.rb
+- lib/numerouno/parser.rb
+- lib/numerouno/search.rb
+- script/console
+- script/destroy
+- script/generate
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/brentsnook/numerouno
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: numerouno
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: English natural language parser for numbers.
+test_files: []
+