ecoportal-api-v2 2.0.9 → 2.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5640c86f2f87990f7d4c3906f4732ee196b757966c3c3cc08f0a87e458ccb4a5
-  data.tar.gz: c90366a05f7c35fc77a0d8374384258277092e9d7b3ee25f458ab815a41162ce
+  metadata.gz: 0a93753cf1640abe95935d227eb0518f39e4dc007da9c2771d872bbcc7f0f7ff
+  data.tar.gz: 7fc6475b6d05011ab94bc3774922afe0e6c0501420633556c7580455dc26724e
 SHA512:
-  metadata.gz: 2aa98c2d721ff735425e9c21aee036698e5467a3c010e35d84921d9352ae12400f627c8a2a16359177ac22e583a417b05302c852b513b3d6d6bc4743b8cac170
-  data.tar.gz: f356407dfd38797be43f29ad02d7a1772c7136cf1d686eb2554dc226316184aa70e27c89b9de39d52725ab6b95505149a1d7b38a39897915862d8a0dfa33e3ca
+  metadata.gz: 210a1b99d67ee7aa17e5ae3050a1c23d65a4a41c625dfa6d5cd016e8a32f1d346aff9c2ce94a846188a47a74f97ffde28df05af7425d9269aebdc5a84bb8b0c8
+  data.tar.gz: 841d3d7e2b8396f673e76d7b6e14eeea773acda0bc323f60af86741032ff2e6a6bc4c79a6bce873f8b7a51f699718b67d0103773b690cd9236421b7ff75cff27

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2.0.10] - 2024-08-xx
+## [2.0.12] - 2024-10-xx
 
 ### Added
 
@@ -10,6 +10,27 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [2.0.11] - 2024-10-18
+
+### Changed
+
+- upgrade `ecoportal-api` core gem
+
+### Fixed
+
+- `Ecoportal::API::V2::Page::Component::ReferenceField#delete`
+  - It wasn't deleting references
+
+## [2.0.10] - 2024-10-01
+
+### Added
+
+- development dependency: `rubocop`
+
+### Changed
+
+- upgraded core `ecoportal-api` **gem** dependency
+
 ## [2.0.9] - 2024-08-22
 
 ### Added

data/README.md

@@ -1,5 +1,3 @@
-**Originally ---> 'ecoportal-api-oozes'**
-
 # Ecoportal::API::V2
 
 This is a basic collection of helpers that can be used to interact with the
@@ -15,12 +13,11 @@ gem 'ecoportal-api-v2', require: %w[ecoportal/api-v2]
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install ecoportal-api-v2
-
+    gem install ecoportal-api-v2
 
 ## Changelog
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'rubocop/rake_task'
 require "yard"
 require "redcarpet"
 
@@ -16,12 +17,20 @@ RSpec::Core::RakeTask.new(:spec_fast) do |task|
   task.rspec_opts = ['--fail-fast', '--backtrace']
 end
 
+desc "run rubocop diaplying cop names"
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
 # default task name is yard
 desc "Yard: generate all the documentation"
 YARD::Rake::YardocTask.new(:doc) do |t|
   #t.files = ['lib/**/*.rb']
 end
 
-task :default     => [:spec]
-task :rspec_trace => :spec_trace
-task :rspec_fast  => :spec_fast
+desc "default task: runs rubocop and rspec"
+task :default do
+  Rake::Task[:rubocop].invoke
+ensure
+  Rake::Task[:spec].invoke
+end

data/ecoportal-api-v2.gemspec

@@ -1,12 +1,14 @@
+# rubocop:disable Gemspec/DevelopmentDependencies
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ecoportal/api/v2_version"
+
+require 'ecoportal/api/v2_version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ecoportal-api-v2"
+  spec.name          = 'ecoportal-api-v2'
   spec.version       = Ecoportal::API::GEM2_VERSION
-  spec.authors       = ["Oscar Segura"]
-  spec.email         = ["rien@ecoportal.co.nz", "oscar@ecoportal.co.nz", "bozydar@ecoportal.co.nz"]
+  spec.authors       = ['Oscar Segura']
+  spec.email         = ['oscar@ecoportal.co.nz']
 
   spec.summary       = "A collection of helpers for interacting with the ecoPortal MS's V2 API"
   spec.homepage      = "https://www.ecoportal.com"
