ruby-sun-times 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ff22355b53b8e849bdb6620d1e51552a72840e0
-  data.tar.gz: ce1cccf30fa5f6461918853588010f534a2f3ffc
+  metadata.gz: ecb13177df09644d48fc75563740cec84495ce00
+  data.tar.gz: c9002e7be0138db8ba4409844d97f7ecab102187
 SHA512:
-  metadata.gz: 6c9c521a94cf297ab45fd32ba1f87dfe64b0beac36b1ad89c6d870e477fbb3c7a3d7248070b04d23f4abce20d188a6d61baa873d10dceb5d9c44b97fe2fe42b9
-  data.tar.gz: 96b2cec093ae213b771179cdc9939b03d151a7c0d0e3b2093be39dbb90c4d58c3100b876014970acdd8b67be000de2d66fce9947986d21177da47ee0505d1cd0
+  metadata.gz: 7b0a05c96603d12fcc58821a79b39ccc74a7f0b7034540b32c5aafba39cd41035dc330bb10eadcceefd4a4a8f11be523c6678901b0d600ee964d2e47a1ff1dee
+  data.tar.gz: 35671f27cd9a50ca1e1db445021a870bf87abb13257c544acd169e1c2a09c15088b7b7a2a26672a6d83c0060d42867729654d9e80efcbf7f973c472b96434735

data/{README → README.md}

@@ -1,20 +1,47 @@
-== SunTimes
+# SunTimes
 
 Calculates sunrise and sunset times.
 
 An implementation of the algorithm descibed at http://williams.best.vwh.net/sunrise_sunset_algorithm.htm
 
-== References
+# Usage
+
+## Requiring
+
+In a Gemfile/Gemspec:
+
+```
+gem 'ruby-sun-times', require: 'sun_times'
+```
+
+Directly:
+
+```ruby
+require 'sun_times'
+```
+
+## Calls
+
+There are two helper methods: 'rise' and 'set'.
+
+```
+day = Date.new(2010, 3, 8)
+latitude = 43.779
+longitude = 11.432
+puts SunTimes.set(day, latitude, longitude)
+```
+
+# 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
+# Licence
 
 This code is free to use under the terms of the MIT licence:
 
-  Copyright (c) 2010 Joe Yates
+  Copyright (c) 2010 - 2013 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

data/lib/sun_times.rb

@@ -47,15 +47,22 @@ module SunTimes
   # * +date+ - An object that responds to :to_datetime.
   # * +latitude+ - The latitude of the location in degrees.
   # * +longitude+ - The longitude of the location in degrees.
-  # * +options+ - Additional option is <tt>:zenith</tt>.
+  # * +options+ -
+  #   * <tt>:never_rises_result</tt> - the value to be returned if the sun never rises on the supplied date,
+  #   * <tt>:never_sets_result</tt> - the value to be returned if the sun never sets on the supplied date,
+  #   * <tt>:zenith</tt> - default 90.83333
   #
   # ==== 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 = {})
+    options = {
+      :never_sets_result  => nil,
+      :never_rises_result => nil,
+      :zenith             => DEFAULT_ZENITH,
+    }.merge(options)
     datetime = date.to_datetime
     raise "Unknown event '#{ event }'" if KNOWN_EVENTS.find_index(event).nil?
-    zenith = options.delete(:zenith) || DEFAULT_ZENITH
 
     # lngHour
     longitude_hour = longitude / DEGREES_PER_HOUR
@@ -91,13 +98,13 @@ module SunTimes
     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)))) /
+      (Math.cos(degrees_to_radians(options[: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
+    return options[:never_rises_result] 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
+    return options[:never_sets_result] if cos_local_hour_angle < -1
 
     # H
     suns_local_hour =

data/lib/sun_times/version.rb

@@ -2,7 +2,7 @@ module SunTimes
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/unit/ruby_sun_times_spec.rb

@@ -6,6 +6,10 @@ describe SunTimes do
   let(:longitude) { 11.432 }
   let(:rise) { Time.gm(2010, 3, 8, 5, 39, 53) }
   let(:set) { Time.gm(2010, 3, 8, 17, 11, 16) }
+  let(:midsummer) { Date.new(2010, 6, 21) }
+  let(:midwinter) { Date.new(2010, 12, 21) }
+  let(:north_cape_latitude) { 71.170219 }
+  let(:north_cape_longitude) { 25.785556 }
 
   describe '#calculate' do
     context ':rise' do
@@ -44,18 +48,13 @@ describe SunTimes do
     end
 
     context 'midnight sun' do
-      # North Cape
-      let(:midsummer) { Date.new(2010, 6, 21) }
-      let(:latitude) { 71.170219 }
-      let(:longitude) { 25.785556 }
-
       it 'rise is nil' do
-        result = SunTimes.calculate(:rise, midsummer, latitude, longitude)
+        result = SunTimes.calculate(:rise, midsummer, north_cape_latitude, north_cape_longitude)
         expect(result).to be_nil
       end
 
       it 'set is nil' do
-        result = SunTimes.calculate(:set, midsummer, latitude, longitude)
+        result = SunTimes.calculate(:set, midsummer, north_cape_latitude, north_cape_longitude)
         expect(result).to be_nil
       end
     end
@@ -68,6 +67,22 @@ describe SunTimes do
         SunTimes.calculate(:set, day, 47.5, -122)
       end
     end
+
+    context 'options' do
+      context ':never_rises_result' do
+        it 'uses the supplied value, instead of nil' do
+          result = SunTimes.calculate(:rise, midwinter, north_cape_latitude, north_cape_longitude, {:never_rises_result => :never_rises})
+          expect(result).to eq(:never_rises)
+        end
+      end
+
+      context ':never_sets_result' do
+        it 'uses the supplied value, instead of nil' do
+          result = SunTimes.calculate(:rise, midsummer, north_cape_latitude, north_cape_longitude, {:never_sets_result => :never_sets})
+          expect(result).to eq(:never_sets)
+        end
+      end
+    end
   end
 
   describe '#rise' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-sun-times
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Joe Yates
@@ -48,15 +48,13 @@ files:
 - .rspec
 - COPYING
 - Gemfile
-- README
+- README.md
 - Rakefile
 - lib/sun_times.rb
 - lib/sun_times/version.rb
 - ruby-sun-times.gemspec
 - spec/spec_helper.rb
 - spec/unit/ruby_sun_times_spec.rb
-- test/calculate_test.rb
-- test/test_all.rb
 homepage: https://github.com/joeyates/ruby-sun-times
 licenses: []
 metadata: {}

data/test/calculate_test.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'test/unit'
-require 'sun_times'
-require 'date'
-
-class SunTimesTest < Test::Unit::TestCase
-
-=begin
-  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_31st_december
-  end
-=end
-end

data/test/test_all.rb

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