voom-presenters 0.2.0 → 2.1.0

data/app/demo/plugins/image_crop.pom

@@ -0,0 +1,44 @@
+Voom::Presenters.define(:image_crop, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :image_crop
+
+  page_title 'Image Crop'
+
+  indented_grid do
+    title 'Drag and drop with cropper preview'
+    grid do
+      column 6 do
+        image_crop id: :event_image,
+                   aspect_ratio: 1.0,
+                   image: 'https://cdn.mos.cms.futurecdn.net/4f6d31c116fdada59a5cb16d136e3068-970-80.jpg' do
+        end
+      end
+      column 6 do
+        file_input name: :event_file_name, preview: :event_image, accept: 'image/png, image/jpeg, image/gif, image/svg+xml' do
+          grid do
+            column 12 do
+              card do
+                text 'Drop it here'
+                button icon: :cloud_upload
+              end
+            end
+          end
+        end
+      end
+      event :change do
+        replaces :context_list, ':context_list'
+      end
+    end
+  end
+
+  # image_crop do
+  #   event :change do
+  #     replaces :context_list, ':context_list'
+  #   end
+  # end
+  attach 'context_list'
+  attach :code, file: __FILE__
+end
+

data/app/demo/plugins/index.pom

@@ -0,0 +1,29 @@
+Voom::Presenters.define(:index, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :foo
+
+  indented_grid do
+    display 'Sample Plugin'
+    body 'You can extend the presenters by writing a plugin.'
+    body 'Plugins can fully extend and override built in presenter behavior.'
+    blank
+    icon 'fa-hand-point-left', position: :left
+    subheading 'Select a plugin to get started'
+    blank
+    body 'The plugin generator is the easiest way to get started.'
+    body 'presenters generate plugin <your plugin name>'
+    blank
+    body 'For a complete example checkout the sample '\
+               '[foo_presenter_plugin](https://github.com/rx/foo_presenter_plugin).'
+    foo(random_fact)
+    button 'New Random Fact' do
+      event :click do
+        bar 'Showing new random fact!'
+        snackbar last_response.data
+      end
+    end
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/plugins/nav/drawer.pom

@@ -0,0 +1,19 @@
+Voom::Presenters.define(:plugin_drawer, namespace: :plugins) do
+  helpers Voom::Presenters::Helpers::Inflector
+  drawer 'Plugins' do
+    menu do
+      item 'Sample Plugin' do
+        event :click do
+          loads :index
+        end
+      end
+      %i(image_crop chart).sort.each do |comp|
+        item titleize(comp) do
+          event :click do
+            loads comp
+          end
+        end
+      end
+    end
+  end
+end

data/app/demo/shared/context_list.pom

@@ -9,7 +9,7 @@ Voom::Presenters.define(:context_list) do
     end
 
     def scrubbed_context
-      scrubbed_keys = context.fetch(:exclude) {%w{title file hide_time}}
+      scrubbed_keys = context.fetch(:exclude) {%w{title file hide_time _presenter_ _namespace1_ session}}
       context.select {|k, _| !scrubbed_keys.include?(k.to_s)}
     end
   end

data/app/demo/styles.pom

@@ -34,7 +34,9 @@ Voom::Presenters.define(:styles) do
     separator
     body 'Line above me is a separator'
     link 'You can have a link', 'https://www.google.com/search?q=link&source=lnms&tbm=isch&sa=X&ved=0ahUKEwipr4zY_JXdAhVNXK0KHWFNCdYQ_AUICigB&biw=1651&bih=932'
+    blank
+    link 'I open in a new tab or window', 'https://example.com', target: :blank
 
   end
   attach :code, file: __FILE__
-end
+end

data/bin/console

@@ -15,8 +15,8 @@ Voom::Presenters::App.boot!
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require 'irb'
-IRB.start
+# require 'irb'
+# IRB.start

data/component-status.yml

@@ -49,20 +49,20 @@
     Notes: 
 -
     Components: Data tables
-    Implementation: MDL
+    Implementation: MDC
     MDL: 
-    MDC: N
+    MDC: Y
     Priority: 
     Completeness: 2
     Notes: 
 -
     Components: Dialogs
-    Implementation: MDL
+    Implementation: MDC
     MDL: 
     MDC: Y
     Priority: High
-    Completeness: 1
-    Notes: Current implementation from MDL and polyfil does not work on iOS/Safari. Port to MDC.
+    Completeness: 2
+    Notes:
 -
     Components: Dividers
     Implementation: N
@@ -121,11 +121,11 @@
     Notes: Date, time, datetime are supported.
 -
     Components: Progress & activity
-    Implementation: N
+    Implementation: MDC
     MDL: 
     MDC: Y
-    Priority: medium
-    Completeness: 
+    Priority:
+    Completeness: 1
     Notes: 
 -
     Components: Selection controls/switches
@@ -210,10 +210,10 @@
            The list icons are not displaying tooltips.
            **Help wanted**
 -
-    Components: Widgets
-    Implementation: N
-    MDL: N
-    MDC: N
-    Priority: medium
-    Completeness: 
-    Notes: Need extension/plugin design with ace editor and charts as available plugins.
+    Components: Widgets/Plugins
+    Implementation: Various
+    MDL: N/A
+    MDC: N/A
+    Priority:
+    Completeness: 2
+    Notes: Handled by presenter plugins.

data/config.ru

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-if ENV['VOOM_ENV']=='integration_testing'
+if ENV['VOOM_ENV'] == 'integration_testing'
   require 'simplecov'
   if ENV['CIRCLE_ARTIFACTS']
     dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
@@ -10,22 +10,32 @@ end
 
 ENV['VOOM_ROOT'] = File.expand_path(__dir__)
 ENV['GOOGLE_API_KEY'] = 'AIzaSyDhSgj9XSBLY5E9Rx5pP2ILQ7IXnD4uX2Q'
-libdir = File.join(ENV['VOOM_ROOT'], 'lib')
-$:.unshift(libdir) unless $:.include?(libdir)
-require 'voom/presenters/api/app'
-require 'voom/presenters/web_client/app'
-require 'voom/presenters/demo/search'
-require 'voom/presenters/demo/echo'
+require 'voom'
+
+require 'rack/cors'
+use Rack::Cors do
+  allow do
+    origins '*'
+    resource '*', headers: :any, methods: [:get, :post, :options]
+  end
+end
+
+Voom::Presenters::Settings.configure do |config|
+  config.presenters.root = File.join(ENV['VOOM_ROOT'], 'app')
+  config.presenters.web_client.prepare_context << ->(context, session, _env) {
+    context.merge(session: session)
+  }
+end
 
 use Voom::Presenters::Demo::Search
 use Voom::Presenters::Demo::Echo
+use Voom::Presenters::Demo::Slow
+use Voom::Presenters::Demo::DragonDrop
 
 use Voom::Presenters::WebClient::App
 run Voom::Presenters::Api::App
 
-Voom::Presenters::Settings.configure do |config|
-  config.presenters.root = File.join(ENV['VOOM_ROOT'], 'app')
-end
+
 Voom::Presenters::App.boot!
 
 

data/docs/settings.md

@@ -0,0 +1,81 @@
+# Configuration
+Presenters can be configured via settings set in e.g. Rails initializers.
+
+## Overview
+Configuration is handled via [dry-configurable](https://github.com/dry-rb/dry-configurable).
+
+```ruby
+Voom::Presenters::Settings.configure do |config|
+  config.presenters.helpers << SomeHelperClass
+end
+```
+
+## Table of Contents
+* [`before_render`](#before_render)
+
+## Settings
+### `before_render`
+`before_render` is an array of things which respond to `#call/1`. The items in
+the array are lazily invoked with the current request prior to a Presenter
+being rendered.
+
+If an item returns a non-`nil` Presenter name, this Presenter will be rendered
+instead of the Presenter that was about to be rendered. In this case, subsequent
+`before_render` items will not be invoked.
+
+```ruby
+# request: /foos/foo?id=1
+
+Voom::Presenters::Settings.configure do |config|
+  config.presenters.before_render << lambda do |req|
+    if some_predicate?
+      return :render_me_instead
+      # /render_me_instead?id=1 will be rendered instead of /foos/foo?id=1.
+    end
+
+    # return nil will not intercept rendering and the next lambda will be
+    # invoked.
+  end
+
+  # this lambda will be invoked only if all previous lambdas returned nil.
+  config.presenters.before_render << lambda do |req|
+    puts 'if you see me, some_predicate? returned true'
+
+    # return nil will not intercept rendering and the next lambda will be
+    # invoked.
+  end
+end
+```
+
+If all items return `nil`, the original Presenter is rendered unintercepted.
+
+#### Returning context
+
+A `before_render` item may optionally return a context hash. This hash will be
+passed to the rendered presenter and merged with existing context at render
+time. **Key names in a returned context hash will overwrite the request's
+context, so use with caution.**
+
+```ruby
+# request: /foos/foo?id=1
+
+class AuthenticationCheck
+  def initialize; end
+
+  def call(req)
+    unless authenticated?(req)
+      return ['auth:login', { timestamp: Time.current.to_i }]
+      # /auth/login?id=1&timestamp=1579535489 will be rendered instead of
+      # /foos/foo?id=1.
+      # /auth/login will have context { id: 1, timestamp: 1579535489 }
+    end
+
+    # return nil will not intercept rendering and the next lambda will be
+    # invoked.
+  end
+end
+
+Voom::Presenters::Settings.configure do |config|
+  config.presenters.before_render << AuthenticationCheck.new
+end
+```

data/exe/presenters

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative '../lib/voom/presenters/cli'
+Voom::Presenters::Cli.start(ARGV)

data/lib/hash_ext/traverse.rb

@@ -0,0 +1,14 @@
+module HashExt
+  module Traverse
+    def self.traverse(hash, &block)
+      hash.inject({}) do |h,(k,v)|
+        if Hash === v
+          v = traverse(v,&block)
+        end
+        nk, nv = block.call(k,v)
+        h[nk] = nv unless nk.nil?
+        h
+      end
+    end
+  end
+end

data/lib/voom.rb

@@ -0,0 +1,25 @@
+require 'zeitwerk'
+
+class MyInflector < Zeitwerk::GemInflector
+  def camelize(basename, _abspath)
+    case basename
+    when "dsl"
+      "DSL"
+    else
+      super
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector = MyInflector.new(__FILE__)
+#loader.logger = Logger.new($stderr)
+loader.setup
+
+module Voom
+end
+
+if defined?(::Rails)
+  # We need this class's file to be parsed, but we want to let Zeitwerk load it
+  Voom::Railtie
+end

data/lib/voom/container_methods.rb

@@ -1,8 +1,8 @@
-require  'voom/symbol/to_str'
+require 'dry-container'
 
 module Voom
   module ContainerMethods
-    include Voom::Symbol
+    include Voom::Symbol::ToStr
 
     def registered_keys
       @registered_keys ||= []

data/lib/voom/engine.rb

@@ -0,0 +1,5 @@
+module Voom
+  class Engine < ::Rails::Engine
+    config.eager_load_paths += Dir["#{config.root}/lib"]
+  end
+end

data/lib/voom/presenters/api/app.rb

@@ -1,7 +1,6 @@
 require 'sinatra'
+require 'honeybadger' if ENV.fetch('HONEYBADGER_API_KEY'){false}
 require 'json'
-require 'voom/presenters'
-require 'voom/presenters/api/router'
 
 module Voom
   module Presenters
@@ -31,23 +30,44 @@ module Voom
 
         private
 
+        # analogous to Voom::Presenters::WebClient::App#render_presenter
         def render_presenter(presenter)
-          # puts "/presenters/api/#{params[:version]}/#{params[:presenter]}/"
-          # puts "Parameters: #{params.inspect}"
-          presenter = Voom::Presenters::App[presenter].call
-          pom = presenter.expand(router: router, context: prepare_context)
-          content_type :json
-          JSON.dump(pom.to_hash)
+          begin
+            before_render = Presenters::Settings.config.presenters.before_render
+            render_instead, ctx = before_render
+                                    .lazy
+                                    .map { |p| p.call(request) }
+                                    .detect(&:itself)
+
+            if Presenters::App.registered?(render_instead)
+              presenter = render_instead
+            end
+
+            p = params.merge(ctx || {})
+            presenter = Voom::Presenters::App[presenter].call
+            pom = presenter.expand(router: router, context: prepare_context(p))
+            content_type :json
+            JSON.dump(pom.to_hash)
+          rescue StandardError => e
+            presenter_name = presenter.respond_to?(:name) ? presenter.name : '(unknown)'
+            Presenters::Settings.config.presenters.error_logger.call(
+              @env['rack.errors'],
+              e,
+              params,
+              presenter_name
+            )
+            raise e
+          end
         end
 
         def router
           settings.router_.new(base_url: "#{request.base_url}#{env['SCRIPT_NAME']}")
         end
 
-        def prepare_context
+        def prepare_context(base_params = params)
           prepare_context = Presenters::Settings.config.presenters.web_client.prepare_context.dup
           prepare_context.push(method(:scrub_context))
-          context = params.dup
+          context = base_params.dup
           prepare_context.reduce(context) do |params, context_proc|
             context_proc.call(params, session, env)
           end
@@ -63,4 +83,4 @@ module Voom
       end
     end
   end
-end
+end