evt-clock 0.4.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3774995830bf251f1db6d3579490b50349ee2707
+  data.tar.gz: 881f4843ee93399302a4c8eb3d8aa09c9b85ffc4
+SHA512:
+  metadata.gz: 05a468f10b8e34e7d10b49d6e9f8fe26a689ceeb33dc4231fbf97b16956fee2e550eb0abacf75949031c40a2237b83f7fa641cced1ad9f6b6ad0285ab053ff63
+  data.tar.gz: db2e35f806c8393b2e87f5c3a598e7ef391537727c24db0910500c68e3dfd14aca6d5e237295a123a3b2f288f322a044d1652e8bd4bed2fbc779e215d2592171

data/lib/clock.rb

@@ -0,0 +1,11 @@
+require 'time'
+require 'tzinfo'
+require 'ostruct'
+require 'naught'
+
+require 'clock/clock'
+require 'clock/substitute'
+require 'clock/utc'
+require 'clock/local'
+require 'clock/localized'
+require 'clock/localized/timezone'

data/lib/clock/clock.rb

@@ -0,0 +1,141 @@
+module Clock
+  class Error < RuntimeError; end
+
+  def self.included(cls)
+    cls.extend Now
+    cls.extend Canonize
+    cls.extend SystemTime
+    cls.extend ISO8601
+    cls.extend Parse
+    cls.extend ElapsedMilliseconds
+    cls.extend Timestamp
+    cls.extend Configure
+  end
+
+  def now(time=nil)
+    time || self.class.now(system_time: system_time)
+  end
+
+  def canonize(time)
+    self.class.canonize(time, system_time)
+  end
+
+  def system_time
+    self.class.system_time
+  end
+
+  def iso8601(time=nil, precision: nil)
+    time ||= now
+    self.class.iso8601 time, precision: precision, system_time: system_time
+  end
+
+  def parse(str)
+    time = self.class.parse(str, system_time: system_time)
+  end
+
+  def timestamp(time=nil)
+    self.class.timestamp time
+  end
+
+  def self.local(time)
+    time.getlocal
+  end
+
+  def self.localized(time, identifier)
+    clock = Localized.build identifier
+    clock.canonize time
+  end
+
+  def self.utc(time)
+    time.utc
+  end
+
+  def elapsed_milliseconds(start_time, end_time)
+    self.class.elapsed_milliseconds(start_time, end_time)
+  end
+
+  module Now
+    def now(time=nil, system_time: nil)
+      system_time ||= self.system_time
+      time ||= system_time.now
+      canonize(time, system_time)
+    end
+  end
+
+  module Canonize
+    def canonize(time, system_time)
+      time
+    end
+  end
+
+  module SystemTime
+    extend self
+    def system_time
+      Time
+    end
+  end
+
+  module ISO8601
+    extend self
+    def iso8601(time=nil, precision: nil, system_time: nil)
+      precision ||= self.precision
+      time ||= now(system_time: system_time)
+      time.iso8601(precision)
+    end
+
+    def precision
+      Defaults.precision
+    end
+
+    module Defaults
+      def self.precision
+        3
+      end
+    end
+  end
+
+  module Parse
+    extend self
+    def parse(str, system_time: nil)
+      system_time ||= self.system_time
+      time = Time.parse str
+      canonize(time, system_time)
+    end
+  end
+
+  module ElapsedMilliseconds
+    extend self
+    def elapsed_milliseconds(start_time, end_time=nil, system_time: nil)
+      end_time ||= now(system_time: system_time)
+
+      start_time = parse(start_time) if start_time.is_a? String
+      end_time = parse(end_time) if end_time.is_a? String
+
+      ((end_time - start_time) * 1000).round
+    end
+  end
+
+  module Timestamp
+    extend self
+    def timestamp(time=nil, system_time: nil)
+      time ||= now(system_time: system_time)
+      time.to_f
+    end
+  end
+
+  module Configure
+    def configure(receiver)
+      instance = new
+      receiver.clock = instance
+      instance
+    end
+  end
+
+  extend Now
+  extend Canonize
+  extend SystemTime
+  extend ISO8601
+  extend Parse
+  extend ElapsedMilliseconds
+  extend Timestamp
+end

data/lib/clock/controls.rb

@@ -0,0 +1,2 @@
+require 'clock/controls/time'
+require 'clock/controls/time/offset'

data/lib/clock/controls/time.rb

@@ -0,0 +1,28 @@
+module Clock
+  module Controls
+    module Time
+      def self.example(time=nil, precision: nil)
+        time ||= Raw.example
+
+        ISO8601.example(time, precision: precision)
+      end
+
+      def self.reference
+        ::Time.utc 2000
+      end
+
+      module Raw
+        def self.example
+          Time.reference
+        end
+      end
+
+      module ISO8601
+        def self.example(time=nil, precision: nil)
+          time ||= Raw.example
+          UTC.iso8601(time, precision: precision)
+        end
+      end
+    end
+  end
+end

data/lib/clock/controls/time/offset.rb

@@ -0,0 +1,34 @@
+module Clock
+  module Controls
+    module Time
+      module Offset
+        def self.example(amount=nil, precision: nil, time: nil)
+          offset_time = Raw.example amount, precision: precision, time: time
+
+          ISO8601.example offset_time, precision: precision
+        end
+
+        module Raw
+          def self.example(amount=nil, precision: nil, time: nil)
+            amount ||= 1
+            time ||= Time::Raw.example
+
+            scale = scale(precision: precision)
+
+            offset = amount * scale
+
+            time + offset
+          end
+
+          def self.scale(precision: nil)
+            precision ||= Clock::ISO8601::Defaults.precision
+
+            scale = 10 ** precision
+
+            Rational(1, scale)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clock/local.rb

