VanaTime 2.0.0 → 2.1.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 2.1.0 / 2007-09-17
+
+* ok, the previous callback system was retarded. rewritten again to not suck
+  moved from ruby observer to RubyBean
+  added skillup calculator support
+
 == 2.0.0 / 2007-09-08
 
 * rewritten to support a callback based arch, added element information,

data/Manifest

@@ -4,10 +4,13 @@ LICENSE
 lib/vana_time.rb
 lib/Vana/time_manager.rb
 lib/Vana/time.rb
+lib/Vana/skillup_calculator.rb
 lib/Vana/moon_countdown.rb
 lib/Vana/moon.rb
 lib/Vana/element.rb
 lib/Vana/day.rb
 lib/Vana/constants.rb
 lib/Vana/common.rb
+lib/util/ruby_bean.rb
+lib/util/log_listener.rb
 CHANGELOG

data/README

@@ -1,7 +1,7 @@
-VanaTime 2.0.0 README
+VanaTime 2.1.0 README
 =====================
 
-This document was last updated on Sat Sep  8 13:41:50 EDT 2007.
+This document was last updated on Mon Sep 17 23:09:51 EDT 2007.
 
 
 Introduction to VanaTime
@@ -19,103 +19,98 @@ you may want to use explicit versioning in any code depending on it.
 FFXI::TimeManager
 =================
 
