local_date_time_attributes 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c32b770854306fb5b91ca41a48c0452657dc7f64753c9db4894858d4b9d03f8
+  data.tar.gz: 5a68e821cb30fef498e1a50c9e97af4a4a54e2df5da7ab9866acf7bb718e3b11
+SHA512:
+  metadata.gz: 89e8bbb4feee7621cba35ec4f83e84e8a01a4dd46e389afdad15d254a087d6b49acfea5891e64b875bf63339b437cce2ded224f3076fc850927b9f6b90b4e97e
+  data.tar.gz: 241ffa8f7852b5020c2cbe15de9618c9132bdce0c69c91c4e2a0349bfcfcbb35f6beb36e69e8dfcf141d8346bba837c293f317a27ca273799e36a6367a28c6ad

data/.github/workflows/gempush.yml

@@ -0,0 +1,30 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in local_date_time_attributes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    local_date_time_attributes (0.1.0)
+      activerecord (>= 5.0)
+      activesupport (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  local_date_time_attributes!
+  rake (~> 13.0)
+  rspec
+  timecop
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 azohoori
+
+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,71 @@
+# LocalDateTimeAttributes
+
+![Ruby](https://github.com/Cisco-AMP/local_date_time_attributes/workflows/Ruby/badge.svg) ![Ruby Gem](https://github.com/Cisco-AMP/local_date_time_attributes/workflows/Ruby%20Gem/badge.svg) [![Gem Version](https://badge.fury.io/rb/local_date_time_attributes.svg)](https://badge.fury.io/rb/local_date_time_attributes)
+
+Leverages the active_record attributes api to define a custom active_record type `local_date_time`. Normally, active_record will convert a Time,DateTime,Date which has a timezone into the active_record's base timezone - performing conversion of the time in the process. This custom attribute will ignore the timezone component of the `Time` attribute.
+
+Sometimes it is preferrable to ignore the timezone defined by [Time.zone](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html) before persisting or loading from persistence. In otherwords, the time_zone component is ignored prior to saving to the database and after loading from database
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'local_date_time_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install local_date_time_attributes
+
+
+## Usage
+
+On an active_record model, just add an attribute with the type `:local_date_time`
+
+    class Interview < ApplicationRecord
+      attribute :start_at, :local_date_time
+    end
+
+We will have a date_time attribute on ProductUpdate.start_at that ignores timezone prior to persisting and after loading
+
+
+
+    $ Time.zone = 'Eastern Time (US & Canada)'
+      => "Eastern Time (US & Canada)"
+
+    # active_record is setup to use a different timezone
+    $ ActiveRecord::Base.default_timezone
+      => :utc
+
+    $ time = Time.zone.local(2007, 2, 10, 15, 30, 45)
+      => Sat, 10 Feb 2007 15:30:45 EST -05:00
+
+    # Timezone is ignored when saving to a database
+    $ Interview.new(start_at: time).save
+       (0.4ms)  BEGIN
+      SQL (4.7ms)  UPDATE `interviews` SET `start_at` = '2007-02-10 15:30:45', `updated_at` = '2020-03-25 18:06:11' WHERE `product_updates`.`id` = 1
+       (1.5ms)  COMMIT
+
+    $ interview = Interview.first
+
+    $ interview.start_at
+      => Sat, 10 Feb 2007 15:30:45 EST -05:00
+
+    # timezone is ignored when loading
+    $ Time.use_zone('Asia/Singapore') { product_update.reload.start_at }
+      => Sat, 10 Feb 2007 15:30:45 +08 +08:00
+      
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Cisco-AMP/local_date_time_attributes.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "local_date_time_attributes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/local_date_time_attributes.rb

@@ -0,0 +1,9 @@
+require "local_date_time_attributes/version"
+require 'delegate'
+require 'active_support'
+require 'active_support/time'
+require 'active_support/time_with_zone'
+
+require 'local_date_time_attributes/local_date_time'
+require 'local_date_time_attributes/local_date_time_type'
+require 'local_date_time_attributes/railtie' if defined?(Rails)

data/lib/local_date_time_attributes/local_date_time.rb

@@ -0,0 +1,28 @@
+require 'delegate'
+require 'active_support'
+require 'active_support/time'
+require 'active_support/time_with_zone'
+module LocalDateTimeAttributes
+  class LocalDateTime < SimpleDelegator
+    def initialize(date_time)
+      super(from_local(date_time))
+    end
+
+    # Returns a datetime in the timezone specified without changing the time
+    def to_local(time_zone = Time.zone.try(:name))
+      return if __getobj__.nil? || time_zone.nil?
+      ActiveSupport::TimeZone.new(time_zone).local_to_utc(__getobj__).in_time_zone(time_zone)
+    end
+    
+    private
+    
+    def from_local(date_time)
+      return if date_time.nil?
+      ActiveSupport::TimeZone.new(active_record_timezone).local_to_utc(date_time).in_time_zone(active_record_timezone)
+    end
+
+    def active_record_timezone
+      ActiveRecord::Base.default_timezone == :UTC ? 'UTC' : Rails.configuration.time_zone
+    end
+  end
+end

data/lib/local_date_time_attributes/local_date_time_type.rb

@@ -0,0 +1,20 @@
+require 'active_record/type'
+module LocalDateTimeAttributes
+  class LocalDateTimeType < ActiveRecord::Type::DateTime
+    def cast(value)
+      if value.instance_of? LocalDateTime
+        return value
+      elsif !value.nil?
+        LocalDateTime.new(value)
+      end
+    end
+
+    def serialize(value)
+      value.try(:__getobj__)
+    end
+
+    def deserialize(value)
+      cast(value).try(:to_local)
+    end
+  end
+end

data/lib/local_date_time_attributes/railtie.rb

@@ -0,0 +1,8 @@
+require 'local_date_time_attributes/local_date_time_type'
+module LocalDateTimeAttributes
+  class Railtie < Rails::Railtie
+    initializer "local_date_time_attributes.types" do
+      ActiveRecord::Type.register(:local_date_time, LocalDateTimeAttributes::LocalDateTimeType)
+    end
+  end
+end

data/lib/local_date_time_attributes/version.rb

@@ -0,0 +1,3 @@
+module LocalDateTimeAttributes
+  VERSION = "0.1.1"
+end

data/local_date_time_attributes.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "local_date_time_attributes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "local_date_time_attributes"
+  spec.version       = LocalDateTimeAttributes::VERSION
+  spec.authors       = ["Samson Nguyen"]
+  spec.email         = ["samsnguy@cisco.com"]
+
+  spec.summary       = %q{ ActiveRecord attributes api to define a DateTime attribute that ignores Time.zone}
+  spec.description   = %q{Introduces a custom ActiveRecord attribute type which will ignore the timezone set by Time.zone. This is useful in the event we are modifying the current thread timezone}
+  spec.homepage      = "https://github.com/Cisco-AMP/local_date_time_attributes"
+
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    #spec.metadata["homepage_uri"] = spec.homepage
+    #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~>2.0'
+  spec.add_development_dependency 'rake', '~>13.0'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'activesupport', '>= 5.0'
+  spec.add_dependency 'activerecord', '>= 5.0'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: local_date_time_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Samson Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Introduces a custom ActiveRecord attribute type which will ignore the
+  timezone set by Time.zone. This is useful in the event we are modifying the current
+  thread timezone
+email:
+- samsnguy@cisco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gempush.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/local_date_time_attributes.rb
+- lib/local_date_time_attributes/local_date_time.rb
+- lib/local_date_time_attributes/local_date_time_type.rb
+- lib/local_date_time_attributes/railtie.rb
+- lib/local_date_time_attributes/version.rb
+- local_date_time_attributes.gemspec
+homepage: https://github.com/Cisco-AMP/local_date_time_attributes
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord attributes api to define a DateTime attribute that ignores Time.zone
+test_files: []