temporal-rails 0.2.1 → 0.2.2

data/LICENSE

@@ -4,7 +4,7 @@ Rails to use.
 Documentation and other useful information can be found at
 https://github.com/jejacks0n/temporal
 
-Copyright (c) 2011 Jeremy Jackson
+Copyright (c) 2012 Jeremy Jackson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/temporal/controller_additions.rb

@@ -5,7 +5,7 @@ module Temporal
     end
 
     def set_time_zone
-      Time.zone = ActiveSupport::TimeZone.new(cookies[:timezone]) || Rails.application.config.time_zone
+      Time.zone = cookies[:timezone] ? ActiveSupport::TimeZone.new(cookies[:timezone]) : Rails.application.config.time_zone
     end
   end
 end

data/lib/temporal/engine.rb

@@ -2,7 +2,7 @@ require 'temporal/controller_additions'
 
 module Temporal
   class Engine < ::Rails::Engine
-    initializer  "temporal.controller_additions" do
+    initializer "temporal.controller_additions" do
       ActiveSupport.on_load(:action_controller) do
         include Temporal::ControllerAdditions
       end

data/lib/temporal/version.rb

@@ -1,3 +1,3 @@
 module Temporal
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ApplicationController, type: :controller do
+
+  before do
+    Rails.application.config.time_zone = 'Central Time (US & Canada)'
+  end
+
+  it "set the timezone to the configured default if the cookie isn't set" do
+    get :welcome
+    Time.zone.to_s.should =~ /Central Time/
+    response.code.should == "200"
+  end
+
+  it "set the timezone based on the cookie" do
+    @request.cookies[:timezone] = 'America/Denver'
+    get :welcome
+    Time.zone.to_s.should =~ /Denver/
+    response.code.should == "200"
+  end
+
+end

data/spec/dummy/config/application.rb

@@ -1,6 +1,8 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require 'action_controller/railtie'
+require 'sprockets/railtie'
+
 require 'evergreen/rails'
 
 if defined?(Bundler)
@@ -46,13 +48,13 @@ module Dummy
     # Use SQL instead of Active Record's schema dumper when creating the database.
     # This is necessary if your schema can't be completely dumped by the schema dumper,
     # like if you have constraints or database-specific column types
-    config.active_record.schema_format = :sql
+    #config.active_record.schema_format = :sql
 
     # Enforce whitelist mode for mass assignment.
     # This will create an empty whitelist of attributes available for mass-assignment for all models
     # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
     # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
+    #config.active_record.whitelist_attributes = true
 
     # Enable the asset pipeline
     config.assets.enabled = true

data/spec/dummy/config/environments/development.rb

@@ -23,11 +23,11 @@ Dummy::Application.configure do
   config.action_dispatch.best_standards_support = :builtin
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  #config.active_record.mass_assignment_sanitizer = :strict
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
+  #config.active_record.auto_explain_threshold_in_seconds = 0.5
 
   # Do not compress assets
   config.assets.compress = false

data/spec/dummy/config/environments/test.rb

@@ -27,10 +27,10 @@ Dummy::Application.configure do
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
+  #config.action_mailer.delivery_method = :test
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  #config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

data/spec/dummy/config/routes.rb

@@ -1,6 +1,6 @@
 Dummy::Application.routes.draw do
 
-  match '/welcome' => 'application#welcome'
+  root to: 'application#welcome'
 
   # The priority is based upon order of creation:
   # first created -> highest priority.

data/spec/dummy/db/schema.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 0) do
+
+end

data/spec/engine/temporal_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Temporal do
+
+  it "is a module" do
+    Temporal.should be_a(Module)
+  end
+
+  it "has a version" do
+    Temporal::VERSION.should be_a(String)
+  end
+
+  it "defines ControllerAdditions" do
+    Temporal::ControllerAdditions.should be_a(Module)
+  end
+
+  it "includes ControllerAdditions in ActionController::Base" do
+    ActionController::Base.new.methods.should include(:set_time_zone)
+  end
+
+end

