ecoportal-api-v2 0.8.9 → 0.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5833ea731a9d1360c346264d234ce9f95266db92a5480180a17f413459f196de
-  data.tar.gz: f3ef175580d2ab47c0ee7f51dc2731c0b42bd27ffa9f59600fb506d5cde38a4b
+  metadata.gz: 146b0998371f28683143b8a95ae1b68e11f8f079698502bede31c8e29369fc97
+  data.tar.gz: 4ce0f3dd75e4e1d822d4540fa0ff1e3e18a7c7dca1c54d7030bdb475adc21a93
 SHA512:
-  metadata.gz: 52064ec37a32470e699f846ac1c6c57f8f535fb0be1d689a4f086836a47f9fb2805c0f84533842f5aaa4ee9e538c60e61c1569177ae16a015520c65248347174
-  data.tar.gz: 0f8cd291558cad37b5157dba7ffdea6670548952b6aa5b0c90b34820abd2693d8f484009265bbc4c8c83fb46684f2968e9a40d4a65563e0ffc6704cca30885d0
+  metadata.gz: 21605169ab88cb159ee32a2f6f36e3100b183a03a7f9c895b33631934811bb9e3f16c6bc6101ddfac562854f8762f545a743b68c55d662c97be54ff35fc5b9e8
+  data.tar.gz: d2a66296e4b9194667983ba5c37c646fd6a12e037138870aa2771c743fc75dbf9b2ee91d07af7b1e4b501ad1afd846b427a8b92f5dc99ee4551200cc742dcd20

data/CHANGELOG.md

@@ -1,7 +1,69 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.9] - 2021-06-xx
+## [0.8.13] - 2021-08-xx
+
+### Added
+### Changed
+### Fixed
+  - `Ecoportal::API::V2::Stage::Sections`
+    - `weight` fixing should only happen on entire page, **not** on stage sections that could change the order of section shared with other stages
+    - `#scope_weight` was not excluding the section when using `weight` of the last one
+  - Several classes with `embeds_many` were performing the `ordering` of those elements in the wrong way
+  - `Ecoportall::API::Common::Content::DoubleModel`
+    - `#replace_original_doc` had a couple of typos
+    - `#replace_doc` should only remove the variable referring to the current object and only if `new_doc` is `nil`
+  - `Ecoportal::API::Common::Content::CollectionModel` on insertion and deletion it was removing instance variable objects.
+    - There was no need for this approach, as the only necessary thing is to just keep those variable instances up to date in the correct unique access point to do so.
+    - Aside note: the reason why this was initially designed this way is because there were some difficulties to identify the existing elements in the subjacent model. Once `#passkey` as added, this difficulty could be overcome.
+  - `Ecoportal::API::Common::Content::ArrayModel` on initialize, default `doc` should be an `Array`
+
+## [0.8.12] - 2021-08-30
+
+### Added
+  - `Ecoportal::API::V2::Pages::PageStage#current_stage`
+
+### Fixed
+  - `Ecoportal::API::Common::Content::DocHelpers#get_body` typo and wrong parameters on call.
+  - `Ecoportal::API::V2::Pages#update` should always return `Result` object.
+  - `Ecoportal::API::V2::Registers#search` was not using `cursor_id` to iterate.
+
+## [0.8.11] - 2021-08-27
+
+### Added
+  - `Ecoportal::API::V2::Page#stages?`
+  - `Ecoportal::API::V2::Pages::PageStage#current_stage_id`
+  - `Ecoportal::API::V2::Registers#search` added option keyed parameter `:only_first`
+    - which will make the method return the first `Ecoportal::API::V2::Registers::SearchResults`
+    - This has been **added** with the aim of knowing how many results out of how many entries.
+
+### Changed
+  - `Ecoportal::API::V2::Pages::PageStage#update` won't update unless there's something to update.
+
+### Fixed
+
+
+## [0.8.10] - 2021-08-22
+
+### Added
+  - `Ecoportal::API::Common::Content::CollectionModel#[]` now supports position as well
+  - `Ecoportal::API::V2::Page::Component::FilesField#add_file`: support for adding files
+  - `Ecoportal::API::V2::Page::Component::PeopleField#viewable_fields`: support for managing `viewable_fields`
+
+### Changed
+
+### Fixed
+  - `Ecoportal::API::V2::Page::Component::FilesField`: was not requiring `File`
+  - `Ecoportal::API::V2::Page::Component::NumberField#value`: it was missing :/
+  - `Ecoportal::API::Common::Content::HashDiffPatch` did not support nested objects in Arrays, where the nested object wouldn't have a `patch_ver`. This **fix** allows for it
+    - `Ecoportal::API::Common::Content::DoubleModel.passforced` to define `methods` that should always be present. This allows to define `patch_ver` as a forced `key` in models that have it
+      - The enforcement (`self.class.enforce!`) happens on `initialize`
+      - `passenforced` subjacent model `forced_model_keys` is inheritable
+  - `Ecoportal::API::Common::Content::CollectionModel`:
+    - Method `upsert!` was not working fine the parameters `pos`, `before` and `after`
+    - Method `delete!` did not support position
+
+## [0.8.9] - 2021-08-16
 
 ### Added
   - `Ecoportal::API::Common::Content::ModelHelpers`

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

