coprl 0.1.0 → 3.0.0.beta.1

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

@@ -0,0 +1,19 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class TextArea < TextField
+          attr_reader :rows, :cols
+
+          def initialize(**attribs_, &block)
+            super(type: :text_area, **attribs_, &block)
+            @rows = attribs.delete(:rows) || default(:rows)
+            @cols = attribs.delete(:cols) || default(:cols) unless full_width
+            expand!
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,113 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class TextField < Input
+
+          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){ false }
+            @full_width = attribs.delete(:full_width){ true }
+            @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
+
+          def label(text=nil)
+            return @label if locked?
+            @label = text
+          end
+
+          def icon(icon=nil, **attribs, &block)
+            return @icon if locked?
+            @icon = Components::Icon.new(parent: self, icon: icon, position: attribs.delete(:position){:right},
+                                         **attribs, &block)
+          end
+
+          def value(value=nil)
+            return @value if locked?
+            @value = value
+          end
+
+          def pattern(pattern=nil)
+            return @pattern if locked?
+            @pattern = json_regexp(Regexp.new(pattern))
+          end
+
+          def hint(hint=nil)
+            return @hint if locked?
+            @hint = hint
+          end
+
+          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', '^').
+                sub('\\Z', '$').
+                sub('\\z', '$').
+                sub(/^\//, '').
+                sub(/\/[a-z]*$/, '').
+                gsub(/\(\?#.+\)/, '').
+                gsub(/\(\?-\w+:/, '(').
+                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/coprl/presenters/dsl/components/time_field.rb

@@ -0,0 +1,21 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class TimeField < DatetimeBase
+          attr_reader :config
+
+          def initialize(**attribs_, &block)
+            super(type: :time, **attribs_, &block)
+            map_config(:min_time, :min_date)
+            map_config(:max_time, :max_date)
+            merge_config(:time_24hr, true)
+
+            expand!
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,25 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        # Base class used by toggle classes
+        class ToggleBase < Input
+          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)
+            @off_value = attribs.delete(:off_value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class Tooltip < Base
+          attr_reader :position
+
+          def initialize(**attribs_, &block)
+            super(type: :tooltip,
+                  **attribs_, &block)
+            @position = attribs.delete(:position){ :left }
+            self.text(attribs.delete(:text)) if attribs.key?(:text)
+            expand!
+          end
+
+          def text(*text, **attribs, &block)
+            return @text if locked?
+            @text = Components::Typography.new(parent: self, type: :text, text: text, **attribs, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Components
+        class Typography < EventBase
+          include Mixins::Tooltips
+
+          attr_accessor :text, :level, :color, :position, :inline, :markdown
+
+          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 = 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,
+                                         **attribs, &block)
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Coprl
+  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/coprl/presenters/dsl/definer.rb

@@ -0,0 +1,9 @@
+module Coprl
+  module Presenters
+    module DSL
+      # The default dsl for ui
+      module Definer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Coprl
+  module Presenters
+    module DSL
+      # The default dsl for ui
+      # 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
+        attr_reader :name, :namespace, :options
+        def initialize(name, namespace, options, &block)
+          @block = block
+          @name = name
+          @namespace = namespace
+          @options = options
+        end
+
+        def build
+          self
+        end
+
+        def expand(router: , 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, namespace: @namespace, &@block)
+          presenter.expand_instance(freeze: false)
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/dsl/invalid_presenter.rb

@@ -0,0 +1,8 @@
+module Coprl
+  module Presenters
+    module DSL
+      class InvalidPresenter < StandardError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Coprl
+  module Presenters
+    module DSL
+      module Lockable
+        def locked?
+          @parent.send(:locked?)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require 'base64'
+
+module Coprl
+  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/coprl/presenters/dsl/user_interface.rb

@@ -0,0 +1,157 @@
+require 'ice_nine'
+
+module Coprl
+  module Presenters
+    module DSL
+      class UserInterface
+        include DSL::Definer
+        include DSL::ProtectFromForgery
+        include Components::Mixins::Common
+        include Components::Mixins::Helpers
+        include Components::Mixins::Dialogs
+        include Components::Mixins::Snackbars
+        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 Coprl::Serializer
+        include Coprl::Trace
+
+        attr_reader :router, :context, :components, :name, :namespace
+        private :context, :router, :namespace
+        alias params context
+
+        def initialize(context:, parent: nil, router: nil, name: nil, namespace: [], &block)
+          @parent = parent
+          @router = router || @parent&.send(:router)
+          @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)
+          return @page if locked?
+          @page = Components::Page.new(parent: self, **attribs, &block)
+        end
+
+        def header(title = nil, **attribs, &block)
+          return @header if locked?
+          @header = Components::Header.new(parent: self, title: title,
+                                           **attribs, &block)
+        end
+
+        def drawer(name = nil, **attribs, &block)
+          return @drawer if locked?
+          @drawer = Components::Drawer.new(parent: self, title: name,
+                                           **attribs, &block)
+        end
+
+
+        def footer(**attribs, &block)
+          return @footer if locked?
+          @footer = Components::Footer.new(parent: self,
+                                           **attribs, &block)
+        end
+
+        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
+        end
+
+        # Called by the definition.expand method to evaluate a user interface with a different context
+        # This should be made unavailable to the dsl
+        def expand_instance(freeze: true)
+          instance_eval(&@block)
+          lock!
+          deep_freeze if freeze
+          self
+        end
+
+        def url(**context_)
+          return '#' unless @router
+          context = context_.dup
+          link_to = context.delete(:link)
+          post_to = context.delete(:command)
+          @router.url(render: link_to, command: post_to, context: context)
+        end
+
+        def type
+          :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
+          IceNine.deep_freeze(self) if Presenters::Settings.config.presenters.deep_freeze
+          self
+        end
+
+        def parent(for_type)
+          nil
+        end
+
+        def _helpers_
+          return @helpers if @helpers
+        end
+
+        def yield_block
+          return @_yield_block_ if @_yield_block_
+          @parent.send(:yield_block) if @parent
+        end
+
+        def add_global_helpers
+          Presenters::Settings.config.presenters.helpers.each do |helper|
+            self.helpers(helper)
+          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
+end
+