ecoportal-api-v2 2.0.16 → 3.1.1

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

@@ -6,14 +6,14 @@ module Ecoportal
         # which differs of `attr_*` ruby native class methods because `pass*`
         # completelly **links** the methods **to a subjacent `Hash` model**
         class DoubleModel < Ecoportal::API::Common::BaseModel
-          require 'ecoportal/api/common/content/double_model/base'
-          require 'ecoportal/api/common/content/double_model/parented'
-          require 'ecoportal/api/common/content/double_model/modifiers'
-          require 'ecoportal/api/common/content/double_model/var_tracking'
-          require 'ecoportal/api/common/content/double_model/hash_helpers'
-          require 'ecoportal/api/common/content/double_model/double_doc'
-          require 'ecoportal/api/common/content/double_model/attributable'
-          require 'ecoportal/api/common/content/double_model/diffable_model'
+          require_relative 'double_model/base'
+          require_relative 'double_model/parented'
+          require_relative 'double_model/modifiers'
+          require_relative 'double_model/var_tracking'
+          require_relative 'double_model/hash_helpers'
+          require_relative 'double_model/double_doc'
+          require_relative 'double_model/attributable'
+          require_relative 'double_model/diffable'
 
           include Base
           include Parented
@@ -23,7 +23,7 @@ module Ecoportal
 
           include DoubleDoc
           include Attributable
-          include DiffableModel
+          include Diffable
 
           class << self
             def new_uuid(length: 24)

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

@@ -4,17 +4,24 @@ module Ecoportal
     module Common
       module Content
         module HashDiffPatch
-          extend DocHelpers
+          class << self
+            def included(base)
+              super
+
+              base.send :include, InstanceMethods
+            end
+          end
 
-          ID_KEYS    = %w[id].freeze
           META_KEYS  = %w[id patch_ver].freeze
           NO_CHANGES = "%not-changed!%".freeze
 
-          class << self
+          module InstanceMethods
+            include DocHelpers
+
             # The `patch data` is built as follows:
             # 1. detect changes that have occurred translate into one `operation` of `OP_TYPE`:
             #   * `changed`: meaning that the object has changed (existed and has not been removed)
-            #   * `delete`:  the object has been removed
+            #   * `deleted`:  the object has been removed
             #   * `new`:     the object is new
             # 2. at the level of the target object of the model, the object is opened for change
             # with `id` and `operation` as follows:
@@ -54,6 +61,12 @@ module Ecoportal
 
             private
 
+            def meta_keys
+              return self::META_KEYS if respond_to?(:const_get)
+
+              self.class::META_KEYS
+            end
+
             def equal_values?(a, b)
               if a.is_a?(String) || b.is_a?(String)
                 a_empty = a.to_s.strip.empty?
@@ -76,7 +89,7 @@ module Ecoportal
                 end
 
                 a.each do |key, a_value|
-                  next if META_KEYS.include?(key)
+                  next if meta_keys.include?(key)
 
                   b_value = nil
 
@@ -90,8 +103,7 @@ module Ecoportal
                   data_hash.delete(key) if data_hash[key] == NO_CHANGES
                 end
 
-                #if (data_hash.keys - ID_KEYS).empty?
-                return NO_CHANGES if (data_hash.keys - META_KEYS).empty?
+                return NO_CHANGES if (data_hash.keys - meta_keys).empty?
 
                 if b&.key?('patch_ver')
                   data_hash['patch_ver'] = b['patch_ver']
@@ -217,6 +229,8 @@ module Ecoportal
               bool
             end
           end
+
+          extend InstanceMethods
         end
       end
     end

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

@@ -31,7 +31,7 @@ module Ecoportal
             end
           end
 
-          def hash_except(hash, *keys)
+          def hash_except!(hash, *keys)
             keys.each {|key| hash.delete(key)}
             hash
           end

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

@@ -7,14 +7,14 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/common/content/includer'
-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'
-require 'ecoportal/api/common/content/doc_helpers'
-require 'ecoportal/api/common/content/hash_diff_patch'
-require 'ecoportal/api/common/content/client'
-require 'ecoportal/api/common/content/wrapped_response'
+require_relative 'content/includer'
+require_relative 'content/class_helpers'
+require_relative 'content/string_digest'
+require_relative 'content/model_helpers'
+require_relative 'content/doc_helpers'
+require_relative 'content/hash_diff_patch'
+require_relative 'content/double_model'
+require_relative 'content/array_model'
+require_relative 'content/collection_model'
+require_relative 'content/client'
+require_relative 'content/wrapped_response'

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

@@ -9,5 +9,5 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/common/concerns'
-require 'ecoportal/api/common/content'
+require_relative 'common/concerns'
+require_relative 'common/content'

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

@@ -7,8 +7,8 @@ module Ecoportal
             class << self
               def new_doc
                 {
-                  "id"         => new_uuid,
-                  "weight"     => 99
+                  'id'     => new_uuid,
+                  'weight' => 99
                 }
               end
             end
@@ -30,16 +30,18 @@ module Ecoportal
             passarray   :file_container_ids
 
             def to_s
-              stat = case
-                when overdue
-                  "Overdue"
-                when complete
-                  "Complete"
+              stat =
+                if overdue
+                  'Overdue'
+                elsif complete
+                  'Complete'
                 else
-                  "Pending"
-              end
-              assignee = assigned_person_member["name"] || assigned_person_member["email"]
-              "#{name}, #{created_at.to_s}, #{stat}, #{assignee}"
+                  'Pending'
+                end
+
+              assignee = assigned_person_member['name'] || assigned_person_member['email']
+
+              "#{name}, #{created_at}, #{stat}, #{assignee}"
             end
           end
         end

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

@@ -9,22 +9,24 @@ module Ecoportal
             passboolean :permits_and_rules_integration, :add_subscribed, :add_subscribed_to_tasks
             passarray   :permitted_person_schema_ids, order_matters: false
 
-            embeds_many :actions, klass: "Ecoportal::API::V2::Page::Component::Action", order_key: :weight
+            embeds_many :actions, klass: 'Ecoportal::API::V2::Page::Component::Action', order_key: :weight
 
             def empty?
               actions.empty?
             end
-            
+
             # Adds a task with `name` short description
             # @return [Ecoportal::API::V2::Page::Component::Action]
-            def add_task (name)
+            def add_task(name)
               task_doc = actions.items_class.new_doc
               actions.upsert!(task_doc) do |task|
                 task.name = name
-                if prev = previous_task(task)
+                if (prev = previous_task(task))
                   task.weight = prev.weight
                 end
+
                 yield(task) if block_given?
+
                 fix_task_weights!
               end
             end
@@ -50,14 +52,15 @@ module Ecoportal
                 case cnf
                 when Hash
                   supported = [:requires]
-                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                  unless (rest = hash_except!(cnf.dup, *supported)).empty?
                     unused.push(rest)
                   end
-                  if cnf.key?(:requires) then configure_required(cnf[:requires]) end
+
+                  configure_required(cnf[:requires]) if cnf.key?(:requires)
                 else
                   unused.push(cnf)
                 end
-              end.yield_self do |unused|
+              end.then do |unused|
                 super(*unused)
               end
             end
@@ -68,11 +71,9 @@ module Ecoportal
               self.required = true
               case req
               when :all, NilClass
-                self.required_number_of_completed_actions = "all"
+                self.required_number_of_completed_actions = 'all'
               when Numeric
                 self.required_number_of_completed_actions = req
-              else
-                # Unsupported
               end
             end
 
@@ -84,8 +85,9 @@ module Ecoportal
 
             def previous_task(value)
               tasks = ordered_tasks
-              pos  = tasks.index(value) - 1
-              return if pos < 0
+              pos   = tasks.index(value) - 1
+              return if pos.negative?
+
               tasks[pos]
             end
           end

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

@@ -21,8 +21,9 @@ module Ecoportal
 
             # Adds a task with `name` short description
             # @return [Ecoportal::API::V2::Page::Component::Action]
-            def attach_action (*ids, force: false)
+            def attach_action(*ids, force: false)
               raise "Can't attach actions" unless enable_attaching_actions && force
+
               action_ids << ids
             end
 

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

@@ -5,10 +5,9 @@ module Ecoportal
         class Component
           class ChartField
             class Config < Ecoportal::API::Common::Content::DoubleModel
-
               class << self
                 def new_doc
-                  {"id" => new_uuid}
+                  {'id' => new_uuid}
                 end
               end
 

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

@@ -14,41 +14,46 @@ module Ecoportal
             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"
-            embeds_one :heatmap_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Heatmap"
-            embeds_one :sankey_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Sankey"
-            embeds_one :indicator_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Indicator"
-            embeds_one :faceted_series_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Multiseries"
-            embeds_one :benchmark_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Benchmark"
+            embeds_one :series_config, klass: 'Ecoportal::API::V2::Page::Component::ChartField::SeriesConfig'
+            embeds_one :frequency_config, klass: 'Ecoportal::API::V2::Page::Component::ChartField::Frequency'
+            embeds_one :heatmap_config, klass: 'Ecoportal::API::V2::Page::Component::ChartField::Heatmap'
+            embeds_one :sankey_config, klass: 'Ecoportal::API::V2::Page::Component::ChartField::Sankey'
+            embeds_one :indicator_config, klass: 'Ecoportal::API::V2::Page::Component::ChartField::Indicator'
+            embeds_one :faceted_series_config, klass: 'Ecoportal::API::V2::Page::Component::ChartField::Multiseries'
+            embeds_one :benchmark_config, klass: 'Ecoportal::API::V2::Page::Component::ChartField::Benchmark'
 
-            embeds_many :series, klass: "Ecoportal::API::V2::Page::Component::ChartField::Serie"
+            embeds_many :series, klass: 'Ecoportal::API::V2::Page::Component::ChartField::Serie'
 
-            MODES = ["frequency", "series", "heatmap", "sankey", "indicator", "faceted_series", "benchmark"]
+            MODES = %w[
+              frequency heatmap sankey
+              series faceted_series
+              indicator benchmark
+            ].freeze
 
             def mode=(value)
               raise "Unsuported mode #{value}. Should be one of #{MODES}" unless MODES.include?(value)
               config_doc(nil)
-              doc["mode"] = value
+              doc['mode'] = value
               config_doc(config.class.new_doc)
-              self.mode
+
+              mode
             end
 
             def config
-              case self.mode
-              when "frequency"
+              case mode
+              when 'frequency'
                 frequency_config
-              when "series"
+              when 'series'
                 series_config
-              when "heatmap"
+              when 'heatmap'
                 heatmap_config
-              when "sankey"
+              when 'sankey'
                 sankey_config
-              when "indicator"
+              when 'indicator'
                 indicator_config
-              when "faceted_series"
+              when 'faceted_series'
                 faceted_series_config
-              when "benchmark"
+              when 'benchmark'
                 benchmark_config
               end
             end
@@ -56,24 +61,23 @@ module Ecoportal
             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
+              case 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
@@ -81,12 +85,12 @@ 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'
-require 'ecoportal/api/v2/page/component/chart_field/heatmap'
-require 'ecoportal/api/v2/page/component/chart_field/sankey'
-require 'ecoportal/api/v2/page/component/chart_field/indicator'
-require 'ecoportal/api/v2/page/component/chart_field/multiseries'
-require 'ecoportal/api/v2/page/component/chart_field/benchmark'
+require_relative 'chart_field/config'
+require_relative 'chart_field/frequency'
+require_relative 'chart_field/series_config'
+require_relative 'chart_field/serie'
+require_relative 'chart_field/heatmap'
+require_relative 'chart_field/sankey'
+require_relative 'chart_field/indicator'
+require_relative 'chart_field/multiseries'
+require_relative 'chart_field/benchmark'

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

@@ -25,7 +25,6 @@ module Ecoportal
             passarray   :color_map, order_matters: false
 
             passthrough :chart_user
-
           end
         end
       end

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

@@ -4,20 +4,23 @@ module Ecoportal
       class Page
         class Component
           class ChecklistField < Page::Component
-            embeds_many :items, klass: "Ecoportal::API::V2::Page::Component::ChecklistItem", order_key: :weight
+            embeds_many :items, klass: 'Ecoportal::API::V2::Page::Component::ChecklistItem', order_key: :weight
 
             def empty?
               items.empty?
             end
-            
+
             def add_item(label:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
               itm_doc = items.items_class.new_doc
               items.upsert!(itm_doc, pos: pos, before: before, after: after) do |item|
-                item.label  = label
-                if prev = previous_item(item)
+                item.label = label
+
+                if (prev = previous_item(item))
                   item.weight = prev.weight
                 end
+
                 yield(item) if block_given?
+
                 fix_item_weights!
               end
             end
@@ -43,10 +46,10 @@ module Ecoportal
             def previous_item(value)
               itms = ordered_items
               pos  = itms.index(value) - 1
-              return if pos < 0
+              return if pos.negative?
+
               itms[pos]
             end
-
           end
         end
       end

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

@@ -4,12 +4,11 @@ module Ecoportal
       class Page
         class Component
           class ChecklistItem < Ecoportal::API::Common::Content::DoubleModel
-
             class << self
               def new_doc
                 {
-                  "id"          => new_uuid,
-                  "weight"      => 9999
+                  'id'     => new_uuid,
+                  'weight' => 9999
                 }
               end
             end

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

@@ -16,8 +16,8 @@ module Ecoportal
             passboolean :grant_permissions_enabled
             passthrough :apply_attached_contractors_permissions_to
             passthrough :admin_access, :regular_access
-            embeds_one  :attached_contractors_permissions_flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
-            embeds_one  :attached_contractors_admin_permissions_flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
+            embeds_one  :attached_contractors_permissions_flags, klass: 'Ecoportal::API::V2::Page::PermissionFlags'
+            embeds_one  :attached_contractors_admin_permissions_flags, klass: 'Ecoportal::API::V2::Page::PermissionFlags' # rubocop:disable Layout/LineLength
 
             def empty?
               contractor_entities_ids.empty?
@@ -55,7 +55,7 @@ module Ecoportal
             #     - `:subscribed`
             #     - `:subscribed_to_tasks`
             #   - `requires: number` to fine the number of required people to be attached
-            def configure(*conf)
+            def configure(*conf) # rubocop:disable Metrics/AbcSize
               conf.each_with_object([]) do |cnf, unused|
                 case cnf
                 when :me_button
@@ -63,14 +63,15 @@ module Ecoportal
                 when :singular
                   self.singular = true
                 when Hash
-                  supported = [:singular, :permits]
-                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                  supported = %i[singular permits]
+                  unless (rest = hash_except!(cnf.dup, *supported)).empty?
                     unused.push(rest)
                   end
 
-                  if cnf.key?(:singular) then self.singular = !!cnf[:singular] end
+                  self.singular = !!cnf[:singular] if cnf.key?(:singular) # rubocop:disable Style/DoubleNegation
+
                   if cnf.key?(:permits)
-                    if permits = cnf[:permits]
+                    if (permits = cnf[:permits])
                       self.regular_access = true
                       configure_permits(*[permits].flatten.compact)
                     else
@@ -78,7 +79,7 @@ module Ecoportal
                     end
                   end
                   if cnf.key?(:admin_permits)
-                    if permits = cnf[:permits]
+                    if (permits = cnf[:permits])
                       self.admin_access = true
                       configure_permits(*[permits].flatten.compact)
                     else
@@ -88,35 +89,35 @@ module Ecoportal
                 else
                   unused.push(cnf)
                 end
-              end.yield_self do |unused|
+              end.then do |unused|
                 super(*unused)
               end
             end
 
             private
 
-            def configure_permits(*conf, to: :regular)
+            def configure_permits(*conf, to: :regular) # rubocop:disable Naming/MethodParameterName
               conf.each_with_object([]) do |cnf, flags|
                 permits_scope = :apply_attached_contractors_permissions_to=
                 case cnf
                 when :all
-                  send(permits_scope, "page")
+                  send(permits_scope, 'page')
                 when :stages
-                  send(permits_scope, "all_stages")
+                  send(permits_scope, 'all_stages')
                 when :page
-                  send(permits_scope, "page_only")
+                  send(permits_scope, 'page_only')
                 when :stage
-                  send(permits_scope, "current_stage")
+                  send(permits_scope, 'current_stage')
                 else
                   flags.push(cnf)
                 end
-              end.yield_self do |flags|
+              end.then do |flags|
                 target_flags   = :attached_contractors_admin_permissions_flags if to == :admin
                 target_flags ||= :attached_contractors_permissions_flags
-                self.send(target_flags).configure *flags
+
+                send(target_flags).configure(*flags)
               end
             end
-
           end
         end
       end