@@ -33,7 +33,7 @@ module Ecoportal
 
           end
 
-          def initialize(doc = {}, parent: self, key: nil)
+          def initialize(doc = [], parent: self, key: nil)
             super(doc, parent: parent, key: key)
           end
 

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

@@ -110,6 +110,9 @@ module Ecoportal
           end
 
           # Transforms `value` into the actual `key` to access the object in the doc `Array`
+          # @note
+          #   - The name of the method is after the paren't class method
+          #   - This method would have been better called `_doc_pos` :)
           def _doc_key(value)
             #print "*(#{value.class})"
             return super(value) unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel)
@@ -143,17 +146,21 @@ module Ecoportal
           end
 
           # Get an element usign the `key`.
+          # @param value [String, Hash, Ecoportal::API::Common::Content::DoubleModel]
+          # @return [Object] the `items_class` element object
           def [](value)
             items_by_key[get_key(value)]
           end
 
+          # @return [Array<Object>] the `items_class` element object
           def values_at(*keys)
             keys.map {|key| self[key]}
           end
 
           # Tries to find the element `value`, if it exists, it updates it
-          # Otherwise it pushes it to the end
-          # @return the element
+          #   Otherwise it pushes it to the end
+          # @value [Hash, Ecoportal::API::Common::Content::DoubleModel] the eleement to be added
+          # @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"
@@ -163,7 +170,10 @@ module Ecoportal
             if item = self[value]
               item.replace_doc(item_doc)
             else
-              _doc_upsert(item_doc, pos: pos, before: before, after: after)
+              _doc_upsert(item_doc, pos: pos, before: before, after: after).tap do |pos_idx|
+                _items.insert(pos_idx, new_item(item_doc))
+                @indexed = false
+              end
             end
             (item || self[item_doc]).tap do |item|
               yield(item) if block_given?
@@ -171,12 +181,18 @@ module Ecoportal
           end
 
           # Deletes `value` from this `CollectionModel` instance
+          # @param value [String, Hash, Ecoportal::API::Common::Content::DoubleModel]
+          #   - When used as `String`, the `key` value (i.e. `id` value) is expected
+          #   - When used as `Hash`, it should be the `doc` of the target element
+          #   - When used as `DoubleModel`, it should be the specific object to be deleted
           def delete!(value)
-            unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel)
+            unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel) || value.is_a?(String)
               raise "'Content::DoubleModel' or 'Hash' doc required"
             end
             if item = self[value]
               _doc_delete(item.doc)
+              @indexed = false
+              _items.delete(item)
             end
           end
 
@@ -187,7 +203,8 @@ module Ecoportal
           def items_key;      self.class.items_key;     end
 
           def on_change
-            variables_remove!
+            @indexed = false
+            #variables_remove!
           end
 
           # Gets the `key` of the object `value`
@@ -199,6 +216,8 @@ module Ecoportal
               value[items_key]
             when String
               value
+            when Numeric
+              get_key(self.to_a[value])
             end
           end
 
@@ -243,25 +262,16 @@ module Ecoportal
           # @return [Object] the element deleted from `doc`
           def _doc_delete(value)
             if current_pos = _doc_key(value)
