RubySunrise 0.1.0 → 0.1.1

data/lib/{sunrise.rb → solareventcalculator.rb}

@@ -13,18 +13,14 @@ class SolarEventCalculator
     @longitude = longitude
   end
 
-  def compute_longitude_hour
+  def compute_lnghour
     lngHour = @longitude / BigDecimal.new("15")
     lngHour.round(4)
   end
 
-  def compute_rise_longitude_hour
-    longHour = @date.yday + ((BigDecimal.new("6") - compute_longitude_hour) / BigDecimal.new("24"))
-    longHour.round(4)
-  end
-
-  def compute_set_longitude_hour
-    longHour = @date.yday + ((BigDecimal.new("18") - compute_longitude_hour) / BigDecimal.new("24"))
+  def compute_longitude_hour(isSunrise)
+    minuend = (isSunrise) ? BigDecimal.new("6") : BigDecimal.new("18")
+    longHour = @date.yday + ((minuend - compute_lnghour) / BigDecimal.new("24"))
     longHour.round(4)
   end
 
@@ -85,17 +81,12 @@ class SolarEventCalculator
     cosLocalHour.round(4)
   end
 
-  def compute_sunrise_local_hour_angle(cosSunLocalHour)
+  def compute_local_hour_angle(cosSunLocalHour, isSunrise)
     acosH = BigDecimal.new(Math.acos(cosSunLocalHour).to_s)
-    localHourAngle = BigDecimal.new("360") - rads_as_degrees(acosH)
-    localHourAngle = localHourAngle / BigDecimal.new("15")
-    localHourAngle.round(4)
-  end
+    acosHDegrees = rads_as_degrees(acosH)
 
-  def compute_sunset_local_hour_angle(cosSunLocalHour)
-    acosH = BigDecimal.new(Math.acos(cosSunLocalHour).to_s)
-    acosH = rads_as_degrees(acosH)
-    localHourAngle = acosH / BigDecimal.new("15")
+    localHourAngle = (isSunrise) ? BigDecimal.new("360") - acosHDegrees : acosHDegrees
+    localHourAngle = localHourAngle / BigDecimal.new("15")
     localHourAngle.round(4)
   end
 
@@ -111,11 +102,11 @@ class SolarEventCalculator
     utcTime.round(4)
   end
 
-  def compute_utc_sunrise(zenith)
-    longHour = compute_longitude_hour
-    riseLongHour = compute_rise_longitude_hour
+  def compute_utc_solar_event(zenith, isSunrise)
+    longHour = compute_lnghour
+    eventLongHour = compute_longitude_hour(isSunrise)
 
-    meanAnomaly = compute_sun_mean_anomaly(riseLongHour)
+    meanAnomaly = compute_sun_mean_anomaly(eventLongHour)
     sunTrueLong = compute_sun_true_longitude(meanAnomaly)
     cosineSunLocalHour = compute_cosine_sun_local_hour(sunTrueLong, zenith)
 
@@ -123,8 +114,8 @@ class SolarEventCalculator
       return nil
     end
 
-    sunLocalHour = compute_sunrise_local_hour_angle(cosineSunLocalHour)
-    localMeanTime = compute_local_mean_time(sunTrueLong, longHour, riseLongHour, sunLocalHour)
+    sunLocalHour = compute_local_hour_angle(cosineSunLocalHour, isSunrise)
+    localMeanTime = compute_local_mean_time(sunTrueLong, longHour, eventLongHour, sunLocalHour)
 
     timeParts = localMeanTime.to_s('F').split('.')
     mins = BigDecimal.new("." + timeParts[1]) * BigDecimal.new("60")
@@ -135,27 +126,36 @@ class SolarEventCalculator
     Time.gm(@date.year, @date.mon, @date.mday, hours, pad_minutes(mins.to_i))
   end
 
-  def compute_utc_sunset(zenith)
-    longHour = compute_longitude_hour
-    setLongHour = compute_set_longitude_hour
+  def compute_utc_civil_sunrise
+    compute_utc_solar_event(96, true)
+  end
 
-    meanAnomaly = compute_sun_mean_anomaly(setLongHour)
-    sunTrueLong = compute_sun_true_longitude(meanAnomaly)
-    cosineSunLocalHour = compute_cosine_sun_local_hour(sunTrueLong, zenith)
+  def compute_utc_civil_sunset
+    compute_utc_solar_event(96, false)
+  end
 
