ecoportal-api-v2 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65194be30f026aa431874543d6905b5704ea081c6a3c9ef0bf9741142c4c4253
-  data.tar.gz: 398eaeb83ea38386670715c0fa83144004abdbd8c7edfd8581ecb7b157c8d205
+  metadata.gz: 70ba8da2cd5c6bd11498fb6cf8a40b04d121940c1693efc525372e3a584758f8
+  data.tar.gz: 2aa49af74223a5a03529fd3920714ff9b4f1dcbc636285c6b187acebe9b2e601
 SHA512:
-  metadata.gz: 0761f2079d2493f6fef928f846daf4b6b0413838c4f1252c8cf31742284fc5bcfc0e8d6dbd635f2659b37a34a6b90c09ed42f7db781c868a635188354dbe4bbd
-  data.tar.gz: c979ae5a583898d47c1b8501d19ea651f31013a78461008c4ed6eff69c6b1a271c2c812dbbc2a52bc82d90b7caf67e9a286e8d488639eb8bd5a8fd6678c91659
+  metadata.gz: 75a8af0bc9495b4ba65688914eaf2ac94e4b08756581a3e6f193c390376ae6d905d08321ba8c8017675e1d2991ce1c699176f74c4c7b4b3b7aa91edbd8b37325
+  data.tar.gz: ea3368515e1fb001874e4e932902e063bb2e1cbf015cb352c2813313bb97abd80c446e5f9ab623fa11dbc0dc8e9c164c5b1947475d7a43c935da91ac34c9be22

data/.rubocop.yml

@@ -1,39 +1,70 @@
 AllCops:
-  TargetRubyVersion: 2.5.1
+  TargetRubyVersion: 2.7.8
   Exclude:
     - 'config/routes.rb'
+  NewCops: enable
 
-Metrics/LineLength:
-  Enabled: false
-Metrics/BlockLength:
-  ExcludedMethods: [context, describe]
-  Max: 50
+Metrics/ClassLength:
+  Max: 500
+Metrics/ModuleLength:
+  Max: 300
 Metrics/MethodLength:
   Max: 50
-Metrics/ClassLength:
-  Max: 200
 Metrics/AbcSize:
   Max: 30
-
-ParameterLists:
+Metrics/ParameterLists:
   Max: 5
   CountKeywordArgs: false
+Metrics/BlockLength:
+  CountAsOne: ['array', 'heredoc', 'method_call']
+  Max: 50
+Metrics/CyclomaticComplexity:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 30
 
-Style/StringLiterals:
+Style/AccessorGrouping:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/BlockDelimiters:
+  BracesRequiredMethods: ['log']
+Style/ClassAndModuleChildren:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
-Style/CommentedKeyword:
+Style/StringLiterals:
   Enabled: false
-Style/MultilineBlockChain:
+Style/StringLiteralsInInterpolation:
   Enabled: false
 Style/Documentation:
   Enabled: false
-Style/StringLiteralsInInterpolation:
+Style/CommentedKeyword:
+  Enabled: false
+Style/MultilineBlockChain:
   Enabled: false
 Style/AndOr:
   Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/FetchEnvVar:
+  Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: true
 
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+Layout/LeadingCommentSpace:
+  Enabled: false
+  AllowGemfileRubyComment: true
+Layout/ParameterAlignment:
+  Enabled: false
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: symmetrical
+Layout/LineLength:
+  Enabled: true
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
 Layout/SpaceInsideBlockBraces:
@@ -42,14 +73,22 @@ Layout/SpaceAroundOperators:
   Enabled: false
 Layout/ExtraSpacing:
   AllowForAlignment: true
+  AllowBeforeTrailingComments: true
 Layout/AccessModifierIndentation:
   EnforcedStyle: indent
 Layout/DotPosition:
   EnforcedStyle: trailing
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
 Naming/VariableNumber:
   EnforcedStyle: snake_case
+  CheckSymbols: false
+Naming/MethodParameterName:
+  AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io']
+Naming/RescuedExceptionsVariableName:
+  Enabled: false

data/CHANGELOG.md

@@ -1,13 +1,16 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [1.1.8] - 2024-03-xx
+## [1.1.8] - 2024-03-23
 
-### Added
 ### Changed
+  - A lot of code tidy up
+
 ### Fixed
+  - `Ecoportal::API::Common::Conent::CollectionModel`
+    - correct `item` `klass` resolution
 
-## [1.1.7] - 2024-03-xx
+## [1.1.7] - 2024-03-13
 
 ### Added
   - `Ecoportal::API::Common::Concerns::Benchmarkable`

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

@@ -7,13 +7,9 @@ module Ecoportal
         #   - Its purpose is to handle an Array of basic objects (i.e. `Date`, `String`, `Number`)
         class ArrayModel < Content::DoubleModel
           class TypeMismatchedComparison < StandardError
-            def initialize (this: nil, that: msg = "Trying to compare objects with different behavior.")
-              if this
-                msg += " From object with 'order_matters: #{this.order_matters?}' and 'uniq: #{this.uniq?}'."
-              end
-              if that
-                msg += " To object where 'order_matters: #{that.order_matters?}' and 'uniq: #{that.uniq?}'."
-              end
+            def initialize(this: nil, that: msg = "Trying to compare objects with different behavior.")
+              msg += " From object with 'order_matters: #{this.order_matters?}' and 'uniq: #{this.uniq?}'." if this
+              msg += " To object where 'order_matters: #{that.order_matters?}' and 'uniq: #{that.uniq?}'."  if that
               super(msg)
             end
           end
@@ -27,7 +23,8 @@ module Ecoportal
             # @param b [ArrayModel]
             # @return [Boolean] `true` if both elements have same behaviour
             def same_type?(a, b)
-              raise "To use this comparison both objects should be `ArrayModel`" unless a.is_a?(ArrayModel) && b.is_a?(ArrayModel)
+              msg = "To use this comparison both objects should be `ArrayModel`"
+              raise msg unless a.is_a?(ArrayModel) && b.is_a?(ArrayModel)
               (a.order_matters? == b.order_matters?) && (a.uniq? == b.uniq?)
             end
           end
@@ -38,12 +35,25 @@ module Ecoportal
             super(doc, parent: parent, key: key, read_only: read_only)
           end
 
-          def order_matters?; self.class.order_matters; end
-          def uniq?;          self.class.uniq;          end
+          def order_matters?
+            self.class.order_matters
+          end
+
+          def uniq?
+            self.class.uniq
+          end
+
+          def length
+            count
+          end
 
-          def length;   count;      end
-          def empty?;   count == 0; end
-          def present?; count > 0;  end
+          def empty?
+            count&.zero?
+          end
+
+          def present?
+            count&.positive?
+          end
 
           def each(&block)
             return to_enum(:each) unless block
@@ -66,10 +76,10 @@ module Ecoportal
             _items.slice(0..-1)
           end
 
-          # @param value [Object, Array<Object>, ArrayModel] the value(s) of the new object
+          # @param other [Object, Array<Object>, ArrayModel] the value(s) of the new object
           # @return [ArrayModel] a new object with the current class
-          def new_from(value)
-            self.class.new(into_a(value))
+          def new_from(other)
+            self.class.new(into_a(other))
           end
 
           # @return [ArrayModel] a copy of the current object
@@ -93,28 +103,28 @@ module Ecoportal
           # @param pos [Integer] the position of the element
           # @param value [String, Date, Number] the element
           # @return [Date, String, Number]
-          def []=(post, value)
+          def []=(pos, value)
             _items[pos] = value
             on_change
             self[pos]
           end
 
           # Compares with an `Array` or another `ArrayModel`
-          # @param a [ArrayModel, Array]
-          def ==(a)
-            return true if self.equal?(a)
-            return false unless (a.class == self.class) || a.is_a?(Array)
-            case a
+          # @param other [ArrayModel, Array]
+          def ==(other)
+            return true  if equal?(other)
+            return false unless (other.class == self.class) || other.is_a?(Array)
+
+            case other
             when Array
-              self == new_from(a)
+              self == new_from(other)
             when ArrayModel
-              return true if
-              raise TypeMismatchedComparison.new(this: self, that: a) unless self.class.same_type?(self, a)
+              raise TypeMismatchedComparison.new(this: self, that: other) unless self.class.same_type?(self, other)
 
-              if self.order_matters?
-                _items == a.to_a
+              if order_matters?
+                _items == other.to_a
               else
-                (_items - a.to_a).empty? && (a.to_a - _items).empty?
+                (_items - other.to_a).empty? && (other.to_a - _items).empty?
               end
             end
           end
@@ -154,11 +164,10 @@ module Ecoportal
           end
 
           # Resets the `Array` by keeping its reference and adds the value(s)
-          # @param value [Object, Array<Object>, ArrayModel] the value(s) to be added
-          # @param values [Array]
-          def <(values)
+          # @param other [Object, Array<Object>, ArrayModel] the value(s) to be added
+          def <(other)
             _items.clear
-            self << values
+            self << other
           end
 
           # Clears the `Array` keeping its reference
@@ -169,25 +178,25 @@ module Ecoportal
           end
 
           # Concat to new
-          def +(value)
-            new_from(self.to_a + into_a(value))
+          def +(other)
+            new_from(to_a + into_a(other))
           end
 
           # Join
-          # @param value [Object, Array<Object>, ArrayModel] the value(s) to be joined
+          # @param other [Object, Array<Object>, ArrayModel] the value(s) to be joined
           # @return [ArrayModel] a new object instance with the intersection done
-          def |(value)
-            new = new_from(value) - self
-            new_from(to_a + new.to_a)
+          def |(other)
+            oth = new_from(other) - self
+            new_from(to_a + oth.to_a)
           end
 
           # Intersect
-          # @param value [Object, Array<Object>, ArrayModel] the value(s) to be deleted
+          # @param other [Object, Array<Object>, ArrayModel] the value(s) to be deleted
           # @return [ArrayModel] a new object instance with the intersection done
-          def &(value)
-            self.dup.tap do |out|
-              self.dup.tap do |delta|
-                delta.delete!(*into_a(value))
+          def &(other)
+            dup.tap do |out|
+              dup.tap do |delta|
+                delta.delete!(*into_a(other))
                 out.delete!(*into_a(delta))
               end
             end
@@ -196,9 +205,9 @@ module Ecoportal
           # Subtract
           # @param value [Object, Array<Object>, ArrayModel] the value(s) to be deleted
           # @return [ArrayModel] a **copy** of the object with the elements subtracted
-          def -(value)
-            self.dup.tap do |copy|
-              copy.delete!(*into_a(value))
+          def -(other)
+            dup.tap do |copy|
+              copy.delete!(*into_a(other))
             end
           end
 
@@ -206,7 +215,7 @@ module Ecoportal
           def delete!(*values)
             values.map do |v|
               deletion!(v)
-            end.tap do |r|
+            end.tap do |_r|
               on_change
             end
           end
@@ -216,43 +225,41 @@ module Ecoportal
           # @param val1 [Object] the first value to swap
           # @param val2 [Object] the second value to swap
           # @return [Integer] the new of `value1`, `nil` if it wasn't moved
-          def swap(value1, value2)
-            index(value2).tap do |dest|
-              if dest && pos = index(value1)
-                _items[dest] = value1
-                _items[pos]  = value2
+          def swap(val_1, val_2)
+            index(val_2).tap do |dest|
+              if dest && (pos = index(val_1))
+                _items[dest] = val_1
+                _items[pos]  = val_2
               end
             end
           end
 
           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
-                  when used_param?(before) && before
-                    index(before)
-                  when used_param?(after) && after
-                    if i = index(after) then i + 1 end
-                  end
+            idx = index(value)
+            return idx if idx && uniq?
+
+            pos =
+              if used_param?(pos) && pos
+                pos
+              elsif used_param?(before) && before
+                index(before)
+              elsif used_param?(after) && after
+                if (idx = index(after)) then idx + 1 end
+              end
 
+            # use last position as default
             pos ||= length
-            pos.tap do |i|
+            pos.tap do |_i|
               _items.insert(pos, value)
               on_change
             end
           end
 
           # TODO
-          def move(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-            if i = index(value)
-              unless i == pos
-
-                on_change
-              end
-              pos
-            end
+          def move(value, pos: NOT_USED, _before: NOT_USED, _after: NOT_USED)
+            return    unless (idx = index(value))
+            on_change unless idx == pos
+            pos
           end
 
           protected
@@ -270,13 +277,9 @@ module Ecoportal
           end
 
           def deletion!(value)
-            if !uniq?
-              if i = _items.index(value)
-                _items.slice!(i)
-              end
-            else
-              _items.delete(value)
-            end
+            return _items.delete(value) if uniq?
+            return                      unless (idx = _items.index(value))
+            _items.slice!(idx)
           end
         end
       end

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

@@ -5,7 +5,7 @@ module Ecoportal
       module Content
         module ClassHelpers
           include Common::BaseClass
-          NOT_USED = "no_used!"
+          NOT_USED = "no_used!".freeze
 
           # Class resolver
           # @note it caches the resolved `klass`es
@@ -18,21 +18,21 @@ module Ecoportal
             @resolved ||= {}
             @resolved[klass] ||=
               case klass
-                when Class
-                  klass
-                when String
-                  begin
-                    Kernel.const_get(klass)
-                  rescue NameError => e
-                    raise if exception
-                  end
-                when Symbol
-                  source_class.resolve_class(source_class.send(klass))
-                when Hash
-                  referrer, referred = klass.first
-                  resolve_class(referred, source_class: referrer, exception: exception)
-                else
-                  raise "Unknown class: #{klass}" if exception
+              when Class
+                klass
+              when String
+                begin
+                  Kernel.const_get(klass)
+                rescue NameError
+                  raise if exception
+                end
+              when Symbol
+                source_class.resolve_class(source_class.send(klass))
+              when Hash
+                referrer, referred = klass.first
+                resolve_class(referred, source_class: referrer, exception: exception)
+              else
+                raise "Unknown class: #{klass}" if exception
               end
           end
 
@@ -41,11 +41,11 @@ module Ecoportal
           # @param key [String, Symbol] to be normalized
           # @return [String] a correct constant name
           def to_constant(key)
-            str_name = key.to_s.strip.split(/::/).compact.map do |str|
+            key.to_s.strip.split(/::/).compact.map do |str|
               str.slice(0).upcase + str.slice(1..-1)
-            end.join("").split(/[\-\_ :]+/i).compact.map do |str|
+            end.join.split(/[\-\_ :]+/i).compact.map do |str|
               str.slice(0).upcase + str.slice(1..-1)
-            end.join("")
+            end.join
           end
 
           # Helper to create an instance variable `name`
@@ -60,7 +60,7 @@ module Ecoportal
           # Generates random ids in hexadecimal to use in class name generation.
           # @param len [Integeter] length of the `uid`
           # @return [String] a random unique id of length `len`
-          def uid(len = 8);
+          def uid(len = 8)
             SecureRandom.hex(len/2)
           end
 
@@ -72,8 +72,8 @@ module Ecoportal
           # @yieldparam child_class [Class] the new class
           # @return [Class] the new generated class
           def new_class(name = "Child#{uid}", inherits: self, namespace: inherits)
-            name            = name.to_s.to_sym.freeze
-            class_name      = to_constant(name)
+            name       = name.to_s.to_sym.freeze
+            class_name = to_constant(name)
 
             unless target_class = resolve_class("#{namespace}::#{class_name}", exception: false)
               target_class = Class.new(inherits)
@@ -92,19 +92,17 @@ module Ecoportal
           # @return
           def to_time(value, exception: true)
             case value
-            when NilClass
+            when Time, NilClass
               value
             when String
               begin
                 Time.parse(value)
-              rescue ArgumentArgument => e
+              rescue ArgumentArgument
                 raise if exception
                 nil
               end
             when Date
               Time.parse(value.to_s)
-            when Time
-              value
             else
               to_time(value.to_s) if value.respond_to?(:to_s)
             end
@@ -147,6 +145,7 @@ module Ecoportal
           #   - mutating methods would reflect the changes on other classes as well
           #   - therefore, `freeze` will be called on the values that are inherited.
           def inherited(subclass)
+            super
             inheritable_class_vars.each do |var|
               instance_var = instance_variable_name(var)
               value        = instance_variable_get(instance_var)