time_jawn 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Njg1YjFmZmFjMTA0M2E2Y2JjZjAwN2NiZGVhOGMwNDRjMzAzZmFjNg==
+  data.tar.gz: !binary |-
+    MzgyMjcxMzY3NGM0YTg3ZGQ5ZWZlODUwNzRhMWQ1NzYzOWI4NjA3ZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTIxNGVjZmJlOTA4NTJhOTYxOTRmYzA0OTA3ODBkYWEzMjQ3MTdiMzdlODNi
+    ODY1MDI5MjBkNjdkMTBkMjc5ZWM0OGFkOWIyZDU0MjBhYjNmYzQ5NTBjYjEz
+    MDk1ZjM3ZGNkYzhmNDVhYzljNTFjMGQzN2E5ODZiOWNiYTA2MGY=
+  data.tar.gz: !binary |-
+    NjAxMDc4ZTM0ZGJmZDUyNTJkNTE5MjM1M2Q2OGRhYjU1Mzg4OGQ0NjllNzY5
+    Yzk1ZTc0YTQ5MDRkMWY1YTRhYjEwOGE3YWY1NzczNzQ5ZGU5ZTAwZmEzZGJh
+    ZjRiYzc5NmRkYmIwMTU2ODcwZDJhOTM4ODNjYWUzODAwMjg3YjA=

data/lib/time_jawn/time_jawn.rb

@@ -0,0 +1,95 @@
+# The base module of the TimeJawn gem. Everything in here assumes that your model has a valid time zone
+# in a attribute name time_zone or has been delegating one to somewhere else.
+module TimeJawn
+  # Automatically runs and adds ClassMethods to ActiveRecord::Base
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+  # Defines methods that will attached to all ActiveRecord classes.
+  module ClassMethods
+    # When called it loads the methods located in InstanceMethods.
+    # It is typically included in a model's rb file so that instances of that class gain the InstanceMethods at each instantiation.
+    #     class Event<ActiveRecord::Base
+    #       has_time_zone
+    #     end 
+    def has_time_zone
+      send :include, InstanceMethods
+    end
+    # Locates all of an ActiveRecord class' DateTime Attributes and returns them as an array of symbols.
+    def _datetime_attributes
+      klass = self.name.constantize
+
+      datetime_attributes = []
+      klass.columns.each do |column|
+         datetime_attributes << column.name.to_sym if column.type == :datetime
+      end
+      return datetime_attributes
+    end
+  end
+  #Defines methods that will be added to instances of classes that have previously called has_time_zone.
+  module InstanceMethods
+    # This method generates a series of methods on instances. The methods that are created are called
+    # local_#{attribue} and local_#{attribute}= the attribute portion their names are completed by enumerating
+    # the datetime_attributes of the class. Twice as many methods as there are DateTime attributes will 
+    # be created.
+    # 
+    #    :created_at, and :updated_at
+    #     
+    #     local_created_at
+    #     local_updated_at
+    #     local_created_at=
+    #     local_updated_at=
+    # 
+    # The local_#{attribue} methods will take the value stored in the attribute indicated by the methods name
+    # and apply a time zone conversion to it. This is useful for displaying the local time (according to the object).
+    # 
+    # local_#{attribute}= methods are assignment shortcuts. They behave a little differently than you would expect.
+    # They do not take a local time and convert it into utc (or whatever, ActiveSupport will handle that for us), 
+    # what these assigment methods do is take any sort of string that looks like a time, or any sort of time or datetime 
+    # object lop off whatever timezone is being fed in and glue the instances local timezone on the end before applying 
+    # it to the appropriate attribute. This is convenient for some one in one time zone setting a value for an instance 
+    # that represents a different time zone. For example:
+    #
+    #     I am in Philadelphia (EST), my application is set to UTC, and I want to set the time on an Alarm instance that 
+    #     goes off in San Francisco (PST). I want that time to be 6PM. In Philadlephia I choose 6PM (local), the applications assumes I 
+    #     meant 6PM UTC (2PM EST and 11AM PST). That is not what I intended, I intended on 6PM PST, and now my Alarm is all wrong.
+    #     The assignment methods turn 6PM (set in EST, and processed in UTC) into 6PM PST (or 9PM EST, 1AM UTC) the expected time. The
+    #     Alarm goes off as expected!*
+    #
+    #     *Times in this example may be wrong since I put them in myself.
+    #
+    # You can see examples of how these methods work in the specs folder.
+    def self.included(base)
+      base._datetime_attributes.each do |attribute|
+        define_method(:"local_#{attribute}") { _to_local(send(attribute)) }
+        define_method(:"local_#{attribute}=") do |time_or_string_value|
+          if time_or_string_value.is_a? String
+            write_attribute(attribute, _add_zone(time_or_string_value))
+          else
+            write_attribute(attribute, _change_zone(time_or_string_value))
+          end
+        end
+      end
+    end
+    # Returns the current time according to the instance.
+    def current_time
+      _to_local(DateTime.current)
+    end
+    # converts a time object into it's local counter part (they will have the same value but differnt presentation.)
+    def _to_local(time)
+      time.in_time_zone(self.time_zone)
+    end
+    
+    # Given a string that looks like a time. It will convert that string into a time object that matches the time but with
+    # the instances time zone appended.
+    def _add_zone(time_string)
+      Time.zone = self.time_zone
+      Time.zone.parse(time_string)
+    end
+
+    # Returns a string representation of a time object suitable for consumption by add_zone.
+    def _change_zone(time)
+      _add_zone(time.strftime('%a, %d %b %Y %H:%M:%S'))
+    end
+  end
+end

