ecoportal-api-v2 0.9.6 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9502632e0f39a86587a093fb54bcadcd42b7a3db38ed98d5ec35ea5a56a9b257
-  data.tar.gz: 393ff91c773c047ffa031350a88af80f395847f326ec4b13011f33dc2477c6b5
+  metadata.gz: d8f33b34cbba08724022856ecf54859aa40fed40bbeb2d06972edb97a0f5a171
+  data.tar.gz: bb53bb8e3e882b93aed2bb6f6a6f43df1c9405e5b4a6ac18b86d99ab52b28be8
 SHA512:
-  metadata.gz: c7733b21b7d7dec324c7561cb495e83ffc39f6e567eb5332613590ca914f611ec8361d6a356506f4f6eb846f0cbc5f7361e6235e9c1eb0b992ef7010dff0d093
-  data.tar.gz: 80d8a90e09c22ddd80854fa4d38ab6b7b6c0d533db3f694059818f20573c9a2f023888f3959fa8c67db8a37a6bbb9597a1d66fda0485e418c4197fcd1788d9e3
+  metadata.gz: 6bf8ffdc02fb8471a833e3451abd89bb09b573f6a711cbc99eec189d528bd7c90643a0a33d86ae89c08fa449c65c3bdf0a1c1353b33afe049ffa62a3dac5a6ac
+  data.tar.gz: 8444d1a3c41222e186aeffbf15158b8048187508a66d225413aab38d1a07f61a0a14508d1259eed7b131c2806cdac537814b057a017b3aad8d21514a515244c1

data/CHANGELOG.md

@@ -1,10 +1,33 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.9.7] - 2022-11-xx
+## [1.0.1] - 2023-02-xx
 
 ### Added
 ### Changed
+### Fixed
+
+## [1.0.1] - 2023-02-24
+
+### Added
+  - Allowed `read_only` mode to support `emdeds_many` with item class without `method_key`
+    - `Ecoportal::API::Common::Content::DoubleModel`
+    - `Ecoportal::API::Common::Content::CollectionModel`
+    - `Ecoportal::API::Common::Content::ArrayModel`
+
+### Changed
+  - It is a risky change (so treated as a **braking change**)
+
+## [0.9.7] - 2022-11-29
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::ReferenceField` added methods `#delete` and `#clear`
+
+### Changed
+  - `Ecoportal::API::V2::Page::Component::ReferenceField#add`
+    - be able to add multiple references
+    - prevent double-ups, just in case the server doesn't handle this
+
 ### Fixed
   - `Ecoportal::API::V2::Page::Component#bindings`
 

data/lib/ecoportal/api/common/content/array_model.rb

@@ -34,8 +34,8 @@ module Ecoportal
 
           inheritable_class_vars :order_matteres, :uniq
 
-          def initialize(doc = [], parent: self, key: nil)
-            super(doc, parent: parent, key: key)
+          def initialize(doc = [], parent: self, key: nil, read_only: false)
+            super(doc, parent: parent, key: key, read_only: read_only)
           end
 
           def order_matters?; self.class.order_matters; end

data/lib/ecoportal/api/common/content/collection_model.rb

@@ -52,7 +52,7 @@ module Ecoportal
             # @yieldparam doc [Hash]
             # @yieldreturn [Klass] instance object of the target `klass`
             # @return [Klass] instance object of the target `klass`
-            def new_item(doc = NOT_USED, parent: nil, key: nil, &block)
+            def new_item(doc = NOT_USED, parent: nil, key: nil, read_only: false, &block)
               if block
                 @new_item = block
               elsif used_param?(doc)
@@ -61,7 +61,7 @@ module Ecoportal
                   @new_item.call(doc, parent, key)
                 else
                   if target_class = self.klass(doc)
-                    doc.is_a?(target_class) ? doc : target_class.new(doc, parent: parent, key: key)
+                    doc.is_a?(target_class) ? doc : target_class.new(doc, parent: parent, key: key, read_only: read_only)
                   else
                     raise "Could not find a class for: #{doc}"
                   end
