ruby-sun-times 0.1.4 → 0.1.5

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+script: "bundle exec rspec"
+cache: bundler

data/README.md

@@ -1,6 +1,16 @@
-# SunTimes
+# ruby-sun-times [![Build Status](https://travis-ci.org/joeyates/ruby-sun-times.png?branch=master)][Continuous Integration]
 
-Calculates sunrise and sunset times.
+*Calculates sunrise and sunset times*
+
+  * [Source Code]
+  * [API documentation]
+  * [Rubygem]
+  * [Continuous Integration]
+
+[Source Code]: https://github.com/joeyates/ruby-sun-times "Source code at GitHub"
+[API documentation]: http://rubydoc.info/gems/ruby-sun-times/frames "RDoc API Documentation at Rubydoc.info"
+[Rubygem]: http://rubygems.org/gems/ruby-sun-times "Ruby gem at rubygems.org"
+[Continuous Integration]: http://travis-ci.org/joeyates/ruby-sun-times "Build status by Travis-CI"
 
 An implementation of the algorithm descibed at http://williams.best.vwh.net/sunrise_sunset_algorithm.htm
 

data/lib/sun_times.rb

@@ -25,50 +25,75 @@
 
 require 'date'
 
-module SunTimes
+class SunTimes
   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
+  attr_reader :options
+
+  # Deprecated: use SunTimes.new.rise(...)
   def self.rise(date, latitude, longitude, options = {})
-    calculate(:rise, date, latitude, longitude, options)
+    new(options).calculate(:rise, date, latitude, longitude, options)
   end
 
-  # Helper method: calculates sunset, with the same parameters as calculate
+  # Deprecated: use SunTimes.new.set(...)
   def self.set(date, latitude, longitude, options = {})
-    calculate(:set, date, latitude, longitude, options)
+    new(options).calculate(:set, date, latitude, longitude, options)
+  end
+
+  # Deprecated: use SunTimes.new.rise/set(...)
+  def self.calculate(event, date, latitude, longitude, options = {})
+    new(options).calculate(event, date, latitude, longitude)
   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 :to_datetime.
-  # * +latitude+ - The latitude of the location in degrees.
-  # * +longitude+ - The longitude of the location in degrees.
   # * +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 = {
