greenwich 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.2-p180@greenwich

data/README.md

@@ -31,13 +31,14 @@ You add Greenwich to your models like so:
 
     date_with_time_zone :field_name
 
+Meta-Programming Magic
+--------------------------------
+
 By default Greenwich looks for a few different columns in your model depending on the
 field name you passed in.  Let's look at some examples.
 
-Meta-Programming Magic
---------------------------------
+**DateTime Field Lookup**
 
-** DateTime Field Lookup **
 Greenwich will lookup `:field_name` based on a couple different standard column suffixes.
 
   * `_at`
@@ -49,7 +50,8 @@ For example, if you specify:
 
 Greenwich will look for the columns `start_at` and `start_datetime` (in that order).
 
-** Time Zone Field Lookup **
+**Time Zone Field Lookup**
+
 Time Zone lookups default to a per-field or per-model specification.  If you specify:
 
     date_with_time_zone :start
@@ -59,9 +61,9 @@ find a field by that name, it will use `:time_zone`.
 
 Usage
 --------------------------------
-  * Note: These examples assume the application's default time zone is set to UTC.
+  * **Note:** _These examples assume the application's default time zone is set to UTC.
     If you have modified the default time zone, directly accessing your DateTime field
-    will render it in _that_ time zone and not UTC.
+    will render it in _that_ time zone and not UTC._
 
 When working with your instances, Greenwich will convert to the proper time zone when
 you access it.  So if you've previously saved a DateTime like this:
@@ -98,19 +100,19 @@ And again, asking Greenwich for the value of `start` will result in:
 Issues
 ------
 
