ecoportal-api-oozes 0.6.1 → 0.7.4

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

@@ -0,0 +1,54 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField < Page::Component
+            passthrough :mode
+            passthrough :relative, :relstart, :relbound
+            passthrough :bounded, :ubound, :lbound
+            passthrough :filter_date_input
+            passthrough :user_id, :lock_chart_user
+
+            embeds_one :series_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::SeriesConfig"
+            embeds_one :frequency_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Frequency"
+            embeds_one :heatmap_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Heatmap"
+            embeds_one :sankey_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Sankey"
+            embeds_one :indicator_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Indicator"
+            embeds_one :faceted_series_config, klass: "Ecoportal::API::V2::Page::Component::ChartField::Multiseries"
+
+            embeds_many :series, klass: "Ecoportal::API::V2::Page::Component::ChartField::Serie"
+
+            MODES = ["frequency", "series", "heatmap", "sankey", "indicator", "faceted_series"]
+
+            def config
+              case mode
+              when "frequency"
+                frequency_config
+              when "series"
+                series_config
+              when "heatmap"
+                heatmap_config
+              when "sankey"
+                sankey_config
+              when "indicator"
+                indicator_config
+              when "faceted_series"
+                faceted_series_config
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page/component/chart_field/frequency'
+require 'ecoportal/api/v2/page/component/chart_field/series_config'
+require 'ecoportal/api/v2/page/component/chart_field/serie'
+require 'ecoportal/api/v2/page/component/chart_field/heatmap'
+require 'ecoportal/api/v2/page/component/chart_field/sankey'
+require 'ecoportal/api/v2/page/component/chart_field/indicator'
+require 'ecoportal/api/v2/page/component/chart_field/multiseries'

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

@@ -0,0 +1,29 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Frequency < Common::Content::DoubleModel
+              passkey     :id
+              passthrough :patch_ver
+              passthrough :register_id, :source_type
+
+              passthrough :mode, :input
+              passarray   :tags
+              passthrough :secondary
+
+              passthrough :output, :bar_mode
+              passthrough :series_size, :skip_zeroes
+
+              passarray   :filters, :people_filters, :task_filters
+
+              passthrough :color
+              passarray   :color_map
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Heatmap < Common::Content::DoubleModel
+              passkey     :id
+              passthrough :patch_ver
+              passthrough :register_id, :source_type
+
+              passthrough :xinput, :xmode
+              passthrough :yinput, :ymode
+              passarray   :xtags, :ytags
+
+              passthrough :bucket_type
+
+              passarray   :filters, :people_filters, :task_filters
+
+              passthrough :color
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Indicator < Common::Content::DoubleModel
+              passkey     :id
+              passthrough :patch_ver
+              passthrough :register_id, :source_type
+
+              passthrough :date_input, :secondary
+              passthrough :duration, :math_mode, :currency
+              
+              passthrough :display_previous, :change_format, :invert_colors
+
+              passarray   :filters, :people_filters, :task_filters
+
+              passthrough :color
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Multiseries < Common::Content::DoubleModel
+              passkey     :id
+              passthrough :patch_ver
+              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
+              passarray   :facet_tags
+
+              passarray   :filters, :people_filters, :task_filters
+
+              passthrough :display_mode, :display_type
+              passthrough :color
+              passarray   :color_map
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Sankey < Common::Content::DoubleModel
+              passkey     :id
+              passthrough :patch_ver
+              passthrough :register_id, :source_type
+
+              passthrough :xinput, :xmode
+              passthrough :yinput, :ymode
+              passthrough :zinput, :zmode
+              passarray   :xtags, :ytags, :ztags
+
+              passarray   :filters, :people_filters, :task_filters
+
+              passthrough :color
+              passarray   :color_map
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class Serie < Common::Content::DoubleModel
+              passkey     :id
+              passthrough :patch_ver
+              passthrough :register_id
+
+              passthrough :input, :type
+              passarray   :y_axes
+
+              passthrough :visual, :stacked
+
+              passarray   :filters, :people_filters, :task_filters
+
+              passthrough :color
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartField
+            class SeriesConfig < Common::Content::DoubleModel
+              passkey     :id
+              passthrough :patch_ver
+
+              passthrough :xlabel, :xtype
+              passthrough :interval, :calc_mode, :comparative_year
+              passthrough :ylabel
+
+              passthrough :filled_up_with_zeros, :zero_y, :bounds_rigid
+              passthrough :stack_all
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class ChartFrField < Page::Component
+            passthrough :register_id, :date_input
+            passthrough :filter
+
+            passthrough :facet_by_tags, :facet_by_select
+            passthrough :select_input, :select_mapping
+            passarray   :facet_tags
+
+            passthrough :relative, :relstart, :relbound
+            passthrough :bounded, :ubound, :lbound
+
+            passthrough :display_mode, :display_type
+            passarray   :guidelines
+            passthrough :cumulative, :cumulative_mode, :cumulative_start
+            passthrough :multiplier, :granularity
+
+            passthrough :color
+            passarray   :color_map
+
+            passthrough :chart_user
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,41 @@ module Ecoportal
       class Page
         class Component
           class ChecklistField < Page::Component
-            #class_resolver :checklist_item_class, "Ecoportal::API::V2::Page::Component::ChecklistItem"
-            embeds_multiple :items, klass: "Ecoportal::API::V2::Page::Component::ChecklistItem", order_key: :weight
+            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
+              items.upsert!(itm_doc, pos: pos, before: before, after: after) do |item|
+                item.label  = label
+                if prev = previous_item(item)
+                  item.weight = prev.weight
+                end
+                yield(item) if block_given?
+                fix_item_weights!
+              end
+            end
+
+            def ordered_items
+              items.each_with_index.sort_by do |item, index|
+                (item.weight >= 9999) ? [index, index] : [item.weight, index]
+              end.map(&:first)
+            end
+
+            private
+
+            def fix_item_weights!
+              ordered_items.each_with_index do |item, index|
+                item.weight = index
+              end
+            end
+
+            def previous_item(value)
+              itms = ordered_items
+              pos  = itms.index(value) - 1
+              return if pos < 0
+              itms[pos]
+            end
+
           end
         end
       end

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

@@ -4,6 +4,16 @@ module Ecoportal
       class Page
         class Component
           class ChecklistItem < Common::Content::DoubleModel
+
+            class << self
+              def new_doc
+                {
+                  "id"     => new_uuid,
+                  "weight" => 9999
+                }
+              end
+            end
+            
             passkey     :id
             passthrough :patch_ver, :label
             passthrough :weight, :checked

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

@@ -5,6 +5,27 @@ module Ecoportal
         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
+
+            ISO8601 = "%Y-%m-%dT%H:%M:00Z" # "%Y-%m-%dT%H:%M:00.00Z"
+
+            def value=(val)
+              doc["value"] = self.class.to_time(val).yield_self do |datetime|
+                datetime = datetime.utc.strftime(ISO8601) if datetime
+                datetime
+              end
+            end
+
+            def value
+              if val = doc["value"]
+                (Time.parse(val) rescue nil).yield_self do |datetime|
+                  datetime.localtime if datetime
+                end
+              end
+            end
+
           end
         end
       end

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

@@ -4,8 +4,7 @@ module Ecoportal
       class Page
         class Component
           class FilesField < Page::Component
-            #class_resolver :file_class, "Ecoportal::API::V2::Page::File"
-            embeds_multiple :items, klass: "Ecoportal::API::V2::Page::File", order_key: :position
+            embeds_many :items, klass: "Ecoportal::API::V2::Page::File", order_key: :position
           end
         end
       end

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

@@ -4,10 +4,33 @@ module Ecoportal
       class Page
         class Component
           class GaugeField < Page::Component
-            passthrough :value
+            passthrough :value, :max
+            passthrough :active_color
+
+            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')
+              stop_doc = stops.items_class.new_doc
+              stops.upsert!(stop_doc) do |stop|
+                stop.threshold = threshold
+                stop.color     = color
+                yield(stop) if block_given?
+              end
+            end
+
+            def ordered_stops
+              stops.each_with_index.sort_by do |stop, index|
+                (stop.threshold >= 9999) ? [index, index] : [stop.threshold, index]
+              end.map(&:first)
+            end
+
           end
         end
       end
     end
   end
 end
+
+require 'ecoportal/api/v2/page/component/gauge_stop'

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

@@ -0,0 +1,88 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component
+          class GaugeStop < Common::Content::DoubleModel
+
+            class << self
+              def new_doc
+                {
+                  "id"        => new_uuid,
+                  "threshold" => nil,
+                  "color"     => nil
+                }
+              end
+            end
+
+            passkey     :id
+            passthrough :patch_ver, :threshold
+            passthrough :color
+
+            # Assign the color to the stop.
+            # @note These are the available colors:
+            #   - :blue, :blue_greyed, :blue_light
+            #   - :turquoise, :jade, :green, :pistachio, :avocado
+            #   - :yellow, :orange, :pumpkin, :red, :magenta, :fuchsia, :purple, :violet
+            # @param value [String, Symbol] you can use a `symbol` to specify a color
+            def color=(value)
+              value  = to_color(value) if value.is_a?(Symbol)
+              doc["color"] = value
+            end
+
+            # @return [Symbol] to get the `color` sym code
+            def color_sym
+              color_maps.each do |k, v|
+                return k if color == v
+              end
+              :undefined
+            end
+
+            private
+
+            def to_color(value)
+              return nil unless valid_color?(value)
+              return value if value.is_a?(String)
+              color_maps[value]
+            end
+
+            def valid_color?(value)
+              return true if value.is_a?(String) && colors.any? {|c| c == value}
+              return true if value.is_a?(Symbol) && color_syms.any? {|s| s == value}
+            end
+
+            def color_syms
+              @color_syms ||= color_maps.keys
+            end
+
+            def colors
+              @colors ||= color_maps.values
+            end
+
+            def color_maps
+              @color_maps ||= [
+                [:blue, "#5656e2"],
+                [:blue_greyed, "#568be2"],
+                [:blue_light, "#56c0e2"],
+                [:turquoise, "#56e2cf"],
+                [:jade, "#56e29b"],
+                [:green, "#56e267"],
+                [:pistachio, "#79e256"],
+                [:avocado, "#aee256"],
+                [:yellow, "#e2e156"],
+                [:orange, "#e2ad56"],
+                [:pumpkin, "#e27956"],
+                [:red, "#e25667"],
+                [:magenta, "#e2569c"],
+                [:fuchsia, "#e256d1"],
+                [:purple, "#be56e2"],
+                [:violet, "#8a56e2"]
+              ].to_h
+            end
+
+          end
+        end
+      end
+    end
+  end
+end