fmrest 0.9.0 → 0.12.0

data/lib/fmrest/v1/type_coercer.rb

@@ -5,17 +5,18 @@ 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
       COERCE_FULL = [:full, "full"].freeze
 
       # @param app [#call]
-      # @param options [Hash]
-      def initialize(app, options = FmRest.default_connection_settings)
+      # @param settings [FmRest::ConnectionSettings]
+      def initialize(app, settings)
         super(app)
-        @options = options
+        @settings = settings
       end
 
       def on_complete(env)
@@ -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,23 +111,79 @@ 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
+        @settings.date_format
+      end
+
+      def timestamp_fm_format
+        @settings.timestamp_format
+      end
+
+      def time_fm_format
+        @settings.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 ||= @settings.timezone.try(:to_sym) == :local
       end
 
       def coerce_dates
-        @options.fetch(:coerce_dates, false)
+        @settings.coerce_dates
       end
 
       alias_method :enabled?, :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,12 +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
 
       def convert_script_arguments(script_arguments, suffix = nil)

data/lib/fmrest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Pedro Carbajal
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -54,30 +54,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,14 +98,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -152,16 +152,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
@@ -235,8 +235,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING
 - fmrest.gemspec
 - lib/fmrest.rb
+- lib/fmrest/connection_settings.rb
 - lib/fmrest/errors.rb
 - lib/fmrest/spyke.rb
 - lib/fmrest/spyke/base.rb
@@ -250,6 +252,7 @@ files:
 - lib/fmrest/spyke/model/global_fields.rb
 - lib/fmrest/spyke/model/http.rb
 - lib/fmrest/spyke/model/orm.rb
+- lib/fmrest/spyke/model/record_id.rb
 - lib/fmrest/spyke/model/serialization.rb
 - lib/fmrest/spyke/model/uri.rb
 - lib/fmrest/spyke/portal.rb
@@ -262,10 +265,13 @@ files:
 - lib/fmrest/token_store/base.rb
 - lib/fmrest/token_store/memory.rb
 - lib/fmrest/token_store/moneta.rb
+- lib/fmrest/token_store/null.rb
 - lib/fmrest/token_store/redis.rb
 - lib/fmrest/v1.rb
+- lib/fmrest/v1/auth.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
@@ -278,7 +284,22 @@ homepage: https://github.com/beezwax/fmrest-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |+
+  =======================================
+   Notes on upgrading from fmrest < 0.12
+  =======================================
+
+  There's a small breaking change in fmrest 0.12 that will most likely not affect
+  you, but you may want to be aware of:
+
+  Previous to this version the record ID on an FmRest::Spyke::Base instance could
+  be set with `id=`. This caused problems in cases where a FileMaker layout had a
+  field named `id`, so `id=` got renamed to `__record_id=`. Setting the record ID
+  by hand however isn't something useful or that should be done at all, so it's
+  very unlikely that this change will affect your existing code at all.
+
+  Thanks for using fmrest-ruby!
+
 rdoc_options: []
 require_paths:
 - lib
@@ -294,7 +315,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: FileMaker Data API client using Faraday
 test_files: []
+...