data/spec/javascripts/temporal_spec.js.coffee

@@ -2,3 +2,75 @@ require '/assets/temporal.js'
 
 describe "Temporal", ->
 
+  beforeEach ->
+    document.cookie = 'timezone='
+    document.cookie = 'timezone_offset='
+    @timezoneStub = {name: 'foo', offset: 0}  # 0 here ensure the jsonp request isn't made
+
+  describe "signature", ->
+
+    it "has a detect and reference method", ->
+      expect(Object.keys(Temporal).length).toBe 2
+      expect(Object.keys(Temporal)).toEqual ['detect', 'reference']
+      expect(typeof(Temporal.detect)).toBe 'function'
+      expect(typeof(Temporal.reference)).toBe 'function'
+
+
+  describe ".detect", ->
+
+    beforeEach ->
+      window.Temporal = Temporal.reference() if Temporal.reference
+      @spy = spyOn(Temporal.prototype, 'detectLocally').andReturn @timezoneStub
+      @callback = ->
+
+    it "instantiates an instance and passes arguments", ->
+      instance = Temporal.detect('username', @callback)
+      expect(@spy).toHaveBeenCalled()
+      expect(instance.username).toBe 'username'
+      expect(instance.callback).toBe @callback
+
+
+  describe "constructor", ->
+
+    it "calls #detectLocally", ->
+      spy = spyOn(Temporal.prototype, 'detectLocally').andReturn @timezoneStub
+      new Temporal()
+      expect(spy.callCount).toBe 1
+
+    it "calls #geoLocate if there's a username for the GeoName API", ->
+      spyOn(Temporal.prototype, 'detectLocally').andReturn name: 'foo', offset: 1
+      spy = spyOn(Temporal.prototype, 'geoLocate')
+      new Temporal('username')
+      expect(spy.callCount).toBe 1
+
+    it "doesn't call #geoLocate if there isn't a username", ->
+      spyOn(Temporal.prototype, 'detectLocally').andReturn name: 'foo', offset: 1
+      spy = spyOn(Temporal.prototype, 'geoLocate')
+      new Temporal()
+      expect(spy.callCount).toBe 0
+
+    it "calls #set", ->
+      spyOn(Temporal.prototype, 'detectLocally').andReturn @timezoneStub
+      spy = spyOn(Temporal.prototype, 'set')
+      new Temporal()
+      expect(spy.callCount).toBe 1
+      expect(spy).toHaveBeenCalledWith name: 'foo', offset: 0
+
+
+  describe "#detectLocally", ->
+
+    beforeEach ->
+      spyOn(Temporal.prototype, 'detect')
+      @temporal = new Temporal()
+
+    it "returns a quickly determined time zone", ->
+      spyOn(Temporal.prototype, 'januaryOffset').andReturn -420
+      spyOn(Temporal.prototype, 'juneOffset').andReturn -360
+      timezone = @temporal.detectLocally()
+      expect(timezone).toEqual name: 'America/Denver', offset: -7
+
+    it "handles other locations than denver", ->
+      spyOn(Temporal.prototype, 'januaryOffset').andReturn 120
+      spyOn(Temporal.prototype, 'juneOffset').andReturn 120
+      timezone = @temporal.detectLocally()
+      expect(timezone).toEqual name: 'Africa/Johannesburg', offset: 2

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+ENV['RAILS_ENV'] ||= 'test'
+ENV['RAILS_ROOT'] = File.expand_path('../dummy', __FILE__)
+require File.expand_path('../dummy/config/environment', __FILE__)
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Temporal::Engine.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  #config.fixture_path = "#{::Temporal::Engine.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  #config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

data/vendor/assets/javascripts/temporal.js.coffee

@@ -1,41 +1,22 @@
-class TimeZone
+# Temporal -- use detect() to detect, and reference() if you need a reference
+# to the class so you can use it.
+# -----------------------------------------------------------------------------
+class Temporal
 
