ecoportal-api-v2 0.8.8 → 0.8.9

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

@@ -4,16 +4,18 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Benchmark < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Benchmark < ChartField::Config
+              passthrough :register_id, :source_type
 
-              passthrough :register_id
-              passthrough :source_type
               passthrough :benchmark_field, :benchmark_label
-              passthrough :across, :across_field
+
+              passboolean :across
+              passthrough :across_field
+
+              passboolean :grouped
+              passthrough :group_field
+
               passthrough :against_field, :against_label
-              passthrough :grouped, :group_field
 
               passthrough :calculation_mode
               passthrough :min, :max

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

@@ -0,0 +1,23 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Config < Common::Content::DoubleModel
+
+              class << self
+                def new_doc
+                  {"id" => new_uuid}
+                end
+              end
+              
+              passkey     :id
+              passthrough :patch_ver
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,9 +4,7 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Frequency < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Frequency < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :mode, :input
@@ -14,7 +12,8 @@ module Ecoportal
               passthrough :secondary
 
               passthrough :output, :bar_mode
-              passthrough :series_size, :skip_zeroes
+              passthrough :series_size
+              passboolean :skip_zeroes
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false
 

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

@@ -4,9 +4,7 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Heatmap < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Heatmap < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :xinput, :xmode

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

@@ -4,15 +4,14 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Indicator < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Indicator < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :date_input, :secondary
-              passthrough :duration, :math_mode, :currency
+              passthrough :duration, :math_mode
 
-              passthrough :display_previous, :change_format, :invert_colors
+              passboolean :currency, :display_previous, :invert_colors
+              passthrough :change_format
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false
 

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

@@ -4,17 +4,15 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Multiseries < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Multiseries < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :xinput, :xlabel
               passthrough :interval, :calc_mode
 
               passthrough :yinput, :ylabel
-              passthrough :facet_by_discrete, :discrete_facet
-              passthrough :facet_by_tags
+              passboolean :facet_by_discrete, :facet_by_tags
+              passthrough :discrete_facet
               passarray   :facet_tags
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false

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

@@ -4,9 +4,7 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Sankey < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Sankey < ChartField::Config
               passthrough :register_id, :source_type
 
               passthrough :xinput, :xmode

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

@@ -4,15 +4,14 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Serie < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
+            class Serie < ChartField::Config
               passthrough :register_id
 
               passthrough :input, :type
               passarray   :y_axes
 
-              passthrough :visual, :stacked
+              passthrough :visual
+              passboolean :stacked
 
               passarray   :filters, :people_filters, :task_filters, order_matters: false
 

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

@@ -4,16 +4,14 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class SeriesConfig < Common::Content::DoubleModel
-              passkey     :id
-              passthrough :patch_ver
-
+            class SeriesConfig < ChartField::Config
               passthrough :xlabel, :xtype
-              passthrough :interval, :calc_mode, :comparative_year
               passthrough :ylabel
+              passthrough :interval, :calc_mode
+              passboolean :comparative_year
 
-              passthrough :filled_up_with_zeros, :zero_y, :bounds_rigid
-              passthrough :stack_all
+              passboolean :filled_up_with_zeros, :zero_y, :bounds_rigid
+              passboolean :stack_all
             end
           end
         end

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

@@ -7,16 +7,18 @@ module Ecoportal
             passthrough :register_id, :date_input
             passthrough :filter
 
-            passthrough :facet_by_tags, :facet_by_select
-            passthrough :select_input, :select_mapping
+            passboolean :facet_by_tag, :facet_by_select
             passarray   :facet_tags
+            passthrough :select_input, :select_mapping
 
-            passthrough :relative, :relstart, :relbound
-            passthrough :bounded, :ubound, :lbound
+            passboolean :relative, :bounded
+            passthrough :relstart, :relbound
+            passthrough :ubound, :lbound
 
             passthrough :display_mode, :display_type
             passarray   :guidelines
-            passthrough :cumulative, :cumulative_mode, :cumulative_start
+            passboolean :cumulative
+            passthrough :cumulative_mode, :cumulative_start
             passthrough :multiplier, :granularity
 
             passthrough :color

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

@@ -7,7 +7,7 @@ module Ecoportal
             embeds_many :items, klass: "Ecoportal::API::V2::Page::Component::ChecklistItem", order_key: :weight
 
             def add_item(label:, pos: NOT_USED, before: NOT_USED, after: NOT_USED)
-              itm_doc = items.stops.items_class.new_doc
+              itm_doc = items.items_class.new_doc
               items.upsert!(itm_doc, pos: pos, before: before, after: after) do |item|
                 item.label  = label
                 if prev = previous_item(item)

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

@@ -13,10 +13,11 @@ module Ecoportal
                 }
               end
             end
-            
+
             passkey     :id
             passthrough :patch_ver, :label
-            passthrough :weight, :checked
+            passthrough :weight
+            passboolean :checked
           end
         end
       end

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

@@ -4,10 +4,13 @@ module Ecoportal
       class Page
         class Component
           class DateField < Page::Component
-            passthrough :value
-            passthrough :show_time, :today_button, :past_only
-            passthrough :create_event, :remind_me_in
-            passthrough :renews, :renews_every, :renews_unit, :renews_until
+            passdate    :value
+            passboolean :show_time, :today_button, :past_only
+            passboolean :create_event
+            passthrough :remind_me_in
+            passboolean :renews
+            passthrough :renews_every, :renews_unit
+            passdate    :renews_until
 
             ISO8601 = "%Y-%m-%dT%H:%M:00Z" # "%Y-%m-%dT%H:%M:00.00Z"
 
@@ -26,6 +29,70 @@ module Ecoportal
               end
             end
 
+            def create_event=(value)
+              self.past_only = false
+              doc["create_event"] = !!value
+            end
+
+            # Quick config helper
+            # @param conf [Symbol, Array<Symbol>]
+            #   - `:time` to show time
+            #   - `:now_button` to display `NOW` button
+            #   - `:past` to only allow past dates
+            #   - `:event` to enable event
+            #   - `:reminder` to set the reminder (requires `:event`)
+            #     - `:never`
+            #     - `:one_day`
+            #     - `:three_days`
+            #     - `:one_week`
+            #     - `:two_weeks`
+            #     - `:one_month`
+            def configure(*conf)
+              conf.each_with_object([]) do |cnf, unused|
+                case cnf
+                when :time
+                  self.show_time  = true
+                when :now_button
+                  self.today_button = true
+                when :past
+                  self.past_only = true
+                when :event
+                  self.create_event = true
+                when Hash
+                  supported = [:reminder]
+                  unless (rest = hash_except(cnf.dup, *supported)).empty?
+                    unused.push(rest)
+                  end
+                  if cnf.key?(:reminder) then configure_reminder(cnf[:reminder]) end
+                else
+                  unused.push(cnf)
+                end
+              end.yield_self do |unused|
+                super(*unused)
+              end
+            end
+
+            private
+
+            def configure_reminder(value)
+              case value
+              when :never, NilClass
+                self.remind_me_in = "never"
+              when :one_day
+                self.remind_me_in = "1.day"
+              when :three_days
+                self.remind_me_in = "3.days"
+              when :one_week
+                self.remind_me_in = "1.week"
+              when :two_weeks
+                self.remind_me_in = "2.weeks"
+              when :one_month
+                self.remind_me_in = "1.month"
+              else
+                # Unsupported
+              end
+            end
+
           end
         end
       end

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

@@ -6,8 +6,9 @@ module Ecoportal
           class File < Common::Content::DoubleModel
             passkey     :id
             passthrough :patch_ver, :position
-            passthrough :content_type, :file_size, :file_container_id
-            passdate    :file_update_at
+            passthrough :file_size, :token, read_only: true
+            passthrough :content_type, :file_container_id
+            passdate    :file_update_at, read_only: true
           end
         end
       end

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

@@ -5,13 +5,13 @@ module Ecoportal
         class Component
           class GaugeField < Page::Component
             passthrough :value, :max
-            passthrough :active_color
+            passthrough :active_color, read_only: true
 
             embeds_many :stops, klass: "Ecoportal::API::V2::Page::Component::GaugeStop", order_key: :threshold
 
             # Adds a stop at `threshold` with `color`
             # @return [Ecoportal::API::V2::Page::Component::GaugeStop]
-            def add_stop (threshold: 0.0, color: '#e256d1')
+            def add_stop(threshold: 0.0, color: '#e256d1')
               stop_doc = stops.items_class.new_doc
               stops.upsert!(stop_doc) do |stop|
                 stop.threshold = threshold

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class GeoCoordinates < Common::Content::DoubleModel
+            passthrough :lat, :lon
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,10 +4,13 @@ module Ecoportal
       class Page
         class Component
           class GeoField < Page::Component
-            passthrough :address, :coordinates
+            passthrough :address
+            embeds_one  :coordinates, klass: "Ecoportal::API::V2::Page::Component::GeoCoordinates"
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/geo_coordinates'

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'