voom-presenters 0.1.10 → 2.0.0

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/components/actions/action.rb.tt

@@ -0,0 +1,16 @@
+require 'voom/presenters/dsl/components/actions/base'
+
+
+module Voom
+  module Presenters
+    module Plugins
+      module <%= classify(name) %>
+          class <%= classify(name) %>Action < DSL::Components::Actions::Base
+            def initialize(**attribs_, &block)
+              super(type: :<%= underscore(name) %>_action, **attribs_, &block)
+            end
+        end
+      end
+    end
+  end
+end

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/components/actions/dsl.rb.tt

@@ -0,0 +1,22 @@
+require_relative '<%= classify(name) %>_action'
+
+module Voom
+  module Presenters
+    module Plugins
+      module <%= classify(name) %>
+        # Event Actions are methods that appear inside an event block.
+        # They do something on the (web) client and require code written for the client.
+        # Name this actionJs method whatever you want
+        # The data for this actionJs is rendered into the DOM using the file:
+        #   web_client/components/actions/<%= classify(name) %>_data.rb
+        # The javascript that performs the actionJs is defined in the file:
+        #   views/js/components/actions/<%= classify(name) %>_action.js
+        module DSLEventActions
+          def <%= underscore(name) %>_action(text, **attributes, &block)
+            self << <%= classify(name) %>::<%= classify(name) %>Action.new(text: text, parent: self, **attributes, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/components/component.rb.tt

@@ -0,0 +1,18 @@
+require 'voom/presenters/dsl/components/event_base'
+
+module Voom
+  module Presenters
+    module Plugins
+      module <%= classify(name) %>
+        class <%= classify(name) %>Component < DSL::Components::EventBase
+          attr_reader :random_fact
+          def initialize(random_fact, **attribs_, &block)
+            @random_fact = random_fact
+            super(type: :<%= underscore(name) %>, **attribs_, &block)
+            expand!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/components/dsl.rb.tt

@@ -0,0 +1,19 @@
+require_relative '<%= underscore(name) %>_component'
+
+module Voom
+  module Presenters
+    module Plugins
+      module <%= classify(name) %>
+        # Components add new methods to the POM component hierarchy. They should add a component object to the
+        # POM component stream. These components are the declarative instructions that are used to render a client.
+        # POM components require corresponding views templates and JS that render them.
+        # Name this method whatever you want.
+        module DSLComponents
+          def <%= underscore(name) %>(random_fact, **attributes, &block)
+            self << <%= classify(name) %>::<%= classify(name) %>Component.new(random_fact, parent: self, **attributes, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/helpers/helper.rb.tt

@@ -0,0 +1,15 @@
+module Voom
+  module Presenters
+    module Plugins
+      module <%= classify(name) %>
+        # Helpers are added to all POM in the system automatically when the plugin is included on the POM or globally.
+        module DSLHelpers
+          # Add your methods here
+          def random_fact
+            "http://en.wikipedia.org/wiki/Special:Randompage"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/plugin.rb.tt

@@ -0,0 +1,9 @@
+# Loads the plugin features
+# Helpers
+require_relative '<%= underscore(name) %>/helpers/<%= underscore(name) %>_helper'
+# Components
+require_relative '<%= underscore(name) %>/components/<%= underscore(name) %>_dsl'
+require_relative '<%= underscore(name) %>/web_client/components/<%= underscore(name) %>_render'
+# Actions
+require_relative '<%= underscore(name) %>/components/actions/<%= underscore(name) %>_dsl'
+require_relative '<%= underscore(name) %>/web_client/components/actions/<%= underscore(name) %>_data'

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/web_client/components/actions/data.rb.tt

@@ -0,0 +1,17 @@
+module Voom
+  module Presenters
+    module Plugins
+      module <%= classify(name) %>
+        # Web Client Actions set up the the event handler data that will be consumed by a javascript class
+        # This data will be stored on the DOM as a data attribute defined in the
+        # file: views/components/assets/<%= underscore(name) %>.erb
+      module WebClientActions
+        def action_data_<%= underscore(name) %>_action(action, _parent_id, *)
+          # Type, URL, Options, Params (passed into javascript event/action classes)
+          [action.type, action.url, action.options.to_h, action.attributes.to_h]
+        end
+      end
+      end
+    end
+  end
+end

data/lib/voom/presenters/generators/templates/plugin/lib/voom/presenters/plugins/web_client/components/render.rb.tt

@@ -0,0 +1,23 @@
+module Voom
+  module Presenters
+    module Plugins
+      module <%= classify(name) %>
+        module WebClientComponents
+          def render_<%= underscore(name) %>(comp,render:, components:, index:)
+            view_dir = File.join(__dir__, '../../../../../../..', 'views', 'components')
+            render.call :erb, :<%= underscore(name) %>, views: view_dir,
+                        locals: {comp: comp,
+                        components: components, index: index}
+          end
+          # The string returned from this method will be added to the HTML header section of the page layout
+          # It will be called once for the page.
+          # The pom is passed along with the sinatra render method.
+          def render_header_<%= underscore(name) %>(_pom, render:)
+            view_dir = File.join(__dir__, '../../../../../../..', 'views', 'components')
+            render.call :erb, :<%= underscore(name) %>_header, views: view_dir
+          end
+        end
+      end
+    end
+  end
+end

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_relative 'helpers/date'
-require_relative 'helpers/time'
-require_relative 'helpers/inflector'
-require_relative 'helpers/errors'
-
 module Voom
   module Presenters
     module Helpers
       include Helpers::Time
       include Helpers::Date
-      include Helpers::Errors
-      if defined?(Rails)
-        require_relative 'helpers/rails'
+      include Helpers::Redact
+      if defined?(::Rails)
         include Voom::Presenters::Helpers::Rails
       end
     end

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

@@ -2,10 +2,10 @@ module Voom
   module Presenters
     module Helpers
       module Date
-        LONG_FORMAT='%m/%d/%Y'
-        SHORT_FORMAT='%d %b %Y'
+        LONG_FORMAT='%B %e, %Y'
+        SHORT_FORMAT='%e %b'
 
-        def format_date(date, format: '%m/%d/%Y')
+        def format_date(date, format: LONG_FORMAT)
           date ? date.strftime(format) : ''
         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,7 +1,4 @@
 if defined?(Rails)
-  require_relative 'rails/currency'
-  require_relative 'rails/model_table'
-
   module Voom
     module Presenters
       module Helpers
@@ -9,12 +6,19 @@ if defined?(Rails)
           include ActionView::Helpers::AssetUrlHelper
           include Voom::Presenters::Helpers::Rails::Currency
           include Voom::Presenters::Helpers::Rails::ModelTable
+          include Namespace
+
           def default_url_options
             {}
           end
 
-          def presenters_path(presenter, **params)
-            path = voom_presenters_web_client_app_path(params)
+          def presenters_path(presenter, host: false, **params)
+            presenter = _expand_namespace_(presenter, namespace)
+            presenter = presenter.gsub(':', '/')
+
+            path = host ? voom_presenters_web_client_app_url(params, host: router.base_url) :
+                          voom_presenters_web_client_app_path(params)
+
             if path.include?('?')
               path = path.sub('?', "#{presenter}?")
             else
@@ -24,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/rails/model_table.rb

@@ -5,8 +5,9 @@ module Voom
         module ModelTable
           # Build a a table from a Rails model
           def table_for(query_,
-                        empty_icon: nil,
+                        empty_icon: 'far fa-folder-open fa-rotate-180',
                         except: [:id, :created_at, :updated_at],
+                        timezone: nil, # The timezone to covnert _at and _on values
                         selectable: false, &block)
             row1 = query_.first
             if row1
@@ -16,27 +17,34 @@ module Voom
 
                 query_.each do |item_|
                   row do
-                    _table_row_(__columns__, block, except, item_)
+                    _table_row_(__columns__, block, except, item_, timezone: timezone)
                   end
                 end
               end
             else
-              body "You have no #{query_.arel_table.name.pluralize}", level: 2
-              icon empty_icon, size: '10rem' if empty_icon
+              icon empty_icon, size: '6rem' if empty_icon
+              body "You have no #{query_.arel_table.name.pluralize.humanize}"
             end
           end
 
 
           private
-          def _table_row_(__columns__, block, except, item_)
+          def _table_row_(__columns__, block, except, item_, timezone: nil)
             __columns__.each do |col|
               next if except.include?(col.name.to_sym)
-              column item_.send(col.name.to_sym) do
+                value = format_value(col.name,item_.send(col.name.to_sym), timezone: timezone)
+              column value do
                 self.instance_exec(item_, col.name.to_sym, &block) if block
               end
             end
           end
 
+          def format_value(col_name, value, timezone:)
+            return format_time_long(value, timezone: timezone) if timezone &&
+                col_name.ends_with?('_at') || col_name.ends_with?('_on')
+            value
+          end
+
           def _table_header_(__columns__, except)
             header do
               __columns__.each do |col|

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