ecoportal-api-v2 0.8.6 → 0.8.10

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

@@ -5,7 +5,8 @@ module Ecoportal
         class Component
           class Image < Common::Content::DoubleModel
             passkey     :id
-            passthrough :patch_ver, :weight
+            passforced  :patch_ver, default: 1
+            passthrough :weight
             passthrough :height, :width, :caption
             passthrough :dimensions, :styles
           end

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

@@ -13,11 +13,67 @@ module Ecoportal
               end
             end
 
-            passthrough :layout, :strech, :no_popup, :hide_options
+            passthrough :layout
+            passboolean :strech, :no_popup, :hide_options
             embeds_many :images, klass: "Ecoportal::API::V2::Page::Image", order_key: :weight
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:strech` to make the image fit the full size of the image field
+            #   - `:popup` to set to enable disable poupup on `click`
+            #   - `:layout_button` to offer layout options to user
+            #   - `:layout` with the following available values
+            #     - `:three_crop` to specify _3 across_ by cutting the image to equalize size
+            #     - `:three` to specify _3 across_
+            #     - `:two` to specify _2 across_
+            #     - `:one` to specify _Full width (1 Across)_
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :strech
+                  self.strech = true
+                when :popup
+                  self.no_popup = false
+                when :layout_button
+                  self.hide_options = false
+                when Hash
+                  supported = [:layout_button, :layout]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+
+                  if cnf.key?(:layout_button) then self.hide_options = !cnf[:layout_button] end
+                  if cnf.key?(:layout) then configure_layour cnf[:layout] end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
+            private
+
+            def configure_layout(value)
+              case value
+              when :three
+                self.layout = "third"
+              when :two
+                self.layout = "half"
+              when :one
+                self.layout = "fill"
+              when :three_crop
+                self.layout = "third_crop"
+              else
+                # Unsupported
+              end
+            end
+
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/image'

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

@@ -4,6 +4,7 @@ module Ecoportal
       class Page
         class Component
           class NumberField < Page::Component
+            passthrough :value
           end
         end
       end

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

@@ -4,17 +4,125 @@ 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
+            embeds_many :viewable_fields, klass: "Ecoportal::API::V2::Page::Component::PeopleViewableField"
+
+            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
 
-            def add(id)
-              people_ids << id
+            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
+
+            # Adds a field to the `viewable_fields`
+            def add_viewable(field_id, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
+              viewable_fields.upsert!({"id" => field_id}, pos: pos, before: before, after: after)
+            end
+
+            # Deletes a field from the `viewable_fields`
+            def delete_viewable(field_id)
+              viewable_fields.delete!(field_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
@@ -23,3 +131,5 @@ module Ecoportal
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/people_viewable_field'

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,18 +4,20 @@ 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
 
-            def numeric!
-              data_type = "num"
+            def numeric!(&block)
+              ordered_options.each {|opt| opt.numeric!(&block)}
+              self.data_type = "num"
             end
 
-            def text!
-              data_type = "str"
+            def text!(&block)
+              ordered_options.each {|opt| opt.text!(&block)}
+              self.data_type = "str"
             end
 
             def select(value)
@@ -42,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
@@ -61,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

@@ -4,19 +4,30 @@ module Ecoportal
       class Page
         class Component
           class SelectionOption < Common::Content::DoubleModel
-            
+
             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
+            end
+
+            def text!
+              self.value = block_given?? yield(value) : value.to_s
+            end
+
           end
         end
       end