sun_time 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-07-23
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/sun_time.rb
+lib/sun_time/date_ext.rb
+lib/sun_time/degree_trig.rb
+script/console
+script/destroy
+script/generate
+test/test_date_ext.rb
+test/test_degree_trig.rb
+test/test_sun_time.rb

data/README.rdoc

@@ -0,0 +1,90 @@
+= sun_time
+
+* http://github.com/elabs/sun_time
+
+== DESCRIPTION:
+
+Calculate the time of sunrise and sunset for location on a specific date.
+
+== SYNOPSIS:
+
+Create a new SunTime instance with a Date and latitude and longitude in decimal format as arguments. Then you can call the `sunrise` and `sunset` methods on that instance.
+
+    require 'sun_time'
+    
+    date = Date.new(2009, 7, 23)
+    latitude = 57.7119                  # N 57° 42' 42"
+    longitude = 11.9683                 # E 11° 58' 5"
+    
+    sun_time = SunTime.new(date, latitude, longitude)
+    
+    sun_time.sunrise
+    # => Thu Jul 23 02:50:32 UTC 2009
+    
+    sun_time.sunset
+    # => Thu Jul 23 19:48:56 UTC 2009
+    
+Note that the times returned are always in UTC, so you have to convert them to your local time yourself if you want that.
+
+If you try to calculate sunrise or sunset for a location where the sun doesn't rise or set on the chosen date, nil is returned:
+
+    winter_in_sweden = SunTime.new(Date.new(2009,12,22), 67.8529, 20.2426)
+
+    winter_in_sweden.sunrise
+    # => nil
+
+    winter_in_sweden.sunset
+    # => nil
+
+    summer_in_sweden = SunTime.new(Date.new(2009,6,22), 67.8529, 20.2426)
+
+    summer_in_sweden.sunrise
+    # => nil
+
+    summer_in_sweden.sunset
+    # => nil
+
+
+=== Date Extension:
+
+Optionally, you can use SunTime as an extension to the Date class. Here's how you do that:
+
+    require 'sun_time'
+    require 'sun_time/date_ext
+
+    date = Date.new(2009, 7, 23)
+
+    date.sunrise(57.7119, 11.9683)
+    # => Thu Jul 23 02:50:32 UTC 2009
+
+    date.sunset(57.7119, 11.9683)
+    # => Thu Jul 23 19:48:56 UTC 2009
+
+== INSTALL:
+
+sudo gem install sun_time
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Edithouse eLabs AB
+
+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,23 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/sun_time'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'sun_time' do
+  self.developer 'Carl-Johan Kihlbom', 'cj@elabs.se'
+  self.rubyforge_name = 'elabs'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/sun_time/date_ext.rb

@@ -0,0 +1,9 @@
+class Date
+  def sunrise(lat, lng)
+    SunTime.new(self, lat, lng).sunrise
+  end
+  
+  def sunset(lat, lng)
+    SunTime.new(self, lat, lng).sunset
+  end
+end

data/lib/sun_time/degree_trig.rb

@@ -0,0 +1,35 @@
+class SunTime
+  module DegreeTrig
+    def r2d (v)
+      180/Math::PI * v 
+    end
+  
+    def d2r (v)
+      Math::PI/180 * v
+    end
+  
+    def sin (d)
+      Math.sin(d2r(d))
+    end
+  
+    def asin (d)
+     r2d Math.asin(d)
+    end
+  
+    def cos (d)
+      Math.cos(d2r(d))
+    end
+  
+    def acos (d)
+      r2d Math.acos(d)
+    end
+  
+    def tan (d)
+      Math.tan(d2r(d))
+    end
+  
+    def atan (d)
+      r2d Math.atan(d)
+    end
+  end
+end

data/lib/sun_time.rb

