nickel 0.0.3 → 0.0.4

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Louis Zell <lzell11@gmail.com>
+Copyright (c) 2009-2011 Lou Zell, lzell11@gmail.com, http://hazelmade.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
@@ -16,4 +16,4 @@ 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.
+THE SOFTWARE.

data/README.rdoc

@@ -1,4 +1,5 @@
-=== Nickel is a client for Natural Inputs
+=== Nickel extracts date, time, and message information from naturally worded text.
+
 === Install
   
   gem install nickel
@@ -6,19 +7,18 @@
 === Usage
 
 ==== A single occurrence
-  n = Nickel.query "lunch tomorrow with maria"
-  n.message                       # => lunch with maria
-  n.occurrences[0].type           # => single
-  n.occurrences[0].start_date     # => 20090323
+  n = Nickel.parse("use the force on july 1st at 9am", Time.now)
+  n.message                       #=> "use the force"
+  n.occurrences.first.start_date  #=> "20110701"
 
 ==== A daily occurrence
-  n = Nickel.query "wake up everyday at 11am"
+  n = Nickel.parse "wake up everyday at 11am"
   n.message                       # => wake up
   n.occurrences[0].type           # => daily
   n.occurrences[0].start_time     # => 11:00:00
   
 ==== A weekly occurrence
-  n = Nickel.query "guitar lessons every tuesday at 5pm"
+  n = Nickel.parse "guitar lessons every tuesday at 5pm"
   n.message                       # => guitar lessons
   n.occurrences[0].type           # => weekly
   n.occurrences[0].day_of_week    # => tue
@@ -26,7 +26,7 @@
   n.occurrences[0].start_time     # => 17:00:00
 
 ==== A day monthly occurrence
-  n = Nickel.query "drink specials on the second thursday of every month"
+  n = Nickel.parse "drink specials on the second thursday of every month"
   n.message                       # => drink specials
   n.occurrences[0].type           # => daymonthly
   n.occurrences[0].day_of_week    # => thu
@@ -34,14 +34,14 @@
   n.occurrences[0].interval       # => 1
   
 ==== A date monthly occurrence
-  n = Nickel.query "pay credit card every month on the 22nd"
+  n = Nickel.parse "pay credit card every month on the 22nd"
   n.message                       # => pay credit card
   n.occurrences[0].type           # => datemonthly
   n.occurrences[0].date_of_month  # => 22
   n.occurrences[0].interval       # => 1
 
 ==== Multiple occurrences
-  n = Nickel.query "band meeting every monday and wednesday at 2pm"
+  n = Nickel.parse "band meeting every monday and wednesday at 2pm"
   n.message                       # => band meeting
   n.occurrences[0].type           # => weekly
   n.occurrences[0].day_of_week    # => mon
@@ -52,6 +52,18 @@
 
 ==== Setting current time
 
-  n = Nickel.query "lunch 3 days from now", DateTime.new(2010,3,31)
+  n = Nickel.parse "lunch 3 days from now", DateTime.new(2010,3,31)
   n.message                       # => lunch
-  n.occurrences[0].start_date     # => 20100403
+  n.occurrences[0].start_date     # => 20100403
+
+
+Running Tests
+=======
+$ rake test
+
+If you do not have RUBYOPT set: 
+$ RUBYOPT='rubygems' rake test
+
+
+Copyright (c) 2008-2011 Lou Zell, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the nlp plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the nlp plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Nlp'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/nickel/construct.rb

