weather.rb in attack-barometer-0.5.0

- old
+ new

@@ -1,41 +1,46 @@
 module Barometer
-  
+  #
+  # Weather
+  #
+  # holds all the measurements taken and provdes
+  # methods to interact with the data
+  #
   class Weather
     
-    # hash of measurements indexed by :source
     attr_accessor :measurements
     
-    def initialize
-      @measurements = []
-    end
+    def initialize; @measurements = []; end
     
-    # the default source is the first source/measurement that we
-    # have successful results for
+    # the default measurement is the first successful measurement
+    #
     def default
       return nil unless self.sources
       self.source(self.sources.first)
     end
     
     # find the measurement for the given source, if it exists
+    #
     def source(source)
       raise ArgumentError unless (source.is_a?(String) || source.is_a?(Symbol))
       @measurements.each do |measurement|
         return measurement if measurement.source == source.to_sym
       end
       nil
     end
     
     # list successful sources
+    #
     def sources
       @measurements.collect {|m| m.source.to_sym if m.success?}.compact
     end
     
     #
     # Quick access methods
     #
     
+    def metric?; self.default ? self.default.metric? : true; end
     def current; (default = self.default) ? default.current : nil; end
     def forecast; (default = self.default) ? default.forecast : nil; end
     def now; self.current; end
     
     def today
@@ -46,15 +51,20 @@
     def tomorrow
       default = self.default
       default && default.forecast ? default.forecast[1] : nil
     end
     
+    # measurement search
+    # this will search the default measurements forecasts looking for
+    # the matching date
+    #
     def for(query)
       default = self.default
       default && default.forecast ? default.for(query) : nil
     end
     
+    
     #
     # helper methods
     #
     # these are handy methods that can average values for successful weather
     # sources, or answer a simple question (ie: weather.windy?)
@@ -62,32 +72,37 @@
     
     #
     # averages
     #
     
-    def metric?
-      self.default ? self.default.metric? : true
-    end
-    
     # this assumes calculating for current, and that "to_f" for a value
     # will return the value needed
     # value_name = the name of the value we are averaging
+    # if a measurement has weighting, it will respect that
+    #
     def current_average(value_name)
       values = []
       @measurements.each do |measurement|
-        values << measurement.current.send(value_name).to_f if measurement.success? &&
-          measurement.current.send(value_name)
+        if measurement.weight && measurement.weight > 1
+          measurement.weight.times do
+            values << measurement.current.send(value_name).to_f if measurement.success? &&
+              measurement.current.send(value_name)
+          end
+        else
+          values << measurement.current.send(value_name).to_f if measurement.success? &&
+            measurement.current.send(value_name)
+        end
       end
       values.compact!
       return nil unless values && values.size > 0
       values.inject(0.0) { |sum,v| sum += v if v } / values.size
     end
     
     def average(value_name, do_average=true, class_name=nil)
       if class_name
         if do_average
-          avg = Barometer.const_get(class_name).new(self.metric?)
+          avg = Data.const_get(class_name).new(self.metric?)
           avg << self.current_average(value_name)
         else
           avg = self.now.send(value_name)
         end
       else
@@ -95,10 +110,11 @@
       end
       avg
     end
       
     # average of all values
+    #
     def humidity(do_average=true); average("humidity",do_average); end
     def temperature(do_average=true); average("temperature",do_average,"Temperature"); end
     def wind(do_average=true); average("wind",do_average,"Speed"); end
     def pressure(do_average=true); average("pressure",do_average,"Pressure"); end
     def dew_point(do_average=true); average("dew_point",do_average,"Temperature"); end
@@ -121,64 +137,69 @@
     #
     # simple questions
     # pass the question on to each successful measurement until we get an answer
     #
     
-    def windy?(threshold=10, utc_time=Time.now.utc)
+    def windy?(threshold=10, time_string=nil)
+      local_datetime = Data::LocalDateTime.parse(time_string)
       raise ArgumentError unless (threshold.is_a?(Fixnum) || threshold.is_a?(Float))
-      raise ArgumentError unless utc_time.is_a?(Time)
+      raise ArgumentError unless (local_datetime.nil? || local_datetime.is_a?(Data::LocalDateTime))
       
       is_windy = nil
       @measurements.each do |measurement|
         if measurement.success?
-          is_windy = measurement.windy?(threshold, utc_time)
+          is_windy = measurement.windy?(threshold, local_datetime)
           return is_windy if !is_windy.nil?
         end
       end
       is_windy
     end
 
-    def wet?(threshold=50, utc_time=Time.now.utc)
+    def wet?(threshold=50, time_string=nil)
+      local_datetime = Data::LocalDateTime.parse(time_string)
       raise ArgumentError unless (threshold.is_a?(Fixnum) || threshold.is_a?(Float))
-      raise ArgumentError unless utc_time.is_a?(Time)
+      raise ArgumentError unless (local_datetime.nil? || local_datetime.is_a?(Data::LocalDateTime))
       
       is_wet = nil
       @measurements.each do |measurement|
         if measurement.success?
-          is_wet = measurement.wet?(threshold, utc_time)
+          is_wet = measurement.wet?(threshold, local_datetime)
           return is_wet if !is_wet.nil?
         end
       end
       is_wet
     end
 
-    def day?(utc_time=Time.now.utc)
-      raise ArgumentError unless utc_time.is_a?(Time)
+    def day?(time_string=nil)
+      local_datetime = Data::LocalDateTime.parse(time_string)
+      raise ArgumentError unless (local_datetime.nil? || local_datetime.is_a?(Data::LocalDateTime))
       
       is_day = nil
       @measurements.each do |measurement|
         if measurement.success?
-          is_day = measurement.day?(utc_time)
+          is_day = measurement.day?(local_datetime)
           return is_day if !is_day.nil?
         end
       end
       is_day
     end
 
-    def night?(utc_time=Time.now.utc)
-      raise ArgumentError unless utc_time.is_a?(Time)
-      is_day = self.day?(utc_time)
+    def night?(time_string=nil)
+      local_datetime = Data::LocalDateTime.parse(time_string)
+      raise ArgumentError unless (local_datetime.nil? || local_datetime.is_a?(Data::LocalDateTime))
+      is_day = self.day?(local_datetime)
       is_day.nil? ? nil : !is_day
     end
 
-    def sunny?(utc_time=Time.now.utc)
-      raise ArgumentError unless utc_time.is_a?(Time)
+    def sunny?(time_string=nil)
+      local_datetime = Data::LocalDateTime.parse(time_string)
+      raise ArgumentError unless (local_datetime.nil? || local_datetime.is_a?(Data::LocalDateTime))
       
       is_sunny = nil
       @measurements.each do |measurement|
         if measurement.success?
-          return false if self.day?(utc_time) == false
-          is_sunny = measurement.sunny?(utc_time)
+          return false if self.day?(local_datetime) == false
+          is_sunny = measurement.sunny?(local_datetime)
           return is_sunny if !is_sunny.nil?
         end
       end
       is_sunny
     end
\ No newline at end of file