when_sun 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Enphase Energy
+
+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.rdoc

@@ -0,0 +1,21 @@
+= when_sun
+
+WhenSun is a RubyGem for calculating the sunrise and sunset for locations based on the date, latitude and longitude.
+
+This gem is based on https://github.com/joeyates/ruby-sun-times implementation of http://williams.best.vwh.net/sunrise_sunset_algorithm.htm
+
+== Contributing to when_sun
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Enphase Energy. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "when_sun"
+  gem.homepage = "http://github.com/cracell/when_sun"
+  gem.license = "MIT"
+  gem.summary = %Q{WhenSun is a RubyGem for calculating the sunrise and sunset for locations based on the date, latitude and longitude.}
+  gem.description = %Q{WhenSun is a RubyGem for calculating the sunrise and sunset for locations based on the date, latitude and longitude.}
+  gem.email = "ecranston@enphaseenergy.com"
+  gem.authors = ["Eric Cranston"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "when_sun #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/when_sun.rb

@@ -0,0 +1,124 @@
+require 'date'
+
+class WhenSun
+  DEFAULT_ZENITH = 90.83333
+  KNOWN_EVENTS = [:rise, :set]
+
+  # Helper method: calculates sunrise, with the same parameters as calculate
+  def self.rise(date, latitude, longitude, options = {})
+    calculate(:rise, date, latitude, longitude, options)
+  end
+
+  # Helper method: calculates sunset, with the same parameters as calculate
+  def self.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 self.calculate(event, date, latitude, longitude, options = {})
+    raise "Unknown event '#{ event }'" unless KNOWN_EVENTS.include?(event)
+    zenith = options.delete(:zenith) || DEFAULT_ZENITH
+
+    # lngHour
+    longitude_hour = longitude / 15.0
+
+    # 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 / 15.0
+
+    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 / 15.0
+
+    # 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
+
+    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 self.degrees_to_radians(d)
+    d.to_f / 360.0 * 2.0 * Math::PI
+  end
+
+  def self.radians_to_degrees(r)
+    r.to_f * 360.0 / (2.0 * Math::PI)
+  end
+
+  def self.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/helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'when_sun'
+

data/test/test_when_sun.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'when_sun'
+
+class TestWhenSun < Test::Unit::TestCase
+
+  def test_rise_20100308_pontassieve
+    rise = WhenSun.calculate(:rise, Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(rise.to_i, 1268026793)
+  end
+
+  def test_set_20100308_pontassieve
+    rise = WhenSun.calculate(:set, Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(rise.to_i, 1268068276)
+  end
+
+  def test_rise_helper
+    rise = WhenSun.rise(Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(rise.to_i, 1268026793)
+  end
+
+  def test_set_helper
+    rise = WhenSun.set(Date.new(2010, 3, 8), 43.779, 11.432)
+    assert_equal(rise.to_i, 1268068276)
+  end
+
+  def test_midnight_sun_on_20100621_north_cape
+    rise = WhenSun.calculate(:rise, Date.new(2010, 6, 21), 71.170219, 25.785556)
+    assert_nil(rise)
+    set = WhenSun.calculate(:set, Date.new(2010, 6, 21), 71.170219, 25.785556)
+    assert_nil(set)
+  end
+
+  def test_unknown_event
+    assert_raise(RuntimeError) { WhenSun.calculate(:foo, Date.new(2010, 3, 8), 43.779, 11.432) }
+  end
+
+end

data/when_sun.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{when_sun}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Cranston"]
+  s.date = %q{2011-08-18}
+  s.description = %q{WhenSun is a RubyGem for calculating the sunrise and sunset for locations based on the date, latitude and longitude.}
+  s.email = %q{ecranston@enphaseenergy.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/when_sun.rb",
+    "test/helper.rb",
+    "test/test_when_sun.rb",
+    "when_sun.gemspec"
+  ]
+  s.homepage = %q{http://github.com/cracell/when_sun}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{WhenSun is a RubyGem for calculating the sunrise and sunset for locations based on the date, latitude and longitude.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: when_sun
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eric Cranston
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id002
+  prerelease: false
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  name: rcov
+description: WhenSun is a RubyGem for calculating the sunrise and sunset for locations based on the date, latitude and longitude.
+email: ecranston@enphaseenergy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/when_sun.rb
+- test/helper.rb
+- test/test_when_sun.rb
+- when_sun.gemspec
+has_rdoc: true
+homepage: http://github.com/cracell/when_sun
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: WhenSun is a RubyGem for calculating the sunrise and sunset for locations based on the date, latitude and longitude.
+test_files: []
+