ecoportal-api-v2 0.8.8 → 0.8.9

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

@@ -4,19 +4,117 @@ module Ecoportal
       class Page
         class Component
           class PeopleField < Page::Component
-            passthrough :is_me_button, :attach_mode
+            passboolean :is_me_button
+            passthrough :attach_mode
             passthrough :person_schema_id
             pass_reader :viewable_fields
-            passthrough :singular, :requires_number
+
+            passboolean :singular
+            passthrough :requires_number
+
             passarray   :people_ids
             pass_reader :cached_people
-            passthrough :attached_people_permissions_enabled, :apply_attached_people_permissions_to
-            passthrough :attached_people_permissions_editable, :attached_people_permissions_flags
 
+            passboolean :attached_people_permissions_enabled, :attached_people_permissions_editable
+            passthrough :apply_attached_people_permissions_to
+
+            embeds_one  :attached_people_permissions_flags, klass: "Ecoportal::API::V2::Page::PermissionFlags"
+
+            # Attaches people
             def add(*ids)
               people_ids << ids
             end
 
+            # Deletes people
+            def delete(*ids)
+              people_ids.reject! {|id| ids.include?(id)}
+            end
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:snapshot` to set mode to `snapshot`
+            #   - `:live` to set mode to `live`
+            #   - `:me_button` to display `ME` button
+            #   - `:permits` to define the permissions
+            #     - `:all` for _entire page/all stages_
+            #     - `:stages` for _all stages containing this field_
+            #     - `:page` for _page only_
+            #     - `:stage` for _only the stage containing this field when attached_
+            #     - `:restructure`
+            #     - `:configure`
+            #     - `:can_permission`
+            #     - `:create_actions`
+            #     - `:admin_actions`
+            #     - `:subscribed`
+            #     - `:subscribed_to_tasks`
+            #   - `requires: number` to fine the number of required people to be attached
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :snapshot
+                  self.attach_mode  = "snapshot"
+                when :live
+                  self.attach_mode  = "live"
+                when :me_button
+                  self.is_me_button = true
+                when :singular
+                  self.singular = true
+                when Hash
+                  supported = [:singular, :permits, :requires]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  
+                  if cnf.key?(:singular) then self.singular = !!cnf[:singular] end
+                  if cnf.key?(:permits)
+                    if permits = cnf[:permits]
+                      self.attached_people_permissions_enabled = true
+                      configure_permits(*[permits].flatten.compact)
+                    else
+                      self.attached_people_permissions_enabled = false
+                    end
+                  end
+                  if cnf.key?(:requires)
+                    self.singular = false
+                    if requires = cnf[:requires]
+                      self.required        = true
+                      self.requires_number = requires
+                    else
+                      self.required        = false
+                      self.requires_number = nil
+                    end
+                  end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
+            private
+
+            def configure_permits(*conf)
+              conf.each_with_object([]) do |cnf, flags|
+                case cnf
+                when :all
+                  self.apply_attached_people_permissions_to = "page"
+                when :stages
+                  self.apply_attached_people_permissions_to = "all_stages"
+                when :page
+                  self.apply_attached_people_permissions_to = "page_only"
+                when :stage
+                  self.apply_attached_people_permissions_to = "current_stage"
+                when :can_edit
+                  self.attached_people_permissions_editable = true
+                else
+                  flags.push(cnf)
+                end
+              end.yield_self do |flags|
+                self.attached_people_permissions_flags.configure *flags
+              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

@@ -16,7 +16,8 @@ module Ecoportal
 
             passkey     :id
             passthrough :patch_ver, :name, :value
-            passthrough :weight, :selected
+            passthrough :weight
+            passboolean :selected
 
             def numeric!
               self.value = block_given?? yield(value) : value.to_i

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/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/section.rb

@@ -8,7 +8,7 @@ module Ecoportal
               {
                 "id"     => new_uuid,
                 "type"   => split ? "split" : "content",
-                "weight" => 9999
+                "weight" => 800
               }.tap do |out|
                 component_ids = if split
                     {
@@ -44,10 +44,70 @@ module Ecoportal
             all_component_ids.include?(id)
           end
 
-          def components
-            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
+          def components(side: nil)
+            case side
+            when :right
+              components_right
+            when :left
+              components_left
+            when NilClass
+              components_by_id(*all_component_ids)
+            else
+              raise "Side should be one of [nil, :right, :left]. Given: #{side}"
+            end
+          end
+
+          def components_left
+            raise "You are trying to retrieve side components in a Split Section" unless split?
+            components_by_id(*left_component_ids)
+          end
+
+          def components_right
+            raise "You are trying to retrieve side components in a Split Section" unless split?
+            components_by_id(*right_component_ids)
+          end
+
+          # Adds `field` to the section
+          # @note
+          #   - To the specified `side`, when split section (default `:left`)
+          #   - To the end if `after` is not specified
+          #   - If `after` is specified, it searches field
+          #     - On the specific `side`, if specified (and split section)
+          #     - And adds the `field` after it, when found, or at the end if `after` is not found
+          # @param field [Ecoportal::API::V2::Page::Component] the field to be added.
+          def add_component(field, after: nil, side: nil)
+            raise "field should be a Ecoportal::API::V2::Page::Component. Given: #{field.class}" unless field.is_a?(Ecoportal::API::V2::Page::Component)
+            if field.section == self
+              raise "Field with id '#{field.id}' already belongs to this section"
+            elsif sec = field.section
+              # Field belongs to another section
+              raise "Field with id '#{field.id}' belongs to section '#{sec.heading || "Unnamed"}' (id: '#{sec.id}')"
+            end
+
+            if split?
+              ids_ary = side == :right ? right_component_ids : left_component_ids
+              fields  = components(side: side || :left)
+            else
+              ids_ary = component_ids
+              fields  = components
+            end
+            if after
+              after_fld = fields.find do |fld|
+                found   = nil
+                found ||= !!after if after.is_a?(Ecoportal::API::V2::Page::Component)
+                found ||= fld.id == after
+                found ||= same_string?(fld.label, after)
+              end
+            end
+            ids_ary.insert_one(field.id, after: after_fld&.id)
+            self
+          end
+
+          private
+
+          def components_by_id(*ids)
+            root.components.values_at(*ids).select.with_index do |fld, i|
+              puts "Warning: field id #{ids[i]} points to missing field" if !fld
               fld && (!block_given? || yield(fld))
             end
           end