coprl 0.1.0 → 3.0.0.beta.1

data/lib/coprl/presenters/helpers/redact.rb

@@ -0,0 +1,13 @@
+module Coprl
+  module Presenters
+    module Helpers
+      module Redact
+        # https://material.io/guidelines/patterns/data-formats.html#data-formats-data-redaction-truncation
+        def redact(string, last_chars = 4)
+          return "" unless string
+          "• • • #{string.split(//).last(last_chars).join}"
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/helpers/route.rb

@@ -0,0 +1,24 @@
+module Coprl
+  module Presenters
+    module Helpers
+      module Route
+        include Namespace
+
+        def presenters_path(presenter, host: false, **params)
+          presenter = _expand_namespace_(presenter, namespace)
+          presenter = presenter.gsub(':', '/')
+          router.url(render: presenter, host: host, context: params)
+        end
+
+        alias presenter_path presenters_path
+
+        # Full qualified URL
+        def presenters_url(presenter, **params)
+          presenters_path(presenter, host: true, **params)
+        end
+
+        alias presenter_url presenters_url
+      end
+    end
+  end
+end

data/lib/coprl/presenters/helpers/time.rb

@@ -0,0 +1,27 @@
+require 'tzinfo'
+
+module Coprl
+  module Presenters
+    module Helpers
+      module Time
+        LONG_FORMAT='%m/%d/%Y %I:%M:%S %p %Z'
+        SHORT_FORMAT='%d %b %H:%M %Z'
+
+        def format_time(time, format: LONG_FORMAT, timezone: nil)
+          return '' unless time
+          time = time.in_time_zone(timezone) if timezone
+          time.strftime(format)
+        end
+
+        def format_time_long(time, format: nil, timezone: nil)
+          format_time(time, format: format||LONG_FORMAT, timezone: timezone)
+        end
+
+        def format_time_short(time, format: nil, timezone: nil)
+          format_time(time, format: format||SHORT_FORMAT, timezone: timezone)
+        end
+      end
+    end
+  end
+end
+

data/lib/coprl/presenters/namespace.rb

@@ -0,0 +1,12 @@
+module Coprl
+  module Presenters
+    module Namespace
+      def _expand_namespace_(presenter, namespace)
+        presenter = presenter.to_s
+        return presenter if presenter.split(':').size > 1
+        return presenter if presenter.split('/').size > 1
+        namespace.any? ? namespace.join(':')+':'+presenter : presenter
+      end
+    end
+  end
+end

data/lib/coprl/presenters/pluggable.rb

@@ -0,0 +1,37 @@
+include Coprl::Trace
+
+module Coprl
+  module Presenters
+    module Pluggable
+      def include_plugins(*layers, plugins: [],
+                          plugin_method: method(:include))
+        plugins = Array(plugins) + Array(Coprl::Presenters::Settings.config.presenters.plugins)
+        plugins.uniq.each do |plugin|
+          plugin(plugin, *layers, plugin_method: plugin_method)
+        end
+      end
+
+
+      # Returns the module for the specified plugin. If the module is not
+      # defined, the corresponding plugin required.
+      def plugin_module(plugin)
+        module_name = plugin.to_s.gsub(/(^|_)(.)/) {|x| x[-1..-1].upcase}
+        unless Coprl::Presenters::Plugins.const_defined?(module_name, false)
+          trace {"Method plugin loading plugin: #{plugin}"}
+          load "coprl/presenters/plugins/#{plugin}.rb"
+        end
+        Coprl::Presenters::Plugins.const_get(module_name)
+      end
+
+      def plugin(plugin, *layers, plugin_method: method(:include))
+        m = plugin.is_a?(Module) ? plugin : plugin_module(plugin)
+        layers.each do |layer|
+          if m.const_defined?(layer, false) && !self.const_defined?(layer, false)
+            trace {"Injecting plugin(#{m.const_get(layer).inspect}) into #{self.inspect}!"}
+            plugin_method.call(m.const_get(layer))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/plugins.rb

@@ -0,0 +1,7 @@
+module Coprl
+  module Presenters
+    module Plugins
+
+    end
+  end
+end

data/lib/coprl/presenters/plugins/google_maps.rb

@@ -0,0 +1,24 @@
+module Coprl
+  module Presenters
+    module Plugins
+      module GoogleMaps
+          module DSLComponents
+            def google_map(**attributes, &block)
+              self << GoogleMap.new(parent: self, **attributes, &block)
+            end
+          end
+        module WebClientComponents
+          def render_google_map(comp,
+                                render:,
+                                components:,
+                                index:)
+            view_dir = File.join(__dir__, 'google_maps')
+            render.call :erb, :google_map, views: view_dir,
+                        locals: {comp: comp,
+                                 components: components, index: index}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/plugins/google_maps/google_map.erb

