fmrest-spyke 0.17.1 → 0.18.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19e4983cff9d5959b2e9263687daaf18d779fcf6d284cbb6ec8844c1623beabf
-  data.tar.gz: 0e558a94cf0b26f5ffe1258f33385f0e016a73ae55aa200ea6768160c746ebd1
+  metadata.gz: 38cc05be48b9ba5737e7a2c1d89504bab617a2f1d6d7261fde1b5a919aa793e7
+  data.tar.gz: 0b1780c8ce2f7d8d8f4c300909b2bafb7f41e18e2ce648f929be9e2d3569ddbe
 SHA512:
-  metadata.gz: 1af0c0918fe48374fd2dbe5f20bbeb8f0f7e9f73537233f9b530ea53ec37c3ceffba5612c244ce0c9553c66a2090dcd1d8330581940f6713660cbc6b1a362dd0
-  data.tar.gz: 75abe05bdbfec9e21d0bc3e6dcc5c10d3bbdb66213382c494e3b7511f4c00c628b5ad054ca81e486c4c614a3c9832f60787000a5d990399488ce7027c59a45e1
+  metadata.gz: 123d5611c9c862605c30643b8034665c67c24fc283d21311f6124baff2271c459bcae0d4834f2480f4aa2e521105a6df58ecb011f46fc4f50a656df4a91108f5
+  data.tar.gz: 91a6d0bdf49792a76b0bf817543a89e7b92bcf0c55eaa128d9bee3219f250e47a14bd064f862383f11f66dac70f1830cc6f1017b56d912f4d8be344e7ac86bed

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Changelog
 
+### 0.18.0
+
+* Better support for portals with mismatching field qualifiers
+* Defining an attribute on a model that would collide with an existing method
+  now raises an error
+
 ### 0.17.1
 
 * Fixed crash when `fmid_token` is set but `username` isn't

data/README.md

@@ -543,6 +543,10 @@ class LoggyBee < FmRest::Layout
 end
 ```
 
+## Gotchas
+
+Read about unexpected scenarios in the [gotchas doc](docs/Gotchas.md).
+
 ## API implementation completeness table
 
 FM Data API reference: https://fmhelp.filemaker.com/docs/18/en/dataapi/

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "fmrest/spyke/portal_builder"
 require "fmrest/spyke/portal"
 
 module FmRest
@@ -13,6 +14,8 @@ module FmRest
         included do
           # Keep track of portal options by their FM keys as we could need it
           # to parse the portalData JSON in SpykeFormatter
+          #
+          # TODO: Replace this with options in PortalBuilder
           class_attribute :portal_options, instance_accessor: false, instance_predicate: false
 
           # class_attribute supports a :default option since ActiveSupport 5.2,
@@ -40,11 +43,13 @@ module FmRest
           #   end
           #
           def has_portal(name, options = {})
-            create_association(name, Portal, options)
+            # This is analogous to Spyke's create_association method, but using
+            # our custom builder instead
+            self.associations = associations.merge(name => PortalBuilder.new(self, name, Portal, options))
 
             # Store options for SpykeFormatter to use if needed
             portal_key = options[:portal_key] || name
-            self.portal_options = portal_options.merge(portal_key.to_s => options.dup.merge(name: name.to_s)).freeze
+            self.portal_options = portal_options.merge(portal_key.to_s => options.dup.merge(name: name.to_s).freeze).freeze
 
             define_method "#{name.to_s.singularize}_ids" do
               association(name).map(&:id)

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

@@ -94,11 +94,17 @@ module FmRest
           end
 
           def _fmrest_define_attribute(from, to)
+            if existing_method = ((method_defined?(from) || private_method_defined?(from)) && from) ||
+                                 ((method_defined?("#{from}=") || private_method_defined?("#{from}=")) && "#{from}=")
+
+              raise ArgumentError, "You tried to define an attribute named `#{from}' on `#{name}', but this will generate a instance method `#{existing_method}', which is already defined by FmRest::Layout."
+            end
+
             # We use a setter here instead of injecting the hash key/value pair
             # directly with #[]= so that we don't change the mapped_attributes
             # hash on the parent class. The resulting hash is frozen for the
             # same reason.
