fmrest 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f96cf4500b2417bde1c853954dee03a362088adac933fc7d803d8e37e91cc8a
-  data.tar.gz: e6cd271dbfef1c87c04a515b8a22e7ead87ec88ab915b37245d4dcecc7c9a237
+  metadata.gz: 53c6e0d0260a3b825c031831136651a5f2252d8d0cebd8e2077919caf13d0fb6
+  data.tar.gz: 215b6d2a7735ce0a3109ae542f400aa0bee0d60f8808225fc4d77c52009c37d3
 SHA512:
-  metadata.gz: 68c4083e32e942fd609b050c2001d32b97c18d88ab70301f10ff0ce31527af2c5faff6e210afceaf152280dc2e0924a8edf2e2994e28ad331d2f015860f172f3
-  data.tar.gz: 9af1f38e2a59bda96639d6b6f1d3756b007a8c327392159f6288f2365161a94a211ff483744499771716e8e1d61cd8a57876fbfffcf7646e61db52d1794ab1a3
+  metadata.gz: 4fdbb4dbc83ed0409e6680e8ffd028794ac01c07335ca43c95bd076e99359c17151b14634cb1a77bd41043ad104566ad5f820805de73d1f683aa957b02ad4fa5
+  data.tar.gz: 15966e4cc59a6bb9161f6edd6250beaa948d1c5c69ff911b3f2ca1eba2f782d79b8097c2038513e3ad4b84263b6b9e5f812cc7c37708a72f8a52d8db454b078f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### 0.10.0
+
+* Added `FmRest::StringDateAwareness` module to correct some issues when using
+  `FmRest::StringDate`
+* Added basic timezones support
+* Deprecated `class < FmRest::Spyke::Base(config_hash)` syntax in favor of
+  using `self.fmrest_config=`
+
 ### 0.9.0
 
 * Added `FmRest::Spyke::Base.set_globals`

data/README.md

@@ -120,6 +120,7 @@ Option              | Description                                | Format
 `:date_format`      | Date parsing format                        | String (FM date format)     | `"MM/dd/yyyy"`
 `:timestamp_format` | Timestmap parsing format                   | String (FM date format)     | `"MM/dd/yyyy HH:mm:ss"`
 `:time_format`      | Time parsing format                        | String (FM date format)     | `"HH:mm:ss"`
+`:timezone`         | The timezone for the FM server             | `:local` \| `:utc` \: `nil` | `nil`
 
 ### Default connection settings
 
@@ -270,9 +271,9 @@ a DSL in model classes).
 ### Hybrid string/date objects
 
 `FmRest::StringDate` and `FmRest::StringDateTime` are special classes that
-inherit from `String`, but internally parse and store a `Date`/`DateTime`
-(respectively), and delegate any methods not provided by `String` to those
-objects. In other words, they quack like a duck *and* bark like a dog.
+inherit from `String`, but internally parse and store a `Date` or `DateTime`,
+and delegate any methods not provided by `String` to those objects. In other
+words, they quack like a duck *and* bark like a dog.
 
 You can use these when you want fmrest-ruby to provide you with date objects,
 but you don't want to worry about date coercion of false positives (i.e. a
@@ -280,7 +281,29 @@ string field that gets converted to `Date` because it just so matched the given
 date format).
 
 Be warned however that these classes come with a fair share of known gotchas
-(see GitHub wiki for more info).
+(see GitHub wiki for more info). Some of those gothas can be removed by calling
+
+```ruby
+FmRest::StringDateAwareness.enable
+```
+
+Which will extend the core `Date` and `DateTime` classes to be aware of
+`FmRest::StringDate`, especially when calling `Date.===`, `Date.parse` or
+`Date._parse`.
+
+If you're working with ActiveRecord models this will also make them accept
+`FmRest::StringDate` values for date fields.
+
+### Timezones
+
+fmrest-ruby has basic timezone support. You can set the `:timezone` option in
+your connection settings to one of the following values:
+
+* `:local` - dates will be converted to your system local time offset (as
+  defined by `ENV["TZ"]`), or the timezone set by `Time.zone` if you're using
+  ActiveSupport
+* `:utc` - dates will be converted to UTC offset
+* `nil` - (default) ignore timezones altogether
 
 
 ## Spyke support (ActiveRecord-like ORM)
