has_zone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53371fa0b22046704af05bf67038f0d12b06965c
+  data.tar.gz: be7aff3caed35d3c9abb5f552a5f969803e2911f
+SHA512:
+  metadata.gz: 0f49581efb0258ad9566ebfd07dfbe505f7b08195c4728eb702b31a4a6f20b9e204e68357a462c4192c23aad23baf5ec76ac807e19b2fa6ea84baf56783bda8f
+  data.tar.gz: ca81dbaf1c9ed288391f3d9955f41ee805958231a5b5c470c42136900ff4c077ec67ec292f8515455bc86c3df31ffc8aecd4916b3cb90bc052c34549b97d64dd

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jerry Luk
+
+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,39 @@
+# HasZone
+
+Provides a way to convert from TZinfo time zone identifer to ActiveSupport TimeZone for your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_zone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_zone
+
+## Usage
+
+Assuming you have an attribute time_zone in your User model:
+
+    class User < ActiveRecord::Base
+      include HasZone
+      has_zone with: time_zone
+    end
+
+Then you can use the time zone with:
+
+    user.time_zone = "America/Los_Angeles"
+    user.zone # returns ActiveSupport::TimeZone of "Pacific Time (US & Canada)"
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new :spec
+
+task :default  => :spec

data/has_zone.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_zone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_zone"
+  spec.version       = HasZone::VERSION
+  spec.authors       = ["Jerry Luk"]
+  spec.email         = ["jerryluk@gmail.com"]
+  spec.description   = %q{Provides a way to convert from TZinfo time zone identifer to ActiveSupport TimeZone for your Rails application.}
+  spec.summary       = %q{Provides a way to convert from TZinfo time zone identifer to ActiveSupport TimeZone for your Rails application.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.0"
+  spec.add_dependency "activemodel", ">= 4.0"
+  spec.add_dependency "tzinfo"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/has_zone.rb

@@ -0,0 +1,3 @@
+require "has_zone/version"
+require "has_zone/tzinfo"
+require "has_zone/has_zone"

data/lib/has_zone/has_zone.rb

@@ -0,0 +1,42 @@
+module HasZone
+  extend ActiveSupport::Concern
+
+  included do
+
+    validates_inclusion_of :time_zone, in: ::ActiveSupport::TimeZone.tzids_map.keys, allow_blank: true, if: :time_zone_changed?
+
+    # This allows the model has the ability to store TimeZone.
+    # Usage:
+    # has_zone with: :time_zone
+    #
+    # It defines the following methods:
+    #
+    # :zone
+    # Public: Returns the Rails Time Zone.
+    #
+    #
+    # :zone=(identifier)
+    # Public: Sets the TimeZone by TZinfo identifier.
+    #
+    # identifier - Time Zone identifier
+    #
+    def self.has_zone(options = { with: :time_zone })
+      define_method(:zone) do
+        return nil if send(options[:with]).nil?
+        @zone ||= ::ActiveSupport::TimeZone.tzids_map[send(options[:with])].try(:name)
+      end
+
+      define_method(:zone=) do |tz|
+        zone = tz.is_a?(String) ? ::ActiveSupport::TimeZone.new(tz) : tz
+        send "#{options[:with]}=".to_sym, zone.try(:identifier)
+      end
+
+      define_method("#{options[:with]}=".to_sym) do |tz|
+        # Since we memoize the time zone, we need to reset it if the time zone has changed
+        @zone = nil
+        write_attribute(options[:with], tz)
+      end
+    end
+  end
+
+end

data/lib/has_zone/tzinfo.rb

@@ -0,0 +1,60 @@
+require 'tzinfo'
+
+module TZInfoExtension
+  module ClassMethods
+    def abbreviations_map
+      @abbreviations_map ||= begin
+        (abbreviations_map = {}).tap do |am|
+          all.each do |tz|
+            tz.abbreviations.each do |abb|
+              if am[abb].present?
+                am[abb] << tz
+              else
+                am[abb] = [tz]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+  module InstanceMethods
+    def next_period(period)
+      period_end = period.utc_end
+      period_end ? period_for_utc(period_end + 1.day) : nil
+    end
+
+    def abbreviations
+      date = Time.now.utc.beginning_of_year
+      abbreviations = []
+      period = period_for_local(date)
+      while not(abbreviations.include? period.abbreviation)
+        abbreviations << period.abbreviation
+        break unless (period = next_period(period))
+      end
+      abbreviations
+    end
+  end
+end
+
+class TZInfo::Timezone
+  extend TZInfoExtension::ClassMethods
+  include TZInfoExtension::InstanceMethods
+end
+
+class ActiveSupport::TimeZone
+  extend TZInfoExtension::ClassMethods
+  include TZInfoExtension::InstanceMethods
+
+  def self.tzids_map
+    @tzids_map ||= begin
+      (tzids_map = {}).tap do |tm|
+        zones_map.each { |n, z| tm[z.identifier] ||= z }
+      end
+    end
+  end
+
+  def identifier
+    self.tzinfo.try(:identifier)
+  end
+end

data/lib/has_zone/version.rb

@@ -0,0 +1,3 @@
+module HasZone
+  VERSION = "0.0.1"
+end

data/spec/has_zone_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe HasZone do
+  class Resource
+    include ActiveModel::Validations
+    include HasZone
+    attr_accessor :time_zone
+    has_zone with: :time_zone
+
+    def write_attribute(attribute, value)
+      instance_variable_set("@#{attribute}".to_sym, value)
+    end
+  end
+
+  let(:resource) { Resource.new }
+
+  it "returns nil if time_zone is nil" do
+    resource.time_zone = nil
+    resource.zone.should be_nil
+  end
+
+  it "returns TimeZone if time_zone is not nil" do
+    resource.time_zone = "America/New_York"
+    resource.zone.should_not be_nil
+  end
+
+  it "returns updated TimeZone if time_zone is updated" do
+    resource.time_zone = "America/New_York"
+    expect {
+      resource.time_zone = "America/Los_Angeles"
+    }.to change(resource, :zone)
+  end
+
+  it "sets TimeZone from string" do
+    resource.zone = "Pacific Time (US & Canada)"
+    resource.zone.should == ActiveSupport::TimeZone.new("Pacific Time (US & Canada)").name
+    resource.time_zone.should == "America/Los_Angeles"
+  end
+
+  it "sets TimeZone from TimeZone" do
+    zone = ActiveSupport::TimeZone.new("Pacific Time (US & Canada)")
+    resource.zone = zone
+    resource.zone.should == "Pacific Time (US & Canada)"
+    resource.time_zone.should == "America/Los_Angeles"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems'
+require 'active_support/all'
+require 'active_model'
+
+$: << File.join(File.dirname(__FILE__), "/../lib")
+require 'has_zone'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: has_zone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jerry Luk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a way to convert from TZinfo time zone identifer to ActiveSupport
+  TimeZone for your Rails application.
+email:
+- jerryluk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- has_zone.gemspec
+- lib/has_zone.rb
+- lib/has_zone/has_zone.rb
+- lib/has_zone/tzinfo.rb
+- lib/has_zone/version.rb
+- spec/has_zone_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Provides a way to convert from TZinfo time zone identifer to ActiveSupport
+  TimeZone for your Rails application.
+test_files:
+- spec/has_zone_spec.rb
+- spec/spec_helper.rb