coprl 0.1.0 → 3.0.0.beta.1

data/config.ru

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+if ENV['VOOM_ENV'] == 'integration_testing'
+  require 'simplecov'
+  if ENV['CIRCLE_ARTIFACTS']
+    dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
+    SimpleCov.coverage_dir(dir)
+  end
+  SimpleCov.start
+end
+
+ENV['VOOM_ROOT'] = File.expand_path(__dir__)
+ENV['GOOGLE_API_KEY'] = 'AIzaSyDhSgj9XSBLY5E9Rx5pP2ILQ7IXnD4uX2Q'
+require 'coprl'
+
+require 'rack/cors'
+use Rack::Cors do
+  allow do
+    origins '*'
+    resource '*', headers: :any, methods: [:get, :post, :options]
+  end
+end
+
+Coprl::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 Coprl::Presenters::Demo::Search
+use Coprl::Presenters::Demo::Echo
+use Coprl::Presenters::Demo::Slow
+use Coprl::Presenters::Demo::DragonDrop
+
+use Coprl::Presenters::WebClient::App
+run Coprl::Presenters::Api::App
+
+
+Coprl::Presenters::App.boot!
+
+

data/coprl.gemspec

@@ -1,35 +1,43 @@
-# frozen_string_literal: true
-
-require_relative "lib/coprl/version"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coprl/presenters/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "coprl"
-  spec.version       = Coprl::VERSION
-  spec.authors       = ["Russell Edens"]
-  spec.email         = ["russell@voomify.com"]
-
-  spec.summary       = "COmmon PResenter Language (COPRL)"
-  spec.description   = "COPRL is a Ruby DSL for rendering user interfaces."
-  spec.homepage      = "https://github.com/rx/coprl-ruby"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.name = 'coprl'
+  spec.version = Coprl::Presenters::Version::VERSION
+  spec.authors = ['Russell Edens']
+  spec.email = ["rx@russelledens.net\n"]
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/rx/coprl-ruby.git"
-  spec.metadata["changelog_uri"] = "https://github.com/rx/coprl-ruby/CHANGELOG.md"
+  spec.summary = 'COPRL Presenters Gem'
+  spec.homepage = 'http://github.com/rx/presenters'
+  spec.license = 'MIT'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_runtime_dependency 'ice_nine', '~>0.11'
+  spec.add_runtime_dependency 'dry-container', '~>0.6'
+  spec.add_runtime_dependency 'dry-configurable', '>0.1', '<= 7.0'
+  spec.add_runtime_dependency 'dry-inflector', '~>0.1'
+  spec.add_runtime_dependency 'sinatra', '>=1.4', '< 3.0'
+  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'
 
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency 'thor', '~> 1.1.0'
+  spec.add_development_dependency 'rack-test', '~>0.8'
+  spec.add_development_dependency 'rack', '>= 2.0.6'
+  spec.add_development_dependency 'pry', '~>0.10'
+  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'
 end

data/docs/migrating_from_v2_to_v3.md

@@ -0,0 +1,33 @@
+# Migrating from Presenters v2 to COPRL Presenters v3
+
+## Plugins
+
+The plugins have been modified to support Rails native views.
+There is a generator that you can also use to generate a new plugin: `coprl generate plugin PLUGIN_NAME`.
+In some cases generating a new plugin and moving over the code may be the preferred option.
+
+The rest of this guide assumes you are going to migrate it over manualy.
+
+### Module Rename
+* Rename library directory `lib/voom` => 'lib/coprl'
+* Refactor module `Voom` => `Coprl`
+* Replace in `lib` files  'voom/' => `coprl/`
+
+### View Changes
+
+In the Coprl::Presenters::Plugins::PLUGIN_NAME::WebClientComponents
+Add the following callback that points to your views directory
+
+    def view_dir_PLUGIN_NAME(pom)
+        File.join(__dir__, '../../../../../../..', 'views', 'components')
+    end
+
+* Add an `application` directory under your view directory returned above.
+* Add a `_` prefix to your templates.
+* Change erb render calls in your templates `erb :"components/event"` => `partial "components/event"`
+* Add raw calls to any javascript/css that you emitt from your templates, e.g., `<%= raw File.read(File.expand_path('../../../../../../public/c3.min.css', __dir__)  ) %>`
+
+**Recommended** 
+
+Move templates, javascript and css files into their own view directory at the root of the presenter. 
+This makes it easier to reason and find the appropriate parts of the plugin

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
+Coprl::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
+
+Coprl::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
+
+Coprl::Presenters::Settings.configure do |config|
+  config.presenters.before_render << AuthenticationCheck.new
+end
+```

data/exe/coprl

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-
-require "coprl"
+require_relative '../lib/coprl/presenters/cli'
+Coprl::Presenters::Cli.start(ARGV)

data/lib/coprl.rb

@@ -1,8 +1,26 @@
-# frozen_string_literal: true
+require 'zeitwerk'
 
-require_relative "coprl/version"
+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 Coprl
-  class Error < StandardError; end
-  # Your code goes here...
+end
+
+if defined?(::Rails)
+  # We need this class's file to be parsed, but we want to let Zeitwerk load it
+  Coprl::Presenters::Rails::Railtie
+  Coprl::Presenters::Rails::Engine
 end

data/lib/coprl/container_methods.rb

@@ -0,0 +1,40 @@
+require 'dry-container'
+
+module Coprl
+  module ContainerMethods
+    include Coprl::Symbol::ToStr
+
+    def registered_keys
+      @registered_keys ||= []
+    end
+
+    def registered?(presenter)
+      container.key?(sym_to_str(presenter))
+    end
+
+    def [](name)
+      resolve(name)
+    end
+
+    def resolve(name)
+      container.resolve(sym_to_str(name))
+    end
+
+    def list
+      container.keys
+    end
+    alias keys list
+
+    def container
+      @container ||= Dry::Container.new
+    end
+
+    # This method empties out the container
+    # It should ONLY be used for testing purposes
+    def reset!
+      registered_keys.each { |key| ClassConstants.new(key).deconstantize }
+      @registered_keys = []
+      container._container.clear
+    end
+  end
+end

data/lib/coprl/logger_methods.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Coprl
+  module LoggerMethods
+    private
+    
+    def logger
+      Logger.new(STDOUT)
+    end
+  end
+end

data/lib/coprl/parameters.rb

@@ -0,0 +1,73 @@
+module Coprl
+  # Provides a query interface for the ruby parameters method
+  class Parameters
+    def initialize(parameters)
+      @params = parameters
+    end
+
+    def args
+      @params.select {|p| p.first == :req || p.first == :opt}
+    end
+
+    def required_args
+      @params.select {|p| p.first == :req}
+    end
+
+    def required_args?
+      required_args.any?
+    end
+
+    def optional_args
+      @params.select {|p| p.first == :opt}
+    end
+
+    def optional_args?
+      optional_args.any?
+        end
+
+    def splats_args
+      @params.select {|p| p.first == :rest}
+    end
+
+    def splats_args?
+      splats_args.any?
+    end
+    
+    def options
+      @params.select {|p| p.first == :keyreq || p.first == :key}
+    end
+
+    def options?
+      options.any?
+    end
+
+    def required_options
+      @params.select {|p| p.first == :keyreq}
+    end
+
+    def required_options?
+      required_options.any?
+    end
+    
+
+    def optional_options
+      @params.select {|p| p.first == :key}
+    end
+
+    def optional_options?
+      optional_options.any?
+    end
+
+    def spalts_options
+      @params.select {|p| p.first == :keyrest}
+    end
+
+    def splats_options?
+      spalts_options.any?
+    end
+
+    def names(args_or_options)
+      args_or_options.map(&:last)
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+require 'sinatra'
+require 'honeybadger' if ENV.fetch('HONEYBADGER_API_KEY'){false}
+require 'json'
+
+module Coprl
+  module Presenters
+    module Api
+      # This is the Rest API for COPRL services/component commands
+      class App < Sinatra::Base
+        set :root, File.expand_path('../../../..', __FILE__)
+        set :router_, Router
+        set :bind, '0.0.0.0'
+
+        get '/:_presenter_.pom' do
+          render_presenter(params[:_presenter_])
+        end
+
+        get '/:_namespace1_/:_presenter_.pom' do
+          fq_presenter = [params[:_namespace1_], params[:_presenter_]].join(':')
+          pass unless Presenters::App.registered?(fq_presenter)
+          render_presenter(fq_presenter)
+        end
+
+        get '/:_namespace1_/:_namespace2_/:_presenter_.pom' do
+          fq_presenter = [params[:_namespace1_], params[:_namespace2_], params[:_presenter_]].join(':')
+          pass unless Presenters::App.registered?(fq_presenter)
+          render_presenter(fq_presenter)
+        end
+
+
+        private
+
+        # analogous to Coprl::Presenters::WebClient::App#render_presenter
+        def render_presenter(presenter)
+          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 = Coprl::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(base_params = params)
+          prepare_context = Presenters::Settings.config.presenters.web_client.prepare_context.dup
+          prepare_context.push(method(:scrub_context))
+          context = base_params.dup
+          prepare_context.reduce(context) do |params, context_proc|
+            context_proc.call(params, session, env)
+          end
+          context
+        end
+
+        def scrub_context(params, _session, _env)
+          %i(splat captures _presenter_ grid_nesting).each do |key|
+            params.delete(key)
+          end
+          params
+        end
+      end
+    end
+  end
+end