@@ -0,0 +1,15 @@
+module Clock
+  class Local
+    include Clock
+
+    def self.canonize(time, *)
+      Clock.local(time)
+    end
+
+    module Substitute
+      def self.build
+        Clock::Substitute.new
+      end
+    end
+  end
+end

data/lib/clock/localized.rb

@@ -0,0 +1,60 @@
+module Clock
+  class Localized
+    include Clock
+
+    attr_reader :timezone
+
+    def initialize(timezone)
+      @timezone = timezone
+    end
+
+    def self.build(timezone_identifier=nil, utc_reference: nil)
+      timezone = Timezone.build timezone_identifier, utc_reference: utc_reference
+      new(timezone)
+    end
+
+    def self.configure(receiver, timezone_identifier=nil)
+      instance = build(timezone_identifier)
+      receiver.clock = instance
+      instance
+    end
+
+    def system_time
+      timezone
+    end
+
+    def self.canonize(time, system_time)
+      time = time.utc
+      system_time.utc_to_local time
+    end
+
+    def self.iso8601(time, precision: nil, system_time: nil)
+      time ||= now time, system_time: system_time
+      utc_time = time.utc
+      local_time = system_time.utc_to_local utc_time
+      local_time.iso8601 precision
+    end
+
+    module Defaults
+      def self.timezone_identifier(timezone_identifier)
+        env_identifier = ENV['TIMEZONE']
+
+        if env_identifier
+          timezone_identifier = env_identifier
+        end
+
+        unless timezone_identifier
+          timezone_identifier = 'America/Mexico_City'
+        end
+
+        timezone_identifier
+      end
+    end
+
+    module Substitute
+      def self.build
+        Clock::Substitute.new
+      end
+    end
+  end
+end

data/lib/clock/localized/timezone.rb

@@ -0,0 +1,60 @@
+module Clock
+  class Localized
+    class Timezone
+      attr_reader :tzinfo_timezone
+      attr_reader :utc_reference
+
+      def initialize(tzinfo_timezone, utc_reference)
+        @tzinfo_timezone = tzinfo_timezone
+        @utc_reference = utc_reference
+      end
+
+      def self.build(timezone_identifier=nil, utc_reference: nil)
+        utc_reference ||= Time.now.utc
+
+        timezone_identifier = Defaults.timezone_identifier(timezone_identifier)
+        tzinfo_timezone = TZInfo::Timezone.get(timezone_identifier)
+
+        new tzinfo_timezone, utc_reference
+      end
+
+      def period
+        tzinfo_timezone.period_for_utc utc_reference
+      end
+
+      def now(tzinfo_time=nil)
+        tzinfo_time ||= tzinfo_timezone.now
+        convert tzinfo_time
+      end
+
+      def utc_to_local(utc_time)
+        tzinfo_time = tzinfo_timezone.utc_to_local utc_time
+        convert tzinfo_time
+      end
+
+      def convert(tzinfo_time)
+        seconds = tzinfo_time.sec + tzinfo_time.subsec
+
+        Time.new(
+          tzinfo_time.year,
+          tzinfo_time.month,
+          tzinfo_time.day,
+          tzinfo_time.hour,
+          tzinfo_time.min,
+          seconds,
+          offset
+        )
+      end
+
+      def offset
+        total_offset = period.offset.utc_total_offset
+
+        hours, seconds = total_offset.abs.divmod 3600
+        minutes = seconds / 60
+
+        sign = total_offset > 0 ? '+' : '-'
+        offset = "#{sign}#{hours.to_s.rjust(2, '0')}:#{minutes.to_s.rjust(2, '0')}"
+      end
+    end
+  end
+end

data/lib/clock/substitute.rb

@@ -0,0 +1,31 @@
+module Clock
+  class Substitute
+    include Clock
+
+    attr_writer :system_time
+
+    def system_time
+      @system_time ||= NullTime.build
+    end
+
+    def now=(val)
+      system_time = OpenStruct.new
+      system_time.now = val
+      self.system_time = system_time
+      system_time
+    end
+
+    def iso8601(*args)
+      if system_time.is_a? OpenStruct
+        return super(*args)
+      end
+      nil
+    end
+
+    class NullTime < Naught.build
+      def self.build
+        new
+      end
+    end
+  end
+end

data/lib/clock/utc.rb

@@ -0,0 +1,33 @@
+module Clock
+  class UTC
+    include Clock
+
+    def self.canonize(time, *)
+      Clock.utc(time)
+    end
+
+    def coerce(time)
+      self.class.shift(time)
+    end
+
+    def self.coerce(time)
+      if time.is_a? String
+        time = Time.parse(time)
+      end
+
+      offset = time.gmt_offset
+
+      utc_time = time.getutc
+
+      utc_time = utc_time + offset
+
+      now(utc_time)
+    end
+
+    module Substitute
+      def self.build
+        Clock::Substitute.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: evt-clock
+version: !ruby/object:Gem::Version
+  version: 0.4.0.2
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: naught
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ntl-test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/clock.rb
+- lib/clock/clock.rb
+- lib/clock/controls.rb
+- lib/clock/controls/time.rb
+- lib/clock/controls/time/offset.rb
+- lib/clock/local.rb
+- lib/clock/localized.rb
+- lib/clock/localized/timezone.rb
+- lib/clock/substitute.rb
+- lib/clock/utc.rb
+homepage: https://github.com/eventide-project/clock
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Clock interface with support for dependency configuration for real and null
+  object implementations
+test_files: []