-  constructor: (keyOrProperties) ->
-    if typeof(keyOrProperties) == 'string'
-      zone = TIMEZONES[keyOrProperties]
-      @[property] = value for own property, value of zone
-      @resolveAmbiguity()
-    else
-      @[property] = value for own property, value of keyOrProperties
-
-  resolveAmbiguity: ->
-    ambiguous = AMBIGIOUS_ZONES[@name]
-    return if typeof(ambiguous) is 'undefined'
-    for key, value of ambiguous
-      if Temporal.dateIsDst(DST_START_DATES[value])
-        @name = value
-        return
+  jsonpCallback = "geoSuccessCallback#{parseInt(Math.random() * 10000)}"
 
+  @detect: (username = null, callback = null) =>
+    new Temporal(username, callback)
 
-class Temporal
+  constructor: (@username = null, @callback = null) ->
+    @detect()
 
-  @detect: (@username = null, @callback = null) =>
-    timezone = @quick()
-    if timezone.offset != @get().offset
-      navigator.geolocation.getCurrentPosition(@geoSuccess, ->) if @username and navigator.geolocation
+  detect: ->
+    timezone = @detectLocally()
+    @geoLocate() if @username and navigator.geolocation and timezone.offset != @get().offset
     @set(timezone)
 
-  @geoSuccess: (position) =>
-    window[JSONP_CALLBACK] = @parseGeoResponse
-    script = document.createElement('script')
-    script.setAttribute('src', "http://api.geonames.org/timezoneJSON?lat=#{position.coords.latitude}&lng=#{position.coords.longitude}&username=#{@username}&callback=#{JSONP_CALLBACK}")
-    document.getElementsByTagName('head')[0].appendChild(script)
-
-  @parseGeoResponse: (response) =>
-    delete(window[JSONP_CALLBACK])
-    @set(new TimeZone(name: response.timezoneId, offset: response.rawOffset)) if response.timezoneId
-
-  @quick: =>
+  detectLocally: ->
     januaryOffset = @januaryOffset()
     juneOffset = @juneOffset()
     key = {offset: januaryOffset, dst: 0, hemisphere: HEMISPHERE_UNKNOWN}
@@ -45,35 +26,76 @@ class Temporal
       key = {offset: juneOffset, dst: 1, hemisphere: HEMISPHERE_SOUTH}
     new TimeZone("#{([key.offset, key.dst].join(','))}#{if key.hemisphere is HEMISPHERE_SOUTH then ',s' else ''}")
 
-  @set: (timezone) ->
-    window.timezone = timezone
+  geoLocate: ->
+    navigator.geolocation.getCurrentPosition(@geoSuccess, ->)
+
+  geoSuccess: (position) =>
+    window[jsonpCallback] = @parseGeoResponse
+    script = document.createElement('script')
+    script.setAttribute('src', "http://api.geonames.org/timezoneJSON?lat=#{position.coords.latitude}&lng=#{position.coords.longitude}&username=#{@username}&callback=#{jsonpCallback}")
+    document.getElementsByTagName('head')[0].appendChild(script)
+
+  parseGeoResponse: (response) =>
+    delete(window[jsonpCallback])
+    @set(new TimeZone(name: response.timezoneId, offset: response.rawOffset)) if response.timezoneId
+
+  set: (@timezone) ->
+    window.timezone = @timezone
     expiration = new Date()
     expiration.setMonth(expiration.getMonth() + 1)
-    document.cookie = "timezone=#{timezone.name}; expires=#{expiration.toGMTString()}"
-    document.cookie = "timezone_offset=#{timezone.offset}; expires=#{expiration.toGMTString()}"
-    @callback?(timezone)
+    document.cookie = "timezone=#{@timezone.name}; expires=#{expiration.toGMTString()}"
+    document.cookie = "timezone_offset=#{@timezone.offset}; expires=#{expiration.toGMTString()}"
+    @callback?(@timezone)
 
