auto_timezone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9901a6357efef35d0cde1aa805aa999b5a8e658b
+  data.tar.gz: 705672de63cafabf10d84f4b823a164355bf286a
+SHA512:
+  metadata.gz: 0436d6a733b2d80affc27b091e525bfcc80c61685dff72582a7f0aa94d35b419ab20f5b6260daad03cecdfb30ed594eff344c20bf9a0e14bf541f1b56ae06c07
+  data.tar.gz: 6d815ce6e38fdc83d275ff0f8d3639c098a4a9e647d95a01278fbad842f218746f5f201edbbd1fcd76bdc38cb6e5eb5a9362223801dd4d039862b9fb929739f5

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store
+.env

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nathan Griffith
+
+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,60 @@
+# AutoTimezone
+
+Automatically infer and set `Time.zone` with each request. The available (and configurable)
+strategies include:
+
+* Using the timezone offset provided by the browser. **[Now supports Daylight Savings Time]**
+* Using a value stored on `current_user` (or anything accessible in the context of the controller)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auto_timezone'
+```
+
+And then execute:
+
+    $ bundle
+
+Lastly, add this line to the top of your `application.js` (it has no dependencies):
+
+```javascript
+//= require auto_timezone
+```
+
+## Usage
+
+Without any additional configuration, your application should start honoring timezone by asking
+the browser for the offset from UTC time.
+
+To install the `auto_timezone.rb` configuration initializer, execute:
+
+    $ rails g auto_timezone:install
+
+Check out the generated `auto_timezone.rb` for more configuration settings.
+
+## Limitations
+
+Currently, the auto-inferred timezone will only take effect *after* the first pageload.
+
+For the first pageload, you may want to set a more useful default timezone in `application.rb`:
+
+```ruby
+config.time_zone = 'Eastern Time (US & Canada)'
+```
+
+## To Do
+
+* Implement `jsTimezoneDetect` strategy
+* Implement tests
+* Infer or approximate timezone during initial web request (somehow...)
+
+## Contributing
+
+1. Fork it ( https://github.com/smudge/auto_timezone/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/auto_timezone.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_timezone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'auto_timezone'
+  spec.version       = AutoTimezone::VERSION
+  spec.authors       = ['smudge']
+  spec.email         = ['nathan@ngriffith.com']
+  spec.summary       = 'Simple and unobtrusive timezone configuration for Rails'
+  spec.description   = 'Automatically infer and set `Time.zone` with each web request.'
+  spec.homepage      = 'http://github.com/smudge/auto_timezone'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'railties', '~> 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/auto_timezone.rb

@@ -0,0 +1,10 @@
+require 'auto_timezone/version'
+require 'auto_timezone/config'
+require 'auto_timezone/controller'
+
+module AutoTimezone
+  class Engine < ::Rails::Engine
+  end
+end
+
+ActionController::Base.send :include, AutoTimezone::Controller

data/lib/auto_timezone/config.rb

@@ -0,0 +1,28 @@
+module AutoTimezone
+  class Config
+    attr_accessor :preferred_timezones
+    attr_accessor :default_timezone_block
+
+    def initialize
+      set_defaults
+    end
+
+    def default_timezone(&block)
+      self.default_timezone_block = block
+    end
+
+  private
+
+    def set_defaults
+      self.preferred_timezones = %w(US/Eastern US/Central US/Mountain US/Pacific)
+    end
+  end
+
+  def self.configure(&block)
+    block.call(config)
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/lib/auto_timezone/controller.rb

@@ -0,0 +1,15 @@
+require_relative 'sundial'
+
+module AutoTimezone
+  module Controller
+    def self.included(base)
+      base.prepend_around_filter :use_auto_timezone
+    end
+
+  private
+
+    def use_auto_timezone(&block)
+      Time.use_zone(Sundial.new(self).current_timezone, &block)
+    end
+  end
+end

data/lib/auto_timezone/sundial.rb

@@ -0,0 +1,44 @@
+module AutoTimezone
+  class Sundial
+    def initialize(ctx)
+      @ctx = ctx
+      return if !config.default_timezone_block || @ctx.respond_to?(:auto_timezone_default)
+      @ctx.define_singleton_method :auto_timezone_default, config.default_timezone_block
+    end
+
+    def current_timezone
+      @current_timezone ||= Time.find_zone(timezone_name)
+    end
+
+    def self.preferred_zones
+      @preferred_zones ||= config.preferred_timezones.map { |z| Time.find_zone(z) }
+    end
+
+  private
+
+    def timezone_name
+      cookies[:auto_timezone] ||= timezone_from_config_block
+      cookies[:auto_timezone] ||= timezone_from_offset
+    end
+
+    def timezone_from_config_block
+      @ctx.auto_timezone_default if @ctx.respond_to?(:auto_timezone_default)
+    end
+
+    def timezone_from_offset
+      find_zone_by_offset(cookies[:auto_timezone_offset].presence.try(:to_i)).try(:name)
+    end
+
+    def find_zone_by_offset(offset)
+      self.class.preferred_zones.find { |z| z.utc_offset == offset } || Time.find_zone(offset)
+    end
+
+    def cookies
+      @ctx.send(:cookies)
+    end
+
+    def config
+      AutoTimezone.config
+    end
+  end
+end

data/lib/auto_timezone/version.rb

@@ -0,0 +1,3 @@
+module AutoTimezone
+  VERSION = '0.0.1'
+end

data/lib/generators/auto_timezone/install_generator.rb

@@ -0,0 +1,12 @@
+module AutoTimezone
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Copies auto_timezone config to your initializers.'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_config_file
+        template 'config_initializer.rb', 'config/initializers/auto_timezone.rb'
+      end
+    end
+  end
+end

data/lib/generators/auto_timezone/templates/config_initializer.rb

@@ -0,0 +1,15 @@
+AutoTimezone.configure do |config|
+  # To allow users to customize their timezone (once logged-in), uncomment the following line
+  # and modify to support your desired method of retrieving a timezone:
+  #
+  # config.default_timezone do
+  #   current_user.timezone
+  # end
+
+  # Because multiple named timezones fall under the same UTC offset, we have no way of knowing
+  # the exact timezone (by name). You may customize a list of "preferred" timezones if you have a
+  # general idea of where your users reside, within a specific UTC offset.
+  # The default config value is: ['US/Eastern', 'US/Central', 'US/Mountain', 'US/Pacific']
+  #
+  # config.preferred_timezones += %w(Hawaii Alaska)
+end

data/vendor/assets/javascripts/auto_timezone.js

@@ -0,0 +1,7 @@
+Date.prototype.getDSTTimezoneOffset = function() {
+  var jan = new Date(this.getFullYear(), 0, 1);
+  var jul = new Date(this.getFullYear(), 6, 1);
+  return Math.max(jan.getTimezoneOffset(), jul.getTimezoneOffset());
+}
+
+document.cookie = "auto_timezone_offset=" + -60 * new Date().getDSTTimezoneOffset();

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: auto_timezone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- smudge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Automatically infer and set `Time.zone` with each web request.
+email:
+- nathan@ngriffith.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_timezone.gemspec
+- lib/auto_timezone.rb
+- lib/auto_timezone/config.rb
+- lib/auto_timezone/controller.rb
+- lib/auto_timezone/sundial.rb
+- lib/auto_timezone/version.rb
+- lib/generators/auto_timezone/install_generator.rb
+- lib/generators/auto_timezone/templates/config_initializer.rb
+- vendor/assets/javascripts/auto_timezone.js
+homepage: http://github.com/smudge/auto_timezone
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple and unobtrusive timezone configuration for Rails
+test_files: []
+has_rdoc: