ecoportal-api-oozes 0.5.6 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b995a0d1c80408bc83f797ffe14f0bf8457d1e1be99eac780f3924c19d6efbe
-  data.tar.gz: f06fae1cf1aaf5fbcc7fdc102a3f78f55da137d3ab9c5f12a5852c6d74d99af3
+  metadata.gz: 169653f85a26c45f2b60eb95358dd7e547185b07a5a722bb56643a63daa1fb1f
+  data.tar.gz: 696de7a2f37b8fcf7409be373bfb491b4fa70bfc504cace816a4b64076cb9bd7
 SHA512:
-  metadata.gz: a2cf8d4e48892f6f31e6b852f8aeff840af65729d5d811596561f4841d77a2063a23d2dd0b111a67a1e8feafee12cf892c02fa4acab46e1b3a55af39554ab54e
-  data.tar.gz: 3fe6beb0b48d961544e227328eeb43676470feab25a0713987cab4d4a44d0ec52a52f8f512a27be183efdbd1de4ac8cdddccd929ddbe859f8e1169ee3107bb95
+  metadata.gz: 6b134337977269a67e49d451bad2a854da602724326483e72cfa3c95cbb012d6f8fbbd88742d9f58fba019869c7c11ae5e14f74e2ae8756daaa8035ab9658d09
+  data.tar.gz: 342dbf60de74361387b383428a8b066184c9b0ce73dba98f3761da5c83b5efd8393da8cc7e836b58bf47aacac660493d316b93be0a88a3876c7d7195ab7afb49

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [0.6.1] - 2020-07-11
+
+### Added
+  - `Ecoportal::API::Common::Content::DoubleModel#pretty_print`
+### Changed
+### Fixed
+
+## [0.6.0] - 2020-07-11
+
+### Added
+### Changed
+  - upgraded `ecoportal-api` gem
+### Fixed
+
+## [0.5.9] - 2020-07-02
+
+### Added
+  - helper `Ecoportal::API::Common::Content::StringDigest#indexable_label`: to see the part of a label that gets indexed
+  - this `CHANGELOG.md` file
+### Changed
+### Fixed

data/ecoportal-api-oozes.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
   spec.add_development_dependency "pry"
 
-  spec.add_dependency 'ecoportal-api',  '~> 0.5', '>= 0.5.5'
+  spec.add_dependency 'ecoportal-api',  '~> 0.6', '>= 0.6.0'
 end

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

@@ -30,13 +30,6 @@ module Ecoportal
               (a.order_matters? == b.order_matters?) && (a.uniq? == b.uniq?)
             end
 
-            # Creates a new object with `doc` where `original_doc` is `[]`
-            def create(doc)
-              self.new([]).tap do |page|
-                page.replace_doc(doc)
-              end
-            end
-
           end
 
           def initialize(doc = {}, parent: self, key: nil)
@@ -226,7 +219,6 @@ module Ecoportal
             end
           end
 