-  @get: ->
+  get: ->
     name: @getCookie('timezone')
-    offset: parseFloat(@getCookie('timezone_offset'))
+    offset: parseFloat(@getCookie('timezone_offset')) || 0
 
-  @getCookie: (name) ->
+  getCookie: (name) ->
     match = document.cookie.match(new RegExp("(?:^|;)\\s?#{name}=(.*?)(?:;|$)", 'i'))
     match && unescape(match[1])
 
-  @januaryOffset: ->
+  januaryOffset: ->
     @dateOffset(new Date(2011, 0, 1, 0, 0, 0, 0))
 
-  @juneOffset: ->
+  juneOffset: ->
     @dateOffset(new Date(2011, 5, 1, 0, 0, 0, 0))
 
-  @dateOffset: (date) ->
+  dateOffset: (date) ->
     -date.getTimezoneOffset()
 
-  @dateIsDst: (date) ->
+
+# Timezone -- contains offset and timezone name
+# -----------------------------------------------------------------------------
+class TimeZone
+
+  dateIsDst = (date) ->
     (((if date.getMonth() > 5 then @juneOffset() else @januaryOffset())) - @dateOffset(date)) isnt 0
 
-JSONP_CALLBACK = "geoSuccessCallback#{parseInt(Math.random() * 10000)}"
+  resolveAmbiguity = ->
+    ambiguous = AMBIGIOUS_ZONES[@name]
+    return if typeof(ambiguous) is 'undefined'
+    for key, value of ambiguous
+      if dateIsDst(DST_START_DATES[value])
+        @name = value
+        return
+
+  constructor: (keyOrProperties) ->
+    if typeof(keyOrProperties) == 'string'
+      zone = TIMEZONES[keyOrProperties]
+      @[property] = value for own property, value of zone
+      resolveAmbiguity()
+    else
+      @[property] = value for own property, value of keyOrProperties
+
+
+# Expose Temporal to the global scope
+# -----------------------------------------------------------------------------
+@Temporal = {detect: Temporal.detect, reference: -> Temporal}
+
+
+# Data
+# -----------------------------------------------------------------------------
 HEMISPHERE_SOUTH = 'SOUTH'
 HEMISPHERE_NORTH = 'NORTH'
 HEMISPHERE_UNKNOWN = 'N/A'
@@ -191,5 +213,3 @@ TIMEZONES =
   '765,1,s':  {offset: 12.75, name: 'Pacific/Chatham'}
   '780,0':    {offset: 13,    name: 'Pacific/Tongatapu'}
   '840,0':    {offset: 14,    name: 'Pacific/Kiritimati'}
-
-@Temporal = {detect: Temporal.detect}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: temporal-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Javascript timezone detection that also sets Time.zone for Rails to use
 email:
 - jejacks0n@gmail.com
@@ -122,6 +138,7 @@ files:
 - lib/temporal-rails.rb
 - vendor/assets/javascripts/temporal.js.coffee
 - LICENSE
+- spec/controllers/application_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/controllers/application_controller.rb
@@ -142,10 +159,13 @@ files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/engine/temporal_spec.rb
 - spec/javascripts/spec_helper.js
 - spec/javascripts/temporal_spec.js.coffee
+- spec/spec_helper.rb
 homepage: http://github.com/jejacks0n/temporal
 licenses:
 - MIT
@@ -161,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2430015501946444903
+      hash: -492844622740408129
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -170,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2430015501946444903
+      hash: -492844622740408129
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -178,6 +198,7 @@ signing_key:
 specification_version: 3
 summary: ! 'Temporal: Javascript timezone detection for Rails'
 test_files:
+- spec/controllers/application_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/controllers/application_controller.rb
@@ -198,7 +219,10 @@ test_files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/engine/temporal_spec.rb
 - spec/javascripts/spec_helper.js
 - spec/javascripts/temporal_spec.js.coffee
+- spec/spec_helper.rb