voom-presenters 0.2.0 → 2.1.0

data/lib/voom/presenters/generators/templates/plugin/presenter_plugin.gemspec.tt

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "<%= name %>_presenter_plugin"
+  spec.version       = '0.0.1'
+  spec.authors       = ["<%= `git config user.name`.strip %>"]
+  spec.email         = ["<%= `git config user.email`.strip %>"]
+
+  spec.summary       = %q{<%= name %> presenter plugin.}
+  spec.homepage      = 'http://github.com/<%= `git config user.name`.strip %>/<%= name %>_presenters_plugin'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/voom/presenters/generators/templates/plugin/views/assets/css/components/component.css.tt

@@ -0,0 +1,21 @@
+/* Custom CSS for this component - defines a fade in animation*/
+#random_fact {
+    opacity: 0;
+}
+
+#random_fact.load {
+    opacity: 1;
+    animation-name: fadeInOpacity;
+    animation-iteration-count: 1;
+    animation-timing-function: ease-in;
+    animation-duration: 2s;
+}
+
+@keyframes fadeInOpacity {
+    0% {
+        opacity: 0;
+    }
+    100% {
+        opacity: 1;
+    }
+}

data/lib/voom/presenters/generators/templates/plugin/views/assets/js/components/actions/action.js.tt

@@ -0,0 +1,15 @@
+// This event callback pushes its results into the results array and returns a promise.
+function <%=underscore(name)%>_action(_options, params, _event, results) {
+  var promiseObj = new Promise(function(resolve) {
+    console.log('<%= classify(name) %> called');
+    // Reload iFrame: https://stackoverflow.com/questions/86428/what-s-the-best-way-to-reload-refresh-an-iframe
+    document.getElementById('random_fact').src += '';
+    results.push({
+      action: 'action',
+      content: JSON.stringify({data: params.text}),
+      statusCode: 200,
+    });
+    resolve(results);
+  });
+  return promiseObj;
+}

data/lib/voom/presenters/generators/templates/plugin/views/assets/js/components/component.js.tt

@@ -0,0 +1,39 @@
+  // Optional Javascript callback class. You typically need to define this when you have data to submit, or special
+  // event handling to bind to.
+  // To hook this up you need to provide the `v-plugin` class and
+  // data-plugin-callback='RandomFacts' on the element.
+  class RandomFacts {
+    // passed the DOM element that has the .v-plugin class on it.
+    constructor(element) {
+      // This is where you might pull data elements into your
+      // component from the markup. Like so:
+      // this.data = element.dataset.someDataICareAbout;
+    }
+
+    // Optional
+    // Called before the component is submitted via post/put. Allows the component to add its key/value pairs to the
+    // submitted data.
+    // If you provide this you need to add the v-input class to your DOM element to get called.
+    // Containers iterate their elements that have the v-input class defined on them and invoke the prepareSubmit
+    // function for each.
+    prepareSubmit(params) {
+      // params is a key,value pair. Add name/value like so:
+      // params.push(['some_name', 'some_value']);
+    }
+
+    // Optional
+    // Called whenever a container is about to be submitted, before prepareSubmit.
+    // returns true on success
+    // returns on failure return an error object that can be processed by VErrors:
+    //    { email: ["email must be filled", "email must be from your domain"] }
+    //    { page:  ["must be filled"] }
+    // Returning an error stops the submission.
+    validate(formData) {
+      return true;
+    }
+
+    // Optional
+    // Clear's the control
+    clear() {
+    }
+  }

data/lib/voom/presenters/generators/templates/plugin/views/components/component.erb.tt

@@ -0,0 +1,14 @@
+<!--Custom markup.
+If the plugin defines a component then it should set v-plugin and data-plugin-callback to the class of the component
+
+If the plugin posts data then it should define the v-input class.
+That will cause its validate and prepareSubmit methods in the component to be called
+
+If the plugin has events it publishes then the erb :"components/event" needs to be invoked to
+hookup the event handling markup
+
+Any additional data you want to pass to your component javascript should be setup here as data attributes.
+-->
+<iframe id="random_fact" class='v-plugin v-input' data-plugin-callback='RandomFacts'
+        src="<%%= comp.random_fact %>" height=512
+        <%%= erb :"components/event", :locals => {comp: comp, events: comp.events, parent_id: comp.id} %>></iframe>

data/lib/voom/presenters/generators/templates/plugin/views/components/component_header.erb.tt

@@ -0,0 +1,20 @@
+<style>
+  <%%= File.read(File.expand_path('../assets/css/components/<%= underscore(name) %>.css', __dir__)  ) %>
+</style>
+
+<script>
+  // This file is defining the callback method that will be invoked when the custom plugin actionJs `actionJs` is encountered
+  <%%= File.read(File.expand_path('../assets/js/components/actions/<%= underscore(name) %>.js', __dir__)  ) %>
+  // This file is defining the plugin component that will be delegated to by the WebClient.
+  <%%= File.read(File.expand_path('../assets/js/components/<%= underscore(name) %>.js', __dir__)  ) %>
+
+  // Custom javascript specific to this sample plugin - sets the class name that causes the initial load to
+  // animate a transition (defined in the component.css.tt file)
+  function load() {
+    document.getElementById('random_fact').className = ' load';
+  }
+
+  window.onload = load;
+</script>
+
+

data/lib/voom/presenters/helpers.rb