-This will probably be the only class you end up using. It wraps everything
-else up in a convenient callback system that keeps things in sync, only
-does updates when necessary, and fires off your code on events. Huzzah! Here's
-a quick example text clock:
-
-include FFXI::Constants
-tm = FFXI::TimeManager.now
-tm.callback(MS_SECOND) {|time| puts "Vana'diel Time: #{time}" }
-loop {tm.earth_time=(Time.now) ; sleep 0.04}
-
-If you want to manage existing VanaTime, VanaDay, and VanaMoon objects you
-can create a blank TimeManager and call manage on them:
-
-tm = FFXI::TimeManager.new
-tm.manage(time, day, moon)
-
-The following are the supported events for adding callbacks:
-
-MS_SECOND
-MS_MINUTE
-MS_HOUR
-MS_DAY
-MS_MONTH
-MS_YEAR
-day (of the week, fires off seperately from MS_DAY)
-moon_days
-moon_percent
-moon_phase
-next_optimal_phase
-next_phase_countdown
-optimal_phase_countdown
-
-FFXI::VanaTime API
-==================
-
-  * new(Time)
-      accepts a Time object to initialize a new VanaTime
-  * now
-      calls new with Time.now
-  * at(VanaTime)
-      accepts a VanaTime object, int, or float representing vana time to
-      initialize a new VanaTime object
-  * earth_time=(Time)
-      allows re-initializing a VanaTime object with a new earth time
-  * vana_time=(VanaTime)
-      allows re-initializing a VanaTime object with a new vana time, given
-      as a VanaTime object (why not >_>), or (more useful) an int or float
-  * to_i
-      returns an integer with the internal representation of vana time
-  * to_f
-      returns a float with the internal representation of vana time without
-      losing any accuracy
-  * year
-  * year_start
-  * month
-  * month_start
-  * date
-  * date_start
-  * tomorrow
-  * hour
-  * hour_start
-  * minute
-  * minute_start
-  * second
-  * second_start
-      these methods return various times, what we're interested in
-  * to_s
-      returns a string in the format:
-      YYYY-MM-DD hh:mm:ss
-  * time_string
-      returns just the time portion of to_s
-  * date_string
-      returns just the date portion of to_s
-
-FFXI::VanaDay API
-=================
+This will probably be the only class you end up using directly. It wraps
+everything else up in a convenient cascading update system that keeps things
+in sync, only does updates when necessary, and provides callbacks for firing
+off your code on events. Huzzah! Callbacks have access to the instance of
+TimeManager that fired the callback (in case you need access to values other
+than the property you're installing the callback for), the old value for the
+property, and the new value for the property. Cascading updates are enabled by
+enable_cascading_updates and disabled by disable_cascading_updates.
+
+Here's a quick example text clock:
+
+  tm = FFXI::TimeManager.new
+  tm.callback(:time_string) {|m,old,new| puts "Time: #{new}"}
+  tm.callback(:next_phase_countdown_string) do |manager, old, new|
+    puts "Countdown until #{manager.moon.next_phase}: #{new}"
+  end
+  tm.enable_cascading_updates
+  loop {tm.update_earth_time(Time.now) ; sleep 0.5}
+
+If you want to manage existing VanaTime, VanaDay, and etc you can pass these as
+options on init, and any objects not passed in will be created for you. The
+name for the option will be similar to the class name:
+
+  tm = FFXI::TimeManager.new(:vana_time => FFXI::VanaTime.now)
+
+Note that you can have as many TimeManager objects as you want or need for the
+same set of vanatime objects, as long as only one of them has cascading
+updates enabled.
+
+The following are the supported properties for adding callbacks, along with the
+classes that define them (with the more interesting properties first):
+
+=====> VanaTime
+  :time_string
+  :date_string
+  :earth_time
+  :vana_time
+  :tomorrow
+  :year
+  :month
+  :date
+  :hour
+  :minute
+  :second
+  :year_start
+  :month_start
+  :date_start
+  :hour_start
+  :minute_start
+  :second_start
+
+=====> VanaDay
+  :day_html
+  :day_string
+  :day
+  :day_element
+  :day_weakness
+  :day_strength
+
+=====> VanaMoon
+  :moon_string
+  :moon_percent_string
+  :moon_phase_name
+  :moon_phase_short_name
+  :next_phase_name
+  :next_phase_short_name
+  :optimal_phase_name
+  :optimal_phase_short_name
+  :next_phase_target
+  :optimal_phase_target
+  :moon_phase
+  :moon_percent
+  :moon_days
+
+=====> VanaMoonCountdown
+  :next_phase_countdown_string
+  :optimal_phase_countdown_string
+  :next_phase_countdown
+  :optimal_phase_countdown
+
+=====> SkillupCalculator
+  :skillup_difficulty
+  :base_difficulty
+  :moon_phase_factor
+  :day_crystal_factor
 
-  * new(VanaTime)
-      accepts a VanaTime object used to initialize the vana day, using a new
-      VanaTime initialized to the current time if one isn't passed
-  * vana_time=(VanaTime)
-      used to reinitialize the vana day object with a new time
-  * to_i
-      returns a base zero number representing the day of the week
-  * to_s
-      returns the name of the day of the week
-  * to_html
-      returns the day's name in a font tag with the day's color
-  * element
-      returns an Element object with the current day's element
-  * weakness
-      returns an Element object with the current day's elemental weakness
 
 FFXI::ElementFactory::Element
 =============================
 
   * name
+  * direction
   * strength
   * weakness
   * color
@@ -124,37 +119,12 @@ FFXI::ElementFactory::Element
   * ninjutsu
   * avatar
 
-FFXI::VanaMoon API
-==================
-
-  * new(Time)
-      Unlike VanaDay, VanaMoon is initialized with earth time
-  * now
-      calls new with the current time
-  * to_i
-      returns a number representing the exact position along the progression
-      of moon phases
-  * percent
-      returns the absolute value of the percentage formatted
-  * phase
-      returns the name of the current moon phase
-  * to_s
-      returns a string in the format: moon_percent.abs phase_name
-  * next_phase
-      returns the name of the next moon phase
-  * optimal_phase
-      returns the name of the next optimal moon phase
-
-FFXI::VanaMoonCountdown API
+
+FFXI::SkillupCalculator API
 ===========================
 
-  * to_next_array
-      returns an array containing the days, hours, minutes, and seconds until
-      the next moon phase
-  * to_next
-      returns a formatted countdown until the next moon phase
-  * to_optimal_array
-      returns an array containing the days, hours, minutes, and seconds until
-      the next optimal moon phase
-  * to_optimal
-      returns a formatted countdown until the next optimal moon phase
+  * crystal_element=(element)
+  * recipe_cap=(cap)
+  * skill=(skill)
+
+All other details are handled by cascading updates via TimeManager.

data/VanaTime.gemspec

@@ -1,11 +1,11 @@
 
-# Gem::Specification for Vanatime-2.0.0
+# Gem::Specification for Vanatime-2.1.0
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{VanaTime}
-  s.version = "2.0.0"
-  s.date = %q{2007-09-08}
+  s.version = "2.1.0"
+  s.date = %q{2007-09-18}
   s.summary = %q{A library for converting realtime to vanadiel time}
   s.email = %q{ttilley@gmail.com}
   s.homepage = %q{http://vanatime.rubyforge.org/}
@@ -13,30 +13,30 @@ Gem::Specification.new do |s|
   s.description = %q{A library for converting realtime to vanadiel time}
   s.has_rdoc = true
   s.authors = ["Travis Tilley"]
-  s.files = ["README", "Manifest", "LICENSE", "lib/vana_time.rb", "lib/Vana/time_manager.rb", "lib/Vana/time.rb", "lib/Vana/moon_countdown.rb", "lib/Vana/moon.rb", "lib/Vana/element.rb", "lib/Vana/day.rb", "lib/Vana/constants.rb", "lib/Vana/common.rb", "CHANGELOG", "VanaTime.gemspec"]
+  s.files = ["README", "Manifest", "LICENSE", "lib/vana_time.rb", "lib/Vana/time_manager.rb", "lib/Vana/time.rb", "lib/Vana/skillup_calculator.rb", "lib/Vana/moon_countdown.rb", "lib/Vana/moon.rb", "lib/Vana/element.rb", "lib/Vana/day.rb", "lib/Vana/constants.rb", "lib/Vana/common.rb", "lib/util/ruby_bean.rb", "lib/util/log_listener.rb", "CHANGELOG", "VanaTime.gemspec"]
 end
 
 
 # # Original Rakefile source (requires the Echoe gem):
 # 
-# version = "2.0.0"
+# version = "2.1.0"
 # 
 # ENV['RUBY_FLAGS'] = ""
 # 
 # begin
-#   require 'rubygems'
-#   gem 'echoe', '=2.3'
-#   require 'echoe'
+#  require 'rubygems'
+#  gem 'echoe', '=2.4'
+#  require 'echoe'
 # 
-#   Echoe.new('VanaTime', version) do |p|
-#     p.rubyforge_name = 'vanatime'
-#     p.summary = "A library for converting realtime to vanadiel time"
-#     p.url = "http://vanatime.rubyforge.org/"
-#     p.author = 'Travis Tilley'
-#     p.email = "ttilley@gmail.com"
-#   end
+#  Echoe.new('VanaTime', version) do |p|
+#   p.rubyforge_name = 'vanatime'
+#   p.summary = "A library for converting realtime to vanadiel time"
+#   p.url = "http://vanatime.rubyforge.org/"
+#   p.author = 'Travis Tilley'
+#   p.email = "ttilley@gmail.com"
+#  end
 # 
 # rescue LoadError => boom
-#   puts "You are missing a dependency required for meta-operations on this gem."
-#   puts "#{boom.to_s.capitalize}."
+#  puts "You are missing a dependency required for meta-operations on this gem."
+#  puts "#{boom.to_s.capitalize}."
 # end

data/lib/Vana/common.rb

@@ -1,86 +1,86 @@
 module FFXI
-  module Common
-    include FFXI::Constants
+ module Common
+  include FFXI::Constants
 
-    def self.vana_to_earth(vana_time)
-      (((vana_time.to_f - ((898 * 360 + 30) * MS_DAY.to_f)) / 25) +
-          MS_BASIS_DATE.to_f) / MS_SECOND
-    end
-
-    def self.earth_to_vana(earth_time)
-      ((898 * 360 + 30) * MS_DAY) + ((earth_time.to_f * MS_SECOND) -
-          MS_BASIS_DATE) * 25
-    end
+  def self.vana_to_earth(vana_time)
+   (((vana_time.to_f - ((898 * 360 + 30) * MS_DAY.to_f)) / 25) +
+     MS_BASIS_DATE.to_f) / MS_SECOND
+  end
 
-    private
+  def self.earth_to_vana(earth_time)
+   ((898 * 360 + 30) * MS_DAY) + ((earth_time.to_f * MS_SECOND) -
+     MS_BASIS_DATE) * 25
+  end
 
-    def start_of_period(vana_time, period)
-      vana_time.to_f - (vana_time.to_f % period )
-    end
+  private
 
-    def end_of_period(vana_time, period)
-      start_of_period(vana_time, period) + period
-    end
+  def start_of_period(vana_time, period)
+   vana_time.to_f - (vana_time.to_f % period )
+  end
 
-    def period_has_passed_since(period, since, vana_time)
-      if since.nil?
-        true
-      else
-        elapsed = vana_time.to_f - since.to_f
+  def end_of_period(vana_time, period)
+   start_of_period(vana_time, period) + period
+  end
 
-        if elapsed < 0
-          # if we're going -back- in time, we need to measure from the END of
-          # the period instead of the start.
-          elapsed = (since.to_f + period) - vana_time.to_f
-        end
+  def period_has_passed_since(period, since, vana_time)
+   if since.nil?
+    true
+   else
+    elapsed = vana_time.to_f - since.to_f
 
-        elapsed >= period
-      end
+    if elapsed < 0
+     # if we're going -back- in time, we need to measure from the END of
+     # the period instead of the start.
+     elapsed = (since.to_f + period) - vana_time.to_f
     end
 
-    def second_has_passed_since(since, vana_time)
-      period_has_passed_since(MS_SECOND, since, vana_time)
-    end
+    elapsed >= period
+   end
+  end
 
-    def minute_has_passed_since(since, vana_time)
-      period_has_passed_since(MS_MINUTE, since, vana_time)
-    end
+  def second_has_passed_since(since, vana_time)
+   period_has_passed_since(MS_SECOND, since, vana_time)
+  end
 
-    def hour_has_passed_since(since, vana_time)
-      period_has_passed_since(MS_HOUR, since, vana_time)
-    end
+  def minute_has_passed_since(since, vana_time)
+   period_has_passed_since(MS_MINUTE, since, vana_time)
+  end
 
-    def day_has_passed_since(since, vana_time)
-      period_has_passed_since(MS_DAY, since, vana_time)
-    end
+  def hour_has_passed_since(since, vana_time)
+   period_has_passed_since(MS_HOUR, since, vana_time)
+  end
 
-    def month_has_passed_since(since, vana_time)
-      period_has_passed_since(MS_MONTH, since, vana_time)
-    end
+  def day_has_passed_since(since, vana_time)
+   period_has_passed_since(MS_DAY, since, vana_time)
+  end
 
-    def year_has_passed_since(since, vana_time)
-      period_has_passed_since(MS_YEAR, since, vana_time)
-    end
+  def month_has_passed_since(since, vana_time)
+   period_has_passed_since(MS_MONTH, since, vana_time)
+  end
+
+  def year_has_passed_since(since, vana_time)
+   period_has_passed_since(MS_YEAR, since, vana_time)
+  end
 
-    def countdown(time)
-      day_left = time.to_f / MS_DAY
-      hour_left = (day_left.to_f - day_left.floor) * 24
-      min_left = (hour_left.to_f - hour_left.floor) * 60
-      sec_left = (min_left.to_f - min_left.floor) * 60
+  def countdown(time)
+   day_left = time.to_f / MS_DAY
+   hour_left = (day_left.to_f - day_left.floor) * 24
+   min_left = (hour_left.to_f - hour_left.floor) * 60
+   sec_left = (min_left.to_f - min_left.floor) * 60
 
-      [day_left.floor, hour_left.floor, min_left.floor, sec_left.floor]
-    end
+   [day_left.floor, hour_left.floor, min_left.floor, sec_left.floor]
+  end
 
-    def format_countdown(countdown)
-      formatted = String.new
-      countdown[0..2].each do |part|
-        if (part > 0)
-          formatted += "%02d" % part
-          formatted += ":"
-        end
-      end
-      formatted += "%02d" % countdown[3]
-      formatted
+  def format_countdown(countdown)
+   formatted = String.new
+   countdown[0..2].each do |part|
+    if (part > 0)
+     formatted += "%02d" % part
+     formatted += ":"
     end
+   end
+   formatted += "%02d" % countdown[3]
+   formatted
   end
+ end
 end