darian_calendar 0.2 → 1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGFkYjZjZDk2Y2MwYzA4M2NhNDI4MDczYzEzODJiNjI2ZTk4YmJjNw==
+    MmY2MWYxMTY4NGFjODBhZjE4MTJjZTljMzQ5NDVkNGNlOGQ5ZDI3NA==
   data.tar.gz: !binary |-
-    MmNlMjdmZDQ3ZDk1ZDNmZThmNDM0YjUxY2JhM2U5M2RhOWYyMmJjMQ==
+    NTY0MWU1OWUzOWVkNDcyM2EyM2E1OGUyNTZhMmE4ODJjZGQxZDM2NA==
 SHA512:
   metadata.gz: !binary |-
-    MzkyNTQ3NmJlNWUyZTEzMzJhYTUzZjBkODcwMDQ3OWYyYWU4ZmY4M2Y0YTgx
-    MWNiODg0MGQ1ZDg3YWM3ZTdjNmM2YjQwNTJkM2RkOGI0YWUxZGZmNDBmMGM4
-    OTcxMTk2M2IwYzI0MWFiN2Q0ZTBjZDNmZTBkNjYxNzQ0MTE0OTU=
+    NTI4M2QwYmQzZDY1ZTE3ZmU4MmVkYjE0ODI2OTNiYzcyYTgyMTZiZGI2NjQw
+    YzhmNWNiOGEwYzk3N2Q2NTFhM2IwYWNjYzUyZTc0MTg1ZjA2MDdhNDdjYWRl
+    YzkxZTQyMGZmYzczYzEwOTcwN2ZlMmQwZDQ4MTE0YjU2ZDhjM2M=
   data.tar.gz: !binary |-
-    M2EyMmNhZmNmZGViYWY5ZWFmODEzYTUwNTljODAyMjgxNjQxMDExMTFlOWIx
-    YzlmNzFiZTllZTExYmRlMGMwMzcwYmEzMDQ5Y2IzNDgyY2YzOTgzYTI5NTJi
-    Yjg5MzE4OTFkMzAyNDg0YzA4NjgwYjY5YTFlMjQ0YzJmOTgxZGQ=
+    YmUxYWIwYTBlNWY4OWYyM2JkZmI0YWFkMzZjODZkZmMxZGQ0MGZiODdhMTEz
+    MmYwYTMwMzJlYmQ2MWIzMmVmZmIyMTBkZTg5NzZjZjYzM2Y5ZGIyYTE5ZTFm
+    ZDdlNzhjNWJkNGQzODcwNjQ4NDBmZWNhY2E0YTM2MzMzNWZjNWU=

data/.travis.yml

@@ -3,6 +3,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - jruby-19mode
-  - rbx-2.2.4
+  - jruby
+  - rbx
 bundler_args: --without development

data/CHANGELOG.md

@@ -1,12 +1,15 @@
-## 0.2
+## 1.0
+- JSON support
+- Martian date object
+- Bugfixes
+- Optimizations
 
+## 0.2
 - Documentation with Yard
 - Minor optimization
 
 ## 0.1.0
-
 - Working version of the darian calender converter
 
 ## 0.0.1
-
 - Initial release

data/README.md

@@ -43,6 +43,9 @@ mars_time = DarianCalendar::Time.from_earth(Time.utc(2012, 10, 15, 16, 50, 0), D
 
 mars_time = DarianCalendar::Time.parse_earth('2012-10-15 16:50:00 UTC')
 mars_time = DarianCalendar::Time.parse_earth('2012-10-15 16:50:00 UTC', DarianCalendar::CalendarTypes::MARTIANA)
+
+mars_date = DarianCalendar::Date.today
+mars_date = DarianCalendar::Time.now.to_date
 ```
 
 ```ruby
@@ -89,7 +92,7 @@ bundle exec rspec
 ```
 
 ## Copyright
-- _The Darian Calendar Ruby Gem_ is Copyright © 2014 Christian Worreschk, MarSec.
+- _The Darian Calendar Ruby Gem_ is Copyright © 2014 by Christian Worreschk, MarSec.
 - _The Darian System_ is Copyright © 1986-2005 by Thomas Gangale
 
 ## License

data/lib/darian_calendar.rb

@@ -1,5 +1,9 @@
 # encoding: utf-8
 
+require 'date'
+require 'time'
+require 'json'
+require 'darian_calendar/date'
 require 'darian_calendar/time'
 
 # This Ruby library converts earth time to mars time and back again. You can choose between 5 variants of the Darian calendar system; Martiana, Defrost, Areosynchronous, Hensel and Aqua.
@@ -7,8 +11,44 @@ require 'darian_calendar/time'
 # It's based on the JavaScript Converter which was developed by Alan Hensel and Thomas Gangale. (http://pweb.jps.net/~tgangale/mars/converter/calendar_clock.htm)
 module DarianCalendar
 
+  # Variantes of the Darian calendar system (Different sol and month names)
+  module CalendarTypes
+    MARTIANA        = :martiana
+    DEFROST         = :defrost
+    AREOSYNCHRONOUS = :areosynchronous
+    HENSEL          = :hensel
+    AQUA            = :aqua
+  end
+
+  MARS_TO_EARTH_DAYS = 1.027491251
+  EPOCH_OFFSET       = 587744.77817
+  SECONDS_A_DAY      = 86400.0
+  ROUND_UP_SECOND    = 1/SECONDS_A_DAY;
+  E_DAYS_TIL_UNIX    = 719527.0
+
+  SOL_NAMES = {
+    martiana: ['Sol Solis', 'Sol Lunae', 'Sol Martis', 'Sol Mercurii', 'Sol Jovis', 'Sol Veneris', 'Sol Saturni'],
+    defrost: ['Axatisol', 'Benasol', 'Ciposol', 'Domesol', 'Erjasol', 'Fulisol', 'Gavisol'],
+    areosynchronous: ['Heliosol', 'Phobosol', 'Deimosol', 'Terrasol', 'Venusol', 'Mercurisol', 'Jovisol']
+  }
+  MONTH_NAMES = {
+    martiana: ['Sagittarius', 'Dhanus', 'Capricornus', 'Makara', 'Aquarius', 'Kumbha', 'Pisces', 'Mina', 'Aries', 'Mesha', 'Taurus', 'Rishabha', 'Gemini', 'Mithuna', 'Cancer', 'Karka', 'Leo', 'Simha', 'Virgo', 'Kanya', 'Libra', 'Tula', 'Scorpius', 'Vrishika'],
+    defrost: ['Adir', 'Bora', 'Coan', 'Deti', 'Edal', 'Flo', 'Geor', 'Heliba', 'Idanon', 'Jowani', 'Kireal', 'Larno', 'Medior', 'Neturima', 'Ozulikan', 'Pasurabi', 'Rudiakel', 'Safundo', 'Tiunor', 'Ulasja', 'Vadeun', 'Wakumi', 'Xetual', 'Zungo'],
+    hensel: ['Vernalis', 'Duvernalis', 'Trivernalis', 'Quadrivernalis', 'Pentavernalis', 'Hexavernalis', 'Aestas', 'Duestas', 'Triestas', 'Quadrestas', 'Pentestas', 'Hexestas', 'Autumnus', 'Duautumn', 'Triautumn', 'Quadrautumn', 'Pentautumn', 'Hexautumn', 'Unember', 'Duember', 'Triember', 'Quadrember', 'Pentember', 'Hexember']
+  }
+
   class << self
 
+    # Returns the total number of martian sols for an earth date or time
+    # @param earth_date_time [Date/Time] Earth date or time
+    # @return [Float] number of sols
+    def sols_from_earth(earth_date_time)
+      seconds = earth_date_time.is_a?(::Date) ? earth_date_time.strftime("%s").to_f : earth_date_time.to_f
+      days = (seconds / SECONDS_A_DAY) + E_DAYS_TIL_UNIX
+      sols = (days - EPOCH_OFFSET) / MARS_TO_EARTH_DAYS
+      return sols
+    end
+
     # Returns the current mars time. Shortcut for 'DarianCalendar::Time.now'
     # @param type [DarianCalendar::CalendarTypes] Calendar type
     # @return [DarianCalendar::Time] current mars time
@@ -16,6 +56,13 @@ module DarianCalendar
       DarianCalendar::Time.now(type)
     end
 
+    # Returns the current mars time. Shortcut for 'DarianCalendar::Time.now'
+    # @param type [DarianCalendar::CalendarTypes] Calendar type
+    # @return [DarianCalendar::Time] current mars time
+    def today(type=CalendarTypes::MARTIANA)
+      DarianCalendar::Date.today(type)
+    end
+
   end
 
 end

data/lib/darian_calendar/date.rb

@@ -0,0 +1,213 @@
+# encoding: utf-8
+
+module DarianCalendar
+
+  # The date is a particular day of a Darian calendar year
+  class Date
+    include Comparable
+
+    # @return [Integer] year
+    attr_reader :year
+    # @return [Integer] month of the year
+    attr_reader :month
+    # @return [Integer] sol of the month
+    attr_reader :sol
+    # @return [String] full month name ("Mithuna")
+    attr_reader :month_name
+    # @return [String] full weeksol name ("Sol Jovis")
+    attr_reader :week_sol_name
+    # @return [Integer] number of sols since the earth date 0-0-0
+    attr_reader :total_sols
+    # @return [String] sol of the week
+    attr_reader :week_sol
+    # @return [Integer] season of the year
+    attr_reader :season
+    # @return [Integer] sol of the season
+    attr_reader :sol_of_season
+    # @return [Integer] month of the season
+    attr_reader :month_of_season
+    # @return [Integer] sol of the year
+    attr_reader :sol_of_year
+    # @return [String] name of the calendar type ("Martiana")
+    attr_reader :calendar_type
+
+    alias :day :sol
+    alias :week_day :week_sol
+
+    protected
+
+    def set_attributes(total_sols, type)
+      @calendar_type = type.to_s.capitalize
+      @total_sols    = total_sols
+
+      sD  = (@total_sols / 334296).floor
+      doD = (@total_sols - (sD * 334296)).floor
+
+      sC = 0
+      doC = doD
+      sC = ((doD - 1) / 66859).floor if doD != 0
+      doC -= ((sC * 66859) + 1) if sC != 0
+
+      sX = 0
+      doX = doC
+      if sC != 0 # century that does not begin with leap day
+        sX = ((doC + 1) / 6686).floor
+        doX -= ((sX * 6686) - 1) if sX != 0
+      else
+        sX = (doC / 6686).floor
+        doX -= (sX * 6686) if sX != 0
+      end
+
+      sII = 0
+      doII = doX
+      if (sC != 0) && (sX == 0) # decade that does not begin with leap day
+        sII = (doX / 1337).floor
+        doII -= (sII * 1337) if sII != 0
+      else # 1338, 1337, 1337, 1337 ...
+        sII = ((doX - 1) / 1337) if doX != 0
+        doII -= ((sII * 1337) + 1) if sII != 0
+      end
+
+      sI = 0
+      doI= doII
+      if (sII == 0) && ((sX != 0) || ((sX == 0) && (sC == 0)))
+        sI = (doII / 669).floor
+        doI -= 669 if sI != 0
+      else # 668, 669
+        sI = ((doII + 1) / 669).floor
+        doI -= 668 if sI != 0
+      end
+
+      @year = (500 * sD) + (100 * sC) + (10 * sX) + (2 * sII) + sI
+      @season = case true # 0-3
+        when (doI < 167) then 0
+        when (doI < 334) then 1
+        when (doI < 501) then 2
+        else 3
+      end
+
+      @sol_of_season = doI - 167 * @season # 0-167
+      @month_of_season = (@sol_of_season / 28).floor #  0-5
+      @sol_of_year = doI
+
+      @month = @month_of_season + (6 * @season) + 1 # 1-24
+      @sol   = doI - (((@month - 1) * 28) - @season) + 1 # 1-28
+      @week_sol = ((@sol - 1) % 7) + 1 # 1-7
+
+      @week_sol_name = case type
+        when DarianCalendar::CalendarTypes::MARTIANA, CalendarTypes::HENSEL then DarianCalendar::SOL_NAMES[:martiana][@week_sol-1]
+        when DarianCalendar::CalendarTypes::DEFROST then DarianCalendar::SOL_NAMES[:defrost][@week_sol-1]
+        when DarianCalendar::CalendarTypes::AREOSYNCHRONOUS then DarianCalendar::SOL_NAMES[:areosynchronous][@week_sol-1]
+        when DarianCalendar::CalendarTypes::AQUA then @week_sol.to_s
+        else ''
+      end
+
+      @month_name = case type
+        when DarianCalendar::CalendarTypes::MARTIANA then DarianCalendar::MONTH_NAMES[:martiana][@month-1]
+        when DarianCalendar::CalendarTypes::DEFROST, DarianCalendar::CalendarTypes::AREOSYNCHRONOUS then DarianCalendar::MONTH_NAMES[:defrost][@month-1]
+        when DarianCalendar::CalendarTypes::HENSEL then DarianCalendar::MONTH_NAMES[:hensel][@month-1]
+        when DarianCalendar::CalendarTypes::AQUA then @month.to_s
+        else ''
+      end
+    end
+
+    public
+
+    # Converts a date object to a mars date object
+    # @param earth_date [::Date] Earth date
+    # @param type [DarianCalendar::CalendarTypes] Calendar type
+    # @return [DarianCalendar::Date] mars date
+    def self.from_earth(earth_date, type=DarianCalendar::CalendarTypes::MARTIANA)
+      self.new(DarianCalendar.sols_from_earth(earth_date), type)
+    end
+
+    # Parses the given representation of a date, and converts it to a mars date
+    # @param string [String] String with a date
+    # @param type [DarianCalendar::CalendarTypes] Calendar type
+    # @return [DarianCalendar::Date] mars date
+    def self.parse_earth(string, type=DarianCalendar::CalendarTypes::MARTIANA)
+      self.from_earth(::Date.parse(string), type)
+    end
+
+    # Creates a date object denoting the present mars day.
+    # @param type [DarianCalendar::CalendarTypes] Calendar type
+    # @return [DarianCalendar::Date] current mars date
+    def self.today(type=DarianCalendar::CalendarTypes::MARTIANA)
+      self.from_earth(::Date.today, type)
+    end
+
+    # Sets the model attributes from a JSON string. Returns self.
+    # @param json [String] JSON string
+    # @return [DarianCalendar::Date] mars date
+    def self.from_json(string)
+      json = JSON::parse(string)
+      type =  json['calendar_type'].to_s.downcase.to_sym rescue nil
+      self.new(json['total_sols'].to_f, type)
+    end
+
+    # Compares two dates and returns -1, zero, 1 or nil. The other should be a mars date object.
+    # @param another [DarianCalendar::Date]
+    # @return [Integer] Compare result
+    def <=>(another)
+      @total_sols.floor <=> another.total_sols.floor
+    end
+
+    # Return the number of sols in the given year
+    # @return [Integer] Number of sols in the given year
+    def sols_in_year
+      self.leap? ? 669 : 668
+    end
+
+    # Returns true if the given year is a leap year
+    # @return [Boolean] true if the given year is a leap year
+    def leap?
+      return true if (@year % 500) == 0
+      return false if (@year % 100) == 0
+      return true if (@year %  10) == 0
+      return false if (@year % 2) == 0
+      return true
+    end
+
+    # Converts the given mars date to earth date
+    # @return [Date] earth date
+    def to_earth
+      earth_days = (@total_sols * DarianCalendar::MARS_TO_EARTH_DAYS) + DarianCalendar::EPOCH_OFFSET + DarianCalendar::ROUND_UP_SECOND
+      earth_seconds = ((earth_days - DarianCalendar::E_DAYS_TIL_UNIX) * DarianCalendar::SECONDS_A_DAY) - 1
+      ::Time.at(earth_seconds).to_date
+    end
+
+    # Returns a string in an ISO 8601 format (This method doesn’t use the expanded representations).
+    # @return [String] Date as a string in an ISO 8601 format
+    def to_s
+      sprintf('%d-%02d-%02d', @year, @month, @sol)
+    end
+
+    # Returns a JSON string representing the model.
+    # @return Returns a JSON string representing the model.
+    def to_json
+      self.as_json.to_json
+    end
+
+    # Returns a hash representing the model.
+    # @return Returns a hash representing the model.
+    def as_json
+      json = {}
+      self.instance_variables.sort.each do |attr|
+        field = attr.to_s.gsub('@', '')
+        json[field] = self.send(field)
+      end
+      return json
+    end
+
+    # Converts a number of martian sols to mars date.
+    # @param sols optional [Float] Number of martian sols. Default is the number of sols of the the current date.
+    # @param type optional [DarianCalendar::CalendarTypes] calendar type.
+    # @return [DarianCalendar::Date] mars date
+    def initialize(sols=nil, type=DarianCalendar::CalendarTypes::MARTIANA)
+      total_sols = sols.to_f != 0 ? sols.to_f : DarianCalendar.sols_from_earth(::Date.today)
+      self.set_attributes(total_sols, type)
+    end
+
+  end
+
+end

data/lib/darian_calendar/time.rb

@@ -2,99 +2,36 @@
 
 module DarianCalendar
 
-  # Variantes of the Darian calendar system
-  module CalendarTypes
-    MARTIANA        = :martiana
-    DEFROST         = :defrost
-    AREOSYNCHRONOUS = :areosynchronous
-    HENSEL          = :hensel
-    AQUA            = :aqua
-  end
-
   # Timestamp in the Darian calendar system
-  class Time
-    include Comparable
+  class Time < DarianCalendar::Date
 
-    # @return [Integer] year
-    attr_reader :year
-    # @return [Integer] month of the year
-    attr_reader :month
-    # @return [Integer] sol of the month
-    attr_reader :sol
     # @return [Integer] hour of the sol
     attr_reader :hour
     # @return [Integer] minute of the hour
     attr_reader :min
     # @return [Integer] second of the minute
     attr_reader :sec
-    # @return [String] full month name ("Mithuna")
-    attr_reader :month_name
-    # @return [String] full weeksol name ("Sol Jovis")
-    attr_reader :week_sol_name
-    # @return [Float] number of sols (with hour, minutes and seconds) since the earth date 0-0-0
-    attr_reader :total_sols
-    # @return [String] sol of the week
-    attr_reader :week_sol
-    # @return [Integer] season of the year
-    attr_reader :season
-    # @return [Integer] sol of the season
-    attr_reader :sol_of_season
-    # @return [Integer] month of the season
-    attr_reader :month_of_season
-    # @return [Integer] sol of the year
-    attr_reader :sol_of_year
-    # @return [String] name of the calendar type ("Martiana")
-    attr_reader :calendar_type
-
-    alias :day :sol
-    alias :week_day :week_sol
-
-    MARS_TO_EARTH_DAYS = 1.027491251
-    EPOCH_OFFSET = 587744.77817
-    SECONDS_A_DAY = 86400.0
-    ROUND_UP_SECOND = 1/SECONDS_A_DAY;
-    E_DAYS_TIL_UNIX = 719527.0
-
-    SOL_NAMES = {
-      martiana: ['Sol Solis', 'Sol Lunae', 'Sol Martis', 'Sol Mercurii', 'Sol Jovis', 'Sol Veneris', 'Sol Saturni'],
-      defrost: ['Axatisol', 'Benasol', 'Ciposol', 'Domesol', 'Erjasol', 'Fulisol', 'Gavisol'],
-      areosynchronous: ['Heliosol', 'Phobosol', 'Deimosol', 'Terrasol', 'Venusol', 'Mercurisol', 'Jovisol']
-    }
-    MONTH_NAMES = {
-      martiana: ['Sagittarius', 'Dhanus', 'Capricornus', 'Makara', 'Aquarius', 'Kumbha', 'Pisces', 'Mina', 'Aries', 'Mesha', 'Taurus', 'Rishabha', 'Gemini', 'Mithuna', 'Cancer', 'Karka', 'Leo', 'Simha', 'Virgo', 'Kanya', 'Libra', 'Tula', 'Scorpius', 'Vrishika'],
-      defrost: ['Adir', 'Bora', 'Coan', 'Deti', 'Edal', 'Flo', 'Geor', 'Heliba', 'Idanon', 'Jowani', 'Kireal', 'Larno', 'Medior', 'Neturima', 'Ozulikan', 'Pasurabi', 'Rudiakel', 'Safundo', 'Tiunor', 'Ulasja', 'Vadeun', 'Wakumi', 'Xetual', 'Zungo'],
-      hensel: ['Vernalis', 'Duvernalis', 'Trivernalis', 'Quadrivernalis', 'Pentavernalis', 'Hexavernalis', 'Aestas', 'Duestas', 'Triestas', 'Quadrestas', 'Pentestas', 'Hexestas', 'Autumnus', 'Duautumn', 'Triautumn', 'Quadrautumn', 'Pentautumn', 'Hexautumn', 'Unember', 'Duember', 'Triember', 'Quadrember', 'Pentember', 'Hexember']
-    }
-
-    # Calculates the total number of martian sols for this earth time
-    # @param earth_time [Time] Earth time
-    # @return [Integer] number of sols
-    def self.sols_from_earth_time(earth_time)
-      days = (earth_time.to_f / SECONDS_A_DAY) + E_DAYS_TIL_UNIX
-      sols = (days - EPOCH_OFFSET) / MARS_TO_EARTH_DAYS
-      return sols
-    end
 
     # Converts a time object to a mars time object
     # @param earth_time [Time] Earth time
     # @param type [DarianCalendar::CalendarTypes] Calendar type
     # @return [DarianCalendar::Time] mars time
-    def self.from_earth(earth_time, type=CalendarTypes::MARTIANA)
-      self.new(self.sols_from_earth_time(earth_time), type)
+    def self.from_earth(earth_time, type=DarianCalendar::CalendarTypes::MARTIANA)
+      self.new(DarianCalendar.sols_from_earth(earth_time), type)
     end
 
     # Parses the given representation of date and time, and converts it to mars time
     # @param string [String] String with date and time
     # @param type [DarianCalendar::CalendarTypes] Calendar type
     # @return [DarianCalendar::Time] mars time
-    def self.parse_earth(string, type=CalendarTypes::MARTIANA)
+    def self.parse_earth(string, type=DarianCalendar::CalendarTypes::MARTIANA)
       self.from_earth(::Time.parse(string), type)
     end
 
     # Returns the current mars time.
     # @param type [DarianCalendar::CalendarTypes] Calendar type
     # @return [DarianCalendar::Time] current mars time
-    def self.now(type=CalendarTypes::MARTIANA)
+    def self.now(type=DarianCalendar::CalendarTypes::MARTIANA)
       self.from_earth(::Time.now, type)
     end
 
@@ -105,27 +42,11 @@ module DarianCalendar
       @total_sols <=> another.total_sols
     end
 
-    # Return the number of sols in the given year
-    # @return [Integer] Number of sols in the given year
-    def sols_in_year
-      self.leap? ? 669 : 668
-    end
-
-    # Returns true if the given year is a leap year
-    # @return [Boolean] true if the given year is a leap year
-    def leap?
-      return true if (@year % 500) == 0
-      return false if (@year % 100) == 0
-      return true if (@year %  10) == 0
-      return false if (@year % 2) == 0
-      return true
-    end
-
     # Converts the given mars time to earth time
     # @return [Time] earth time
     def to_earth
-      earth_days = (@total_sols * MARS_TO_EARTH_DAYS) + EPOCH_OFFSET + ROUND_UP_SECOND
-      earth_seconds = ((earth_days - E_DAYS_TIL_UNIX) * SECONDS_A_DAY) - 1
+      earth_days = (@total_sols * DarianCalendar::MARS_TO_EARTH_DAYS) + DarianCalendar::EPOCH_OFFSET + DarianCalendar::ROUND_UP_SECOND
+      earth_seconds = ((earth_days - DarianCalendar::E_DAYS_TIL_UNIX) * DarianCalendar::SECONDS_A_DAY) - 1
       ::Time.at(earth_seconds)
     end
 
@@ -135,83 +56,20 @@ module DarianCalendar
       sprintf('%d-%02d-%02d %02d:%02d:%02d', @year, @month, @sol, @hour, @min, @sec)
     end
 
+    # Returns the date of the given mars time
+    # @return [DarianCalendar::Date] mars date
+    def to_date
+      DarianCalendar::Date.new(self.total_sols)
+    end
+
     # Converts a number of martian sols to mars time.
     # @param sols optional [Float] Number of martian sols. Default is the number of sols of the the current time.
     # @param type optional [DarianCalendar::CalendarTypes] calendar type.
     # @return [DarianCalendar::Time] mars time
-    def initialize(sols=nil, type=CalendarTypes::MARTIANA)
-      @calendar_type = type.to_s.capitalize
-      @total_sols = sols.to_f != 0 ? sols.to_f : self.sols_from_earth_time(::Time.now)
-
-      sD  = (@total_sols / 334296).floor
-      doD = (@total_sols - (sD * 334296)).floor
-
-      sC = 0
-      doC = doD
-      sC = ((doD - 1) / 66859).floor if doD != 0
-      doC -= ((sC * 66859) + 1) if sC != 0
-
-      sX = 0
-      doX = doC
-      if sC != 0 # century that does not begin with leap day
-        sX = ((doC + 1) / 6686).floor
-        doX -= ((sX * 6686) - 1) if sX != 0
-      else
-        sX = (doC / 6686).floor
-        doX -= (sX * 6686) if sX != 0
-      end
-
-      sII = 0
-      doII = doX
-      if (sC != 0) && (sX == 0) # decade that does not begin with leap day
-        sII = (doX / 1337).floor
-        doII -= (sII * 1337) if sII != 0
-      else # 1338, 1337, 1337, 1337 ...
-        sII = ((doX - 1) / 1337) if doX != 0
-        doII -= ((sII * 1337) + 1) if sII != 0
-      end
-
-      sI = 0
-      doI= doII
-      if (sII == 0) && ((sX != 0) || ((sX == 0) && (sC == 0)))
-        sI = (doII / 669).floor
-        doI -= 669 if sI != 0
-      else # 668, 669
-        sI = ((doII + 1) / 669).floor
-        doI -= 668 if sI != 0
-      end
-
-      @year = (500 * sD) + (100 * sC) + (10 * sX) + (2 * sII) + sI
-      @season = case true # 0-3
-        when (doI < 167) then 0
-        when (doI < 334) then 1
-        when (doI < 501) then 2
-        else 3
-      end
-
-      @sol_of_season = doI - 167 * @season # 0-167
-      @month_of_season = (@sol_of_season / 28).floor #  0-5
-      @sol_of_year = doI
-
-      @month = @month_of_season + (6 * @season) + 1 # 1-24
-      @sol   = doI - (((@month - 1) * 28) - @season) + 1 # 1-28
-      @week_sol = ((@sol - 1) % 7) + 1 # 1-7
-
-      @week_sol_name = case type
-        when CalendarTypes::MARTIANA, CalendarTypes::HENSEL then SOL_NAMES[:martiana][@week_sol-1]
-        when CalendarTypes::DEFROST then SOL_NAMES[:defrost][@week_sol-1]
-        when CalendarTypes::AREOSYNCHRONOUS then SOL_NAMES[:areosynchronous][@week_sol-1]
-        when CalendarTypes::AQUA then @week_sol.to_s
-        else ''
-      end
+    def initialize(sols=nil, type=DarianCalendar::CalendarTypes::MARTIANA)
+      total_sols = sols.to_f != 0 ? sols.to_f : DarianCalendar.sols_from_earth(::Time.now)
 
-      @month_name = case type
-        when CalendarTypes::MARTIANA then MONTH_NAMES[:martiana][@month-1]
-        when CalendarTypes::DEFROST, CalendarTypes::AREOSYNCHRONOUS then MONTH_NAMES[:defrost][@month-1]
-        when CalendarTypes::HENSEL then MONTH_NAMES[:hensel][@month-1]
-        when CalendarTypes::AQUA then @month.to_s
-        else ''
-      end
+      self.set_attributes(total_sols, type)
 
       partial_sol = @total_sols - @total_sols.floor
       hour = partial_sol* 24

data/lib/darian_calendar/version.rb

@@ -1,3 +1,3 @@
 module DarianCalendar
-  VERSION = '0.2'
+  VERSION = '1.0'
 end

data/spec/darian_calendar_spec.rb

@@ -6,13 +6,42 @@ describe DarianCalendar do
 
   describe 'class methods' do
 
+    #def sols_from_earth(earth_date_time)
+    #  seconds = earth_date_time.is_a?(::Date) ? earth_date_time.strftime("%s").to_f : earth_date_time.to_f
+    #  days = (seconds / SECONDS_A_DAY) + E_DAYS_TIL_UNIX
+    #  sols = (days - EPOCH_OFFSET) / MARS_TO_EARTH_DAYS
+    #  return sols
+    #end
+    describe '#sols_from_earth' do
+      context 'parameter is a date object' do
+        it 'returns the total number of martian sols' do
+          earth = ::Date.new(2012, 10, 15)
+          DarianCalendar.sols_from_earth(earth).should == 143466.15767923463
+        end
+      end
+      context 'parameter is a time object' do
+        it 'returns the total number of martian sols' do
+          earth = ::Time.utc(2012, 10, 15, 16, 50, 0)
+          DarianCalendar.sols_from_earth(earth).should == 143466.84030197054
+        end
+      end
+    end
+
     describe '#now' do
       it 'returns current mars time' do
-        earth = Time.utc(2012, 10, 15, 16, 50, 0)
-        Time.should_receive(:now).and_return(earth)
+        earth = ::Time.utc(2012, 10, 15, 16, 50, 0)
+        ::Time.should_receive(:now).and_return(earth)
         DarianCalendar.now.should == DarianCalendar::Time.from_earth(earth)
       end
     end
+
+    describe '#today' do
+      it 'returns current mars date' do
+        earth = ::Date.new(2012, 10, 15)
+        ::Date.should_receive(:today).and_return(earth)
+        DarianCalendar.today.should == DarianCalendar::Date.from_earth(earth)
+      end
+    end
   end
 
 end

data/spec/date_spec.rb

@@ -0,0 +1,202 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe DarianCalendar::Date do
+
+  before do
+    @earth_date = ::Date.new(2012, 10, 15)
+    @mars_date  = DarianCalendar::Date.from_earth(@earth_date)
+    @mars_date_json = '{"calendar_type":"Martiana","month":14,"month_name":"Mithuna","month_of_season":1,"season":2,"sol":26,"sol_of_season":53,"sol_of_year":387,"total_sols":143466.15767923463,"week_sol":5,"week_sol_name":"Sol Jovis","year":214}'
+  end
+
+  describe 'attributes' do
+
+    it 'aliases day to sol and week day to week sol' do
+      @mars_date.day.should == @mars_date.sol
+      @mars_date.week_day.should == @mars_date.week_sol
+    end
+
+  end
+
+  describe 'initialize method' do
+    it 'converts earth date to mars date' do
+      @mars_date.year.should  == 214
+      @mars_date.month.should == 14
+      @mars_date.sol.should   == 26
+
+      @mars_date.total_sols.should      == 143466.15767923463
+      @mars_date.season.should          == 2
+      @mars_date.sol_of_season.should   == 53
+      @mars_date.month_of_season.should == 1
+      @mars_date.sol_of_year.should     == 387
+      @mars_date.week_sol.should        == 5
+    end
+  end
+
+  describe 'class methods' do
+
+    describe '.from_earth' do
+      it 'converts an earth date to a mars date' do
+        DarianCalendar::Date.from_earth(@earth_date).should == @mars_date
+      end
+    end
+
+    describe '.parse_earth' do
+      it 'parses earth date and converts it to mars date' do
+        DarianCalendar::Date.parse_earth('2012-10-15').should == @mars_date
+      end
+    end
+
+    describe '.today' do
+      it 'returns current mars date' do
+        ::Date.should_receive(:today).and_return(@earth_date)
+        DarianCalendar::Date.today.should == DarianCalendar::Date.from_earth(@earth_date)
+      end
+    end
+
+    describe '.from_json' do
+      it 'parses a json string and creates a mars date' do
+        DarianCalendar::Date.from_json(@mars_date_json).should == @mars_date
+      end
+    end
+
+  end
+
+  describe 'instance methods' do
+
+    describe '#<=>' do
+      it 'compares mars date objects' do
+        same_date   = DarianCalendar::Date.from_earth(Date.new(2012, 10, 15))
+        past_date   = DarianCalendar::Date.from_earth(Date.new(2012, 10, 14))
+        future_date = DarianCalendar::Date.from_earth(Date.new(2012, 10, 16))
+
+        @mars_date.should == same_date
+        @mars_date.should >  past_date
+        @mars_date.should <  future_date
+
+        @mars_date.should_not < past_date
+        @mars_date.should_not > future_date
+      end
+    end
+
+    describe '#sols_in_year' do
+      it 'returns the number of sols in a martian year' do
+        leap_mars_date  = DarianCalendar::Date.from_earth(Date.new(2013, 10, 15))
+        leap_mars_date.sols_in_year.should == 669
+        @mars_date.sols_in_year.should     == 668
+      end
+    end
+
+    describe '#leap?' do
+      it 'returns if year is a leap year' do
+        leap_mars_date  = DarianCalendar::Date.from_earth(Date.new(2013, 10, 15))
+        leap_mars_date.leap?.should == true
+        @mars_date.leap?.should     == false
+      end
+    end
+
+    describe '#to_earth' do
+      it 'converts mars date to earth date' do
+        @earth_date == @mars_date.to_earth
+      end
+    end
+
+    describe '#to_s' do
+      it 'converts mars date to string' do
+        @mars_date.to_s.should == '214-14-26'
+      end
+    end
+
+    describe '#to_json' do
+      it 'converts mars date to a json string' do
+        @mars_date.to_json.should == @mars_date_json
+      end
+    end
+
+    describe '#as_json' do
+      it 'converts mars date to json' do
+        @mars_date.as_json.should == JSON::parse(@mars_date_json)
+      end
+    end
+
+    describe '#week_sol_name' do
+      context 'calendar type is not set' do
+        it 'returns "Sol Jovis"' do
+          @mars_date.week_sol_name.should == 'Sol Jovis'
+        end
+      end
+      context 'calendar type is "Martina"' do
+        it 'returns "Sol Jovis"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::MARTIANA)
+          mars_date.week_sol_name.should == 'Sol Jovis'
+        end
+      end
+      context 'calendar type is "Defrost"' do
+        it 'returns "Erjasol"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::DEFROST)
+          mars_date.week_sol_name.should == 'Erjasol'
+        end
+      end
+      context 'calendar type is "Areosynchronous"' do
+        it 'returns "Venusol"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::AREOSYNCHRONOUS)
+          mars_date.week_sol_name.should == 'Venusol'
+        end
+      end
+      context 'calendar type is "Hensel"' do
+        it 'returns "Sol Jovis"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::HENSEL)
+          mars_date.week_sol_name.should == 'Sol Jovis'
+        end
+      end
+      context 'calendar type is "Aqua"' do
+        it 'returns "5"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::AQUA)
+          mars_date.week_sol_name.should == '5'
+        end
+      end
+    end
+
+    describe '#month_name' do
+      context 'calendar type is not set' do
+        it 'returns "Mithuna"' do
+          @mars_date.month_name.should == 'Mithuna'
+        end
+      end
+      context 'calendar type is "Martina"' do
+        it 'returns "Mithuna"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::MARTIANA)
+          mars_date.month_name.should == 'Mithuna'
+        end
+      end
+      context 'calendar type is "Defrost"' do
+        it 'returns "Neturima"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::DEFROST)
+          mars_date.month_name.should == 'Neturima'
+        end
+      end
+      context 'calendar type is "Areosynchronous"' do
+        it 'returns "Neturima"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::AREOSYNCHRONOUS)
+          mars_date.month_name.should == 'Neturima'
+        end
+      end
+      context 'calendar type is "Hensel"' do
+        it 'returns "Duautumn"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::HENSEL)
+          mars_date.month_name.should == 'Duautumn'
+        end
+      end
+      context 'calendar type is "Aqua"' do
+        it 'returns "14"' do
+          mars_date = DarianCalendar::Date.from_earth(@earth_date, DarianCalendar::CalendarTypes::AQUA)
+          mars_date.month_name.should == '14'
+        end
+      end
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -2,4 +2,5 @@
 
 require 'time'
 require 'date'
+require 'json'
 require Pathname(__FILE__).dirname.join('../lib/darian_calendar').to_s

data/spec/time_spec.rb

@@ -5,8 +5,11 @@ require 'spec_helper'
 describe DarianCalendar::Time do
 
   before do
-    @earth_time = Time.utc(2012, 10, 15, 16, 50, 0)
+    @earth_date = ::Date.new(2012, 10, 15)
+    @earth_time = ::Time.utc(2012, 10, 15, 16, 50, 0)
+    @mars_date  = DarianCalendar::Date.from_earth(@earth_date)
     @mars_time  = DarianCalendar::Time.from_earth(@earth_time)
+    @mars_time_json = '{"calendar_type":"Martiana","hour":20,"min":10,"month":14,"month_name":"Mithuna","month_of_season":1,"season":2,"sec":2,"sol":26,"sol_of_season":53,"sol_of_year":387,"total_sols":143466.84030197054,"week_sol":5,"week_sol_name":"Sol Jovis","year":214}'
   end
 
   describe 'attributes' do
@@ -38,10 +41,9 @@ describe DarianCalendar::Time do
 
   describe 'class methods' do
 
-    describe '.total_sols' do
-      it 'returns total sols from earth time' do
-        sols = DarianCalendar::Time.sols_from_earth_time(@earth_time)
-        sols.should == @mars_time.total_sols
+    describe '.from_earth' do
+      it 'converts an earth time to a mars time' do
+        DarianCalendar::Date.from_earth(@earth_time).should == @mars_time
       end
     end
 
@@ -51,13 +53,26 @@ describe DarianCalendar::Time do
       end
     end
 
+    describe '.today' do
+      it 'returns current mars date' do
+        ::Date.should_receive(:today).and_return(@earth_date)
+        DarianCalendar::Time.today.should == DarianCalendar::Date.from_earth(@earth_date)
+      end
+    end
+
     describe '.now' do
       it 'returns current mars time' do
-        Time.should_receive(:now).and_return(@earth_time)
+        ::Time.should_receive(:now).and_return(@earth_time)
         DarianCalendar.now.should == DarianCalendar::Time.from_earth(@earth_time)
       end
     end
 
+    describe '.from_json' do
+      it 'parses a json string and creates a mars date' do
+        DarianCalendar::Time.from_json(@mars_time_json).should == @mars_time
+      end
+    end
+
   end
 
   describe 'instance methods' do
@@ -105,6 +120,24 @@ describe DarianCalendar::Time do
       end
     end
 
+    describe '#to_date' do
+      it 'returns the date of the mars time' do
+        @mars_time.to_date.should == @mars_date
+      end
+    end
+
+    describe '#to_json' do
+      it 'converts mars time to a json string' do
+        @mars_time.to_json.should == @mars_time_json
+      end
+    end
+
+    describe '#as_json' do
+      it 'converts mars time to json' do
+        @mars_time.as_json.should == JSON::parse(@mars_time_json)
+      end
+    end
+
     describe '#week_sol_name' do
       context 'calendar type is not set' do
         it 'returns "Sol Jovis"' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darian_calendar
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '1.0'
 platform: ruby
 authors:
 - Christian Worreschk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies: []
 description: This Ruby library converts earth time to mars time and back again. You
   can choose between 5 variants of the Darian calendar system; Martiana, Defrost,
@@ -32,9 +32,11 @@ files:
 - Rakefile
 - darian_calendar.gemspec
 - lib/darian_calendar.rb
+- lib/darian_calendar/date.rb
 - lib/darian_calendar/time.rb
 - lib/darian_calendar/version.rb
 - spec/darian_calendar_spec.rb
+- spec/date_spec.rb
 - spec/spec_helper.rb
 - spec/time_spec.rb
 homepage: http://github.com/marsec/darian_calendar