freq 0.1.0

data/.autotest

@@ -0,0 +1,10 @@
+module Autotest::CustomTestMatch
+  Autotest.add_hook :initialize do |at|
+    at.add_mapping(/test/) do |f, _|
+      at.files_matching(/_test\.rb$/)
+    end
+    at.add_mapping(/lib\/.*/) do |f, _|
+      at.files_matching(/_test\.rb$/)
+    end
+  end
+end

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README.rdoc

@@ -0,0 +1,3 @@
+= Freq
+
+A library for parsing and using natural language frequency descriptions.

data/README.textile

@@ -0,0 +1,3 @@
+h1. Freq
+
+A library for parsing and using natural language frequency descriptions.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run tests.'
+task :default => [:test]
+
+desc 'Run tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Freq'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "freq"
+    gemspec.summary = "Freq provides parsing of strings describing periodically occurring events."
+    gemspec.email = "anthonyeden@gmail.com"
+    gemspec.homepage = "http://github.com/aeden/freq"
+    gemspec.description = "Freq provides parsing of strings describing periodically occurring events."
+    gemspec.authors = ["Anthony Eden"]
+    gemspec.files.exclude 'docs/**/*'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

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

data/lib/freq.rb

@@ -0,0 +1,97 @@
+# Class that defines a frequency for a recurring thing.
+#
+# Note: this class does not properly handle months and years.
+class Freq
+  
+  SECOND = 1 unless defined? SECOND
+  MINUTE = SECOND * 60 unless defined? MINUTE
+  HOUR = MINUTE * 60 unless defined? HOUR
+  DAY = HOUR * 24 unless defined? DAY
+  WEEK = DAY * 7 unless defined? WEEK
+  
+  MONTH = DAY * 30 unless defined? MONTH
+  YEAR = DAY * 365 unless defined? YEAR
+  
+  attr_accessor :period
+  attr_accessor :times
+  
+  def initialize(period, times)
+    @period = period
+    @times = times
+  end
+  
+  def to_seconds
+    return 0 if times == 0 || period == 0
+    period / times
+  end
+  
+  # Apply the frequency to the given timestamp to get the next occurrence.
+  def next(t)
+    Time.at(t + to_seconds)
+  end
+  
+  def self.parse(str)
+    times = 1
+    period = 0
+    multiplier = 1
+    
+    words = str.downcase.split
+    words.each_with_index do |word, i|
+      case word
+      when 'every'
+        if words[i+1] == 'other'
+          multiplier = 2
+        end
+        if words[i+1] =~ /\d+/
+          multiplier = words[i+1].to_i
+        end
+      when 'twice' then times = 2
+      when /times?/
+        times = word_to_number(words[i-1])
+      when /seconds?/ then period = SECOND
+      when /minutes?/ then period = MINUTE
+      when /hours?/ then period = HOUR
+      when /days?/ then period = DAY
+      when /weeks?/ then period = WEEK
+      when /months?/ then period = MONTH
+      when /years?/ then period = YEAR
+      end
+    end
+    
+    new(period * multiplier, times)
+  end
+  
+  def self.word_to_number(word)
+    if n = word.to_i
+      if n == 0
+        return 0 if word == '0' || word == 'zero'
+      else
+        return n
+      end
+    end
+    
+    irregular = {
+      '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
+    }
+    return irregular[word] if irregular[word]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/freq'

data/test/unit/freq_test.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class FreqTest < Test::Unit::TestCase
+  context "a frequency" do
+    context "when parsed as a string" do
+      should "construct the correct frequency" do
+        expectations.each do |s, expect|
+          assert_equal expect, Freq.parse(s).to_seconds
+        end
+      end
+    end
+    context "next" do
+      should "return the correct Time value" do
+        expectations.each do |s, expect|
+          t = Time.now
+          assert_equal t + expect, Freq.parse(s).next(t)
+        end
+      end
+    end
+  end
+  
+  def expectations
+    {
+      'every second' => Freq::SECOND,
+      'once a second' => Freq::SECOND,
+      'every minute' => Freq::MINUTE,
+      'once a minute' => Freq::MINUTE,
+      'every hour' => Freq::HOUR,
+      'once an hour' => Freq::HOUR,
+      'every day' => Freq::DAY,
+      'once a day' => Freq::DAY,
+      'every week' => Freq::WEEK,
+      'once a week' => Freq::WEEK,
+      'every month' => Freq::MONTH,
+      'once a month' => Freq::MONTH,
+      'every year' => Freq::YEAR,
+      'once a year' => Freq::YEAR,
+      
+      'every other second' => Freq::SECOND * 2,
+      'every other minute' => Freq::MINUTE * 2,
+      'every other hour' => Freq::HOUR * 2,
+      'every other day' => Freq::DAY * 2,
+      'every other week' => Freq::WEEK * 2,
+      
+      'every 2 seconds' => Freq::SECOND * 2,
+      'every 10 seconds' => Freq::SECOND * 10,
+      'every 2 minutes' => Freq::MINUTE * 2,
+      'every 10 minutes' => Freq::MINUTE * 10,
+      'every 2 hours' => Freq::HOUR * 2,
+      'every 10 hours' => Freq::HOUR * 10,
+      'every 2 days' => Freq::DAY * 2,
+      'every 10 days' => Freq::DAY * 10,
+      'every 2 weeks' => Freq::WEEK * 2,
+      'every 10 weeks' => Freq::WEEK * 10,
+      
+      'once every 2 seconds' => Freq::SECOND * 2,
+      'twice every 2 seconds' => Freq::SECOND * 1,
+      
+      '1 time every 2 seconds' => Freq::SECOND * 2,
+      '1 time every second' => Freq::SECOND * 1,
+      '10 times every minute' => Freq::SECOND * 6,
+      '5 times every other day' => Freq::DAY / 5 * 2,
+      
+      'twice a minute' => Freq::MINUTE / 2,
+      '4 times a minute' => Freq::MINUTE / 4,
+      'four times a minute' => Freq::MINUTE / 4,
+      'ten times per minute' => Freq::MINUTE / 10,
+      'twice an hour' => Freq::HOUR / 2,
+      '4 times an hour' => Freq::HOUR / 4,
+      'four times an hour' => Freq::HOUR / 4,
+      'ten times per hour' => Freq::HOUR / 10,
+      'twice a day' => Freq::DAY / 2,
+      '4 times a day' => Freq::DAY / 4,
+      'four times a day' => Freq::DAY / 4,
+      'ten times per day' => Freq::DAY / 10,
+      'twice a week' => Freq::WEEK / 2,
+      '4 times a week' => Freq::WEEK / 4,
+      'four times a week' => Freq::WEEK / 4,
+      'ten times per week' => Freq::WEEK / 10,
+    }
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: freq
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anthony Eden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-20 00:00:00 -10:00
+default_executable: 
+dependencies: []
+
+description: Freq provides parsing of strings describing periodically occurring events.
+email: anthonyeden@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- README.textile
+files: 
+- .autotest
+- .gitignore
+- README.rdoc
+- README.textile
+- Rakefile
+- VERSION
+- lib/freq.rb
+- test/test_helper.rb
+- test/unit/freq_test.rb
+has_rdoc: true
+homepage: http://github.com/aeden/freq
+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: Freq provides parsing of strings describing periodically occurring events.
+test_files: 
+- test/test_helper.rb
+- test/unit/freq_test.rb