+  def initialize(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?
+  end
+
+  # Calculates the sunrise time for a specific date and location
+  #
+  # ==== Parameters
+  # * +date+ - An object that responds to :to_datetime.
+  # * +latitude+ - The latitude of the location in degrees.
+  # * +longitude+ - The longitude of the location in degrees.
+  #
+  # ==== Example
+  #   SunTimes.new.rise(Date.new(2010, 3, 8), 43.779, 11.432)
+  #   > Mon Mar 08 05:39:53 UTC 2010
+  def rise(date, latitude, longitude)
+    calculate(:rise, date, latitude, longitude)
+  end
+
+  # calculates sunset, see #rise for parameters
+  def set(date, latitude, longitude)
+    calculate(:set, date, latitude, longitude)
+  end
+
+  private
+
+  def calculate(event, date, latitude, longitude)
+    datetime = to_datetime(date)
+    raise "Unknown event '#{event}'" unless KNOWN_EVENTS.include?(event)
 
     # lngHour
     longitude_hour = longitude / DEGREES_PER_HOUR
 
     # t
-    base_time = event == :rise ? 6.0 : 18.0
+    base_time =
+      if event == :rise
+        6.0
+      else
+        18.0
+      end
     approximate_time = datetime.yday + (base_time - longitude_hour) / 24.0
 
     # M
@@ -128,12 +153,12 @@ module SunTimes
     offset_hours = datetime.offset * 24.0
 
     if gmt_hours + offset_hours < 0
-      next_day = datetime.next_day
-      return calculate(event, next_day.new_offset, latitude, longitude, options = {})
+      next_day = next_day(datetime)
+      return calculate(event, next_day.new_offset, latitude, longitude)
     end
     if gmt_hours + offset_hours > 24
-      previous_day = datetime.prev_day
-      return calculate(event, previous_day.new_offset, latitude, longitude, options = {})
+      previous_day = prev_day(datetime)
+      return calculate(event, previous_day.new_offset, latitude, longitude)
     end
 
     hour = gmt_hours.floor
@@ -144,17 +169,49 @@ module SunTimes
     Time.gm(datetime.year, datetime.month, datetime.day, hour, minute, seconds)
   end
 
-  private
+  ############################
+  # ruby 1.8 compatibility
+
+  def to_datetime(date)
+    if date.respond_to?(:to_datetime)
+      date.to_datetime
+    else
+      values = [
+        date.year,
+        date.month,
+        date.day,
+      ]
+      [:hour, :minute, :second, :zone].each do |m|
+        values <<
+          if date.respond_to?(m)
+            date.send(m)
+          else
+            0
+          end
+      end
+      DateTime.new(*values)
+    end
+  end
+
+  def prev_day(datetime)
+    datetime - 1
+  end
+
+  def next_day(datetime)
+    datetime + 1
+  end
+
+  ############################
 
-  def self.degrees_to_radians(d)
+  def degrees_to_radians(d)
     d.to_f / 360.0 * 2.0 * Math::PI
   end
 
-  def self.radians_to_degrees(r)
+  def radians_to_degrees(r)
     r.to_f * 360.0 / (2.0 * Math::PI)
   end
 
-  def self.coerce_degrees(d)
+  def coerce_degrees(d)
     if d < 0
       d += 360
       return coerce_degrees(d)

data/lib/sun_times/version.rb

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

data/spec/unit/ruby_sun_times_spec.rb

@@ -1,101 +1,115 @@
 require 'spec_helper'
 
 describe SunTimes do
+  let(:options) { {} }
   let(:day) { Date.new(2010, 3, 8) }
   let(:latitude) { 43.779 }
   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
-      it 'returns the sunrise time' do
-        result = SunTimes.calculate(:rise, day, latitude, longitude)
-        expect(result).to be_within(1).of(rise)
+  subject { described_class.new(options) }
+
+  shared_examples_for 'never sets and never rises options' do |method|
+    context ':never_rises_result' do
+      let(:options) do
+        {
+          :never_rises_result => :never_rises,
+          :never_sets_result => :never_sets,
+        }
       end
-    end
 
-    context ':set' do
-      it 'returns the sunset time' do
-        result = SunTimes.calculate(:set, day, latitude, longitude)
-        expect(result).to be_within(1).of(set)
+      context 'never rises' do
+        it 'uses the supplied value' do
+          result = subject.send(method, midwinter, north_cape_latitude, north_cape_longitude)
+          expect(result).to eq(:never_rises)
+        end
       end
-    end
 
-    context 'unknown event' do
-      it 'fails' do
-        expect {
-          SunTimes.calculate(:foo, day, latitude, longitude)
-        }.to raise_error(RuntimeError, /unknown event/i)
+      context 'never sets' do
+        it 'uses the supplied value' do
+          result = subject.send(method, midsummer, north_cape_latitude, north_cape_longitude)
+          expect(result).to eq(:never_sets)
+        end
       end
     end
+  end
 
+  shared_examples_for 'timezones' do |method|
     context 'with timezone' do
       let(:zone) { Rational(-8, 24) }
       let(:day_with_zone) { DateTime.new(2011, 12, 13, 0, 0, 0, zone) }
 
       it 'calculates according to the supplied value' do
-        set = SunTimes.calculate(:set, day_with_zone, 45.52, -122.681944)
+        set = subject.send(method, day_with_zone, 45.52, -122.681944)
         result_datetime = DateTime.new(set.year, set.month, set.day, set.hour, set.min, set.sec, 0)
 
         expect(result_datetime).to be > day_with_zone
         expect(result_datetime).to be <= day_with_zone + 1
       end
     end
+  end
 
+  shared_examples_for 'no event' do |method|
     context 'midnight sun' do
-      it 'rise is nil' do
-        result = SunTimes.calculate(:rise, midsummer, north_cape_latitude, north_cape_longitude)
+      it 'is nil' do
+        result = subject.send(method, midsummer, north_cape_latitude, north_cape_longitude)
         expect(result).to be_nil
       end
+    end
 
-      it 'set is nil' do
-        result = SunTimes.calculate(:set, midsummer, north_cape_latitude, north_cape_longitude)
+    context 'continuous night' do
+      it 'is nil' do
+        result = subject.send(method, midwinter, north_cape_latitude, north_cape_longitude)
         expect(result).to be_nil
       end
     end
+  end
 
+  shared_examples_for 'limiting cases' do |method|
     context 'last day of the year' do
       let(:zone) { Rational(-8, 24) }
       let(:day) { DateTime.new(2013, 12, 31, 8, 59, 5, zone) }
 
       it 'calculates correctly' 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
+        subject.send(method, day, 47.5, -122)
       end
     end
   end
 
   describe '#rise' do
+    let(:rise) { Time.gm(2010, 3, 8, 5, 39, 53) }
+
     it 'returns the sunrise time' do
-      result = SunTimes.rise(day, latitude, longitude)
+      result = subject.rise(day, latitude, longitude)
       expect(result).to be_within(1).of(rise)
     end
+
+    include_examples 'timezones', :rise
+    include_examples 'limiting cases', :rise
+    include_examples 'no event', :rise
+
+    context 'options' do
+      include_examples 'never sets and never rises options', :rise
+    end
   end
 
   describe '#set' do
+    let(:set) { Time.gm(2010, 3, 8, 17, 11, 16) }
+
     it 'returns the sunset time' do
-      result = SunTimes.set(day, latitude, longitude)
+      result = subject.set(day, latitude, longitude)
       expect(result).to be_within(1).of(set)
     end
+
+    include_examples 'timezones', :set
+    include_examples 'limiting cases', :set
+    include_examples 'no event', :rise
+
+    context 'options' do
+      include_examples 'never sets and never rises options', :set
+    end
   end
 end

metadata

@@ -1,51 +1,63 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ruby-sun-times
-version: !ruby/object:Gem::Version
-  version: 0.1.4
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 5
+  version: 0.1.5
 platform: ruby
-authors:
+authors: 
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-01-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: 
 email: joe.g.yates@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
+- .travis.yml
 - COPYING
 - Gemfile
 - README.md
@@ -55,30 +67,40 @@ files:
 - ruby-sun-times.gemspec
 - spec/spec_helper.rb
 - spec/unit/ruby_sun_times_spec.rb
+has_rdoc: true
 homepage: https://github.com/joeyates/ruby-sun-times
 licenses: []
-metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+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: 2.0.3
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Module which calculates sunrise and sunset times
-test_files:
+test_files: 
 - spec/spec_helper.rb
 - spec/unit/ruby_sun_times_spec.rb
-has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: ecb13177df09644d48fc75563740cec84495ce00
-  data.tar.gz: c9002e7be0138db8ba4409844d97f7ecab102187
-SHA512:
-  metadata.gz: 7b0a05c96603d12fcc58821a79b39ccc74a7f0b7034540b32c5aafba39cd41035dc330bb10eadcceefd4a4a8f11be523c6678901b0d600ee964d2e47a1ff1dee
-  data.tar.gz: 35671f27cd9a50ca1e1db445021a870bf87abb13257c544acd169e1c2a09c15088b7b7a2a26672a6d83c0060d42867729654d9e80efcbf7f973c472b96434735