@@ -1,16 +1,10 @@
-require 'voom/presenters/helpers/date'
-require 'voom/presenters/helpers/time'
-require 'voom/presenters/helpers/inflector'
-require 'voom/presenters/helpers/errors'
-
 module Voom
   module Presenters
     module Helpers
       include Helpers::Time
       include Helpers::Date
-      include Helpers::Errors
-      if defined?(Rails)
-        require 'voom/presenters/helpers/rails'
+      include Helpers::Redact
+      if defined?(::Rails)
         include Voom::Presenters::Helpers::Rails
       end
     end

data/lib/voom/presenters/helpers/inflector.rb

@@ -3,7 +3,7 @@ module Voom
     module Helpers
       module Inflector
         def inflector
-          @inflector ||= Dry::Inflector.new
+          @_inflector_ ||= Dry::Inflector.new
         end
 
         def humanize(text)

data/lib/voom/presenters/helpers/rails.rb

@@ -1,8 +1,4 @@
 if defined?(Rails)
-  require 'voom/presenters/helpers/rails/currency'
-  require 'voom/presenters/helpers/rails/model_table'
-  require 'voom/presenters/namespace'
-
   module Voom
     module Presenters
       module Helpers
@@ -11,15 +7,18 @@ if defined?(Rails)
           include Voom::Presenters::Helpers::Rails::Currency
           include Voom::Presenters::Helpers::Rails::ModelTable
           include Namespace
+
           def default_url_options
             {}
           end
 
-          def presenters_path(presenter, **params)
+          def presenters_path(presenter, host: false, **params)
             presenter = _expand_namespace_(presenter, namespace)
-            presenter = presenter.gsub(':','/')
+            presenter = presenter.gsub(':', '/')
+
+            path = host ? voom_presenters_web_client_app_url(params, host: router.base_url) :
+                          voom_presenters_web_client_app_path(params)
 
-            path = voom_presenters_web_client_app_path(params)
             if path.include?('?')
               path = path.sub('?', "#{presenter}?")
             else
@@ -29,8 +28,16 @@ if defined?(Rails)
             end
             path
           end
+
+          alias presenter_path presenters_path
+
+          def presenters_url(presenter, host: true, **params)
+            presenters_path(presenter, host: host, **params)
+          end
+
+          alias presenter_url presenters_url
         end
       end
     end
   end
-end
+end

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

@@ -0,0 +1,13 @@
+module Voom
+  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/voom/presenters/helpers/route.rb

@@ -1,16 +1,23 @@
-require 'voom/presenters/namespace'
-
 module Voom
   module Presenters
     module Helpers
       module Route
         include Namespace
 
-        def presenters_path(presenter, **params)
+        def presenters_path(presenter, host: false, **params)
           presenter = _expand_namespace_(presenter, namespace)
-          presenter = presenter.gsub(':','/')
-          router.url(render: presenter, context: params)
+          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

data/lib/voom/presenters/pluggable.rb

@@ -0,0 +1,37 @@
+include Voom::Trace
+
+module Voom
+  module Presenters
+    module Pluggable
+      def include_plugins(*layers, plugins: [],
+                          plugin_method: method(:include))
+        plugins = Array(plugins) + Array(Voom::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 Voom::Presenters::Plugins.const_defined?(module_name, false)
+          trace {"Method plugin loading plugin: #{plugin}"}
+          load "voom/presenters/plugins/#{plugin}.rb"
+        end
+        Voom::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/voom/presenters/plugins.rb

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

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

@@ -0,0 +1,24 @@
+module Voom
+  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/voom/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/voom/presenters/{dsl/components → plugins/google_maps}/google_map.rb

@@ -2,9 +2,9 @@ require 'uri'
 
 module Voom
   module Presenters
-    module DSL
-      module Components
-        class GoogleMap < Base
+    module Plugins
+      module GoogleMaps
+        class GoogleMap < DSL::Components::EventBase
 
           attr_reader :url, :google_api_key, :height, :width
 
@@ -19,6 +19,7 @@ module Voom
             @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

data/lib/voom/presenters/{dsl.rb → registry.rb}

@@ -1,16 +1,6 @@
-require 'voom/trace'
-
 module Voom
   module Presenters
-    def self.define(name, namespace: nil, &block)
-      unless namespace
-        namespace = name.to_s.split(':')
-        name = namespace.pop
-      end
-      DSL.define(name, namespace, &block)
-    end
-
-    module DSL
+    class Registry
       class << self
         include Voom::Trace
       end
@@ -21,10 +11,10 @@ module Voom
         @registry
       end
 
-      def self.define(name, namespace, &block)
+      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] = Voom::Presenters::DSL::Definition.new(namespace, &block)
+        fq_name = namespace.any? ? namespace.join(':') + ':' + name.to_s : name.to_s
+        registry[fq_name] = Voom::Presenters::DSL::Definition.new(name, namespace, options, &block)
       end
 
       def self.load(directory)
@@ -55,12 +45,20 @@ module Voom
 
       def self.register(name, definition)
         return Voom::Presenters::App.register(name: name, presenter: definition) unless Voom::Presenters::App.registered?(name)
-        logger.warn {"Warning attempted to redefine the presenter: #{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/voom/presenters/router.rb

@@ -0,0 +1,59 @@
+require 'rack'
+
+module Voom
+  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