zonebie 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+notifications:
+  email:
+    - alindeman@gmail.com

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zonebie.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andy Lindeman
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,109 @@
+# Zonebie
+
+[![Build Status](https://secure.travis-ci.org/highgroove/zonebie.png)](http://travis-ci.org/highgroove/zonebie)
+
+Zonebie prevents bugs in code that deals with timezones by randomly assigning a
+zone on every run.
+
+## Requirements
+
+* MRI (1.8.7, 1.9.2, 1.9.3)
+* JRuby (1.6)
+* Rubinius (1.2, 2.0)
+
+***
+
+And **either** of these gems which adds timezone support to Ruby:
+
+* `activesupport` >= 2.3 (Rails 2.3, 3.0, 3.1, 3.2)
+* `tzinfo` >= 0.3
+
+## Installation
+
+If using Bundler (recommended), add to Gemfile:
+
+````ruby
+gem 'zonebie'
+````
+
+## Usage with Rails & ActiveSupport
+
+ActiveSupport allows setting a global timezone that will be used for many date
+and time calculations throughout the application.
+
+Zonebie can set this to a random timezone at the beginning of test runs.
+Specifically for ActiveSupport, it sets `Time.zone`.
+
+### Test::Unit & Minitest
+
+Add to `test/test_helper.rb`:
+
+```ruby
+Zonebie.set_random_timezone
+```
+
+### RSpec
+
+Add to `spec/spec_helper.rb`:
+
+```ruby
+Zonebie.set_random_timezone
+```
+
+### Cucumber
+
+Add a file `features/support/zonebie.rb` with the following contents:
+
+```ruby
+Zonebie.set_random_timezone
+```
+
+## Usage with TZInfo
+
+Zonebie can use the `tzinfo` gem, allowing it to work outside of ActiveSupport
+(Rails).
+
+However, `Zonebie.set_random_timezone` does not work outside of ActiveSupport
+because there is not a concept of a global timezone setting. If you simply need
+a random timezone for some other part of your tests, Zonebie can help.
+
+```ruby
+zone = TZInfo::Timezone.get(Zonebie.random_timezone)
+puts zone.now
+
+# Also works in Rails/ActiveSupport
+zone = ActiveSupport::TimeZone[Zonebie.random_timezone]
+puts zone.now
+```
+
+## Reproducing Bugs
+
+When `Zonebie.set_random_timezone` is called, Zonebie assigns a timezone and
+prints a message to STDOUT:
+
+```
+[Zonebie] Setting timezone to "Eastern Time (US & Canada)"
+```
+
+If you would rather that Zonebie not print out this information during your tests,
+put Zonebie in quiet mode before calling `set_random_timezone`:
+
+```ruby
+Zonebie.quiet = true
+```
+
+To rerun tests with a specific timezone (e.g., to reproduce a bug that only
+seems present in one zone), set the `TZ` environment variable:
+
+```ruby
+# Assuming tests run with simply `rake`
+TZ="Eastern Time (US & Canada)" rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/zonebie.rb

@@ -0,0 +1,53 @@
+require File.expand_path("zonebie/version", File.dirname(__FILE__))
+
+module Zonebie
+  class << self
+    attr_accessor :quiet
+
+    def backend
+      unless @backend
+        @backend = if @backends[:activesupport].usable?
+                     @backends[:activesupport]
+                   else
+                     @backends.values.detect(&:usable?)
+                   end
+      end
+
+      @backend
+    end
+
+    def backend=(backend)
+      case backend
+      when Symbol
+        @backend = @backends[backend]
+      else
+        @backend = backend
+      end
+
+      if !backend.nil? && @backend.nil?
+        raise ArgumentError, "Unsupported backend: #{backend}"
+      end
+
+      @backend
+    end
+
+    def add_backend(backend)
+      @backends ||= {}
+      @backends[backend.name] = backend
+    end
+
+    def set_random_timezone
+      zone = ENV['TZ'] || random_timezone
+
+      $stdout.puts("[Zonebie] Setting timezone to \"#{zone}\"") unless quiet
+      backend.zone = zone
+    end
+
+    def random_timezone
+      zones = backend.zones
+      zones[rand(zones.length)]
+    end
+  end
+end
+
+require File.expand_path("zonebie/backends", File.dirname(__FILE__))

data/lib/zonebie/backends.rb

@@ -0,0 +1,2 @@
+require File.expand_path("backends/active_support", File.dirname(__FILE__))
+require File.expand_path("backends/tzinfo", File.dirname(__FILE__))

data/lib/zonebie/backends/active_support.rb

@@ -0,0 +1,31 @@
+begin
+  require "active_support/time"
+rescue LoadError
+  # not required; this backend will simply not be used
+end
+
+module Zonebie
+  module Backends
+    class ActiveSupport
+      class << self
+        def name
+          :activesupport
+        end
+
+        def zones
+          ::ActiveSupport::TimeZone.all.map(&:name)
+        end
+
+        def zone=(zone)
+          ::Time.zone = zone
+        end
+
+        def usable?
+          defined?(::ActiveSupport)
+        end
+      end
+
+      Zonebie.add_backend(self)
+    end
+  end
+end

data/lib/zonebie/backends/tzinfo.rb

@@ -0,0 +1,31 @@
+begin
+  require "tzinfo"
+rescue LoadError
+  # not required; this backend will simply not be used
+end
+
+module Zonebie
+  module Backends
+    class TZInfo
+      class << self
+        def name
+          :tzinfo
+        end
+
+        def zones
+          ::TZInfo::Timezone.all.map(&:identifier)
+        end
+
+        def zone=(zone)
+          $stderr.puts("[Zonebie] It is not possible to set a global timezone with `tzinfo`")
+        end
+
+        def usable?
+          defined?(::TZInfo)
+        end
+      end
+
+      Zonebie.add_backend(self)
+    end
+  end
+end

data/lib/zonebie/rspec.rb

@@ -0,0 +1,7 @@
+require File.expand_path("../zonebie", File.dirname(__FILE__))
+
+RSpec.configure do |c|
+  c.before(:suite) do
+    Zonebie.set_random_timezone
+  end
+end

data/lib/zonebie/version.rb

@@ -0,0 +1,3 @@
+module Zonebie
+  VERSION = "0.0.2"
+end

data/spec/integrations/activesupport_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+require "active_support/time"
+
+describe Zonebie do
+  before do
+    Zonebie.backend = :activesupport
+  end
+
+  describe "#set_random_timezone" do
+    it "assigns a random timezone" do
+      ::Time.expects(:zone=).with do |zone|
+        ActiveSupport::TimeZone.all.map(&:name).include? zone
+      end
+
+      $stdout.stubs(:puts)
+      Zonebie.set_random_timezone
+    end
+  end
+end

data/spec/lib/zonebie/backends/active_support_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Zonebie::Backends::ActiveSupport do
+  describe "#name" do
+    it "is :activesupport" do
+      described_class.name.should == :activesupport
+    end
+  end
+
+  describe "#zones" do
+    it "returns a list of zones provided by ActiveSupport" do
+      ::ActiveSupport::TimeZone.stubs(:all).
+        returns([
+          stub(:name => "Eastern Time (US & Canada)"),
+          stub(:name => "Central Time (US & Canada)")
+        ])
+
+      described_class.zones.should =~ ["Eastern Time (US & Canada)", "Central Time (US & Canada)"]
+    end
+  end
+
+  describe "#zone=" do
+    it "sets Time.zone provided by ActiveSupport" do
+      ::Time.expects(:zone=).with("Eastern Time (US & Canada)")
+
+      described_class.zone = "Eastern Time (US & Canada)"
+    end
+  end
+
+  describe "usable?" do
+    it "returns true if ActiveSupport is available" do
+      described_class.should be_usable
+    end
+
+    it "returns false if ActiveSupport is unavailable" do
+      old_active_support = ActiveSupport
+      Object.send(:remove_const, :ActiveSupport)
+      begin
+        described_class.should_not be_usable
+      ensure
+        ActiveSupport = old_active_support
+      end
+    end
+  end
+end

data/spec/lib/zonebie/backends/tzinfo_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Zonebie::Backends::TZInfo do
+  describe "#name" do
+    it "is :tzinfo" do
+      described_class.name.should == :tzinfo
+    end
+  end
+
+  describe "#zones" do
+    it "returns a list of zones provided by TZInfo" do
+      ::TZInfo::Timezone.stubs(:all).
+        returns([
+          stub(:identifier => "America/Chicago"),
+          stub(:identifier => "America/New York")
+        ])
+
+      described_class.zones.should =~ ["America/Chicago", "America/New York"]
+    end
+  end
+
+  describe "#zone=" do
+    it "is a noop" do
+      $stderr.stubs(:puts)
+      described_class.zone = "America/Chicago"
+    end
+  end
+
+  describe "usable?" do
+    it "returns true if TZInfo is available" do
+      described_class.should be_usable
+    end
+
+    it "returns false if TZInfo is unavailable" do
+      old_tz_info = TZInfo
+      Object.send(:remove_const, :TZInfo)
+      begin
+        described_class.should_not be_usable
+      ensure
+        TZInfo = old_tz_info
+      end
+    end
+  end
+end

data/spec/lib/zonebie_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe Zonebie do
+  describe "#backend" do
+    it "defaults to the activesupport backend in the presence of activesupport" do
+      Zonebie.backend.name.should == :activesupport
+    end
+
+    it "allows setting the backend to tzinfo" do
+      Zonebie.backend = :tzinfo
+      Zonebie.backend.name.should == :tzinfo
+    end
+
+    it "defaults to tzinfo in the absense of activesupport" do
+      Zonebie::Backends::ActiveSupport.stubs(:usable?).returns(false)
+
+      Zonebie.backend.name.should == :tzinfo
+    end
+
+    it "does not allow setting the backend to an unsupported value" do
+      expect {
+        Zonebie.backend = :foobar
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#add_backend" do
+    it "allows registration of backends classes" do
+      expect {
+        Zonebie.backend = :my_new_backend
+      }.to raise_error(ArgumentError)
+
+      Zonebie.add_backend(stub(:name => :my_new_backend))
+      Zonebie.backend = :my_new_backend
+    end
+  end
+
+  describe "#set_random_timezone" do
+    let(:backend) {
+      stub_everything(:name  => :my_awesome_backend,
+                      :zones => ["Eastern Time (US & Canada)"])
+    }
+
+    before do
+      Zonebie.add_backend(backend)
+      Zonebie.backend = :my_awesome_backend
+    end
+
+    it "asks the backend to set the zone" do
+      $stdout.stubs(:puts)
+      backend.expects(:zone=).with("Eastern Time (US & Canada)")
+
+      Zonebie.set_random_timezone
+    end
+
+    it "outputs the timezone to STDOUT" do
+      $stdout.expects(:puts).with("[Zonebie] Setting timezone to \"Eastern Time (US & Canada)\"")
+      Zonebie.set_random_timezone
+    end
+
+    it "does not output the timezone to STDOUT if quiet mode is enabled" do
+      $stdout.expects(:puts).never
+
+      Zonebie.quiet = true
+      begin
+        Zonebie.set_random_timezone
+      ensure
+        Zonebie.quiet = false
+      end
+    end
+
+    it "sends the timezone as ENV[TZ] if present" do
+      $stdout.stubs(:puts)
+
+      backend.expects(:zone=).with("Pacific Time (US & Canada)")
+
+      ENV['TZ'] = "Pacific Time (US & Canada)"
+      Zonebie.set_random_timezone
+    end
+  end
+
+  describe "#random_timezone" do
+    let(:backend) {
+      stub_everything(:name  => :my_awesome_backend,
+                      :zones => ["Eastern Time (US & Canada)"])
+    }
+
+    before do
+      Zonebie.add_backend(backend)
+      Zonebie.backend = :my_awesome_backend
+    end
+
+    it "returns a random timezone" do
+      Zonebie.random_timezone.should == "Eastern Time (US & Canada)"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../lib/zonebie", File.dirname(__FILE__))
+
+require "mocha"
+RSpec.configure do |c|
+  c.mock_with :mocha
+
+  c.before do
+    ENV.delete('TZ')
+    Zonebie.backend = nil # reset to default
+  end
+end

data/zonebie.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/zonebie/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andy Lindeman"]
+  gem.email         = ["alindeman@gmail.com"]
+  gem.description   = %q{Runs your tests in a random timezone}
+  gem.summary       = %q{Zonebie prevents bugs in code that deals with timezones by randomly assigning a zone on every run}
+  gem.homepage      = "https://github.com/highgroove/zonebie"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "zonebie"
+  gem.require_paths = ["lib"]
+  gem.version       = Zonebie::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~>2.8"
+  gem.add_development_dependency "mocha", "~>0.10.0"
+
+  gem.add_development_dependency "activesupport", ">=2.3"
+  gem.add_development_dependency "tzinfo", ">=0.3"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification 
+name: zonebie
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Andy Lindeman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  type: :development
+  name: rake
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 8
+        version: "2.8"
+  requirement: *id002
+  type: :development
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  requirement: *id003
+  type: :development
+  name: mocha
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  requirement: *id004
+  type: :development
+  name: activesupport
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  requirement: *id005
+  type: :development
+  name: tzinfo
+description: Runs your tests in a random timezone
+email: 
+- alindeman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/zonebie.rb
+- lib/zonebie/backends.rb
+- lib/zonebie/backends/active_support.rb
+- lib/zonebie/backends/tzinfo.rb
+- lib/zonebie/rspec.rb
+- lib/zonebie/version.rb
+- spec/integrations/activesupport_spec.rb
+- spec/lib/zonebie/backends/active_support_spec.rb
+- spec/lib/zonebie/backends/tzinfo_spec.rb
+- spec/lib/zonebie_spec.rb
+- spec/spec_helper.rb
+- zonebie.gemspec
+homepage: https://github.com/highgroove/zonebie
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Zonebie prevents bugs in code that deals with timezones by randomly assigning a zone on every run
+test_files: 
+- spec/integrations/activesupport_spec.rb
+- spec/lib/zonebie/backends/active_support_spec.rb
+- spec/lib/zonebie/backends/tzinfo_spec.rb
+- spec/lib/zonebie_spec.rb
+- spec/spec_helper.rb