@@ -322,17 +345,6 @@ class Honeybee < FmRest::Spyke::Base
 end
 ```
 
-In this case you can pass the [`fmrest_config`](#modelfmrest_config) hash as an
-argument to `Base()`:
-
-```ruby
-class Honeybee < FmRest::Spyke::Base(host: "...", database: "...", username: "...", password: "...")
-end
-
-Honeybee.fmrest_config
-# => { host: "...", database: "...", username: "...", password: "..." }
-```
-
 All of Spyke's basic ORM operations work:
 
 ```ruby

data/lib/fmrest/spyke/base.rb

@@ -8,6 +8,8 @@ module FmRest
 
     class << self
       def Base(config = nil)
+        warn "[DEPRECATION] Inheriting from `FmRest::Spyke::Base(config)` is deprecated and will be removed, inherit from `FmRest::Spyke::Base` (without arguments) and use `fmrest_config=` instead"
+
         if config
           return Class.new(::FmRest::Spyke::Base) do
                    self.fmrest_config = config

data/lib/fmrest/spyke/model/connection.rb

@@ -4,10 +4,19 @@ module FmRest
   module Spyke
     module Model
       module Connection
-        extend ::ActiveSupport::Concern
+        extend ActiveSupport::Concern
 
         included do
-          class_attribute :fmrest_config, instance_accessor: false, instance_predicate: false
+          class_attribute :fmrest_config, instance_writer: false, instance_predicate: false
+
+          # Overrides the fmrest_config reader created by class_attribute so we
+          # can default set the default at call time.
+          #
+          # This method gets overwriten in subclasses if self.fmrest_config= is
+          # called.
+          define_singleton_method(:fmrest_config) do
+            FmRest.default_connection_settings
+          end
 
           class_attribute :faraday_block, instance_accessor: false, instance_predicate: false
           class << self; private :faraday_block, :faraday_block=; end
@@ -40,7 +49,7 @@ module FmRest
           def fmrest_connection
             @fmrest_connection ||=
               begin
-                config = fmrest_config || FmRest.default_connection_settings
+                config = fmrest_config
 
                 FmRest::V1.build_connection(config) do |conn|
                   faraday_block.call(conn) if faraday_block

data/lib/fmrest/spyke/model/serialization.rb

@@ -4,8 +4,8 @@ module FmRest
   module Spyke
     module Model
       module Serialization
-        FM_DATE_FORMAT = "%m/%d/%Y".freeze
-        FM_DATETIME_FORMAT = "#{FM_DATE_FORMAT} %H:%M:%S".freeze
+        FM_DATE_FORMAT = "%m/%d/%Y"
+        FM_DATETIME_FORMAT = "#{FM_DATE_FORMAT} %H:%M:%S"
 
         # Override Spyke's to_params to return FM Data API's expected JSON
         # format, and including only modified fields
@@ -63,9 +63,9 @@ module FmRest
         def serialize_values!(params)
           params.transform_values! do |value|
             case value
-            when DateTime, Time
-              value.strftime(FM_DATETIME_FORMAT)
-            when Date
+            when DateTime, Time, FmRest::StringDateTime
+              convert_datetime_timezone(value.to_datetime).strftime(FM_DATETIME_FORMAT)
+            when Date, FmRest::StringDate
               value.strftime(FM_DATE_FORMAT)
             else
               value
@@ -74,6 +74,17 @@ module FmRest
 
           params
         end
+
+        def convert_datetime_timezone(dt)
+          case fmrest_config.fetch(:timezone, nil)
+          when :utc, "utc"
+            dt.new_offset(0)
+          when :local, "local"
+            dt.new_offset(FmRest::V1.local_offset_for_datetime(dt))
+          when nil
+            dt
+          end
+        end
       end
     end
   end

data/lib/fmrest/string_date.rb

@@ -79,17 +79,24 @@ module FmRest
     class InvalidDate < ArgumentError; end
 
     class << self
-      alias_method :strptime, :new
+      def strptime(str, date_format, *_)
+        begin
+          date = self::DELEGATE_CLASS.strptime(str, date_format)
+        rescue ArgumentError
+          raise InvalidDate
+        end
+
+        new(str, date)
+      end
     end
 
-    def initialize(str, date_format, **str_args)
+    def initialize(str, date, **str_args)
+      raise ArgumentError, "str must be of class String" unless str.is_a?(String)
+      raise ArgumentError, "date must be of class #{self.class::DELEGATE_CLASS.name}" unless date.is_a?(self.class::DELEGATE_CLASS)
+
       super(str, **str_args)
 