@@ -0,0 +1,121 @@
+# Ruby Nickel Library 
+# Copyright (c) 2008-2011 Lou Zell, lzell11@gmail.com, http://hazelmade.com
+# MIT License [http://www.opensource.org/licenses/mit-license.php]
+
+module Nickel
+
+  class Construct
+    include InstanceFromHash
+    attr_accessor :comp_start, :comp_end, :found_in
+  end
+
+  class DateConstruct < Construct
+    attr_accessor :date
+    def interpret
+      {:date => @date}
+    end
+  end
+
+  class DateSpanConstruct < Construct
+    attr_accessor :start_date, :end_date
+  end
+
+  class TimeConstruct < Construct
+    attr_accessor :time
+    def interpret
+      {:time => @time}
+    end
+  end
+
+  class TimeSpanConstruct < Construct
+    attr_accessor :start_time, :end_time
+  end
+
+  class WrapperConstruct < Construct
+    attr_accessor :wrapper_type, :wrapper_length
+  end
+
+  class RecurrenceConstruct < Construct
+    attr_accessor :repeats, :repeats_on
+    
+    def interpret
+      if    variant_of?(:daily)       then interpret_daily_variant
+      elsif variant_of?(:weekly)      then interpret_weekly_variant
+      elsif variant_of?(:daymonthly)  then interpret_daymonthly_variant
+      elsif variant_of?(:datemonthly) then interpret_datemonthly_variant
+      else
+        puts @repeats.inspect
+        raise StandardError.new("self is an invalid variant, check value of self.repeats or @repeats")
+      end
+    end
+    
+    def get_interval
+      if    has_interval_of?(1)  then 1
+      elsif has_interval_of?(2)  then 2
+      elsif has_interval_of?(3)  then 3
+      else
+        raise StandardError.new("self.repeats is invalid!!")
+      end
+    end
+
+    private
+    def has_interval_of?(x)
+      case x
+      when 1 then [:daily, :weekly, :daymonthly, :datemonthly].include?(@repeats)
+      when 2 then [:altdaily, :altweekly, :altdaymonthly, :altdatemonthly].include?(@repeats)
+      when 3 then [:threedaily, :threeweekly, :threedaymonthly, :threedatemonthly].include?(@repeats)
+      end
+    end
+
+    def variant_of?(sym)
+      case sym
+      when :daily       then [:daily, :altdaily, :threedaily].include?(@repeats)
+      when :weekly      then [:weekly, :altweekly, :threeweekly].include?(@repeats)
+      when :daymonthly  then [:daymonthly, :altdaymonthly, :threedaymonthly].include?(@repeats)
+      when :datemonthly then [:datemonthly, :altdatemonthly, :threedatemonthly].include?(@repeats)
+      end
+    end
+
+    def interpret_daily_variant
+      hash_for_occ_base = {:type => :daily, :interval => get_interval}
+      [hash_for_occ_base]
+    end
+
+    # @repeats_on is an array of day indices. For example,
+    # "every monday and wed" will produce @repeats_on == [0,2].
+    def interpret_weekly_variant
+      hash_for_occ_base = {:type => :weekly, :interval => get_interval}
+      array_of_occurrences = []
+      @repeats_on.each do |day_of_week|
+        array_of_occurrences << hash_for_occ_base.merge({:day_of_week => day_of_week})
+      end
+      array_of_occurrences
+    end
+
+    # @repeats_on is an array of arrays: Each sub array has the format
+    # [week_of_month, day_of_week].  For example, 
+    # "the first and second sat of every month" will produce
+    # @repeats_on == [[1,5], [2,5]]
+    def interpret_daymonthly_variant
+      hash_for_occ_base = {:type => :daymonthly, :interval => get_interval}
+      array_of_occurrences = []
+      @repeats_on.each do |on|
+        h = {:week_of_month => on[0], :day_of_week => on[1]}
+        array_of_occurrences << hash_for_occ_base.merge(h)
+      end
+      array_of_occurrences
+    end
+
+    # @repeats_on is an array of datemonthly indices.  For example, 
+    # "the 21st and 22nd of every monthy" will produce @repeats_on == [21, 22]
+    def interpret_datemonthly_variant
+      hash_for_occ_base = {:type => :datemonthly, :interval => get_interval}
+      array_of_occurrences = []
+      @repeats_on.each do |date_of_month|
+        h = {:date_of_month => date_of_month}
+        array_of_occurrences << hash_for_occ_base.merge(h)
+      end
+      array_of_occurrences
+    end
+  end
+end