coprl 0.1.0 → 3.0.0.beta.1

data/lib/coprl/presenters/dsl/components/header.rb

@@ -0,0 +1,58 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class Header < Base
+          attr_accessor :title, :image, :placement
+
+          VALID_PLACEMENTS = %i[static fixed].freeze
+
+          def initialize(**attribs_, &block)
+            super(type: :header,
+                  **attribs_, &block)
+            self.title(attribs.delete(:title)) if attribs.key?(:title)
+            @image = attribs.delete(:image)
+            @placement = validate_placement(attribs.delete(:placement) { :static })
+            expand!
+          end
+
+          def button(icon=nil, **attributes, &block)
+            return @button if locked?
+            @button = Components::Button.new(icon: icon, parent: self, **attributes, &block)
+          end
+
+          def menu(**attribs, &block)
+            return @menu if locked?
+            @menu = Components::Menu.new(parent: self,
+                             **attribs, &block)
+          end
+
+          def nav(**attribs, &block)
+            return @nav if locked?
+            @nav = Components::Menu.new(parent: self,
+                                         **attribs, &block)
+          end
+
+          def title(*text, **attribs, &block)
+            return @title if locked?
+            @title = Components::Typography.new(parent: self, type: :text, text: text, **attribs, &block)
+          end
+
+          private
+
+          def validate_placement(value)
+            return unless value
+
+            placement = value.to_sym
+
+            unless VALID_PLACEMENTS.include?(placement)
+              raise Errors::ParameterValidation, "Invalid placement specified: #{placement}"
+            end
+
+            placement
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/hidden_field.rb

@@ -0,0 +1,23 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class HiddenField < Input
+          attr_reader :name
+
+          def initialize(**attribs_, &block)
+            super(type: :hidden_field,
+                  **attribs_, &block)
+            expand!
+          end
+
+          def value(value=nil)
+            return @value if locked?
+            @value = value
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/coprl/presenters/dsl/components/icon.rb

@@ -0,0 +1,18 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class Icon < IconBase
+          include Mixins::Tooltips
+          attr_accessor :text
+
+          def initialize(**attribs_, &block)
+            super(**attribs_, &block)
+            @text = attribs.delete(:text)
+            expand!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/icon_base.rb

@@ -0,0 +1,22 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class IconBase < EventBase
+          include Mixins::Tooltips
+          attr_reader :icon, :color, :size, :position, :hidden
+
+          def initialize(**attribs_, &block)
+            super(type: :icon,
+                  **attribs_, &block)
+            @icon     = attribs.delete(:icon)
+            @color    = attribs.delete(:color)
+            @size     = attribs.delete(:size){ :default }
+            @position = Array(attribs.delete(:position)).compact
+            @hidden = attribs.delete(:hidden) {false}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/icon_toggle.rb

@@ -0,0 +1,19 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class IconToggle < ToggleBase
+          attr_accessor :icon, :on_icon, :selected
+
+          def initialize(**attribs_, &block)
+            super(type: :icon_toggle, **attribs_, &block)
+            @icon = attribs.delete(:icon)
+            @on_icon = attribs.delete(:on_icon) { @icon }
+            @selected = attribs.delete(:selected) { false }
+            expand!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/image.rb

@@ -0,0 +1,84 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class Image < EventBase
+          include Mixins::Tooltips
+
+          VALID_FIT_TYPES = %i[contain cover fill fit].freeze
+          DEFAULT_POSITION = :center
+
+          attr_accessor :image,
+                        :description,
+                        :url,
+                        :min_height,
+                        :height,
+                        :max_height,
+                        :min_width,
+                        :width,
+                        :max_width,
+                        :border,
+                        :border_color,
+                        :border_radius,
+                        :fit,
+                        :position
+
+          def initialize(**attribs_, &block)
+            super(type: :image, **attribs_, &block)
+
+            @image = attribs.delete(:image)
+            @description = attribs.delete(:description)
+
+            @min_width = validate_size(attribs.delete(:min_width))
+            @width = validate_size(attribs.delete(:width))
+            @max_width = validate_size(attribs.delete(:max_width))
+
+            @min_height = validate_size(attribs.delete(:min_height))
+            @height = validate_size(attribs.delete(:height))
+            @max_height = validate_size(attribs.delete(:max_height))
+
+            @border = attribs.delete(:border)
+            @border_color = attribs.delete(:border_color) { :primary }
+            @border_radius = attribs.delete(:border_radius)
+
+            @fit = validate_fit(attribs.delete(:fit) { :contain })
+            @position = Array(attribs.delete(:position) { DEFAULT_POSITION }).compact
+
+            @url = build_url
+
+            expand!
+          end
+
+          private
+
+          def build_url
+            return unless image
+            return image if image.start_with?('/') || image.start_with?('http')
+
+            @parent.router.url(render: image, context: {})
+          end
+
+          def validate_fit(fit)
+            return unless fit
+
+            fit = fit.to_sym
+
+            unless VALID_FIT_TYPES.include?(fit)
+              raise Errors::ParameterValidation, "Invalid image fit specified: #{fit}"
+            end
+
+            fit
+          end
+
+          # Ensure all size values have a unit, defaulting to pixels.
+          def validate_size(value)
+            return unless value
+            return "#{value}px" if value.to_s.match?(/\A\d+\Z/)
+
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/image_list.rb

@@ -0,0 +1,43 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class ImageList < Base
+
+          attr_reader :images, :columns, :list_type, :spacing
+
+          def initialize(**attribs_, &block)
+            super(type: :image_list, **attribs_, &block)
+            @images = []
+            @columns = attribs_.delete(:columns){ 5 }
+            @list_type = attribs_.delete(:list_type){ 'standard' }
+            @spacing = attribs_.delete(:spacing)
+            @border_attribs = attribs_.slice(:border, :border_color, :border_radius)
+            expand!
+          end
+
+          def image(image=nil, **attribs, &block)
+            combined_attribs = attribs.merge(@border_attribs)
+            @images << ImageListItem.new(parent: self,
+                                         image: image,
+                                         **combined_attribs,
+                                         &block)
+          end
+
+          class ImageListItem < Components::Image
+
+            attr_reader :label
+
+            def initialize(**attribs_, &block)
+              super(type: :image_list_item, **attribs_, &block)
+              @label = attribs_.delete(:label){ nil }
+              expand!
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/input.rb

@@ -0,0 +1,30 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class Input < EventBase
+          include Mixins::Tooltips
+
+          attr_reader :name,
+                      :dirtyable,
+                      :disabled
+
+          def initialize(**attribs_, &block)
+            super(**attribs_, &block)
+            @name = attribs.delete(:name)
+            @dirtyable = attribs.delete(:dirtyable) { true }
+            @disabled = attribs.delete(:disabled) { false }
+          end
+
+          # If present this error message will be displayed in place of the validation message produced by the
+          # underlying component.
+          def validation_error(error=nil)
+            return @validation_error if locked?
+            @validation_error = error
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/link.rb

@@ -0,0 +1,33 @@
+module Coprl::Presenters::DSL::Components
+  class Link < Typography
+
+    VALID_TARGETS = %i[self blank].freeze
+
+    attr_accessor :url,
+                  :text,
+                  :target
+
+    def initialize(parent:, **attribs_, &block)
+      super(type: :link, parent: parent, **attribs_, &block)
+
+      @url = attribs_.delete(:url)
+      @text = attribs_.delete(:text) { url }
+      @target = validate_target(attribs_.delete(:target) { :self })
+
+      expand!
+    end
+
+    private
+
+    def validate_target(value)
+      target = value&.to_sym
+
+      unless VALID_TARGETS.include?(target)
+        raise Errors::ParameterValidation,
+              "target must be one of #{VALID_TARGETS.join(', ')}"
+      end
+
+      target
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/list.rb

@@ -0,0 +1,47 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class List < Base
+          include Mixins::Content
+          include Mixins::Append
+          include Mixins::Attaches
+          include Mixins::Event
+
+          attr_reader :lines, :lines_only, :color, :border, :selectable, :total_lines, :dense
+          attr_accessor :components
+
+          def initialize(**attribs_, &block)
+            super(type: :list, **attribs_, &block)
+            @color  = attribs.delete(:color) { nil }
+            @border = attribs.delete(:border) { nil }
+
+            @lines_only = attribs.delete(:lines_only) { false }
+            @selectable = attribs.delete(:selectable) { false }
+            @dense = attribs.delete(:dense) { false }
+            @lines = []
+            @components = []
+            @total_lines = attribs.delete(:total_lines) || 0
+            add_select_control!( attribs.fetch(:select_control_label) { 'Select All' } )
+            expand!
+          end
+
+          def add_select_control!(text)
+            return unless @selectable && !@lines_only
+            @lines << Lists::Header.new(parent: self,
+                                        total_lines: @total_lines,
+                                        checkbox: {text: text, dirtyable: false})
+          end
+
+          def line(text=nil, **attribs, &block)
+            @lines << Lists::Line.new(parent:self, text: text, selectable: selectable, **attribs, &block)
+          end
+
+          def separator(**attribs, &block)
+            @lines << Lists::Separator.new(parent:self, **attribs, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/components/lists/action.rb

@@ -0,0 +1,69 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        module Lists
+          class Action < Base
+            attr_accessor :action_type
+
+            def initialize(**attribs_, &block)
+              super(type: :action, **attribs_, &block)
+              expand!
+            end
+
+            def icon(icon = nil, **attribs, &block)
+              return @icon if locked?
+              @action_type = :icon
+              @icon = Icon.new(parent: self, icon: icon,
+                               **attribs, &block)
+            end
+
+
+            def menu(**attribs, &block)
+              return @menu if locked?
+              @action_type = :menu
+              @menu = Menu.new(parent: self,
+                               **attribs, &block)
+            end
+
+            def checkbox(**attribs, &block)
+              return @checkbox if locked?
+              @action_type = :checkbox
+              @checkbox = Checkbox.new(parent: self,
+                                       **attribs, &block)
+            end
+
+            def radio_button(**attribs, &block)
+              return @radio_button if locked?
+              @action_type = :radio_button
+              @radio_button = RadioButton.new(parent: self,
+                                              **attribs, &block)
+            end
+
+            def switch(**attribs, &block)
+              return @switch if locked?
+              @action_type = :switch
+              @switch = Switch.new(parent: self,
+                                   **attribs, &block)
+            end
+
+            def icon_toggle(icon = nil, **attribs, &block)
+              return @icon_toggle if locked?
+              @action_type = :icon_toggle
+              @icon_toggle = IconToggle.new(parent: self,
+                                            icon: icon,
+                                            **attribs, &block)
+            end
+
+            def button(text = nil, **attribs, &block)
+              return @button if locked?
+              @action_type = :button
+              @button = Components::Button.new(text: text, parent: self, **attribs, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+