sun-times 0.1.2

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Joe Yates
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, 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.

data/README

@@ -0,0 +1,35 @@
+== SunTimes
+
+Calculates sunrise and sunset times.
+
+An implementation of the algorithm descibed at http://williams.best.vwh.net/sunrise_sunset_algorithm.htm
+
+== References
+
+* http://www.astro.uu.nl/~strous/AA/en/reken/zonpositie.html - Calculations
+* http://williams.best.vwh.net/sunrise_sunset_algorithm.htm - Algorithm
+* http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/264573 - Ken Bloom's implementation
+
+== Licence
+
+This code is free to use under the terms of the MIT licence:
+
+  Copyright (c) 2010 Joe Yates
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  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.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'rake/clean'
+
+$:.unshift(File.dirname(__FILE__) + '/lib')
+require 'sun_times'
+
+RDOC_OPTS = ['--quiet', '--title', 'Sun Times Calculator', '--main', 'README', '--inline-source']
+CLEAN.include 'doc'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name = 'sun-times'
+  s.summary = 'Module which calculates sunrise and sunset times'
+  s.version = SunTimes::VERSION::STRING
+
+  s.homepage = 'http://github.com/timoschilling/sun-times'
+  s.author = ['Joe Yates', 'Timo Schilling']
+  s.email = ['joe.g.yates@gmail.com', 'timo@schilling.io']
+
+  s.files = ['README', 'COPYING', 'Rakefile'] + FileList['{lib,test}/**/*.rb']
+  s.require_paths = ['lib']
+
+  s.has_rdoc = true
+  s.rdoc_options += RDOC_OPTS
+  s.extra_rdoc_files = ['README', 'COPYING']
+
+  s.test_file = 'test/test_all.rb'
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.options += RDOC_OPTS
+  rdoc.main = "README"
+  rdoc.rdoc_files.add ['README', 'COPYING', 'lib/**/*.rb']
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end

data/lib/sun_times.rb

@@ -0,0 +1,179 @@
+#--
+# Copyright (c) 2010 Joe Yates
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, 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.
+#++
+
+# Algorithm from http://williams.best.vwh.net/sunrise_sunset_algorithm.htm
+
+require 'date'
+
+module SunTimes
+
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+
+  DEFAULT_ZENITH = 90.83333
+  KNOWN_EVENTS = [:rise, :set]
+  DEGREES_PER_HOUR = 360.0 / 24.0
+
+  # Helper method: calculates sunrise, with the same parameters as calculate
+  def SunTimes.rise(date, latitude, longitude, options = {})
+    calculate(:rise, date, latitude, longitude, options)
+  end
+
+  # Helper method: calculates sunset, with the same parameters as calculate
+  def SunTimes.set(date, latitude, longitude, options = {})
+    calculate(:set, date, latitude, longitude, options)
+  end
+
+  # Calculates the sunrise or sunset time for a specific date and location
+  #
+  # ==== Parameters
+  # * +event+ - One of :rise, :set.
+  # * +date+ - An object that responds to yday.
+  # * +latitude+ - The latitude of the location in degrees.
+  # * +longitude+ - The longitude of the location in degrees.
+  # * +options+ - Additional option is <tt>:zenith</tt>.
+  #
+  # ==== Example
+  #   SunTimes.calculate(:rise, Date.new(2010, 3, 8), 43.779, 11.432)
+  #   > Mon Mar 08 05:39:53 UTC 2010
+  def SunTimes.calculate(event, date, latitude, longitude, options = {})
+    raise "Unknown event '#{ event }'" if KNOWN_EVENTS.find_index(event).nil?
+    zenith = options.delete(:zenith) || DEFAULT_ZENITH
+
+    # lngHour
+    longitude_hour = longitude / DEGREES_PER_HOUR
+
+    # t
+    base_time = event == :rise ? 6.0 : 18.0
+    approximate_time = date.yday + (base_time - longitude_hour) / 24.0
+
+    # M
+    mean_sun_anomaly = (0.9856 * approximate_time) - 3.289
+
+    # L
+    sun_true_longitude = mean_sun_anomaly +
+                        (1.916 * Math.sin(degrees_to_radians(mean_sun_anomaly))) +
+                        (0.020 * Math.sin(2 * degrees_to_radians(mean_sun_anomaly))) +
+                        282.634
+    sun_true_longitude = coerce_degrees(sun_true_longitude)
+
+    # RA
+    tan_right_ascension = 0.91764 * Math.tan(degrees_to_radians(sun_true_longitude))
+    sun_right_ascension = radians_to_degrees(Math.atan(tan_right_ascension))
+    sun_right_ascension = coerce_degrees(sun_right_ascension)
+
+    # right ascension value needs to be in the same quadrant as L
+    sun_true_longitude_quadrant  = (sun_true_longitude  / 90.0).floor * 90.0
+    sun_right_ascension_quadrant = (sun_right_ascension / 90.0).floor * 90.0
+    sun_right_ascension += (sun_true_longitude_quadrant - sun_right_ascension_quadrant)
+
+    # RA = RA / 15
+    sun_right_ascension_hours = sun_right_ascension / DEGREES_PER_HOUR
+
+    sin_declination = 0.39782 * Math.sin(degrees_to_radians(sun_true_longitude))
+    cos_declination = Math.cos(Math.asin(sin_declination))
+
+    cos_local_hour_angle =
+      (Math.cos(degrees_to_radians(zenith)) - (sin_declination * Math.sin(degrees_to_radians(latitude)))) /
+      (cos_declination * Math.cos(degrees_to_radians(latitude)))
+
+    # the sun never rises on this location (on the specified date)
+    return nil if cos_local_hour_angle > 1
+    # the sun never sets on this location (on the specified date)
+    return nil if cos_local_hour_angle < -1
+
+    # H
+    suns_local_hour =
+      if event == :rise
+        360 - radians_to_degrees(Math.acos(cos_local_hour_angle))
+      else
+        radians_to_degrees(Math.acos(cos_local_hour_angle))
+      end
+
+    # H = H / 15
+    suns_local_hour_hours = suns_local_hour / DEGREES_PER_HOUR
+
+    # T = H + RA - (0.06571 * t) - 6.622
+    local_mean_time = suns_local_hour_hours + sun_right_ascension_hours - (0.06571 * approximate_time) - 6.622
+
+    # UT = T - lngHour
+    gmt_hours = local_mean_time - longitude_hour
+    gmt_hours -= 24.0 if gmt_hours > 24
+    gmt_hours += 24.0 if gmt_hours <  0
+
+    case
+    when date.respond_to?( :offset )
+      offset_hours = date.offset * 24
+    when date.respond_to?( :gmt_offset )
+      offset_hours = date.gmt_offset / 3600
+    else
+      offset_hours = nil
+    end
+
+    if ! offset_hours.nil?
+      if gmt_hours + offset_hours < 0
+        next_day = Date.new(date.year, date.month, date.day + 1)
+        return calculate(event, next_day, latitude, longitude, options = {})
+      end
+      if gmt_hours + offset_hours > 24
+        previous_day = Date.new(date.year, date.month, date.day + 1)
+        return calculate(event, previous_day, latitude, longitude, options = {})
+      end
+    end
+
+    hour = gmt_hours.floor
+    hour_remainder = (gmt_hours.to_f - hour.to_f) * 60.0
+    minute = hour_remainder.floor
+    seconds = (hour_remainder - minute) * 60.0
+
+    Time.gm(date.year, date.month, date.day, hour, minute, seconds)
+  end
+
+  private
+
+  def SunTimes.degrees_to_radians(d)
+    d.to_f / 360.0 * 2.0 * Math::PI
+  end
+
+  def SunTimes.radians_to_degrees(r)
+    r.to_f * 360.0 / (2.0 * Math::PI)
+  end
+
+  def SunTimes.coerce_degrees(d)
+    if d < 0
+      d += 360
+      return coerce_degrees(d)
+    end
+    if d >= 360
+      d -= 360
+      return coerce_degrees(d)
+    end
+    d
+  end
+
+end

