barometer 0.3.2 → 0.5.0

data/lib/barometer/data/night.rb

@@ -0,0 +1,69 @@
+require 'date'
+module Barometer
+  #
+  # Night Measurement
+  # a data class for forecasted night weather conditions
+  #
+  # This is basically a data holding class for the forecasted night 
+  # weather conditions.
+  #
+  class Data::NightMeasurement
+    
+    attr_reader :date, :icon, :condition
+    attr_reader :pop, :wind, :humidity
+    
+    # accessors (with input checking)
+    #
+    def date=(date)
+      raise ArgumentError unless date.is_a?(Date)
+      @date = date
+    end
+    
+    def icon=(icon)
+      raise ArgumentError unless icon.is_a?(String)
+      @icon = icon
+    end
+    
+    def condition=(condition)
+      raise ArgumentError unless condition.is_a?(String)
+      @condition = condition
+    end
+    
+    def pop=(pop)
+      raise ArgumentError unless pop.is_a?(Fixnum)
+      @pop = pop
+    end
+    
+    def wind=(wind)
+      raise ArgumentError unless wind.is_a?(Data::Speed)
+      @wind = wind
+    end
+    
+    def humidity=(humidity)
+      raise ArgumentError unless humidity.is_a?(Fixnum)
+      @humidity = humidity
+    end
+    
+    def sun=(sun)
+      raise ArgumentError unless sun.is_a?(Data::Sun)
+      @sun = sun
+    end
+    
+    #
+    # helpers
+    #
+    
+    # creates "?" helpers for all attributes (which maps to nil?)
+    #
+    def method_missing(method,*args)
+      # if the method ends in ?, then strip it off and see if we
+      # respond to the method without the ?
+      if (call_method = method.to_s.chomp!("?")) && respond_to?(call_method)
+        return send(call_method).nil? ? false : true
+      else
+        super(method,*args)
+      end
+    end
+    
+  end
+end

data/lib/barometer/data/pressure.rb

@@ -12,7 +12,7 @@ module Barometer
   #       that this class was designed for storing weather data,
   #       and it seems that it is more common in this case
   #
-  class Pressure < Barometer::Units
+  class Data::Pressure < Data::Units
     
     METRIC_UNITS = "mb"
     IMPERIAL_UNITS = "in"
@@ -48,6 +48,7 @@ module Barometer
     #
     
     # store millibars
+    #
     def mb=(mb)
       return if !mb || !(mb.is_a?(Integer) || mb.is_a?(Float))
       @millibars = mb.to_f
@@ -55,6 +56,7 @@ module Barometer
     end
     
     # store inches
+    #
     def in=(inches)
       return if !inches || !(inches.is_a?(Integer) || inches.is_a?(Float))
       @inches = inches.to_f
@@ -62,14 +64,16 @@ module Barometer
     end
     
     # return the stored millibars or convert from inches
+    #
     def mb(as_integer=true)
-      mb = (@millibars || Pressure.in_to_mb(@inches))
+      mb = (@millibars || Data::Pressure.in_to_mb(@inches))
       mb ? (as_integer ? mb.to_i : (100*mb).round/100.0) : nil
     end
     
     # return the stored inches or convert from millibars
+    #
     def in(as_integer=true)
-      inches = (@inches || Pressure.mb_to_in(@millibars))
+      inches = (@inches || Data::Pressure.mb_to_in(@millibars))
       inches ? (as_integer ? inches.to_i : (100*inches).round/100.0) : nil
     end
     
@@ -86,30 +90,35 @@ module Barometer
     #
     
     # will just return the value (no units)
