voom-presenters 0.2.0 → 2.1.0

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

@@ -0,0 +1,43 @@
+module Voom
+  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/voom/presenters/dsl/components/input.rb

@@ -1,21 +1,30 @@
-require 'voom/presenters/dsl/components/mixins/event'
-require 'voom/presenters/dsl/components/mixins/tooltips'
-
 module Voom
   module Presenters
     module DSL
       module Components
         class Input < EventBase
           include Mixins::Tooltips
-          attr_reader :name
+
+          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/voom/presenters/dsl/components/link.rb

@@ -0,0 +1,33 @@
+module Voom::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/voom/presenters/dsl/components/list.rb

@@ -1,10 +1,3 @@
-require 'voom/presenters/dsl/components/lists/line'
-require 'voom/presenters/dsl/components/lists/separator'
-require 'voom/presenters/dsl/components/lists/header'
-require 'voom/presenters/dsl/components/mixins/content'
-require 'voom/presenters/dsl/components/mixins/append'
-require 'voom/presenters/dsl/components/mixins/attaches'
-
 module Voom
   module Presenters
     module DSL
@@ -13,10 +6,11 @@ module Voom
           include Mixins::Content
           include Mixins::Append
           include Mixins::Attaches
-          
-          attr_reader :lines, :lines_only, :color, :border, :selectable, :total_lines
+          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 }
@@ -24,6 +18,7 @@ module Voom
 
             @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
@@ -35,7 +30,7 @@ module Voom
             return unless @selectable && !@lines_only
             @lines << Lists::Header.new(parent: self,
                                         total_lines: @total_lines,
-                                        checkbox: {text: text})
+                                        checkbox: {text: text, dirtyable: false})
           end
 
           def line(text=nil, **attribs, &block)
@@ -50,5 +45,3 @@ module Voom
     end
   end
 end
-
-

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

@@ -1,7 +1,3 @@
-require 'voom/presenters/dsl/components/icon'
-require 'voom/presenters/dsl/components/icon_toggle'
-
-
 module Voom
   module Presenters
     module DSL
@@ -15,7 +11,7 @@ module Voom
               expand!
             end
 
