ecoportal-api-v2 0.8.17 → 0.8.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b34fee0d135768fa89e14303a3f7d334eb51c961c29759d471d3151bf7f4c973
-  data.tar.gz: 32ed7cdfb74f7278d938a98ff730edd545391a1304fb369864400a1cccebaf62
+  metadata.gz: dfc9e699414df7fd4298148668b5b0a95759dc114758614d29da2ba7bc6472de
+  data.tar.gz: d589c4f84d7f0d55912d6542129bdebc74d599730a8980c1ec83b8317b7dd942
 SHA512:
-  metadata.gz: 3cfce53a0eeff5e7bd1d5256638a53e4537118f6b77e36c36cac3ceb89d9fb16b8765c583ba771f970ba888f4eac2081ecda3f94d592822d90724c51999a9d4f
-  data.tar.gz: b59bfa83a0c4ea3ab05a02ff305208d26fd8986d8ef995701fcb1ca730571d44d1198a3e03a51f1842d51d3232c40af1317ce3f73edd04f18864319604b01a47
+  metadata.gz: 901028e62fb4e10920918815635a7b99b54fb058ab0c79514a338373aa3b9e6b200757f26912876c2b7bf97201e3958353795dea870e7dbc3154e4e1ad578954
+  data.tar.gz: 85951a26535f34d0cbbc66d35410c8059b83df436359fea19e478196db2b93496f8a17ac0fe048ef231309f2684546fac4cc037076ffb0603b54d03ccb0de22c

data/CHANGELOG.md

@@ -1,10 +1,50 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.17] - 2021-09-29
+## [0.8.21] - 2021-12-15
 
 ### Added
+  - To children of `Ecoportal::API::V2::Page::Component` added method `#to_s` (for exporting)
+  - `Ecoportal::API::V2::Page::Component::ReferenceField`
+    - added `#references` (the lookup results)
+    - added `#reference_ids` (the `ids` of the referenced oozes)
+
+### Changed
+  - Re-exposed `Ecoportal::API::V2::Stages#ordered`
+  
+### Fixed
+  - `Ecoportal::API::V2::Page::Component::ImagesField#images` typo in `klass`
+
+## [0.8.20] - 2021-12-09
+
 ### Changed
+  - `Ecoportal::API::V2::Pages::PageStage#permits` removed
+    - The reason is that it should be changed using the `Stage#permits` instead
+  - Upgraded `ecoportal-api` gem dependency
+
+### Fixed
+  - `Ecoportal::API::V2::Page::Stage#sections` typo
+
+## [0.8.19] - 2021-09-29
+
+### Changed
+  - Moved validation of components multi-section from `PageStage` to `Page`
+  - Removed validation from `PageStage#as_update`
+    - This means that the validation will not run natively, but in the client lib
+
+### Fixed
+  - `Ecoportal::V2::Page::Stage#section?` fixed typo
+  - `Ecoportal::V2::Page::Stage`
+    - `#attached?` added missing code
+    - `#component?` fixed typo
+
+## [0.8.18] - 2021-09-29
+
+### Fixed
+  - typo in `PageStage#validate`
+
+## [0.8.17] - 2021-09-29
+
 ### Fixed
   - Typo in `Section#attached?`
 

data/ecoportal-api-v2.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
   spec.add_development_dependency "pry"      , ">= 0.14"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.8.3', '< 0.9'
+  spec.add_dependency 'ecoportal-api', '>= 0.8.4', '< 0.9'
 end

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

@@ -55,6 +55,10 @@ module Ecoportal
             doc.tap {|d| d.uniq! if uniq?}
           end
 
+          def to_s(delimiter: "|")
+            map(&:to_s).join(delimiter)
+          end
+
           # @see #_items
           # @return [Array] a **copy** of the `Array` elements
           def to_a

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

@@ -29,6 +29,19 @@ module Ecoportal
             passthrough :duration_in_days, read_only: true
             passarray   :file_container_ids
 
+            def to_s
+              stat = case
+                when overdue
+                  "Overdue"
+                when complete
+                  "Complete"
+                else
+                  "Pending"
+              end
+              assignee = assigned_person_member["name"] || assigned_person_member["email"]
+              "#{name}, #{created_at.to_s}, #{stat}, #{assignee}"
+            end
+
           end
         end
       end

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

@@ -30,6 +30,10 @@ module Ecoportal
               end
             end
 
+            def to_s(delimiter: "\n")
+              ordered_tasks.map(&:to_s).join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:requires` required number of completed actions

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

@@ -24,6 +24,10 @@ module Ecoportal
               end
             end
 
+            def to_s(delimiter: "\n")
+              ordered_items.map(&:to_s).compact.join(delimiter)
+            end
+
             private
 
             def fix_item_weights!

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

@@ -19,6 +19,10 @@ module Ecoportal
             passthrough :label
             passthrough :weight
             passboolean :checked
+
+            def to_s
+              checked ? label : nil
+            end
           end
         end
       end

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

@@ -34,6 +34,10 @@ module Ecoportal
               doc["create_event"] = !!value
             end
 
+            def to_s
+              value.to_s
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:time` to show time

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

@@ -19,6 +19,10 @@ module Ecoportal
             passthrough :file_size, :content_type, :token, read_only: true
             passthrough :file_container_id
             passdate    :file_update_at, read_only: true
+
+            def to_s
+              file_container_id
+            end
           end
         end
       end

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

@@ -24,6 +24,10 @@ module Ecoportal
               end
             end
 
+            def to_s(delimiter: "\n")
+              ordered_files.map(&:to_s).join(delimiter)
+            end
+
             private
 
             def fix_file_positions!

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

@@ -26,6 +26,9 @@ module Ecoportal
               end
             end
 
+            def to_s
+              value.to_s
+            end
           end
         end
       end

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

@@ -5,6 +5,10 @@ module Ecoportal
         class Component
           class GeoCoordinates < Common::Content::DoubleModel
             passthrough :lat, :lon
+
+            def to_s
+              "#{lat},#{lon}" if lat & lon
+            end
           end
         end
       end

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

@@ -6,6 +6,10 @@ module Ecoportal
           class GeoField < Page::Component
             passthrough :address
             embeds_one  :coordinates, klass: "Ecoportal::API::V2::Page::Component::GeoCoordinates"
+
+            def to_s
+              coordinates.to_s
+            end
           end
         end
       end

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

@@ -15,7 +15,11 @@ module Ecoportal
 
             passthrough :layout
             passboolean :strech, :no_popup, :hide_options
-            embeds_many :images, klass: "Ecoportal::API::V2::Page::Image", order_key: :weight
+            embeds_many :images, klass: "Ecoportal::API::V2::Page::Component::Image", order_key: :weight
+
+            def to_s
+              images.count
+            end
 
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]

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

@@ -40,6 +40,10 @@ module Ecoportal
               viewable_fields.delete!(field_id)
             end
 
+            def to_s(delimiter: "\n")
+              people_ids.join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:snapshot` to set mode to `snapshot`

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

@@ -9,6 +9,10 @@ module Ecoportal
             passthrough :max_length
             passboolean :exact_index
 
+            def to_s
+              value
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:multiline` multi line mode

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

@@ -5,10 +5,21 @@ module Ecoportal
         class Component
           class ReferenceField < Page::Component
             passthrough :register_id
+            passarray   :references
             passboolean :hide_create, :hide_attach
             passboolean :hide_metadata, :hide_dashboards
             passboolean :display_fields, :display_fields_in_lookup
 
+            def reference_ids
+              references.map do |ref|
+                ref["id"]
+              end
+            end
+
+            def to_s(delimiter: "\n")
+              reference_ids.to_a.join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:show_fields` specify if the public register fields should be shown (requires `register_id`)

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

@@ -5,6 +5,23 @@ module Ecoportal
         class Component
           class RichTextField < Page::Component
             passthrough :content
+
+            HTML_TAGS_REX = /<("[^"]*"|'[^']*'|[^'">])*>/
+
+            def to_s
+              remove_html_tags(content)
+            end
+
+            private
+
+            def remove_html_tags(str)
+              str = str.gsub(HTML_TAGS_REX, ' ')  if str
+              str = str.gsub(/[^[:print:]]/, '') if str
+              str = str.gsub(":&nbsp;", ' ')     if str
+              str = str.gsub("&#34;", '"')       if str
+              str = str.gsub("&amp;", '&')       if str
+              str
+            end
           end
         end
       end

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

@@ -63,6 +63,12 @@ module Ecoportal
               end
             end
 
+            def to_s(name: true, delimiter: "\n")
+              [selected].flatten.compact.map do |opt|
+                name ? opt.name : opt.value
+              end.join(delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:flat` to display in flat mode

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

@@ -7,6 +7,10 @@ module Ecoportal
             passboolean :single_select, :use_defaults
             passthrough :tag_tree_id, :button_text
 
+            def to_s(delimiter: "\n")
+              root.tags.to_s(delimiter: delimiter)
+            end
+
             # Quick config helper
             # @param conf [Symbol, Array<Symbol>]
             #   - `:multiple` to allow multiple selection

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

@@ -110,7 +110,7 @@ module Ecoportal
           # 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)}
+            ooze.sections.find {|sec| sec.component?(id)}
           end
 
           # @return [Boolean] whether or not this field is attached to any section.

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

@@ -45,7 +45,7 @@ module Ecoportal
 
           # @return [Boolean] whether or not the section appears in an ooze instance
           def attached?
-            !ooze.stages? || stages.any?
+            !ooze.stages? || stages.any? {|stg| stg.section?(self)}
           end
 
           # @return [Boolean] whether or not this section is a split section
@@ -67,7 +67,7 @@ module Ecoportal
             when Ecoportal::API::V2::Page::Component
               component?(com_or_id.id)
             when String
-              all_component_ids.include?(id)
+              all_component_ids.include?(com_or_id)
             else
               msg = "Missuse: com_or_id should be a Component or a String. Given: #{com_or_id.class}"
               raise ArgumentError.new(msg)

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

@@ -28,7 +28,7 @@ module Ecoportal
             sec_ids = section_ids.to_a
             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))
+              sec && (!block_given? || yield(sec))
             end.sort_by.with_index {|sec, index| [sec.weight, index]}
           end
 
@@ -41,7 +41,7 @@ module Ecoportal
             when Ecoportal::API::V2::Page::Section
               section?(sec_or_id.id)
             when String
-              self.section_ids.include?(id)
+              self.section_ids.include?(sec_or_id)
             else
               raise ArgumentError.new("sec_or_id must be either a Section or a String. Given: #{sec_or_id.class}")
             end

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

@@ -19,11 +19,11 @@ module Ecoportal
             end
           end
 
-          #def ordered
-          #  self.sort_by.with_index do |stage, index|
-          #    [stage.ordering, index]
-          #  end
-          #end
+          def ordered
+            self.sort_by.with_index do |stage, index|
+              [stage.ordering, index]
+            end
+          end
 
         end
       end

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

@@ -54,6 +54,20 @@ module Ecoportal
           self.stages.count > 0
         end
 
+        # @return [String] with feedback, if for this page instance, there are any of:
+        #   1. components multi-section (fields belonging to more than one section)
+        def validate
+          msg = ""
+          if (multi = components.multi_section).length > 0
+            msg += "There are fields attached to more than one section:\n  • "
+            msg += multi.map do |fld|
+              fld.label
+            end.join("\n  • ") + "\n"
+          end
+
+          msg.empty?? true : msg
+        end
+
         private
 
         def _doc_bug_fix(hash)

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

@@ -7,7 +7,7 @@ module Ecoportal
           passthrough :task_priority, :state, :status
           passthrough :votes_enabled, :upvotes, :downvotes
 
-          embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
+          #embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
           passarray   :force_errors, :subtags, order_matters: false
 
           # @return [String] `id` of the stage we got the data of.
@@ -22,39 +22,25 @@ module Ecoportal
             end
           end
 
-          # @raise [Exception] if for this page instance, there are any of:
+          # @return [String] with feedback, if for this page instance, there are any of:
           #   1. orphaned components (fields not belonging to any section)
-          #   2. components multi-section (fields belonging to more than one section)
-          #   3. orphaned sections (sections not belonging to any stage)
-          def as_update(*args, **kargs)
-            validate.tap do |validation|
-              raise validation if validation.is_a?(String)
-            end
-            super(*args, **kargs)
-          end
-
-          private
-
+          #   2. orphaned sections (sections not belonging to any stage)
           def validate
-            msg   = ""
-            if (orphans = components.unattached).length > 0
-              msg += "There are fields not attached to any sections:"
-              msg += orphans.map do |fld|
-                fld.label
-              end.join("\n  • ") + "\n"
-            end
+            msg  = super
+            msg  = "" unless msg.is_a?(String)
 
-            if (multi = components.multi_section).length > 0
-              msg += "There are fields attached to more than one section:"
+            orphans = components.unattached.select {|comp| comp.global_binding.to_s.strip.empty?}
+            if orphans.length > 0
+              msg += "There are fields not attached to any sections:\n  • "
               msg += orphans.map do |fld|
                 fld.label
               end.join("\n  • ") + "\n"
             end
 
             if (orphans = sections.unattached).length > 0
-              msg += "There are sections not attached to any stage:"
+              msg += "There are sections not attached to any stage:\n  • "
               msg += orphans.map do |sec|
-                "'#{sec.header}' (#{sec.id})"
+                "'#{sec.heading}' (#{sec.id})"
               end.join("\n  • ") + "\n"
             end
             msg.empty?? true : msg

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.17"
+    GEM2_VERSION = "0.8.21"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.17
+  version: 0.8.21
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -140,7 +140,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'