-      begin
-        @delegate = self.class::DELEGATE_CLASS.strptime(str, date_format)
-      rescue ArgumentError
-        raise InvalidDate
-      end
+      @delegate = date
 
       freeze
     end
@@ -178,4 +185,36 @@ module FmRest
       @delegate
     end
   end
+
+  module StringDateAwareness
+    def _parse(v, *_)
+      if v.is_a?(StringDateTime)
+        return { year: v.year, mon: v.month, mday: v.mday, hour: v.hour, min: v.min, sec: v.sec, sec_fraction: v.sec_fraction, offset: v.offset }
+      end
+      if v.is_a?(StringDate)
+        return { year: v.year, mon: v.month, mday: v.mday }
+      end
+      super
+    end
+
+    def parse(v, *_)
+      if v.is_a?(StringDate)
+        return self == ::DateTime ? v.to_datetime : v.to_date
+      end
+      super
+    end
+
+    # Overriding case equality method so that it returns true for
+    # `FmRest::StringDate` instances
+    #
+    # Calls superclass method
+    #
+    def ===(other)
+      super || other.is_a?(StringDate)
+    end
+
+    def self.enable(classes: [Date, DateTime])
+      classes.each { |klass| klass.singleton_class.prepend(self) }
+    end
+  end
 end

data/lib/fmrest/v1.rb

@@ -4,6 +4,7 @@ require "fmrest/v1/connection"
 require "fmrest/v1/paths"
 require "fmrest/v1/container_fields"
 require "fmrest/v1/utils"
+require "fmrest/v1/dates"
 
 module FmRest
   module V1
@@ -15,5 +16,6 @@ module FmRest
     extend Paths
     extend ContainerFields
     extend Utils
+    extend Dates
   end
 end

data/lib/fmrest/v1/dates.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module FmRest
+  module V1
+    module Dates
+      FM_DATETIME_FORMAT_MATCHER = /MM|mm|dd|HH|ss|yyyy/.freeze
+
+      FM_DATE_TO_STRPTIME_SUBSTITUTIONS = {
+        "MM"   => "%m",
+        "dd"   => "%d",
+        "yyyy" => "%Y",
+        "HH"   => "%H",
+        "mm"   => "%M",
+        "ss"   => "%S"
+      }.freeze
+
+      FM_DATE_TO_REGEXP_SUBSTITUTIONS = {
+        "MM"   => '(?:0[1-9]|1[012])',
+        "dd"   => '(?:0[1-9]|[12][0-9]|3[01])',
+        "yyyy" => '\d{4}',
+        "HH"   => '(?:[01]\d|2[0123])',
+        "mm"   => '[0-5]\d',
+        "ss"   => '[0-5]\d'
+      }.freeze
+
+      def self.extended(mod)
+        mod.instance_eval do
+          @date_strptime = {}
+          @date_regexp = {}
+        end
+      end
+
+      # Converts a FM date-time format to `DateTime.strptime` format
+      #
+      # @param fm_format [String] The FileMaker date-time format
+      # @return [String] The `DateTime.strpdate` equivalent of the given FM
+      #   date-time format
+      def fm_date_to_strptime_format(fm_format)
+        @date_strptime[fm_format] ||=
+          fm_format.gsub(FM_DATETIME_FORMAT_MATCHER, FM_DATE_TO_STRPTIME_SUBSTITUTIONS).freeze
+      end
+
+      # Converts a FM date-time format to a Regexp. This is mostly used a
+      # quicker way of checking whether a FM field is a date field than
+      # Date|DateTime.strptime
+      #
+      # @param fm_format [String] The FileMaker date-time format
+      # @return [Regexp] A reegular expression matching strings in the given FM
+      #   date-time format
+      def fm_date_to_regexp(fm_format)
+        @date_regexp[fm_format] ||= 
+          Regexp.new('\A' + fm_format.gsub(FM_DATETIME_FORMAT_MATCHER, FM_DATE_TO_REGEXP_SUBSTITUTIONS) + '\Z').freeze
+      end
+
+      # Takes a DateTime dt, and returns the correct local offset for that dt,
+      # daylight savings included, in fraction of a day.
+      #
+      # By default, if ActiveSupport's Time.zone is set it will be used instead
+      # of the system timezone.
+      #
+      # @param dt [DateTime] The DateTime to get the offset for
+      # @param zone [nil, String, TimeZone] The timezone to use to calculate
+      #   the offset (defaults to system timezone, or ActiveSupport's Time.zone
+      #   if set)
+      # @return [Rational] The offset in fraction of a day
+      def local_offset_for_datetime(dt, zone = nil)
+        dt = dt.new_offset(0)
+        time = ::Time.utc(dt.year, dt.month, dt.day, dt.hour, dt.min, dt.sec)
+
+        # Do we have ActiveSupport's TimeZone?
+        time = if time.respond_to?(:in_time_zone)
+                 time.in_time_zone(zone || ::Time.zone)
+               else
+                 time.localtime
+               end
+
+        Rational(time.utc_offset, 86400) # seconds in one day (24*60*60)
+      end
+    end
+  end
+end