-            self.mapped_attributes = mapped_attributes.merge(from => to).freeze
+            self.mapped_attributes = mapped_attributes.merge(from => to.to_s).freeze
 
             _fmrest_attribute_methods_container.module_eval do
               define_method(from) do

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

@@ -6,8 +6,6 @@ module FmRest
       module GlobalFields
         extend ::ActiveSupport::Concern
 
-        FULLY_QUALIFIED_FIELD_NAME_MATCHER = /\A[^:]+::[^:]+\Z/.freeze
-
         class_methods do
           def set_globals(values_hash)
             connection.patch(FmRest::V1.globals_path, {
@@ -26,7 +24,7 @@ module FmRest
                 next
               end
 
-              unless FULLY_QUALIFIED_FIELD_NAME_MATCHER === k.to_s
+              unless V1.is_fully_qualified?(k.to_s)
                 raise ArgumentError, "global fields must be given in fully qualified format (table name::field name)"
               end
 

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

@@ -26,7 +26,7 @@ module FmRest
         def serialize_for_portal(portal)
           params =
             changed_params.except(:__record_id).transform_keys do |key|
-              "#{portal.attribute_prefix}::#{key}"
+              V1.is_fully_qualified?(key) ? key : "#{portal.attribute_prefix}::#{key}"
             end
 
           params[:recordId] = __record_id.to_s if __record_id

data/lib/fmrest/spyke/portal_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FmRest
+  module Spyke
+    class PortalBuilder < ::Spyke::Associations::Builder
+      attr_reader :options
+
+      def klass
+        begin
+          super
+        rescue NameError => e
+          ::FmRest::Layout
+        end
+      end
+    end
+  end
+end

data/lib/fmrest/spyke/spyke_formatter.rb

@@ -195,8 +195,8 @@ module FmRest
         out
       end
 
-      # Extracts `recordId` and strips the `"PortalName::"` field prefix for each
-      # portal
+      # Extracts `recordId` and strips the `"tableName::"` field qualifier for
+      # each portal
       #
       # Sample `json_portal_data`:
       #
@@ -210,19 +210,33 @@ module FmRest
       # @return [Hash] the portal data in Spyke format
       def prepare_portal_data(json_portal_data)
         json_portal_data.each_with_object({}) do |(portal_name, portal_records), out|
+
           portal_options = @model.portal_options[portal_name.to_s] || {}
+          portal_builder = @model.associations[portal_options[:name].to_sym]
+          portal_class = portal_builder && portal_builder.klass
+          portal_attributes = (portal_class && portal_class.mapped_attributes.values) || []
 
           out[portal_name] =
             portal_records.map do |portal_fields|
               attributes = { __record_id: portal_fields[:recordId] }
               attributes[:__mod_id] = portal_fields[:modId] if portal_fields[:modId]
 
-              prefix = portal_options[:attribute_prefix] || portal_name
-              prefix_matcher = /\A#{prefix}::/
+              qualifier = portal_options[:attribute_prefix] || portal_name
+              qualifier_matcher = /\A#{qualifier}::/
 
               portal_fields.each do |k, v|
                 next if :recordId == k || :modId == k
-                attributes[k.to_s.gsub(prefix_matcher, "").to_sym] = v
+
+                stripped_field_name = k.to_s.gsub(qualifier_matcher, "")
+
+                # Only use the non-qualified attribute name if it was defined
+                # that way on the portal model, otherwise default to the fully
+                # qualified name
+                if portal_attributes.include?(stripped_field_name)
+                  attributes[stripped_field_name.to_sym] = v
+                else
+                  attributes[k.to_sym] = v
+                end
               end
 
               attributes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-spyke
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0.rc1
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fmrest-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.0.rc1
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +68,7 @@ files:
 - lib/fmrest/spyke/model/serialization.rb
 - lib/fmrest/spyke/model/uri.rb
 - lib/fmrest/spyke/portal.rb
+- lib/fmrest/spyke/portal_builder.rb
 - lib/fmrest/spyke/relation.rb
 - lib/fmrest/spyke/spyke_formatter.rb
 - lib/fmrest/spyke/validation_error.rb
@@ -86,9 +87,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.3
 signing_key: