itsu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18def3cf1e319629ae966bc3ae382e4a039b3d46
+  data.tar.gz: a9e5321576e0a64abfe35ddb7d130989ab9775d4
+SHA512:
+  metadata.gz: 4c48409817aa85e711f34021ac671ee44bd714f99223b5dc082f4b87aee14dd6eb8a2b8155f659cb6d8329deb061037d439d571679bc584827c0defdbe518fd0
+  data.tar.gz: 648312cfbca28e447df46ccc0b4c83f4653a0361d694259b30f1dfe17c7fc89bf7b444d61837935a82fc65f694d7fd5c48b34c161431bcd3e4635800dfb33691

data/lib/itsu.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+
+# Simple Time checking library.
+# The goal is to check on regularly occurring events in a business cycle,
+# such as something that needs to happen every week, month, or quarter.
+# 
+# All time math is done relative to the time zone of the supplied argument.
+#
+module Itsu
+  module_function
+
+  # Supported period constants
+  #
+  module Period
+    WEEK = 'week'
+    MONTH = 'month'
+    QUARTER = 'quarter'
+  end
+
+  SECONDS_IN_HOUR = 3600
+  SECONDS_IN_DAY = 86400
+
+  # Roll back the time to the beginning of the day (midnight, 00:00:00)
+  #
+  # @param [Time] time Timestamp
+  # @return [Time] Timestamp of the start of the day.
+  # 
+  def start_of_day(time)
+    day = time - time.hour * SECONDS_IN_HOUR
+    day -= time.min * 60
+    day -= time.sec
+    _adjust_dst(day)
+  end
+
+  # Get the starting time for the first day of the week (Monday) relative to
+  # the provided timestamp.
+  # If the timestamp is on Monday, will return the start of the same day.
+  #
+  # @param [Time] time Timestamp
+  # @return [Time] Timestamp of the previous Monday.
+  #
+  def start_of_week(time)
+    mon = time - ((time.wday + 6) % 7 * SECONDS_IN_DAY)
+    start_of_day(mon)
+  end
+
+  # Roll back the time to the beginning of the month.
+  #
+  # @param [Time] time Timestamp
+  # @return [Time] Timestamp of the start of the month.
+  # 
+  def start_of_month(time)
+    first = time - (time.mday - 1) * SECONDS_IN_DAY
+    start_of_day(first)
+  end
+
+  # Get the starting time for the first day of the quarter relative to the
+  # provided timestamp.
+  #
+  # @param [Time] time Timestamp
+  # @return [Time] Timestamp of the start of the quarter.
+  #
+  def start_of_quarter(time)
+    back = (time.mon - 1) % 3
+    qtr = time
+    (1..back).each { qtr -= qtr.mday * SECONDS_IN_DAY }
+    start_of_month(qtr)
+  end
+
+  # Determine if a time falls within the current period.
+  # For example, if the period is 'week', then check if the date falls within
+  # the current week.
+  # This can be used to test if a occurrence has already happened this period.
+  # For weeks, consider the week to start on Monday.
+  # This is a history check. All future times will return true.
+  #
+  # @param [Time] time Timestamp to check.
+  # @param [Itsu::Period] period Period to check against.
+  # @return [Boolean] Whether the timestamp is within the most recent period.
+  #
+  def in_period?(time, period)
+    case period
+    when Period::WEEK
+      time > start_of_week(Time.now)
+    when Period::MONTH
+      time > start_of_month(Time.now)
+    when Period::QUARTER
+      time > start_of_quarter(Time.now)
+    else
+      raise ArgumentError, "Unrecognized period, #{period}."
+    end
+  end
+
+  def _adjust_dst(time)
+    # Internal method. Assumes midnight adjustments have already occurred.
+    case time.hour
+    when 0
+      time
+    when 1
+      time - SECONDS_IN_HOUR
+    when 23
+      time + SECONDS_IN_HOUR
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: itsu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael S. Daines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies: []
+description: Simple Time library. The goal is to check on regularly occurring events
+  in a business cycle, such as something that needs to happen every week, month, or
+  quarter.
+email: defndaines@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/itsu.rb
+homepage: http://rubygems.org/gems/itsu
+licenses:
+- EPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: itsu (いつ), a simple time library.
+test_files: []