date_time_attribute 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWNmMGZkNmU3MjU3YmJlNmY5M2Y1OTE4ZTcxNjYxYjJjYzhjYzRmNQ==
+  data.tar.gz: !binary |-
+    ODIyYTdjYzg0NTEyZWRlYWY1NGJkOTNiNWEyNWZjNzIyYjRiMzgyNw==
+SHA512:
+  metadata.gz: !binary |-
+    YmFiMjNhNjIyYTcwOTJmNmZiYzQwY2E5OGI4ZjFjMzdhYmQ0NTkzYzllY2Ey
+    MWRiYjYxYjZlZDUzNjc4YmM0MjUzZDQ3MzY0NmQxNjg1ZjQ3MTAzZTViOThk
+    NmRjZjdkZTg0OGEwYjk4ZmYyYWQwNDYxMWU4YTZkZGU0ODY2NDk=
+  data.tar.gz: !binary |-
+    YmU4NjQxNDIzYjMxNDQzODZmYmI2MTRkZjY3NjQzYTE5NWI4NzQ3MTZiODM0
+    ZTIyNzE3ZTI5ZjJiNzBkYTRlNjNlNDg1NTE2N2I4ZDc2MjM4MTFlMTdkNDYz
+    NjU5NDVmNGEwMjc4NTFkYjJlNWU5YTQ5YTRlY2U3ZmRmNDkxZGM=

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: czlNGiIULZNDOuZC2lIz2JV0eC4IsE8C6

data/.gitignore

@@ -0,0 +1,19 @@
+# Packed ge
+*.gem
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+*.gem
+.rvmrc
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rspec"
+  gem 'coveralls', require: false
+end
+

data/README.md