-    if(cosineSunLocalHour > BigDecimal.new("1") || cosineSunLocalHour < BigDecimal.new("-1"))
-      return nil
-    end
+  def compute_utc_official_sunrise
+    compute_utc_solar_event(90.8333, true)
+  end
 
-    sunLocalHour = compute_sunset_local_hour_angle(cosineSunLocalHour)
-    localMeanTime = compute_local_mean_time(sunTrueLong, longHour, setLongHour, sunLocalHour)
+  def compute_utc_official_sunset
+    compute_utc_solar_event(90.8333, false)
+  end
 
-    timeParts = localMeanTime.to_s('F').split('.')
-    mins = BigDecimal.new("." + timeParts[1]) * BigDecimal.new("60")
-    mins = mins.truncate()
-    hours = timeParts[0]
+  def compute_utc_nautical_sunrise
+    compute_utc_solar_event(102, true)
+  end
 
-    Time.gm(@date.year, @date.mon, @date.mday, hours, pad_minutes(mins.to_i))
+  def compute_utc_nautical_sunset
+    compute_utc_solar_event(102, false)
+  end
+
+  def compute_utc_astronomical_sunrise
+    compute_utc_solar_event(108, true)
+  end
+
+  def compute_utc_astronomical_sunset
+    compute_utc_solar_event(108, false)
   end
 
   def pad_minutes(minutes)

data/rubysunrise.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do | s |
   s.name = "RubySunrise"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
   s.author = "Mike Reedell / LuckyCatLabs"
   s.email = "mike@luckycatlabs.com"
   s.homepage = "http://www.luckycatlabs.com"

data/test/sunrisetest.rb

@@ -1,4 +1,4 @@
-require 'sunrise'
+require '../lib/solareventcalculator'
 
 describe SolarEventCalculator, "test the math for home" do
 
@@ -8,11 +8,11 @@ describe SolarEventCalculator, "test the math for home" do
   end
 
   it "returns correct longitude hour" do
-    @calc.compute_longitude_hour.should eql(BigDecimal.new("-5.0523"))
+    @calc.compute_lnghour.should eql(BigDecimal.new("-5.0523"))
   end
 
   it "returns correct longitude hour" do
-    @calc.compute_rise_longitude_hour.should eql(BigDecimal.new("306.4605"))
+    @calc.compute_longitude_hour(true).should eql(BigDecimal.new("306.4605"))
   end
 
   it "returns correct sunrise mean anomaly" do
@@ -44,7 +44,7 @@ describe SolarEventCalculator, "test the math for home" do
   end
 
   it "returns correct sunrise local hour angle" do
-    @calc.compute_sunrise_local_hour_angle(BigDecimal.new("0.0791")).should eql(BigDecimal.new("18.3025"))
+    @calc.compute_local_hour_angle(BigDecimal.new("0.0791"), true).should eql(BigDecimal.new("18.3025"))
   end
 
   it "returns correct sunrise local mean time" do
@@ -56,19 +56,19 @@ describe SolarEventCalculator, "test the math for home" do
   end
 
   it "returns correct civil sunrise time" do
-    @calc.compute_utc_sunrise(96).should eql(Time.gm(@date.year, @date.mon, @date.mday, 11, 4))
+    @calc.compute_utc_civil_sunrise.should eql(Time.gm(@date.year, @date.mon, @date.mday, 11, 4))
   end
 
   it "returns correct official sunrise time" do
-    @calc.compute_utc_sunrise(90.8333).should eql(Time.gm(@date.year, @date.mon, @date.mday, 11, 33))
+    @calc.compute_utc_official_sunrise.should eql(Time.gm(@date.year, @date.mon, @date.mday, 11, 33))
   end
 
   it "returns correct nautical sunrise time" do
-    @calc.compute_utc_sunrise(102).should eql(Time.gm(@date.year, @date.mon, @date.mday, 10, 32))
+    @calc.compute_utc_nautical_sunrise.should eql(Time.gm(@date.year, @date.mon, @date.mday, 10, 32))
   end
 
   it "returns correct astronomical sunrise time" do
-    @calc.compute_utc_sunrise(108).should eql(Time.gm(@date.year, @date.mon, @date.mday, 10, 1))
+    @calc.compute_utc_astronomical_sunrise.should eql(Time.gm(@date.year, @date.mon, @date.mday, 10, 1))
   end
 end
 
@@ -77,13 +77,12 @@ describe SolarEventCalculator, "test the math for areas where there could be no
   it "returns correct time" do
     date = Date.parse('2008-04-25') #25 April 2008
     calc = SolarEventCalculator.new(date, BigDecimal.new("64.8378"), BigDecimal.new("-147.7164"))