@@ -0,0 +1,10 @@
+<% if comp %>
+  <img id="<%= comp.id %>"
+       class="v-image v-google-map-image <%= comp.events ? 'v-actionable' : nil%>"
+       src="<%= comp.url %>"
+       border="0"
+       height="<%= comp.height %>"
+       width="<%= comp.width %>"
+       alt=""
+       <%= erb :"components/event", :locals => {comp: comp, events: comp.events, parent_id: comp.id} %>>
+<% end %>

data/lib/coprl/presenters/plugins/google_maps/google_map.rb

@@ -0,0 +1,41 @@
+require 'uri'
+
+module Coprl
+  module Presenters
+    module Plugins
+      module GoogleMaps
+        class GoogleMap < DSL::Components::EventBase
+
+          attr_reader :url, :google_api_key, :height, :width
+
+          def initialize(**attribs_, &block)
+            super(type: :google_map, **attribs_, &block)
+            @address = attribs.delete(:address)
+            @latitude = attribs.delete(:latitude)
+            @longitude = attribs.delete(:longitude)
+            @width = attribs.delete(:width) { 640 }
+            @height = attribs.delete(:height) { 640 }
+            @zoom = attribs.delete(:zoom) { 14 }
+            @scale = attribs.delete(:scale) { 1 }
+            @google_api_key = attribs.delete(:google_api_key) { ENV['GOOGLE_API_KEY'] }
+            @url = build_static_map_image_url
+            expand!
+          end
+
+          private
+
+          def build_static_map_image_url
+            return @img_url if locked?
+            @img_url = "https://maps.googleapis.com/maps/api/staticmap?center=#{query_string}&zoom=#{@zoom}&scale=#{@scale}&size=#{@width}x#{@height}&markers=|#{query_string}&key=#{@google_api_key}"
+          end
+
+          def query_string
+            return "#{@latitude},#{@longitude}" if @latitude && @longitude
+            URI.escape(@address)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/rails/engine.rb

@@ -0,0 +1,19 @@
+module Coprl
+  module Presenters
+    module Rails
+      class Engine < ::Rails::Engine
+        config.before_configuration do
+          # load our engine from the rails-engine directory
+          config.root = File.join(root,'rails-engine')
+        end
+
+        initializer 'coprl_presenters.middleware' do |app|
+          # adds the public directory to the middleware so that the bundle.css and bundle.js are picked up
+          # TODO: should rename these since they are common names that are likely going to collide
+          app.middleware.use ::ActionDispatch::Static, File.join(root, '..', 'public')
+        end
+      end
+    end
+  end
+end
+

data/lib/coprl/presenters/rails/railtie.rb

@@ -0,0 +1,41 @@
+require 'filewatcher'
+
+module Coprl
+  module Presenters
+    module Rails
+      class Railtie < ::Rails::Railtie
+        BOOT = -> {
+          Coprl::Presenters::App.reset!
+          Coprl::Presenters::Settings.configure do |config|
+            config.presenters.root = ::Rails.root.join('app')
+            config.presenters.deep_freeze = false
+          end
+          Coprl::Presenters::App.boot!
+        } unless defined?(BOOT)
+
+        WATCH = -> {
+          return unless ::Rails.env.development?
+          path = ::Rails.root.join('app', '**', '*.pom')
+          puts "Watching #{path} for changes..."
+          filewatcher = Filewatcher.new(path)
+          Thread.new(filewatcher) do |fw|
+            fw.watch do |f|
+              puts "Detected updated POM file: #{f}"
+              begin
+                BOOT.call
+              rescue Exception => exc
+                puts exc.backtrace
+                puts exc.message
+              end
+            end
+          end
+        } unless defined?(WATCH)
+
+        config.after_initialize do
+          BOOT.call
+          WATCH.call
+        end
+      end
+    end
+  end
+end

data/lib/coprl/presenters/registry.rb

@@ -0,0 +1,64 @@
+module Coprl
+  module Presenters
+    class Registry
+      class << self
+        include Coprl::Trace
+      end
+
+      @registry = {}
+
+      def self.registry
+        @registry
+      end
+
+      def self.define(name, namespace, options, &block)
+        namespace = Array(namespace).map(&:to_s)
+        fq_name = namespace.any? ? namespace.join(':') + ':' + name.to_s : name.to_s
+        registry[fq_name] = Coprl::Presenters::DSL::Definition.new(name, namespace, options, &block)
+      end
+
+      def self.load(directory)
+        files = File.join(directory, '**', '*.pom')
+        Dir.glob(files) do |file|
+          Kernel.load file
+        end
+      end
+
+      def self.finalize
+        registry.each do |key, definition|
+          begin
+            register(key, build(definition))
+          rescue Exception => e
+            logger.error {"Failed to load presenter #{key}: #{e.inspect}."}
+            raise e
+          end
+        end
+      end
+
+      # This method empties out the dsl definitions
+      # It should ONLY be used for testing purposes
+      def self.reset!
+        registry.clear
+      end
+
+      private
+
+      def self.register(name, definition)
+        return Coprl::Presenters::App.register(name: name, presenter: definition) unless Coprl::Presenters::App.registered?(name)
+      end
+
+      def self.build(definition)
+        definition.build
+      end
+    end
+
+    def self.define(name, namespace: nil, options: {}, &block)
+      unless namespace
+        namespace = name.to_s.split(':')
+        name = namespace.pop
+      end
+      Registry.define(name, namespace, options, &block)
+    end
+
+  end
+end

data/lib/coprl/presenters/router.rb

@@ -0,0 +1,59 @@
+require 'rack'
+
+module Coprl
+  module Presenters
+      class Router
+
+        attr_reader :base_url
+
+        def initialize(base_url: nil)
+          @base_url = base_url
+        end
+
+        def url(command: nil, render: nil, host: false, context:)
+          _params_ = context.dup
+          return build_render_url(render, _params_, host: host) unless command
+          _params_[:redirect]=build_render_url(render, _params_) if render
+          build_command_url(command, _params_)
+        end
+
+        def scrub_params(_params_)
+          _params_.delete('captures')
+          _params_.delete('presenter')
+          _params_.delete('action')
+          _params_.delete('errors')
+          _params_
+        end
+
+        private
+
+        def build_command_url(command, params)
+          return '' unless command
+          add_query_params(command, params)
+        end
+
+        def build_render_url(render_, params, host:)
+          return '#' unless render_
+          render = render_.to_s
+          return render if render.start_with?('http')
+          render = render.gsub(':', '/')
+          seperator = render.start_with?('/') ? '' : '/'
+          url = "#{host ? base_url : nil}#{seperator}#{render}"
+          add_query_params(url, params)
+        end
+
+        def add_query_params(url, params)
+          query_params = build_params(params)
+          if (!query_params.nil? && !query_params.empty?)
+            query_seperator = url.include?('?') ? '&' : '?'
+            url = "#{url}#{query_seperator}#{query_params}"
+          end
+          url
+        end
+
+        def build_params(params)
+          Rack::Utils.build_nested_query(scrub_params(params))
+        end
+      end
+    end
+  end

data/lib/coprl/presenters/settings.rb

@@ -0,0 +1,81 @@
+#include Coprl::Trace
+#trace {"Loading Presenters Settings"}
+require 'dry-configurable'
+
+unless defined?(Coprl::Presenters::Settings)
+  module Coprl
+    module Presenters
+      class Settings
+        extend ::Dry::Configurable
+        setting :presenters do
+          setting :root, []
+          # You can add helpers that will automatically be included
+          # For example:
+          # Coprl::Presenters::Settings.configure do |config|
+          #   config.presenters.helpers << YourHelperModule # Passing a module
+          #   config.presenters.helpers << &->{ def foo; :foo; end } # Passing a block
+          # end
+          setting :helpers, [Coprl::Presenters::Helpers::Route]
+          setting :deep_freeze, false
+          setting :id_generator, ->(node) {"id-#{SecureRandom.hex}"}
+          setting :web_client do
+            # Add lambda's to modify the context for the presenters
+            # For example:
+            # Coprl::Presenters::Settings.configure do |config|
+            #   config.presenters.web_client.prepare_context << ->(context, session, _env){
+            #     identity_id = session[:aaa_identity]
+            #     context.merge(aaa_identity: identity_id)
+            #   }
+            # end
+            setting :prepare_context, []
+            # Relative to the root
+            setting :custom_css, '../public/presenters'
+            setting :protect_from_forgery, false
+          end
+          setting :plugins, [:google_maps]
+          setting :components do
+            setting :defaults do
+              setting :datetime do
+                setting :format, 'M j, y h:i K'
+                setting :time_24hr, false
+              end
+              setting :date do
+                setting :format, 'F j, Y'
+              end
+              setting :time do
+                setting :format, 'h:i K'
+                setting :time_24hr, false
+              end
+              setting :text_area do
+                setting :rows, 3
+                setting :cols, 80
+              end
+              # Typography
+              setting :headline do
+                setting :level, 5
+              end
+              setting :title do
+                setting :level, 6
+              end
+              setting :rich_text_area do
+                setting :rows, 6
+              end
+            end
+          end
+          setting :error_logger, ->(file, e, _params, _presenter_name) {
+            msg = [
+              "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")} - #{e.class} - #{e.message}:",
+              *e.backtrace
+            ].join("\n\t")
+            file.puts(msg)
+          }
+          setting :before_render, [] # an array of `#call`ables
+        end
+
+        def self.default(type, key)
+          config.presenters.components.defaults&.public_send(type)&.public_send(key)
+        end
+      end
+    end
+  end
+end