fOOrth 0.5.0

data/lib/fOOrth/library/duration/arithmetic.rb

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+#* library/duration/arithmetic.rb - Arithmetic operator support for durations.
+module XfOOrth
+
+  #* library/duration/arithmetic.rb - Arithmetic operator support for durations.
+  class Duration
+
+    #Coerce the argument to match my type.
+    def foorth_coerce(arg)
+      @period.foorth_coerce(arg)
+    end
+
+    #Convert this duration to a rational number.
+    def to_r
+      @period
+    end
+
+    #Alias rationalize to the to_r method.
+    alias :rationalize :to_r
+
+    #Alias to_foorth_r to the to_r method.
+    alias :to_foorth_r :to_r
+
+    #Define equality for durations.
+    def eql?(other)
+      @period.eql?(other.to_foorth_r)
+    end
+
+    #Alias == to the eql? operator.
+    alias :== :eql?
+  end
+
+  #[a_duration numeric/duration] + [a_duration]
+  Duration.create_shared_method('+', NosSpec, [], &lambda {|vm|
+    begin
+      result = @period + @period.foorth_coerce(vm.peek)
+      vm.poke(Duration.new(result))
+    rescue
+      vm.data_stack.pop
+      raise
+    end
+  })
+
+  #[a_duration numeric/duration] - [a_duration]
+  Duration.create_shared_method('-', NosSpec, [], &lambda {|vm|
+    begin
+      result = @period - @period.foorth_coerce(vm.peek)
+      vm.poke(Duration.new(result))
+    rescue
+      vm.data_stack.pop
+      raise
+    end
+  })
+
+  #[a_duration numeric/duration] * [a_duration]
+  Duration.create_shared_method('*', NosSpec, [], &lambda {|vm|
+    begin
+      result = @period * @period.foorth_coerce(vm.peek)
+      vm.poke(Duration.new(result))
+    rescue
+      vm.data_stack.pop
+      raise
+    end
+  })
+
+  #[a_duration numeric/duration] / [a_duration]
+  Duration.create_shared_method('/', NosSpec, [], &lambda {|vm|
+    begin
+      result = @period / @period.foorth_coerce(vm.peek)
+      vm.poke(Duration.new(result))
+    rescue
+      vm.data_stack.pop
+      raise
+    end
+  })
+
+  # [a_duration] 1+ [a_duration+1]
+  Duration.create_shared_method('1+', TosSpec, [], &lambda {|vm|
+    result = @period + 1
+    vm.push(Duration.new(result))
+  })
+
+  # [a_duration] 1- [a_duration-1]
+  Duration.create_shared_method('1-', TosSpec, [], &lambda {|vm|
+    result = @period - 1
+    vm.push(Duration.new(result))
+  })
+
+  # [a_duration] 2+ [a_duration+2]
+  Duration.create_shared_method('2+', TosSpec, [], &lambda {|vm|
+    result = @period + 2
+    vm.push(Duration.new(result))
+  })
+
+  # [a_duration] 2- [a_duration-2]
+  Duration.create_shared_method('2-', TosSpec, [], &lambda {|vm|
+    result = @period - 2
+    vm.push(Duration.new(result))
+  })
+
+  # [a_duration] 2* [a_duration*2]
+  Duration.create_shared_method('2*', TosSpec, [], &lambda {|vm|
+    result = @period * 2
+    vm.push(Duration.new(result))
+  })
+
+  # [a_duration] 2/ [a_duration/2]
+  Duration.create_shared_method('2/', TosSpec, [], &lambda {|vm|
+    result = @period / 2
+    vm.push(Duration.new(result))
+  })
+
+end

data/lib/fOOrth/library/duration/formatter.rb