-            def icon(icon=nil, **attribs, &block)
+            def icon(icon = nil, **attribs, &block)
               return @icon if locked?
               @action_type = :icon
               @icon = Icon.new(parent: self, icon: icon,
@@ -26,21 +22,21 @@ module Voom
             def menu(**attribs, &block)
               return @menu if locked?
               @action_type = :menu
-              @menu = Menu.new(parent: self, 
+              @menu = Menu.new(parent: self,
                                **attribs, &block)
             end
 
             def checkbox(**attribs, &block)
               return @checkbox if locked?
               @action_type = :checkbox
-              @checkbox = Checkbox.new(parent: self, 
+              @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, 
+              @radio_button = RadioButton.new(parent: self,
                                               **attribs, &block)
             end
 
@@ -51,13 +47,15 @@ module Voom
                                    **attribs, &block)
             end
 
-            def icon_toggle(icon=nil, **attribs, &block)
+            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)
+              @icon_toggle = IconToggle.new(parent: self,
+                                            icon: icon,
+                                            **attribs, &block)
             end
 
-            def button(text=nil, **attribs, &block)
+            def button(text = nil, **attribs, &block)
               return @button if locked?
               @action_type = :button
               @button = Components::Button.new(text: text, parent: self, **attribs, &block)

data/lib/voom/presenters/dsl/components/lists/actions.rb

@@ -1,5 +1,3 @@
-require 'voom/presenters/dsl/components/lists/action'
-
 module Voom
   module Presenters
     module DSL
@@ -12,7 +10,6 @@ module Voom
               expand!
             end
 
-
             def icon(icon=nil, **attribs, &block)
               action = Lists::Action.new(parent: self)
               action.icon(icon, **attribs, &block)

data/lib/voom/presenters/dsl/components/lists/line.rb

@@ -1,10 +1,3 @@
-require 'voom/presenters/dsl/components/lists/actions'
-require 'voom/presenters/dsl/components/icon'
-require 'voom/presenters/dsl/components/avatar'
-require 'voom/presenters/dsl/components/typography'
-require 'voom/presenters/dsl/components/mixins/event'
-require 'voom/presenters/dsl/components/mixins/tooltips'
-
 module Voom
   module Presenters
     module DSL
@@ -13,22 +6,29 @@ module Voom
           class Line < EventBase
             extend Gem::Deprecate
             include Mixins::Tooltips
+            include Mixins::Dialogs
+
+            CHECKBOX_ATTRIBUTES = %i[name value checked dirtyable value off_value].freeze
 
-            attr_accessor :selected, :selectable
+            attr_accessor :selected, :selectable, :components
 
             def initialize(**attribs_, &block)
               super(type: :line, **attribs_, &block)
               @selected = attribs.delete(:selected) {false}
               @selectable = attribs.delete(:selectable) {false}
-              self.text(attribs.delete(:text)) if attribs.key?(:text)
-              self.subtitle(attribs.delete(:subtitle)) if attribs.key?(:subtitle)
-              self.info(attribs.delete(:info)) if attribs.key?(:info)
-              self.body(attribs.delete(:body)) if attribs.key?(:body)
+              self.text(attribs.delete(:text), attribs) if attribs[:text]
+              self.subtitle(attribs.delete(:subtitle)) if attribs[:subtitle]
+              self.info(attribs.delete(:info)) if attribs[:info]
+              self.body(attribs.delete(:body)) if attribs[:body]
               self.avatar(attribs.delete(:avatar)) if attribs.key?(:avatar)
               self.icon(attribs.delete(:icon)) if attribs.key?(:icon)
-              self.checkbox(attribs.delete(:checkbox)) if attribs.key?(:checkbox) && !@selectable
-              self.checkbox(attribs.slice(:name, :value, :checked)) if @selectable
 
+              if @selectable
+                self.checkbox(attribs.slice(*CHECKBOX_ATTRIBUTES))
+              elsif attribs.key?(:checkbox)
+                self.checkbox(attribs.delete(:checkbox))
+              end
+              @components = []
               @actions = []
               expand!
             end
@@ -37,6 +37,7 @@ module Voom
               return @text if locked?
               @text = Components::Typography.new(parent: self, type: :text, text: text, **attribs, &block)
             end
+            alias title text
 
             def subtitle(*text, **attribs, &block)
               return @subtitle if locked?
@@ -67,13 +68,24 @@ module Voom
 
             def checkbox(**attributes, &block)
               return @checkbox if locked?
-              field_name = @selectable ? "#{attributes.delete(:name)}[]" : attributes.delete(:name)
+
+              # Append [] if the list is selectable and the checkbox's name
+              # doesn't already include brackets:
+              field_name = attributes.delete(:name).to_s
+              field_name += '[]' if @selectable && !field_name.include?('[')
+
               @checkbox = Components::Checkbox.new(parent: self,
                                                    name: field_name,
                                                    **attributes,
                                                    &block)
             end
 
+            def hidden_field(**attributes, &block)
+              return @hidden_field if locked?
+
+              @hidden_field = Components::HiddenField.new(parent: self, **attributes, &block)
+            end
+
             def menu(**attributes, &block)
               return @menu if locked?
               @menu = Components::Menu.new(parent: self, **attributes, &block)

data/lib/voom/presenters/dsl/components/menu.rb

@@ -1,24 +1,19 @@
-require 'voom/presenters/dsl/components/mixins/event'
-require 'voom/presenters/dsl/components/mixins/tooltips'
-require 'voom/presenters/dsl/components/mixins/attaches'
-require 'voom/presenters/dsl/components/mixins/buttons'
-require 'voom/presenters/dsl/components/mixins/typography'
-
 module Voom
   module Presenters
     module DSL
       module Components
         class Menu < Base
-          attr_accessor :items, :title, :position, :placement, :color, :open
+          attr_accessor :items, :title, :position, :placement, :color, :open, :hoisted
 
           def initialize(title=nil, **attribs_, &block)
             super(type: :menu, **attribs_, &block)
             @title = title
             @items = []
-            @position = attribs.delete(:position) || :left
-            @placement = attribs.delete(:placement) || :default
+            @position = attribs.delete(:position){:left}
+            @placement = attribs.delete(:placement){:default}
             @color = attribs.delete(:color)
             @open = attributes.delete(:open) {false}
+            @hoisted = attributes.delete(:hoisted) {true}
             expand!
           end
 
@@ -41,9 +36,45 @@ module Voom
 
           private
 
+          module BaseMenuItem
+            attr_reader :position, :size, :color
+
+            private
+
+            VALID_POSITIONS = %i[top bottom].freeze
+            VALID_SIZES = %i[normal small].freeze
+
+            def validate_position(value)
+              return unless value
+
+              v = value.to_sym
+
+              unless VALID_POSITIONS.include?(v)
+                raise Errors::ParameterValidation,
+                      "Invalid item position! Valid positions include #{VALID_POSITIONS.join(', ')}"
+              end
+
+              v
+            end
+
+            def validate_size(value)
+              return unless value
+
+              v = value.to_sym
+
+              unless VALID_SIZES.include?(v)
+                raise Errors::ParameterValidation,
+                      "Invalid item size! Valid sizes include #{VALID_SIZES.join(', ')}"
+              end
+
+              v
+            end
+          end
+
           class Item < EventBase
             include Mixins::Tooltips
             include Mixins::Typography
+            include BaseMenuItem
 
             attr_accessor :text, :disabled, :selected
 
@@ -52,6 +83,9 @@ module Voom
               @text = attribs.delete(:text)
               @disabled = attribs.delete(:disabled)
               @selected = attribs.delete(:selected) {false}
+              @position = validate_position(attribs.delete(:position) { :top })
+              @size = validate_size(attribs.delete(:size) { :normal })
+              @color = attribs.delete(:color) { :primary }
               @components = []
               expand!
             end
@@ -66,12 +100,20 @@ module Voom
           class Label < Item
             def initialize(**attribs, &block)
               super(type: :label, **attribs, &block)
+              @position = validate_position(attribs.delete(:position) { :top })
+              @size = validate_size(attribs.delete(:size) { :normal })
+              @color = attribs.delete(:color) { :primary }
             end
           end
 
           class Divider < Base
+            include BaseMenuItem
+
             def initialize(**attribs, &block)
               super(type: :divider, **attribs, &block)
+              @position = validate_position(attribs.delete(:position) { :top })
+              @size = validate_size(attribs.delete(:size) { :normal })
+              @color = attribs.delete(:color) { :primary }
             end
           end
         end

data/lib/voom/presenters/dsl/components/mixins/append.rb

@@ -9,8 +9,8 @@ module Voom
               @components << comp
             end
 
-            def yield_to(&block)
-              instance_eval(&block) if block
+            def yield_to(*args, &block)
+              instance_exec(*args, &block) if block_given?
             end
           end
         end

data/lib/voom/presenters/dsl/components/mixins/attaches.rb

@@ -1,5 +1,3 @@
-require 'voom/presenters/namespace'
-
 module Voom
   module Presenters
     module DSL

data/lib/voom/presenters/dsl/components/mixins/avatar.rb

@@ -5,9 +5,7 @@ module Voom
         module Mixins
           module Avatar
             def avatar(avatar = nil, **attribs, &block)
-              return @avatar if locked?
-              @avatar = Components::Avatar.new(parent: self, avatar: avatar,
-                                   **attribs, &block)
+              self << Components::Avatar.new(parent: self, avatar: avatar, **attribs, &block)
             end
           end
         end