safedb 0.01.0001

data/lib/session/time.stamp.rb

@@ -0,0 +1,340 @@
+#!/usr/bin/ruby
+
+module OpenSession
+
+  require 'singleton'
+
+  # This stamp sits at the centre of a fundamental DevOps pattern concerned
+  # with infrastructure provisioning and configuraion management.
+  #
+  # The central idea behind the pattern is to link every infrastructure
+  # object created during a session with a reference accurate to the nearest
+  # centi-second denoting the moment the software runtime (session) began.
+  class Stamp
+    include Singleton
+
+    attr_reader :time_now
+
+    # Return two digit [mo] month index from 01 to 12.
+    # @example 02 => in February
+    def self.mo
+      return Stamp.instance.time_now.strftime "%m"
+    end
+
+
+    # Return three character abbreviated month name.
+    # @example feb => in February
+    def self.mmm
+      return Stamp.instance.time_now.strftime( "%b" ).downcase
+    end
+
+
+    # Return three character abbreviated day of week.
+    # @example tue => on Tuesday
+    def self.ddd
+      return Stamp.instance.time_now.strftime( "%a" ).downcase
+    end
+
+
+    # Return two digit (character) hour of day from 00 to 23.
+    # @example 22 => between 22.00.00 and 22.59.59 inclusive
+    def self.hh
+      return Stamp.instance.time_now.strftime "%H"
+    end
+
+
+    # Return two digit minute of hour from [00] to [59].
+    def self.mm
+      return Stamp.instance.time_now.strftime "%M"
+    end
+
+
+    # Return two digit second of minute from [00] to [59].
+    def self.ss
+      return Stamp.instance.time_now.strftime "%S"
+    end
+
+
+    # Return a [3 digit] second and tenth of second
+    # representation.
+    #
+    # The final digit is derived from the 1000 sliced
+    # millisecond of second running from 000 to 999.
+    #
+    # <tt>Truncation (Not Rounding)</tt>
+    #
+    # The [final] digit is acquired by TRUNCATING
+    # (chopping off) the last 2 of the 3 millisecond
+    # digits. No rounding is applied.
+    #
+    # The 3 returned digits comprise of the
+    #
+    # - second of minute => 2 digits | [00] to [59] (and)
+    # - tenth of second  => 1 digit from [0] to [9]
+    #
+    # @example
+    #
+    #  => The time at the 562nd millisecond  of the 49th
+    #     second of the minute.
+    #
+    #  => 3 chars
+    #  => 495
+    def self.sst
+      millisec_string = Stamp.instance.time_now.strftime "%L"
+      return "#{ss}#{millisec_string[0]}"
+    end
+
+
+    # Return the [two] digit year (eg 19 for 2019).
+    # that we are currently in.
+    def self.yy
+      return Stamp.instance.time_now.strftime("%Y")[2..-1]
+    end
+
+
+    # Return the [four] digit year (eg 2019)
+    # that we are currently in.
+    def self.yyyy
+      return Stamp.instance.time_now.strftime("%Y")
+    end
+
+
+    # Return 3 digit julian day of year [001] to [366].
+    def self.jjj
+      return Stamp.instance.time_now.strftime "%j"
+    end
+
+
+    # [yymo_mmm] returns an amalgam of
+    #
+    #    => the two-digit year
+    #    => the two-digit month index (starting at 01)
+    #    => a period (separator)
+    #    => the abbreviated month name
+    #
+    # @example
+    #   => 1908.aug
+    #   => for August 2019
+    #
+    def self.yymo_mmm
+      return "#{yy}#{mo}.#{mmm}"
+    end
+
+
+    # Given two integer parameters (month index and 4 digit year) representing
+    # the month in question this method returns the [PREVIOUS MONTHS] character
+    # amalgam in the format [yymo_mmm] where
+    #
+    #    => yy  | previous month's two-digit year
+    #    => mo  | previous month's two-digit month index
+    #    => .   | a period (separator)
+    #    => mmm | previous month's abbreviated month name
+    #
+    # -------------------
+    # Example 1 (Simple)
+    # -------------------
+    #
+    #  returns char => 1907.jul
+    #  4 parameters => 8, 2019
+    #  representing => August, 2019
+    #
+    # ----------------------
+    # Example 2 (Last Year)
+    # ----------------------
+    #
+    #  returns char => 1812.dec
+    #  4 parameters => 1, 2019
+    #  representing => January, 2019
+    def self.previous_month_chars this_month_index, this_4digit_year
+
+      prev_month_index = this_month_index == 1 ? 12 : ( this_month_index - 1 )
+      prev_2dig_mn_pad = sprintf '%02d', prev_month_index
+      prev_4digit_year = this_month_index == 1 ? ( this_4digit_year - 1 ) : this_4digit_year
+      prev_twodigit_yr = "#{prev_4digit_year.to_s}"[2..-1]
+      prev_months_name = Date::ABBR_MONTHNAMES[prev_month_index].downcase
+
+      return "#{prev_twodigit_yr}#{prev_2dig_mn_pad}.#{prev_months_name}"
+
+    end
+
+    # Using the current class time this method returns
+    # the character amalgam for the [PREVIOUS MONTH] in
+    # the format [yymo_mmm] where
+    #
+    #    => yy  | last month's two-digit year
+    #    => mo  | last month's two-digit month index
+    #    => .   | a period (separator)
+    #    => mmm | last month's abbreviated month name
+    #
+    # -------------------
+    # Example 1 (Simple)
+    # -------------------
+    #
+    #  returns => 1907.jul
+    #  if this month is => August 2019
+    #
+    # ----------------------
+    # Example 2 (Last Year)
+    # ----------------------
+    #
+    #  returns => 1812.dec
+    #  if this month is => January 2019
+    def self.yymo_mmm_prev
+      return previous_month_chars mo.to_i, yyyy.to_i
+    end
+
+
+    # Return 5 digit amalgam of year and julian day.
+    #  eg [19003] for [January 3rd 2019]
+    def self.yyjjj
+      return "#{yy}#{jjj}"
+    end
+
+
+    # Return the 4 digit amalgam of the hour and minute
+    # using the 24 hour clock.
+    #
+    # @example
+    #   => 1525
+    #   => 03:25 pm
+    def self.hhmm
+      return "#{hh}#{mm}"
+    end
+
+
+    # Return the time of day to a TENTH of a second accuracy.
+    # [8] characters will always be returned with the 5th one
+    # being the (period) separator.
+    #
+    # The first (separated) segment delivers a hhmm 24 hour
+    # clock representation of the stamped time.
+    #
+    # The 3 digits of the second segment comprise of
+    #
+    #   second of minute => 2 digits | [00] to [59]
+    #   tenth of second  => 1 digit from [0] to [9]
+    #
+    # @example
+    #   => The time at the 562nd millisecond  of the 49th
+    #      second of the 23rd minute of the 17th hour of
+    #      the day ( 17:23:49.562 )
+    #
+    #   => 8 chars
+    #   => 1723.495
+    def self.hhmm_sst
+      return "#{hhmm}.#{sst}"
+    end
+
+
+    # Return a string timestampt that is a period separated
+    # amalgam of the 2 digit year, 3 digit julian day, 2 digit
+    # hour, 2 digit minute, 2 digit second and 1 digit rounded
+    # down tenth of second.
+    #
+    # @example
+    #   => 19003.1025
+    #   => 10:25 am on January 3rd 2019
+    #
+    #
+    # Return the time of day to a TENTH of a second accuracy.
+    # [8] characters will always be returned with the 5th one
+    # being the (period) separator.
+    #
+    # The first (separated) segment delivers a hhmm 24 hour
+    # clock representation of the stamped time.
+    #
+    # The 3 digits of the second segment comprise of
+    #
+    # - second of minute => 2 digits | [00] to [59]
+    # - tenth of second  => 1 digit from [0] to [9]
+    #
+    # @example
+    #   => The time at the 562nd millisecond  of the 49th
+    #      second of the 23rd minute of the 17th hour of
+    #      the day ( 17:23:49.562 )
+    #
+    #   => 8 chars
+    #   => 1723.495
+    def self.yyjjj_hhmm_sst
+      return "#{yyjjj}.#{hhmm}.#{sst}"
+    end
+
+
+    # Return a string timestampt that is a period separated
+    # amalgam of the 2 digit year, 3 digit julian day, 2 digit
+    # hour, 2 digit minute, 2 digit second and <b>9 digit</b>
+    # nanosecond.
+    #
+    # @example
+    #   return  => 19003.1725.42.836592034
+    #   4 time  => 17:25:42 am on January 3rd 2019
+    #
+    # As per the above example, the time returned
+    #
+    # - is the 836592034 <b>nanosecond</b>
+    # - of the 42nd <b>second</b>
+    # - of the 25th <b>minute</b>
+    # - of the 17th <b>hour</b>
+    # - of the 3rd <b>day</b>
+    # - of the 20th <b>year</b>
+    # - of the 21st <b>century</b>
+    #
+    # @return [String]
+    #    Return the time of day to nanosecond accuracy.
+    #    23 characters are always returned with three (3) period
+    #    separators at the 6th, 11th and 14th positions.
+    def self.yyjjj_hhmm_ss_nanosec
+      nanosec_str = Stamp.instance.time_now.strftime "%9N"
+      return "#{yyjjj}.#{hhmm}.#{ss}.#{nanosec_str}"
+    end
+
+
+    # Return the Rubyfied time zone being used.
+    def self.zone
+      return Stamp.instance.time_now.zone
+    end
+
+
+    # Log segments of time pertaining to the time stamp.
+    # @todo
+    #    move method contents into test class
+    def self.log_instance_time
+
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] eco time stamp => [#{Stamp.instance.time_now.ctime}]" }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] Univ Time Zone => #{zone}"  }
+      log.info(x) { "[stamp] Month Index is => #{mo}"    }
+      log.info(x) { "[stamp] Month Name is  => #{mmm}"   }
+      log.info(x) { "[stamp] Day Of Week is => #{ddd}"   }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] Two Digit Year => #{yy}"    }
+      log.info(x) { "[stamp] Julian Cal Day => #{jjj}"   }
+      log.info(x) { "[stamp] Yr and Jul Day => #{yyjjj}" }
+      log.info(x) { "[stamp] Hour of Theday => #{hh}"    }
+      log.info(x) { "[stamp] Minute of Hour => #{mm}"    }
+      log.info(x) { "[stamp] Hour + Minute  => #{hhmm}"  }
+      log.info(x) { "[stamp] Second of Min  => #{ss}"    }
+      log.info(x) { "[stamp] 600 Min Slices => #{sst}"   }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] The Time Stamp => #{yyjjj_hhmm_sst}" }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+
+    end
+
+
+    # This singleton (one instance) class sets the time just once.
+    def initialize
+
+      @time_now = Time.now;
+
+    end
+
+
+############    Stamp.log_instance_time
+
+
+  end
+
+
+end

data/lib/session/user.home.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby
+
+# coding: utf-8
+
+# opensession contains basic behaviour for managing a client only
+# (serverless) session. Configuration directives are read and written
+# from an INI off the home directory that is created when the session
+# is first initiated.
+module OpenSession
+
+  # This singleton class ascertains the users home folder in a manner
+  # agnositic to whether the software is running on Linux or Windows.
+  class Home
+    include Singleton
+
+    # This static behaviour reads the [home folder] just once.
+    def self.dir
+      return Home.instance.folder
+    end
+
+    # This static behaviour reads the [username] just once.
+    def self.usr
+      return Home.instance.username
+    end
+
+    attr_reader :folder
+    attr_reader :username
+
+    # Ascertain the home folder location.
+    def initialize
+
+      # On Windows the home folder may end with [AppData/Roaming].
+      extraneous_path = "/AppData/Roaming"
+
+      @folder  = Dir.home
+      @username = @folder.split("/").last
+      return unless Dir.home.end_with? extraneous_path
+
+      # Remove the tail [AppData/Roaming] from the home path.
+      @folder = Dir.home.gsub extraneous_path, ""
+      @username = @folder.split("/").last
+
+    end
+
+
+  end
+
+
+end