coprl 3.0.0.beta.2 → 3.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e11f41de6e5ebd00304df4a4cfe917123cf26cce95f02f8d9ead207f55204101
-  data.tar.gz: 0c65b1a3211123c2a2ed171fc811816e1646f5d9c5997b375d1bde5d2e979db2
+  metadata.gz: 7d7518e53fa8334d12c57f9221559528d01368548e0806077042e232c47cf6d4
+  data.tar.gz: c7cbe113161ae098b0a789827edc1233d1a59299d6bdbc618a077c66b8cb85a0
 SHA512:
-  metadata.gz: efb2027ca9f8ec7863dbb946cf6cfab079b747300e3afb3af9d6c176e50a195950dcf3677db68834d7a601ffd9efda6a859abcc5d3471df615b295829c0ea11b
-  data.tar.gz: 9abeedcb34dcb334c6438f14ffe0cb2e78cd1d47ad39eea111b0ae368cd52dc36eba87697237cbf4bb603746e530e7036b699bd45d6d78998509d709ab4c613f
+  metadata.gz: f1b6b99fc482af03d45152745a7969cc190cf9948f116d8026a7623d8c4a11cd4fcfef7a66894b262e8110aa960f15bdec72c91913a4dc3ba0473ee4b640147e
+  data.tar.gz: a3d7dd1e766e3fc1e8f619f8abc658cf8dd0a887eee46068f9e147540768e6927e50cdb129346d79bc14402f960064d3df00608e15af8e3633e90d3347bb9ec4

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [3.0.0-beta.3](https://github.com/rx/presenters/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-06-07)
+
+
+### Bug Fixes
+
+* added cli --version ([4c5b10e](https://github.com/rx/presenters/commit/4c5b10e0707bcdeecfb29908eb3284b692cbcd41))
+* added missing prepare context callbacks to Rails Engine ([bafa36d](https://github.com/rx/presenters/commit/bafa36d6e95ad9863eb93cb44cc894163c147c4f))
+* added prepare context for Rails native views engine that sets the request and session automatically ([a09f3c6](https://github.com/rx/presenters/commit/a09f3c637102e640fe0b91894ae89b5a07288846))
+* Added version.rb to plugin generator ([f1f2092](https://github.com/rx/presenters/commit/f1f20925dfd326fb5a47910952e21b34b762c31d))
+* Added version.rb to plugin generator ([35187bf](https://github.com/rx/presenters/commit/35187bf188957e2ca93e2bf07963e958452f27fe))
+* expanded plugin generator to include github semantic release, demo pom and sample README ([06de7a2](https://github.com/rx/presenters/commit/06de7a237f8a417a11776d1994915c32253a981d))
+* fixed unordered list partial rendering error ([014f1d1](https://github.com/rx/presenters/commit/014f1d19926d7e9d39618fbe68c8068db316ac4b))
+* generator not compatible with COPRL 3 Rails templating naming conventions ([f6d80f0](https://github.com/rx/presenters/commit/f6d80f0a44f6305b9339bc2bd6db8487eefc68cc))
+* removed google_map built in plugin to its own plugin ([a34290d](https://github.com/rx/presenters/commit/a34290de890e2fdf7e6c2c7b1714854d454c82a4))
+
+
+### Features
+
+* Added singular alias for common actions: load, replace, post, create, and delete ([b57c305](https://github.com/rx/presenters/commit/b57c305bd4dbf95b8a9662ad747020683bf74c8d))
+
 # [3.0.0-beta.2](https://github.com/rx/presenters/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-06-03)
 
 

data/Gemfile

@@ -24,7 +24,12 @@ end
 gem 'foo_presenter_plugin',  github: 'coprl/foo_presenter_plugin', require: false
 gem 'image_crop_presenter_plugin',  github: 'coprl/image_crop_presenter_plugin', require: false
 gem 'chart_presenter_plugin',  github: 'coprl/chart_presenter_plugin', require: false
+gem 'google_maps_presenter_plugin',  github: 'coprl/google_maps_presenter_plugin', branch: :main, require: false
+gem 'cacheable_presenter_plugin', github: 'coprl/cacheable_presenter_plugin', require: false
+gem 'script_presenter_plugin', github: 'coprl/script_presenter_plugin', require: false
+gem 'scroll_to_presenter_plugin', github: 'coprl/scroll_to_presenter_plugin', require: false
 
 gem 'rack-cors'
 gem 'honeybadger' if ENV.fetch('HONEYBADGER_API_KEY'){false}
 gem 'puma'
+gem 'dotenv'

data/Gemfile.lock

@@ -1,3 +1,9 @@
+GIT
+  remote: https://github.com/coprl/cacheable_presenter_plugin.git
+  revision: 262ac076d70d94b111b9ccb692dfc9225c7cc6c6
+  specs:
+    cacheable_presenter_plugin (0.0.3)
+
 GIT
   remote: https://github.com/coprl/chart_presenter_plugin.git
   revision: ae9a8bb805570dbf2c1156e3c81f07e3a24807e2
@@ -10,12 +16,31 @@ GIT
   specs:
     foo_presenter_plugin (0.0.2)
 
+GIT
+  remote: https://github.com/coprl/google_maps_presenter_plugin.git
+  revision: 237d956ce36b6c9945080088e4d9e5a2f042ee5b
+  branch: main
+  specs:
+    google_maps_presenter_plugin (0.1.0)
+
 GIT
   remote: https://github.com/coprl/image_crop_presenter_plugin.git
   revision: 33452c5d3b232e93a942280f8429be2707c992ab
   specs:
     image_crop_presenter_plugin (0.1.0)
 
+GIT
+  remote: https://github.com/coprl/script_presenter_plugin.git
+  revision: c7cea03e73f4752a3df99e4b3ab0d4030f141f4d
+  specs:
+    script_presenter_plugin (0.0.2)
+
+GIT
+  remote: https://github.com/coprl/scroll_to_presenter_plugin.git
+  revision: e1dd957723561117ee45743ac9e27a4fd91a4a97
+  specs:
+    scroll_to_presenter_plugin (0.0.2)
+
 PATH
   remote: .
   specs:
@@ -40,6 +65,7 @@ GEM
     concurrent-ruby (1.1.8)
     diff-lcs (1.3)
     docile (1.3.1)
+    dotenv (2.7.6)
     dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5.0)
@@ -143,10 +169,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.13)
+  cacheable_presenter_plugin!
   chart_presenter_plugin!
   coprl!
+  dotenv
   foo_presenter_plugin!
   gem-release (~> 2.0)
+  google_maps_presenter_plugin!
   image_crop_presenter_plugin!
   pry
   pry-byebug
@@ -158,6 +187,8 @@ DEPENDENCIES
   rspec
   rspec-html-matchers
   rspec_junit_formatter
+  script_presenter_plugin!
+  scroll_to_presenter_plugin!
   shotgun (~> 0.9)
   simplecov
   thor (~> 1.1.0)

data/app/demo/components/nav/menu.pom

@@ -25,7 +25,6 @@ Coprl::Presenters.define('component_menu') do
       layouts
       lists
       number_fields
-      maps
       menus
       multi_selects
       progress

data/app/demo/plugins/cacheable.pom

@@ -0,0 +1,64 @@
+require 'ostruct'
+
+Coprl::Presenters.define(:cacheable, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :cacheable
+
+  page_title 'Cacheable'
+
+  helpers do
+    def cache_object
+      OpenStruct.new(cache_key: 'wild')
+    end
+
+    def cache_objects
+      [
+        OpenStruct.new(cache_key: 'abc'),
+        OpenStruct.new(cache_key: '123'),
+      ]
+    end
+  end
+
+  indented_grid do
+    body <<~DOC
+      The caching plugin provides russian doll caching support.
+      Declare the plugin in your pom, `plugin :cacheable`, or configure it globally:
+
+      ```
+      Coprl::Presenters::Settings.configure do |config|
+        config.presenters.plugins.push(:cacheable)
+      end
+      ```
+
+      For Rails it automatically uses the Rails::Cache. For other Rack apps you need to configure it with a block:
+
+      ```
+      Coprl::Presenters::Plugins::Cacheable::Settings.configure do |config|
+        # A cache needs to respond to fetch(key, &block) and exist?(key) or has_key?(key)
+        config.cache=cache_store
+      end
+      ```
+      Simply wrap your POM with the cache directive. 
+      Complex keys are supported.  If an object responds to `cache_key` then that will be used for it.  
+      An object that responds to `map` will be expanded.  As a last resort `to_s` is used.
+               
+      Examples (refresh your browser to observe cached values):
+    DOC
+    title "Not cached at #{DateTime.now}"
+    cache :remember_me do
+      title "Simple Cache Key - cached at #{DateTime.now}"
+    end
+
+    cache [:title, cache_object, cache_objects] do
+      title "Complex Cache Key - cached at #{DateTime.now}"
+    end
+    blank
+    body <<~DOC
+      Note: Confusion alert ... if you are using shotgun for the demo, it **will not cache**, since the demo uses an in memory cache and shotgun reloads its entire process with each refresh.
+    DOC
+
+  end
+  attach :code, file: __FILE__
+end

data/app/demo/plugins/google_maps.pom

@@ -0,0 +1,24 @@
+Coprl::Presenters.define(:google_maps, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :google_maps
+  page_title 'Maps'
+
+  indented_grid do
+    unless ENV['GOOGLE_API_KEY']
+      headline 'You must define the ENV variable GOOGLE_API_KEY for this to render a map'
+      subtitle 'Dev hint: Create an .env file with a `GOOGLE_API_KEY=yourkey` and restart. Goto [Google Using API Keys](https://developers.google.com/maps/documentation/javascript/get-api-key) to create a key.'
+    end
+    subheading 'Static Maps'
+    address = '125 Park Street, Traverse City, MI'
+    google_map address: address, height: "300px", width: "400px"  do
+      event :click do
+        loads "https://www.google.com/maps/place/#{address}"
+      end
+    end
+
+    attach :code, file: __FILE__
+  end
+
+end

data/app/demo/plugins/image_crop.pom

@@ -20,7 +20,7 @@ Coprl::Presenters.define(:image_crop, namespace: :plugins) do
           grid do
             column 12 do
               card do
-                text 'Drop it here'
+                text 'Drop an image or click'
                 button icon: :cloud_upload
               end
             end

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

@@ -7,7 +7,7 @@ Coprl::Presenters.define(:plugin_drawer, namespace: :plugins) do
           loads :index
         end
       end
-      %i(image_crop chart).sort.each do |comp|
+      %i(image_crop chart google_maps cacheable script scroll_to).sort.each do |comp|
         item titleize(comp) do
           event :click do
             loads comp

data/app/demo/plugins/script.pom

@@ -0,0 +1,17 @@
+Coprl::Presenters.define(:script, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :script
+  page_title 'Script'
+
+  script inline: <<~JAVASCRIPT
+      alert( 'Hello, world!' );
+  JAVASCRIPT
+  indented_grid do
+    subheading 'You can write arbitrary javascript using the script component. For example, the alert you just dismissed.'
+
+    attach :code, file: __FILE__
+  end
+
+end

data/app/demo/plugins/scroll_to.pom

@@ -0,0 +1,22 @@
+Coprl::Presenters.define(:scroll_to, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :scroll_to
+  page_title 'Scroll to'
+
+  indented_grid do
+    subheading 'Sometimes you need to scroll to find content after some action. This is what the scroll to plugin is for.'
+    button :scroll do
+      event :click do
+        scroll_to :scroll_target #, smooth: true, offset: 100
+      end
+    end
+    (1..100).each do
+      body '.'
+    end
+    title 'Thanks for scrolling here', id: :scroll_target
+
+    attach :code, file: __FILE__
+  end
+end

data/app/demo/shared/context_list.pom

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

data/config.ru

@@ -9,7 +9,7 @@ if ENV['VOOM_ENV'] == 'integration_testing'
 end
 
 ENV['VOOM_ROOT'] = File.expand_path(__dir__)
-ENV['GOOGLE_API_KEY'] = 'AIzaSyDhSgj9XSBLY5E9Rx5pP2ILQ7IXnD4uX2Q'
+require 'dotenv/load'
 require 'coprl'
 
 require 'rack/cors'
@@ -27,6 +27,20 @@ Coprl::Presenters::Settings.configure do |config|
   }
 end
 
+require 'pry'
+require 'coprl/presenters/plugins/cacheable'
+cache_store = Concurrent::Hash.new
+# Quick and dirty demo always growing memory cache -- DONT DO THIS IN PRODUCTION!
+def cache_store.fetch(key, options=nil, &block)
+  result = super(key, &block)
+  store(key, result) unless has_key?(key)
+  result
+end
+
+Coprl::Presenters::Plugins::Cacheable::Settings.configure do |config|
+  config.cache=cache_store
+end
+
 use Coprl::Presenters::Demo::Search
 use Coprl::Presenters::Demo::Echo
 use Coprl::Presenters::Demo::Slow

data/lib/coprl/presenters/cli.rb

@@ -1,5 +1,6 @@
 require 'thor'
 require_relative 'generators/plugin'
+require_relative 'version'
 
 module Coprl
   module Presenters
@@ -20,6 +21,15 @@ module Coprl
         end
       end
       class Cli < Thor
+        def self.exit_on_failure?
+          true
+        end
+        map %w[--version -v] => :__print_version
+
+        desc "--version, -v", "print the version"
+        def __print_version
+          puts Coprl::Presenters::Version::VERSION
+        end
         desc "generate", "generate a plugin"
         subcommand "generate", Generate
       end

data/lib/coprl/presenters/dsl/components/event.rb

@@ -27,6 +27,7 @@ module Coprl
                                        wait_for_download: wait_for_download,
                                        params: params, &block)
           end
+          alias load loads
 
           def replaces(target, presenter, input_tag: nil, ignore_input_values: [], **params, &block)
             self << Actions::Replaces.new(parent: self,
@@ -36,6 +37,7 @@ module Coprl
                                           ignore_input_values: Array(ignore_input_values),
                                           params: params, &block)
           end
+          alias replace replaces
 
           # Method can be one of :post, :put, :delete or :patch
           def posts(path, input_tag: nil, headers: nil, **params, &block)
@@ -45,8 +47,10 @@ module Coprl
                                        headers: headers,
                                        params: params, &block)
           end
-
+          alias post posts
           alias creates posts
+          alias create posts
+
 
           def updates(path, input_tag: nil, headers: nil, **params, &block)
             self << Actions::Updates.new(parent: self,
@@ -63,6 +67,7 @@ module Coprl
                                          headers: headers,
                                          params: params, &block)
           end
+          alias delete deletes
 
           def dialog(dialog_id, **params, &block)
             self << Actions::Dialog.new(parent: self,

data/lib/coprl/presenters/generators/plugin.rb

@@ -32,13 +32,13 @@ module Coprl
 
           def template_file(template, target_filename=template, source_path=nil, target_path=source_path)
             source = join_path(TEMPLATES_ROOT, source_path, "#{template}.tt")
-            destination = join_path(plusin_name, target_path, target_filename)
+            destination = join_path(plugin_name, target_path, target_filename)
             template source, destination
           end
 
           def file(file, target_filename=file, source_path=nil, target_path=nil)
             source = join_path(TEMPLATES_ROOT, source_path, file)
-            destination = join_path(plusin_name, target_path, target_filename)
+            destination = join_path(plugin_name, target_path, target_filename)
 
             copy_file source, destination
           end
@@ -59,17 +59,27 @@ module Coprl
             underscore(name)
           end
 
-          def plusin_name
+          def plugin_name
             "#{underscored_name}_presenter_plugin"
           end
         end
 
+        def create_version
+          template_file('version.rb', "version.rb", LIB_ROOT, "lib/#{underscored_name}_presenter_plugin")
+        end
+
         def create_root_files
           file('.gitignore')
           template_file('Gemfile')
           template_file('LICENSE.txt')
           template_file('presenter_plugin.gemspec', "#{underscored_name}_presenter_plugin.gemspec")
-          file 'README.md'
+          template_file 'README.md'
+        end
+
+        def create_semantic_release_github_action
+          file('.releaserc')
+          file('.ruby-version')
+          file('semantic-release.yml', 'semantic-release.yml', dir('.github', 'workflows'))
         end
 
         def create_plugin
@@ -90,9 +100,9 @@ module Coprl
                         dir('views', 'assets', 'css', 'components'))
           template_file('component.js', "#{underscored_name}.js",
                         dir('views', 'assets', 'js', 'components'))
-          template_file('component.erb', "#{underscored_name}.erb",
+          template_file('component.erb', "_#{underscored_name}.erb",
                         dir('views', 'components', 'application'))
-          template_file('component_header.erb', "#{underscored_name}_header.erb",
+          template_file('component_header.erb', "_#{underscored_name}_header.erb",
                         dir('views', 'components', 'application'))
         end
 
@@ -115,6 +125,10 @@ module Coprl
                         lib_dir('helpers'),
                         named_dir('helpers'))
         end
+
+        def create_demo_pom
+          template_file('plugin.pom', "#{underscored_name}.pom", dir('demo'))
+        end
       end
     end
   end

data/lib/coprl/presenters/generators/templates/plugin/.github/workflows/semantic-release.yml

@@ -0,0 +1,41 @@
+name: CI
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Semantic Release
+        uses: cycjimmy/semantic-release-action@v2
+        with:
+          extra_plugins: |
+            @semantic-release/git
+            @semantic-release/changelog
+            @semantic-release/github
+            semantic-release-rubygem
+          dry_run: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+

data/lib/coprl/presenters/generators/templates/plugin/.releaserc

@@ -0,0 +1,15 @@
+{
+  "branches": ['+([0-9])?(.{+([0-9]),x}).x', 'master', 'next', 'next-major', {name: 'beta', prerelease: true}, {name: 'alpha', prerelease: true}],
+  "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+       "@semantic-release/github",
+       ["semantic-release-rubygem",
+           {
+               "gemPublish": false
+           }
+       ],
+       "@semantic-release/git"
+    ]
+}

data/lib/coprl/presenters/generators/templates/plugin/.ruby-version

@@ -0,0 +1 @@
+2.7.2

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

@@ -0,0 +1,34 @@
+# <%= humanize(name) %> Presenter Plugin
+
+A [COPRL](http://github.com/coprl/coprl) presenter plugin that <%= name %>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '<%= name %>_presenter_plugin', git: 'https://github.com/coprl/<%= name %>_presenter_plugin', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage in POMs
+
+Declare the plugin in your pom, `plugin :<%= name %>`.
+
+TODO: Add an example POM and describe your plugin here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coprl/<%= name %>_presenter_plugin.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the COPRL project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coprl/coprl/blob/master/CODE-OF-CONDUCT.md).

data/lib/coprl/presenters/generators/templates/plugin/demo/plugin.pom.tt

@@ -0,0 +1,15 @@
+Coprl::Presenters.define(:<%= name %>, namespace: :plugins) do
+  helpers Demo::Helpers::IndentedGrid
+  attach :top_nav
+  attach :plugin_drawer
+  plugin :<%= name %>
+  page_title '<%= humanize(name) %>'
+
+  <%= name %> # TODO Add your demo code here
+
+  indented_grid do
+    subheading 'TODO describe how to use your plugin'
+
+    attach :code, file: __FILE__
+  end
+end

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

@@ -1,4 +1,4 @@
-require_relative '<%= classify(name) %>_action'
+require_relative '<%= underscore(name) %>_action'
 
 module Coprl
   module Presenters

data/lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/version.rb.tt

@@ -0,0 +1,3 @@
+module <%= classify(name) %>PresenterPlugin
+  VERSION = "0.0.1"
+end

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

@@ -1,21 +1,22 @@
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require '<%= name %>_presenter_plugin/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "<%= name %>_presenter_plugin"
-  spec.version       = '0.0.1'
+  spec.name          = '<%= name %>_presenter_plugin'
+  spec.version       = <%= classify(name) %>PresenterPlugin::VERSION
   spec.authors       = ["<%= `git config user.name`.strip %>"]
   spec.email         = ["<%= `git config user.email`.strip %>"]
 
-  spec.summary       = %q{<%= name %> presenter plugin.}
+  spec.summary       = %q{A COPRL presenter plugin for <%= name %>}
   spec.homepage      = 'http://github.com/<%= `git config user.name`.strip %>/<%= name %>_presenters_plugin'
-  spec.license       = "MIT"
+  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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', "~> 2.0"
+  spec.add_development_dependency 'rake', "~> 10.0"
 end

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

@@ -11,4 +11,4 @@ Any additional data you want to pass to your component javascript should be setu
 -->
 <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>
+        <%%= partial "components/event", :locals => {comp: comp, events: comp.events, parent_id: comp.id} %>></iframe>

data/lib/coprl/presenters/settings.rb

@@ -32,7 +32,7 @@ unless defined?(Coprl::Presenters::Settings)
             setting :custom_css, '../public/presenters'
             setting :protect_from_forgery, false
           end
-          setting :plugins, [:google_maps]
+          setting :plugins, []
           setting :components do
             setting :defaults do
               setting :datetime do

data/lib/coprl/presenters/version.rb

@@ -1,7 +1,7 @@
 module Coprl
   module Presenters
     module Version
-      VERSION = '3.0.0.beta.2'
+      VERSION = '3.0.0.beta.3'
     end
   end
 end

data/rails-engine/app/controllers/coprl_controller.rb

@@ -12,7 +12,7 @@ class CoprlController < ApplicationController
     fq_presenter_name = [presenter_name, 'index'].compact.join(':')
     presenter_name = fq_presenter_name if Coprl::Presenters::App.registered?(fq_presenter_name)
     presenter = Coprl::Presenters::App[presenter_name].call
-    context = params.dup.to_unsafe_hash
+    context = prepare_context(params)
     router = Coprl::Presenters::WebClient::Router.new(base_url: request.base_url)
     @pom = presenter.expand(router: router, context: context)
   end
@@ -23,4 +23,21 @@ class CoprlController < ApplicationController
       prepend_view_path path
     end
   end
+
+  def prepare_context(base_params = params)
+    prepare_context = Coprl::Presenters::Settings.config.presenters.web_client.prepare_context.dup
+    prepare_context.push(method(:scrub_context))
+    context = base_params.dup.to_unsafe_hash
+    prepare_context.reduce(context) do |params, context_proc|
+      context = context_proc.call(params, session, request.env)
+    end
+    context
+  end
+
+  def scrub_context(params, _session, _env)
+    %i(grid_nesting input_tag).each do |key|
+      params.delete(key) {params.delete(key.to_s)}
+    end
+    params
+  end
 end

data/rails-engine/config/initializers/session.rb

@@ -0,0 +1,8 @@
+Rails.application.config.to_prepare do
+  Coprl::Presenters::Settings.configure do |config|
+    config.presenters.web_client.prepare_context.prepend ->(context, session, _env) {
+      context.merge(request: Rack::Request.new(_env),
+                    session: session)
+    }
+  end
+end

data/views/mdc/components/unordered_list/_list_item.erb

@@ -1,7 +1,7 @@
 <li class="<%= 'icon-li' if list_item.icon %>">
-  <%= erb :"components/unordered_list/icon", :locals => {:list_item => list_item} %>
+  <%= partial "components/unordered_list/icon", :locals => {:list_item => list_item} %>
   <%= expand_text(list_item.text&.text) %>
   <% if list_item.unordered_list %>
-    <%= erb :"components/unordered_list", :locals => {:comp => list_item.unordered_list} %>
+    <%= partial "components/unordered_list", :locals => {:comp => list_item.unordered_list} %>
   <% end %>
-</li>
+</li>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coprl
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.2
+  version: 3.0.0.beta.3
 platform: ruby
 authors:
 - Russell Edens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ice_nine
@@ -340,7 +340,6 @@ files:
 - app/demo/components/fabs.pom
 - app/demo/components/file_inputs.pom
 - app/demo/components/footers.pom
-- app/demo/components/google_maps.pom
 - app/demo/components/headers.pom
 - app/demo/components/hidden_fields.pom
 - app/demo/components/icons.pom
@@ -405,10 +404,14 @@ files:
 - app/demo/patterns/drag_drop.pom
 - app/demo/patterns/floating_card.pom
 - app/demo/patterns/search_select.pom
+- app/demo/plugins/cacheable.pom
 - app/demo/plugins/chart.pom
+- app/demo/plugins/google_maps.pom
 - app/demo/plugins/image_crop.pom
 - app/demo/plugins/index.pom
 - app/demo/plugins/nav/drawer.pom
+- app/demo/plugins/script.pom
+- app/demo/plugins/scroll_to.pom
 - app/demo/shared/code.pom
 - app/demo/shared/context_list.pom
 - app/demo/shared/debug.pom
@@ -558,16 +561,21 @@ files:
 - lib/coprl/presenters/errors/unprocessable.rb
 - lib/coprl/presenters/generators/inflectors.rb
 - lib/coprl/presenters/generators/plugin.rb
+- lib/coprl/presenters/generators/templates/plugin/.github/workflows/semantic-release.yml
 - lib/coprl/presenters/generators/templates/plugin/.gitignore
+- lib/coprl/presenters/generators/templates/plugin/.releaserc
+- lib/coprl/presenters/generators/templates/plugin/.ruby-version
 - lib/coprl/presenters/generators/templates/plugin/Gemfile.tt
 - lib/coprl/presenters/generators/templates/plugin/LICENSE.txt.tt
-- lib/coprl/presenters/generators/templates/plugin/README.md
+- lib/coprl/presenters/generators/templates/plugin/README.md.tt
+- lib/coprl/presenters/generators/templates/plugin/demo/plugin.pom.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/components/actions/action.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/components/actions/dsl.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/components/component.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/components/dsl.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/helpers/helper.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/plugin.rb.tt
+- lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/version.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/web_client/components/actions/data.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/web_client/components/render.rb.tt
 - lib/coprl/presenters/generators/templates/plugin/presenter_plugin.gemspec.tt
@@ -589,9 +597,6 @@ files:
 - lib/coprl/presenters/namespace.rb
 - lib/coprl/presenters/pluggable.rb
 - lib/coprl/presenters/plugins.rb
-- lib/coprl/presenters/plugins/google_maps.rb
-- lib/coprl/presenters/plugins/google_maps/google_map.erb
-- lib/coprl/presenters/plugins/google_maps/google_map.rb
 - lib/coprl/presenters/rails/engine.rb
 - lib/coprl/presenters/rails/railtie.rb
 - lib/coprl/presenters/registry.rb
@@ -672,6 +677,7 @@ files:
 - rails-engine/app/views/layouts/coprl.html.erb
 - rails-engine/config.ru
 - rails-engine/config/initializers/presenters.rb
+- rails-engine/config/initializers/session.rb
 - rails-engine/config/routes.rb
 - scripts/build.sh
 - views/mdc/.babelrc

data/app/demo/components/google_maps.pom

@@ -1,22 +0,0 @@
-require_relative '../helpers/indented_grid'
-
-Coprl::Presenters.define(:maps) do
-  helpers Demo::Helpers::IndentedGrid
-  attach :top_nav
-  attach :component_drawer
-  page_title 'Maps'
-
-  indented_grid do
-    subheading 'Static Maps'
-
-    address = '125 Park Street, Traverse City, MI'
-    google_map address: address, height: 300, width: 400  do
-      event :click do
-        loads "https://www.google.com/maps/place/#{address}"
-      end
-    end
-
-    attach :code, file: __FILE__
-  end
-
-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