ecoportal-api-v2 0.8.12 → 0.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 692fe87a2a9dd089ee091bae7133915ac5c9ae4b0643be6086b57206569a1044
-  data.tar.gz: 4d9866b6e5727b176caaff881cb44a3cd13ca08418884e69283f8c64c0e80272
+  metadata.gz: 146b0998371f28683143b8a95ae1b68e11f8f079698502bede31c8e29369fc97
+  data.tar.gz: 4ce0f3dd75e4e1d822d4540fa0ff1e3e18a7c7dca1c54d7030bdb475adc21a93
 SHA512:
-  metadata.gz: b812fc350ccdfd173d8ca7b02b05bd0676eda8dac97e2a981cd6c87e1e62c7170744a352ef962144ffb24b3bf9eb43011156c78c09f22a00db154431fd2be5ca
-  data.tar.gz: 00c551099e991a339125e5a985f98aa918b8f9844e03b7b6ba79c6cc2fc5d9ffa4303eaee51c2acc6205932472cdf5324692a73d875e647ba0bcd685f676c60c
+  metadata.gz: 21605169ab88cb159ee32a2f6f36e3100b183a03a7f9c895b33631934811bb9e3f16c6bc6101ddfac562854f8762f545a743b68c55d662c97be54ff35fc5b9e8
+  data.tar.gz: d2a66296e4b9194667983ba5c37c646fd6a12e037138870aa2771c743fc75dbf9b2ee91d07af7b1e4b501ad1afd846b427a8b92f5dc99ee4551200cc742dcd20

data/CHANGELOG.md

@@ -1,12 +1,27 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.12] - 2021-08-xx
+## [0.8.13] - 2021-08-xx
 
 ### Added
-  - `Ecoportal::API::V2::Pages::PageStage#current_stage`
-
 ### 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.

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)
@@ -167,7 +170,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 +191,8 @@ module Ecoportal
             end
             if item = self[value]
               _doc_delete(item.doc)
+              @indexed = false
+              _items.delete(item)
             end
           end
 
@@ -195,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`
@@ -253,9 +262,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 +282,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/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/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/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
+                "weight"     => INITIAL_WEIGHT
               }.tap do |out|
                 component_ids = if split
                     {
@@ -78,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}')"
@@ -92,6 +95,7 @@ module Ecoportal
               ids_ary = component_ids
               fields  = components
             end
+
             if after
               after_fld = fields.find do |fld|
                 found   = nil
@@ -100,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

@@ -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

@@ -29,6 +29,10 @@ 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
@@ -44,6 +48,35 @@ module Ecoportal
           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
+
       end
     end
   end

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.12"
+    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.12
+  version: 0.8.13
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler