ecoportal-api-v2 0.8.29 → 0.8.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca7591fd58fc849aefad7508d07e7902d5016ccaa19642dc7f8bb94b2ad445ca
-  data.tar.gz: c0a76091ed2702c29973d7295654f447425bf8e819e9684913bc71132eeccc9a
+  metadata.gz: f7fdd84d3767ffc6a9a5adfe976ad4a485754c076475d01da46877aa38e01d65
+  data.tar.gz: 8c775abd99edba549b7b8abe049ac06c631005671b972a9340795857b378d39a
 SHA512:
-  metadata.gz: aab5c8003ceb2d0bfc71169f9a2bcda26cb37253cad9a6ec277309c4d2c6bb1a3e4a4fc8717b69286a81b4b6cf43b8e3c969267171f5d4b529fefbe1c85e2da8
-  data.tar.gz: 96d45a7aba715ea08eb0b96f6920f2dae25a8f27383f460e4883bf79233a9efb2a26bea10025d7b8a7931b3450c9650e1518da52044c90e03f8edfcbba8f9058
+  metadata.gz: a4cc041705a2ac1e2ebe6eaaf7cc30fe79b780a1b5dc397bb1526fe0112df0a050d07452100e0174110e5cf30271ef1b3ddbb4f8b866c66824755c6f6bd287ad
+  data.tar.gz: 1bdb9cd3ff3cf0b64f282f4be9ec372c276c8deee7b47b8a142eab20069c2ef072966b87a1a1c9047e01a54895354bd7e2a9a404215eabf6bbc689641297b8d4

data/CHANGELOG.md

@@ -1,7 +1,50 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.29] - 2022-06-xx
+## [0.8.31] - 2022-08-xx
+
+### Added
+  - `Ecoportal::API:V2::Common::Content::ClassHelpers.uid` to generate a random uid
+
+### Changed
+  - added **inheritable attributes** to
+    - `Ecoportal::API:V2::Common::Content::ArrayModel` (:order_matteres, :uniq)
+    - `Ecoportal::API:V2::Common::Content::CollectionModel` (klass, :order_matters, :order_key, :items_key, :new_item)
+    - `Ecoportal::API:V2::Common::Content::DoubleModel` (:key)
+  - moved `SecureRandom` dependency to `Ecoportal::API:V2::Common::Content::ClassHelpers`
+
+### Fixed
+  - `Ecoportal::API::V2::Page::Component::SelectionOption#numeric!` fix conversion
+  - `Ecoportal::API:V2::Common::Content::ClassHelpers`, `new_class`
+    - **Added** parameter `namespace` (default: the class `inherits` parameter): it's purpose is to define the namespace where the new class will sit
+    - **Fixed** also the namespace where the new class constant will sit (it was using always the source class `self`)
+    - **Improved** `name` parameter to have a default value that is randomized. This is useful when we just want to do something like `SomeClass.new_class`, where the name of the new class doesn't really matter.
+  - **Fixed** lost reference of class resolvers when using `embeds_many`
+    - `Ecoportal::API:V2::Common::Content::ClassHelpers`, `resolve_class` accepts now a `Hash` with `key` referrer class, and `value` any of the previously accepted ones (i.e. `Symbol` or `String`). To this purpose, `source_class` parameter has been added.
+    - This has been natively wrapped in `Ecoportal::API:V2::Common::Content::DoubleModel.embeds_many`, as it naturally shares the `class_resolver` with a third party class that loses the reference.
+
+## [0.8.30] - 2022-07-11
+
+### Added
+  - `Ecoportal::API::V2::Page::MoultCounter`
+    - Available on `Ecoportal::API::V2::Pages::PageStage`
+  - `Ecoportal::API::V2::Page::Component#Law` added support for `LawField` content
+    - where `Ecoportal::API::V2::Page::Component#LawField` has many of
+  - `Ecoportal::API::V2::Component` added parameter `any_length:` for
+    - `#ref` and `#indexable_label` (aiming to enhance data exportability)
+
+### Changed
+  - Reviewed `to_s` method on multiple components, to ensure smooth export
+
+### Fixed
+  - `Ecoportal::API::V2::Pages::PageStage#uid`
+    - Should check if `mould_conter` exists
+    - Should return `id` if `mould_counter` does not exist
+  - **Exports**
+    - `Ecoportal::API::V2::Pages::Component::PeopleField#to_s`: fix type conversion
+    - `Ecoportal::API::V2::Pages::Component::DateField#to_s`: make time to work to the local timezone where the client script runs
+
+## [0.8.29] - 2022-07-07
 
 ### Added
   - `Ecoportal::API::V2::Page::Component::ActionField#permitted_person_schema_ids`

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

@@ -6,7 +6,7 @@ module Ecoportal
         # @note
         #   - Its purpose is to handle an Array of basic objects (i.e. `Date`, `String`, `Number`)
         class ArrayModel < Content::DoubleModel
-          class TypeMismatchedComparison < Exception
+          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?}'."
@@ -30,9 +30,10 @@ module Ecoportal
               raise "To use this comparison both objects should be `ArrayModel`" unless a.is_a?(ArrayModel) && b.is_a?(ArrayModel)
               (a.order_matters? == b.order_matters?) && (a.uniq? == b.uniq?)
             end
-
           end
 
+          inheritable_class_vars :order_matteres, :uniq
+
           def initialize(doc = [], parent: self, key: nil)
             super(doc, parent: parent, key: key)
           end

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

@@ -1,3 +1,4 @@
+require 'securerandom'
 module Ecoportal
   module API
     module Common
@@ -10,9 +11,10 @@ module Ecoportal
           # @note it caches the resolved `klass`es
           # @raise [Exception] when could not resolve if `exception` is `true`
           # @param klass [Class, String, Symbol] the class to resolve
+          # @param source_class [Class] when the reference to `klass` belongs to a different inheritance chain.
           # @param exception [Boolean] if it should raise exception when could not resolve
           # @return [Class] the `Class` constant
-          def resolve_class(klass, exception: true)
+          def resolve_class(klass, source_class: self, exception: true)
             @resolved ||= {}
             @resolved[klass] ||=
               case klass
@@ -25,18 +27,24 @@ module Ecoportal
                     raise if exception
                   end
                 when Symbol
-                  resolve_class(self.send(klass))
+                  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
 
           # Helper to normalize `key` into a correct `ruby` **constant name**
+          # @note it removes namespace syntax `::`
           # @param key [String, Symbol] to be normalized
           # @return [String] a correct constant name
           def to_constant(key)
-            str_name = key.to_s.strip.split(/[\-\_ ]/i).compact.map do |str|
-              str.slice(0).upcase + str.slice(1..-1).downcase
+            str_name = 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|
+              str.slice(0).upcase + str.slice(1..-1)
             end.join("")
           end
 
@@ -49,20 +57,27 @@ module Ecoportal
             str
           end
 
+          # 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);
+            SecureRandom.hex(len/2)
+          end
+
           # If the class for `name` exists, it returns it. Otherwise it generates it.
           # @param name [String, Symbol] the name of the new class
           # @param inherits [Class] the parent class to _inherit_ from
+          # @param namespace [Class, String] an existing `constant` (class or module) the new class will be namespaced on
           # @yield [child_class] configure the new class
           # @yieldparam child_class [Class] the new class
           # @return [Class] the new generated class
-          def new_class(name, inherits:)
+          def new_class(name = "Child#{uid}", inherits: self, namespace: inherits)
             name            = name.to_sym.freeze
             class_name      = to_constant(name)
-            full_class_name = "#{inherits}::#{class_name}"
 
-            unless target_class = resolve_class(full_class_name, exception: false)
+            unless target_class = resolve_class("#{namespace}::#{class_name}", exception: false)
               target_class = Class.new(inherits)
-              self.const_set class_name, target_class
+              Kernel.const_get(namespace.to_s).const_set class_name, target_class
             end
 
             target_class.tap do |klass|
@@ -138,7 +153,6 @@ module Ecoportal
               subclass.instance_variable_set(instance_var, value.freeze)
             end
           end
-
         end
       end
     end

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

@@ -82,11 +82,12 @@ module Ecoportal
                 klass.uniq          = uniq
               end
             end
-
           end
 
           include Enumerable
 
+          inheritable_class_vars :klass, :order_matters, :order_key, :items_key, :new_item
+
           def initialize(ini_doc = [], parent: self, key: nil)
             unless self.class.klass?
               raise "Undefined base 'klass' or 'new_item' callback for #{self.class}"

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

@@ -1,5 +1,3 @@
-require 'securerandom'
-
 module Ecoportal
   module API
     module Common
@@ -12,7 +10,7 @@ module Ecoportal
           extend Common::Content::ClassHelpers
           include Common::Content::ModelHelpers
 
-          class UnlinkedModel < Exception
+          class UnlinkedModel < StandardError
             def initialize (msg = "Something went wrong when linking the document.", from: nil, key: nil)
               msg += " From: #{from}." if from
               msg += " key: #{key}."   if key
@@ -31,8 +29,8 @@ module Ecoportal
               @key = value.to_s.freeze
             end
 
-            def new_uuid(length: 12)
-              SecureRandom.hex(length)
+            def new_uuid(length: 24)
+              uid(length)
             end
 
             # Same as `attr_reader` but links to a subjacent `Hash` model property
@@ -208,18 +206,24 @@ module Ecoportal
               else
                 raise "You should either specify the 'klass' of the elements or the 'enum_class'"
               end
-              embed(method, key: key, multiple: true, klass: eclass)
+              embed(method, key: key, multiple: true, klass: eclass) do |instance_with_called_method|
+                # keep reference to the original class to resolve the `klass` dependency
+                # See stackoverflow: https://stackoverflow.com/a/73709529/4352306
+                referrer_class = instance_with_called_method.class
+                eclass.klass = {referrer_class => klass} if klass
+              end
             end
 
             private
 
-            def embed(method, key: method, nullable: false, multiple: false, klass:)
+            def embed(method, key: method, nullable: false, multiple: false, klass:, &block)
               method = method.to_s.freeze
               var    = instance_variable_name(method).freeze
               k      = key.to_s.freeze
 
               # retrieving method (getter)
               define_method(method) do
+                yield(self) if block_given?
                 return instance_variable_get(var) if instance_variable_defined?(var)
                 unless nullable
                   doc[k] ||= multiple ? [] : {}
@@ -239,7 +243,7 @@ module Ecoportal
 
           end
 
-          inheritable_class_vars :forced_model_keys
+          inheritable_class_vars :forced_model_keys, :key
 
           attr_reader :_parent, :_key
 

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

@@ -7,16 +7,16 @@ module Ecoportal
         module StringDigest
           MAX_HASH_LABEL = 64
 
-          def indexable_label(str)
+          def indexable_label(str, any_length: false)
             return nil unless str
             lbl = str.downcase.gsub(/[^A-Za-z]+/,"-").slice(0, MAX_HASH_LABEL)
-            return nil unless lbl.length >= 3
+            return nil if (lbl.length < 3) && !any_length
             lbl
           end
 
           # Calculates the Hash of the field based on label
-          def hash_label(str)
-            return nil unless lbl = indexable_label(str)
+          def hash_label(str, any_length: false)
+            return nil unless lbl = indexable_label(str, any_length: any_length)
             "z" +  Digest::MD5.hexdigest(lbl).slice(0, 8);
           end
 

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

@@ -41,7 +41,6 @@ module Ecoportal
               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/date_field.rb

@@ -35,7 +35,8 @@ module Ecoportal
             end
 
             def to_s
-              value.to_s
+              return nil unless value
+              to_local_time(value).strftime(ISO8601)
             end
 
             # Quick config helper
@@ -78,6 +79,23 @@ module Ecoportal
 
             private
 
+            def to_local_time(value)
+              case value
+              when DateTime
+                value.new_offset(local_offset).to_time
+              when String
+                to_local_time(Time.parse(value))
+              when Date
+                to_local_time(value.to_time)
+              when Time
+                to_local_time(value.to_datetime)
+              end
+            end
+
+            def local_offset
+              @local_offset ||= DateTime.now.offset
+            end
+
             def configure_reminder(value)
               case value
               when :never, NilClass

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

@@ -22,7 +22,7 @@ module Ecoportal
             passdate    :file_update_at, read_only: true
 
             def to_s
-              file_container_id
+              [label, file_container_id].join(" => ")
             end
           end
         end

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

@@ -0,0 +1,32 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class Law < Common::Content::DoubleModel
+
+            class << self
+              def new_doc
+                {
+                  "id"         => new_uuid,
+                  "weight"     => 999
+                }
+              end
+            end
+
+            passkey     :id
+            passforced  :patch_ver, default: 1
+            passthrough :title, :weight
+            passthrough :content, :product
+            passthrough :legislation, :category, :topic
+            passdate    :updated_at, read_only: true
+
+            def to_s
+              [legislation, title, category, topic].join(" <:> ")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,9 +4,22 @@ module Ecoportal
       class Page
         class Component
           class LawField < Page::Component
+            embeds_many :snippets, klass: "Ecoportal::API::V2::Page::Component::Law", order_key: :weight
+
+            def ordered_snippets
+              snippets.sort_by.with_index do |snippet, index|
+                [snippet.weight, index]
+              end
+            end
+
+            def to_s(delimiter: "\n")
+              ordered_snippets.map(&:to_s).join(delimiter)
+            end
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/law'

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

@@ -5,6 +5,10 @@ module Ecoportal
         class Component
           class NumberField < Page::Component
             passthrough :value
+
+            def to_s
+              value
+            end
           end
         end
       end

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

@@ -41,7 +41,7 @@ module Ecoportal
             end
 
             def to_s(delimiter: "\n")
-              people_ids.join(delimiter)
+              people_ids.to_a.join(delimiter)
             end
 
             # Quick config helper

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

@@ -130,9 +130,9 @@ module Ecoportal
               end
             end
 
-            def to_s(name: true, delimiter: "\n")
+            def to_s(value: true, delimiter: "\n")
               [selected].flatten.compact.map do |opt|
-                name ? opt.name : opt.value
+                value ? opt.value : opt.name
               end.join(delimiter)
             end
 

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

@@ -30,7 +30,7 @@ module Ecoportal
 
             private
 
-            def to_i
+            def to_i(value)
               Float(value).to_i
             end
 

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

@@ -18,6 +18,9 @@ module Ecoportal
             passdate    :signature_updated_at, read_only: true
             passthrough :signature_content, :color
 
+            def to_s
+              [signed_by_name, signature_updated_at].join(" at ")
+            end
           end
         end
       end

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

@@ -101,8 +101,8 @@ module Ecoportal
             refs.first
           end
 
-          def ref
-            if digest = self.class.hash_label(label)
+          def ref(any_length: false)
+            if digest = self.class.hash_label(label, any_length: any_length)
               [type, digest].join(".")
             end
           end
@@ -144,8 +144,8 @@ module Ecoportal
             forces.count > 0
           end
 
-          def indexable_label
-            self.class.indexable_label(label)
+          def indexable_label(any_length: false)
+            self.class.indexable_label(label, any_length: any_length)
           end
 
           # Quick config helper

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

@@ -0,0 +1,32 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class MouldCounter < Common::Content::DoubleModel
+          UID_REGEX    = /^(?<prefix>.*?)(?<counter>\d+)(?<postfix>.*)$/i
+          STR_LEN      = 5
+          BASE_NUM_STR = "0" * STR_LEN
+
+          passthrough :prefix, :postfix
+          passthrough :counter
+          passthrough :render
+
+          def set(uid)
+            return nil unless uid.is_a?(String)
+            return nil unless match = uid.match(UID_REGEX)
+            self.counter = count_str(match[:counter])
+            self.prefix = match[:prefix]
+            self.postfix = match[:postfix]
+            self.render = "#{match[:prefix]}#{counter}#{match[:postfix]}"
+          end
+
+          private
+
+          def count_str(num)
+            (BASE_NUM_STR + num.to_s)[-5..-1]
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -3,20 +3,28 @@ module Ecoportal
     class V2
       class Pages
         class PageStage < V2::Page
-          passthrough :mould_counter, :archive
+          passthrough :archive
+          embeds_one :mould_counter, klass: "Ecoportal::API::V2::Page::MouldCounter"
           passthrough :task_priority, :state, :status
           passthrough :votes_enabled, :upvotes, :downvotes
 
           #embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
           passarray   :force_errors, :subtags, order_matters: false
 
+          # @return [Boolean] whether or not this entry has mould counter
+          def mould_counter?
+            !!doc["moult_counter"]
+          end
+
           # @return [String] unique id
           def uid
-            if counter = mould_counter
+            if mould_counter? && counter = mould_counter
               counter.render
+            else
+              id
             end
           end
-          
+
           # @return [String] `id` of the stage we got the data of.
           def current_stage_id
             doc.dig("active_stage", "id") || doc["current_stage_id"]
@@ -52,7 +60,6 @@ module Ecoportal
             end
             msg.empty?? true : msg
           end
-
         end
       end
     end

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.29"
+    GEM2_VERSION = "0.8.31"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.29
+  version: 0.8.31
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-07 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,7 @@ files:
 - lib/ecoportal/api/v2/page/component/geo_field.rb
 - lib/ecoportal/api/v2/page/component/image.rb
 - lib/ecoportal/api/v2/page/component/images_field.rb
+- lib/ecoportal/api/v2/page/component/law.rb
 - lib/ecoportal/api/v2/page/component/law_field.rb
 - lib/ecoportal/api/v2/page/component/number_field.rb
 - lib/ecoportal/api/v2/page/component/people_field.rb
@@ -222,6 +223,7 @@ files:
 - lib/ecoportal/api/v2/page/force/binding.rb
 - lib/ecoportal/api/v2/page/force/bindings.rb
 - lib/ecoportal/api/v2/page/forces.rb
+- lib/ecoportal/api/v2/page/mould_counter.rb
 - lib/ecoportal/api/v2/page/permission_flags.rb
 - lib/ecoportal/api/v2/page/permit.rb
 - lib/ecoportal/api/v2/page/section.rb