data/lib/time_jawn.rb

@@ -0,0 +1,3 @@
+require 'time_jawn/time_jawn'
+
+ActiveRecord::Base.send(:include, TimeJawn)

data/spec/time_jawn_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+
+describe Happening do
+  before(:each){
+      @happening1 = Happening.find_by_name('Eastern Time (US & Canada)')
+      @happening2 = Happening.find_by_name('Pacific/Honolulu')
+      Time.zone = 'UTC'
+  }
+  context 'class method' do
+    describe "datetime_attributes" do
+      it "returns an array of all datetime objects for the class" do
+        expect(Happening._datetime_attributes).to eq [:start_time, :created_at, :updated_at] 
+      end
+    end
+    describe "has_time_zone" do
+      it "does not have instance methods until called" do
+        expect(Happening.instance_methods.include? :local_start_time).to eq false
+        expect(Happening.instance_methods.include? :local_created_at).to eq false
+        expect(Happening.instance_methods.include? :local_updated_at).to eq false
+        expect(Happening.instance_methods.include? :local_start_time=).to eq false
+        expect(Happening.instance_methods.include? :local_updated_at=).to eq false
+        expect(Happening.instance_methods.include? :local_updated_at=).to eq false
+      end
+      it "has instance methods once called " do
+        
+        Happening.has_time_zone
+        
+        expect(Happening.instance_methods.include? :local_start_time).to eq true
+        expect(Happening.instance_methods.include? :local_created_at).to eq true
+        expect(Happening.instance_methods.include? :local_updated_at).to eq true
+        expect(Happening.instance_methods.include? :local_start_time=).to eq true
+        expect(Happening.instance_methods.include? :local_created_at=).to eq true
+        expect(Happening.instance_methods.include? :local_updated_at=).to eq true
+      end
+    end
+  end
+  context 'static instance methods' do
+
+    describe "self.included(base)" do
+      pending "How do you test this? I suppose if the dynamic tests exist this worked. Seems shoddy."
+    end
+
+    describe "current_time" do
+      it "returns a time with zone object reflecting the current local time of the instance" do
+        Timecop.freeze
+        expect(DateTime.current).to eq @happening1.current_time
+        Timecop.return
+      end
+    end
+
+    describe "_to_local(time)" do
+      it "returns a time with zone that has been coverted to reflect the local time" do
+        expect(@happening1.start_time).to eq 'Mon, 01 Apr 2013 00:01:00 UTC +00:00'
+        expect(@happening1._to_local(@happening1.start_time)).to eq 'Sun, 31 Mar 2013 20:01:00 EDT -04:00'
+        expect(@happening1._to_local(@happening1.start_time).to_s).to eq "2013-03-31 20:01:00 -0400"
+      end
+    end
+
+    describe "_add_zone(time_string)" do
+      it "returns a time with zone object that reflects the time value passed in time_string with time zone information of instance appended" do
+        expect(@happening1._add_zone("2013-08-19 12:34:56")).to eq 'Mon, 19 Aug 2013 12:34:56 EDT -04:00'
+        expect(@happening2._add_zone("2013-08-19 12:34:56")).to eq 'Mon, 19 Aug 2013 12:34:56 HST -10:00'
+        expect(@happening1._add_zone("2013-11-11 12:34:56")).to eq 'Mon, 11 Nov 2013 12:34:56 EST -05:00'
+        expect(@happening2._add_zone("2013-11-11 12:34:56")).to eq 'Mon, 11 Nov 2013 12:34:56 HST -10:00'
+      end
+    end
+
+    describe "_change_zone(time)" do
+      it "returns a time with zone object that has had only it's time zone switched to local time of instance" do
+        Time.zone = 'Rangoon'
+        time = Time.zone.parse("Wed, 28 Aug 2015 15:16:16")
+        expect(time.to_s.split(' ')[2]).to eq ('+0630')
+        expect(time.to_s.split(' ')[2]).to_not eq ('-0400')
+        expect(@happening1._change_zone(time)).to_not eq time
+        expect(@happening1._change_zone(time).to_s.split(' ')[0]).to eq time.to_s.split(' ')[0]
+        expect(@happening1._change_zone(time).to_s.split(' ')[1]).to eq time.to_s.split(' ')[1]
+        expect(@happening1._change_zone(time).to_s.split(' ')[2]).to_not eq time.to_s.split(' ')[2]
+        expect(@happening1._change_zone(time).to_s.split(' ')[2]).to_not eq ('+0630')
+        expect(@happening1._change_zone(time).to_s.split(' ')[2]).to eq ('-0400')
+      end
+    end
+  end
+  context 'dynamic instance methods' do
+    describe "local_start_time" do
+      it "returns a time with zone object that reflects the value of start_time altered to the instance's time zone" do
+        expect(@happening1.start_time).to eq 'Mon, 01 Apr 2013 00:01:00 UTC +00:00'
+        expect(@happening1.start_time).to eq 'Sun, 31 Mar 2013 20:01:00 EDT -04:00'
+        Time.zone = 'Eastern Time (US & Canada)'
+        expect(@happening1.local_start_time.to_s).to eq "2013-03-31 20:01:00 -0400"
+
+        expect(@happening2.start_time).to eq 'Mon, 01 Apr 2013 00:00:00 UTC +00:00'
+        expect(@happening2.start_time).to eq 'Sun, 31 Mar 2013 14:00:00 HST -10:00'
+        Time.zone = 'Pacific/Honolulu'
+        expect(@happening2.local_start_time.to_s).to eq "2013-03-31 14:00:00 -1000"
+      end
+    end
+
+    describe "local_updated_at" do
+      it "returns a time with zone object that reflects the value of updated_at at altered to the instance's time zone" do
+        expect(@happening1.updated_at).to eq 'Tue, 01 Jan 2013 00:01:00 UTC +0000'
+        expect(@happening1.updated_at).to eq 'Wed, 31 Dec 2012 20:01:00 EDT -04:00'
+        Time.zone = 'Eastern Time (US & Canada)'
+        expect(@happening1.local_updated_at.to_s).to eq "2012-12-31 19:01:00 -0500"
+
+        expect(@happening2.updated_at).to eq 'Tue, 01 Jan 2013 00:00:00 UTC +0000'
+        expect(@happening2.updated_at).to eq 'Wed, 31 Dec 2012 14:00:00 HST -10:00'
+        Time.zone = 'Pacific/Honolulu'
+        expect(@happening2.local_updated_at.to_s).to eq "2012-12-31 14:00:00 -1000"
+      end
+    end
+
+    describe "local_created_at" do
+      it "returns a time with zone object that reflects the value of created_at at altered to the instance's time zone" do
+        expect(@happening1.created_at).to eq 'Tue, 01 Jan 2013 00:01:00 UTC +0000'
+        expect(@happening1.created_at).to eq 'Wed, 31 Dec 2012 20:01:00 EDT -04:00'
+        Time.zone = 'Eastern Time (US & Canada)'
+        expect(@happening1.local_created_at.to_s).to eq "2012-12-31 19:01:00 -0500"
+
+        expect(@happening2.created_at).to eq 'Tue, 01 Jan 2013 00:00:00 UTC +0000'
+        expect(@happening2.created_at).to eq 'Wed, 31 Dec 2012 14:00:00 HST -10:00'
+        Time.zone = 'Pacific/Honolulu'
+        expect(@happening2.local_created_at.to_s).to eq "2012-12-31 14:00:00 -1000"
+      end
+    end
+
+    describe "local_start_time=(time_or_string)" do
+      it "sets start_time on the instance to a time_with_zone object only modifying the time zone" do
+        expect(@happening1.start_time).to eq 'Mon, 01 Apr 2013 00:01:00 UTC +00:00'
+        
+        @happening1.local_start_time = Time.parse("Thu, 29 Aug 2013 02:40:12 HST -10:00")
+        expect(@happening1.start_time).to eq Time.parse("2013-08-29 02:40:12 -0400")
+
+        @happening1.local_start_time = Time.parse("Thu, 29 Aug 2013 02:41:12")
+        expect(@happening1.start_time).to eq Time.parse("2013-08-29 02:41:12 -0400")
+
+        @happening1.local_start_time = "Thu, 29 Aug 2013 02:42:12"
+        expect(@happening1.start_time).to eq Time.parse("2013-08-29 02:42:12 -0400")
+
+        @happening1.local_start_time = "Thu, 29 Aug 2013 02:43:12 HST -10:00"
+        expect(@happening1.start_time).to eq Time.parse("2013-08-29 02:43:12 -0400")
+
+        @happening1.local_start_time = "2013-11-11 12:34:56"
+        expect(@happening1.start_time).to eq Time.parse("2013-11-11 12:34:56 -0500")
+
+      end
+    end
+
+    describe "local_updated_at=(time_or_string)" do
+      it "sets updated_at on the instance to a time_with_zone object only modifying the time zone" do
+        expect(@happening1.updated_at).to eq 'Tue, 01 Jan 2013 00:01:00 +0000'
+        
+        @happening1.local_updated_at = Time.parse("Thu, 29 Aug 2013 02:40:12 HST -10:00")
+        expect(@happening1.updated_at).to eq Time.parse("2013-08-29 02:40:12 -0400")
+
+        @happening1.local_updated_at = Time.parse("Thu, 29 Aug 2013 02:41:12")
+        expect(@happening1.updated_at).to eq Time.parse("2013-08-29 02:41:12 -0400")
+
+        @happening1.local_updated_at = "Thu, 29 Aug 2013 02:42:12"
+        expect(@happening1.updated_at).to eq Time.parse("2013-08-29 02:42:12 -0400")
+
+        @happening1.local_updated_at = "Thu, 29 Aug 2013 02:43:12 HST -10:00"
+        expect(@happening1.updated_at).to eq Time.parse("2013-08-29 02:43:12 -0400")
+
+        @happening1.local_updated_at = "2013-11-11 12:34:56"
+        expect(@happening1.updated_at).to eq Time.parse("2013-11-11 12:34:56 -0500")
+
+      end
+    end
+
+    describe "local_created_at=(time_or_string)" do
+      it "sets created_at on the instance to a time_with_zone object only modifying the time zone" do
+        expect(@happening1.created_at).to eq ' Tue, 01 Jan 2013 00:01:00 +0000'
+        
+        @happening1.local_created_at = Time.parse("Thu, 29 Aug 2013 02:40:12 HST -10:00")
+        expect(@happening1.created_at).to eq Time.parse("2013-08-29 02:40:12 -0400")
+
+        @happening1.local_created_at = Time.parse("Thu, 29 Aug 2013 02:41:12")
+        expect(@happening1.created_at).to eq Time.parse("2013-08-29 02:41:12 -0400")
+
+        @happening1.local_created_at = "Thu, 29 Aug 2013 02:42:12"
+        expect(@happening1.created_at).to eq Time.parse("2013-08-29 02:42:12 -0400")
+
+        @happening1.local_created_at = "Thu, 29 Aug 2013 02:43:12 HST -10:00"
+        expect(@happening1.created_at).to eq Time.parse("2013-08-29 02:43:12 -0400")
+
+        @happening1.local_created_at = "2013-11-11 12:34:56"
+        expect(@happening1.created_at).to eq Time.parse("2013-11-11 12:34:56 -0500")
+
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: time_jawn
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Platt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: TimeJawn makes class instances time zone aware. It doesn't care one iota
+  about system, application or database time as far as I can tell. It has some expectations
+  and adds some useful methods.
+email: mplatt@tammantech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/time_jawn.rb
+- lib/time_jawn/time_jawn.rb
+- spec/time_jawn_spec.rb
+homepage: http://tammantech.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: TimeJawn makes time zone aware class instances.
+test_files:
+- spec/time_jawn_spec.rb