-If you have problems, please create a [Github issue](https://github.com/jfelchner/validates_truthiness/issues).
+If you have problems, please create a [Github issue](https://github.com/jfelchner/greenwich/issues).
 
 Credits
 -------
 
 ![thekompanee](http://www.thekompanee.com/public_files/kompanee-github-readme-logo.png)
 
-validates_truthiness is maintained by [The Kompanee, Ltd.](http://www.thekompanee.com)
+greenwich is maintained by [The Kompanee, Ltd.](http://www.thekompanee.com)
 
 The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
 
 License
 -------
 
-validates_truthiness is Copyright © 2011 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+greenwich is Copyright © 2011 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file.
 

data/greenwich.gemspec

@@ -28,7 +28,9 @@ Gem::Specification.new do |s|
   s.require_paths     = ["lib"]
   #= Manifest =#
 
-  s.add_development_dependency('bundler',   '~> 1.0.15')
-  s.add_development_dependency('rspec',     '~> 2.6.0')
-  s.add_development_dependency('yard',      '~> 0.7.1')
+  s.add_dependency('activerecord', '~> 3.0')
+
+  s.add_development_dependency('bundler',   '~> 1.0')
+  s.add_development_dependency('rspec',     '~> 2.6')
+  s.add_development_dependency('yard',      '~> 0.7')
 end

data/lib/greenwich.rb

@@ -1,5 +1,5 @@
 require "greenwich/version"
+require "greenwich/utilities"
+require "greenwich/time_with_zone"
+require "greenwich/rails"
 
-module Greenwich
-  # Your code goes here...
-end

data/lib/greenwich/rails.rb

@@ -0,0 +1,75 @@
+require  'greenwich'
+
+module Greenwich  #:nodoc:
+  module Conversion #:nodoc:
+    def self.included(base) #:nodoc:
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def time_with_custom_time_zone(name, options = {})
+        time_zone_field = options[:time_zone]  || Greenwich::Utilities.get_time_zone_field(name, column_names)
+        time_field      = options[:time_field] || Greenwich::Utilities.get_time_field(name, column_names)
+
+        skip_time_zone_conversion_for_attributes << time_field
+
+        mapping = [ [time_field, 'truncated_time_as_string'], [time_zone_field, 'time_zone_name'] ]
+
+        composed_of name,
+                    :class_name => 'ActiveSupport::TimeWithZone',
+                    :mapping => mapping,
+                    :allow_nil => true,
+                    :constructor => Proc.new { |time, time_zone|
+                      time_zone = ActiveSupport::TimeZone.new(time_zone) unless time_zone.is_a? ActiveSupport::TimeZone
+                      time = time.to_time
+
+                      ActiveSupport::TimeWithZone.new(nil, time_zone, time)
+                    },
+                    :converter => Proc.new { |value|
+                      value[1] = ActiveSupport::TimeZone.new(value[1]) unless value[1].is_a? ActiveSupport::TimeZone
+                      value[0] = value[0].to_time
+
+                      ActiveSupport::TimeWithZone.new(nil, value[1], value[0])
+                    }
+
+        define_method "#{time_field}=" do |time|
+          instance_eval do
+            time_zone = read_attribute(time_zone)
+
+            if time_zone.nil?
+              write_attribute(time_field, time.to_s)
+            else
+              self.send("#{name}=".to_sym, [time, time_zone])
+            end
+          end
+        end
+
+        time_zone "#{name}_time_zone".to_sym, :for => name.to_sym if options[:time_zone] == time_zone_field
+      end
+
+      def time_zone(name, options = {})
+        options[:for] = [options[:for]].compact unless options[:for].is_a? Array
+        options[:for].map! { |v| [v, Greenwich::Utilities.get_time_field(v, column_names)] }
+
+        define_method "#{name}" do
+          ActiveSupport::TimeZone.new(read_attribute(name))
+        end
+
+        define_method "#{name}=" do |time_zone|
+          instance_eval do
+            time_zone = ActiveSupport::TimeZone.new(time_zone) unless time_zone.is_a? ActiveSupport::TimeZone || time_zone.nil?
+            time_zone = time_zone.name if time_zone.respond_to? :name
+            write_attribute(name, time_zone)
+
+            options[:for].each do |composed_field, time_field|
+              time = read_attribute(time_field)
+              self.send("#{composed_field}=".to_sym, [time, time_zone]) unless time.nil?
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Greenwich::Conversion

data/lib/greenwich/time_with_zone.rb

@@ -0,0 +1,26 @@
+module ActiveSupport
+  class TimeWithZone
+    def time_zone=(new_zone)
+      ActiveSupport::TimeWithZone.new(nil, ActiveSupport::TimeZone.new(new_zone), time)
+    end
+
+    def time_zone_name
+      time_zone.name
+    end
+
+    def truncated_time
+      ActiveSupport::TimeWithZone.new(nil, ActiveSupport::TimeZone.new('UTC'), time)
+    end
+
+    def truncated_time_as_string
+      truncated_time.to_s
+    end
+  end
+
+  class TimeZone
+    def freeze
+      tzinfo; utc_offset;
+      super
+    end
+  end
+end

data/lib/greenwich/utilities.rb

@@ -0,0 +1,22 @@
+module Greenwich
+  module Utilities
+    def self.get_time_zone_field(name, columns)
+      target_columns = ["#{name}_time_zone", "time_zone"]
+
+      get_target_column(target_columns, columns)
+    end
+
+    def self.get_time_field(name, columns)
+      target_columns = ["#{name}_at", "#{name}_datetime", "#{name}_time"]
+
+      get_target_column(target_columns, columns)
+    end
+
+  private
+    def self.get_target_column(target_columns, all_columns)
+      target_columns.each {|col| return col if all_columns.include?(col) }
+
+      nil
+    end
+  end
+end

data/lib/greenwich/version.rb

@@ -1,3 +1,3 @@
 module Greenwich
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/greenwich/utilities_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Greenwich::Utilities do
+  describe "#truncate" do
+    before { @expected_time = Time.utc(2011, 5, 13, 17, 31, 13, 0) }
+
+    context "when passed a String" do
+      it "returns the correct time if no offset is given" do
+        truncated = Greenwich::Utilities.truncate("2011-05-13 17:31:13")
+        truncated.should eql @expected_time
+      end
+
+      it "returns the correct time if an offset is given" do
+        truncated = Greenwich::Utilities.truncate("2011-05-13 17:31:13 -0600")
+        truncated.should eql @expected_time
+      end
+    end
+
+    context "when passed a TimeWithZone" do
+      before { @time = Time.utc(2011, 5, 13, 17, 31, 13) }
+
+      it "returns the correct time if TimeWithZone is UTC" do
+        utc_time_zone = ActiveSupport::TimeZone.new('UTC')
+        time_with_zone = ActiveSupport::TimeWithZone.new(@time, utc_time_zone)
+
+        truncated = Greenwich::Utilities.truncate(time_with_zone)
+        truncated.should eql @expected_time
+      end
+
+      it "returns the correct time if TimeWithZone is not UTC" do
+        alaskan_time_zone = ActiveSupport::TimeZone.new('Alaska')
+        time_with_zone = ActiveSupport::TimeWithZone.new(nil, alaskan_time_zone, @time)
+
+        truncated = Greenwich::Utilities.truncate(time_with_zone)
+        truncated.should eql @expected_time
+      end
+    end
+
+    context "when passed a DateTime" do
+      it "returns the correct time if DateTime is UTC" do
+        datetime = DateTime.civil(2011, 5, 13, 17, 31, 13, 0)
+
+        truncated = Greenwich::Utilities.truncate(datetime)
+        truncated.should eql @expected_time
+      end
+
+      it "returns the correct time if DateTime is not UTC" do
+        datetime = DateTime.civil(2011, 5, 13, 17, 31, 13, -0.25)
+
+        truncated = Greenwich::Utilities.truncate(datetime)
+        truncated.should eql @expected_time
+      end
+    end
+  end
+
+  describe "#get_time_zone" do
+    context "when passed a valid time zone" do
+      it "returns that time zone" do
+        time_zone = Greenwich::Utilities.get_time_zone(nil, 'foo')
+        time_zone.should eql 'foo'
+      end
+    end
+
+    context "when not passed a time zone" do
+      before { @time = Time.utc(2011, 5, 13, 17, 31, 13) }
+
+      context "and passed a TimeWithZone for the time" do
+        it "returns the time zone associated with the time" do
+          alaskan_time_zone = ActiveSupport::TimeZone.new('Alaska')
+          time_with_zone = ActiveSupport::TimeWithZone.new(nil, alaskan_time_zone, @time)
+
+          time_zone = Greenwich::Utilities.get_time_zone(time_with_zone, nil)
+          time_zone.should eql alaskan_time_zone
+        end
+
+        it "returns the time zone associated with the time" do
+          utc_time_zone = ActiveSupport::TimeZone.new('UTC')
+
+          time_zone = Greenwich::Utilities.get_time_zone(@time, nil)
+          time_zone.should eql utc_time_zone
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+require 'greenwich'
+
+RSpec.configure do |config|
+  config.before do
+    load File.join(File.dirname(__FILE__), "model.rb")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: greenwich
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,42 +10,53 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-03 00:00:00.000000000 -05:00
+date: 2011-07-06 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2152414440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152414440
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153525320 !ruby/object:Gem::Requirement
+  requirement: &2152413920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.15
+        version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2153525320
+  version_requirements: *2152413920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153524820 !ruby/object:Gem::Requirement
+  requirement: &2152413460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2153524820
+  version_requirements: *2152413460
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2153524360 !ruby/object:Gem::Requirement
+  requirement: &2152412980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *2153524360
+  version_requirements: *2152412980
 description: Store all of your times in the database as UTC but want to give your
   users the ability to choose a custom time zone for each instance of a DateTime field?
 email:
@@ -57,13 +68,20 @@ extra_rdoc_files:
 - LICENSE
 files:
 - .gitignore
+- .rspec
+- .rvmrc
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - greenwich.gemspec
 - lib/greenwich.rb
+- lib/greenwich/rails.rb
+- lib/greenwich/time_with_zone.rb
+- lib/greenwich/utilities.rb
 - lib/greenwich/version.rb
-- README.md
-- LICENSE
+- spec/greenwich/utilities_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/jfelchner/greenwich
 licenses: []
@@ -90,4 +108,6 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Allowing users to select dates with custom time zones since 2011.
-test_files: []
+test_files:
+- spec/greenwich/utilities_spec.rb
+- spec/spec_helper.rb