-    calc.compute_utc_sunrise(108).should eql(nil)
+    calc.compute_utc_nautical_sunrise.should eql(nil)
   end
 
   it "returns correct time" do
     date = Date.parse('2008-04-25') #25 April 2008
     calc = SolarEventCalculator.new(date, BigDecimal.new("64.8378"), BigDecimal.new("-147.7164"))
-    calc.compute_utc_sunrise(102).should eql(nil)
+    calc.compute_utc_nautical_sunrise.should eql(nil)
   end
 end
-

data/test/sunsettest.rb

@@ -1,4 +1,4 @@
-require 'sunrise'
+require '../lib/solareventcalculator'
 
 describe SolarEventCalculator, "Test the sunset algorithm" do
 
@@ -8,11 +8,11 @@ describe SolarEventCalculator, "Test the sunset algorithm" do
   end
 
   it "returns correct longitude hour" do
-    @calc.compute_longitude_hour.should eql(BigDecimal.new("-5.0523"))
+    @calc.compute_lnghour.should eql(BigDecimal.new("-5.0523"))
   end
 
   it "returns correct longitude hour" do
-    @calc.compute_set_longitude_hour.should eql(BigDecimal.new("306.9605"))
+    @calc.compute_longitude_hour(false).should eql(BigDecimal.new("306.9605"))
   end
 
   it "returns correct sunset mean anomaly" do
@@ -44,7 +44,7 @@ describe SolarEventCalculator, "Test the sunset algorithm" do
   end
 
   it "returns correct sunset local hour angle" do
-    @calc.compute_sunset_local_hour_angle(BigDecimal.new("0.0815")).should eql(BigDecimal.new("5.6883"))
+    @calc.compute_local_hour_angle(BigDecimal.new("0.0815"), false).should eql(BigDecimal.new("5.6883"))
   end
 
   it "returns correct sunset local mean time" do
@@ -56,19 +56,19 @@ describe SolarEventCalculator, "Test the sunset algorithm" do
   end
 
   it "returns correct civil sunset time" do
-    @calc.compute_utc_sunset(96).should eql(Time.gm(@date.year, @date.mon, @date.mday, 22, 28))
+    @calc.compute_utc_civil_sunset.should eql(Time.gm(@date.year, @date.mon, @date.mday, 22, 28))
   end
 
   it "returns correct official sunset time" do
-    @calc.compute_utc_sunset(90.8333).should eql(Time.gm(@date.year, @date.mon, @date.mday, 21, 59))
+    @calc.compute_utc_official_sunset.should eql(Time.gm(@date.year, @date.mon, @date.mday, 21, 59))
   end
 
   it "returns correct nautical sunset time" do
-    @calc.compute_utc_sunset(102).should eql(Time.gm(@date.year, @date.mon, @date.mday, 23, 0))
+    @calc.compute_utc_nautical_sunset.should eql(Time.gm(@date.year, @date.mon, @date.mday, 23, 0))
   end
 
   it "returns correct astronomical sunset time" do
-    @calc.compute_utc_sunset(108).should eql(Time.gm(@date.year, @date.mon, @date.mday, 23, 31))
+    @calc.compute_utc_astronomical_sunset.should eql(Time.gm(@date.year, @date.mon, @date.mday, 23, 31))
   end
 end
 
@@ -77,13 +77,12 @@ describe SolarEventCalculator, "test the math for areas where the sun doesn't se
   it "returns correct time" do
     date = Date.parse('2008-04-25') #25 April 2008
     calc = SolarEventCalculator.new(date, BigDecimal.new("64.8378"), BigDecimal.new("-147.7164"))
-    calc.compute_utc_sunset(108).should eql(nil)
+    calc.compute_utc_nautical_sunset.should eql(nil)
   end
 
   it "returns correct time" do
     date = Date.parse('2008-04-25') #25 April 2008
     calc = SolarEventCalculator.new(date, BigDecimal.new("64.8378"), BigDecimal.new("-147.7164"))
-    calc.compute_utc_sunset(102).should eql(nil)
+    calc.compute_utc_nautical_sunset.should eql(nil)
   end
 end
-

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mike Reedell / LuckyCatLabs
@@ -28,7 +28,7 @@ extra_rdoc_files: []
 
 files: 
 - rubysunrise.gemspec
-- lib/sunrise.rb
+- lib/solareventcalculator.rb
 has_rdoc: true
 homepage: http://www.luckycatlabs.com
 licenses: []