coprl 0.1.0 → 3.0.0.beta.5

data/lib/coprl/presenters/errors.rb

@@ -0,0 +1 @@
+Dir[File.join(__dir__, 'errors', '*.rb')].each { |file| require file }

data/lib/coprl/presenters/errors/invalid_dsl.rb

@@ -0,0 +1,8 @@
+module Coprl
+  module Presenters
+    module Errors
+      class InvalidDsl < StandardError
+      end
+    end
+  end
+end

data/lib/coprl/presenters/errors/parameter_validation.rb

@@ -0,0 +1,8 @@
+module Coprl
+  module Presenters
+    module Errors
+      class ParameterValidation < Unprocessable
+      end
+    end
+  end
+end

data/lib/coprl/presenters/errors/unprocessable.rb

@@ -0,0 +1,8 @@
+module Coprl
+  module Presenters
+    module Errors
+      class Unprocessable < StandardError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Coprl
+  module Presenters
+    module Generators
+      module Inflectors
+        def classify(input)
+          # "books" => "Book"
+          @inflector.classify(input)
+        end
+
+        def pluralize(input)
+          #book" => "books"
+          @inflector.pluralize(input)
+        end
+
+        def singularize(input)
+          #"books" => "book"
+          @inflector.singularize(input)
+        end
+
+        def camelize(input)
+          # "dry/inflector" => "Dry::Inflector"
+          @inflector.camelize(input)
+        end
+
+        def tableize(input)
+          # "Book" => "books"
+          @inflector.tableize(input)
+        end
+
+        def dasherize(input)
+          # "dry_inflector" => "dry-inflector"
+          @inflector.dasherize(input)
+        end
+
+        def underscore(input)
+          # "dry-inflector" => "dry_inflector"
+          @inflector.underscore(input)
+        end
+
+        def demodulize(input)
+          # "Dry::Inflector"  => "Inflector"
+          @inflector.demodulize(input)
+        end
+
+        def humanize(input)
+          # "dry_inflector"  => "Dry inflector", "author_id" => "Author"
+          @inflector.humanize(input)
+        end
+
+        def ordinalize(input)
+          # 1 => "1st
+          @inflector.ordinalize(input)
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,136 @@
+require "dry/inflector"
+require_relative 'inflectors'
+
+module Coprl
+  module Presenters
+    module Generators
+      class Plugin < ::Thor::Group
+        TEMPLATES_ROOT = File.join('templates','plugin')
+        LIB_ROOT = File.join('lib','coprl','presenters','plugins')
+        include Thor::Actions
+        argument :name
+
+        def self.exit_on_failure?
+          true
+        end
+
+        def initialize(args = [], local_options = {}, config = {})
+          @inflector = Dry::Inflector.new
+          super
+        end
+
+        def self.source_root
+          File.dirname(__FILE__)
+        end
+
+        no_tasks do
+          include Coprl::Presenters::Generators::Inflectors
+
+          def join_path(*parts)
+            File.join(*parts.compact)
+          end
+
+          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(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(plugin_name, target_path, target_filename)
+
+            copy_file source, destination
+          end
+
+          def lib_dir(*args)
+            dir(LIB_ROOT, *args)
+          end
+
+          def dir(*args)
+            join_path(*args)
+          end
+          
+          def named_dir(*args)
+            lib_dir(underscored_name, *args)
+          end
+          
+          def underscored_name
+            underscore(name)
+          end
+
+          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")
+          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
+          template_file('plugin.rb', "#{underscored_name}.rb", LIB_ROOT)
+        end
+
+        def create_component_files
+          template_file('component.rb', "#{underscored_name}_component.rb",
+                        lib_dir('components'),
+                        named_dir('components'))
+          template_file('dsl.rb', "#{underscored_name}_dsl.rb",
+                        lib_dir('components'),
+                        named_dir('components'))
+          template_file('render.rb', "#{underscored_name}_render.rb",
+                        lib_dir('web_client', 'components'),
+                        named_dir('web_client', 'components'))
+          template_file('component.css', "#{underscored_name}.css",
+                        dir('views', 'assets', 'css', 'components'))
+          template_file('component.js', "#{underscored_name}.js",
+                        dir('views', 'assets', 'js', 'components'))
+          template_file('component.erb', "_#{underscored_name}.erb",
+                        dir('views', 'components', 'application'))
+          template_file('component_header.erb', "_#{underscored_name}_header.erb",
+                        dir('views', 'components', 'application'))
+        end
+
+        def create_action_files
+          template_file('action.rb', "#{underscored_name}_action.rb",
+                        lib_dir('components', 'actions'),
+                        named_dir('components', 'actions'))
+          template_file('dsl.rb', "#{underscored_name}_dsl.rb",
+                        lib_dir('components', 'actions'),
+                        named_dir('components', 'actions'))
+          template_file('data.rb', "#{underscored_name}_data.rb",
+                        lib_dir('web_client', 'components', 'actions'),
+                        named_dir('web_client', 'components', 'actions'))
+          template_file('action.js', "#{underscored_name}.js",
+                        dir('views', 'assets', 'js', 'components', 'actions'))
+        end
+
+        def create_helper_files
+          template_file('helper.rb', "#{underscored_name}_helper.rb",
+                        lib_dir('helpers'),
+                        named_dir('helpers'))
+        end
+
+        def create_demo_pom
+          template_file('plugin.pom', "#{underscored_name}.pom", dir('demo'))
+        end
+      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/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea

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/Gemfile.tt

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in <%= name %>_presenter_plugin.gemspec
+gemspec

data/lib/coprl/presenters/generators/templates/plugin/LICENSE.txt.tt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) <%= Time.new.year %> <%=`git config user.name`.strip%> (<%= `git config user.email`.strip %>)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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/action.rb.tt

@@ -0,0 +1,16 @@
+require 'coprl/presenters/dsl/components/actions/base'
+
+
+module Coprl
+  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/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/components/actions/dsl.rb.tt

@@ -0,0 +1,22 @@
+require_relative '<%= underscore(name) %>_action'
+
+module Coprl
+  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/coprl/presenters/generators/templates/plugin/lib/coprl/presenters/plugins/components/component.rb.tt

@@ -0,0 +1,18 @@
+require 'coprl/presenters/dsl/components/event_base'
+
+module Coprl
+  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