@@ -19,16 +21,20 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "pry"      , '~> 0.14'
-  spec.add_development_dependency "rake",      '>= 13.0.3', "< 14"
-  spec.add_development_dependency "redcarpet", '>= 3.6.0',  "< 4"
-  spec.add_development_dependency "rspec",     '>= 3.12.0', "< 4"
-  spec.add_development_dependency "yard",      '~>  0.9.34'
+  spec.add_development_dependency 'pry',       '~> 0.14'
+  spec.add_development_dependency 'rake',      '>= 13.0.3', '< 14'
+  spec.add_development_dependency 'redcarpet', '>= 3.6.0',  '< 4'
+  spec.add_development_dependency 'rspec',     '>= 3.12.0', '< 4'
+  spec.add_development_dependency 'rubocop',   '~> 1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0'
+  spec.add_development_dependency 'yard',         '~> 0.9'
 
-  spec.add_dependency 'ecoportal-api', '~> 0.10'
-  spec.add_dependency 'mime-types',    '~> 3.5', '>= 3.5.2'
+  spec.add_dependency 'ecoportal-api', '~> 0.10', '>= 0.10.5'
+  spec.add_dependency 'mime-types',    '~> 3.5',  '>= 3.5.2'
 end
+
+# rubocop:enable Gemspec/DevelopmentDependencies

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

@@ -1,3 +1,4 @@
+# rubocop:disable Naming/MethodParameterName
 module Ecoportal
   module API
     module Common
@@ -5,9 +6,9 @@ module Ecoportal
         module HashDiffPatch
           extend DocHelpers
 
-          ID_KEYS    = %w[id]
-          META_KEYS  = %w[id patch_ver]
-          NO_CHANGES = "%not-changed!%"
+          ID_KEYS    = %w[id].freeze
+          META_KEYS  = %w[id patch_ver].freeze
+          NO_CHANGES = "%not-changed!%".freeze
 
           class << self
             # The `patch data` is built as follows:
@@ -38,14 +39,13 @@ module Ecoportal
             # @param b [Hash] previous hash model
             # @return [Hash] a `patch data`
             def patch_diff(a, b)
-              case
-              when b.is_a?(Hash) && !empty?(b) && empty?(a)
+              if b.is_a?(Hash) && !empty?(b) && empty?(a)
                 patch_delete(b)
-              when a.is_a?(Hash) && !empty?(a) && empty?(b)
+              elsif a.is_a?(Hash) && !empty?(a) && empty?(b)
                 patch_new(a)
-              when a.is_a?(Hash) && b.is_a?(Hash)
+              elsif a.is_a?(Hash) && b.is_a?(Hash)
                 patch_update(a, b)
-              when any_array?(a, b)
+              elsif any_array?(a, b)
                 patch_data_array(a, b)
               else
                 a
@@ -54,9 +54,12 @@ module Ecoportal
 
             private
 
-            def equal_values(a, b)
+            def equal_values?(a, b)
               if a.is_a?(String) || b.is_a?(String)
-                return true if a.to_s.strip.empty? && b.to_s.strip.empty?
+                a_empty = a.to_s.strip.empty?
+                b_empty = b.to_s.strip.empty?
+
+                return true if a_empty && b_empty
               end
               a == b
             end
@@ -66,124 +69,137 @@ module Ecoportal
             def patch_data(a, b = nil, delete: false)
               {}.tap do |data_hash|
                 if delete
-                  patch_ver = (a && a["patch_ver"]) || 1
-                  data_hash["patch_ver"] = patch_ver
+                  patch_ver = (a && a['patch_ver']) || 1
+                  data_hash['patch_ver'] = patch_ver
                   next
                 end
+
                 a.each do |key, a_value|