@@ -0,0 +1,129 @@
+require 'date'
+
+require File.expand_path(File.join(File.dirname(__FILE__), "sun_time/degree_trig"))
+
+class SunTime
+  VERSION = '0.0.1'
+  
+  class AlwaysDarkError < ::StandardError; end
+  class AlwaysLightError < ::StandardError; end
+  
+  attr_reader :date, :lat, :lng
+  
+  def initialize (date, lat, lng)
+    @date = date
+    @lat = lat
+    @lng = lng
+    @m = nil
+  end
+  
+  def sunrise
+    jd2time j_rise
+  rescue AlwaysDarkError, AlwaysLightError
+    nil
+  end
+  
+  def sunset
+    jd2time j_set
+  rescue AlwaysDarkError, AlwaysLightError
+    nil
+  end
+    
+private
+  include DegreeTrig
+  
+  # Julian date
+  def j_date
+    date.jd
+  end
+  
+  # West longitude
+  def lng_w
+    lng * -1
+  end
+  
+  # North latitude
+  def lat_n
+    lat
+  end
+  
+  # Mean solar anomaly
+  def m(_j_transit=j_star)
+    (357.5291 + 0.98560028 * (_j_transit - 2451545)) % 360
+  end
+  
+  # Julian cycle since Jan 1, 2000
+  def n
+    ((j_date.to_f - 2451545 - 0.0009) - (lng_w/360)).round
+  end
+  
+  # Equation of center
+  def c(_m=m)
+    1.9148*sin(_m) + 0.0200*sin(2*_m) + 0.0003*sin(3*_m)
+  end
+  
+  # Ecliptical longitude of the sun
+  def sun_l
+    _m = @m || m
+    c = c(_m)
+    (_m + 102.9372 + c + 180) % 360
+  end
+  
+  # Declination of the sun
+  def sun_d
+    recalculate_m
+    asin(sin(sun_l) * sin(23.45))
+  end
+  
+  # Hour angle (half the arc length of the sun)
+  def h
+    i = (sin(-0.83) - sin(lat_n) * sin(sun_d)) / (cos(lat_n) * cos(sun_d))
+    
+    if i < -1.0
+      raise AlwaysLightError, "The sun is always up at this location on #{date}"
+    elsif i > 1.0
+      raise AlwaysDarkError,  "The sun is always down at this location on #{date}"
+    end
+    
+    acos( i )
+  end
+  
+  # Julian date of solar noon on cycle n
+  # TODO: Iteratively recalculate m using j_transit until it stops changing
+  def j_transit(_m=m)
+    j_star + (0.0053 * sin(_m)) - (0.0069 * sin(2*sun_l))
+  end
+  
+  def recalculate_m
+    current_m = m(j_transit)
+    last_m = nil
+    until current_m == last_m
+      last_m = current_m
+      current_m = m(j_transit(last_m))
+    end
+    @m = current_m
+  end
+  
+  # Approximate Julian date of solar noon on cycle n
+  def j_star
+    2451545 + 0.0009 + (lng_w/360) + n
+  end
+  
+  # Julian date of sunrise on cycle n
+  def j_rise
+    j_transit - (j_set - j_transit)
+  end
+
+  # Julian date of sunset on cycle n
+  def j_set
+    @j_star = 2451545 + 0.0009 + ((h + lng_w) / 360) + n
+    
+    @j_star + (0.0053 * sin(@m)) - (0.0069 * sin(2*sun_l))
+  end
+  
+  
+  def jd2time (jd)
+    dt = DateTime.jd(jd, 12)
+    Time.utc(dt.year, dt.month, dt.day, dt.hour, dt.min, dt.sec)
+  end 
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sun_time.rb'}"
+puts "Loading sun_time gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_date_ext.rb

@@ -0,0 +1,22 @@
+require "test/unit"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/sun_time/date_ext"))
+
+class TestDate < Test::Unit::TestCase
+  def setup
+    @lat = 57.7119
+    @lng = 11.9683
+    @date = Date.new(2009, 7, 23)
+  end
+  
+  def test_sunrise
+    sunrise = Time.mktime(2009, 7, 23, 4, 50, 32)
+    assert_equal(sunrise, @date.sunrise(@lat, @lng))
+  end
+  
+  def test_sunset
+    sunset =  Time.mktime(2009, 7, 23, 21, 48, 56)
+  
+    assert_equal(sunset, @date.sunset(@lat, @lng))
+  end
+end

data/test/test_degree_trig.rb