data/lib/fmrest/v1/type_coercer.rb

@@ -5,7 +5,8 @@ require "fmrest/string_date"
 module FmRest
   module V1
     class TypeCoercer < Faraday::Response::Middleware
-      # We use this date to represent a time for consistency with ginjo-rfm
+      # We use this date to represent a FileMaker time for consistency with
+      # ginjo-rfm
       JULIAN_ZERO_DAY = "-4712/1/1"
 
       COERCE_HYBRID = [:hybrid, "hybrid", true].freeze
@@ -30,15 +31,13 @@ module FmRest
           field_data = record["fieldData"] || record[:fieldData]
           portal_data = record["portalData"] || record[:portalData]
 
-          # Build an enumerator that iterates over hashes of fields
-          enum = Enumerator.new { |y| y << field_data }
-          if portal_data
-            portal_data.each_value do |portal_records|
-              enum += portal_records.to_enum
+          coerce_fields(field_data)
+
+          portal_data.try(:each_value) do |portal_records|
+            portal_records.each do |pr|
+              coerce_fields(pr)
             end
           end
-
-          enum.each { |hash| coerce_fields(hash) }
         end
       end
 
@@ -49,29 +48,49 @@ module FmRest
           next unless v.is_a?(String)
           next if k == "recordId" || k == :recordId || k == "modId" || k == :modId
 
-          begin
-            str_timestamp = datetime_class.strptime(v, datetime_format)
-            hash[k] = str_timestamp
-            next
-          rescue ArgumentError
+          if quick_check_timestamp(v)
+            begin
+              hash[k] = coerce_timestamp(v)
+              next
+            rescue ArgumentError
+            end
           end
 
-          begin
-            str_date = date_class.strptime(v, date_format)
-            hash[k] = str_date
-            next
-          rescue ArgumentError
+          if quick_check_date(v)
+            begin
+              hash[k] = date_class.strptime(v, date_strptime_format)
+              next
+            rescue ArgumentError
+            end
           end
 
-          begin
-            str_time = datetime_class.strptime("#{JULIAN_ZERO_DAY} #{v}", time_format)
-            hash[k] = str_time
-            next
-          rescue ArgumentError
+          if quick_check_time(v)
+            begin
+              hash[k] = datetime_class.strptime("#{JULIAN_ZERO_DAY} #{v}", time_strptime_format)
+              next
+            rescue ArgumentError
+            end
           end
         end
       end
 
+      def coerce_timestamp(str)
+        str_timestamp = DateTime.strptime(str, datetime_strptime_format)
+
+        if local_timezone?
+          # Change the DateTime to the local timezone, keeping the same
+          # time and just modifying the timezone
+          offset = FmRest::V1.local_offset_for_datetime(str_timestamp)
+          str_timestamp = str_timestamp.new_offset(offset) - offset
+        end
+
+        if datetime_class == StringDateTime
+          str_timestamp = StringDateTime.new(str, str_timestamp)
+        end
+
+        str_timestamp
+      end
+
       def date_class
         @date_class ||=
           case coerce_dates
@@ -92,19 +111,75 @@ module FmRest
           end
       end
 
-      def date_format
-        @date_format ||=
-          FmRest::V1.convert_date_time_format(@options[:date_format] || DEFAULT_DATE_FORMAT)
+      def date_fm_format
+        @options[:date_format] || DEFAULT_DATE_FORMAT
+      end
+
+      def timestamp_fm_format
+        @options[:timestamp_format] || DEFAULT_TIMESTAMP_FORMAT
+      end
+
+      def time_fm_format
+        @options[:time_format] || DEFAULT_TIME_FORMAT
       end
 