-                  b_value = b[key] if b_has_key = b && b.key?(key)
-                  is_meta_key = META_KEYS.include?(key)
-                  skip_equals = b_has_key && equal_values(a_value, b_value)
-                  next if is_meta_key || skip_equals
+                  next if META_KEYS.include?(key)
+
+                  b_value = nil
+
+                  if b&.key?(key)
+                    b_value = b[key]
+                    next if equal_values?(a_value, b_value)
+                  end
+
                   data_hash[key] = patch_diff(a_value, b_value)
+
                   data_hash.delete(key) if data_hash[key] == NO_CHANGES
                 end
+
                 #if (data_hash.keys - ID_KEYS).empty?
-                if (data_hash.keys - META_KEYS).empty?
-                  return NO_CHANGES
-                else
-                  #patch_ver = (b && b["patch_ver"]) || 1
-                  #data_hash["patch_ver"] = patch_ver
-                  if b && b.key?("patch_ver")
-                    data_hash["patch_ver"] = b["patch_ver"]
-                  elsif a && a.key?("patch_ver")
-                    data_hash["patch_ver"] = a["patch_ver"]
-                  end
-                  data_hash.delete("force_patch")
+                return NO_CHANGES if (data_hash.keys - META_KEYS).empty?
+
+                if b&.key?('patch_ver')
+                  data_hash['patch_ver'] = b['patch_ver']
+                elsif a&.key?('patch_ver')
+                  data_hash['patch_ver'] = a['patch_ver']
                 end
+
+                data_hash.delete("force_patch")
               end
             end
 
             def patch_delete(b)
               return NO_CHANGES unless b.is_a?(Hash)
-              if id = get_id(b, exception: false)
-                {
-                  "id"        => id,
-                  "operation" => "deleted",
-                  "data"      => patch_data(b, delete: true)
-                }
-              else
-                nil
-              end
+              return nil        unless (id = get_id(b, exception: false))
+
+              {
+                'id'        => id,
+                'operation' => 'deleted',
+                'data'      => patch_data(b, delete: true)
+              }
             end
 
             def patch_new(a)
               return NO_CHANGES unless a.is_a?(Hash)
-              if id = get_id(a, exception: false)
-                {
-                  "id"        => id,
-                  "operation" => "new",
-                  "data"      => patch_data(a)
-                }
-              else
-                a
-              end
+              return a          unless (id = get_id(a, exception: false))
+
+              {
+                'id'        => id,
+                'operation' => 'new',
+                'data'      => patch_data(a)
+              }
             end
 
             def patch_update(a, b)
               return NO_CHANGES unless a.is_a?(Hash)
-              if id = get_id(a, exception: false)
-                {
-                  "id"        => id,
-                  "operation" => "changed",
-                  "data"      => patch_data(a, b)
-                }.tap do |update_hash|
-                  return nil unless update_hash["data"] != NO_CHANGES
-                end
-              else
-                a
+              return a          unless (id = get_id(a, exception: false))
+
+              {
+                'id'        => id,
+                'operation' => 'changed',
+                'data'      => patch_data(a, b)
+              }.tap do |update_hash|
+                return nil unless update_hash['data'] != NO_CHANGES
               end
             end
 
             def patch_data_array(a, b)
+              return patch_data_nested_array(a, b) if nested_array?(a, b)
+
+              patch_data_flat_array(a, b)
+            end
+
+            def patch_data_flat_array(a, b)
               original_b = b
-              a ||= []; b ||= []
-              if !nested_array?(a, b)
-                if a.length == b.length && (a & b).length == b.length
-                  if original_b
-                    NO_CHANGES
-                  else
-                    a
-                  end
-                else
-                  a
-                end
-              else # array with nested elements
-                a_ids = array_ids(a)
-                b_ids = array_ids(b)
-
-                del_ids = b_ids - a_ids
-                oth_ids = b_ids & a_ids
-                new_ids = a_ids - b_ids
-
-                arr_delete = del_ids.map do |id|
-                  patch_delete(array_id_item(b, id))
-                end.compact
-
-                arr_update = oth_ids.map do |id|
-                  patch_update(array_id_item(a, id), array_id_item(b, id))
-                end.compact
-
-                arr_new = new_ids.map do |id|
-                  patch_new(array_id_item(a, id))
-                end.compact
-
-                (arr_delete.concat(arr_update).concat(arr_new)).tap do |patch_array|
-                  # remove data with no `id`
-                  patch_array.reject! {|item| !item.is_a?(Hash)}
-                  return NO_CHANGES if patch_array.empty?
-                end
+              a        ||= []
+              b        ||= []
+
+              same_elements =
+                a.length == b.length &&
+                (a & b).length == b.length
+
+              return a          unless same_elements
+              return NO_CHANGES if original_b
+
+              a
+            end
+
+            def patch_data_nested_array(a, b)
+              a ||= []
+              b ||= []
+
+              # array with nested elements
+              a_ids = array_ids(a)
+              b_ids = array_ids(b)
+
+              del_ids = b_ids - a_ids
+              oth_ids = b_ids & a_ids
+              new_ids = a_ids - b_ids
+
+              arr_delete = del_ids.map do |id|
+                patch_delete(array_id_item(b, id))
+              end.compact
+
+              arr_update = oth_ids.map do |id|
+                patch_update(array_id_item(a, id), array_id_item(b, id))
+              end.compact
+
+              arr_new = new_ids.map do |id|
+                patch_new(array_id_item(a, id))
+              end.compact
+
+              arr_delete.concat(arr_update).concat(arr_new).tap do |patch_array|
+                # remove data with no `id`
+                patch_array.select! {|item| item.is_a?(Hash)}
+                return NO_CHANGES if patch_array.empty?
               end
             end
 
             def nested_array?(*arr)
-              case
-              when arr.length > 1
+              if arr.length > 1
                 arr.any? {|a| nested_array?(a)}
-              when arr.length == 1
-                arr = arr.first
+              elsif arr.length == 1
+                arr = arr.first || []
                 arr.any? do |item|
-                  item.is_a?(Hash) && item.has_key?("patch_ver")
+                  next false unless item.is_a?(Hash)
+                  next true  if item.key?('patch_ver')
+                  # next true  if item.key?('id')
+
+                  false
                 end
               else
                 false
@@ -197,11 +213,13 @@ module Ecoportal
             def empty?(a)
               bool   = !a
               bool ||= a.respond_to?(:empty?) && a.empty?
+              bool
             end
-
           end
         end
       end
     end
   end
 end
+
+# rubocop:enable Naming/MethodParameterName

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

@@ -16,18 +16,18 @@ module Ecoportal
 
             def reference_ids
               references.map do |ref|
-                ref["id"]
+                ref['id']
               end
             end
 
             def add(*ref_ids)
-              doc["references"].tap do |refs|
+              doc['references'].tap do |refs|
                 ref_ids.each do |ref_id|
                   next if reference_ids.include?(ref_id)
                   refs.push({
-                    "id"        => ref_id,
-                    "weight"    => 0,
-                    "patch_ver" => 0
+                    'id'        => ref_id,
+                    'weight'    => 0,
+                    'patch_ver' => 0
                   })
                 end
               end
@@ -39,13 +39,20 @@ module Ecoportal
 
             def delete(*ref_ids)
               ref_ids.each do |ref_id|
-                doc_ref = doc["references"].find do |df|
-                  df["id"] == ref_id
+                doc_ref = doc['references'].find do |df|
+                  df['id'] == ref_id
                 end
 
                 next unless doc_ref
 
-                doc["references"].delete(doc_ref)
+                ori_ref = original_doc['references'].find do |od|
+                  od['id'] == ref_id
+                end
+
+                # force patch version
+                ori_ref['patch_ver'] ||= 0
+
+                doc['references'].delete(doc_ref)
               end
             end
 

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = '2.0.9'.freeze
+    GEM2_VERSION = '2.0.11'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.0.11
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -84,20 +84,48 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: ecoportal-api
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +133,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -112,6 +143,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.5
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -134,9 +168,7 @@ dependencies:
         version: 3.5.2
 description:
 email:
-- rien@ecoportal.co.nz
 - oscar@ecoportal.co.nz
-- bozydar@ecoportal.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -270,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's V2 API