ozone 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89f0892ad2d69ebd4e89ea7334e4e3cda9e60fd8
-  data.tar.gz: 9387af4d22b447496660ee99b3298452f00b204d
+  metadata.gz: 6333a6bb89f133a43dcf273dd82f5d7a2de819e6
+  data.tar.gz: 8eeeb170d91b60cc8a6dd40fb580b2469d46f99f
 SHA512:
-  metadata.gz: a422392e2f7dcadf2961a47ce9f5079f2805f66243b0f6ba1fe2d67ed2059215eee63d9f6be2a56de4c5879cc9bf0735b90ccd4dee466450b6602a94968e477b
-  data.tar.gz: b30c116550d69b2dfb8caa6ab76f20a611ab75ba11f0fd920602c4ec881b8b7181302653abdff0f296d65e4ca604b46aa11db992cfc3f6f3462b827c24c8d623
+  metadata.gz: 2a45fc5be2db9076de08bfc80249dd2daa966cdb65baa6f9b802b36b14e1849a8cdefc07609c7c80855f050238d1c0e98474a5f7fcc2e10e5e1d09fedaea63e8
+  data.tar.gz: 547347a2b563f3191a643f9de83c734f4e6560e15a47ee9da2ecaa827d195998ed22c4b7a643d132c857fa038680eba07a1e806f4a826d5b9f72580ca7595088

data/README.md

@@ -3,7 +3,10 @@ Convert time based on offset, with or without dst
 =======
 # Ozone
 
-Given an offset (in minutes) and a boolean whether to observe daylight savings, convert a ruby time to a string representation, adjusted by offset, and either abiding by or ignoring daylight savings.
+Given a ruby time, an offset (in minutes), and a boolean whether to observe daylight savings, Ozone provides two things:
+
+1) Convert a ruby time to a string representation, adjusted by offset, and either abiding by or ignoring daylight savings.
+2) Compare with a ruby time to see whether before or after, either abiding by or ignoring daylight savings.
 
 ## Installation
 
@@ -23,16 +26,54 @@ Or install it yourself as:
 
 ## Usage
 
-Ozone has just one method -- call -- which takes a time, offset (from utc, in minutes), whether to use daylight savings, and a [time format](http://ruby-doc.org/core-2.2.0/Time.html#method-i-strftime). Default format is YYYY-MM-DD HH:MM.
+An instance of Ozone::Time can be compared with a ruby time.
+
+When observes_dst is true, Ozone::Time has the same value as ruby Time when making comparisons.
+
+```ruby
+dst_time = Time.parse("2014-03-09 10:00:00 UTC")
+ozone_time = Ozone::Time.new(
+  time: dst_time,
+  offset: -480,
+  observes_dst: true,
+)
+
+> ozone_time.before?(1.second.since(dst_time))
+=> true
+> ozone_time.before?(1.second.until(dst_time))
+=> false
+```
+
+However, when observes_dst is false:
 
 ```ruby
-> Ozone.call(time: t, offset: -480, observes_dst: true)
+ozone_time = Time.new(
+  time: dst_time,
+  offset: -480,
+  observes_dst: false,
+)
+
+> ozone_time.before?(1.second.since(dst_time)
+=> true
+> ozone_time.before?(1.second.until(dst_time)
+=> true
+```
+
+This is because during daylight savings, times will be adjusted backwards 1 hour if daylight savings
+is not being observed.
+
+Ozone::Formatter has one method -- call -- which takes a time, offset (from utc, in minutes), whether to use daylight savings, and a [time format](http://ruby-doc.org/core-2.2.0/Time.html#method-i-strftime). Default format is YYYY-MM-DD HH:MM.
+
+```ruby
+> Ozone::Formatter.call(time: t, offset: -480, observes_dst: true)
 => "2014/07/17 17:30"
 
-> Ozone.call(time: t, offset: -480, observes_dst: false)
+> Ozone::Formatter.call(time: t, offset: -480, observes_dst: false)
 => "2014/07/17 16:30"
 ```
 
+This functionality can also be accessed via the Ozone::Time#strftime method.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ozone/version.rb

@@ -1,3 +1,3 @@
 module Ozone
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ozone.rb

@@ -3,17 +3,58 @@ require "ozone/version"
 require 'active_support/time'
 
 module Ozone
-  module_function
+  module Formatter
+    module_function
 
-  def call(time:, offset:, observes_dst: true, format: '%Y-%m-%d %H:%M')
-    timezone = ActiveSupport::TimeZone[offset/60]
-    time_with_zone = time.in_time_zone(timezone)
-    if time_with_zone.dst? && !observes_dst
-      offset -= 120
+    def call(time:, offset:, observes_dst: true, format: '%Y-%m-%d %H:%M')
       timezone = ActiveSupport::TimeZone[offset/60]
-      2.hours.since(time.in_time_zone(timezone)).strftime(format)
-    else
-      time_with_zone.strftime(format)
+      time_with_zone = time.in_time_zone(timezone)
+      if time_with_zone.dst? && !observes_dst
+        # If we're during daylight savings time, but
+        # we are not observing daylight savings,
+        # there is a one-hour window where there is not
+        # an equivalent time between standard and daylight
+        # savings times. In order to deal with this,
+        # we subtract two hours from the offset and then
+        # take 2 hours from the given time. This frees
+        # us to string format the time without ruby
+        # making adjustments internally.
+        offset -= 120
+        timezone = ActiveSupport::TimeZone[offset/60]
+        2.hours.since(time.in_time_zone(timezone)).strftime(format)
+      else
+        time_with_zone.strftime(format)
+      end
+    end
+  end
+
+  class Time
+    def initialize(time:, offset:, observes_dst: true)
+      @offset = offset
+      @timezone = ActiveSupport::TimeZone[offset/60]
+      @observes_dst = observes_dst
+      @time = time
+    end
+
+    def before?(time_with_zone)
+      adjusted_time < time_with_zone
+    end
+
+    def after?(time_with_zone)
+      !before?(time_with_zone)
+    end
+
+    def strftime(format: '%Y-%m-%d %H:%M')
+      Formatter.call(time: @time, offset: @offset, observes_dst: @observes_dst, format: format)
+    end
+
+    private
+
+    def adjusted_time
+      time_with_zone = @time.in_time_zone(@timezone)
+      time_with_zone.dst? && !@observes_dst ?
+        1.hour.until(time_with_zone) :
+        time_with_zone
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ozone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hubert Huang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport