coprl 0.1.0 → 3.0.0.beta.1

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

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

@@ -0,0 +1,12 @@
+module Coprl::Presenters::WebClient::Helpers
+  # Sinatra specific helpers
+  module Rails
+    include Coprl::Presenters::WebClient::Helpers::Shared
+    include LocalVariables
+    include Partials
+    include SafeMarkdown
+    include Namespaced
+    include Raw
+    include EscapeHtml
+  end
+end

data/lib/coprl/presenters/web_client/helpers/rails/escape_html.rb

@@ -0,0 +1,9 @@
+module Coprl::Presenters::WebClient::Helpers::Rails
+  module EscapeHtml
+    def h(text)
+      # Rails escapes html already so we don't do it here. It is the opposite as Sinatra.
+      # For the inverse see raw
+      text
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/rails/local_variables.rb

@@ -0,0 +1,11 @@
+module Coprl::Presenters::WebClient::Helpers::Rails
+  module LocalVariables
+    # A rails specific helper to see if a local variable is defined
+    # This passes the binding from the evaluating (erb) context
+    # We don't do this inline, because rails and sintra have different variable names for the same thing
+    def bound_locals_include?(variable, __binding__)
+      locals = __binding__.local_variable_get(:local_assigns)
+      locals.include? variable
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/rails/namespaced.rb

@@ -0,0 +1,12 @@
+module Coprl::Presenters::WebClient::Helpers::Rails
+  module Namespaced
+    def namespaced_presenter(params)
+      scoped_presenter = []
+      scoped_presenter << params.fetch(:namespace1,nil)
+      scoped_presenter << params.fetch(:namespace2,nil)
+      scoped_presenter << params.fetch(:presenter,nil)
+      scoped_presenter.compact!
+      scoped_presenter.any? ? scoped_presenter.join(':') : nil
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/rails/partials.rb

@@ -0,0 +1,20 @@
+module Coprl::Presenters::WebClient::Helpers::Rails
+  module Partials
+    # Called by built in views
+    def partial(template, *args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options.merge!(partial: template)
+      # Rails does not support the views parameter ... but sinatra does so we clean it up here
+      options.delete(:views)
+      render options
+    end
+
+    # Called by plugins
+    def render_partial(_engine, template, options = {}, locals = {}, &block)
+      # Rails does not support the views parameter ... but sinatra does so we clean it up here
+      options.delete(:views)
+      options.merge!(partial: template.to_s)
+      render options
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/rails/raw.rb

@@ -0,0 +1,9 @@
+module Coprl::Presenters::WebClient::Helpers::Rails
+  module Raw
+    def raw(html_js_string)
+      # Note Rails escapes by default ... Sinatra is the opposite
+      # For the inverse see escape_html
+      html_js_string.to_s.html_safe
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/rails/safe_markdown.rb

@@ -0,0 +1,9 @@
+module Coprl::Presenters::WebClient::Helpers::Rails
+  module SafeMarkdown
+    include Coprl::Presenters::WebClient::Helpers::Markdown
+    # Called by built in views
+    def markdown(string)
+      base_markdown(string).html_safe
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Coprl::Presenters::WebClient::Helpers
+  module RenderComponent
+    def render_component(scope, comp, components, index)
+      Coprl::Presenters::WebClient::ComponentRenderer.new(comp,
+                                                          render: method(:render_partial),
+                                                          scope: scope,
+                                                          components: components,
+                                                          index: index).render
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Coprl::Presenters::WebClient::Helpers
+  # Helpers used in both rails and sinatra
+  module Shared
+    include FormHelpers
+    include PaddingHelpers
+    include ExpandHash
+    include RenderComponent
+    include Inflector
+    include Color
+    include Headers
+    include Equal
+    include Includes
+    include UniqueId
+    include SnakeToCamel
+    include DragAndDrop
+    include TransformHash
+  end
+end

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

@@ -0,0 +1,11 @@
+module Coprl::Presenters::WebClient::Helpers
+  # Sinatra specific helpers
+  module Sinatra
+    include Coprl::Presenters::WebClient::Helpers::Shared
+    include LocalVariables
+    include Partials
+    include SafeMarkdown
+    include Raw
+    include EscapeHtml
+  end
+end

data/lib/coprl/presenters/web_client/helpers/sinatra/escape_html.rb

@@ -0,0 +1,9 @@
+module Coprl::Presenters::WebClient::Helpers::Sinatra
+  module EscapeHtml
+    def h(text)
+      # Note: Rails escapes html already. It is the opposite as Sinatra.
+      # For the inverse see raw
+      Rack::Utils.escape_html(text)
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/sinatra/local_variables.rb

@@ -0,0 +1,11 @@
+module Coprl::Presenters::WebClient::Helpers::Sinatra
+  module LocalVariables
+    # A sinatra specific helper to see if a local variable is defined
+    # This passes the binding from the evaluating (erb) context
+    # We don't do this inline, because rails and sintra have different variable names for the same thing
+    def bound_locals_include?(variable, __binding__)
+      locals = __binding__.local_variable_get(:locals)
+      locals.include? variable
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/sinatra/partials.rb

@@ -0,0 +1,27 @@
+module Coprl::Presenters::WebClient::Helpers::Sinatra
+  module Partials
+    # Called by built in views
+    def partial(template, *args)
+      template = _add_underscore(template)
+      template = _add_application_dir(template) unless template.start_with?("components/") || template.start_with?("body/")
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options.merge!(:layout => false)
+      erb(:"#{template}", options)
+    end
+
+    # Called by plugins
+    def render_partial(engine, template, options = {}, locals = {}, &block)
+      partial(template, options)
+    end
+
+    def _add_underscore(template)
+      template_array = template.to_s.split('/')
+      template_array[0..-2].join('/') + "/_#{template_array[-1]}"
+    end
+
+    def _add_application_dir(template)
+      "application/#{template}"
+    end
+
+  end
+end

data/lib/coprl/presenters/web_client/helpers/sinatra/raw.rb

@@ -0,0 +1,9 @@
+module Coprl::Presenters::WebClient::Helpers::Sinatra
+  module Raw
+    def raw(html_js_string)
+      # Sinatra is raw/unsafe by default - this is the opposite of rails
+      # For the inverse see escape_html
+      html_js_string
+    end
+  end
+end

data/lib/coprl/presenters/web_client/helpers/sinatra/safe_markdown.rb

@@ -0,0 +1,10 @@
+module Coprl::Presenters::WebClient::Helpers::Sinatra
+  module SafeMarkdown
+    include Coprl::Presenters::WebClient::Helpers::Markdown
+    # Called by built in views
+    def markdown(string)
+      # Sinatra does not need a safe_html call it defaults to safe_html
+      base_markdown(string)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Coprl::Presenters::WebClient::Helpers
+  module SnakeToCamel
+    def snake_to_camel(hash, except: [])
+      Hash[hash.map {|k, v|
+        next [k, v] if except.include?(k)
+        new_key = k.to_s.split('_').collect(&:capitalize).join
+        new_key[0] = new_key[0].downcase
+        [new_key, v]}
+      ]
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Coprl::Presenters::WebClient::Helpers
+  module TransformHash
+    def to_hash(ostruct_or_hash)
+      {}.tap do |h|
+        ostruct_or_hash.to_h.each {|key, value| h[key.to_sym] = transform(value)}
+      end
+    end
+
+    def transform(thing)
+      case thing
+      when OpenStruct
+        to_hash(thing)
+      when Array
+        thing.map {|v| transform(v)}
+      else
+        thing
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Coprl::Presenters::WebClient::Helpers
+  module UniqueId
+    def unique_id(comp)
+      "#{comp.id}-#{SecureRandom.hex(4)}"
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'erb'
+
+module Coprl
+  module Presenters
+    module WebClient
+      # This class renders headers for the plugins into the default layout.
+      class PluginHeaders
+        extend Pluggable
+        include_plugins(:WebClientComponents)
+
+        def initialize(pom:, render:)
+          @pom = pom
+          @render = render
+          initialize_plugins
+        end
+
+        def render
+          results = ""
+          ((@plugins||[]) + Coprl::Presenters::Settings.config.presenters.plugins).each do |plugin|
+            header_method = :"render_header_#{plugin}"
+            results << send(header_method,
+                 @pom,
+                 render: @render) if respond_to?(header_method)
+          end
+          results
+        end
+
+        private
+
+        def initialize_plugins
+          @plugins = @pom.send(:plugins)
+          self.class.include_plugins(:WebClientComponents, plugins: @plugins)
+        end
+      end
+    end
+  end
+end