@@ -88,7 +88,7 @@ module Ecoportal
 
           inheritable_class_vars :klass, :order_matters, :order_key, :items_key, :new_item
 
-          def initialize(ini_doc = [], parent: self, key: nil)
+          def initialize(ini_doc = [], parent: self, key: nil, read_only: false)
             unless self.class.klass?
               raise "Undefined base 'klass' or 'new_item' callback for #{self.class}"
             end
@@ -102,7 +102,7 @@ module Ecoportal
                         []
                       end
 
-            super(ini_doc, parent: parent, key: key)
+            super(ini_doc, parent: parent, key: key, read_only: read_only)
           end
 
           # @return [Class] the class of the elements of the Collection
@@ -175,7 +175,7 @@ module Ecoportal
           # @return [Object] the `items_class` element object
           def upsert!(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel)
-              raise "'Content::DoubleModel' or 'Hash' doc required"
+              raise "'Content::DoubleModel' or 'Hash' doc required. Given #{value.class}"
             end
             item_doc = value.is_a?(Content::DoubleModel)? value.doc : value
             item_doc = JSON.parse(item_doc.to_json)
@@ -256,7 +256,7 @@ module Ecoportal
           private
 
           def new_item(value)
-            self.class.new_item(value, parent: self)
+            self.class.new_item(value, parent: self, read_only: self._read_only)
           end
 
           # Helper to remove tracked down instance variables

data/lib/ecoportal/api/common/content/double_model.rb

@@ -18,6 +18,9 @@ module Ecoportal
             end
           end
 
+          class NoKeyMethod < StandardError
+          end
+
           class << self
             attr_reader :key
 
@@ -171,7 +174,7 @@ module Ecoportal
 
                 define_method method do
                   return instance_variable_get(var) if instance_variable_defined?(var)
-                  new_obj = dim_class.new(parent: self, key: method)
+                  new_obj = dim_class.new(parent: self, key: method, read_only: self._read_only)
                   variable_set(var, new_obj)
                 end
               end
@@ -194,7 +197,10 @@ module Ecoportal
             # @param order_matters [Boolean] to state if the order will matter
             # @param klass [Class, String] the class of the individual elements it embeds
             # @param enum_class [Class, String] the class of the collection that will hold the individual elements
-            def embeds_many(method, key: method, order_matters: false, order_key: nil, klass: nil, enum_class: nil)
+            # @param read_only [Boolean] whether or not should try to **work around** items `klass` missing a `key`
+            #   - If set to `true` this is meant only for read purposes (won't be able to successufully insert)
+            def embeds_many(method, key: method, klass: nil, enum_class: nil,
+              order_matters: false, order_key: nil, read_only: false)
               if enum_class
                 eclass = enum_class
               elsif klass
@@ -206,7 +212,7 @@ module Ecoportal
               else
                 raise "You should either specify the 'klass' of the elements or the 'enum_class'"
               end
-              embed(method, key: key, multiple: true, klass: eclass) do |instance_with_called_method|
+              embed(method, key: key, multiple: true, klass: eclass, read_only: read_only) do |instance_with_called_method|
                 # keep reference to the original class to resolve the `klass` dependency
                 # See stackoverflow: https://stackoverflow.com/a/73709529/4352306
                 referrer_class = instance_with_called_method.class
@@ -216,7 +222,7 @@ module Ecoportal
 
             private
 
-            def embed(method, key: method, nullable: false, multiple: false, klass:, &block)
+            def embed(method, key: method, nullable: false, multiple: false, klass:, read_only: false, &block)
               method = method.to_s.freeze
               var    = instance_variable_name(method).freeze
               k      = key.to_s.freeze
@@ -230,9 +236,22 @@ module Ecoportal
                 end
                 return variable_set(var, nil) unless doc[k]
 
-                self.class.resolve_class(klass).new(
-                  doc[k], parent: self, key: k
-                ).tap {|obj| variable_set(var, obj)}
+                embedded_class = self.class.resolve_class(klass)
+
+                if multiple && read_only
+                  if doc[k].is_a?(Array) && embedded_class < Common::Content::CollectionModel
+                    if (item_class = embedded_class.klass) && !item_class.key?
+                      item_class.passkey :id
+                      doc[k].each_with_index do |item_doc, i|
+                        item_doc["id"] = "#{i}" unless item_doc.key?("id")
+                      end
+                    end
+                  end
+                end
+
+                embedded_class.new(doc[k], parent: self, key: k, read_only: self._read_only || read_only).tap do |obj|
+                  variable_set(var, obj)
+                end
               end
             end
 
@@ -244,16 +263,17 @@ module Ecoportal
 
           inheritable_class_vars :forced_model_keys, :key
 
-          attr_reader :_parent, :_key
+          attr_reader :_parent, :_key, :_read_only
 
-          def initialize(doc = {}, parent: self, key: nil)
-            @_dim_vars = []
-            @_parent   = parent || self
-            @_key      = key    || self
+          def initialize(doc = {}, parent: self, key: nil, read_only: false)
+            @_dim_vars  = []
+            @_parent    = parent || self
+            @_key       = key    || self
+            @_read_only = read_only
 
             self.class.enforce!(doc)
 
-            if _parent == self
+            if (_parent == self) || read_only
               @doc          = doc
               @original_doc = JSON.parse(@doc.to_json)
             end
@@ -271,13 +291,13 @@ module Ecoportal
 
           # @return [String] the `value` of the `key` method (i.e. `id` value)
           def key
-            raise "No key_method defined for #{self.class}" unless key_method?
+            raise NoKeyMethod.new "No key_method defined for #{self.class}" unless key_method?
             self.method(key_method).call
           end
 
           # @param [String] the `value` of the `key` method (i.e. `id` value)
           def key=(value)
-            raise "No key_method defined for #{self.class}" unless key_method?
+            raise NoKeyMethod.new "No key_method defined for #{self.class}" unless key_method?
             method = "#{key_method}="
             self.method(method).call(value)
           end
@@ -296,6 +316,7 @@ module Ecoportal
 
           # @return [nil, Hash] the underlying `Hash` model as is (carrying current changes)
           def doc
+            return @doc if doc_var?
             raise UnlinkedModel.new(from: "#{self.class}#doc", key: _key) unless linked?
             if is_root?
               @doc
@@ -378,8 +399,12 @@ module Ecoportal
 
           protected
 
+          def doc_var?
+            !!defined?(@doc)
+          end
+
           def is_root?
-            _parent == self && !!defined?(@doc)
+            _parent == self && doc_var?
           end
 
           def linked?

data/lib/ecoportal/api/v2/page/component/reference_field.rb

@@ -13,19 +13,36 @@ module Ecoportal
             def empty?
               reference_ids.empty?
             end
-            
+
             def reference_ids
               references.map do |ref|
                 ref["id"]
               end
             end
 
-            def add(ref_id)
-              doc["references"].push({
-                "id" => ref_id,
-                "weight" => 0,
-                "patch_ver" => 0
-              })
+            def add(*ref_ids)
+              doc["references"].tap do |refs|
+                ref_ids.each do |ref_id|
+                  next if reference_ids.include?(ref_id)
+                  refs.push({
+                    "id" => ref_id,
+                    "weight" => 0,
+                    "patch_ver" => 0
+                  })
+                end
+              end
+            end
+
+            def clear
+              delete(*reference_ids)
+            end
+
+            def delete(*ref_ids)
+              ref_ids.each do |ref_id|
+                if doc_ref = doc["references"].find {|doc_ref| doc_ref["id"] == ref_id}
+                  doc["references"].delete(doc_ref)
+                end
+              end
             end
 
             def to_s(delimiter: "\n")

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.9.6"
+    GEM2_VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 1.0.1
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler