ecoportal-api-v2 2.0.16 → 3.1.1

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

@@ -7,28 +7,28 @@ module Ecoportal
             passboolean :multiple, :flat, :other
             passthrough :other_desc
             passthrough :data_type
-            embeds_many :options, enum_class: "Ecoportal::API::V2::Page::Component::SelectionOptions"
+            embeds_many :options, enum_class: 'Ecoportal::API::V2::Page::Component::SelectionOptions'
 
             def empty?
               values.empty?
             end
-            
+
             def numeric?
-              self.data_type == "num"
+              data_type == 'num'
             end
 
             def text?
-              self.data_type == "txt"
+              data_type == 'txt'
             end
 
             def numeric!(&block)
               options.ordered.each {|opt| opt.numeric!(&block)}
-              self.data_type = "num"
+              self.data_type = 'num'
             end
 
             def text!(&block)
               options.ordered.each {|opt| opt.text!(&block)}
-              self.data_type = "str"
+              self.data_type = 'str'
             end
 
             def switch_type!(&block)
@@ -39,40 +39,38 @@ module Ecoportal
               opt = options.find_option(value_name, by_name: by_name)
               sel = selected
               return true if !multiple && opt == sel
+
               sel.selected = false if !multiple && sel
-              opt.selected = true unless !opt
+              opt.selected = true  if opt
             end
 
             def deselect(value_name, by_name: false)
-              if opt = options.find_option(value_name, by_name: by_name)
-                opt.selected = false
-              end
+              return unless (opt = options.find_option(value_name, by_name: by_name))
+
+              opt.selected = false
             end
 
             def selected(by_name: false, by_value: false, value: false, name: false)
-              case
-              when by_value
+              if by_value
                 elems = [selected].flatten.compact
                 options.hash(elems) do |option|
                   name ? option.name : option
                 end
-              when by_name
+              elsif by_name
                 elems = [selected].flatten.compact
                 options.hash(elems, by_name: true) do |option|
                   value ? option.value : option
                 end
+              elsif multiple
+                options.ordered.select(&:selected)
               else
-                if multiple
-                  options.ordered.select {|opt| opt.selected}
-                else
-                  options.find {|opt| opt.selected}
-                end
+                options.find(&:selected)
               end
             end
 
             def value
               if multiple
-                selected.map {|opt| opt.value}
+                selected.map(&:value)
               else
                 selected&.value
               end
@@ -84,7 +82,7 @@ module Ecoportal
 
             def name
               if multiple
-                selected.map {|opt| opt.name}
+                selected.map(&:name)
               else
                 selected&.name
               end
@@ -133,7 +131,7 @@ module Ecoportal
               conf.each_with_object([]) do |cnf, unused|
                 case cnf
                 when :flat
-                  self.flat  = true
+                  self.flat = true
                 when :multiple
                   self.multiple = true
                 when :single
@@ -141,30 +139,28 @@ module Ecoportal
                 when :other
                   self.other = true
                 when Hash
-                  supported = [:flat, :options, :type]
-                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                  supported = %i[flat options type]
+                  unless (rest = hash_except!(cnf.dup, *supported)).empty?
                     unused.push(rest)
                   end
 
-                  if cnf.key?(:flat) then self.flat = cnf[:flat] end
-                  if cnf.key?(:options)
-                    if opts = cnf[:options]
-                      configure_options opts
-                    end
+                  self.flat = cnf[:flat] if cnf.key?(:flat)
+
+                  if cnf.key?(:options) && (opts = cnf[:options])
+                    configure_options opts
                   end
+
                   if cnf.key?(:type)
                     if cnf[:type] == :str
-                      self.text!
+                      text!
                     elsif cnf[:type] == :num
-                      self.numeric!
-                    else
-                      # Unknown type
+                      numeric!
                     end
                   end
                 else
                   unused.push(cnf)
                 end
-              end.yield_self do |unused|
+              end.then do |unused|
                 super(*unused)
               end
             end
@@ -172,9 +168,10 @@ module Ecoportal
             private
 
             def configure_options(opts)
-              hopts = self.options_by_value
+              hopts = options_by_value
+
               opts.each do |val, nm|
-                if option = hopts[val]
+                if (option = hopts[val])
                   option.name = nm
                 else
                   add_option(value: val, name: nm)

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

@@ -4,13 +4,13 @@ module Ecoportal
       class Page
         class Component
           class SelectionOptions < Ecoportal::API::Common::Content::CollectionModel
-            class_resolver :option_class, "Ecoportal::API::V2::Page::Component::SelectionOption"
+            class_resolver :option_class, 'Ecoportal::API::V2::Page::Component::SelectionOption'
 
             self.klass = :option_class
             self.order_key = :weight
 
             def component
-              self._parent
+              _parent
             end
 
             def ooze
@@ -19,27 +19,31 @@ module Ecoportal
 
             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)
+
+                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)}
+                find {|opt| same_string?(opt.name, value_name)}
               else
-                opt = self.find {|opt| opt.value == value_name}
+                find {|opt| opt.value == value_name}
               end
             end
 
             def ordered
-              self.sort_by.with_index do |option, index|
+              sort_by.with_index do |option, index|
                 [option.weight, index]
               end
             end
@@ -82,7 +86,8 @@ module Ecoportal
             def previous_option(value)
               opts = ordered
               pos  = opts.index(value) - 1
-              return if pos < 0
+              return if pos.negative?
+
               opts[pos]
             end
           end

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

@@ -28,18 +28,19 @@ module Ecoportal
                   self.use_defaults = true
                 when Hash
                   supported = [:button_text]
-                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+
+                  unless (rest = hash_except!(cnf.dup, *supported)).empty?
                     unused.push(rest)
                   end
-                  if cnf.key?(:button_text) then self.button_text = cnf[:button_text] end
+
+                  self.button_text = cnf[:button_text] if cnf.key?(:button_text)
                 else
                   unused.push(cnf)
                 end
-              end.yield_self do |unused|
+              end.then do |unused|
                 super(*unused)
               end
             end
-
           end
         end
       end

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

@@ -228,24 +228,24 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/v2/page/component/tag_field'
-require 'ecoportal/api/v2/page/component/geo_field'
-require 'ecoportal/api/v2/page/component/selection_field'
-require 'ecoportal/api/v2/page/component/date_field'
-require 'ecoportal/api/v2/page/component/number_field'
-require 'ecoportal/api/v2/page/component/gauge_field'
-require 'ecoportal/api/v2/page/component/plain_text_field'
-require 'ecoportal/api/v2/page/component/rich_text_field'
-require 'ecoportal/api/v2/page/component/people_field'
-require 'ecoportal/api/v2/page/component/contractor_entities_field'
-require 'ecoportal/api/v2/page/component/checklist_field'
-require 'ecoportal/api/v2/page/component/action_field'
-require 'ecoportal/api/v2/page/component/actions_field'
-require 'ecoportal/api/v2/page/component/files_field'
-require 'ecoportal/api/v2/page/component/images_field'
-require 'ecoportal/api/v2/page/component/signature_field'
-require 'ecoportal/api/v2/page/component/reference_field'
-require 'ecoportal/api/v2/page/component/law_field'
-require 'ecoportal/api/v2/page/component/mailbox_field'
-require 'ecoportal/api/v2/page/component/chart_field'
-require 'ecoportal/api/v2/page/component/chart_fr_field'
+require_relative 'component/tag_field'
+require_relative 'component/geo_field'
+require_relative 'component/selection_field'
+require_relative 'component/date_field'
+require_relative 'component/number_field'
+require_relative 'component/gauge_field'
+require_relative 'component/plain_text_field'
+require_relative 'component/rich_text_field'
+require_relative 'component/people_field'
+require_relative 'component/contractor_entities_field'
+require_relative 'component/checklist_field'
+require_relative 'component/action_field'
+require_relative 'component/actions_field'
+require_relative 'component/files_field'
+require_relative 'component/images_field'
+require_relative 'component/signature_field'
+require_relative 'component/reference_field'
+require_relative 'component/law_field'
+require_relative 'component/mailbox_field'
+require_relative 'component/chart_field'
+require_relative 'component/chart_fr_field'

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

@@ -4,26 +4,27 @@ module Ecoportal
       class Page
         class Force
           class Bindings < Ecoportal::API::Common::Content::CollectionModel
-            class_resolver :binding_class, "Ecoportal::API::V2::Page::Force::Binding"
+            class_resolver :binding_class, 'Ecoportal::API::V2::Page::Force::Binding'
 
             self.klass         = :binding_class
             self.order_matters = true
 
             def ooze
-              self._parent.ooze
+              _parent.ooze
             end
 
             def force
-              self._parent
+              _parent
             end
 
             # @note first local binding name will shadow later ones
-            # @param only_winner [Boolean] specifies if retrieving multiple bindings with same name or just the winner
+            # @param only_winner [Boolean] specifies if retrieving multiple bindings
+            #   with same name or just the winner
             # @return [Hash] where **key** is `name` and **value** is
             #   1. a single _binding_, if `only_winner` is `true`
             #   2. an `Array` of _bindings_ with same _name_, otherwise
             def by_name(only_winner: false)
-              self.each_with_object({}) do |binding, hash|
+              each_with_object({}) do |binding, hash|
                 if winner_only
                   hash[binding.name] ||= binding
                 else
@@ -33,13 +34,14 @@ module Ecoportal
               end
             end
 
-
             # @note first local binding name will shadow later ones.
-            # @param only_winner [Boolean] specifies if shadowed bindings (inactive) should be excluded (`true`)
-            # @return [Hash] where **key** is a _section_ or a _component_ and **value** is eitheran `Array` of _bindings_.
+            # @param only_winner [Boolean] specifies if shadowed bindings (inactive)
+            #   should be excluded (`true`)
+            # @return [Hash] where **key** is a _section_ or a _component_ and **value**
+            #   is eitheran `Array` of _bindings_.
             def by_reference(only_winner: false)
               if only_winner
-                by_name(only_winner: true).each_with_object({}) do |(name, binds), hash|
+                by_name(only_winner: true).each_with_object({}) do |(_name, binds), hash|
                   if binds.is_a?(Array)
                     binds.each {|binding| (hash[binding.reference] ||= []).push(binding)}
                   else
@@ -47,23 +49,28 @@ module Ecoportal
                   end
                 end
               else
-                self.each_with_object({}) do |binding, hash|
+                each_with_object({}) do |binding, hash|
                   (hash[binding.reference] ||= []).push(binding)
                 end
               end
             end
 
-            # @param obj [Ecoportal::API::V2::Page::Section, Ecoportal::API::V2::Page::Component)] the referred component or section.
+            # @param obj [Ecoportal::API::V2::Page::Section, Ecoportal::API::V2::Page::Component)]
+            #   the referred component or section.
             # @return [Boolean] `true` if `obj` is referred in the bindings, `false` otherwise
             def reference?(obj)
-              get_by_reference(obj).count > 0
+              get_by_reference(obj).count.positive?
             end
 
-            # @param obj [Ecoportal::API::V2::Page::Section, Ecoportal::API::V2::Page::Component)] the referred component or section.
+            # @param obj [Ecoportal::API::V2::Page::Section, Ecoportal::API::V2::Page::Component)]
+            #   the referred component or section.
             # @return [Array<Ecoportal::API::V2::Page::Force::Binding>] binding to the component or section.
             def get_by_reference(obj)
               unless obj.is_a?(Ecoportal::API::V2::Page::Section) || obj.is_a?(Ecoportal::API::V2::Page::Component)
-                raise ArgumentError.new("Expected either a Ecoportal::API::V2::Page::Section or a Ecoportal::API::V2::Page::Component. Given: #{obj.class}")
+                msg  = 'Expected either a Ecoportal::API::V2::Page::Section '
+                msg << 'or a Ecoportal::API::V2::Page::Component. '
+                msg << "Given: #{obj.class}"
+                raise ArgumentError, msg
               end
               self.select do |bind|
                 bind.reference == obj
@@ -73,7 +80,7 @@ module Ecoportal
             # @param id [String] the `id` of the binding to find.
             # @return [Ecoportal::API::V2::Page::Force::Binding] binding with `id`
             def get_by_id(id)
-              self.find do |bind|
+              find do |bind|
                 bind.id == id
               end
             end
@@ -114,31 +121,34 @@ module Ecoportal
             def add(reference, name:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
               binding_doc = binding_class.new_doc
 
-              type = case reference
-                      when Ecoportal::API::V2::Page::Component
-                        unless ooze.components.include?(reference)
-                          msg  = "The field '#{reference.label}' (#{reference.id}) is not present in ooze.components.\n"
-                          msg += "Review your script (i.e. @var where you store previous ooze runs)."
-                          raise msg
-                        end
-                        Ecoportal::API::V2::Page::Force::Binding::COMPONENT_TYPE
-                      when Ecoportal::API::V2::Page::Section
-                        unless ooze.sections.include?(reference)
-                          msg  = "The section '#{reference.heading}' (#{reference.id}) is not present in ooze.sections.\n"
-                          msg += "Review your script (i.e. @var where you store previous ooze runs)."
-                          raise msg
-                        end
-                        Ecoportal::API::V2::Page::Force::Binding::SECTION_TYPE
-                      else
-                        msg = "You can only create bindings with Component and Section. Given: #{reference.class}"
-                        raise ArgumentError.new(msg)
-                      end
+              type =
+                case reference
+                when Ecoportal::API::V2::Page::Component
+                  unless ooze.components.include?(reference)
+                    msg  = "The field '#{reference.label}' (#{reference.id}) is not present in ooze.components.\n"
+                    msg << 'Review your script (i.e. @var where you store previous ooze runs).'
+                    raise msg
+                  end
+                  Ecoportal::API::V2::Page::Force::Binding::COMPONENT_TYPE
+                when Ecoportal::API::V2::Page::Section
+                  unless ooze.sections.include?(reference)
+                    msg  = "The section '#{reference.heading}' (#{reference.id}) is not present in ooze.sections.\n"
+                    msg << 'Review your script (i.e. @var where you store previous ooze runs).'
+                    raise msg
+                  end
+                  Ecoportal::API::V2::Page::Force::Binding::SECTION_TYPE
+                else
+                  msg = "You can only create bindings with Component and Section. Given: #{reference.class}"
+                  raise ArgumentError, msg
+                end
 
               position = scope_position(pos: pos, before: before, after: after)
+
               upsert!(binding_doc, pos: position) do |bind|
                 bind.name         = name
                 bind.reference_id = reference.id
                 bind.type         = type
+
                 yield(bind) if block_given?
               end
             end
@@ -148,19 +158,19 @@ module Ecoportal
             def scope_position(pos: NOT_USED, before: NOT_USED, after: NOT_USED)
               case
               when used_param?(pos)
-                if pos    = to_binding(pos)
+                if (pos = to_binding(pos))
                   _doc_pos(pos) - 1
                 end
               when used_param?(before)
-                if before = to_binding(before)
+                if (before = to_binding(before))
                   _doc_pos(before) - 1
                 end
               when used_param?(after)
-                if after  = to_binding(after)
+                if (after = to_binding(after))
                   _doc_pos(after) - 1
                 end
-              end.yield_self do |position|
-                position ||= self.count
+              end.then do |position|
+                position || count
               end
             end
 

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

@@ -8,14 +8,14 @@ module Ecoportal
           class << self
             def new_doc
               {
-                "id"     => new_uuid,
-                "weight" => INITIAL_WEIGHT
+                'id'     => new_uuid,
+                'weight' => INITIAL_WEIGHT
               }
             end
           end
 
-          class_resolver :bindings_class, "Ecoportal::API::V2::Page::Force::Bindings"
-          class_resolver :helper_class, "Ecoportal::API::V2::Page::Force::Helper"
+          class_resolver :bindings_class, 'Ecoportal::API::V2::Page::Force::Bindings'
+          class_resolver :helper_class, 'Ecoportal::API::V2::Page::Force::Helper'
 
           passkey     :id
           passforced  :patch_ver, default: 1
@@ -37,13 +37,13 @@ module Ecoportal
 
           # It updates `script` by using `helpers`
           def custom_script=(value)
-            doc["custom_script"] = value
+            doc['custom_script'] = value
             update_script
           end
 
           # It sets the `script` value by using `custom_script` and `helpers[N..1].script`
           def update_script
-            doc["script"] = helpers.to_a.reverse.map(&:script).push(custom_script).join("\n")
+            doc['script'] = helpers.to_a.reverse.map(&:script).push(custom_script).join("\n")
           end
         end
       end
@@ -51,6 +51,6 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/v2/page/force/helper'
-require 'ecoportal/api/v2/page/force/binding'
-require 'ecoportal/api/v2/page/force/bindings'
+require_relative 'force/helper'
+require_relative 'force/binding'
+require_relative 'force/bindings'

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Forces < Ecoportal::API::Common::Content::CollectionModel
-          class_resolver :force_class, "Ecoportal::API::V2::Page::Force"
+          class_resolver :force_class, 'Ecoportal::API::V2::Page::Force'
 
           self.klass         = :force_class
           self.order_matters = true

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

@@ -6,8 +6,8 @@ module Ecoportal
           class << self
             def new_doc
               {
-                "id"         => new_uuid,
-                "editable"   => false
+                'id'       => new_uuid,
+                'editable' => false
               }
             end
           end
@@ -16,7 +16,7 @@ module Ecoportal
           passforced  :patch_ver, default: 1
           passthrough :user_id, :user_name
           passthrough :editable
-          embeds_one  :flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
+          embeds_one  :flags, klass: 'Ecoportal::API::V2::Page::PermissionFlags'
         end
       end
     end

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

@@ -3,18 +3,18 @@ module Ecoportal
     class V2
       class Page
         class Sections < Ecoportal::API::Common::Content::CollectionModel
-          class_resolver :section_class, "Ecoportal::API::V2::Page::Section"
+          class_resolver :section_class, 'Ecoportal::API::V2::Page::Section'
 
           self.klass = :section_class
           self.order_key = :weight
 
           def ooze
-            self._parent.ooze
+            _parent.ooze
           end
 
           # @return [Boolean] `true` if there is one or more sections shared, `false` otherwise
           def any_shared?
-            self.any? {|sec| sec.shared?}
+            any?(&:shared?)
           end
 
           # Creates a new `section`
@@ -24,16 +24,19 @@ module Ecoportal
           #     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
+              section.heading = name
+
               move(section, pos: pos, before: before, after: after)
+
               yield(section) if block_given?
             end
           end
 
           # Moves an existing `section`
           def move(section, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-            if weight = scope_weight(section, pos: pos, before: before, after: after)
+            if (weight = scope_weight(section, pos: pos, before: before, after: after))
               section.weight = weight
             end
             fix_weights!
@@ -41,7 +44,7 @@ module Ecoportal
 
           # @return [Ecoportal::API::V2::Page::Section]
           def get_by_id(id)
-            self.find do |sec|
+            find do |sec|
               sec.id == id
             end
           end
@@ -81,7 +84,7 @@ module Ecoportal
           # Gets the sections ordered by `weight` (as they appear in the page)
           # @return [Array<Ecoportal::API::V2::Page::Section>] section sorted by `weight`
           def ordered
-            self.sort_by.with_index do |section, index|
+            sort_by.with_index do |section, index|
               [section.weight, index]
             end
           end
@@ -96,22 +99,23 @@ module Ecoportal
           def scope_weight(section, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             case
             when used_param?(pos)
-              if pos    = to_section(pos)
+              if (pos = to_section(pos))
                 pos.weight - 1
               end
             when used_param?(before)
-              if before = to_section(before)
+              if (before = to_section(before))
                 before.weight - 1
               end
             when used_param?(after)
-              if after  = to_section(after)
+              if (after  = to_section(after))
                 after.weight
               end
-            end.yield_self do |weight|
+            end.then do |weight|
               weight ||= ordered.reject do |sec|
                 sec.id == section.id
               end.last&.weight
-              weight ||= section_class.const_get(:INITIAL_WEIGHT)
+
+              weight || section_class.const_get(:INITIAL_WEIGHT)
             end
           end
 
@@ -127,7 +131,7 @@ module Ecoportal
           end
 
           def fix_weights!
-            unless self.any_shared? && self._parent.is_a?(Ecoportal::API::V2::Pages::PageStage)
+            unless any_shared? && _parent.is_a?(Ecoportal::API::V2::Pages::PageStage)
               ordered.each_with_index do |section, index|
                 section.weight = index
               end
@@ -137,7 +141,8 @@ module Ecoportal
           def previous_section(value)
             secs = ordered
             pos  = secs.index(value) - 1
-            return if pos < 0
+            return if pos.negative?
+
             secs[pos]
           end
         end