ecoportal-api-v2 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6779bebb389337e0a18e355c36cbb5c2ba0ed84f31b7cdbca3bec051a30bd2
-  data.tar.gz: 32e9cc407394ef5ae7ef56f87650180789d229930daf5d7e65d44c33768041ca
+  metadata.gz: 44e2e864edc50d00dc9bf4f0d76f75904c518b46e2bd66fea8326329d1056e6a
+  data.tar.gz: bef29f826e284736b16c5c6587039822b17052abee27da1764b9c46b3cf2c13b
 SHA512:
-  metadata.gz: f2e84e20a4952e07ce7575f98a32b7cd216dbdc163fed0dcf9b9e383062e509d0702cff679b51e02b235afa0b68add386638d41eb5dc7cfcaaabfd965288530b
-  data.tar.gz: d0b3a2d2043a31cca656c98a812dc2e632ae565c121cc85991c211b51acafebb58206be305dbc9da1fcfaf23acc83218ddb1db952d43b76fb5fccc1bc933bde9
+  metadata.gz: 4497df74b329f61934ab456958aaf3a0f9cd2ede10ed488dda7dc003d1ac2f4f5ab637034ef30b6d726b7b7ca5c9f56140bb2f8ac865f759dc376b4ebb489e49
+  data.tar.gz: 0b13d22da55564d605283fc9a0a325dfc863f137079309f2989ee721fc3163a21fe94f9530610df293b1802fcc3d7127bba8d23f6390c4cde459209c6f3a5a45

data/CHANGELOG.md

@@ -1,12 +1,41 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.9.2] - 2022-09-26
+## [0.9.4] - 2022-10-xx
 
 ### Added
 ### Changed
 ### Fixed
 
+## [0.9.3] - 2022-10-11
+
+### Added
+  - `Ecoportal::API::V2::Page` **methods** `#mark_as_submit` and `#mark_as_sign_off`
+
+### Changed
+  - `Ecoportal::API::V2::Pages#get_new`, to return an object of class `Ecoportal::API::V2::Pages::PageStage`
+
+### Fixed
+  - Remove debugging message
+
+## [0.9.2] - 2022-09-29
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::SelectionOption#delete!`
+  - `Ecoportal::API::V2::Page::Component#delete!`
+  - `Ecoportal::API::V2::Page::Component#move` to move to another section or side of the same
+  - `Ecoportal::API::V2::Page::Component#unattach!` to detach the component from any section
+  - `Ecoportal::API::V2::Page::Component::SelectionOption#delete!`
+  - `Ecoportal::API::V2::Page::Component::Binding#delete!`
+  - `Ecoportal::API::V2::Page::Section#remove_component!` to simplify the removal of a field from the section
+
+### Changed
+  - `Ecoportal::API::V2::Page::Component::SelectionField#options`
+    - **added** and moved logics to `Ecoportal::API::V2::Page::Component::SelectionOptions`
+  - `Ecoportal::API::V2::Page::Component::SelectionOption#name` to return `#value` when it's empty
+
+### Fixed
+  - Remove debugging message
 
 ## [0.9.1] - 2022-09-26
 
@@ -16,9 +45,6 @@ All notable changes to this project will be documented in this file.
 ### Changed
   - `Ecoportal::API::V2::Page::Force`, logic around `helpers` (remote forces)
     - **breaking change**: `script` is not writable anymore. You should use `custom_script` instead.
-    
-### Fixed
-
 
 ## [0.8.33] - 2022-09-23
 

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

@@ -278,7 +278,6 @@ module Ecoportal
               _items.delete(value)
             end
           end
-
         end
       end
     end

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

@@ -240,7 +240,6 @@ module Ecoportal
             def model_forced_keys
               @forced_model_keys ||= {}
             end
-
           end
 
           inheritable_class_vars :forced_model_keys, :key

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

@@ -7,8 +7,7 @@ module Ecoportal
             passboolean :multiple, :flat, :other
             passthrough :other_desc
             passthrough :data_type
-
-            embeds_many :options, klass: "Ecoportal::API::V2::Page::Component::SelectionOption", order_key: :weight
+            embeds_many :options, enum_class: "Ecoportal::API::V2::Page::Component::SelectionOptions"
 
             def numeric?
               self.data_type == "num"
@@ -19,12 +18,12 @@ module Ecoportal
             end
 
             def numeric!(&block)
-              ordered_options.each {|opt| opt.numeric!(&block)}
+              options.ordered.each {|opt| opt.numeric!(&block)}
               self.data_type = "num"
             end
 
             def text!(&block)
-              ordered_options.each {|opt| opt.text!(&block)}
+              options.ordered.each {|opt| opt.text!(&block)}
               self.data_type = "str"
             end
 
@@ -33,7 +32,7 @@ module Ecoportal
             end
 
             def select(value_name, by_name: false)
-              opt = find_option(value_name, by_name: by_name)
+              opt = options.find_option(value_name, by_name: by_name)
               sel = selected
               return true if !multiple && opt == sel
               sel.selected = false if !multiple && sel
@@ -41,7 +40,7 @@ module Ecoportal
             end
 
             def deselect(value_name, by_name: false)
-              if opt = find_option(value_name, by_name: by_name)
+              if opt = options.find_option(value_name, by_name: by_name)
                 opt.selected = false
               end
             end
@@ -50,17 +49,17 @@ module Ecoportal
               case
               when by_value
                 elems = [selected].flatten.compact
-                options_hash(elems) do |option|
+                options.hash(elems) do |option|
                   name ? option.name : option
                 end
               when by_name
                 elems = [selected].flatten.compact
-                options_hash(elems, by_name: true) do |option|
+                options.hash(elems, by_name: true) do |option|
                   value ? option.value : option
                 end
               else
                 if multiple
-                  ordered_options.select {|opt| opt.selected}
+                  options.ordered.select {|opt| opt.selected}
                 else
                   options.find {|opt| opt.selected}
                 end
@@ -91,43 +90,23 @@ module Ecoportal
               [name].flatten.compact
             end
 
-            def add_option(value:, name: nil, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-              opt_doc = options.items_class.new_doc
-              options.upsert!(opt_doc, pos: pos, before: before, after: after) do |option|
-                option.name  = name
-                option.value = value
-                if prev = previous_option(option)
-                  option.weight = prev.weight
-                end
-                yield(option) if block_given?
-                fix_option_weights!
-              end
+            # @see Ecoportal::API::V2::Component::SelectionOptions#add
+            def add_option(**kargs, &block)
+              options.add(**kargs, &block)
             end
 
             def ordered_options
-              options.sort_by.with_index do |option, index|
-                [option.weight, index]
-              end
+              options.ordered
             end
 
-            # @param name [Boolean] whether or not the values of the `Hash` should be the `names`
-            # @return [Hash] of **key** _value_ and **value**:
-            #   1. _option_ if `name` is `false`
-            #   2. _name_ if `name` is `true`
+            # @see Ecoportal::API::V2::Component::SelectionOptions#by_value
             def options_by_value(name: false)
-              options_hash do |option|
-                name ? option.name : option
-              end
+              options.by_value(name: name)
             end
 
-            # @param value [Boolean] whether or not the values of the `Hash` should be the `values`
-            # @return [Hash] of **key** _name_ and **value**:
-            #   1. _option_ if `value` is `false`
-            #   2. _value_ if `value` is `true`
+            # @see Ecoportal::API::V2::Component::SelectionOptions#by_name
             def options_by_name(value: false)
-              options_hash(by_name: true) do |option|
-                value ? option.value : option
-              end
+              options.by_name(value: value)
             end
 
             def to_s(value: true, delimiter: "\n")
@@ -198,34 +177,6 @@ module Ecoportal
                 end
               end
             end
-
-            def fix_option_weights!
-              ordered_options.each_with_index do |option, index|
-                option.weight = index
-              end
-            end
-
-            def previous_option(value)
-              opts = ordered_options
-              pos  = opts.index(value) - 1
-              return if pos < 0
-              opts[pos]
-            end
-
-            def find_option(value_name, by_name: false)
-              if by_name
-                opt = options.find {|opt| same_string?(opt.name, value_name)}
-              else
-                opt = options.find {|opt| opt.value == value_name}
-              end
-            end
-
-            def options_hash(elems = ordered_options, by_name: false)
-              elems.each_with_object({}) do |option, hash|
-                key = by_name ? option.name : option.value
-                hash[key] = block_given?? yield(option) : option
-              end
-            end
           end
         end
       end
@@ -233,4 +184,5 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/v2/page/component/selection_options'
 require 'ecoportal/api/v2/page/component/selection_option'

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

@@ -4,7 +4,6 @@ module Ecoportal
       class Page
         class Component
           class SelectionOption < Common::Content::DoubleModel
-
             class << self
               def new_doc
                 {
@@ -20,6 +19,14 @@ module Ecoportal
             passthrough :weight
             passboolean :selected
 
+            def name
+              doc["name"] || "#{value}"
+            end
+
+            def delete!
+              _parent.delete!(self)
+            end
+
             def numeric!
               self.value = block_given?? yield(value) : to_i(value)
             end

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

@@ -0,0 +1,93 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class SelectionOptions < Common::Content::CollectionModel
+            class_resolver :option_class, "Ecoportal::API::V2::Page::Component::SelectionOption"
+
+            self.klass = :option_class
+            self.order_key = :weight
+
+            def component
+              self._parent
+            end
+
+            def ooze
+              component.ooze
+            end
+
+            def add(value:, name: nil, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              opt_doc = items_class.new_doc
+              upsert!(opt_doc, pos: pos, before: before, after: after) do |option|
+                option.name  = name
+                option.value = value
+                if prev = previous_option(option)
+                  option.weight = prev.weight
+                end
+                yield(option) if block_given?
+                fix_weights!
+              end
+            end
+
+            def find_option(value_name, by_name: false)
+              if by_name
+                opt = self.find {|opt| same_string?(opt.name, value_name)}
+              else
+                opt = self.find {|opt| opt.value == value_name}
+              end
+            end
+
+            def ordered
+              self.sort_by.with_index do |option, index|
+                [option.weight, index]
+              end
+            end
+
+            # @param name [Boolean] whether or not the values of the `Hash` should be the `names`
+            # @return [Hash] of **key** _value_ and **value**:
+            #   1. _option_ if `name` is `false`
+            #   2. _name_ if `name` is `true`
+            def by_value(name: false)
+              hash do |option|
+                name ? option.name : option
+              end
+            end
+
+            # @param value [Boolean] whether or not the values of the `Hash` should be the `values`
+            # @return [Hash] of **key** _name_ and **value**:
+            #   1. _option_ if `value` is `false`
+            #   2. _value_ if `value` is `true`
+            def by_name(value: false)
+              hash(by_name: true) do |option|
+                value ? option.value : option
+              end
+            end
+
+            def hash(elems = ordered, by_name: false)
+              elems.each_with_object({}) do |option, hash|
+                key = by_name ? option.name : option.value
+                hash[key] = block_given?? yield(option) : option
+              end
+            end
+
+            private
+
+            def fix_weights!
+              ordered.each_with_index do |option, index|
+                option.weight = index
+              end
+            end
+
+            def previous_option(value)
+              opts = ordered
+              pos  = opts.index(value) - 1
+              return if pos < 0
+              opts[pos]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -118,6 +118,16 @@ module Ecoportal
             !!section
           end
 
+          # Unattaches the field from any section
+          # @note please make sure to reattach or delete! the field before save
+          def unattach!
+            ooze.sections.select do |sec|
+              sec.component?(id)
+            end.each do |sec|
+              sec.remove_component!(self)
+            end
+          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)}
@@ -144,6 +154,17 @@ module Ecoportal
             forces.count > 0
           end
 
+          def delete!
+            bindings.each {|b| b.delete!}
+            self.unattach!
+            self._parent.delete!(self)
+          end
+
+          def move(section:, before: nil, after: nil, side: nil)
+            self.unattach!
+            section.add_component(self, before: before, after: after, side: side)
+          end
+
           def indexable_label(any_length: false)
             self.class.indexable_label(label, any_length: any_length)
           end

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

@@ -52,6 +52,10 @@ module Ecoportal
             def reference
               self.component? ? component : section
             end
+
+            def delete!
+              self._parent.delete!(self)
+            end
           end
         end
       end

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

@@ -174,7 +174,6 @@ module Ecoportal
                 get_by_name(value).first
               end
             end
-
           end
         end
       end

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

@@ -7,6 +7,7 @@ module Ecoportal
 
           self.klass    = :force_class
           order_matters = true
+          self.order_key = :weight
 
           def ooze
             self._parent.ooze

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

@@ -83,6 +83,27 @@ module Ecoportal
             left_component_ids.to_a | right_component_ids.to_a
           end
 
+          # @note when removing a component, please make sure to either
+          #   add it to another section or to delete! it before save
+          def remove_component!(*comps_or_ids)
+            comps_or_ids.each do |com_or_id|
+              case com_or_id
+              when Ecoportal::API::V2::Page::Component
+                remove_component!(com_or_id.id)
+              when String
+                if split?
+                  left_component_ids.delete!(com_or_id)
+                  right_component_ids.delete!(com_or_id)
+                else
+                  component_ids.delete!(com_or_id)
+                end
+              else
+                msg = "Missuse: com_or_id should be a Component or a String. Given: #{com_or_id.class}"
+                raise ArgumentError.new(msg)
+              end
+            end
+          end
+
           # @raise [ArgumentError] if `com_or_id` is not of any of the allowed types
           # @param com_or_id [Ecoportal::API::V2::Page::Component, String] Component or `id` thereof
           # @return [Boolean] whether or not a component/field belongs to this section.
@@ -98,14 +119,32 @@ module Ecoportal
             end
           end
 
+          # @return[Symbol, Nil] might be `:right`, maybe `:left`, or `nil`
+          def component_side(com_or_id)
+            return nil unless split?
+            case com_or_id
+            when Ecoportal::API::V2::Page::Component
+              component_side(com_or_id.id)
+            when String
+              if left_component_ids.include?(com_or_id)
+                :left
+              elsif right_component_ids.include?(com_or_id)
+                :right
+              end
+            else
+              msg = "Missuse: com_or_id should be a Component or a String. Given: #{com_or_id.class}"
+              raise ArgumentError.new(msg)
+            end
+          end
+
           # It looks up the components that belong to this section.
           # @return [Array<Ecoportal::API::V2::Page::Component>]
           def components(side: nil)
             case side
             when :right
-              components_right
+              right_components
             when :left
-              components_left
+              left_components
             when NilClass
               components_by_id(*all_component_ids)
             else
@@ -116,7 +155,7 @@ module Ecoportal
           # It looks up the components that belong to the `left` side of this section.
           # @raise [Exception] if this is not a `split` section
           # @return [Array<Ecoportal::API::V2::Page::Component>]
-          def components_left
+          def left_components
             raise "You are trying to retrieve side components in a Split Section" unless split?
             components_by_id(*left_component_ids)
           end
@@ -124,7 +163,7 @@ module Ecoportal
           # It looks up the components that belong to the `right` side of this section.
           # @raise [Exception] if this is not a `split` section
           # @return [Array<Ecoportal::API::V2::Page::Component>]
-          def components_right
+          def right_components
             raise "You are trying to retrieve side components in a Split Section" unless split?
             components_by_id(*right_component_ids)
           end
@@ -159,9 +198,13 @@ module Ecoportal
             end
 
             if before
-              before_fld = to_component(before, side: side)
+              if before_fld = to_component(before, side: side)
+                side ||= component_side(before_fld)
+              end
             elsif after
-              after_fld  = to_component(after, side: side)
+              if after_fld  = to_component(after, side: side)
+                side ||= component_side(after_fld)
+              end
             end
 
             if split?
@@ -176,20 +219,14 @@ module Ecoportal
           private
 
           def components_by_id(*ids)
-            root.components.values_at(*ids).select.with_index do |fld, i|
+            ooze.components.values_at(*ids).select.with_index do |fld, i|
               puts "Warning: field id #{ids[i]} points to missing field" if !fld
               fld && (!block_given? || yield(fld))
             end
           end
 
           def to_component(value, side: nil)
-            if split?
-              fields  = components(side: side || :left)
-            else
-              fields  = components
-            end
-
-            fields.find do |fld|
+            components(side: side).find do |fld|
               found   = nil
               found ||= fld.id == value.id if value.is_a?(Ecoportal::API::V2::Page::Component)
               found ||= fld.id == value

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

@@ -6,7 +6,8 @@ module Ecoportal
           class_resolver :section_class, "Ecoportal::API::V2::Page::Section"
 
           self.klass = :section_class
-
+          self.order_key = :weight
+          
           def ooze
             self._parent.ooze
           end

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

@@ -6,7 +6,8 @@ module Ecoportal
           class_resolver :stage_class, "Ecoportal::API::V2::Page::Stage"
 
           self.klass = :stage_class
-
+          self.order_key = :ordering
+          
           def ooze
             self._parent.ooze
           end

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

@@ -60,6 +60,16 @@ module Ecoportal
             end
             msg.empty?? true : msg
           end
+
+          def mark_as_submit
+            doc["submitted"] = true
+            doc["type"] = "complete_page"
+          end
+
+          def mark_as_sign_off
+            doc["sign_off"] = true
+            doc["type"] = "review_page"
+          end
         end
       end
     end

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

@@ -9,6 +9,7 @@ module Ecoportal
 
         class_resolver :stages_class, "Ecoportal::API::V2::Pages::Stages"
         class_resolver :page_class,  "Ecoportal::API::V2::Page"
+        class_resolver :page_stage_class,  "Ecoportal::API::V2::Pages::PageStage"
         class_resolver :create_page_response_class,  "Ecoportal::API::V2::Pages::PageCreateResponse"
 
         attr_reader :client
@@ -65,7 +66,7 @@ module Ecoportal
         def get_new(from)
           id       = get_id(from)
           response = client.get("/pages/new", params: {template_id: id})
-          wrapped  = Common::Content::WrappedResponse.new(response, page_class)
+          wrapped  = Common::Content::WrappedResponse.new(response, page_stage_class)
 
           return wrapped.result if wrapped.success?
           raise "Could not get new page from template #{id} - Error #{response.status}: #{response.body}"

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.9.1"
+    GEM2_VERSION = "0.9.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-25 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -216,6 +216,7 @@ files:
 - lib/ecoportal/api/v2/page/component/rich_text_field.rb
 - lib/ecoportal/api/v2/page/component/selection_field.rb
 - lib/ecoportal/api/v2/page/component/selection_option.rb
+- lib/ecoportal/api/v2/page/component/selection_options.rb
 - lib/ecoportal/api/v2/page/component/signature_field.rb
 - lib/ecoportal/api/v2/page/component/tag_field.rb
 - lib/ecoportal/api/v2/page/components.rb