arel_extensions 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9093dcc8b0e665c9bde4c86d7c1c81314ea3766ea8f3cb0774693fb8d8b08dbf
-  data.tar.gz: 89512b1344dfdd0d5f1701f843c5297a24a23a606e105249f3e68c707f080201
+  metadata.gz: c069fafddb858e0acc7cee0bf1bc435c2127ccdf6e5d870b8e9caff0d31abdb1
+  data.tar.gz: 2d0898c4d35fbe0ac72ccb395ef79ae63f10b662ce6003cea0702d55c27b2729
 SHA512:
-  metadata.gz: cda694a64773c8bce00f47842d2429b431db612cfd9e7bc899f53050d8ed8e4a2a07c087e29bb8ce615f42a4bbbcdcfcc4ef2ab19b17ff8a1bf744f85978ae68
-  data.tar.gz: c583725ca48d87d6654ed16b086735fe73b1c12af5161b7cc7148fe7c7abdf42919456b2bcf95ef58d1cf18af3f1eda02101da8c9d1dc364a2648071954559fd
+  metadata.gz: aa4f685f2548b172488d6f3537754c51ad269773a2ff525b7e114e8d4da38bfe41c38cbeee20cb67d7557b46c39c10d218e80181ffa5ebe6be393763981d57d3
+  data.tar.gz: 664cf3c829c5df39b3ef8c9913cec516214482e328f01a8c71370aa937abc47194a20b31b8d930a297c322e22025d1af9b1b49384df08ec65860203b8bf27f78

data/README.md

@@ -152,7 +152,9 @@ t[:birthdate].format('%Y-%m-%d').to_sql
 ```
 
 Which formats the datetime without any time zone conversion.
-The second form is:
+The second form accepts 2 kinds of values:
+
+1. String:
 
 ```ruby
 t[:birthdate].format('%Y/%m/%d %H:%M:%S', 'posix/Pacific/Tahiti')
@@ -162,7 +164,18 @@ t[:birthdate].format('%Y/%m/%d %H:%M:%S', 'posix/Pacific/Tahiti')
 #                                                                            ^^^^^^^^^^^^^^^^^^^^ 🚨 Invalid timezone for SQL Server. Explanation below.
 ```
 
-This will convert the datetime field to the supplied time zone.
+which will convert the datetime field to the supplied time zone. This generally
+means that you're letting the RDBMS decide or infer what is the timezone of the
+column before conversion to the supplied timezone.
+
+1. Hash of the form `{ src_time_zone => dst_time_zone }`:
+
+```ruby
+t[:birthdate].format('%Y/%m/%d %H:%M:%S', { 'posix/Europe/Paris' => 'posix/Pacific/Tahiti' })
+```
+
+which will explicitly indicate the original timestamp that should be considered
+by the RDBMS.
 
 Warning:
 
@@ -176,6 +189,14 @@ Warning:
   - ☣️ Choosing abbreviate forms like `CET`, which stands for `Central European
     Time` will behave differently on `PostgreSQL` and `MySQL`. Don't assume
     uniform behavior, or even a _rational_ one.
+- ⚠️ Pay attention to the type of the `datetime` column you're working with. For
+  example, in Postgres, a `datetime` can be one of the following types:
+  1. `timestamp with time zone`
+  2. `timestamp without time zone`
+  In the first case, you don't need to supply a conversion hash because postgres
+  knows how to convert it to the desired time zone. However, if you do the same
+  for the second case, you might get surprises, especially if your Postgres
+  installation's default timezone is not `UTC`.
 - ⚠️ SQLite is not supported.
 - 🚨 Always test against your setup 🚨
 

data/lib/arel_extensions/nodes/format.rb

@@ -10,7 +10,7 @@ module ArelExtensions
       def initialize expr
         col = expr[0]
         @iso_format = convert_format(expr[1])
-        @time_zone  = Arel::Nodes.build_quoted(expr[2]) if expr[2]
+        @time_zone  = expr[2]
         @col_type = type_of_attribute(col)
         super [col, convert_to_string_node(@iso_format)]
       end

data/lib/arel_extensions/version.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = "2.1.1".freeze
+  VERSION = "2.1.2".freeze
 end

data/lib/arel_extensions/visitors/mssql.rb

@@ -276,9 +276,16 @@ module ArelExtensions
             collector << ' '
           end
           collector = visit o.left, collector
-          if o.time_zone
-            collector << ") AT TIME ZONE 'UTC' AT TIME ZONE "
-            collector = visit o.time_zone, collector
+          case o.time_zone
+          when Hash
+            src_tz, dst_tz = o.time_zone.first
+            collector << ') AT TIME ZONE '
+            collector = visit Arel::Nodes.build_quoted(src_tz), collector
+            collector << ' AT TIME ZONE '
+            collector = visit Arel::Nodes.build_quoted(dst_tz), collector
+          when String
+            collector << ') AT TIME ZONE '
+            collector = visit Arel::Nodes.build_quoted(o.time_zone), collector
           end
           collector << LOADED_VISITOR::COMMA
           collector << fmt.to_s
@@ -307,9 +314,16 @@ module ArelExtensions
                 collector << ' '
               end
               collector = visit o.left, collector
-              if o.time_zone
-                collector << ") AT TIME ZONE 'UTC' AT TIME ZONE "
-                collector = visit o.time_zone, collector
+              case o.time_zone
+              when Hash
+                src_tz, dst_tz = o.time_zone.first.first, o.time_zone.first.second
+                collector << ") AT TIME ZONE "
+                collector = visit Arel::Nodes.build_quoted(src_tz), collector
+                collector << " AT TIME ZONE "
+                collector = visit Arel::Nodes.build_quoted(dst_tz), collector
+              when String
+                collector << ") AT TIME ZONE "
+                collector = visit Arel::Nodes.build_quoted(o.time_zone), collector
               end
               collector << ')'
               collector << ')'                                  if !fmt

data/lib/arel_extensions/visitors/mysql.rb

@@ -211,9 +211,17 @@ module ArelExtensions
           collector << "DATE_FORMAT("
           collector << "CONVERT_TZ(" if o.time_zone
           collector = visit o.left, collector
-          if o.time_zone
+          case o.time_zone
+          when Hash
+            src_tz, dst_tz = o.time_zone.first
+            collector << COMMA
+            collector = visit Arel::Nodes.build_quoted(src_tz), collector
+            collector << COMMA
+            collector = visit Arel::Nodes.build_quoted(dst_tz), collector
+            collector << ')'
+          when String
             collector << COMMA << "'UTC'" << COMMA
-            collector = visit o.time_zone, collector
+            collector = visit Arel::Nodes.build_quoted(o.time_zone), collector
             collector << ')'
           end
           collector << COMMA

data/lib/arel_extensions/visitors/oracle.rb

@@ -449,9 +449,16 @@ module ArelExtensions
         collector << "TO_CHAR("
         collector << "CAST(" if o.time_zone
         collector = visit o.left, collector
-        if o.time_zone
-          collector << " as timestamp) at time zone "
-          collector = visit o.time_zone, collector
+        case o.time_zone
+        when Hash
+          src_tz, dst_tz = o.time_zone.first
+          collector << ' as timestamp) at time zone '
+          collector = visit Arel::Nodes.build_quoted(src_tz), collector
+          collecto < ' at time zone '
+          collector = visit Arel::Nodes.build_quoted(dst_tz), collector
+        when String
+          collector << ' as timestamp) at time zone '
+          collector = visit Arel::Nodes.build_quoted(o.time_zone), collector
         end
         collector << COMMA
         collector = visit Arel::Nodes.build_quoted(fmt), collector

data/lib/arel_extensions/visitors/postgresql.rb

@@ -175,10 +175,18 @@ module ArelExtensions
       def visit_ArelExtensions_Nodes_Format o, collector
         fmt = ArelExtensions::Visitors::strftime_to_format(o.iso_format, DATE_FORMAT_DIRECTIVES)
         collector << "TO_CHAR("
+        collector << '(' if o.time_zone
         collector = visit o.left, collector
-        if o.time_zone
-          collector << " AT TIME ZONE "
-          collector = visit o.time_zone, collector
+        case o.time_zone
+        when Hash
+          src_tz, dst_tz = o.time_zone.first
+          collector << ') AT TIME ZONE '
+          collector = visit Arel::Nodes.build_quoted(src_tz), collector
+          collector << ' AT TIME ZONE '
+          collector = visit Arel::Nodes.build_quoted(dst_tz), collector
+        when String
+          collector << ') AT TIME ZONE '
+          collector = visit Arel::Nodes.build_quoted(o.time_zone), collector
         end
         collector << COMMA
         collector = visit Arel::Nodes.build_quoted(fmt), collector

data/test/arelx_test_helper.rb

@@ -52,7 +52,6 @@ end
 load_lib(db_and_gem[ENV['DB']])
 
 require 'arel_extensions'
-Arel::Table.engine = FakeRecord::Base.new
 
 $arel_silence_type_casting_deprecation = true
 

data/test/with_ar/all_agnostic_test.rb

@@ -403,35 +403,39 @@ module ArelExtensions
                             'tahiti'    => 'Hawaiian Standard Time',
                             'paris'     => 'Central European Standard Time'
                            },
-          'mysql'       => {
+          'posix'       => {
                             'utc'       => 'UTC',
                             'sao_paulo' => 'America/Sao_Paulo',
                             'tahiti'    => 'Pacific/Tahiti',
                             'paris'     => 'Europe/Paris'
-                           },
-          'oracle'  => {
-                            'utc'       => 'UTC',
-                            'sao_paulo' => 'America/Sao_Paulo',
-                            'tahiti'    => 'Pacific/Tahiti',
-                            'paris'     => 'Europe/Paris'
-                            },
-          'postgresql'  => {
-                            'utc'       => 'UTC',
-                            'sao_paulo' => 'America/Sao Paulo (-03)',
-                            'tahiti'    => 'Pacific/Tahiti (-10)',
-                            'paris'     => 'Europe/Paris'
-                            },
+                           }
         }
 
-        tz = time_zones[ENV['DB']]
-        skip "Unsupported timezone conversion for DB=#{ENV['DB']}" if tz.nil?
+        skip "Unsupported timezone conversion for DB=#{ENV['DB']}" if !['mssql', 'mysql', 'oracle', 'postgresql'].include?(ENV['DB'])
+
+        tz = ENV['DB'] == 'mssql' ? time_zones['mssql'] : time_zones['posix']
+
         assert_equal '2014/03/03 12:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S', tz['utc']))
-        assert_equal '2014/03/03 09:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S', tz['sao_paulo']))
-        assert_equal '2014/03/03 02:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S', tz['tahiti']))
+        assert_equal '2014/03/03 09:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S', { tz['utc'] => tz['sao_paulo'] }))
+        assert_equal '2014/03/03 02:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S', { tz['utc'] => tz['tahiti'] }))
+
+        # Skipping conversion from UTC to the desired timezones fails in SQL
+        # Server and Postgres. This is mainly due to the fact that timezone
+        # information is not preserved in the column itself.
+        #
+        # MySQL is happy to consider that times by default are in UTC.
+        assert_equal '2014/03/03 13:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S', { tz['utc'] => tz['paris'] }))
+        refute_equal '2014/03/03 13:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S', tz['paris'])) if !['mysql'].include?(ENV['DB'])
 
         # Winter/Summer time
-        assert_equal '2022/02/01 11:42:00', t(@lucas, Arel::Nodes.build_quoted('2022-02-01 10:42:00').cast(:datetime).format('%Y/%m/%d %H:%M:%S', tz['paris']))
-        assert_equal '2022/08/01 12:42:00', t(@lucas, Arel::Nodes.build_quoted('2022-08-01 10:42:00').cast(:datetime).format('%Y/%m/%d %H:%M:%S', tz['paris']))
+        assert_equal '2014/08/03 14:42:00', t(@lucas, (@updated_at + 5.months).format('%Y/%m/%d %H:%M:%S', { tz['utc'] => tz['paris'] }))
+        if ENV['DB'] == 'mssql'
+          assert_equal '2022/02/01 11:42:00', t(@lucas, Arel::Nodes.build_quoted('2022-02-01 10:42:00').cast(:datetime).format('%Y/%m/%d %H:%M:%S', { tz['utc'] => tz['paris'] }))
+          assert_equal '2022/08/01 12:42:00', t(@lucas, Arel::Nodes.build_quoted('2022-08-01 10:42:00').cast(:datetime).format('%Y/%m/%d %H:%M:%S', { tz['utc'] => tz['paris'] }))
+        else
+          assert_equal '2022/02/01 11:42:00', t(@lucas, Arel::Nodes.build_quoted('2022-02-01 10:42:00').cast(:datetime).format('%Y/%m/%d %H:%M:%S', tz['paris']))
+          assert_equal '2022/08/01 12:42:00', t(@lucas, Arel::Nodes.build_quoted('2022-08-01 10:42:00').cast(:datetime).format('%Y/%m/%d %H:%M:%S', tz['paris']))
+        end
       end
 
       def test_coalesce

data/version_v1.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = "1.3.1".freeze
+  VERSION = "1.3.2".freeze
 end

data/version_v2.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = "2.1.1".freeze
+  VERSION = "2.1.2".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arel_extensions
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Yann Azoury
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord