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

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/coprl.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'tzinfo', '>=1.1', '< 3.0'
   spec.add_runtime_dependency 'tzinfo-data', '~>1.2018'
   spec.add_runtime_dependency 'redcarpet', '~>3.4'
-  spec.add_runtime_dependency 'filewatcher', '~> 1.1.1'
   spec.add_runtime_dependency 'zeitwerk', '~> 2.1'
 
   spec.add_development_dependency 'thor', '~> 1.1.0'
@@ -38,6 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1.13'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'gem-release', '~> 2.0'
   spec.add_development_dependency 'shotgun', '~> 0.9'
+  spec.add_development_dependency 'timecop', '~> 0.9.4  '
 end

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/actions/base.rb

@@ -25,10 +25,14 @@ module Coprl
             private
 
             def extract_options!
-              %i(path presenter target input_tag headers).each do |option|
+              %i(path presenter target headers).each do |option|
                 option_value = attribs.delete(option){:not_found}
                 @options.merge!({option => option_value}) unless option_value==:not_found
               end
+              # Special case ... the input tag is defined at the component base level for all components
+              # By the time we get here we have put it into its accessor via the super call
+              # So we manually move it to the options for all actions
+              @options.merge!(input_tag: self.input_tag) if self.input_tag
             end
 
             def extract_dynamic_params(hash)

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

@@ -15,16 +15,19 @@ module Coprl
           include Mixins::YieldTo
           extend Pluggable
 
-          attr_reader :type, :id, :tag, :attributes, :draggable, :drop_zone, :css_class
+          attr_reader :type, :id, :input_tag, :attributes, :draggable, :drop_zone, :css_class
 
           alias attribs attributes
 
-          def initialize(type:, parent:, id: nil, tag: nil, **attributes, &block)
+          def initialize(type:, parent:, id: nil, tag: nil, input_tag: nil,  **attributes, &block)
             @draggable = attributes.delete(:draggable) {nil}
             @drop_zone = attributes.delete(:drop_zone) {nil}
             @css_class = Array(attributes.delete(:class) {nil})
             @id = id || generate_id
-            @tag = tag
+            @input_tag = input_tag || tag
+            logger.warn(
+                'The `tag` attribute is deprecated. ' \
+                'Please use `input_tag` instead. This will change in a future feature release.') unless tag.nil?
             @type = type
             @parent = parent
             @attributes = attributes
@@ -72,7 +75,6 @@ module Coprl
 
           alias params context
 
-
           def yield_block
             return @_yield_block_ if @_yield_block_
             @parent.send(:yield_block)

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/dsl/components/multi_select.rb

@@ -16,8 +16,8 @@ module Coprl
           def check_option(**attribs, &block)
             @options << CheckOption.new(parent: self,
                                     name: @name,
-                                    tag: @tag,
-                                    **attribs.delete_if{ |k,v| [:tag, :name].include?(k) }, &block)
+                                    input_tag: @input_tag,
+                                    **attribs.delete_if{ |k,v| [:tag, :name, :input_tag].include?(k) }, &block)
           end
 
           class CheckOption < EventBase
@@ -33,7 +33,7 @@ module Coprl
               self.checkbox(name: "#{attribs[:name]}[]",
                             value: @value,
                             text: @text,
-                            tag: tag,
+                            input_tag: self.input_tag,
                             checked: @selected,
                             disabled: @disabled,
                             &block)

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

@@ -58,10 +58,10 @@ module Coprl
             def checkbox(**attributes, &block)
               return @checkbox if locked?
               field_name = @type == :header ? 'all' : "#{attributes.delete(:name)}[]"
-              tag = @type == :header ? '' : @parent.tag
+              tag = @type == :header ? '' : @parent.input_tag
               @checkbox = Components::Checkbox.new(parent: self,
                                                    name: field_name,
-                                                   tag: tag,
+                                                   input_tag: tag,
                                                    **attributes,
                                                    &block)
             end

data/lib/coprl/presenters/dsl/definition.rb

@@ -17,8 +17,8 @@ module Coprl
           self
         end
 
-        def expand(router: , context:{}, &block)
-          presenter = UserInterface.new(router: router, context: context,  name: @name, namespace: @namespace, &@block)
+        def expand(router: , context:{}, plugins: [], &block)
+          presenter = UserInterface.new(router: router, context: context, plugins: plugins, name: @name, namespace: @namespace, &@block)
           yield(presenter) if block
           presenter.expand_instance
         end

data/lib/coprl/presenters/dsl/user_interface.rb

@@ -25,7 +25,7 @@ module Coprl
         private :context, :router, :namespace
         alias params context
 
-        def initialize(context:, parent: nil, router: nil, name: nil, namespace: [], &block)
+        def initialize(context:, parent: nil, router: nil, name: nil, plugins: [], namespace: [], &block)
           @parent = parent
           @router = router || @parent&.send(:router)
           @context = context || {}
@@ -36,7 +36,7 @@ module Coprl
           @footer = nil
           @name = name
           @namespace = namespace
-          @plugins = []
+          @plugins = plugins || []
           @csrf_meta_tags = authenticity_token_meta_tags(@context.fetch(:session, nil))
           add_global_helpers
           initialize_plugins

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,28 @@ 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'), dir('.github', 'workflows'))
         end
 
         def create_plugin
@@ -90,9 +101,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 +126,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", ">= 12.3.3"
 end