-          # TODO
           def insert_one(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             i = index(value)
             return i if (i && uniq?)

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

@@ -80,13 +80,6 @@ module Ecoportal
               end
             end
 
-            # Creates a new object with `doc` where `original_doc` is `[]`
-            def create(doc)
-              self.new([]).tap do |page|
-                page.replace_doc(doc)
-              end
-            end
-
           end
 
           include Enumerable
@@ -152,18 +145,20 @@ module Ecoportal
           # Tries to find the element `value`, if it exists, it updates it
           # Otherwise it pushes it to the end
           # @return the element
-          def upsert!(value)
+          def upsert!(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
             unless value.is_a?(Hash) || value.is_a?(Content::DoubleModel)
               raise "'Content::DoubleModel' or 'Hash' doc required"
             end
             item_doc = value.is_a?(Content::DoubleModel)? value.doc : value
+            item_doc = JSON.parse(item_doc.to_json)
             if item = self[value]
-              item.replace_doc(JSON.parse(item_doc.to_json))
+              item.replace_doc(item_doc)
             else
-              item = new_item(item_doc)
-              _doc_items << item.doc
+              _doc_upsert(item_doc, pos: pos, before: before, after: after)
+            end
+            (item || self[item_doc]).tap do |item|
+              yield(item) if block_given?
             end
-            item
           end
 
           protected
@@ -172,6 +167,10 @@ module Ecoportal
           def uniq?;          self.class.uniq;          end
           def items_key;      self.class.items_key;     end
 
+          def on_change
+            variables_remove!
+          end
+
           # Gets the `key` of the object
           def get_key(value)
             case value
@@ -205,11 +204,9 @@ module Ecoportal
             self.class.new_item(value, parent: self)
           end
 
-          private
-
           # Helper to remove tracked down instance variables
           def variable_remove!(key)
-            if (k = get_key(key)) && (item = @items_by_key[k])
+            if @items_by_key && (k = get_key(key)) && (item = @items_by_key[k])
               _items.delete(item) if _items.include?(item)
               @items_by_key.delete(k)
             else
@@ -223,6 +220,36 @@ module Ecoportal
             super
           end
 
+          def _doc_upsert(value, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+            current_pos = _doc_key(value)
+            pos = case
+              when used_param?(pos)
+                pos
+              when used_param?(before)
+                _doc_key(before)
+              when used_param?(after)
+                puts "to add after #{after.id}"
+                if i = _doc_key(after)
+                  i + 1
+                end
+              end
+
+            pos ||= current_pos
+
+            if current_pos && pos
+              _doc_items.delete(current_pos)
+              pos = (pos <= current_pos)? pos : pos - 1
+            end
+            
+            pos = (pos && pos < _doc_items.length)? pos : _doc_items.length
+
+            pos.tap do |i|
+              _doc_items.insert(pos, value)
+              on_change
+            end
+
+          end
+
         end
       end
     end

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

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module Ecoportal
   module API
     module Common
@@ -28,6 +30,10 @@ module Ecoportal
               @key = value.to_s.freeze
             end
 
+            def new_uuid(length: 12)
+              SecureRandom.hex(length)
+            end
+
             # Same as `attr_reader` but links to a subjacent `Hash` model property
             # @note it does **not** create an _instance variable_
             def pass_reader(*methods)
@@ -154,13 +160,6 @@ module Ecoportal
               embeds_one(method, key: key, multiple: true, klass: dim_class)
             end
 
-            # Creates a new object with `doc` where `original_doc` is `{}`
-            def create(doc)
-              self.new({}).tap do |page|
-                page.replace_doc(doc)
-              end
-            end
-
           end
 
           attr_reader :_parent, :_key
@@ -253,10 +252,10 @@ module Ecoportal
             end
           end
 
-          #def print
-          #  puts JSON.pretty_generate(as_json)
-          #  self
-          #end
+          def pretty_print
+            puts JSON.pretty_generate(as_json)
+            self
+          end
 
           def replace_doc(new_doc)
             raise UnlinkedModel.new(from: "#{self.class}#replace_doc", key: _key) unless linked?
@@ -306,7 +305,7 @@ module Ecoportal
 
           # Removes all the persistent variables
           def variables_remove!
-            @_dim_vars.map {|k| variable_remove!(k)}
+            @_dim_vars.dup.map {|k| variable_remove!(k)}
           end
 
           private

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

@@ -108,10 +108,15 @@ module Ecoportal
             end
 
             def patch_data_array(a, b)
+              original_b = b
               a ||= []; b ||= []
               if !nested_array?(a, b)
                 if a.length == b.length && (a & b).length == b.length
-                  NO_CHANGES
+                  if original_b
+                    NO_CHANGES
+                  else
+                    a
+                  end
                 else
                   a
                 end

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

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

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

@@ -23,6 +23,13 @@ module Ecoportal
           class_resolver :law_field_class,        "Ecoportal::API::V2::Page::Component::LawField"
 
           class << self
+            def new_doc(type:)
+              {
+                "id"   => new_uuid,
+                "type" => type
+              }
+            end
+
             def get_class(doc)
               if doc.is_a?(Hash)
                 case doc["type"]
@@ -81,6 +88,10 @@ module Ecoportal
             root.sections.find {|sec| sec.component?(id)}
           end
 
+          def indexable_label
+            self.class.indexable_label(label)
+          end
+
         end
       end
     end

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

@@ -33,6 +33,42 @@ module Ecoportal
               end
             end
 
+            # a server bug prevents to add new options to an existing field
+            def add_option(name:, value:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              opt_doc = Ecoportal::API::V2::Page::Component::SelectionOption.new_doc
+              options.upsert!(opt_doc, pos: pos, before: before, after: after) do |option|
+                option.name  = name
+                option.value = value
+                if prev = previous_option(option)
+                  option.weight = prev.weight
+                end
+                yield(option) if block_given?
+                fix_option_weights!
+              end
+            end
+
+            def ordered_options
+              options.each_with_index.sort_by do |option, index|
+                (option.weight >= 9999) ? [index, index] : [option.weight, index]
+              end.map(&:first)
+            end
+
+            private
+
+            def fix_option_weights!
+              ordered_options.each_with_index do |option, index|
+                option.weight = index
+              end
+            end
+
+            def previous_option(value)
+              opts = ordered_options
+              pos  = opts.index(value) - 1
+              return if pos < 0
+              opts[pos]
+            end
+
+
           end
         end
       end

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

@@ -4,6 +4,15 @@ module Ecoportal
       class Page
         class Component
           class SelectionOption < Common::Content::DoubleModel
+            class << self
+              def new_doc
+                {
+                  "id"     => new_uuid,
+                  "weight" => 9999
+                }
+              end
+            end
+
             passkey     :id
             passthrough :patch_ver, :name, :value
             passthrough :weight, :selected

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

@@ -27,6 +27,14 @@ module Ecoportal
             end.first
           end
 
+          def add(label:, type:)
+            fld_doc = Ecoportal::API::V2::Page::Component.new_doc(type: type)
+            upsert!(fld_doc) do |fld|
+              fld.label  = label
+              yield(fld) if block_given?
+            end
+          end
+
         end
       end
     end

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

@@ -3,6 +3,28 @@ module Ecoportal
     class V2
       class Page
         class Section < Common::Content::DoubleModel
+          class << self
+            def new_doc(split: false)
+              {
+                "id"     => new_uuid,
+                "type"   => split ? "split" : "content",
+                "weight" => 9999
+              }.tap do |out|
+                component_ids = if split
+                    {
+                      "left_component_ids" => [],
+                      "right_component_ids" => []
+                    }
+                  else
+                    {
+                      "component_ids" => []
+                    }
+                  end
+                out.merge!(component_ids)
+              end
+            end
+          end
+
           passkey     :id
           passthrough :patch_ver, :weight, :type
           passthrough :heading, :left_heading, :right_heading
@@ -22,9 +44,9 @@ module Ecoportal
           end
 
           def components
-            sec_ids = all_component_ids
-            root.components.values_at(*sec_ids).select.with_index do |fld, i|
-              puts "Warning: section #{id} points to missing field #{sec_ids[i]}" if !fld
+            fld_ids = all_component_ids
+            root.components.values_at(*fld_ids).select.with_index do |fld, i|
+              puts "Warning: field #{id} points to missing field #{fld_ids[i]}" if !fld
               fld && (!block_given? || yield(fld))
             end
           end

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

@@ -7,6 +7,39 @@ module Ecoportal
 
           self.klass = :section_class
 
+          def add(name: nil, split: false, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+            sec_doc = Ecoportal::API::V2::Page::Section.new_doc(split: split)
+            upsert!(sec_doc, pos: pos, before: before, after: after) do |section|
+              section.heading  = name
+              if prev = previous_section(section)
+                section.weight = prev.weight
+              end
+              yield(section) if block_given?
+              #fix_weights! # a server bug prevents to set the weight of existing sections
+            end
+          end
+
+          def ordered
+            each_with_index.sort_by do |section, index|
+              (section.weight >= 9999) ? [index, index] : [section.weight, index]
+            end.map(&:first)
+          end
+
+          private
+
+          def fix_weights!
+            ordered.each_with_index do |section, index|
+              section.weight = index
+            end
+          end
+
+          def previous_section(value)
+            secs = ordered
+            pos  = secs.index(value) - 1
+            return if pos < 0
+            secs[pos]
+          end
+
         end
       end
     end

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

@@ -9,6 +9,19 @@ module Ecoportal
           passarray   :subtags, order_matters: false
           passarray   :section_ids
           passthrough :can
+
+          def sections
+            sec_ids = section_ids.to_a
+            root.sections.values_at(*sec_ids).select.with_index do |sec, i|
+              puts "Warning: section #{id} points to missing section #{sec_ids[i]}" if !sec
+              fld && (!block_given? || yield(sec))
+            end.sort_by {|sec| sec.weight}
+          end
+
+          def attach_section(section)
+            section_ids.insert_one(section.id)
+          end
+
         end
       end
     end

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

@@ -13,12 +13,6 @@ module Ecoportal
             end
           end
 
-          def sections
-            section_ids.map do |id|
-              root.sections.find {|sec| sec.id == id}
-            end
-          end
-
         end
       end
     end

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

@@ -41,7 +41,7 @@ module Ecoportal
               return stages.get(pid: pid, sid: sid)
             end
           end
-          raise "Could not get page #{id} - Error #{response.status}: #{response.body}"
+          raise "Could not get page #{pid} - Error #{response.status}: #{response.body}"
         end
 
         # Gets a `new` non-existing page via api with all the ids initialized.
@@ -53,7 +53,6 @@ module Ecoportal
           wrapped  = Common::Content::WrappedResponse.new(response, page_class)
 
           return wrapped.result if wrapped.success?
-          #return page_class.create(response.body["data"]) if response.success?
           raise "Could not get new page from template #{id} - Error #{response.status}: #{response.body}"
         end
 

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

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class V2
-      GEM_VERSION = "0.5.6"
+      GEM_VERSION = "0.6.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-oozes
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.1
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,22 +110,22 @@ dependencies:
   name: ecoportal-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: 
 email:
 - rien@ecoportal.co.nz
@@ -140,6 +140,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md