@@ -0,0 +1,152 @@
+# coding: utf-8
+
+#* library/duration/formatter.rb - Duration formatting support library.
+module XfOOrth
+
+  #Formatter support for the \Duration class.
+  class Duration
+
+    #Extend this class with attr_formatter support.
+    extend FormatEngine::AttrFormatter
+
+    ##
+    #The specification of the formatter method of the \Duration class.
+    #<br>Year Formats:
+    #* %{?}{$}{w}y - Whole years.
+    #* %{?}{$}{w{.p}}Y - Total (with fractional) years.
+    #<br>Month Formats:
+    #* %{?}{$}{w}o - Whole months in the year.
+    #* %{?}{$}{w{.p}}O - Total (with fractional) months.
+    #<br>Day Formats:
+    #* %{?}{$}{w}d - Whole days in the month.
+    #* %{?}{$}{w{.p}}D - Total (with fractional) days.
+    #<br>Hour Formats:
+    #* %{?}{$}{w}h - Whole hours in the day.
+    #* %{?}{$}{w{.p}}H - Total (with fractional) hours.
+    #<br>Minute Formats:
+    #* %{?}{$}{w}m - Whole minutes in the hour.
+    #* %{?}{$}{w{.p}}M - Total (with fractional) minutes.
+    #<br>Second Formats:
+    #* %{?}{$}{w{.p}}s - Total (with fractional) seconds in the minute.
+    #* %{?}{$}{w{.p}}S - Total (with fractional) seconds.
+    #<br>Brief Summary Formats:
+    #* %{?}{$}{w{.p}}B - Total (with fractional) of the largest, non-zero time unit.
+    #<br>Raw Formats (in seconds and fractions):
+    #* %{w{.p}}f - Total seconds in floating point format.
+    #* %{w}r - Total seconds in rational format.
+    #<br>Where:
+    #* \? is an optional flag indicating that the data should be suppressed if absent.
+    #* \$ is an optional flag indication to retrieve the corresponding text label.
+    #* w is an optional field width parameter.
+    #* p is an optional precision parameter.
+
+    attr_formatter :strfmt,
+    {
+      :before => lambda do
+        tmp[:all]   = arr = src.to_a
+        tmp[:year]  = arr[0]; tmp[0] = src.as_years
+        tmp[:month] = arr[1]; tmp[1] = src.as_months
+        tmp[:day]   = arr[2]; tmp[2] = src.as_days
+        tmp[:hour]  = arr[3]; tmp[3] = src.as_hours
+        tmp[:min]   = arr[4]; tmp[4] = src.as_minutes
+        tmp[:sec]   = arr[5]; tmp[5] = src.as_seconds
+      end,
+
+      "%y"  => lambda {cat "%#{fmt.parm_str}d" % tmp[:year]},
+      "%?y" => lambda {cat "%#{fmt.parm_str}d" % tmp[:year] if tmp[:year] >= 1},
+      "%Y"  => lambda {cat "%#{fmt.parm_str}f" % tmp[0]},
+      "%?Y" => lambda {cat "%#{fmt.parm_str}f" % tmp[0] if tmp[0] > 0},
+
+      "%$y" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(0, tmp[:year])},
+      "%?$y"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(0, tmp[:year]) if tmp[:year] >= 1},
+      "%$Y" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(0, tmp[0])},
+      "%?$Y"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(0, tmp[0]) if tmp[0] > 0},
+
+      "%o"  => lambda {cat "%#{fmt.parm_str}d" % tmp[:month]},
+      "%?o" => lambda {cat "%#{fmt.parm_str}d" % tmp[:month] if tmp[:month] >= 1},
+      "%O"  => lambda {cat "%#{fmt.parm_str}f" % tmp[1]},
+      "%?O" => lambda {cat "%#{fmt.parm_str}f" % tmp[1] if tmp[1] > 0},
+
+      "%$o" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(1, tmp[:month])},
+      "%?$o"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(1, tmp[:month]) if tmp[:month] >= 1},
+      "%$O" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(1, tmp[1])},
+      "%?$O"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(1, tmp[1]) if tmp[1] > 0},
+
+      "%d"  => lambda {cat "%#{fmt.parm_str}d" % tmp[:day]},
+      "%?d" => lambda {cat "%#{fmt.parm_str}d" % tmp[:day] if tmp[:day] >= 1},
+      "%D"  => lambda {cat "%#{fmt.parm_str}f" % tmp[2]},
+      "%?D" => lambda {cat "%#{fmt.parm_str}f" % tmp[2] if tmp[2] > 0},
+
+      "%$d" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(2, tmp[:day])},
+      "%?$d"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(2, tmp[:day]) if tmp[:day] >= 1},
+      "%$D" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(2, tmp[2])},
+      "%?$D"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(2, tmp[2]) if tmp[2] > 0},
+
+      "%h"  => lambda {cat "%#{fmt.parm_str}d" % tmp[:hour]},
+      "%?h" => lambda {cat "%#{fmt.parm_str}d" % tmp[:hour] if tmp[:hour] >= 1},
+      "%H"  => lambda {cat "%#{fmt.parm_str}f" % tmp[3]},
+      "%?H" => lambda {cat "%#{fmt.parm_str}f" % tmp[3] if tmp[3] > 0},
+
+      "%$h" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(3, tmp[:hour])},
+      "%?$h"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(3, tmp[:hour]) if tmp[:hour] >= 1},
+      "%$H" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(3, tmp[3])},
+      "%?$H"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(3, tmp[3]) if tmp[3] > 0},
+
+      "%m"  => lambda {cat "%#{fmt.parm_str}d" % tmp[:min]},
+      "%?m" => lambda {cat "%#{fmt.parm_str}d" % tmp[:min] if tmp[:min] >= 1},
+      "%M"  => lambda {cat "%#{fmt.parm_str}f" % tmp[4]},
+      "%?M" => lambda {cat "%#{fmt.parm_str}f" % tmp[4] if tmp[4] > 0},
+
+      "%$m" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(4, tmp[:min])},
+      "%?$m"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(4, tmp[:min]) if tmp[:min] >= 1},
+      "%$M" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(4, tmp[4])},
+      "%?$M"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(4, tmp[4]) if tmp[4] > 0},
+
+      "%s"  => lambda {cat "%#{fmt.parm_str}f" % tmp[:sec]},
+      "%?s" => lambda {cat "%#{fmt.parm_str}f" % tmp[:sec] if tmp[:sec] >= 1},
+      "%S"  => lambda {cat "%#{fmt.parm_str}f" % tmp[5]},
+      "%?S" => lambda {cat "%#{fmt.parm_str}f" % tmp[5] if tmp[5] > 0},
+
+      "%$s" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(5, tmp[:sec])},
+      "%?$s"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(5, tmp[:sec]) if tmp[:sec] >= 1},
+      "%$S" => lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(5, tmp[5])},
+      "%?$S"=> lambda {cat "%#{fmt.parm_str}s" % Duration.pick_label(5, tmp[5]) if tmp[5] > 0},
+
+      "%B"  => lambda {cat "%#{fmt.parm_str}f" % tmp[src.largest_interval]},
+      "%?B" => lambda {cat "%#{fmt.parm_str}f" % tmp[src.largest_interval] if src.period > 0},
+
+      "%$B" => lambda do
+        index = src.largest_interval
+        cat "%#{fmt.parm_str}s" % Duration.pick_label(index, tmp[index])
+      end,
+      "%?$B" => lambda do
+        if src.period > 0
+          index = src.largest_interval
+          cat "%#{fmt.parm_str}s" % Duration.pick_label(index, tmp[index])
+        end
+      end,
+
+
+      "%f"  => lambda {cat "%#{fmt.parm_str}f" % src.period.to_f},
+      "%r"  => lambda {cat "%#{fmt.parm_str}s" % src.period.to_s}
+    }
+
+
+  end
+
+  format_action = lambda do |vm|
+    begin
+      vm.poke(self.strfmt(vm.peek))
+    rescue => err
+      vm.data_stack.pop
+      error "F40: Formating error: #{err.message}."
+    end
+  end
+
+  # [a_time a_string] format [a_string]
+  Duration.create_shared_method('format', NosSpec, [], &format_action)
+
+  # [a_time] f"string" [a_string]
+  Duration.create_shared_method('f"', NosSpec, [], &format_action)
+
+end

