coprl 0.1.0 → 3.0.0.beta.5

data/lib/coprl/presenters/web_client/component_decorator_factory.rb

@@ -0,0 +1,27 @@
+require "dry/inflector"
+
+module Coprl
+  module Presenters
+    module WebClient
+      class ComponentDecoratorFactory
+
+        def self.build(component)
+          comp_class = "#{inflector.camelize(component.type)}HtmlDecorator"
+          klass = if const_defined?(comp_class)
+                    const_get(comp_class)
+                  else
+                    ComponentHtmlDecorator
+                  end
+          klass.new(component)
+        end
+
+        private
+
+        def self.inflector
+          @inflector ||= Dry::Inflector.new
+        end
+
+      end
+    end
+  end
+end

data/lib/coprl/presenters/web_client/component_html_decorator.rb

@@ -0,0 +1,50 @@
+require 'delegate'
+
+module Coprl
+  module Presenters
+    module WebClient
+      class ComponentHtmlDecorator < SimpleDelegator
+
+        def _plugins_
+          __getobj__.send(:_plugins_)
+        end
+
+        def method_missing(meth, *args, &block)
+          if respond_to?(meth)
+            super
+          else
+            nil
+          end
+        end
+
+        private
+
+        HTML_ESCAPED_ATTRIBUTES = %i(
+          id
+          type
+        )
+
+        def self.html_escape_attribute(attr)
+          define_method(attr) do
+            self.class.html_escape(super())
+          end
+        end
+
+        HTML_ESCAPED_ATTRIBUTES.each do |attr|
+          html_escape_attribute(attr)
+        end
+
+        def self.inherited(subclass)
+          subclass::HTML_ESCAPED_ATTRIBUTES.each do |attr|
+            html_escape_attribute(attr)
+          end
+        end
+
+        def self.html_escape(text)
+          Rack::Utils.escape_html(text)
+        end
+
+      end
+    end
+  end
+end

data/lib/coprl/presenters/web_client/component_renderer.rb

@@ -0,0 +1,49 @@
+require 'erb'
+
+module Coprl
+  module Presenters
+    module WebClient
+      # This class renders a given component.
+      # First it looks for plugins that override default behavior
+      # If they don't exist then it renders the base components
+      class ComponentRenderer
+        extend Pluggable
+        include_plugins(:WebClientComponents)
+
+        def initialize(comp,
+                       render:,
+                       components:,
+                       index:,
+                       scope: nil)
+          @comp = comp
+          @index = index
+          @components = components
+          @scope = scope
+          @render = render
+          initialize_plugins
+        end
+
+        def render
+          comp = ComponentDecoratorFactory.build(@comp)
+          components = @components.map { |c| ComponentDecoratorFactory.build(c) }
+
+          return public_send(:"render_#{@scope ? "_#{@scope}_" : nil}#{@comp.type}",
+                      comp,
+                      components: components,
+                      index: @index,
+                      render: @render) if respond_to?(:"render_#{@comp.type}")
+
+          @render.call :erb, "components#{@scope ? "/#{@scope}" : nil}/#{@comp.type}",
+                       :locals => {comp: comp,
+                                   components: components, index: @index}
+        end
+
+        private
+
+        def initialize_plugins
+          self.class.include_plugins(:WebClientComponents, plugins: @comp.send(:_plugins_))
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/web_client/custom_css.rb

@@ -0,0 +1,66 @@
+module Coprl
+  module Presenters
+    module WebClient
+      # This class renders custom CSS for the layout
+      # It looks for public/presenters/global.css first
+      # It then looks for public/presenters/#{env['REQUEST_PATH']}.css
+      class CustomCss
+        include Coprl::Presenters::WebClient::Helpers::HtmlSafe
+
+        attr_reader :path, :root, :host
+        private :path, :root, :host
+
+        def initialize(path, root:, host:)
+          @path = path
+          @root = root
+          @host = host
+        end
+
+        def render
+          return unless custom_css_path
+          [global_css, global_namespace_css(path), presenter_css(path)].join
+        end
+
+        private
+
+        def custom_css_path
+          Presenters::Settings.config.presenters.web_client.custom_css
+        end
+
+        # loads a global css file - by default located at `public/presenters/global.css`
+        def global_css
+          css_file = File.join(custom_css_path, 'global.css')
+          full_path = File.join(root, css_file)
+          _build_css_link_(css_file) if File.exists?(full_path)
+        end
+
+        def global_namespace_css(path)
+          return unless custom_css_path && path
+          namespace_path = path.split('/').reject { |c| c.empty? }.first
+          css_file = File.join(custom_css_path, namespace_path ? namespace_path : '')
+          css_file = File.join(css_file, 'global.css')
+          full_path = File.join(root, css_file)
+          trace {"Loading global namespace: #{full_path}"}
+          _build_css_link_(css_file) if File.exists?(full_path)
+        end
+
+        # loads a custom css file that matches the presenter namespace/presenter.css
+        # by default located at public/presenters/#{namespace}/#{presenter}.css
+        def presenter_css(path)
+          return unless custom_css_path && path
+          css_file = File.join(custom_css_path, path)
+          css_file = File.join(css_file, 'index') if path == '/'
+          css_file = "#{css_file}.css"
+          full_path = File.join(root, css_file)
+          _build_css_link_(css_file) if File.exists?(full_path)
+        end
+
+        def _build_css_link_(path)
+          html_safe (<<~CSS)
+            <link rel="stylesheet" type="text/css" href="#{host}/#{path.sub('public/', '')}">
+          CSS
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/web_client/custom_render.rb

@@ -0,0 +1,31 @@
+require 'redcarpet'
+
+module Coprl::Presenters::WebClient
+  class CustomRender < Redcarpet::Render::Safe
+    # include Redcarpet::Render::SmartyPants
+    BR = '<br/>'
+
+    def initialize(extensions = {})
+      super(extensions)
+    end
+
+    def paragraph(text)
+      text + BR
+    end
+
+    def postprocess(full_document)
+      strip_trailing_br(colorize(full_document))
+    end
+
+    private
+
+    def colorize(doc)
+      doc.gsub(/{c:([#\w]\w+)}([^{]+){\/c}/) {|m| "<span style=\"color:#{$1};\">#{$2}</span>"}
+    end
+
+    def strip_trailing_br(doc)
+      return doc unless doc[-BR.length..-1] == BR
+      doc[0...doc.length-BR.length]
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/color.rb

@@ -0,0 +1,18 @@
+module Coprl::Presenters::WebClient::Helpers
+  module Color
+    def color_classname(comp, affects = nil, color_attr = :color)
+      color = comp&.public_send(color_attr)
+      return unless color
+
+      return "v-#{comp.type}__primary" if eq(color, :primary)
+      return "v-#{comp.type}__secondary" if eq(color, :secondary)
+
+      "v-#{affects}color__#{color}"
+    end
+
+    def color_style(comp, affects = nil, color_attr = :color)
+      color = comp.public_send(color_attr)
+      "#{affects}color: #{color};" unless %w(primary secondary).include?(color.to_s) || color.nil?
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/drag_and_drop.rb

@@ -0,0 +1,21 @@
+module Coprl::Presenters::WebClient::Helpers
+  module DragAndDrop
+    def draggable_attributes(comp)
+      draggable_attributes = ''
+      if comp.draggable
+        draggable_attributes = "draggable=true data-drag_params='#{comp.draggable.to_h.to_json}'"
+      end
+      draggable_attributes
+    end
+
+    def drop_zone_attributes(comp)
+      drop_zone_attributes = ''
+      if comp.drop_zone
+        zone = comp.drop_zone[:zone]
+        drop_zone_attributes = "data-dropzone='#{zone}' data-drop_params='#{comp.drop_zone.to_h.to_json}'"
+      end
+      drop_zone_attributes
+    end
+  end
+end
+

data/lib/coprl/presenters/web_client/helpers/equal.rb

@@ -0,0 +1,7 @@
+module Coprl::Presenters::WebClient::Helpers
+  module Equal
+    def eq(attrib, value)
+      attrib.to_s == value.to_s
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/expand_hash.rb

@@ -0,0 +1,19 @@
+# Expands a hash ensuring all values are hash's
+# POM object models expand to a hash using :to_hash
+# JSON is serialized in as recursive OpenStruct's, they need special expansion logic.
+module Coprl::Presenters::WebClient::Helpers
+  module ExpandHash
+    def expand_hash(h)
+      HashExt::Traverse.traverse(h.to_h) do |k,v|
+        if !v.is_a?(Array) && v.respond_to?(:to_h)
+          v = v.is_a?(OpenStruct) ? expand_hash(v.to_h) : v.to_h
+        elsif v.is_a?(Array)
+          v = v.map {|v| v.is_a?(OpenStruct) ? expand_hash(v.to_h) : v}
+        elsif v.respond_to?(:to_hash)
+          v = v.to_hash
+        end
+        [k,v]
+      end
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/form_helpers.rb

@@ -0,0 +1,14 @@
+# used used by the form erbs
+module Coprl::Presenters::WebClient::Helpers
+  module FormHelpers
+
+    def buttons?(components)
+      buttons(components).any?
+    end
+
+    def buttons(components)
+      components.select {|c| eq(c.type, :button)}
+    end
+
+  end
+end

data/lib/coprl/presenters/web_client/helpers/headers.rb

@@ -0,0 +1,40 @@
+module Coprl::Presenters::WebClient::Helpers
+  module Headers
+    include Coprl::Presenters::WebClient::Helpers::HtmlSafe
+
+    def coprl_headers(base_url, request, pom)
+      html_safe (<<~HEADERS)
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700" type="text/css">
+        <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
+        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.4.1/css/all.css" integrity="sha384-5sAR7xN1Nv6T6+dT2mhtzEpVJvfS3NScPQTrOxhwjIuvcA67KV2R5Jz6kr4abQsz" crossorigin="anonymous">
+        <link rel="stylesheet" href="#{ base_url }/#{ request.env['SCRIPT_NAME'] }bundle.css">
+        <script defer src="#{ base_url }/#{ request.env['SCRIPT_NAME'] }bundle.js"></script>
+        #{plugin_headers(pom)}
+        #{custom_css(request.env['REQUEST_PATH'], base_url)}
+        #{pom.csrf_meta_tags}
+      HEADERS
+    end
+
+    def plugin_headers(pom)
+      Coprl::Presenters::WebClient::PluginHeaders.new(pom: pom, render: method(:render_partial)).render
+    end
+
+    def custom_css(path, host=nil)
+      root = Coprl::Presenters::Settings.config.presenters.root
+      Coprl::Presenters::WebClient::CustomCss.new(path, root: root, host: host).render
+    end
+
+    def custom_js
+      custom_js_path = Coprl::Presenters::Settings.config.presenters.web_client.custom_js
+      Dir.glob(custom_js_path).map do |file|
+        _build_script_tag_(file)
+      end.join("\n") if custom_js_path
+    end
+
+    def _build_script_tag_(path)
+      (<<~JS)
+            <script defer src="#{env['SCRIPT_NAME']}#{path.sub('public/','')}"></script>
+      JS
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/html_safe.rb

@@ -0,0 +1,8 @@
+module Coprl::Presenters::WebClient::Helpers
+  module HtmlSafe
+    def html_safe(string)
+      # This is for rails ... it requires that html safe strings be marked as safe
+      string.respond_to?(:html_safe) ? string.html_safe : string
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/includes.rb

@@ -0,0 +1,11 @@
+module Coprl::Presenters::WebClient::Helpers
+  module Includes
+    def include?(array, value)
+      array.map(&:to_s).include?(value.to_s)
+    end
+
+    def includes_one?(array1, array2)
+      (array2.map(&:to_sym)-array1.map(&:to_sym)).size != array2.size
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/inflector.rb

@@ -0,0 +1,7 @@
+module Coprl::Presenters::WebClient::Helpers
+  module Inflector
+    def inflector
+      @inflector ||= Dry::Inflector.new
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/markdown.rb

@@ -0,0 +1,29 @@
+module Coprl::Presenters::WebClient::Helpers
+  module Markdown
+    def base_markdown(text)
+      unless @markdown
+        renderer = Coprl::Presenters::WebClient::CustomRender.new(hard_wrap: false, filter_html: true)
+        options = {
+          autolink: false,
+          no_intra_emphasis: true,
+          fenced_code_blocks: true,
+          lax_html_blocks: true,
+          strikethrough: true,
+          superscript: true,
+          disable_indented_code_blocks: true
+        }
+        @markdown = Redcarpet::Markdown.new(renderer, options)
+      end
+
+      @markdown.render(text)
+    end
+
+    def expand_text(text, markdown: true)
+      if markdown
+        self.markdown(Array(text).join("\n\n")) #.gsub("\n\n", "<br/>")
+      else
+        Array(text).join('<br/>')
+      end
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/padding_helpers.rb

@@ -0,0 +1,21 @@
+# used used by the grid, content and card erbs
+module Coprl::Presenters::WebClient::Helpers
+  module PaddingHelpers
+    def _padding_array_(padding, nesting=0)
+      return (%i(top0 right0 bottom0 left0) - padding.map {|p| "#{p.to_s.gsub(%r(\d),'')}0".to_sym} + padding.map(&:to_sym)).sort if padding
+      nesting > 1 ? %i(top3 right0 bottom3 left0).sort : []
+    end
+
+    def _padding?(padding, nesting=0)
+      _padding_array_(padding, nesting) != %i(top0 right0 bottom0 left0).sort
+    end
+
+    def _padding_classes_(padding, nesting=0)
+      "v-padding-#{_padding_array_(padding, nesting).join('-')}"
+    end
+
+    def _alignment_class_(align)
+      "v-grid-column-align-#{align}"
+    end
+  end
+end