voom-presenters 0.1.10 → 2.0.0

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

@@ -1,15 +1,14 @@
-require_relative 'text_field'
-
 module Voom
   module Presenters
     module DSL
       module Components
         class TextArea < TextField
-          attr_reader :rows
-          
+          attr_reader :rows, :cols
+
           def initialize(**attribs_, &block)
             super(type: :text_area, **attribs_, &block)
-            @rows = attribs.delete(:rows) || 3
+            @rows = attribs.delete(:rows) || default(:rows)
+            @cols = attribs.delete(:cols) || default(:cols) unless full_width
             expand!
           end
         end

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

@@ -1,18 +1,26 @@
-require_relative 'input'
-
 module Voom
   module Presenters
     module DSL
       module Components
         class TextField < Input
 
-          attr_reader :required, :full_width, :password
+          attr_reader :required,
+                      :full_width,
+                      :auto_complete,
+                      :case_type,
+                      :behavior
+
+          VALID_CASE_TYPES = %i[mixed upper lower].freeze
 
           def initialize(**attribs_, &block)
             super(type: :text_field, **attribs_, &block)
-            @required = attribs.delete(:required)
+            @required = attribs.delete(:required){ false }
             @full_width = attribs.delete(:full_width){ true }
-            @password = attribs.delete(:password)
+            @case_type = validate_case_type(attribs.delete(:case_type) { :mixed })
+            @auto_complete = validate_auto_complete(attribs.delete(:auto_complete) { :off })
+            @behavior = determine_behavior(attribs.delete(:password), attribs.delete(:behavior))
+            label(attribs.delete(:label))if attribs.key?(:label)
+            value(attribs.delete(:value))if attribs.key?(:value)
             expand!
           end
 
@@ -23,8 +31,7 @@ module Voom
 
           def icon(icon=nil, **attribs, &block)
             return @icon if locked?
-            @icon = Components::Icon.new(parent: self, icon: icon,
-                                         context: context,
+            @icon = Components::Icon.new(parent: self, icon: icon, position: attribs.delete(:position){:right},
                                          **attribs, &block)
           end
 
@@ -43,17 +50,13 @@ module Voom
             @hint = hint
           end
 
-          def error(error=nil)
-            return @error if locked?
-            @error = error
-          end
-
-          def readonly(readonly=nil)
-            return @readonly if locked?
-            @readonly = readonly
+          def behavior
+            return "type=\"#{@behavior}\"" unless @behavior == 'currency'
+            return 'type="number" min="0.00" max="10000000000.00" step="0.01"'
           end
 
           private
+
           def json_regexp(regexp)
             str = regexp.inspect.
                 sub('\\A', '^').
@@ -66,9 +69,45 @@ module Voom
                 gsub(/\s/, '')
             Regexp.new(str).source
           end
+
+          def validate_auto_complete(value)
+            case value
+            when false, :disabled, 'disabled', 'off', nil
+              :off
+            when true, :enabled, 'enabled', 'on'
+              :on
+            else # :on, :off, client-specific values
+              value
+            end
+          end
+
+          def validate_case_type(case_type)
+            return unless case_type
+            case_type = case_type.to_sym
+
+            raise Errors::ParameterValidation, "Invalid case type specified: #{case_type}" unless VALID_CASE_TYPES.include?(case_type)
+            case_type
+          end
+
+          def determine_behavior(password, behavior)
+            unless password.nil?
+              logger.warn(
+                'The `password` attribute of text_field is deprecated. ' \
+                'Use `text_field behavior: :password` instead.'
+              )
+            end
+
+            case password
+            when nil
+              behavior
+            when true
+              :password
+            when false
+              :text
+            end
+          end
         end
       end
     end
   end
 end
-

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

@@ -1,5 +1,3 @@
-require_relative 'datetime_base'
-
 module Voom
   module Presenters
     module DSL

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

@@ -1,20 +1,22 @@
-require_relative 'mixins/event'
-require_relative 'input'
-
 module Voom
   module Presenters
     module DSL
       module Components
         # Base class used by toggle classes
         class ToggleBase < Input
-          attr_accessor :text, :checked, :value, :disabled
-         
+          attr_accessor :text,
+                        :text_color,
+                        :checked,
+                        :value,
+                        :off_value
+
           def initialize(**attribs_, &block)
             super(**attribs_, &block)
             @text = attribs.delete(:text)
+            @text_color = attribs.delete(:text_color)
             @checked = attribs.delete(:checked) { false }
             @value = attribs.delete(:value)
-            @disabled = attribs.delete(:disabled) { false }
+            @off_value = attribs.delete(:off_value)
           end
         end
       end

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

@@ -7,7 +7,6 @@ module Voom
 
           def initialize(**attribs_, &block)
             super(type: :tooltip,
-                  context: context,
                   **attribs_, &block)
             @position = attribs.delete(:position){ :left }
             self.text(attribs.delete(:text)) if attribs.key?(:text)
@@ -16,7 +15,7 @@ module Voom
 
           def text(*text, **attribs, &block)
             return @text if locked?
-            @text = Components::Typography.new(parent: self, type: :text, text: text, context: context, **attribs, &block)
+            @text = Components::Typography.new(parent: self, type: :text, text: text, **attribs, &block)
           end
         end
       end

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

@@ -1,6 +1,3 @@
-require_relative 'mixins/event'
-require_relative 'mixins/tooltips'
-
 module Voom
   module Presenters
     module DSL
@@ -8,23 +5,25 @@ module Voom
         class Typography < EventBase
           include Mixins::Tooltips
 
-          attr_accessor :text, :level, :color, :position
+          attr_accessor :text, :level, :color, :position, :inline, :markdown
 
-          def initialize(parent:, **attribs_, &block)
+          def initialize(parent:, level: nil, **attribs_, &block)
             super(type: :text, parent: parent, **attribs_, &block)
             @text = Array(attribs.delete(:text)||'').flatten.join("\n\n").split("\n\n")
-            @level = attribs.delete(:level){1}
+            @level = level
             @color = attribs.delete(:color)
+            @inline = attribs.delete(:inline) { false }
             @position = Array(attribs.delete(:position)).compact
+            @markdown = attribs.delete(:markdown) { true }
             expand!
           end
 
           def icon(icon=nil, **attribs, &block)
             return @icon if locked?
             @icon = Components::Icon.new(parent: self, icon: icon,
-                                         context: context,
                                          **attribs, &block)
           end
+
         end
       end
     end

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

@@ -0,0 +1,50 @@
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        class UnorderedList < Base
+
+          attr_reader :list_items, :list_style
+
+          def initialize(**attribs_, &block)
+            super(type: :unordered_list, **attribs_, &block)
+            @list_style = attribs.delete(:list_style){ :disc }
+            @list_items = []
+            expand!
+          end
+
+          def list_item(text=nil, **attribs_, &block)
+            @list_items << ListItem.new(parent: self, text: text, **attribs_, &block)
+          end
+
+          class ListItem < Base
+
+            def initialize(**attribs_, &block)
+              super(type: :list_item, **attribs_, &block)
+              self.text(attribs.delete(:text)) if attribs.key?(:text)
+              self.icon(attribs.delete(:icon)) if attribs.key?(:icon)
+              self.unordered_list(attribs.delete(:unordered_list)) if attribs.key?(:unordered_list)
+              expand!
+            end
+
+            def text(*text, **attribs, &block)
+              return @text if locked?
+              @text = Components::Typography.new(parent: self, type: :text, text: text, **attribs, &block)
+            end
+
+            def icon(icon=nil, **attribs, &block)
+              return @icon if locked?
+              @icon = Components::Icon.new(parent: self, icon: icon, **attribs, &block)
+            end
+
+            def unordered_list(**attribs, &block)
+              return @unordered_list if locked?
+              @unordered_list = UnorderedList.new(parent: self, **attribs, &block)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/voom/presenters/dsl/definer.rb

@@ -1,7 +1,3 @@
-require_relative 'components/base'
-require_relative 'components/event_base'
-Dir[__dir__ + "/components/*.rb"].each {|file| require file }
-
 module Voom
   module Presenters
     module DSL

data/lib/voom/presenters/dsl/definition.rb

@@ -1,5 +1,3 @@
-require_relative 'user_interface'
-
 module Voom
   module Presenters
     module DSL
@@ -7,8 +5,12 @@ module Voom
       # This class is held in the container. When a request to render a UI comes in
       # It creates a new UserInterface instance, binding it to the router and context of the request
       class Definition
-        def initialize(&block)
+        attr_reader :name, :namespace, :options
+        def initialize(name, namespace, options, &block)
           @block = block
+          @name = name
+          @namespace = namespace
+          @options = options
         end
 
         def build
@@ -16,16 +18,17 @@ module Voom
         end
 
         def expand(router: , context:{}, &block)
-          presenter = UserInterface.new(router: router, context: context,  &@block)
+          presenter = UserInterface.new(router: router, context: context,  name: @name, namespace: @namespace, &@block)
           yield(presenter) if block
           presenter.expand_instance
         end
 
+        # Used by attach
         def expand_child(parent:, context: {})
-          presenter = UserInterface.new(parent: parent, context: context, &@block)
+          presenter = UserInterface.new(parent: parent, context: context, namespace: @namespace, &@block)
           presenter.expand_instance(freeze: false)
         end
       end
     end
   end
-end
+end

data/lib/voom/presenters/dsl/lockable.rb

@@ -2,12 +2,8 @@ module Voom
   module Presenters
     module DSL
       module Lockable
-        def lock!
-          @locked = true
-        end
-
         def locked?
-          @locked || frozen?
+          @parent.send(:locked?)
         end
       end
     end

data/lib/voom/presenters/dsl/protect_from_forgery.rb

@@ -0,0 +1,43 @@
+require 'base64'
+
+module Voom
+  module Presenters
+    module DSL
+      module ProtectFromForgery
+        include Base64
+
+        AUTHENTICITY_TOKEN_LENGTH = 32
+
+        def authenticity_token_meta_tags(session)
+          return unless Presenters::Settings.config.presenters.web_client.protect_from_forgery && session
+          [
+              '<meta name="csrf-param" content="authenticity_token">',
+              "<meta name=\"csrf-token\" content=\"#{form_authenticity_token(session)}\">"
+          ].join("\n").html_safe
+        end
+
+        def form_authenticity_token(session)
+          session[:_csrf_token] ||= SecureRandom.base64(AUTHENTICITY_TOKEN_LENGTH)
+          raw_token = Base64.strict_decode64(session[:_csrf_token])
+          one_time_pad = SecureRandom.random_bytes(AUTHENTICITY_TOKEN_LENGTH)
+          encrypted_csrf_token = xor_byte_strings(one_time_pad, raw_token)
+          masked_token = one_time_pad + encrypted_csrf_token
+          Base64.strict_encode64(masked_token)
+        end
+
+
+        def xor_byte_strings(s1, s2) # :doc:
+          s2 = s2.dup
+          size = s1.bytesize
+          i = 0
+          while i < size
+            s2.setbyte(i, s1.getbyte(i) ^ s2.getbyte(i))
+            i += 1
+          end
+          s2
+        end
+
+      end
+    end
+  end
+end

data/lib/voom/presenters/dsl/user_interface.rb

@@ -1,23 +1,11 @@
 require 'ice_nine'
-require_relative 'definer'
-require_relative 'components/mixins/common'
-require_relative 'components/mixins/helpers'
-require_relative 'components/mixins/dialogs'
-require_relative 'components/mixins/snackbars'
-require_relative 'components/mixins/text_fields'
-require_relative 'components/mixins/date_time_fields'
-require_relative 'invalid_presenter'
-
-require 'voom/serializer'
-require 'voom/trace'
-
 
 module Voom
   module Presenters
     module DSL
       class UserInterface
         include DSL::Definer
-        include Lockable
+        include DSL::ProtectFromForgery
         include Components::Mixins::Common
         include Components::Mixins::Helpers
         include Components::Mixins::Dialogs
@@ -25,63 +13,68 @@ module Voom
         include Components::Mixins::Icons
         include Components::Mixins::TextFields
         include Components::Mixins::DateTimeFields
-
+        include Components::Mixins::Attaches
+        include Components::Mixins::Event
+        extend Pluggable
+        include_plugins(:DSLComponents, :DSLHelpers)
 
         include Voom::Serializer
         include Voom::Trace
 
-        attr_reader :router, :context, :components
-        private :context, :router
+        attr_reader :router, :context, :components, :name, :namespace
+        private :context, :router, :namespace
         alias params context
 
-        def initialize(parent: nil, router: nil, context:, &block)
+        def initialize(context:, parent: nil, router: nil, name: nil, namespace: [], &block)
           @parent = parent
           @router = router || @parent&.send(:router)
-          @context = context
+          @context = context || {}
           @block = block
           @header = nil
           @drawer = nil
           @components = []
           @footer = nil
+          @name = name
+          @namespace = namespace
+          @plugins = []
+          @csrf_meta_tags = authenticity_token_meta_tags(@context.fetch(:session, nil))
           add_global_helpers
+          initialize_plugins
         end
 
-        def page(title=nil, **attribs, &block)
+        def page(title = nil, **attribs, &block)
           return @page if locked?
-          @page = Components::Page.new(parent: self, context: context,
-                                       **attribs, &block)
+          @page = Components::Page.new(parent: self, **attribs, &block)
         end
 
-        def header(title=nil, **attribs, &block)
+        def header(title = nil, **attribs, &block)
           return @header if locked?
           @header = Components::Header.new(parent: self, title: title,
-                                           context: context,
                                            **attribs, &block)
         end
 
-        def drawer(name=nil, **attribs, &block)
+        def drawer(name = nil, **attribs, &block)
           return @drawer if locked?
           @drawer = Components::Drawer.new(parent: self, title: name,
-                                           context: context,
                                            **attribs, &block)
         end
 
 
-
         def footer(**attribs, &block)
           return @footer if locked?
           @footer = Components::Footer.new(parent: self,
-                                           context: context,
                                            **attribs, &block)
         end
 
-        def attach(presenter, **context_, &yield_block)
-          @_yield_block_ = yield_block
-          pom = Voom::Presenters::App[presenter].call.expand_child(parent: self, context: context.merge(context_))
+        def progress(**attributes, &block)
+          self << Components::Progress.new(parent: self, **attributes, &block)
+        end
+
+        def attach(presenter, **params, &yield_block)
+          pom = super
           @header ||= pom.header
           @drawer ||= pom.drawer
           @footer ||= pom.footer
-          @components += pom.components
         end
 
         # Called by the definition.expand method to evaluate a user interface with a different context
@@ -105,6 +98,21 @@ module Voom
           :presenter
         end
 
+        def plugin(*plugin_names)
+          @plugins.push(*plugin_names)
+          self.class.include_plugins(:DSLComponents, :DSLHelpers, plugins: plugin_names)
+        end
+
+        def plugins
+          return @plugins if locked?
+          return @plugins if @plugins
+        end
+        alias _plugins_ plugins
+
+        def csrf_meta_tags
+          Presenters::Settings.config.presenters.web_client.protect_from_forgery ? @csrf_meta_tags : nil
+        end
+
         private
 
         def deep_freeze
@@ -112,8 +120,6 @@ module Voom
           self
         end
 
-        private
-
         def parent(for_type)
           nil
         end
@@ -133,6 +139,17 @@ module Voom
           end
         end
 
+        def initialize_plugins
+          self.class.include_plugins(:DSLComponents, :DSLHelpers, plugins: @plugins)
+        end
+
+        def lock!
+          @locked = true
+        end
+
+        def locked?
+          @locked
+        end
       end
     end
   end