coprl 3.0.0.beta.2 → 3.0.0.beta.7

data/app/demo/components/snackbar_attached.pom

@@ -1,6 +0,0 @@
-
-Coprl::Presenters.define(:snackbar_attached) do
-  title 'In Attached'
-  body  'This can be done in an attached presenter as well'
-  snackbar 'Attached Snackbar Displayed!'
-end

data/lib/coprl/presenters/generators/templates/plugin/README.md

@@ -1,253 +0,0 @@
-# Presenter Plugins
-
-Presenter plugins allows extension and modification of the DSL and WebClient.
-It is powerfully designed for adding additional components to the system, or to change the behavior/look feel/capabilities of existing components.
-
-## Global Plugins
-
-Presenters have global plugins that are configured in the system. They are declared as a setting like so:
-  
-    Coprl::Presenters::Settings.configure do |config|
-      config.presenters.plugins.push(:foo)
-    end 
-
-A global plugin is available to all presenters.
-
-## Local Plugins
-
-A presenters can define that it uses a plugin like so: 
-
-    Coprl::Presenters.define(:index, namespace: :plugins) do
-      plugin :foo
-    end
-
-A local plugin is available only to the presenter that it is defined in.
-
-
-## Creating Plugins
-
-The skeleton for a plugin starts with an empty module in a file stored in `coprl/presenters/plugins` somewhere in ruby's load path 
-(typically in a gemfile or in the lib directory of an framework app, like Rails):
-
-    module Coprl
-      module Presenters
-        module Plugins
-          module Foo
-          end
-        end
-      end
-    end
-
-## Extending the presenter DSL and POM
-
-### Components
-If you want to add additional components to the presenters DSL, provide a `DSLComponents` module under the plugin module:
-
-     module DSLComponents
-       def foo(random_fact, **attributes, &block)
-         self << Foo::Component.new(random_fact, parent: self, **attributes, &block)
-       end
-     end
-
-The above example will extend the dsl by adding the foo method that will add the Foo component to the 
-presenter object model tree.
-
-A presenter component derives from `DSL::Components::Base` or if it needs to handle events  `DSL::Components::EventBase`
-
-      require 'coprl/presenters/dsl/components/base'
-      
-      module Coprl
-        module Presenters
-          module Plugins
-            module Foo
-              class Component < DSL::Components::Base
-                def initialize(**attribs_, &block)
-                  super(type: :foo, **attribs_, &block)
-                end      
-              end
-            end
-          end
-        end
-      end
-      
-### Helpers
-
-To add helpers to the POM define the module `DSLHelpers`
-    
-    module DSLHelpers
-      def random_fact
-        "http://en.wikipedia.org/wiki/Special:Randompage"
-      end
-    end
-
-### Event Actions
-A plugin can extend the set of event actions that are available. 
-When an event fires in the client, like mouse click, a set of actions are executed. A plugin can provide custom
-actions. This examnple adds a actionJs actionJs that can be bound to an event.
-
-    module DSLEventActions
-      def actionJs(text, **attributes, &block)
-        self << Foo::Action.new(text: text, parent: self, **attributes, &block)
-      end
-    end
-    
-Example actionJs class:
-
-    require 'coprl/presenters/dsl/components/actions/base'
-    
-    module Coprl
-      module Presenters
-        module Plugins
-          module Foo
-              class Action < DSL::Components::Actions::Base
-                def initialize(**attribs_, &block)
-                  super(type: :actionJs, **attribs_, &block)
-                end
-            end
-          end
-        end
-      end
-    end
-
-    
-## Adding a WebClient implementation
-
-A plugin that extends the DSL will give you a new custom POM (Presenter Object Model), but that alone won't get you very far.
-The POM describes the user interface, a client must implement each of the components.
-For the WebClient this means adding a template with HTML, CSS and Javascript. 
-
-### Component Templates
-
-To render your component you need to add the following to your plugin:
-  
-    module WebClientComponents
-      def render_foo(comp,
-                     render:,
-                     components:,
-                     index:)
-        view_dir = File.join(__dir__, 'foo')
-        render.call :erb, :foo, views: view_dir,
-                    locals: {comp: comp,
-                             components: components, index: index}
-      end
-    end
-    
-From you ERB you can call any of the other built in WebClient erb's. You can even replace built in component templates.
-The render object supports all the template types supported by Tilt/Sinatra (http://sinatrarb.com/intro.html)
-
-Example template:
-
-    <iframe id="random_fact" src="<%= comp.random_fact %>" height=512 <%= erb :"components/event", :locals => {comp: comp, events: comp.events, parent_id: comp.id} %>></iframe>
-
-
-### Event Action Data
-
-An actionJs from the Presenter Object Model (POM) is sent to a ruby method during template expansion. 
-You are able to then setup any data that you want passed to your actionJs javascript method.
-It expects you will return an array with a type that matches your event actionJs presenter type. The rest is up to you.
-
-
-    module WebClientActions
-      def action_data_bar(actionJs, _parent_id, *)
-        # Type, URL, Options, Params (passed into javascript event/actionJs classes)
-        [actionJs.type, actionJs.url, actionJs.options.to_h, actionJs.attributes.to_h]
-      end
-    end
-    
-Example Javascript method (typically rendered by a template triggered by the render_foo method above):
-
-    <script>
-      function actionJs(_options, params, _event) {
-        // Reload iFrame: https://stackoverflow.com/questions/86428/what-s-the-best-way-to-reload-refresh-an-iframe
-        document.getElementById('random_fact').src += '';
-        return {actionJs: 'actionJs', content: {data: params.text}, statusCode: 200};
-      }
-    </script>
-
-Event actionJs WebClient methods must return a Javascript Object with the properties `actionJs`, `content` and `statusCode`.
-
-
-## WebClient Javascript Interface
-
-When developing a plugin for the WebClient you may want to have your data submitted as part of another component container.
-The most familiar example is a Form.  This requires that you bind your component to the DOM with a few methods.
-Not all plugins need to do this.
-It is only needed in the case of those components that add their data to an http post.
-
-The following components are Containers that will collect data from nested DOM elements using this lifecycle protocol.
-cards.js
-content.js
-dialogs.js
-file-inputs.js
-forms.js
-grid.js
-steppers.js
-
-Lifecycle Protocol:
-
-We call it it a protocol, because it defines a small number of DOM relationships to participate as an integrated component.
-Many frameworks require a common base class, this approach is very light by design.
-
-Container data in the WebClient is collected and submitted using the following sequence:
-
-In your element markup include the `v-input` class on an DOM element.
-
-You can see the container calling code here:
-https://github.com/rx/presenters/blob/master/views/mdc/assets/js/components/base-container.js
-
-If you add the v-plugin class to the DOM element along with a data-plugin-callback dataset that contains a string
-with the class name to proxy the plugin events to.
-
-
-Sample callback class:
-
-    // 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) {
-      }
-  
-      // 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() {
-      }
-  
-      // called to add an event listener to the component
-      // this only needs to be defined if you need the event handler to be bound to the component
-      // in a different manner.  Here is the default implementation you get if you don't define this method:
-      initEventListener(eventName, eventHandler) {
-        if (typeof this.eventsHandler === 'undefined') {
-          this.eventsHandler = {};
-        }
-        if (!this.eventsHandler[eventName]) {
-          // Delegate to the component if possible
-          this.eventsHandler[eventName] = eventHandler;
-          this.element.addEventListener(eventName, eventHandler);
-        }
-      }
-    }

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

@@ -1,24 +0,0 @@
-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

@@ -1,10 +0,0 @@
-<% 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

@@ -1,41 +0,0 @@
-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/views/mdc/body/_postamble.erb

@@ -1,17 +0,0 @@
-<%
-  drawer = pom.drawer
-  footer = pom.footer
-%>
-</div>
-</div>
-<% if drawer %>
-  </div>
-  </div>
-  </div>
-<% end %>
-
-<%= partial "body/snackbar" %>
-<% if footer %>
-  <%= partial "body/footer", :locals => {:footer => footer} %>
-<% end %>
-</div>