lunartic 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lunartic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian O'Keefe
+
+MIT License
+
+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.md

@@ -0,0 +1,54 @@
+# Lunartic
+
+Calculate the approximate phase of the moon on a given date.
+
+Note: Calculations are currently *very* approximate and will be improved shortly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lunartic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lunartic
+
+## Usage
+
+You can get the `day` (day within a cycle, 0..28), `percent_full` (0..1), and `phase` (a symbol) of the moon on a given day like so:
+
+~~~ ruby
+irb(main):001:0> require 'lunartic'
+  => true
+
+# get moon data for today
+irb(main):002:0> moon = Lunartic.now
+  => #<Lunartic::Moon:0x007fa5028e4dc0 @date=#<Date: 2014-06-25 ((2456834j,0s,0n),+0s,2299161j)>>
+irb(main):003:0> moon.day
+  => 27
+irb(main):004:0> moon.phase
+  => :waning_crescent
+irb(main):005:0> moon.percent_full
+  => 0.17138763236974325
+
+# or, get moon data for a given Date
+irb(main):006:0> Lunartic.on_date(Date.new(1989, 12, 28)).phase
+  => :new
+~~~
+
+## Testing
+
+    $ rake spec
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lunartic.rb

@@ -0,0 +1,15 @@
+require 'date'
+require 'lunartic/version'
+require 'lunartic/moon'
+
+module Lunartic
+  class << self
+    def now
+      Lunartic::Moon.new Date.today
+    end
+
+    def on_date(date)
+      Lunartic::Moon.new date
+    end
+  end
+end

data/lib/lunartic/moon.rb

@@ -0,0 +1,48 @@
+module Lunartic
+  class Moon
+    attr_reader :date
+
+    # TODO: we can achieve greater accuracy by adding more
+    # known new moon dates and using the closest one
+    KNOWN_NEW_MOON = Date.new 1900, 1, 1
+
+    SYNODIC_MONTH = 29.530588853
+    HALF_SYNODIC_MONTH = 29.530588853 / 2
+    SYNODIC_DAY = 1 / 29.530588853
+
+    def initialize(date)
+      @date = date
+    end
+
+    def day
+      day = ((@date.jd - KNOWN_NEW_MOON.jd) % SYNODIC_MONTH).floor
+      return 0 if day >= SYNODIC_MONTH.floor
+      day
+    end
+
+    def percent_full
+      (HALF_SYNODIC_MONTH - (day - HALF_SYNODIC_MONTH).abs) / HALF_SYNODIC_MONTH
+    end
+
+    def phase
+      case day
+      when 0
+        :new
+      when 1..6
+        :waxing_crescent
+      when 7
+        :first_quarter
+      when 8..14
+        :waxing_gibbous
+      when 15
+        :full
+      when 16..21
+        :waning_gibbous
+      when 22
+        :last_quarter
+      when 23..28
+        :waning_crescent
+      end
+    end
+  end
+end

data/lib/lunartic/version.rb

@@ -0,0 +1,3 @@
+module Lunartic
+  VERSION = "0.1.0"
+end

data/lunartic.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lunartic/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'lunartic'
+  gem.version       = Lunartic::VERSION
+  gem.authors       = ["Brian O'Keefe"]
+  gem.email         = ['brian@bokstuff.com']
+  gem.summary       = %q{Calculate the approximate phase of the moon on a given date}
+  gem.description   = gem.summary
+  gem.homepage      = 'https://github.com/brianokeefe/lunartic'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rspec', '~> 3.0.0'
+end

data/spec/fixtures/moon.yml

