mongoid-time_with_named_zone 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79c13f8d281f31aa9f7322050df67573d4df3b58
+  data.tar.gz: 74bd30d3a7f9dd11adae14a25b0d7ae89c208f1e
+SHA512:
+  metadata.gz: 7861710c85df3fc471c6533313316b66de70aedebb797ae74f98b06c3661a1758a67978837e9461f30ea1695d98cada93e142c5d65c8f1fc87379e9139835e43
+  data.tar.gz: 4d7e21565a27c84de7fbc511378f855ad4213af444c9da4433267ffcf6df3decc39f0161979ea92f1b10ac221f905aecd8848b53aabcdffbc33dc56845044129

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2014 Carnival Mobile
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,68 @@
+# Mongoid Time With Zone
+
+Timezones can be a developer's worst nightmare and introduce subtle bugs.
+
+This gem provides a [Mongoid](mongoid.org) wrapper for Time objects that includes and retains the timezone name as a string.
+
+Reading from the database will use the `ActiveSupport::TimeWithZone`'s monkey patched `#in_time_zone` (monkey patched by Mongoid) to convert the time to being a TimeWithZone.
+
+This gem does not apply any monkey patches.
+
+This is necessary because MongoDB can save ISO8601 formatted date strings by using a [wrapping type ISODate()](http://docs.mongodb.org/manual/core/shell-types/#date),
+but these don't include the strings representing the name of the timezone. This gem stores timezone string in the database.
+
+## Usage
+
+with Bundler, add this gem to your `Gemfile`:
+
+```ruby
+gem 'mongoid-time_with_named_zone'
+```
+
+requiring manually:
+
+```ruby
+require 'mongoid/time_with_named_zone'
+```
+
+Define your Mongoid models with field types of `Mongoid::TimeWithNamedZone`:
+
+e.g.:
+
+```ruby
+
+class BlogPost
+
+  field :published_at, type: Mongoid::TimeWithNamedZone
+  field :body,         type: String
+
+end
+
+```
+
+and assign attributes to Time instances:
+
+```ruby
+post = BlogPost.new
+post.published_at = Time.now.in_time_zone('Pacific/Auckland')
+
+```
+
+## Testing
+
+Run `rake spec`
+
+## Contributing changes
+
+Once you've made your great commits:
+
+1. Fork time-with-zone
+2. Create a topic branch - git checkout -b my_branch
+3. Push to your branch - git push origin my_branch
+4. Open a Pull Request to discuss your changes
+
+That's it!
+
+## License
+
+See [LICENSE](LICENSE)

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => [:spec]

data/lib/mongoid/time_with_named_zone/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  class TimeWithNamedZone
+    VERSION = '0.1.1'.freeze
+  end
+end

data/lib/mongoid/time_with_named_zone.rb

@@ -0,0 +1,50 @@
+require 'mongoid/time_with_named_zone/version'
+
+# Mongoid namespace from the Mongoid gem
+module Mongoid
+  # Object that stores time and tz information as embedded object
+  # transparently works with AS:TwZ, supports mongoid serialization
+  class TimeWithNamedZone
+    attr_reader :time, :zone
+
+    def initialize(time, zone = 'UTC')
+      @time, @zone = time, zone
+    end
+
+    # Converts an object of this instance into a database friendly value.
+    def mongoize
+      TimeWithNamedZone.mongoize(self)
+    end
+
+    class << self
+      # Get the object as it was stored in the database, and instantiate`
+      # this custom class from it.
+      def demongoize(object)
+        object[:time].in_time_zone(object[:zone]) if object
+      end
+
+      def mongoize(object)
+        hash = case object
+               when self
+                 {
+                   time: object.time,
+                   zone: ActiveSupport::TimeZone.new(object.zone).name
+                 }
+               when ActiveSupport::TimeWithZone
+                 {
+                   time: object.utc,
+                   zone: object.time_zone
+                 }
+               when Time
+                 {
+                   time: object.utc,
+                   zone: 'UTC'
+                 }
+               else
+                 nil
+               end
+        hash.mongoize
+      end
+    end
+  end
+end

data/lib/mongoid-time_with_named_zone.rb

@@ -0,0 +1 @@
+require 'mongoid/time_with_named_zone'

data/mongoid-time_with_named_zone.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/time_with_named_zone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongoid-time_with_named_zone'
+  spec.version       = Mongoid::TimeWithNamedZone::VERSION
+  spec.authors       = ['Carnival Mobile', 'Arthur Evstifeev', 'Artur Khantimirov']
+  spec.email         = ['toby@carnivallabs.com']
+  spec.summary       = %q{A Mongoid wrapper for Time objects that retains the timezone name}
+  spec.description   = %q{This gem works transparently with ActiveSupport::TimeWithZone Times. See more: https://github.com/carnivalmobile/time-with-zone}
+  spec.homepage      = 'https://github.com/carnivalmobile/time-with-zone'
+  spec.license       = 'Apache 2'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'mongoid', '>= 3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+end

data/spec/time_with_zone_spec.rb

@@ -0,0 +1,47 @@
+require 'mongoid'
+require 'mongoid/time_with_named_zone'
+
+describe Mongoid::TimeWithNamedZone do
+  describe '#mongoize' do
+    context 'TimeWithNamedZone' do
+      let(:time) { Mongoid::TimeWithNamedZone.new(Time.utc(2010, 11, 19), 'Pacific/Auckland') }
+      let(:time_with_invalid_zone) { Mongoid::TimeWithNamedZone.new(Time.utc(2010, 11, 19), 'Invalid_timezone') }
+
+      it 'returns hash with utc time and zone' do
+        expect(Mongoid::TimeWithNamedZone.mongoize(time)).to eq(time: Time.utc(2010, 11, 19), zone: 'Pacific/Auckland')
+      end
+
+      it 'raise an error for invalid timezone' do
+        expect { Mongoid::TimeWithNamedZone.mongoize(time_with_invalid_zone) }.to raise_error
+      end
+    end
+
+    context 'ActiveSupport::TimeWithZone' do
+      let(:time) { ActiveSupport::TimeWithZone.new(Time.utc(2010, 11, 19), 'Pacific/Auckland') }
+
+      it 'returns hash with utc time and zone' do
+        expect(Mongoid::TimeWithNamedZone.mongoize(time)).to eq(time: Time.utc(2010, 11, 19), zone: 'Pacific/Auckland')
+      end
+    end
+
+    context 'Time' do
+      let(:time) { Time.utc(2010, 11, 19) }
+
+      it 'returns hash with utc time and utc zone' do
+        expect(Mongoid::TimeWithNamedZone.mongoize(time)).to eq(time: Time.utc(2010, 11, 19), zone: 'UTC')
+      end
+    end
+  end
+
+  describe '.demongoize' do
+    it 'returns time in saved zone' do
+      hash = { time: Time.utc(2010, 11, 19), zone: 'Pacific/Auckland' }
+      demongoized_value = Mongoid::TimeWithNamedZone.demongoize(hash)
+      expect(demongoized_value).to eq(Time.new(2010, 11, 19, '+13:00'))
+    end
+
+    it 'returns nil for blank object' do
+      expect(Mongoid::TimeWithNamedZone.demongoize(nil)).to eq(nil)
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-time_with_named_zone
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Carnival Mobile
+- Arthur Evstifeev
+- Artur Khantimirov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 'This gem works transparently with ActiveSupport::TimeWithZone Times.
+  See more: https://github.com/carnivalmobile/time-with-zone'
+email:
+- toby@carnivallabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid-time_with_named_zone.rb
+- lib/mongoid/time_with_named_zone.rb
+- lib/mongoid/time_with_named_zone/version.rb
+- mongoid-time_with_named_zone.gemspec
+- spec/time_with_zone_spec.rb
+homepage: https://github.com/carnivalmobile/time-with-zone
+licenses:
+- Apache 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- "/Users/Caleb/Projects/time-with-zone/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: A Mongoid wrapper for Time objects that retains the timezone name
+test_files:
+- spec/time_with_zone_spec.rb