time-zone 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 251d7dc390cce283b8d21cc06ec0f8d4e780c4b20e0de7ecbcabfab51d5732e1
-  data.tar.gz: e4b398d416c342b9a9d885b5742fa547b45753263368df9f0a26277e4b998dae
+  metadata.gz: 2f87514b362f81ee4964adead9a93cd19994225c85e06b8c3584caabe8102123
+  data.tar.gz: 5a0f736d97c9ad2093d9069a22a043b96e1d91ec53c833b7f8a60ff87e332e3e
 SHA512:
-  metadata.gz: 9d194fbd11c1a625ec64e12fa1cda3c01717a5881c1e87aecd701885328ab3a329b48a439c301ebe4ffb044c3117b341f8cb1e6998ef6451165a1e9b6251aafc
-  data.tar.gz: 2ffa8ecc006284c7ce7bf0e7977edc74f407fc12e34d0368a249e74d50d998df235edf16d7e3fe09fc5c1467d2206f1fdf1c10ef7f0bf07901fe99fc9f7b2e21
+  metadata.gz: 79db731b27df02f4a817709403dd0450f780697f47818fb6cd77e07c893509c25a436c2dbd8c2c257191a14f075bee4a3fc3f162ba7b10d532446b2e347a2544
+  data.tar.gz: 2c65c7d6ff558e6b00f3629dff240eb0ae0dd2e99dbd985f99a5d7e678962c7f9b7d96b5ddd338e12fa84592ecb953f17e60fd8910962743dfb9ab2f43d7c3ef

data/Gemfile

@@ -4,3 +4,12 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in time-zone.gemspec
 gemspec
+
+group :development do
+	gem 'pry'
+end
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -2,10 +2,16 @@
 
 A very simple time-zone library which works by manipulating the `TZ` environment variable.
 
+[![Build Status](https://secure.travis-ci.org/ioquatix/time-zone.svg)](http://travis-ci.org/ioquatix/time-zone)
+[![Code Climate](https://codeclimate.com/github/ioquatix/time-zone.svg)](https://codeclimate.com/github/ioquatix/time-zone)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/time-zone/badge.svg)](https://coveralls.io/r/ioquatix/time-zone)
+
 ## Motivation
 
 `tzinfo` has an antiquated view of `Time`. It returns local time values with a UTC time zone which is pretty much wrong.
 
+[![A brief history of Time.new](https://img.youtube.com/vi/UjdtH5gO_DQ/0.jpg)](https://www.youtube.com/watch?v=UjdtH5gO_DQ)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,15 +22,15 @@ gem 'time-zone'
 
 And then execute:
 
-    $ bundle
+	$ bundle
 
 Or install it yourself as:
 
-    $ gem install time-zone
+	$ gem install time-zone
 
 ## Usage
 
-There are two basic use cases:
+There are two basic use cases, getting the current time, and converting times.
 
 ### Current Time
 
@@ -40,6 +46,23 @@ Time::Zone.convert(Time.now.utc, "Pacific/Auckland")
 => 2018-05-25 14:14:22 +1200
 ```
 
+### Multiple Operations
+
+```ruby
+Time::Zone.with("US/Pacific") do
+	# Be aware that in some cases Time values are lazy initialized, so you need to use #localtime to force them to evaluate and use the current `TZ`.
+	time = Time.new.localtime
+	puts time.inspect
+	# => 2018-05-24 20:32:29 -0700
+end
+```
+
+### Caveats
+
+This implementation manipulates the per-process `TZ` environment variable. This means that if you don't put locking around all your usage of `localtime`, you may end up with strange results (i.e. in a timezone other than the system specified `TZ`). In the future, this requirement may go away.
+
+This library is unlikely to work on Windows because it doesn't correctly handle changes to `TZ`.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -4,3 +4,10 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :console do
+	require 'pry'
+	require_relative 'lib/time/zone'
+	
+	Pry.start
+end

data/lib/time/zone.rb

@@ -20,39 +20,20 @@
 
 require_relative 'zone/version'
 
-require 'thread'
+require_relative 'zone/locking'
 
 class Time
 	module Zone
-		@tz = Mutex.new
-		
-		def self.with(zone)
-			@tz.synchronize do
-				original_zone = ENV['TZ']
-				
-				begin
-					ENV['TZ'] = zone
-					
-					yield
-				ensure
-					if original_zone
-						ENV['TZ'] = original_zone
-					else
-						ENV.delete('TZ')
-					end
-				end
-			end
-		end
-		
 		def self.now(zone)
 			with(zone) do
-				return Time.now
+				# Time instances are lazy initialized, so we need to force it to pick up the current TZ by invoking #localtime
+				return Time.new.localtime
 			end
 		end
 		
 		def self.convert(time, zone)
 			with(zone) do
-				return Time.now
+				return time.localtime
 			end
 		end
 	end

data/lib/time/zone/locking.rb

@@ -0,0 +1,45 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'thread'
+
+class Time
+	module Zone
+		LOCK = Mutex.new
+		
+		def self.with(zone)
+			LOCK.synchronize do
+				original_zone = ENV['TZ']
+				
+				begin
+					ENV['TZ'] = zone
+					
+					yield
+				ensure
+					if original_zone
+						ENV['TZ'] = original_zone
+					else
+						ENV.delete('TZ')
+					end
+				end
+			end
+		end
+	end
+end

data/lib/time/zone/version.rb

@@ -20,6 +20,6 @@
 
 class Time
 	module Zone
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time-zone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -66,6 +66,7 @@ files:
 - README.md
 - Rakefile
 - lib/time/zone.rb
+- lib/time/zone/locking.rb
 - lib/time/zone/version.rb
 - time-zone.gemspec
 homepage: https://github.com/ioquatix/time-zone