-              _doc_items.delete_at(current_pos).tap do |deleted|
-                on_change
-              end
+              _doc_items.delete_at(current_pos)
             end
           end
 
           def _doc_upsert(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-            current_pos = _doc_key(value)
-            pos = case
-              when used_param?(pos)
-                pos
-              when used_param?(before)
-                _doc_key(before)
-              when used_param?(after)
-                if i = _doc_key(after)
-                  i + 1
-                end
-              end
+            current_pos = if elem = self[value]
+              _doc_key(elem)
+            end
 
+            pos   = scope_position(pos: pos, before: before, after: after)
             pos ||= current_pos
 
             if current_pos && pos
@@ -270,14 +280,29 @@ module Ecoportal
             end
 
             pos = (pos && pos < _doc_items.length)? pos : _doc_items.length
-
             pos.tap do |i|
               _doc_items.insert(pos, value)
-              on_change
             end
 
           end
 
+          def scope_position(pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+            case
+            when used_param?(pos)
+              if elem = self[pos]
+                _doc_key(elem) - 1
+              end
+            when used_param?(before)
+              if elem = self[before]
+                _doc_key(elem) - 1
+              end
+            when used_param?(after)
+              if elem = self[after]
+                _doc_key(elem)
+              end
+            end
+          end
+
         end
       end
     end

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

@@ -13,9 +13,9 @@ module Ecoportal
                 when doc.respond_to?(:as_update)
                   doc.as_update
                 when doc.respond_to?(:as_json)
-                  Common::Content::HashPatchDiff.patch_diff(doc.as_json)
+                  Common::Content::HashDiffPatch.patch_diff(doc.as_json, nil)
                 when doc.is_a?(Hash)
-                  Common::Content::HashPatchDiff.patch_diff(doc)
+                  Common::Content::HashDiffPatch.patch_diff(doc, nil)
                 else
                   raise "Could not get body for doc: #{doc}"
                 end

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

@@ -37,6 +37,8 @@ module Ecoportal
 
             # Same as `attr_reader` but links to a subjacent `Hash` model property
             # @note it does **not** create an _instance variable_
+            # @param methods [Array<Symbol>] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
             def pass_reader(*methods)
               methods.each do |method|
                 method = method.to_s.freeze
@@ -52,6 +54,8 @@ module Ecoportal
 
             # Same as `attr_writer` but links to a subjacent `Hash` model property
             # @note it does **not** create an _instance variable_
+            # @param methods [Array<Symbol>] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
             def pass_writer(*methods)
               methods.each do |method|
                 method = method.to_s.freeze
@@ -70,6 +74,8 @@ module Ecoportal
             #  no chance you can avoid invinite loop for `get_key` without setting an
             #  instance variable key at the moment of the object creation, when the
             #  `doc` is firstly received
+            # @param method [Symbol] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
             def passkey(method)
               method   = method.to_s.freeze
               var      = instance_variable_name(method)
@@ -91,7 +97,33 @@ module Ecoportal
               self
             end
 
+            # These are methods that should always be present in patch update
+            # @note
+            #    - `DoubleModel` can be used with objects that do not use `patch_ver`
+            #    - This ensures that does that do, will get the correct patch update model
+            # @param method [Symbol] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
+            # @param default [Value] the default value that
+            #   this `key` will be written in the model when it doesn't exixt
+            def passforced(method, default: , read_only: false)
+              model_forced_keys[method.to_s.freeze] = default
+              passthrough(method, read_only: read_only)
+            end
+
+            # Ensures `doc` has the `model_forced_keys`. If it doesn't, it adds those missing
+            #   with the defined `default` values
+            def enforce!(doc)
+              return unless doc && doc.is_a?(Hash)
+              return if model_forced_keys.empty?
+              model_forced_keys.each do |key, default|
+                doc[key] = default unless doc.key?(key)
+              end
+              doc
+            end
+
             # Same as `attr_accessor` but links to a subjacent `Hash` model property
+            # @param methods [Array<Symbol>] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
             # @param read_only [Boolean] should it only define the reader?
             def passthrough(*methods, read_only: false)
               pass_reader *methods
@@ -101,6 +133,8 @@ module Ecoportal
 
             # To link as a `Time` date to a subjacent `Hash` model property
             # @see Ecoportal::API::Common::Content::DoubleModel#passthrough
+            # @param methods [Array<Symbol>] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
             # @param read_only [Boolean] should it only define the reader?
             def passdate(*methods, read_only: false)
               pass_reader(*methods) {|value| to_time(value)}
@@ -111,6 +145,8 @@ module Ecoportal
             end
 
             # To link as a `Boolean` to a subjacent `Hash` model property
+            # @param methods [Array<Symbol>] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
             # @param read_only [Boolean] should it only define the reader?
             def passboolean(*methods, read_only: false)
               pass_reader(*methods) {|value| value}
@@ -121,6 +157,8 @@ module Ecoportal
             end
 
             # To link as plain `Array` to a subjacent `Hash` model property
+            # @param methods [Array<Symbol>] the method that exposes the value
+            #   as well as its `key` in the underlying `Hash` model.
             # @param order_matters [Boolean] does the order matter
             # @param uniq [Boolean] should it contain unique elements
             def passarray(*methods, order_matters: true, uniq: true)
@@ -142,6 +180,10 @@ module Ecoportal
             end
 
             # Helper to embed one nested object under one property
+            # @param method [Symbol] the method that exposes the embeded object
+            # @param key [Symbol] the `key` that embeds it to the underlying `Hash` model
+            # @nullable [Boolean] to specify if this object can be `nil`
+            # @param klass [Class, String] the class of the embedded object
             def embeds_one(method, key: method, nullable: false, klass:)
               embed(method, key: key, nullable: nullable, multiple: false, klass: klass)
             end
@@ -149,7 +191,11 @@ module Ecoportal
             # @note
             #   - if you have a dedicated `Enumerable` class to manage `many`, you should use `:enum_class`
             #   - otherwise, just indicate the child class in `:klass` and it will auto generate the class
-            # @param
+            # @param method [Symbol] the method that exposes the embeded object
+            # @param key [Symbol] the `key` that embeds it to the underlying `Hash` model
+            # @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)
               if enum_class
                 eclass = enum_class
@@ -186,8 +232,15 @@ module Ecoportal
               end
             end
 
+            # The list of keys that will be forced in the model
+            def model_forced_keys
+              @forced_model_keys ||= {}
+            end
+
           end
 
+          inheritable_class_vars :forced_model_keys
+
           attr_reader :_parent, :_key
 
           def initialize(doc = {}, parent: self, key: nil)
@@ -195,6 +248,8 @@ module Ecoportal
             @_parent   = parent || self
             @_key      = key    || self
 
+            self.class.enforce!(doc)
+
             if _parent == self
               @doc          = doc
               @original_doc = JSON.parse(@doc.to_json)
@@ -211,11 +266,13 @@ module Ecoportal
             _parent.root
           end
 
+          # @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?
             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?
             method = "#{key_method}="
@@ -234,16 +291,25 @@ module Ecoportal
             end
           end
 
+          # @return [nil, Hash] the underlying `Hash` model as is (carrying current changes)
           def doc
             raise UnlinkedModel.new(from: "#{self.class}#doc", key: _key) unless linked?
-            return @doc if is_root?
-            _parent.doc.dig(*[_doc_key(_key)].flatten)
+            if is_root?
+              @doc
+            else
+              _parent.doc.dig(*[_doc_key(_key)].flatten)
+            end
           end
 
+          # The `original_doc` holds the model as is now on server-side.
+          # @return [nil, Hash] the underlying `Hash` model as after last `consolidate!` changes
           def original_doc
             raise UnlinkedModel.new(from: "#{self.class}#original_doc", key: _key) unless linked?
-            return @original_doc if is_root?
-            _parent.original_doc.dig(*[_doc_key(_key)].flatten)
+            if is_root?
+              @original_doc
+            else
+              _parent.original_doc.dig(*[_doc_key(_key)].flatten)
+            end
           end
 
           def as_json
@@ -254,19 +320,31 @@ module Ecoportal
             doc.to_json(*args)
           end
 
+          # @return [nil, Hash] the patch `Hash` model including only the changes between
+          #   `original_doc` and `doc`
           def as_update
             new_doc = as_json
             Common::Content::HashDiffPatch.patch_diff(new_doc, original_doc)
           end
 
+          # @return [Boolean] stating if there are changes
           def dirty?
             as_update != {}
           end
 
+          # It makes `original_doc` to be like `doc`
+          # @note
+          #   - after executing it, there will be no pending changes
+          #   - you should technically run this command, after a successful update request to the server
           def consolidate!
             replace_original_doc(JSON.parse(doc.to_json))
           end
 
+          # It makes `doc` to be like `original`
+          # @note
+          #   - after executing it, changes in `doc` will be lost
+          #   - you should technically run this command only if you want to remove certain changes
+          # @key [Symbol] the specific part of the model you want to `reset`
           def reset!(key = nil)
             if key
               keys    = [key].flatten.compact
@@ -289,8 +367,8 @@ module Ecoportal
               @doc = new_doc
             else
               dig_set(_parent.doc, [_doc_key(_key)].flatten, new_doc)
-              _parent.variable_remove!(_key)
-              variables_remove!
+              _parent.variable_remove!(_key) unless new_doc
+              #variables_remove!
             end
           end
 
@@ -307,9 +385,9 @@ module Ecoportal
           def replace_original_doc(new_doc)
             raise UnlinkedModel.new(from: "#{self.class}#replace_original_doc", key: _key) unless linked?
             if is_root?
-              @orginal_doc = new_doc
+              @original_doc = new_doc
             else
-              dig_set(_parent.orginal_doc, [_doc_key(_key)].flatten, new_doc)
+              dig_set(_parent.original_doc, [_doc_key(_key)].flatten, new_doc)
             end
           end
 
@@ -331,11 +409,21 @@ module Ecoportal
 
           # Removes all the persistent variables
           def variables_remove!
+            #puts "going to remove vars: #{@_dim_vars} on #{self.class} (parent: #{identify_parent(self._parent)})"
             @_dim_vars.dup.map {|k| variable_remove!(k)}
           end
 
           private
 
+          def identify_parent(object)
+            case object
+            when Ecoportal::API::V2::Page::Stage
+              "stage #{object.name}"
+            when Ecoportal::API::V2::Page::Section
+              "section #{object.heading}"
+            end
+          end
+
           def instance_variable_name(key)
             self.class.instance_variable_name(key)
           end

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

@@ -60,6 +60,8 @@ module Ecoportal
               a == b
             end
 
+            # Compares `a` as charring changes of `b`
+            # @return [Hash] patch data object with only changes
             def patch_data(a, b = nil, delete: false)
               {}.tap do |data_hash|
                 if delete
@@ -75,11 +77,17 @@ module Ecoportal
                   data_hash[key] = patch_diff(a_value, b_value)
                   data_hash.delete(key) if data_hash[key] == NO_CHANGES
                 end
+                #if (data_hash.keys - ID_KEYS).empty?
                 if (data_hash.keys - META_KEYS).empty?
                   return NO_CHANGES
                 else
-                  patch_ver = (b && b["patch_ver"]) || 1
-                  data_hash["patch_ver"] = patch_ver
+                  #patch_ver = (b && b["patch_ver"]) || 1
+                  #data_hash["patch_ver"] = patch_ver
+                  if b && b.key?("patch_ver")
+                    data_hash["patch_ver"] = b["patch_ver"]
+                  elsif a && a.key?("patch_ver")
+                    data_hash["patch_ver"] = a["patch_ver"]
+                  end
                 end
               end
             end
@@ -172,7 +180,9 @@ module Ecoportal
                 arr.any? {|a| nested_array?(a)}
               when arr.length == 1
                 arr = arr.first
-                arr.any? {|item| item.is_a?(Hash)}
+                arr.any? do |item|
+                  item.is_a?(Hash) && item.has_key?("patch_ver")
+                end
               else
                 false
               end

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

@@ -7,14 +7,15 @@ module Ecoportal
             class << self
               def new_doc
                 {
-                  "id"     => new_uuid,
-                  "weight" => 9999
+                  "id"         => new_uuid,
+                  "weight"     => 99
                 }
               end
             end
 
             passkey     :id
-            passthrough :patch_ver, :name
+            passforced  :patch_ver, default: 1
+            passthrough :name
             passthrough :weight, :other_information
             passboolean :complete
 

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

@@ -25,9 +25,9 @@ module Ecoportal
             end
 
             def ordered_tasks
-              actions.each_with_index.sort_by do |task, index|
-                (task.weight >= 9999) ? [index, index] : [task.weight, index]
-              end.map(&:first)
+              actions.sort_by.with_index do |task, index|
+                [task.weight, index]
+              end
             end
 
             # Quick config helper

data/lib/ecoportal/api/v2/page/component/chart_field/config.rb

@@ -11,9 +11,9 @@ module Ecoportal
                   {"id" => new_uuid}
                 end
               end
-              
+
               passkey     :id
-              passthrough :patch_ver
+              passforced  :patch_ver, default: 1
             end
           end
         end

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

@@ -19,9 +19,9 @@ module Ecoportal
             end
 
             def ordered_items
-              items.each_with_index.sort_by do |item, index|
-                (item.weight >= 9999) ? [index, index] : [item.weight, index]
-              end.map(&:first)
+              items.sort_by.with_index do |item, index|
+                [item.weight, index]
+              end
             end
 
             private

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

@@ -8,14 +8,15 @@ module Ecoportal
             class << self
               def new_doc
                 {
-                  "id"     => new_uuid,
-                  "weight" => 9999
+                  "id"          => new_uuid,
+                  "weight"      => 9999
                 }
               end
             end
 
             passkey     :id
-            passthrough :patch_ver, :label
+            passforced  :patch_ver, default: 1
+            passthrough :label
             passthrough :weight
             passboolean :checked
           end

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

@@ -4,10 +4,20 @@ module Ecoportal
       class Page
         class Component
           class File < Common::Content::DoubleModel
+            class << self
+              def new_doc
+                {
+                  "id"         => new_uuid,
+                  "position"   => 99
+                }
+              end
+            end
+
             passkey     :id
-            passthrough :patch_ver, :position
-            passthrough :file_size, :token, read_only: true
-            passthrough :content_type, :file_container_id
+            passforced  :patch_ver, default: 1
+            passthrough :position
+            passthrough :file_size, :content_type, :token, read_only: true
+            passthrough :file_container_id
             passdate    :file_update_at, read_only: true
           end
         end

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

@@ -4,10 +4,46 @@ module Ecoportal
       class Page
         class Component
           class FilesField < Page::Component
-            embeds_many :items, klass: "Ecoportal::API::V2::Page::File", order_key: :position
+            embeds_many :items, klass: "Ecoportal::API::V2::Page::Component::File", order_key: :position
+
+            def add_file(container_id, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              file_doc = items.items_class.new_doc
+              items.upsert!(file_doc, pos: pos, before: before, after: after) do |file|
+                file.file_container_id  = container_id
+                if prev = previous_file(file)
+                  file.position = prev.position
+                end
+                yield(file) if block_given?
+                fix_file_positions!
+              end
+            end
+
+            def ordered_files
+              items.sort_by.with_index do |file, index|
+                [file.position, index]
+              end
+            end
+
+            private
+
+            def fix_file_positions!
+              ordered_files.each_with_index do |file, index|
+                file.position = index
+              end
+            end
+
+            def previous_file(value)
+              fls = ordered_files
+              pos = fls.index(value) - 1
+              return if pos < 0
+              fls[pos]
+            end
+
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/file'

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

@@ -21,9 +21,9 @@ module Ecoportal
             end
 
             def ordered_stops
-              stops.each_with_index.sort_by do |stop, index|
-                (stop.threshold >= 9999) ? [index, index] : [stop.threshold, index]
-              end.map(&:first)
+              stops.sort_by.with_index do |stop, index|
+                [stop.threshold, index]
+              end
             end
 
           end

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

@@ -8,16 +8,16 @@ module Ecoportal
             class << self
               def new_doc
                 {
-                  "id"        => new_uuid,
-                  "threshold" => nil,
-                  "color"     => nil
+                  "id"         => new_uuid,
+                  "threshold"  => nil,
+                  "color"      => nil
                 }
               end
             end
 
             passkey     :id
-            passthrough :patch_ver, :threshold
-            passthrough :color
+            passforced  :patch_ver, default: 1
+            passthrough :threshold, :color
 
             # Assign the color to the stop.
             # @note These are the available colors:

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

@@ -5,7 +5,8 @@ module Ecoportal
         class Component
           class Image < Common::Content::DoubleModel
             passkey     :id
-            passthrough :patch_ver, :weight
+            passforced  :patch_ver, default: 1
+            passthrough :weight
             passthrough :height, :width, :caption
             passthrough :dimensions, :styles
           end

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

@@ -4,6 +4,7 @@ module Ecoportal
       class Page
         class Component
           class NumberField < Page::Component
+            passthrough :value
           end
         end
       end

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

@@ -7,7 +7,7 @@ module Ecoportal
             passboolean :is_me_button
             passthrough :attach_mode
             passthrough :person_schema_id
-            pass_reader :viewable_fields
+            embeds_many :viewable_fields, klass: "Ecoportal::API::V2::Page::Component::PeopleViewableField"
 
             passboolean :singular
             passthrough :requires_number
@@ -30,6 +30,16 @@ module Ecoportal
               people_ids.reject! {|id| ids.include?(id)}
             end
 
+            # Adds a field to the `viewable_fields`
+            def add_viewable(field_id, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              viewable_fields.upsert!({"id" => field_id}, pos: pos, before: before, after: after)
+            end
+
+            # Deletes a field from the `viewable_fields`
+            def delete_viewable(field_id)
+              viewable_fields.delete!(field_id)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:snapshot` to set mode to `snapshot`
@@ -64,7 +74,7 @@ module Ecoportal
                   unless (rest = hash_except(cnf.dup, *supported)).empty?
                     unused.push(rest)
                   end
-                  
+
                   if cnf.key?(:singular) then self.singular = !!cnf[:singular] end
                   if cnf.key?(:permits)
                     if permits = cnf[:permits]
@@ -121,3 +131,5 @@ module Ecoportal
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/people_viewable_field'

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class PeopleViewableField < Common::Content::DoubleModel
+            passkey     :id
+            passthrough :type, read_only: true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -58,9 +58,9 @@ module Ecoportal
             end
 
             def ordered_options
-              options.each_with_index.sort_by do |option, index|
-                (option.weight >= 9999) ? [index, index] : [option.weight, index]
-              end.map(&:first)
+              options.sort_by.with_index do |option, index|
+                [option.weight, index]
+              end
             end
 
             # Quick config helper

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

@@ -8,14 +8,15 @@ module Ecoportal
             class << self
               def new_doc
                 {
-                  "id"     => new_uuid,
-                  "weight" => 9999
+                  "id"         => new_uuid,
+                  "weight"     => 9999
                 }
               end
             end
 
             passkey     :id
-            passthrough :patch_ver, :name, :value
+            passforced  :patch_ver, default: 1
+            passthrough :name, :value
             passthrough :weight
             passboolean :selected
 

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

@@ -13,8 +13,9 @@ module Ecoportal
               end
             end
 
-            passthrough :signed_by_id, :signed_by_name, :signature_url
-            passdate    :signature_updated_at
+            passthrough :signed_by_id, :signed_by_name, read_only: true
+            passthrough :signature_url, read_only: true
+            passdate    :signature_updated_at, read_only: true
             passthrough :signature_content, :color
 
           end

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

@@ -26,13 +26,16 @@ module Ecoportal
 
           class << self
             def new_doc(type: nil)
-              if type
-                type_doc = {"type" => type}
-                base_doc = get_class(type_doc)&.new_doc || {}
-                base_doc.merge!(type_doc)
+              {
+                "id"         => new_uuid
+              }.tap do |base_doc|
+                if type
+                  base_doc.merge!({"type" => type})
+                  if klass = get_class(base_doc)
+                    base_doc.merge!(klass.new_doc || {})
+                  end
+                end
               end
-              return base_doc if base_doc&.key?("id")
-              (base_doc || {}).merge("id" => new_uuid)
             end
 
             def get_class(doc)
@@ -82,7 +85,8 @@ module Ecoportal
           end
 
           passkey     :id
-          passthrough :patch_ver, :undeletable
+          passforced  :patch_ver, default: 1
+          passboolean :undeletable
           passthrough :type, :label, :tooltip, :global_binding
           passboolean :hidden, :deindex, :required
           passthrough :accent

data/lib/ecoportal/api/v2/page/permit.rb

@@ -4,9 +4,10 @@ module Ecoportal
       class Page
         class Permit < Common::Content::DoubleModel
           passkey     :id
-          passthrough :patch_ver
+          passforced  :patch_ver, default: 1
           passthrough :user_id, :user_name
           passthrough :editable, :flags
+          embeds_one  :flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
         end
       end
     end

data/lib/ecoportal/api/v2/page/section.rb

@@ -3,12 +3,14 @@ module Ecoportal
     class V2
       class Page
         class Section < Common::Content::DoubleModel
+          INITIAL_WEIGHT = 9999
+
           class << self
             def new_doc(split: false)
               {
-                "id"     => new_uuid,
-                "type"   => split ? "split" : "content",
-                "weight" => 800
+                "id"         => new_uuid,
+                "type"       => split ? "split" : "content",
+                "weight"     => INITIAL_WEIGHT
               }.tap do |out|
                 component_ids = if split
                     {
@@ -26,10 +28,11 @@ module Ecoportal
           end
 
           passkey     :id
-          passthrough :patch_ver, :weight, :type
+          passforced  :patch_ver, default: 1
+          passthrough :weight, :type
           passthrough :heading, :left_heading, :right_heading
           passarray   :component_ids, :left_component_ids, :right_component_ids
-          passthrough :minimized
+          passboolean :minimized
 
           def split?
             doc && doc["type"] == "split"
@@ -77,8 +80,9 @@ module Ecoportal
           # @param field [Ecoportal::API::V2::Page::Component] the field to be added.
           def add_component(field, after: nil, side: nil)
             raise "field should be a Ecoportal::API::V2::Page::Component. Given: #{field.class}" unless field.is_a?(Ecoportal::API::V2::Page::Component)
+            # IMPORTANT NOTE: The code below creates objects, because field.section does a search on section.component_ids
             if field.section == self
-              raise "Field with id '#{field.id}' already belongs to this section"
+              puts "Field with id '#{field.id}' already belongs to this section"
             elsif sec = field.section
               # Field belongs to another section
               raise "Field with id '#{field.id}' belongs to section '#{sec.heading || "Unnamed"}' (id: '#{sec.id}')"
@@ -91,6 +95,7 @@ module Ecoportal
               ids_ary = component_ids
               fields  = components
             end
+
             if after
               after_fld = fields.find do |fld|
                 found   = nil
@@ -99,6 +104,7 @@ module Ecoportal
                 found ||= same_string?(fld.label, after)
               end
             end
+
             ids_ary.insert_one(field.id, after: after_fld&.id)
             self
           end

data/lib/ecoportal/api/v2/page/sections.rb

@@ -8,11 +8,15 @@ module Ecoportal
           self.klass = :section_class
 
           # Creates a new `section`
+          # @note
+          #   - It won't fix weights unless all the sections of the ooze are present
+          #   - This means that it doesn't fix section weights on stages,
+          #     as shared sections could change order in other stages
           def add(name: nil, split: false, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             sec_doc = section_class.new_doc(split: split)
             upsert!(sec_doc) do |section| #, pos: pos, before: before, after: after) do |section|
               section.heading  = name
-              if weight = scope_weight(pos: pos, before: before, after: after)
+              if weight = scope_weight(section, pos: pos, before: before, after: after)
                 section.weight = weight
               end
               fix_weights!
@@ -51,13 +55,13 @@ module Ecoportal
           # Gets the sections ordered by `weight` (as they appear in the page)
           def ordered
             self.sort_by.with_index do |section, index|
-              (section.weight >= 9999) ? [index, index] : [section.weight, index]
+              [section.weight, index]
             end
           end
 
           private
 
-          def scope_weight(pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+          def scope_weight(section, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             case
             when used_param?(pos)
               if pos    = to_section(pos)
@@ -71,6 +75,11 @@ module Ecoportal
               if after  = to_section(after)
                 after.weight
               end
+            end.yield_self do |weight|
+              weight = ordered.reject do |sec|
+                sec.id == section.id
+              end.last&.weight
+              weight ||= section_class.const_get(:INITIAL_WEIGHT)
             end
           end
 
@@ -86,8 +95,10 @@ module Ecoportal
           end
 
           def fix_weights!
-            ordered.each_with_index do |section, index|
-              section.weight = index
+            unless self._parent.is_a?(Ecoportal::API::V2::Pages::PageStage)
+              ordered.each_with_index do |section, index|
+                section.weight = index
+              end
             end
           end
 

data/lib/ecoportal/api/v2/page/stage.rb

@@ -4,7 +4,7 @@ module Ecoportal
       class Page
         class Stage < Common::Content::DoubleModel
           passkey     :id
-          passthrough :patch_ver
+          passforced  :patch_ver, default: 1
           passthrough :name, :ordering
           passarray   :subtags, order_matters: false
           passarray   :section_ids
@@ -22,7 +22,7 @@ module Ecoportal
             root.sections.values_at(*sec_ids).select.with_index do |sec, i|
               puts "Warning: section #{id} points to missing section #{sec_ids[i]}" if !sec
               fld && (!block_given? || yield(sec))
-            end.sort_by {|sec| sec.weight}
+            end.sort_by.with_index {|sec, index| [sec.weight, index]}
           end
 
           def add_section(*secs)

data/lib/ecoportal/api/v2/page/stages.rb

@@ -14,9 +14,9 @@ module Ecoportal
           end
 
           #def ordered
-          #  self.each_with_index.sort_by do |stage, index|
-          #    (stage.ordering >= 9999) ? [index, index] : [stage.ordering, index]
-          #  end.map(&:first)
+          #  self.sort_by.with_index do |stage, index|
+          #    [stage.ordering, index]
+          #  end
           #end
 
         end

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

@@ -2,9 +2,19 @@ module Ecoportal
   module API
     class V2
       class Page < Common::Content::DoubleModel
-        ALLOWED_KEYS  = %w[id patch_ver name template_id base_tags tags time_zone created_at updated_at can components sections stages]
+        ALLOWED_KEYS  = [
+          "id", "patch_ver", "name", "template_id",
+          "base_tags", "tags",
+          "time_zone", "created_at", "updated_at",
+          "components", "sections", "stages",
+          "permits", "mould_counter", "mould",
+          "state", "task_priority",
+          "votes_enabled", "upvotes", "downvotes",
+          "force_errors", "subtags"
+        ]
+
         passkey     :id
-        passthrough :patch_ver
+        passforced  :patch_ver, default: 1
         passthrough :name, :template_id
         passarray   :base_tags, :tags, order_matters: false
         passthrough :time_zone
@@ -19,12 +29,50 @@ module Ecoportal
         embeds_many :sections,   enum_class: :sections_class
         embeds_many :stages,     enum_class: :stages_class
 
+        def initialize(doc = [], parent: self, key: nil)
+          super(_doc_bug_fix(doc), parent: parent, key: key)
+        end
+
         def as_update
           super.tap do |hash|
             unless !hash
               hash["data"].select! do |key, value|
                 ALLOWED_KEYS.include?(key)
               end
+              return nil if (hash["data"].keys - ["patch_ver"]).empty?
+            end
+          end
+        end
+
+        def stages?
+          self.stages.count > 0
+        end
+
+        private
+
+        def _doc_bug_fix(hash)
+          hash.tap do |hash|
+            _fix_doc(hash["stages"], "flow_node_ids", "section_ids") if hash.key?("stages")
+            if hash.key?("sections")
+              _fix_doc(hash["sections"], "membrane_ids", "component_ids")
+              _fix_doc(hash["sections"], "left_membrane_ids", "left_component_ids")
+              _fix_doc(hash["sections"], "right_membrane_ids", "right_component_ids")
+            end
+          end
+        end
+
+        def _fix_doc(value, source, dest)
+          value.tap do |value|
+            case value
+            when Array
+              value.each {|v| _fix_doc(v, source, dest)}
+            when Hash
+              if value.key?(source) && !value.key?(dest)
+                value[dest] = value[source]
+                value.delete(source)
+              end
+            else
+              # Do nothing!
             end
           end
         end

data/lib/ecoportal/api/v2/pages/page_stage.rb

@@ -9,6 +9,19 @@ module Ecoportal
 
           embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
           passarray   :force_errors, :subtags, order_matters: false
+
+          # `id` of the stage we got the data of.
+          def current_stage_id
+            doc.dig("active_stage", "id") || doc["current_stage_id"]
+          end
+
+          # @return [Ecoportal::API::V2::Page::Stage]
+          def current_stage
+            if stage_id = current_stage_id
+              stages[stage_id]
+            end
+          end
+
         end
       end
     end

data/lib/ecoportal/api/v2/pages.rb

@@ -47,10 +47,13 @@ module Ecoportal
         end
 
         # Requests to update an existing page via api.
+        # @note It won't launch the update unless there are changes
         # @param doc [Hash, Page] data that at least contains an `id` (internal or external) of the target page.
         # @return [Response] an object with the api response.
         def update(doc)
           body = get_body(doc) # , level: "page"
+          # Launch only if there are changes
+          raise "Missing page object" unless body && body["page"]
           id   = get_id(doc)
           client.patch("/pages/#{CGI.escape(id)}", data: body)
         end

data/lib/ecoportal/api/v2/registers/search_results.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class SearchResults < Common::Content::DoubleModel
+          passthrough :total, :total_before_filtering
+          passarray   :tags, order_matters: false
+          embeds_many :results, klass: "Ecoportal::API::V2::Registers::PageResult"
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v2/registers.rb

@@ -9,6 +9,7 @@ module Ecoportal
 
         class_resolver :register_class,  "Ecoportal::API::V2::Registers::Register"
         class_resolver :register_search_result_class, "Ecoportal::API::V2::Registers::PageResult"
+        class_resolver :register_search_results, "Ecoportal::API::V2::Registers::SearchResults"
 
         attr_reader :client
 
@@ -35,7 +36,12 @@ module Ecoportal
         # @param options [Hash] the search options
         # @option options [Hash<Symbol, String>] :query plain search (like the search box in register).
         # @option options [Hash<Symbol, Array<Object>>] :filters the set of filters.
+        # @option options [Boolean] if `true`, it only performs the first search and results `Ecoportal::API::V2::Registers::SearchResults`.
+        # @yield [result]  something to do with search page-result.
+        # @yieldparam result [Ecoportal::V2::Registers::PageResult] a page result.
+        # @return [Ecoportal::API::V2::Registers, Ecoportal::API::V2::Registers::SearchResults]
         def search(register_id, options = {})
+          only_first = options.delete(:only_first)
           # supply a query string
           # or a filter array (copy/paste from dev tools in the browser)
           options = {query: nil, filters: []}.update(options)
@@ -49,6 +55,12 @@ module Ecoportal
             end
           end
 
+          if only_first
+            response = client.get("/registers/#{register_id}/search", params: options)
+            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+            return register_search_results.new(response.body["data"])
+          end
+
           cursor_id = nil
           results = 0
           loop do
@@ -70,8 +82,8 @@ module Ecoportal
               yield object
             end
 
-            # break unless (cursor_id = data["cursor_id"])
-            break if total == results
+            break if total <= results
+            break unless (cursor_id = data["cursor_id"])
           end
           self
         end
@@ -87,3 +99,4 @@ require 'ecoportal/api/v2/registers/register'
 require 'ecoportal/api/v2/registers/stage_result'
 require 'ecoportal/api/v2/registers/stages_result'
 require 'ecoportal/api/v2/registers/page_result'
+require 'ecoportal/api/v2/registers/search_results'

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.9"
+    GEM2_VERSION = "0.8.13"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.8.13
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -209,6 +209,7 @@ files:
 - lib/ecoportal/api/v2/page/component/law_field.rb
 - lib/ecoportal/api/v2/page/component/number_field.rb
 - lib/ecoportal/api/v2/page/component/people_field.rb
+- lib/ecoportal/api/v2/page/component/people_viewable_field.rb
 - lib/ecoportal/api/v2/page/component/plain_text_field.rb
 - lib/ecoportal/api/v2/page/component/reference_field.rb
 - lib/ecoportal/api/v2/page/component/rich_text_field.rb
@@ -230,6 +231,7 @@ files:
 - lib/ecoportal/api/v2/registers.rb
 - lib/ecoportal/api/v2/registers/page_result.rb
 - lib/ecoportal/api/v2/registers/register.rb
+- lib/ecoportal/api/v2/registers/search_results.rb
 - lib/ecoportal/api/v2/registers/stage_result.rb
 - lib/ecoportal/api/v2/registers/stages_result.rb
 - lib/ecoportal/api/v2/registers/template.rb