ecoportal-api-v2 0.8.8 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d7fd0373344854c22b4397e7e2d2645dd799695424f3fa30d006fca2081676d
-  data.tar.gz: 2d839f8ecb67512c2c5d00a2bd6832e53d304334f2c5a6bbc291958661e21130
+  metadata.gz: 5833ea731a9d1360c346264d234ce9f95266db92a5480180a17f413459f196de
+  data.tar.gz: f3ef175580d2ab47c0ee7f51dc2731c0b42bd27ffa9f59600fb506d5cde38a4b
 SHA512:
-  metadata.gz: 27425f592041428b0d07f9593c78f2a80095311e4890a3569ce212e37f067a3b36f2a3b147459e7dca368f7a737671ac9325df6ed40cec3d4a18f75d0ea18d28
-  data.tar.gz: c4cee01feb2c89179da4eda1d3699e5900812b52fb7d198a1447935ac4e89c347bee56ba69c5f6d1a407f968da21112cf0a490855811ddfd5048caace430c422
+  metadata.gz: 52064ec37a32470e699f846ac1c6c57f8f535fb0be1d689a4f086836a47f9fb2805c0f84533842f5aaa4ee9e538c60e61c1569177ae16a015520c65248347174
+  data.tar.gz: 0f8cd291558cad37b5157dba7ffdea6670548952b6aa5b0c90b34820abd2693d8f484009265bbc4c8c83fb46684f2968e9a40d4a65563e0ffc6704cca30885d0

data/CHANGELOG.md

@@ -1,7 +1,43 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.8] - 2021-06-xx
+## [0.8.9] - 2021-06-xx
+
+### Added
+  - `Ecoportal::API::Common::Content::ModelHelpers`
+    - Starting with `#same_string?`, this lib aims to offer a full set of helper comparers.
+  - `Ecoportal::API::V2::Page::Components#get_by_id`
+    - In future changes, method `[]` might be overriding the method of the parent class `CollectionModel`.
+  - `Ecoportal::API::V2::Page::PermissionFlags` to offer support to `can_permission`, `subscribed`, etc.
+  - `Ecoportal::API::V2::Page::Section#add_component` super handy helper to add fields to sections.
+  - `Ecoportal::API::V2::Page::Component::PeopleField#delete` to remove people using their ids.
+  - `Ecoportal::API::V2::Page::Component::GeoField` **added** suport for `#coordinates`
+    - With embedded object `Ecoportal::API::V2::Page::Component::GeoCoordinates`
+  - `#configure` method, to all the `Component` types (but `ChartField` s)
+    - This method allows to quickly set field properties.
+  - `Ecoportal::API::V2::Page::Sections#between`, aiming to obtain sections between two other ones
+
+
+### Changed
+  - `Ecoportal::API::V2::Page::Section` real support for `split` sections (right vs left)
+    - This is actually a **FIX**
+  - `Ecoportal::API::V2::Page::Component::DateField#create_event`
+    - Now it switches to _allow future dates_
+  - `Ecoportal::API::V2::Page::Component::SelectionField#add_option`, the `name` parameter is now optional
+    - This change aims to make it consistent with the back-end.
+  - To its actual `Boolean` type some properties
+    - All `Component` types
+
+### Fixed
+  - `Ecoportal::API::Common::Content::HashDiffPatch` did not support `Hash` values without `id` or `patch_ver`
+    - This fix should allow them to flow to the update
+  - `Ecoportal::API::V2::Page::Component::ChartField` did not have `doc` for `mode` based configuration
+  - `Ecoportal::API::Common::Content::ArrayModel#insert_one`
+    - When `pos`, `before` & `after` were `nil` it was failing to attach the element.
+  - `Ecoportal::API::V2::Page::Sections#add` was not adding in the correct order
+  - `Ecoportal::API::V2::Page::Section.new_doc` was unnecessarily giving `9999` as default weight
+
+## [0.8.8] - 2021-08-03
 
 ### Added
   - `Ecoportal::API::V2::Page::Component::ChartField::Benchmark`
@@ -10,8 +46,7 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
   - Removed `Stages.ordered_stages`: detected bug with Enumerable iteration
-  
-### Fixed
+
 
 ## [0.8.7] - 2021-05-25
 

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

@@ -9,6 +9,7 @@ end
 
 require 'ecoportal/api/common/content/class_helpers'
 require 'ecoportal/api/common/content/string_digest'
+require 'ecoportal/api/common/content/model_helpers'
 require 'ecoportal/api/common/content/double_model'
 require 'ecoportal/api/common/content/array_model'
 require 'ecoportal/api/common/content/collection_model'

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

@@ -3,7 +3,8 @@ module Ecoportal
     module Common
       module Content
         # Class to handle a plain Array embedded in a Hashed model.
-        # @note its purpose is to handle an Array of basic objects (i.e. `Date`, `String`, `Number`)
+        # @note
+        #   - Its purpose is to handle an Array of basic objects (i.e. `Date`, `String`, `Number`)
         class ArrayModel < Content::DoubleModel
           class TypeMismatchedComparison < Exception
             def initialize (this: nil, that: msg = "Trying to compare objects with different behavior.")
@@ -222,15 +223,16 @@ module Ecoportal
           def insert_one(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             i = index(value)
             return i if (i && uniq?)
-
             pos = case
                   when used_param?(pos)
-                    pos
+                    pos || length
                   when used_param?(before)
-                    index(before)
+                    before ? index(before) : length
                   when used_param?(after)
-                    if i = index(after)
-                      i + 1
+                    if after
+                      if i = index(after) then i + 1 end
+                    else
+                      length
                     end
                   else
                     length

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

@@ -2,6 +2,9 @@ module Ecoportal
   module API
     module Common
       module Content
+        # CollectionModel aims to deal with Arrays of actual objects.
+        # @note to be able to refer to the correct element of the Collection,
+        #   it is required that those elements have a unique `key` that allows to identify them
         class CollectionModel < Content::DoubleModel
 
           class << self
@@ -167,6 +170,7 @@ module Ecoportal
             end
           end
 
+          # Deletes `value` from this `CollectionModel` instance
           def delete!(value)
             unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel)
               raise "'Content::DoubleModel' or 'Hash' doc required"
@@ -186,7 +190,7 @@ module Ecoportal
             variables_remove!
           end
 
-          # Gets the `key` of the object
+          # Gets the `key` of the object `value`
           def get_key(value)
             case value
             when Content::DoubleModel
@@ -235,10 +239,13 @@ module Ecoportal
             super
           end
 
+          # Deletes `value` from `doc` (here referred as `_doc_items`)
+          # @return [Object] the element deleted from `doc`
           def _doc_delete(value)
             if current_pos = _doc_key(value)
-              _doc_items.delete_at(current_pos)
-              on_change
+              _doc_items.delete_at(current_pos).tap do |deleted|
+                on_change
+              end
             end
           end
 
@@ -250,7 +257,6 @@ module Ecoportal
               when used_param?(before)
                 _doc_key(before)
               when used_param?(after)
-                #puts "to add after #{after.id}"
                 if i = _doc_key(after)
                   i + 1
                 end

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

@@ -10,6 +10,7 @@ module Ecoportal
         class DoubleModel < Common::BaseModel
           NOT_USED = Common::Content::ClassHelpers::NOT_USED
           extend Common::Content::ClassHelpers
+          include Common::Content::ModelHelpers
 
           class UnlinkedModel < Exception
             def initialize (msg = "Something went wrong when linking the document.", from: nil, key: nil)
@@ -109,6 +110,16 @@ module Ecoportal
               self
             end
 
+            # To link as a `Boolean` to a subjacent `Hash` model property
+            # @param read_only [Boolean] should it only define the reader?
+            def passboolean(*methods, read_only: false)
+              pass_reader(*methods) {|value| value}
+              unless read_only
+                pass_writer(*methods) {|value| !!value}
+              end
+              self
+            end
+
             # To link as plain `Array` to a subjacent `Hash` model property
             # @param order_matters [Boolean] does the order matter
             # @param uniq [Boolean] should it contain unique elements

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

@@ -85,31 +85,43 @@ module Ecoportal
             end
 
             def patch_delete(b)
-              return NO_CHANGES unless b.is_a?(Hash) && id = get_id(b, exception: false)
-              {
-                "id"        => id,
-                "operation" => "deleted",
-                "data"      => patch_data(b, delete: true)
-              }
+              return NO_CHANGES unless b.is_a?(Hash)
+              if id = get_id(b, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "deleted",
+                  "data"      => patch_data(b, delete: true)
+                }
+              else
+                nil
+              end
             end
 
             def patch_new(a)
-              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
-              {
-                "id"        => id,
-                "operation" => "new",
-                "data"      => patch_data(a)
-              }
+              return NO_CHANGES unless a.is_a?(Hash)
+              if id = get_id(a, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "new",
+                  "data"      => patch_data(a)
+                }
+              else
+                a
+              end
             end
 
             def patch_update(a, b)
-              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
-              {
-                "id"        => id,
-                "operation" => "changed",
-                "data"      => patch_data(a, b)
-              }.tap do |update_hash|
-                return nil unless update_hash["data"] != NO_CHANGES
+              return NO_CHANGES unless a.is_a?(Hash)
+              if id = get_id(a, exception: false)
+                {
+                  "id"        => id,
+                  "operation" => "changed",
+                  "data"      => patch_data(a, b)
+                }.tap do |update_hash|
+                  return nil unless update_hash["data"] != NO_CHANGES
+                end
+              else
+                a
               end
             end
 

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

@@ -0,0 +1,36 @@
+module Ecoportal
+  module API
+    module Common
+      module Content
+        module ModelHelpers
+
+          private
+
+          # Offers multiple ways to compare two strings
+          def same_string?(value1, value2, exact: false)
+            case
+            when value1.is_a?(String) && value2.is_a?(String)
+              if exact
+                value1 == value2
+              else
+                value1.to_s.strip.downcase == value2.to_s.strip.downcase
+              end
+            when value1.is_a?(Regexp) && value2.is_a?(String)
+              value2 =~ value1
+            when value1.is_a?(String) && value2.is_a?(Regexp)
+              value1 =~ value2
+            else
+              value1 == value2
+            end
+          end
+
+          def hash_except(hash, *keys)
+            keys.each {|key| hash.delete(key)}
+            hash
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -34,6 +34,7 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/v2/page/permission_flags'
 require 'ecoportal/api/v2/page/permit'
 require 'ecoportal/api/v2/page/component'
 require 'ecoportal/api/v2/page/components'

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

@@ -59,7 +59,6 @@ module Ecoportal
                 when "checklist"
                   checklist_field_class
                 when "page_action","checklist_task"
-                  #doc["type"] = "checklist_task"
                   action_field_class
                 when "file"
                   files_field_class
@@ -85,8 +84,9 @@ module Ecoportal
           passkey     :id
           passthrough :patch_ver, :undeletable
           passthrough :type, :label, :tooltip, :global_binding
-          passthrough :hidden, :accent, :deindex, :required
-          passthrough :hide_view, :hidden_on_reports, :hidden_on_mobile
+          passboolean :hidden, :deindex, :required
+          passthrough :accent
+          passboolean :hide_view, :hidden_on_reports, :hidden_on_mobile
           passarray   :refs
 
           def ref_backend
@@ -107,6 +107,36 @@ module Ecoportal
             self.class.indexable_label(label)
           end
 
+          # Quick config helper
+          # @param conf [Symbol, Array<Symbol>]
+          #   - `:required`
+          #   - `:hide_view` to hide in view mode
+          #   - `:hide_mobile` to hide in mobile app
+          #   - `:hide_reports` to hide in reports
+          #   - `:global` to define a global binding
+          def configure(*conf)
+            conf.each_with_object([]) do |cnf, unused|
+              case cnf
+              when :required
+                self.required  = true
+              when :hide_view
+                self.hide_view = true
+              when :hide_mobile
+                self.hidden_on_mobile = true
+              when :hide_reports
+                self.hidden_on_reports = true
+              when Hash
+                if cnf.key?(:global)
+                  self.global_binding = cnf[:global]
+                end
+              else
+                unused.push(cnf)
+              end
+            end.tap do |unused|
+              raise "Unsupported configuration options '#{unused}' for #{self.class}" unless unused.empty?
+            end
+          end
+
         end
       end
     end

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

@@ -12,14 +12,22 @@ module Ecoportal
                 }
               end
             end
-            
+
             passkey     :id
             passthrough :patch_ver, :name
-            passthrough :weight, :complete, :other_information
-            passdate    :due_date
-            pass_reader :overdue
+            passthrough :weight, :other_information
+            passboolean :complete
+
             passdate    :created_at, read_only: true #, :completed_at
-            pass_reader :created_by, :assigned_person_member_id
+            passthrough :created_by, read_only: true
+            passthrough :assigned_person_member_id, :assigned_person_member
+
+            passdate    :due_date, :reminder_date
+            passboolean :overdue, read_only: true
+
+            passthrough :duration_in_days, read_only: true
+            passarray   :file_container_ids
+
           end
         end
       end

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

@@ -4,9 +4,9 @@ module Ecoportal
       class Page
         class Component
           class ActionField < Page::Component
-            passthrough :create_actions
+            passboolean :create_actions
             passthrough :required_number_of_completed_actions
-            passthrough :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
+            passboolean :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
 
             embeds_many :actions, klass: "Ecoportal::API::V2::Page::Component::Action", order_key: :weight
 
@@ -30,8 +30,43 @@ module Ecoportal
               end.map(&:first)
             end
 
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:requires` required number of completed actions
+            #     - `:all`
+            #     - `#Number`
+            def configure(*conf)
+              self.create_actions = true
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when Hash
+                  supported = [:requires]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:requires) then configure_required(cnf[:requires]) end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
             private
 
+            def configure_required(req)
+              self.required = true
+              case req
+              when :all, NilClass
+                self.required_number_of_completed_actions = "all"
+              when Numeric
+                self.required_number_of_completed_actions = req
+              else
+                # Unsupported
+              end
+            end
+
             def fix_task_weights!
               ordered_tasks.each_with_index do |task, index|
                 task.weight = index

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

@@ -5,10 +5,14 @@ module Ecoportal
         class Component
           class ChartField < Page::Component
             passthrough :mode
-            passthrough :relative, :relstart, :relbound
-            passthrough :bounded, :ubound, :lbound
+            passboolean :relative, :bounded
+            passthrough :relstart, :relbound
+            passthrough :ubound, :lbound
+
             passthrough :filter_date_input
-            passthrough :user_id, :lock_chart_user
+
+            passthrough :user_id, :user_lookup
+            passboolean :lock_chart_user
 
             embeds_one :series_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::SeriesConfig"
             embeds_one :frequency_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Frequency"
@@ -20,10 +24,18 @@ module Ecoportal
 
             embeds_many :series, klass: "Ecoportal::API::V2::Page::Component::ChartField::Serie"
 
-            MODES = ["frequency", "series", "heatmap", "sankey", "indicator", "faceted_series"]
+            MODES = ["frequency", "series", "heatmap", "sankey", "indicator", "faceted_series", "benchmark"]
+
+            def mode=(value)
+              raise "Unsuported mode #{value}. Should be one of #{MODES}" unless MODES.include?(value)
+              config_doc(nil)
+              doc["mode"] = value
+              config_doc(config.class.new_doc)
+              self.mode
+            end
 
             def config
-              case mode
+              case self.mode
               when "frequency"
                 frequency_config
               when "series"
@@ -41,6 +53,27 @@ module Ecoportal
               end
             end
 
+            private
+
+            def config_doc(value)
+              case self.mode
+              when "frequency"
+                doc["frequency_config"] = value
+              when "series"
+                doc["series_config"] = value
+              when "heatmap"
+                doc["heatmap_config"] = value
+              when "sankey"
+                doc["sankey_config"] = value
+              when "indicator"
+                doc["indicator_config"] = value
+              when "faceted_series"
+                doc["faceted_series_config"] = value
+              when "benchmark"
+                doc["benchmark_config"] = value
+              end
+            end
+
           end
         end
       end
@@ -48,6 +81,7 @@ module Ecoportal
   end
 end
 
+require 'ecoportal/api/v2/page/component/chart_field/config'
 require 'ecoportal/api/v2/page/component/chart_field/frequency'
 require 'ecoportal/api/v2/page/component/chart_field/series_config'
 require 'ecoportal/api/v2/page/component/chart_field/serie'