data/lib/fOOrth/library/duration/intervals.rb

@@ -0,0 +1,233 @@
+# coding: utf-8
+
+#* library/duration/intervals.rb - Duration intervals support library.
+module XfOOrth
+
+  #Intervals support for the \Duration class.
+  class Duration
+
+    #Seconds in a second.
+    A_SECOND = Duration.new(1.to_r)
+
+    #Seconds in a minute.
+    A_MINUTE = Duration.new(60 * A_SECOND.to_r)
+
+    #Seconds in an hour.
+    AN_HOUR  = Duration.new(60 * A_MINUTE.to_r)
+
+    #Seconds in a day.
+    A_DAY    = Duration.new(24 * AN_HOUR.to_r)
+
+    #Seconds in a (average) month.
+    A_MONTH  = Duration.new(Rational(365_2425, 120000) * A_DAY.to_r)
+
+    #Seconds in a (average) year.
+    A_YEAR   = Duration.new(12 * A_MONTH.to_r)
+
+    #An array of interval values.
+    INTERVALS = [A_YEAR, A_MONTH, A_DAY, AN_HOUR, A_MINUTE, A_SECOND]
+
+    #An array of interval labels.
+    LABELS = ["years", "months", "days", "hours", "minutes", "seconds"]
+
+    #Pick the appropriate label
+    #<br>Endemic Code Smells
+    #* :reek:ControlParameter
+    def self.pick_label(index, qty=1)
+      result = LABELS[index]
+      result = result.chop if qty == 1
+      " " + result
+    end
+
+    #Find the largest interval for this duration
+    def largest_interval
+      (0..5).detect {|idx| INTERVALS[idx] <= period} || 5
+    end
+
+    #How many whole years in this duration?
+    def years
+      (@period/A_YEAR.to_r).to_i
+    end
+
+    #How many total years in this duration?
+    def as_years
+      (@period/A_YEAR.to_r).to_f
+    end
+
+
+    #How many months into the year in this duration?
+    def months
+      ((@period % A_YEAR.to_r)/A_MONTH.to_r).to_i
+    end
+
+    #How many total months in this duration?
+    def as_months
+      (@period/A_MONTH.to_r).to_f
+    end
+
+
+    #How many days into the month in this duration?
+    def days
+      ((@period % A_MONTH.to_r)/A_DAY.to_r).to_i
+    end
+
+    #How many total days in this duration?
+    def as_days
+      (@period/A_DAY.to_r).to_f
+    end
+
+
+    #How many hours into the day in this duration?
+    def hours
+      (((@period % A_MONTH.to_r) % A_DAY.to_r)/AN_HOUR.to_r).to_i
+    end
+
+    #How many total hours in this duration?
+    def as_hours
+      (@period/AN_HOUR.to_r).to_f
+    end
+
+
+    #How many minutes into the hour in this duration?
+    def minutes
+      (((@period % A_MONTH.to_r) % AN_HOUR.to_r)/A_MINUTE.to_r).to_i
+    end
+
+    #How many total minutes in this duration?
+    def as_minutes
+      (@period/A_MINUTE.to_r).to_f
+    end
+
+
+    #How many seconds into the minute in this duration?
+    def seconds
+      ((@period % A_MONTH.to_r) % A_MINUTE.to_f)
+    end
+
+    #How many total seconds in this duration?
+    def as_seconds
+      @period.to_f
+    end
+
+  end
+
+
+  #Methods to retrieve interval values from the Duration class.
+
+  #[Duration] .intervals [array]
+  Duration.create_exclusive_method('.intervals', TosSpec, [], &lambda {|vm|
+    vm.push(Duration::INTERVALS)
+  })
+
+  #[Duration] .labels [array]
+  Duration.create_exclusive_method('.labels', TosSpec, [], &lambda {|vm|
+    vm.push(Duration::LABELS)
+  })
+
+  #[] a_year [a_duration]
+  VirtualMachine.create_shared_method('a_year', VmSpec, [], &lambda {|vm|
+    vm.push(Duration::A_YEAR)
+  })
+
+  #[] a_month [a_duration]
+  VirtualMachine.create_shared_method('a_month', VmSpec, [], &lambda {|vm|
+    vm.push(Duration::A_MONTH)
+  })
+
+  #[] a_day [a_duration]
+  VirtualMachine.create_shared_method('a_day', VmSpec, [], &lambda {|vm|
+    vm.push(Duration::A_DAY)
+  })
+
+  #[] an_hour [a_duration]
+  VirtualMachine.create_shared_method('an_hour', VmSpec, [], &lambda {|vm|
+    vm.push(Duration::AN_HOUR)
+  })
+
+  #[] a_minute [a_duration]
+  VirtualMachine.create_shared_method('a_minute', VmSpec, [], &lambda {|vm|
+    vm.push(Duration::A_MINUTE)
+  })
+
+  #[] a_second [a_duration]
+  VirtualMachine.create_shared_method('a_second', VmSpec, [], &lambda {|vm|
+    vm.push(Duration::A_SECOND)
+  })
+
+
+  #Methods to deal with intervals.
+
+  #[a_duration] .largest_interval [an_index(0..5)]
+  Duration.create_shared_method('.largest_interval', TosSpec, [], &lambda {|vm|
+    vm.push(self.largest_interval)
+  })
+
+
+  #[a_duration] .years [an_integer]
+  Duration.create_shared_method('.years', TosSpec, [], &lambda {|vm|
+    vm.push(self.years)
+  })
+
+  #[a_duration] .as_years [a_float]
+  Duration.create_shared_method('.as_years', TosSpec, [], &lambda {|vm|
+    vm.push(self.as_years)
+  })
+
+
+  #[a_duration] .months [an_integer]
+  Duration.create_shared_method('.months', TosSpec, [], &lambda {|vm|
+    vm.push(self.months)
+  })
+
+  #[a_duration] .as_months [a_float]
+  Duration.create_shared_method('.as_months', TosSpec, [], &lambda {|vm|
+    vm.push(self.as_months)
+  })
+
+
+  #[a_duration] .days [an_integer]
+  Duration.create_shared_method('.days', TosSpec, [], &lambda {|vm|
+    vm.push(self.days)
+  })
+
+  #[a_duration] .as_days [a_float]
+  Duration.create_shared_method('.as_days', TosSpec, [], &lambda {|vm|
+    vm.push(self.as_days)
+  })
+
+
+  #[a_duration] .hours [an_integer]
+  Duration.create_shared_method('.hours', TosSpec, [], &lambda {|vm|
+    vm.push(self.hours)
+  })
+
+  #[a_duration] .as_hours [a_float]
+  Duration.create_shared_method('.as_hours', TosSpec, [], &lambda {|vm|
+    vm.push(self.as_hours)
+  })
+
+
+  #[a_duration] .minutes [an_integer]
+  Duration.create_shared_method('.minutes', TosSpec, [], &lambda {|vm|
+    vm.push(self.minutes)
+  })
+
+  #[a_duration] .as_minutes [a_float]
+  Duration.create_shared_method('.as_minutes', TosSpec, [], &lambda {|vm|
+    vm.push(self.as_minutes)
+  })
+
+
+  #[a_duration] .seconds [an_integer]
+  Duration.create_shared_method('.seconds', TosSpec, [], &lambda {|vm|
+    vm.push(self.seconds)
+  })
+
+  #[a_duration] .as_seconds [a_float]
+  Duration.create_shared_method('.as_seconds', TosSpec, [], &lambda {|vm|
+    vm.push(self.as_seconds)
+  })
+
+
+
+end