@@ -0,0 +1,40 @@
+require "test/unit"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/sun_time/degree_trig"))
+
+class TestDegreeTrig < Test::Unit::TestCase
+  include SunTime::DegreeTrig
+  
+  def test_sin
+    assert_in_delta(0.017452406437284, sin(1), 2 ** -20)
+  end
+  
+  def test_cos
+    assert_in_delta(0.999847695156391, cos(1), 2 ** -20)
+  end
+  
+  def test_tan
+    assert_in_delta(0.017455064928218, tan(1), 2 ** -20)
+  end
+  
+  def test_asin
+    assert_in_delta(r2d(1.57079633), asin(1), 2 ** -20)
+  end
+  
+  def test_acos
+    assert_in_delta(r2d(0), acos(1), 2 ** -20)
+    assert_in_delta(r2d(1.04719755), acos(0.5), 2 ** -20)
+  end
+  
+  def test_atan
+    assert_in_delta(r2d(0.785398163), atan(1), 2 ** -20)
+  end
+  
+  def test_degrees_to_radians
+    assert_in_delta(0.0174532925, d2r(1), 2 ** -20)
+  end
+
+  def test_radians_to_degrees
+    assert_in_delta(57.2957795, r2d(1), 2 ** -20)
+  end
+end

data/test/test_sun_time.rb

@@ -0,0 +1,82 @@
+require "test/unit"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/sun_time"))
+
+class TestSunTime < Test::Unit::TestCase
+  def setup
+    @lat = 57.7119
+    @lng = 11.9683
+    @date = Date.new(2009, 7, 23)
+    @sun_time = SunTime.new(@date, @lat, @lng)
+  end
+  
+  def test_sunrise
+    sunrise = Time.mktime(2009, 7, 23, 4, 50, 32)
+    
+    assert_equal(sunrise, @sun_time.sunrise)
+  end
+  
+  def test_sunset
+    sunset =  Time.mktime(2009, 7, 23, 21, 48, 56)
+  
+    assert_equal(sunset, @sun_time.sunset)
+  end
+  
+  def test_always_light
+    summer_in_sweden = SunTime.new(Date.new(2009,6,22), 67.8529, 20.2426)
+    assert_nil(summer_in_sweden.sunrise)
+    assert_nil(summer_in_sweden.sunset)
+  end
+  
+  def test_always_dark
+    winter_in_sweden = SunTime.new(Date.new(2009,12,22), 67.8529, 20.2426)
+    assert_nil(winter_in_sweden.sunrise)
+    assert_nil(winter_in_sweden.sunset)
+  end
+  
+  # Private methods
+  
+  def test_j_date
+    assert_equal(2455036, @sun_time.send(:j_date))
+  end
+  
+  def test_n
+    assert_equal(3491, @sun_time.send(:n))
+  end
+  
+  def test_j_star
+    assert_in_delta(2455035.9676547, @sun_time.send(:j_star), 2 ** -20)
+  end
+  
+  def test_m
+    assert_in_delta(198.22779796522, @sun_time.send(:m), 2 ** -20)
+  end
+  
+  def test_c
+    assert_in_delta(-0.58730215027404, @sun_time.send(:c), 2 ** -20)
+  end
+  
+  def test_sun_l
+    assert_in_delta(120.57769581495, @sun_time.send(:sun_l), 2 ** -20)
+  end
+  
+  def test_j_transit
+    assert_in_delta(2455035.9720408, @sun_time.send(:j_transit), 2 ** -20)
+  end
+  
+  def test_sun_d
+    assert_in_delta(20.03506338786, @sun_time.send(:sun_d), 2 ** -20)
+  end
+  
+  def test_h
+    assert_in_delta(127.29871041684, @sun_time.send(:h), 2 ** -20)
+  end
+  
+  def test_j_set
+    assert_in_delta(2455036.3256485, @sun_time.send(:j_set), 2 ** -20)
+  end
+  
+  def test_j_rise
+    assert_in_delta(2455035.6184334, @sun_time.send(:j_rise), 2 ** -20)
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: sun_time
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Carl-Johan Kihlbom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: Calculate the time of sunrise and sunset for location on a specific date.
+email: 
+- cj@elabs.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/sun_time.rb
+- lib/sun_time/date_ext.rb
+- lib/sun_time/degree_trig.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_date_ext.rb
+- test/test_degree_trig.rb
+- test/test_sun_time.rb
+has_rdoc: true
+homepage: http://github.com/elabs/sun_time
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: elabs
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Calculate the time of sunrise and sunset for location on a specific date.
+test_files: 
+- test/test_date_ext.rb
+- test/test_degree_trig.rb
+- test/test_sun_time.rb