ruby-sun-times 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ff22355b53b8e849bdb6620d1e51552a72840e0
+  data.tar.gz: ce1cccf30fa5f6461918853588010f534a2f3ffc
+SHA512:
+  metadata.gz: 6c9c521a94cf297ab45fd32ba1f87dfe64b0beac36b1ad89c6d870e477fbb3c7a3d7248070b04d23f4abce20d188a6d61baa873d10dceb5d9c44b97fe2fe42b9
+  data.tar.gz: 96b2cec093ae213b771179cdc9939b03d151a7c0d0e3b2093be39dbb90c4d58c3100b876014970acdd8b67be000de2d66fce9947986d21177da47ee0505d1cd0

data/.gitignore

@@ -0,0 +1,3 @@
+doc/*
+pkg/*
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Rakefile

@@ -1,48 +1,9 @@
 require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/testtask'
-require 'rake/clean'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-$:.unshift(File.dirname(__FILE__) + '/lib')
-require 'sun_times'
+task :default => :spec
 
-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 = 'ruby-sun-times'
-  s.summary = 'Module which calculates sunrise and sunset times'
-  s.version = SunTimes::VERSION::STRING
-
-  s.homepage = 'http://github.com/joeyates/ruby-sun-times'
-  s.author = 'Joe Yates'
-  s.email = 'joe.g.yates@gmail.com'
-
-  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|
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
 end

data/lib/sun_times.rb

@@ -26,26 +26,17 @@
 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 = {})
+  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 SunTimes.set(date, latitude, longitude, options = {})
+  def self.set(date, latitude, longitude, options = {})
     calculate(:set, date, latitude, longitude, options)
   end
 
@@ -53,7 +44,7 @@ module SunTimes
   #
   # ==== Parameters
   # * +event+ - One of :rise, :set.
-  # * +date+ - An object that responds to yday.
+  # * +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>.
@@ -61,7 +52,8 @@ module SunTimes
   # ==== 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 = {})
+  def self.calculate(event, date, latitude, longitude, options = {})
+    datetime = date.to_datetime
     raise "Unknown event '#{ event }'" if KNOWN_EVENTS.find_index(event).nil?
     zenith = options.delete(:zenith) || DEFAULT_ZENITH
 
@@ -70,7 +62,7 @@ module SunTimes
 
     # t
     base_time = event == :rise ? 6.0 : 18.0
-    approximate_time = date.yday + (base_time - longitude_hour) / 24.0
+    approximate_time = datetime.yday + (base_time - longitude_hour) / 24.0
 
     # M
     mean_sun_anomaly = (0.9856 * approximate_time) - 3.289
@@ -126,24 +118,15 @@ module SunTimes
     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
+    offset_hours = datetime.offset * 24.0
 
-    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
+    if gmt_hours + offset_hours < 0
+      next_day = datetime.next_day
+      return calculate(event, next_day.new_offset, latitude, longitude, options = {})
+    end
+    if gmt_hours + offset_hours > 24
+      previous_day = datetime.prev_day
+      return calculate(event, previous_day.new_offset, latitude, longitude, options = {})
     end
 
     hour = gmt_hours.floor
@@ -151,20 +134,20 @@ module SunTimes
     minute = hour_remainder.floor
     seconds = (hour_remainder - minute) * 60.0
 
-    Time.gm(date.year, date.month, date.day, hour, minute, seconds)
+    Time.gm(datetime.year, datetime.month, datetime.day, hour, minute, seconds)
   end
 
   private
 
-  def SunTimes.degrees_to_radians(d)
+  def self.degrees_to_radians(d)
     d.to_f / 360.0 * 2.0 * Math::PI
   end
 
-  def SunTimes.radians_to_degrees(r)
+  def self.radians_to_degrees(r)
     r.to_f * 360.0 / (2.0 * Math::PI)
   end
 
-  def SunTimes.coerce_degrees(d)
+  def self.coerce_degrees(d)
     if d < 0
       d += 360
       return coerce_degrees(d)
@@ -175,5 +158,4 @@ module SunTimes
     end
     d
   end
-
 end

data/lib/sun_times/version.rb

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

data/ruby-sun-times.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.unshift(File.expand_path('../lib/', __FILE__))
+
+require 'sun_times/version'
+
+Gem::Specification.new do |s|
+  s.name = 'ruby-sun-times'
+  s.summary = 'Module which calculates sunrise and sunset times'
+  s.version = SunTimes::VERSION::STRING
+
+  s.homepage = 'https://github.com/joeyates/ruby-sun-times'
+  s.author = 'Joe Yates'
+  s.email = 'joe.g.yates@gmail.com'
+
+  s.files = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^spec/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'sun_times'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered   = true
+  config.filter_run                         :focus
+  config.order                              = 'random'
+end

data/spec/unit/ruby_sun_times_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe SunTimes do
+  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) }
+
+  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)
+      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)
+      end
+    end
+
+    context 'unknown event' do
+      it 'fails' do
+        expect {
+          SunTimes.calculate(:foo, day, latitude, longitude)
+        }.to raise_error(RuntimeError, /unknown event/i)
+      end
+    end
+
+    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)
+        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
+
+    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)
+        expect(result).to be_nil
+      end
+
+      it 'set is nil' do
+        result = SunTimes.calculate(:set, midsummer, latitude, longitude)
+        expect(result).to be_nil
+      end
+    end
+
+    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
+  end
+
+  describe '#rise' do
+    it 'returns the sunrise time' do
+      result = SunTimes.rise(day, latitude, longitude)
+      expect(result).to be_within(1).of(rise)
+    end
+  end
+
+  describe '#set' do
+    it 'returns the sunset time' do
+      result = SunTimes.set(day, latitude, longitude)
+      expect(result).to be_within(1).of(set)
+    end
+  end
+end

data/test/calculate_test.rb

@@ -6,37 +6,7 @@ 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
-
+=begin
   def test_time
     datetime = Time.gm(2010, 6, 13, 0, 0, 0)
     set = SunTimes.calculate(:set, datetime, 43.779, 11.432)
@@ -49,12 +19,7 @@ class SunTimesTest < Test::Unit::TestCase
     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)
+  def test_31st_december
   end
-
+=end
 end

metadata

@@ -1,66 +1,86 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-sun-times
-version: !ruby/object:Gem::Version 
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.1.3
 platform: ruby
-authors: 
+authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-20 00:00:00 +00:00
-default_executable: 
-dependencies: []
-
+date: 2014-01-01 00:00:00.000000000 Z
+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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: joe.g.yates@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
 - COPYING
-files: 
+- Gemfile
 - README
-- COPYING
 - 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
-has_rdoc: true
-homepage: http://github.com/joeyates/ruby-sun-times
+homepage: https://github.com/joeyates/ruby-sun-times
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --quiet
-- --title
-- Sun Times Calculator
-- --main
-- README
-- --inline-source
-require_paths: 
+rdoc_options: []
+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: 
+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'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Module which calculates sunrise and sunset times
-test_files: 
-- test/test_all.rb
+test_files:
+- spec/spec_helper.rb
+- spec/unit/ruby_sun_times_spec.rb
+has_rdoc: