ecoportal-api-v2 1.1.4 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7774c15da9ae5d6ff253f7a3d3035d6943e6d4de9b68dbd648ea16b6b815b9e
-  data.tar.gz: b87045d030a5648294c0d9ed186cb2324d4df008e19fdb97d6ae2d8a4cc3fe38
+  metadata.gz: b6294103b68ebdbf099d1137865856b10baec21683bd648727976f245cf197ad
+  data.tar.gz: e0500e2c784a46c7a82ca3aa29e44f96d116bd6898e5b35f9174162457208165
 SHA512:
-  metadata.gz: c4586c46e7921caa02d561e9a4b13ff2f2c1cc41d64f4501fff54edb6edb733a43b9adb8d38e93a95c1fbd475f6e837ef6a5ce4a003c338e81dd1d729201f223
-  data.tar.gz: b388223450b1324e3a6e46051b07e2266e275c561ffdc2506354714f259a81e825e5772c22a9608d13c6d90b3e76b2b4a2ce372fc231108f78532a7068335c3b
+  metadata.gz: eb18fb2a167afeaea5eac0db4e13ee58d64fc348ff1ebd33942ad1bb7120cbb828ad2652ed2d6b165d7a1b53eea097338032690e26ee97f5765fd87ba2f97862
+  data.tar.gz: 7a61a35335247d39a0e97574f5b2816a92238d93a9f5b23c62b909a92ae03817057752ffc576ae1414c5e6744a6381b473be4cd2cfc2a0fd4e7582cffd97bdd4

data/CHANGELOG.md

@@ -1,17 +1,33 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [1.1.4] - 2024-02-xx
+## [1.1.7] - 2024-02-xx
 
 ### Added
-  - Support for new fields
-    - `Ecoportal::API::V2::Page::Component::ActionsField`
-    - `Ecoportal::API::V2::Page::Component::MailboxField`
-
 ### Changed
-  - core gem **upgrade**
+### Fixed
+
+## [1.1.6] - 2024-02-29
+
+### Added
+  - A bit of **specs** on object retrieval for `Ecoportal::API::Common::Conent::CollectionModel`
+  - `Ecoportal::API::Registers::PageResult` exposed `membranes`
+    - with new object `Ecoportal::API::Registers::PageResult::MembraneDroplet`
 
 ### Fixed
+  - `Ecoportal::API::Common::Conent::CollectionModel`
+
+## [1.1.5] - 2024-02-03
+
+### Changed
+  - Upgrade gem dependencies
+
+## [1.1.4] - 2024-02-01
+
+### Added
+  - Support for new fields
+    - `Ecoportal::API::V2::Page::Component::ActionsField`
+    - `Ecoportal::API::V2::Page::Component::MailboxField`
 
 ## [1.1.3] - 2023-06-28
 

data/README.md

@@ -20,3 +20,8 @@ And then execute:
 Or install it yourself as:
 
     $ gem install ecoportal-api-v2
+
+
+## Changelog
+
+See {file:CHANGELOG.md} for a list of changes.

data/ecoportal-api-v2.gemspec

@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.4.9",  "< 3"
-  spec.add_development_dependency "rspec",     ">= 3.10.0", "< 4"
+  spec.add_development_dependency "bundler",   ">= 2.4.12", "< 3"
+  spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
   spec.add_development_dependency "rake",      ">= 13.0.3", "< 14"
-  spec.add_development_dependency "yard",      ">= 0.9.26", "< 1"
-  spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 4"
+  spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
+  spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
   spec.add_development_dependency "pry"      , ">= 0.14"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.9.5', '< 0.10'
+  spec.add_dependency 'ecoportal-api', '>= 0.9.6', '< 0.10'
 end

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

@@ -11,6 +11,8 @@ module Ecoportal
             attr_writer   :klass
             attr_accessor :order_matters, :order_key
 
+            # The attr that has been defined as `passkey`
+            # in the item class
             def items_key
               @items_key ||= "id"
             end
@@ -22,6 +24,8 @@ module Ecoportal
             # Resolves to the nuclear `Class` of the elements
             # @note
             #   - use block to define `klass` callback
+            # @note When `klass` is resolved, if the items are of type
+            #   `DoubleModel`, it sets on the collection class the `items_key`
             # @param value [Hash] base `doc` (raw object) to create the object with
             # @yield [doc] identifies the target `class` of the raw object
             # @yieldparam doc [Hash]
@@ -31,6 +35,7 @@ module Ecoportal
               if block
                 @klass = block
                 block.call(value) if value != NOT_USED
+                @klass
               elsif used_param?(value)
                 if @klass.is_a?(Proc)
                   @klass.call(value)
@@ -39,6 +44,10 @@ module Ecoportal
                 end
               else
                 resolve_class(@klass, exception: false)
+              end.tap do |result|
+                next unless result.is_a?(Class)
+                next unless result < Ecoportal::API::Common::Content::DoubleModel
+                self.items_key = result.key
               end
             end
 
@@ -127,7 +136,17 @@ module Ecoportal
                 #print "{{#{p}}}"
               end
             else
-              raise UnlinkedModel.new("Can't find child: #{value}")
+              show_str = \
+                case value
+                when Hash
+                  value.pretty_inspect
+                when Content::DoubleModel
+                  "#{value} with key: #{value.class.key} (items_key: #{self.class.items_key})"
+                else
+                  value
+                end
+
+              raise UnlinkedModel, "Can't find child: #{show_str}"
             end
           end
 

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

@@ -28,6 +28,8 @@ module Ecoportal
               !!key
             end
 
+            # key property (and method) of this model
+            # @note this is auto-set when `passkey` is used
             def key=(value)
               @key = value.to_s.freeze
             end
@@ -72,7 +74,7 @@ module Ecoportal
             # This method is essential to give stability to the model
             # @note `Content::CollectionModel` needs to find elements in the doc `Array`.
             #  The only way to do it is via the access key (i.e. `id`). However, there is
-            #  no chance you can avoid invinite loop for `get_key` without setting an
+            #  no chance you can avoid infinite loop for `get_key` without setting an
             #  instance variable key at the moment of the object creation, when the
             #  `doc` is firstly received
             # @param method [Symbol] the method that exposes the value
@@ -263,6 +265,7 @@ module Ecoportal
 
           inheritable_class_vars :forced_model_keys, :key
 
+          # `_key` refers to the parent's property that links to this model
           attr_reader :_parent, :_key, :_read_only
 
           def initialize(doc = {}, parent: self, key: nil, read_only: false)
@@ -321,6 +324,8 @@ module Ecoportal
             if is_root?
               @doc
             else
+              # transform parent's `_key` to this object into a
+              # path key that can rerieve from the parents's doc
               _parent.doc.dig(*[_doc_key(_key)].flatten)
             end
           end

data/lib/ecoportal/api/v2/registers/page_result/membrane_droplet.rb

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class PageResult
+          class MembraneDroplet < Common::Content::DoubleModel
+            passkey     :ref
+            passthrough :label, :type, :value
+            passthrough :field_configuration_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v2/registers/page_result.rb

@@ -12,10 +12,14 @@ module Ecoportal
           passthrough :mould_counter
 
           class_resolver :stages_class, "Ecoportal::API::V2::Registers::StagesResult"
-          embeds_many    :stages, enum_class: :stages_class
-        end
+          embeds_many    :stages, enum_class: :stages_class, read_only: true
 
+          class_resolver :mem_droplet, "Ecoportal::API::V2::Registers::PageResult::MembraneDroplet"
+          embeds_many    :membranes, klass: :mem_droplet, read_only: true
+        end
       end
     end
   end
 end
+
+require_relative 'page_result/membrane_droplet'

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "1.1.4"
+    GEM2_VERSION = "1.1.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.6
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.9
+        version: 2.4.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.9
+        version: 2.4.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -76,7 +76,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.9.34
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -86,7 +86,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.9.34
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -96,7 +96,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -140,7 +140,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -156,7 +156,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -242,6 +241,7 @@ files:
 - lib/ecoportal/api/v2/people.rb
 - lib/ecoportal/api/v2/registers.rb
 - lib/ecoportal/api/v2/registers/page_result.rb
+- lib/ecoportal/api/v2/registers/page_result/membrane_droplet.rb
 - lib/ecoportal/api/v2/registers/register.rb
 - lib/ecoportal/api/v2/registers/search_results.rb
 - lib/ecoportal/api/v2/registers/stage_result.rb

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1