@@ -0,0 +1,69 @@
+- date_year: 1989
+  date_month: 12
+  date_day: 27
+  day: 28
+  phase: :waning_crescent
+  percent_full: 0.10366124838343745
+
+- date_year: 1989
+  date_month: 12
+  date_day: 28
+  day: 0
+  phase: :new
+  percent_full: 0.0
+
+- date_year: 1989
+  date_month: 12
+  date_day: 31
+  day: 3
+  phase: :waxing_crescent
+  percent_full: 0.20317915195891742
+
+- date_year: 1990
+  date_month: 1
+  date_day: 4
+  day: 7
+  phase: :first_quarter
+  percent_full: 0.47408468790414066
+
+- date_year: 1990
+  date_month: 1
+  date_day: 7
+  day: 10
+  phase: :waxing_gibbous
+  percent_full: 0.677263839863058
+
+- date_year: 1990
+  date_month: 1
+  date_day: 12
+  day: 15
+  phase: :full
+  percent_full: 0.9841042402054129
+
+- date_year: 1990
+  date_month: 1
+  date_day: 15
+  day: 18
+  phase: :waning_gibbous
+  percent_full: 0.7809250882464955
+
+- date_year: 1990
+  date_month: 1
+  date_day: 19
+  day: 22
+  phase: :last_quarter
+  percent_full: 0.5100195523012723
+
+- date_year: 1990
+  date_month: 1
+  date_day: 22
+  day: 25
+  phase: :waning_crescent
+  percent_full: 0.3068404003423549
+
+- date_year: 1990
+  date_month: 1
+  date_day: 26
+  day: 0
+  phase: :new
+  percent_full: 0.0

data/spec/lunartic_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Lunartic do
+  describe '.now' do
+    let(:subject) { Lunartic.now }
+
+    it 'should return a Lunartic::Moon' do
+      expect(subject).to be_a Lunartic::Moon
+    end
+
+    it "should create a Lunartic::Moon using today's date" do
+      expect(subject.day).to eql Lunartic::Moon.new(Date.today).day
+    end
+  end
+
+  describe '.on_date' do
+    let(:subject) { Lunartic.on_date(Date.new(1989, 12, 28)) }
+
+    it 'should return a Lunartic::Moon' do
+      expect(subject).to be_a Lunartic::Moon
+    end
+
+    it 'should create a Lunartic::Moon using the specified date' do
+      expect(subject.day).to eql Lunartic::Moon.new(Date.new(1989, 12, 28)).day
+    end
+  end
+end

data/spec/moon_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Lunartic::Moon do
+  let(:subject) { Lunartic::Moon.new(Date.new(1989, 12, 28)) }
+
+  describe '#initialize' do
+    it 'should return a Lunartic::Moon' do
+      expect(subject).to be_a Lunartic::Moon
+    end
+  end
+
+  describe '#day' do
+    it 'should return a fixnum' do
+      expect(subject.day).to be_a Fixnum
+    end
+
+    it 'should return the correct cycle day for the given date' do
+      test_method_against_fixtures :day
+    end
+  end
+
+  describe '#percent_full' do
+    it 'should return a float' do
+      expect(subject.percent_full).to be_a Float
+    end
+
+    it 'should return the correct percentage full for the given date' do
+      test_method_against_fixtures :percent_full
+    end
+  end
+
+  describe '#phase' do
+    it 'should return a symbol' do
+      expect(subject.phase).to be_a Symbol
+    end
+
+    it 'should return the correct moon phase for a given date' do
+      test_method_against_fixtures :phase
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'lunartic'
+require 'yaml'
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+  config.formatter = :documentation
+end
+
+FIXTURES = YAML.load_file("#{File.dirname __FILE__}/fixtures/moon.yml").map do |obj|
+  sym_hash = {}
+  obj.each_pair do |k,v|
+    sym_hash[k.to_sym] = v
+  end
+  sym_hash
+end
+
+def test_method_against_fixtures(method)
+  FIXTURES.each do |known|
+    date = Date.new(known[:date_year], known[:date_month], known[:date_day])
+    moon = Lunartic::Moon.new date
+    expect(moon.send(method)).to eql known[method]
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: lunartic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian O'Keefe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Calculate the approximate phase of the moon on a given date
+email:
+- brian@bokstuff.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lunartic.rb
+- lib/lunartic/moon.rb
+- lib/lunartic/version.rb
+- lunartic.gemspec
+- spec/fixtures/moon.yml
+- spec/lunartic_spec.rb
+- spec/moon_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brianokeefe/lunartic
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Calculate the approximate phase of the moon on a given date
+test_files:
+- spec/fixtures/moon.yml
+- spec/lunartic_spec.rb
+- spec/moon_spec.rb
+- spec/spec_helper.rb