-      def datetime_format
-        @datetime_format ||=
-          FmRest::V1.convert_date_time_format(@options[:timestamp_format] || DEFAULT_TIMESTAMP_FORMAT)
+      def date_strptime_format
+        FmRest::V1.fm_date_to_strptime_format(date_fm_format)
+      end
+
+      def datetime_strptime_format
+        FmRest::V1.fm_date_to_strptime_format(timestamp_fm_format)
+      end
+
+      def time_strptime_format
+        @time_strptime_format ||=
+          "%Y/%m/%d " + FmRest::V1.fm_date_to_strptime_format(time_fm_format)
+      end
+
+      # We use a string length test, followed by regexp match test to try to
+      # identify date fields. Benchmarking shows this should be between 1 and 3
+      # orders of magnitude faster for fails (i.e. non-dates) than just using
+      # Date.strptime.
+      #
+      #                       user     system      total        real
+      # strptime:         0.268496   0.000962   0.269458 (  0.270865)
+      # re=~:             0.024872   0.000070   0.024942 (  0.025057)
+      # re.match?:        0.019745   0.000095   0.019840 (  0.020058)
+      # strptime fail:    0.141309   0.000354   0.141663 (  0.142266)
+      # re=~ fail:        0.031637   0.000095   0.031732 (  0.031872)
+      # re.match? fail:   0.011249   0.000056   0.011305 (  0.011375)
+      # length fail:      0.007177   0.000024   0.007201 (  0.007222)
+      #
+      # NOTE: The faster Regexp#match? was introduced in Ruby 2.4.0, so we
+      # can't really rely on it being available
+      if //.respond_to?(:match?)
+        def quick_check_timestamp(v)
+          v.length == timestamp_fm_format.length && FmRest::V1::fm_date_to_regexp(timestamp_fm_format).match?(v)
+        end
+
+        def quick_check_date(v)
+          v.length == date_fm_format.length && FmRest::V1::fm_date_to_regexp(date_fm_format).match?(v)
+        end
+
+        def quick_check_time(v)
+          v.length == time_fm_format.length && FmRest::V1::fm_date_to_regexp(time_fm_format).match?(v)
+        end
+      else
+        def quick_check_timestamp(v)
+          v.length == timestamp_fm_format.length && FmRest::V1::fm_date_to_regexp(timestamp_fm_format) =~ v
+        end
+
+        def quick_check_date(v)
+          v.length == date_fm_format.length && FmRest::V1::fm_date_to_regexp(date_fm_format) =~ v
+        end
+
+        def quick_check_time(v)
+          v.length == time_fm_format.length && FmRest::V1::fm_date_to_regexp(time_fm_format) =~ v
+        end
       end
 
-      def time_format
-        @time_format ||=
-          "%Y/%m/%d " + FmRest::V1.convert_date_time_format(@options[:time_format] || DEFAULT_TIME_FORMAT)
+      def local_timezone?
+        @local_timezone ||= @options.fetch(:timezone, nil).try(:to_sym) == :local
       end
 
       def coerce_dates

data/lib/fmrest/v1/utils.rb

@@ -5,17 +5,6 @@ module FmRest
     module Utils
       VALID_SCRIPT_KEYS = [:prerequest, :presort, :after].freeze
 
-      FM_DATETIME_FORMAT_MATCHER = /MM|mm|dd|HH|ss|yyyy/.freeze
-
-      FM_DATETIME_FORMAT_SUBSTITUTIONS = {
-        "MM"   => "%m",
-        "dd"   => "%d",
-        "yyyy" => "%Y",
-        "HH"   => "%H",
-        "mm"   => "%M",
-        "ss"   => "%S"
-      }.freeze
-
       # Converts custom script options to a hash with the Data API's expected
       # JSON script format.
       #
@@ -83,11 +72,6 @@ module FmRest
         params
       end
 
-      # Converts a FM date-time format to `Date.strptime` format
-      #
-      def convert_date_time_format(fm_format)
-        fm_format.gsub(FM_DATETIME_FORMAT_MATCHER, FM_DATETIME_FORMAT_SUBSTITUTIONS)
-      end
 
       private
 

data/lib/fmrest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FmRest
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -266,6 +266,7 @@ files:
 - lib/fmrest/v1.rb
 - lib/fmrest/v1/connection.rb
 - lib/fmrest/v1/container_fields.rb
+- lib/fmrest/v1/dates.rb
 - lib/fmrest/v1/paths.rb
 - lib/fmrest/v1/raise_errors.rb
 - lib/fmrest/v1/token_session.rb