ecoportal-api-v2 0.8.10 → 0.8.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8961e37170e3ffe06d26c17daa6672a15d595ff91c5e8fb38253549b166057a
-  data.tar.gz: c9b25eb42cfa9cb45cee3d830067eddc7d4191fa87f0fd4e35620e346ca27922
+  metadata.gz: 3480ab100855337eef9de50609f4f4776418de1b09a5a1eac3ee31f936f4cd00
+  data.tar.gz: 2520bf687a1d00df3d925788600f78c266fcc6599ac816dac1f7df08703bc9e9
 SHA512:
-  metadata.gz: a68c58f62600b78745caff84d7e0dbda83e2f79cba8d41ca08ffbcf361060bd614fc6957f38878bb09d41dc6db1fcff3e307dd0072d21d960073683e6881fdbc
-  data.tar.gz: 998e1409fd0674bc409ab2ff1dcfb68f42a0dd37bca8eab040750cc8cc10ca2651fb98dc61adf3d44b0b0dbdc0bccfe384786cdd79ad1fd9ed96d12a00f3a4b4
+  metadata.gz: 011752c7161177026fdcd59a01ee7eb048094eb29c5688e2b68e6ad2aec0a263e93990726c1fca86eb1bfc86d000d360db4d8cf685783f7c2ab8257570258740
+  data.tar.gz: 012ed55b7472c56f76b2e1bdafd3ce8cb926c67d5d94e6b3349a7c21ade9ff3a20c2caa4974fe9cdc30a6dba8312663edc633ae7d0a66b31117b57e795727dde

data/CHANGELOG.md

@@ -1,7 +1,86 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.10] - 2021-08-xx
+## [0.8.14] - 2021-09-xx
+
+### Added
+  - `Ecoportal::API::Common::Content::CollectionModel`
+    - `#_doc_pos` for clarity
+    - `#include?` to check if an element is present in the collection
+  - `Ecoportal::API::V2::Page::Stage#section?` check if section belongs to stage
+  - `Ecoportal::API::V2::Page::Sections`
+    - `#get_by_id`
+    - `#unattached` sections that are not attached to any stage
+  - `Ecoportal::API::V2::Page::Section`
+    - `#add_component` **added** parameter `before`: to cover case where you want to add it at the beginning
+    - `#component?` **widened** parameter type
+    - `#stages` stages where this section is attached
+    - `attached?` whether or not the section is attached
+  - `Ecoportal::API::V2::Page::Component`
+    - `#attached?` whether or not the field is attached to some section
+    - `#multi_section?` if the field is attached to more than one section :/
+  - **added** support for `forces`
+    - `Ecoportal::API::V2::Page::Force`
+    - `Ecoportal::API::V2::Page::Forces`
+    - `Ecoportal::API::V2::Page::Force::Binding`
+    - `Ecoportal::API::V2::Page::Force::Bindings`
+  - **added** shortcut to `#ooze` throughout all the model
+  - **validations** in some methods
+    - `Ecoportal::API::V2::Page::Stage#add_section`: section should be in `ooze.sections`
+    - `Ecoportal::API::V2::Page::Section#add_component`: component should be in `ooze.components`
+    - `Ecoportal::API::V2::Page::Force::Bindings#add`:
+      - section to be in `ooze.sections`
+      - component to be in `ooze.components`
+    - `Ecoportal::API::V2::Pages::PageStage#as_update` on page instances, it checks that
+      - Fields do not belong to more than one section
+      - Fields belong at least to one section
+      - Sections belong to at least one stage
+
+### Changed
+### Fixed
+  - `Ecoportal::API::Common::Content::ArrayModel#insert_one` was not inserting when not found. Should insert at least at the end.
+
+## [0.8.13] - 2021-09-03
+
+### Fixed
+  - `Ecoportal::API::V2::Page::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

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
 
@@ -224,25 +224,18 @@ module Ecoportal
             i = index(value)
             return i if (i && uniq?)
             pos = case
-                  when used_param?(pos)
-                    pos || length
-                  when used_param?(before)
-                    before ? index(before) : length
-                  when used_param?(after)
-                    if after
-                      if i = index(after) then i + 1 end
-                    else
-                      length
-                    end
-                  else
-                    length
+                  when used_param?(pos) && pos
+                    pos
+                  when used_param?(before) && before
+                    index(before)
+                  when used_param?(after) && after
+                    if i = index(after) then i + 1 end
                   end
 
+            pos ||= length
             pos.tap do |i|
-              unless !i
-                _items.insert(pos, value)
-                on_change
-              end
+              _items.insert(pos, value)
+              on_change
             end
           end
 

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

@@ -109,7 +109,14 @@ module Ecoportal
             self.class.klass
           end
 
+          def _doc_pos(value)
+            _doc_key(value)
+          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)
@@ -149,6 +156,13 @@ module Ecoportal
             items_by_key[get_key(value)]
           end
 
+          # Checks if an element exists in the collection
+          # @param value [String, Hash, Ecoportal::API::Common::Content::DoubleModel]
+          # @return [Boolean] whether or not it is included
+          def include?(value)
+            items_by_key.key?(get_key(value))
+          end
+
           # @return [Array<Object>] the `items_class` element object
           def values_at(*keys)
             keys.map {|key| self[key]}
@@ -167,7 +181,10 @@ module Ecoportal
             if item = self[value]
               item.replace_doc(item_doc)
             else
-              pos_idx = _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?
@@ -185,6 +202,8 @@ module Ecoportal
             end
             if item = self[value]
               _doc_delete(item.doc)
+              @indexed = false
+              _items.delete(item)
             end
           end
 
@@ -195,7 +214,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`
@@ -253,9 +273,7 @@ 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
 
@@ -275,7 +293,6 @@ module Ecoportal
             pos = (pos && pos < _doc_items.length)? pos : _doc_items.length
             pos.tap do |i|
               _doc_items.insert(pos, value)
-              on_change
             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

@@ -240,7 +240,7 @@ module Ecoportal
           end
 
           inheritable_class_vars :forced_model_keys
-          
+
           attr_reader :_parent, :_key
 
           def initialize(doc = {}, parent: self, key: nil)
@@ -367,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
 
@@ -385,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
 
@@ -409,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,7 +60,7 @@ module Ecoportal
               a == b
             end
 
-            # Compares `a` as charring changes of `b`
+            # Compares `a` as carrying changes of `b`
             # @return [Hash] patch data object with only changes
             def patch_data(a, b = nil, delete: false)
               {}.tap do |data_hash|

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

@@ -8,7 +8,7 @@ module Ecoportal
               def new_doc
                 {
                   "id"         => new_uuid,
-                  "weight"     => 9999
+                  "weight"     => 99
                 }
               end
             end

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/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/file.rb

@@ -8,7 +8,7 @@ module Ecoportal
               def new_doc
                 {
                   "id"         => new_uuid,
-                  "position"   => 9999
+                  "position"   => 99
                 }
               end
             end

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

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

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/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.rb

@@ -93,6 +93,10 @@ module Ecoportal
           passboolean :hide_view, :hidden_on_reports, :hidden_on_mobile
           passarray   :refs
 
+          def ooze
+            self._parent.ooze
+          end
+
           def ref_backend
             refs.first
           end
@@ -103,10 +107,23 @@ module Ecoportal
             end
           end
 
+          # Looks up the section that this component belongs to.
+          # @return [Ecoportal::API::V2::Page::Section, nil] the section where this field is attached to.
           def section
             root.sections.find {|sec| sec.component?(id)}
           end
 
+          # @return [Boolean] whether or not this field is attached to any section.
+          def attached?
+            !!section
+          end
+
+          # @return [Boolean] whether or not the component has been attached to more than one section.
+          def multi_section?
+            secs = ooze.sections.select {|sec| sec.component?(id)}
+            secs.length > 1
+          end
+
           def indexable_label
             self.class.indexable_label(label)
           end

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

@@ -13,18 +13,27 @@ module Ecoportal
 
           order_matters = true
 
+          def ooze
+            self._parent.ooze
+          end
+
+          # @return [Ecoportal::API::V2::Page::Component] the field with `id`
           def get_by_id(id)
             self.find do |comp|
               comp.id == id
             end
           end
 
+          # @return [Array<Ecoportal::API::V2::Page::Component>] the fields of that `type`
           def get_by_type(type)
             self.select do |comp|
               comp.type.downcase == type.to_s.strip.downcase
             end
           end
 
+          # @param name [String, Regexp] the `name` to search the field based on their `label`
+          # @param type [String] the `type` of the fields to be included
+          # @return [Array<Ecoportal::API::V2::Page::Component>] the fields that match `name`.
           def get_by_name(name, type: nil)
             pool = type ? get_by_type(type) : self
             pool.select do |comp|
@@ -32,6 +41,12 @@ module Ecoportal
             end
           end
 
+          # It creates a **new** component
+          # @param label [String, nil]
+          # @param type [String] the type of the field
+          # @yield [field] do some stuff with field
+          # @yieldparam [Ecoportal::API::V2::Page::Component] the created field
+          # @return [Ecoportal::API::V2::Page::Component] the created field.
           def add(label:, type:)
             fld_doc = component_class.new_doc(type: type)
             upsert!(fld_doc) do |fld|
@@ -40,6 +55,15 @@ module Ecoportal
             end
           end
 
+          # @return [Array<Ecoportal::API::V2::Page::Component>] **orphaned** fields (with no section).
+          def unattached
+            select {|comp| !comp.attached?}
+          end
+
+          # @return [Array<Ecoportal::API::V2::Page::Component>] fields belonging to more than one section.
+          def multi_section
+            select {|comp| comp.multi_section?}
+          end
         end
       end
     end

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

@@ -0,0 +1,54 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Force
+          class Binding < Common::Content::DoubleModel
+            class << self
+              def new_doc
+                {
+                  "id"      => new_uuid
+                }
+              end
+            end
+            COMPONENT_TYPE = "membrane_binding"
+            SECTION_TYPE   = "flow_node_binding"
+
+            passkey     :id
+            passforced  :patch_ver, default: 1
+            passthrough :name, :reference_id, :type
+
+            def ooze
+              self._parent.ooze
+            end
+
+            # @return [Boolean] whether or not this the binding refers to a Component
+            def component?
+              type == COMPONENT_TYPE
+            end
+
+            # @return [Boolean] whether or not this the binding refers to a Section
+            def section?
+              type == SECTION_TYPE
+            end
+
+            # @return [Ecoportal::API::V2::Page::Component] field referenced by this binding.
+            def component
+              raise "This is not a component binding, but a section binding" unless component?
+              ooze.components.get_by_id(reference_id)
+            end
+
+            # @return [Ecoportal::API::V2::Page::Section] section referenced by this binding.
+            def section
+              raise "This is not a section binding, but a component binding" unless section?
+              ooze.sections.get_by_id(reference_id)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page/force/binding'
+require 'ecoportal/api/v2/page/force/bindings'

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

@@ -0,0 +1,126 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Force
+          class Bindings < Common::Content::CollectionModel
+            class_resolver :binding_class, "Ecoportal::API::V2::Page::Force::Binding"
+
+            self.klass    = :binding_class
+            order_matters = true
+
+            def ooze
+              self._parent.ooze
+            end
+
+            # @param id [String] the `id` of the binding to find.
+            # @return [Ecoportal::API::V2::Page::Force::Binding] binding with `id`
+            def get_by_id(id)
+              self.find do |bind|
+                bind.id == id
+              end
+            end
+
+            # @param type [String] target `type` of binding
+            #   1. Ecoportal::API::V2::Page::Force::Binding::COMPONENT_TYPE
+            #   2. Ecoportal::API::V2::Page::Force::Binding::SECTION_TYPE
+            # @return [Array<Ecoportal::API::V2::Page::Force::Binding>] the bindings of type `type`
+            def get_by_type(type = Ecoportal::API::V2::Page::Force::Binding::COMPONENT_TYPE)
+              self.select do |bind|
+                bind.type.downcase == type.to_s.strip.downcase
+              end
+            end
+
+            # @param type [String] target `type` of binding
+            #   1. Ecoportal::API::V2::Page::Force::Binding::COMPONENT_TYPE
+            #   2. Ecoportal::API::V2::Page::Force::Binding::SECTION_TYPE
+            # @return [Array<Ecoportal::API::V2::Page::Force::Binding>] the bindings matching `name`
+            def get_by_name(name, type: nil)
+              pool = type ? get_by_type(type) : self
+              pool.select do |bind|
+                same_string?(bind.name, name)
+              end
+            end
+
+            # Creates a new `binding`
+            # @note
+            #   - As there's no position property, it will upsert to the array of bindings
+            # @raise [ArgumentError] when `reference` is neither of Component or Section
+            # @raise [Exception] when
+            #   1. `reference` is a field missing in ooze.components
+            #   2. `reference` is a section missing in ooze.sections
+            # @param reference [Ecoportal::API::V2::Page::Component, Ecoportal::API::V2::Page::Section]
+            #   The field or the section to bind.
+            # @yield [binding] do some stuff with binding
+            # @yieldparam binding [Ecoportal::API::V2::Page::Force::Binding] the created binding
+            # @return [Ecoportal::API::V2::Page::Force::Binding] the created binding.
+            def add(reference, name:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              binding_doc = binding_class.new_doc
+
+              type = case reference
+                      when Ecoportal::API::V2::Page::Component
+                        unless ooze.components.include?(reference)
+                          msg  = "The field '#{reference.label}' (#{reference.id}) is not present in ooze.components.\n"
+                          msg += "Review your script (i.e. @var where you store previous ooze runs)."
+                          raise msg
+                        end
+                        Ecoportal::API::V2::Page::Force::Binding::COMPONENT_TYPE
+                      when Ecoportal::API::V2::Page::Section
+                        unless ooze.sections.include?(reference)
+                          msg  = "The section '#{reference.heading}' (#{reference.id}) is not present in ooze.sections.\n"
+                          msg += "Review your script (i.e. @var where you store previous ooze runs)."
+                          raise msg
+                        end
+                        Ecoportal::API::V2::Page::Force::Binding::SECTION_TYPE
+                      else
+                        msg = "You can only create bindings with Component and Section. Given: #{reference.class}"
+                        raise ArgumentError.new(msg)
+                      end
+
+              position = scope_position(pos: pos, before: before, after: after)
+              upsert!(binding_doc, pos: position) do |bind|
+                bind.name         = name
+                bind.reference_id = reference.id
+                bind.type         = type
+                yield(bind) if block_given?
+              end
+            end
+
+            private
+
+            def scope_position(pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              case
+              when used_param?(pos)
+                if pos    = to_binding(pos)
+                  _doc_pos(pos) - 1
+                end
+              when used_param?(before)
+                if before = to_binding(before)
+                  _doc_pos(before) - 1
+                end
+              when used_param?(after)
+                if after  = to_binding(after)
+                  _doc_pos(after) - 1
+                end
+              end.yield_self do |position|
+                position ||= self.count
+              end
+            end
+
+            def to_binding(value)
+              case value
+              when Ecoportal::API::V2::Page::Force::Binding
+                value
+              when Numeric
+                self[value]
+              else
+                get_by_name(value).first
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end