ecoportal-api-v2 0.8.8 → 0.8.12

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class PeopleViewableField < Common::Content::DoubleModel
+            passkey     :id
+            passthrough :type, read_only: true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,8 +5,40 @@ module Ecoportal
         class Component
           class PlainTextField < Page::Component
             passthrough :value
-            passthrough :multiline, :max_length
-            pass_reader :exact_index
+            passboolean :multiline
+            passthrough :max_length
+            passboolean :exact_index
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:multiline` multi line mode
+            #   - `:singleline` signle line mode
+            #   - `:exact_index` to make the `value` indexed as a **whole** (as opposite to its parts or n-grams)
+            #   - `:max_length` specify the maximum length of the `value`
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :multiline
+                  self.multiline = true
+                when :singleline
+                  self.multiline = false
+                when :exact_index
+                  self.exact_index = true
+                when Hash
+                  supported = [:multiline, :max_length]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:multiline)  then self.multiline = !!cnf[:multiline] end
+                  if cnf.key?(:max_length) then self.max_length = cnf[:max_length] end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
           end
         end
       end

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

@@ -5,9 +5,38 @@ module Ecoportal
         class Component
           class ReferenceField < Page::Component
             passthrough :register_id
-            passthrough :hide_create, :hide_attach
-            passthrough :hide_metadata, :hide_dashboards
-            passthrough :display_fields, :display_fields_in_lookup
+            passboolean :hide_create, :hide_attach
+            passboolean :hide_metadata, :hide_dashboards
+            passboolean :display_fields, :display_fields_in_lookup
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:show_fields` specify if the public register fields should be shown (requires `register_id`)
+            #   - `:create` specify if the `NEW` button should appear
+            #   - `:attach` specify if the `ATTACH` button should appear
+            #   - `:metadata` specify if `metadata` should be shown (i.e. status)
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :show_fields
+                  self.display_fields = true
+                  self.display_fields_in_lookup = true
+                when Hash
+                  supported = [:create, :attach, :metadata]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:create)   then self.hide_create = !cnf[:create] end
+                  if cnf.key?(:attach)   then self.hide_attach = !cnf[:attach] end
+                  if cnf.key?(:metadata) then self.hide_metadata = !cnf[:metadata] end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
           end
         end
       end

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

@@ -4,8 +4,8 @@ module Ecoportal
       class Page
         class Component
           class SelectionField < Page::Component
-            passthrough :multiple, :flat
-            passthrough :other, :other_desc
+            passboolean :multiple, :flat, :other
+            passthrough :other_desc
             passthrough :data_type
 
             embeds_many :options, klass: "Ecoportal::API::V2::Page::Component::SelectionOption", order_key: :weight
@@ -44,7 +44,7 @@ module Ecoportal
               end
             end
 
-            def add_option(name:, value:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+            def add_option(value:, name: nil, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
               opt_doc = options.items_class.new_doc
               options.upsert!(opt_doc, pos: pos, before: before, after: after) do |option|
                 option.name  = name
@@ -63,8 +63,64 @@ module Ecoportal
               end.map(&:first)
             end
 
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:flat` to display in flat mode
+            #   - `:multiple` to allow multiple selection
+            #   - `:single` to set to singular selection
+            #   - `:other` to enable `other` button
+            #   - `:options` to add options (`Hash<value, name>`)
+            #   - `:type` to define the type
+            #     - `:num`
+            #     - `:str`
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :flat
+                  self.flat  = true
+                when :multiple
+                  self.multiple = true
+                when :single
+                  self.multiple = false
+                when :other
+                  self.other = true
+                when Hash
+                  supported = [:flat, :options, :type]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+
+                  if cnf.key?(:flat) then self.flat = cnf[:flat] end
+                  if cnf.key?(:options)
+                    if opts = cnf[:options]
+                      configure_options opts
+                    end
+                  end
+                  if cnf.key?(:type)
+                    if cnf[:type] == :str
+                      self.text!
+                    elsif cnf[:type] == :num
+                      self.numeric!
+                    else
+                      # Unknown type
+                    end
+                  end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
             private
 
+            def configure_options(opts)
+              opts.each do |val, nm|
+                add_option(value: val, name: nm)
+              end
+            end
+
             def fix_option_weights!
               ordered_options.each_with_index do |option, index|
                 option.weight = index

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

@@ -8,15 +8,17 @@ module Ecoportal
             class << self
               def new_doc
                 {
-                  "id"     => new_uuid,
-                  "weight" => 9999
+                  "id"         => new_uuid,
+                  "weight"     => 9999
                 }
               end
             end
 
             passkey     :id
-            passthrough :patch_ver, :name, :value
-            passthrough :weight, :selected
+            passforced  :patch_ver, default: 1
+            passthrough :name, :value
+            passthrough :weight
+            passboolean :selected
 
             def numeric!
               self.value = block_given?? yield(value) : value.to_i

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

@@ -13,8 +13,9 @@ module Ecoportal
               end
             end
 
-            passthrough :signed_by_id, :signed_by_name, :signature_url
-            passdate    :signature_updated_at
+            passthrough :signed_by_id, :signed_by_name, read_only: true
+            passthrough :signature_url, read_only: true
+            passdate    :signature_updated_at, read_only: true
             passthrough :signature_content, :color
 
           end

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

@@ -4,8 +4,38 @@ module Ecoportal
       class Page
         class Component
           class TagField < Page::Component
-            passthrough :single_select, :use_defaults
+            passboolean :single_select, :use_defaults
             passthrough :tag_tree_id, :button_text
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:multiple` to allow multiple selection
+            #   - `:single` to set to singular selection
+            #   - `:default_tag` to prepopulate using users's `default_tag`
+            #   - `:button_text` to define the button description
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :single
+                  self.single_select = true
+                when :multiple
+                  self.single_select = false
+                when :default_tag
+                  self.use_defaults = true
+                when Hash
+                  supported = [:button_text]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:button_text) then self.button_text = cnf[:button_text] end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
           end
         end
       end

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

@@ -26,13 +26,16 @@ module Ecoportal
 
           class << self
             def new_doc(type: nil)
-              if type
-                type_doc = {"type" => type}
-                base_doc = get_class(type_doc)&.new_doc || {}
-                base_doc.merge!(type_doc)
+              {
+                "id"         => new_uuid
+              }.tap do |base_doc|
+                if type
+                  base_doc.merge!({"type" => type})
+                  if klass = get_class(base_doc)
+                    base_doc.merge!(klass.new_doc || {})
+                  end
+                end
               end
-              return base_doc if base_doc&.key?("id")
-              (base_doc || {}).merge("id" => new_uuid)
             end
 
             def get_class(doc)
@@ -59,7 +62,6 @@ module Ecoportal
                 when "checklist"
                   checklist_field_class
                 when "page_action","checklist_task"
-                  #doc["type"] = "checklist_task"
                   action_field_class
                 when "file"
                   files_field_class
@@ -83,10 +85,12 @@ module Ecoportal
           end
 
           passkey     :id
-          passthrough :patch_ver, :undeletable
+          passforced  :patch_ver, default: 1
+          passboolean :undeletable
           passthrough :type, :label, :tooltip, :global_binding
-          passthrough :hidden, :accent, :deindex, :required
-          passthrough :hide_view, :hidden_on_reports, :hidden_on_mobile
+          passboolean :hidden, :deindex, :required
+          passthrough :accent
+          passboolean :hide_view, :hidden_on_reports, :hidden_on_mobile
           passarray   :refs
 
           def ref_backend
@@ -107,6 +111,36 @@ module Ecoportal
             self.class.indexable_label(label)
           end
 
+          # Quick config helper
+          # @param conf [Symbol, Array<Symbol>]
+          #   - `:required`
+          #   - `:hide_view` to hide in view mode
+          #   - `:hide_mobile` to hide in mobile app
+          #   - `:hide_reports` to hide in reports
+          #   - `:global` to define a global binding
+          def configure(*conf)
+            conf.each_with_object([]) do |cnf, unused|
+              case cnf
+              when :required
+                self.required  = true
+              when :hide_view
+                self.hide_view = true
+              when :hide_mobile
+                self.hidden_on_mobile = true
+              when :hide_reports
+                self.hidden_on_reports = true
+              when Hash
+                if cnf.key?(:global)
+                  self.global_binding = cnf[:global]
+                end
+              else
+                unused.push(cnf)
+              end
+            end.tap do |unused|
+              raise "Unsupported configuration options '#{unused}' for #{self.class}" unless unused.empty?
+            end
+          end
+
         end
       end
     end

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

@@ -13,6 +13,12 @@ module Ecoportal
 
           order_matters = true
 
+          def get_by_id(id)
+            self.find do |comp|
+              comp.id == id
+            end
+          end
+
           def get_by_type(type)
             self.select do |comp|
               comp.type.downcase == type.to_s.strip.downcase
@@ -21,10 +27,9 @@ module Ecoportal
 
           def get_by_name(name, type: nil)
             pool = type ? get_by_type(type) : self
-
             pool.select do |comp|
-              comp.label.to_s.strip.downcase == name.to_s.strip.downcase
-            end.first
+              same_string?(comp.label, name)
+            end
           end
 
           def add(label:, type:)

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

@@ -0,0 +1,67 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class PermissionFlags < Common::Content::DoubleModel
+          class << self
+            def new_doc
+              {
+                "can_restructure"          => false,
+                "can_configure"            => false,
+                "can_permission"           => false,
+                "can_create_actions"       => false,
+                "can_administrate_actions" => false,
+                "subscribed"               => false,
+                "subscribed_to_tasks"      => false
+              }
+            end
+          end
+
+          passboolean :can_restructure, :can_configure
+          passboolean :can_permission, :can_create_actions, :can_administrate_actions
+          passboolean :subscribed, :subscribed_to_tasks
+
+          def reset!
+            doc.merge!(self.class.new_doc)
+          end
+
+          # Quick config helper
+          # @param conf [Symbol, Array<Symbol>]
+          #   - `:restructure`
+          #   - `:configure`
+          #   - `:can_permission`
+          #   - `:create_actions`
+          #   - `:admin_actions`
+          #   - `:subscribed`
+          #   - `:subscribed_to_tasks`
+          def configure(*conf)
+            conf.each_with_object([]) do |cnf, unused|
+              case cnf
+              when :restructure
+                self.can_restructure = true
+              when :configure
+                self.can_configure  = true
+              when :can_permission
+                self.can_permission = true
+              when :create_actions
+                self.can_create_actions = true
+              when :admin_actions
+                self.can_administrate_actions = true
+              when :subscribed
+                self.subscribed = true
+              when :subscribed_to_tasks
+                self.subscribed_to_tasks = true
+              else
+                unused.push(cnf)
+              end
+            end.yield_self do |unused|
+              raise "Unknown configuaration options #{unused}" unless unused.empty?
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -4,9 +4,10 @@ module Ecoportal
       class Page
         class Permit < Common::Content::DoubleModel
           passkey     :id
-          passthrough :patch_ver
+          passforced  :patch_ver, default: 1
           passthrough :user_id, :user_name
           passthrough :editable, :flags
+          embeds_one  :flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
         end
       end
     end