@@ -0,0 +1,128 @@
+# DateTime attribute for Ruby!
+[![Gem Version](https://badge.fury.io/rb/date_time_attribute.png)](http://badge.fury.io/rb/date_time_attribute)
+[![Build Status](https://travis-ci.org/einzige/date_time_attribute.png?branch=master)](https://travis-ci.org/einzige/date_time_attribute)
+[![Dependency Status](https://gemnasium.com/einzige/date_time_attribute.png)](https://gemnasium.com/einzige/date_time_attribute)
+[![Coverage Status](https://coveralls.io/repos/einzige/date_time_attribute/badge.png)](https://coveralls.io/r/einzige/date_time_attribute)
+
+Splits DateTime attribute access into two Data, Time and TimeZone attributes.
+
+See also [ActiveRecord (Rails) version](https://github.com/einzige/date_time_attribute_rails).
+
+## Install
+
+```bash
+gem install date_time_attribute
+```
+
+## Enjoy
+
+```ruby
+require 'date_time_attribute'
+
+class Task
+  include DateTimeAttribute
+  date_time_attribute :due_at
+end
+
+task = Task.new
+task.due_at                      # => nil
+
+# Date set
+task.due_at_date = '2001-02-03'
+task.due_at_date                 # => 2001-02-03 00:00:00 +0700
+task.due_at_time                 # => 2001-02-03 00:00:00 +0700
+task.due_at                      # => 2001-02-03 00:00:00 +0700
+
+# Time set
+task.due_at_time = '10:00pm'
+task.due_at_time                 # => 2013-12-02 22:00:00 +0800
+task.due_at_date                 # => 2001-02-03 00:00:00 +0700
+task.due_at                      # => 2001-02-03 22:00:00 +0700
+
+# Time zone is applied as set
+task.due_at_time_zone = 'Moscow'
+task.due_at                      # => Mon, 03 Feb 2013 22:00:00 MSK +04:00
+task.due_at_time_zone = 'London'
+task.due_at                      # => Mon, 03 Feb 2013 22:00:00 GMT +00:00
+```
+
+You can also use it with already existing/initialized attributes
+
+```ruby
+class Task
+  include DateTimeAttribute
+
+  attr_accessor :due_at
+  date_time_attribute :due_at
+
+  def initialize
+    self.due_at = Time.zone.now.tomorrow
+  end
+end
+```
+
+## Using time zones
+
+Default time zone can be applied to an attribute:
+
+```ruby
+class Task
+  include DateTimeAttribute
+  date_time_attribute :due_at, time_zone: 'Moscow'
+end
+```
+
+```ruby
+class Task
+  include DateTimeAttribute
+  date_time_attribute :due_at, time_zone: Proc.new { 'Moscow' }
+end
+```
+
+```ruby
+class Task
+  include DateTimeAttribute
+  date_time_attribute :due_at, time_zone: :my_time_zone
+
+  def my_time_zone
+    self.in_da_moscow? ? 'Moscow' : 'Birobidgan'
+  end
+end
+```
+
+You can also explicitly set timezone:
+
+```ruby
+Time.zone = 'Krasnoyarsk'
+task.due_at                      # => nil
+task.due_at_time = '02:00am'
+task.due_at                      # => Mon, 02 Dec 2013 02:00:00 KRAT +08:00
+task.due_at_time_zone = 'Moscow'
+task.due_at                      # => Mon, 02 Dec 2013 02:00:00 MSK +04:00
+```
+
+## Using Chronic gem
+
+```ruby
+DateTimeAttribute.parser = Chronic
+
+task.due_at_date = 'next saturday'
+task.due_at_time = '10:00pm'
+```
+
+## Advanced usage
+
+```ruby
+my_date_time = DateTimeAttribute::Container.new
+my_date_time.date_time           # => nil
+my_date_time.date = '2001-02-03'
+my_date_time.date_time           # => 2001-02-03 00:00:00 +0700
+my_date_time.dime = '10:00pm'
+my_date_time.date_time           # => 2001-02-03 22:00:00 +0700
+
+# ...same as described above
+```
+
+## See also
+
+[ActiveRecord (Rails) version](https://github.com/einzige/date_time_attribute_rails)

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+task :default => :spec

data/date_time_attribute.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{date_time_attribute}
+  s.version = "0.0.4"
+
+  s.date = %q{2013-11-22}
+  s.authors = ["Sergei Zinin"]
+  s.email = %q{szinin@gmail.com}
+  s.homepage = %q{http://github.com/einzige/date_time_attribute}
+
+  s.licenses = ["MIT"]
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.extra_rdoc_files = ["README.md"]
+
+  s.description = %q{Allows to assign date and time attributes separately for a DateTime attribute in your model instance. Plays with time zones as well.}
+  s.summary = %q{Splits DateTime attribute access into three separate Data, Time and TimeZone attributes}
+
+  s.add_runtime_dependency 'activesupport', ">= 3.0.0"
+  s.add_development_dependency 'bundler'
+end

data/lib/date_time_attribute.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/duration'
+require 'date_time_attribute/container'
+
+module DateTimeAttribute
+  VERSION = '0.0.4'
+
+  extend ActiveSupport::Concern
+
+  def self.parser
+    DateTimeAttribute::Container.parser
+  end
+
+  # @param val Any adapter responding to #parse
+  def self.parser=(val)
+    DateTimeAttribute::Container.parser = val
+  end
+
+  # @param [Symbol] attribute
+  # @return [Container]
+  def date_time_container(attribute)
+    (@date_time_container ||= {})[attribute] ||= DateTimeAttribute::Container.new(send(attribute))
+  end
+
+  # @param [String, Symbol, Proc, nil] zone Time zone
+  def in_time_zone(zone)
+    case zone
+    when nil
+      yield
+    when ActiveSupport::TimeZone, String
+      old_zone = Time.zone
+      Time.zone = zone
+      yield(zone).tap { Time.zone = old_zone }
+    when Proc, Symbol
+      old_zone = Time.zone
+      zone = instance_eval(&(zone.to_proc))
+      Time.zone = zone
+      yield(zone).tap { Time.zone = old_zone }
+    else
+      raise ArgumentError, "Expected timezone, got #{zone.inspect}"
+    end
+  end
+
+  module ClassMethods
+
+    # @param [Symbol] attribute Attribute name
+    # @param [Hash<Symbol>] opts
+    # @option opts [String, Symbol, Proc, nil] :time_zone
+    def date_time_attribute(*attributes)
+      opts = attributes.extract_options!
+      time_zone = opts[:time_zone]
+
+      attributes.each do |attribute|
+        attribute = attribute.to_sym
+
+        # ActiveRecord issue: https://rails.lighthouseapp.com/projects/8994/tickets/4317-inconsistent-method_defined-bevahiour
+        if !(method_defined?(attribute) || (respond_to?(:attribute_method?) && attribute_method?(attribute)))
+          attr_accessor attribute
+        end
+
+        define_method("#{attribute}_date") do
+          in_time_zone(time_zone) do |time_zone|
+            date_time_container(attribute).in_time_zone(time_zone).date
+          end
+        end
+
+        define_method("#{attribute}_time") do
+          in_time_zone(time_zone) do |time_zone|
+            date_time_container(attribute).in_time_zone(time_zone).time
+          end
+        end
+
+        define_method("#{attribute}_time_zone") do
+          in_time_zone(time_zone) do |time_zone|
+            date_time_container(attribute).in_time_zone(time_zone).time_zone
+          end
+        end
+
+        define_method("#{attribute}_date=") do |val|
+          in_time_zone(time_zone) do |time_zone|
+            container = date_time_container(attribute).in_time_zone(time_zone)
+            (container.date = val).tap do
+              self.send("#{attribute}=", container.date_time)
+            end
+          end
+        end
+
+        define_method("#{attribute}_time=") do |val|
+          in_time_zone(time_zone) do |time_zone|
+            container = date_time_container(attribute).in_time_zone(time_zone)
+            (container.time = val).tap do
+              self.send("#{attribute}=", container.date_time)
+            end
+          end
+        end
+
+        define_method("#{attribute}_time_zone=") do |val|
+          in_time_zone(val) do |time_zone|
+            container = date_time_container(attribute).in_time_zone(time_zone)
+            self.send("#{attribute}=", container.date_time)
+            container.time_zone
+          end if val
+        end
+      end
+    end
+  end
+end

data/lib/date_time_attribute/container.rb

@@ -0,0 +1,81 @@
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/time/zones'
+require 'active_support/core_ext/module/delegation'
+
+module DateTimeAttribute
+  class Container < Struct.new(:date_time, :date, :time, :time_zone)
+    delegate :year, :month, :day, :hour, to: :date_time
+
+    # @param [String] time_zone
+    # @return [Container] self
+    def in_time_zone(time_zone)
+      self.time_zone = time_zone
+      update_date_time
+      self
+    end
+
+    # @return [String, nil]
+    def time_zone
+      @time_zone
+    end
+
+    # @param [String] val
+    def time_zone=(val)
+      (@time_zone = val).tap { update_date_time }
+    end
+
+    # @param [String, Date, Time, DateTime, nil] val
+    def date=(val)
+      @date = parse(val)
+      update_date_time
+      @date
+    end
+
+    # @param [String, Date, Time, DateTime, nil] val
+    def time=(val)
+      @time = parse(val)
+      update_date_time
+      @time
+    end
+
+    # @return [Date, String]
+    def date
+      @date || date_time
+    end
+
+    # @return [Time, String]
+    def time
+      @time || date_time
+    end
+
+    def self.parser
+      @parser || Time.zone || Time
+    end
+
+    # @param val Parser used for parsing date/time string values
+    def self.parser=(val)
+      @parser = val
+    end
+
+    private
+
+    def parse(val)
+      case val
+        when String
+          self.class.parser.parse(val)
+        when Date, Time, DateTime, ActiveSupport::TimeWithZone
+          val
+        when nil
+        else
+          raise ArgumentError, "Expected Date, Time, String, got #{val.class.name}"
+      end
+    end
+
+    def update_date_time
+      if @date || @time
+        date_time = self.class.parser.parse("#{date.try(:strftime, '%Y-%m-%d')} #{time.try(:strftime, '%H:%M')}")
+        self.date_time = time_zone ? date_time.in_time_zone(time_zone) : date_time
+      end
+    end
+  end
+end

data/spec/date_time_attribute/container_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe DateTimeAttribute::Container do
+  subject { described_class.new(Time.now) }
+
+  its(:year) { should == Time.now.year }
+  its(:month) { should == Time.now.month }
+  its(:day) { should == Time.now.day }
+  its(:hour) { should == Time.now.hour }
+
+  describe 'setters' do
+    before do
+      Time.zone = 'Pacific Time (US & Canada)'
+    end
+
+    subject(:target) { described_class.new(date_time, date, time) }
+
+    let(:date_time) { nil }
+
+    before do
+      target.date_time = date_time
+      target.date = date
+      target.time = time
+    end
+
+    context "nothing set" do
+      let(:date_time) { nil }
+      let(:date) { nil }
+      let(:time) { nil }
+
+      its(:date_time) { should be_nil }
+    end
+
+    context "time set" do
+      let(:date) { nil }
+      let(:time) { '23:00' }
+
+      its(:year) { should == Time.zone.now.year }
+      its(:month) { should == Time.zone.now.month }
+      its(:day) { should == Time.zone.now.day }
+      its(:hour) { should == 23 }
+    end
+
+    context "date set" do
+      let(:date) { '2001-02-03' }
+      let(:time) { nil }
+
+      its(:year) { should == 2001 }
+      its(:month) { should == 2 }
+      its(:day) { should == 3 }
+
+      it 'does not use current timezone' do
+        subject.hour.should == 0
+      end
+
+      context "time set" do
+        let(:date) { '2001-02-03' }
+        let(:time) { '10:00pm' }
+
+        its(:year) { should == 2001 }
+        its(:month) { should == 2 }
+        its(:day) { should == 3 }
+        its(:hour) { should == 22 }
+
+        context "non string values" do
+          let(:date) { Date.new(2001, 02, 03) }
+          let(:time) { Time.new(2001, 02, 03, 04, 05) }
+
+          its(:year) { should == 2001 }
+          its(:month) { should == 2 }
+          its(:day) { should == 3 }
+          its(:hour) { should == 4 }
+        end
+
+        context "time zone set" do
+          its(:year) { should == 2001 }
+          its(:month) { should == 2 }
+
+          specify do
+            expect { subject.time_zone = 'Moscow' }.to change { subject.time_zone }.from(nil).to('Moscow')
+          end
+
+          specify do
+            expect { subject.time_zone = 'Moscow' }.to change { subject.day }.from(3).to(4)
+          end
+
+          specify do
+            expect { subject.time_zone = 'Moscow' }.to change { subject.hour }.from(22).to(9)
+          end
+
+          context "different environment timezone set" do
+            before do
+              Time.zone = 'Krasnoyarsk'
+            end
+
+            its(:year) { should == 2001 }
+            its(:month) { should == 2 }
+            its(:day) { should == 3 }
+            its(:hour) { should == 22 }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/date_time_attribute_spec.rb

@@ -0,0 +1,205 @@
+require 'spec_helper'
+
+describe DateTimeAttribute do
+  before do
+    Time.zone = 'Pacific Time (US & Canada)'
+  end
+
+  describe ".parser" do
+    its(:parser) { should == Time.zone }
+  end
+
+  describe '.date_time_attribute' do
+    let(:dummy_class) do
+      Class.new do
+        include DateTimeAttribute
+        date_time_attribute :due_at, :created_at
+      end
+    end
+
+    subject(:target) { dummy_class.new }
+
+    it { should respond_to :due_at }
+    it { should respond_to :due_at_time }
+    it { should respond_to :due_at_date }
+    it { should respond_to :created_at }
+    it { should respond_to :created_at_time }
+    it { should respond_to :created_at_date }
+
+    describe "values" do
+      let(:due_at) { nil }
+      let(:date) { nil }
+      let(:time) { nil }
+      let(:time_zone) { nil }
+      subject(:date_time) { target.due_at }
+
+      before do
+        target.due_at = due_at
+        target.due_at_date = date
+        target.due_at_time = time
+        target.due_at_time_zone = time_zone
+      end
+
+      context "nothing set" do
+        let(:due_at) { nil }
+        let(:date) { nil }
+        let(:time) { nil }
+
+        it { should be_nil }
+      end
+
+      context "date_time set" do
+        let(:due_at) { Time.zone.now }
+        it { should_not be_nil }
+      end
+
+      context "time set" do
+        let(:date) { nil }
+        let(:time) { '23:00' }
+
+        its(:year) { should == Time.zone.now.year }
+        its(:month) { should == Time.zone.now.month }
+        its(:day) { should == Time.zone.now.day }
+        its(:hour) { should == 23 }
+      end
+
+      context "date set" do
+        let(:date) { '2001-02-03' }
+        let(:time) { nil }
+
+        its(:year) { should == 2001 }
+        its(:month) { should == 2 }
+        its(:day) { should == 3 }
+        its(:hour) { should == 0 }
+
+        context "time set" do
+          let(:date) { '2001-02-03' }
+          let(:time) { '10:00pm' }
+
+          its(:year) { should == 2001 }
+          its(:month) { should == 2 }
+          its(:day) { should == 3 }
+          its(:hour) { should == 22 }
+
+          context "timezone set explicitly" do
+            let(:time_zone) { 'Krasnoyarsk' }
+
+            its(:year) { should == 2001 }
+            its(:month) { should == 2 }
+            its(:day) { should == 3 }
+            its(:hour) { should == 22 }
+
+            specify do
+              subject.time_zone.name.should == 'Krasnoyarsk'
+            end
+          end
+
+          context "time zone set on attribute" do
+            let(:dummy_class) do
+              Class.new do
+                include DateTimeAttribute
+                date_time_attribute :due_at, time_zone: 'Moscow'
+              end
+            end
+
+            its(:year) { should == 2001 }
+            its(:month) { should == 2 }
+            its(:day) { should == 3 }
+            its(:hour) { should == 22 }
+
+            specify do
+              subject.time_zone.name.should == 'Moscow'
+            end
+
+            context "timezone set explicitly" do
+              let(:time_zone) { 'Krasnoyarsk' }
+
+              its(:year) { should == 2001 }
+              its(:month) { should == 2 }
+              its(:day) { should == 3 }
+              its(:hour) { should == 22 }
+
+              specify do
+                subject.time_zone.name.should == 'Krasnoyarsk'
+              end
+            end
+
+            context "different timezone set" do
+              before do
+                Time.zone = 'Krasnoyarsk'
+              end
+
+              its(:year) { should == 2001 }
+              its(:month) { should == 2 }
+              its(:day) { should == 3 }
+              its(:hour) { should == 22 }
+
+              specify do
+                subject.time_zone.name.should == 'Moscow'
+              end
+            end
+
+            context "timezone proc given" do
+              let(:dummy_class) do
+                Class.new do
+                  include DateTimeAttribute
+                  date_time_attribute :due_at, time_zone: Proc.new { 'Moscow' }
+                end
+              end
+
+              its(:year) { should == 2001 }
+              its(:month) { should == 2 }
+              its(:day) { should == 3 }
+              its(:hour) { should == 22 }
+
+              specify do
+                subject.time_zone.name.should == 'Moscow'
+              end
+            end
+
+            context "timezone method given" do
+              let(:dummy_class) do
+                Class.new do
+                  include DateTimeAttribute
+                  date_time_attribute :due_at, time_zone: :tz
+
+                  def tz
+                    'Moscow'
+                  end
+                end
+              end
+
+              its(:year) { should == 2001 }
+              its(:month) { should == 2 }
+              its(:day) { should == 3 }
+              its(:hour) { should == 22 }
+
+              specify do
+                subject.time_zone.name.should == 'Moscow'
+              end
+            end
+
+            context "nil timezone" do
+              let(:dummy_class) do
+                Class.new do
+                  include DateTimeAttribute
+                  date_time_attribute :due_at, time_zone: :tz
+
+                  def tz
+                    nil
+                  end
+                end
+              end
+
+              it { should be_a(Time) }
+              its(:year) { should == 2001 }
+              its(:month) { should == 2 }
+              its(:day) { should == 3 }
+              its(:hour) { should == 22 }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+if ENV['COVERALLS_CONFIG'] != 'nocoveralls'
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'date_time_attribute'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.color_enabled = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: date_time_attribute
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Sergei Zinin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: Allows to assign date and time attributes separately for a DateTime attribute
+  in your model instance. Plays with time zones as well.
+email: szinin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- date_time_attribute.gemspec
+- lib/date_time_attribute.rb
+- lib/date_time_attribute/container.rb
+- spec/date_time_attribute/container_spec.rb
+- spec/date_time_attribute_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/einzige/date_time_attribute
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Splits DateTime attribute access into three separate Data, Time and TimeZone
+  attributes
+test_files: []