+    #
     def to_i(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.mb : self.in
     end
     
     # will just return the value (no units) with more precision
+    #
     def to_f(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.mb(false) : self.in(false)
     end
     
     # will return the value with units
+    #
     def to_s(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? "#{self.mb} #{METRIC_UNITS}" : "#{self.in} #{IMPERIAL_UNITS}"
     end
     
     # will just return the units (no value)
+    #
     def units(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? METRIC_UNITS : IMPERIAL_UNITS
     end
     
     # when we set inches, it is possible the a non-equivalent value of
     # millibars remains.  if so, clear it.
+    #
     def update_millibars(inches)
       return unless @millibars
-      difference = Pressure.in_to_mb(inches.to_f) - @millibars
+      difference = Data::Pressure.in_to_mb(inches.to_f) - @millibars
       # only clear millibars if the stored millibars is off be more then 1 unit
       # then the conversion of inches
       @millibars = nil unless difference.abs <= 1.0
@@ -117,9 +126,10 @@ module Barometer
     
     # when we set millibars, it is possible the a non-equivalent value of
     # inches remains.  if so, clear it.
+    #
     def update_inches(mb)
       return unless @inches
-      difference = Pressure.mb_to_in(mb.to_f) - @inches
+      difference = Data::Pressure.mb_to_in(mb.to_f) - @inches
       # only clear inches if the stored inches is off be more then 1 unit
       # then the conversion of millibars
       @inches = nil unless difference.abs <= 1.0

data/lib/barometer/data/speed.rb

@@ -14,7 +14,8 @@ module Barometer
   # NOTE: this currently only supports the scale of
   #       kilometers (km) and miles (m) per hour.  There is currently
   #       no way to scale to smaller units (eg km -> m -> mm)
-  class Speed < Barometer::Units
+  #
+  class Data::Speed < Data::Units
     
     METRIC_UNITS = "kph"
     IMPERIAL_UNITS = "mph"
@@ -52,6 +53,7 @@ module Barometer
     #
     
     # store kilometers per hour
+    #
     def kph=(kph)
       return if !kph || !(kph.is_a?(Integer) || kph.is_a?(Float))
       @kilometers = kph.to_f
@@ -59,6 +61,7 @@ module Barometer
     end
     
     # store miles per hour
+    #
     def mph=(mph)
       return if !mph || !(mph.is_a?(Integer) || mph.is_a?(Float))
       @miles = mph.to_f
@@ -76,14 +79,16 @@ module Barometer
     end
     
     # return the stored kilometers or convert from miles
+    #
     def kph(as_integer=true)
-      km = (@kilometers || Speed.m_to_km(@miles))
+      km = (@kilometers || Data::Speed.m_to_km(@miles))
       km ? (as_integer ? km.to_i : (100*km).round/100.0) : nil
     end
     
     # return the stored miles or convert from kilometers
+    #
     def mph(as_integer=true)
-      m = (@miles || Speed.km_to_m(@kilometers))
+      m = (@miles || Data::Speed.km_to_m(@kilometers))
       m ? (as_integer ? m.to_i : (100*m).round/100.0) : nil
     end
     
@@ -100,30 +105,35 @@ module Barometer
     #
     
     # will just return the value (no units)
+    #
     def to_i(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.kph : self.mph
     end
     
     # will just return the value (no units) with more precision
+    #
     def to_f(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.kph(false) : self.mph(false)
     end
     
     # will return the value with units
+    #
     def to_s(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? "#{self.kph} #{METRIC_UNITS}" : "#{self.mph} #{IMPERIAL_UNITS}"
     end
     
     # will just return the units (no value)
+    #
     def units(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? METRIC_UNITS : IMPERIAL_UNITS
     end
     
     # when we set miles, it is possible the a non-equivalent value of
     # kilometers remains.  if so, clear it.
+    #
     def update_kilometers(m)
       return unless @kilometers
-      difference = Speed.m_to_km(m.to_f) - @kilometers
+      difference = Data::Speed.m_to_km(m.to_f) - @kilometers
       # only clear kilometers if the stored kilometers is off be more then 1 unit
       # then the conversion of miles
       @kilometers = nil unless difference.abs <= 1.0
@@ -131,9 +141,10 @@ module Barometer
     
     # when we set kilometers, it is possible the a non-equivalent value of
     # miles remains.  if so, clear it.
+    #
     def update_miles(km)
       return unless @miles
-      difference = Speed.km_to_m(km.to_f) - @miles
+      difference = Data::Speed.km_to_m(km.to_f) - @miles
       # only clear miles if the stored miles is off be more then 1 unit
       # then the conversion of kilometers
       @miles = nil unless difference.abs <= 1.0

data/lib/barometer/data/sun.rb

@@ -4,31 +4,19 @@ module Barometer
   # 
   # Used to store sunrise and sunset information
   #
-  class Sun
+  class Data::Sun
+    
+    attr_reader :rise, :set
     
     def initialize(rise=nil, set=nil)
-      raise ArgumentError unless (rise.is_a?(Time) || rise.nil?)
-      raise ArgumentError unless (set.is_a?(Time) || set.nil?)
-      @rise_utc = rise
-      @set_utc = set
+      raise ArgumentError unless (rise.is_a?(Data::LocalTime) || rise.nil?)
+      raise ArgumentError unless (set.is_a?(Data::LocalTime) || set.nil?)
+      @rise = rise
+      @set = set
     end
 
-    def rise; @rise_utc; end
-    def set; @set_utc; end
-    
-    # useful for incrementing the sunrise and sunset times by exactly
-    # N days ... used when using the same sun data for other days
-    def self.add_days!(sun, n=1)
-      raise ArgumentError unless sun.is_a?(Barometer::Sun)
-      raise ArgumentError unless n.is_a?(Fixnum)
-      seconds_to_add = 60*60*24*n
-      rise_utc = sun.rise + seconds_to_add
-      set_utc = sun.set + seconds_to_add
-      self.new(rise_utc, set_utc)
-    end
-    
     def nil?
-      (@rise_utc || @set_utc) ? false : true
+      (@rise || @set) ? false : true
     end
     
   end

data/lib/barometer/data/temperature.rb

@@ -9,7 +9,7 @@ module Barometer
   # All comparison operations will be done in the absolute
   # scale of Kelvin (K)
   #
-  class Temperature < Barometer::Units
+  class Data::Temperature < Data::Units
     
     METRIC_UNITS = "C"
     IMPERIAL_UNITS = "F"
@@ -36,12 +36,14 @@ module Barometer
     end
     
     # Tf = (9/5)*Tc+32
+    #
     def self.c_to_f(c)
       return nil unless c && (c.is_a?(Integer) || c.is_a?(Float))
        ((9.0/5.0)*c.to_f)+32.0
     end
     
     # Tc = (5/9)*(Tf-32)
+    #
     def self.f_to_c(f)
       return nil unless f && (f.is_a?(Integer) || f.is_a?(Float))
       (5.0/9.0)*(f.to_f-32.0)
@@ -69,38 +71,43 @@ module Barometer
     #
     
     # store celsius and kelvin
+    #
     def c=(c)
       return if !c || !(c.is_a?(Integer) || c.is_a?(Float))
       @celsius = c.to_f
-      @kelvin = Temperature.c_to_k(c.to_f)
+      @kelvin = Data::Temperature.c_to_k(c.to_f)
       self.update_fahrenheit(c.to_f)
     end
     
     # store fahrenheit and kelvin
+    #
     def f=(f)
       return if !f || !(f.is_a?(Integer) || f.is_a?(Float))
       @fahrenheit = f.to_f
-      @kelvin = Temperature.f_to_k(f.to_f)
+      @kelvin = Data::Temperature.f_to_k(f.to_f)
       self.update_celsius(f.to_f)
     end
     
     # store kelvin, convert to all
+    #
     def k=(k)
       return if !k || !(k.is_a?(Integer) || k.is_a?(Float))
       @kelvin = k.to_f
-      @celsius = Temperature.k_to_c(k.to_f)
-      @fahrenheit = Temperature.k_to_f(k.to_f)
+      @celsius = Data::Temperature.k_to_c(k.to_f)
+      @fahrenheit = Data::Temperature.k_to_f(k.to_f)
     end
     
     # return the stored celsius or convert from Kelvin
+    #
     def c(as_integer=true)
-      c = (@celsius || Temperature.k_to_c(@kelvin))
+      c = (@celsius || Data::Temperature.k_to_c(@kelvin))
       c ? (as_integer ? c.to_i : (100*c).round/100.0) : nil
     end
     
     # return the stored fahrenheit or convert from Kelvin
+    #
     def f(as_integer=true)
-      f = (@fahrenheit || Temperature.k_to_f(@kelvin))
+      f = (@fahrenheit || Data::Temperature.k_to_f(@kelvin))
       f ? (as_integer ? f.to_i : (100*f).round/100.0) : nil
     end
     
@@ -117,30 +124,35 @@ module Barometer
     #
     
     # will just return the value (no units)
+    #
     def to_i(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.c : self.f
     end
     
     # will just return the value (no units) with more precision
+    #
     def to_f(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.c(false) : self.f(false)
     end
     
     # will return the value with units
+    #
     def to_s(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? "#{self.c} #{METRIC_UNITS}" : "#{self.f} #{IMPERIAL_UNITS}"
     end
     
     # will just return the units (no value)
+    #
     def units(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? METRIC_UNITS : IMPERIAL_UNITS
     end
     
     # when we set fahrenheit, it is possible the a non-equivalent value of
     # celsius remains.  if so, clear it.
+    #
     def update_celsius(f)
       return unless @celsius
-      difference = Temperature.f_to_c(f.to_f) - @celsius
+      difference = Data::Temperature.f_to_c(f.to_f) - @celsius
       # only clear celsius if the stored celsius is off be more then 1 degree
       # then the conversion of fahrenheit
       @celsius = nil unless difference.abs <= 1.0
@@ -148,9 +160,10 @@ module Barometer
     
     # when we set celsius, it is possible the a non-equivalent value of
     # fahrenheit remains.  if so, clear it.
+    #
     def update_fahrenheit(c)
       return unless @fahrenheit
-      difference = Temperature.c_to_f(c.to_f) - @fahrenheit
+      difference = Data::Temperature.c_to_f(c.to_f) - @fahrenheit
       # only clear fahrenheit if the stored fahrenheit is off be more then 1 degree
       # then the conversion of celsius
       @fahrenheit = nil unless difference.abs <= 1.0

data/lib/barometer/data/units.rb

@@ -1,12 +1,10 @@
 module Barometer
-  class Units
+  class Data::Units
     include Comparable
     
     attr_accessor :metric
     
-    def initialize(metric=true)
-      @metric = metric
-    end
+    def initialize(metric=true); @metric = metric; end
     
     #
     # HELPERS
@@ -16,12 +14,13 @@ module Barometer
     def metric!; @metric=true; end
     def imperial!; @metric=false; end
 
-    # assigns a value to the right attribute based on metric setting    
+    # assigns a value to the right attribute based on metric setting
+    #
     def <<(value)
       return unless value
       
       # these values can be treated like 'nil'
-      nil_values = ["NA"]
+      nil_values = ["NA", "N/A", ""]
     
       begin
         if value.is_a?(Array)
@@ -37,22 +36,14 @@ module Barometer
         # do nothing
       end
     
-      if self.metric?
-        self.metric_default = value_m || value_b
-      else
+      self.metric? ? self.metric_default = value_m || value_b :
         self.imperial_default = value_i || value_b
-      end
     end
     
-    # STUB: define this method to actually retireve the metric_default
-    def metric_default=(value)
-      raise NotImplementedError
-    end
-
-    # STUB: define this method to actually retireve the imperial_default
-    def imperial_default=(value)
-      raise NotImplementedError
-    end
+    # stubs
+    #
+    def metric_default=(value); raise NotImplementedError; end
+    def imperial_default=(value); raise NotImplementedError; end
 
   end
 end