data/test/calculate_test.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'sun_times'
+require 'date'
+
+class SunTimesTest < Test::Unit::TestCase
+
+  def test_rise_20100308_pontassieve
+    rise = SunTimes.calculate(:rise, Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(Time.gm(2010, 3, 8, 5, 39, 53), rise)
+  end
+
+  def test_set_20100308_pontassieve
+    set = SunTimes.calculate(:set, Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(Time.gm(2010, 3, 8, 17, 11, 16), set)
+  end
+
+  def test_rise_helper
+    rise = SunTimes.rise(Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(Time.gm(2010, 3, 8, 5, 39, 53), rise)
+  end
+
+  def test_set_helper
+    set = SunTimes.set(Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(Time.gm(2010, 3, 8, 17, 11, 16), set)
+  end
+
+  def test_midnight_sun_on_20100621_north_cape
+    rise = SunTimes.calculate(:rise, Date.new(2010, 6, 21), 71.170219, 25.785556)
+    assert_nil(rise)
+    set = SunTimes.calculate(:set, Date.new(2010, 6, 21), 71.170219, 25.785556)
+    assert_nil(set)
+  end
+
+  def test_unknown_event
+    assert_raise(RuntimeError) { SunTimes.calculate(:foo, Date.new(2010, 3, 8), 43.779, 11.432) }
+  end
+
+  def test_time
+    datetime = Time.gm(2010, 6, 13, 0, 0, 0)
+    set = SunTimes.calculate(:set, datetime, 43.779, 11.432)
+    assert_equal(Time.gm(2010, 6, 13, 18, 56, 55), set)
+  end
+
+  def test_datetime
+    datetime = DateTime.new(2010, 6, 13, 0, 0, 0)
+    set = SunTimes.calculate(:set, datetime, 43.779, 11.432)
+    assert_equal(Time.gm(2010, 6, 13, 18, 56, 55), set)
+  end
+
+  def test_respects_timezone_if_supplied
+    pst = DateTime.new(2011, 12, 13, 0, 0, 0, Rational(-8, 24))
+    set = SunTimes.calculate(:set, pst, 45.52, -122.681944)
+    result_datetime = DateTime.new(set.year, set.month, set.day, set.hour, set.min, set.sec, 0)
+    assert(pst < result_datetime)
+    assert(pst + 1 > result_datetime)
+  end
+
+end

data/test/test_all.rb

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__)+'/*_test.rb'].each do |test|
+  require test
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: sun-times
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Joe Yates
+- Timo Schilling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-20 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- joe.g.yates@gmail.com
+- timo@schilling.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+- COPYING
+files:
+- README
+- COPYING
+- Rakefile
+- lib/sun_times.rb
+- test/calculate_test.rb
+- test/test_all.rb
+homepage: http://github.com/timoschilling/sun-times
+licenses: []
+post_install_message: 
+rdoc_options:
+- --quiet
+- --title
+- Sun Times Calculator
+- --main
+- README
+- --inline-source
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Module which calculates sunrise and sunset times
+test_files:
+- test/test_all.rb