pageflow-support 15.1.0.beta2 → 15.1.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06d9abcf1014cbcaea5c278133641205394068482222227b0647064cf60a99e2
-  data.tar.gz: 7699ddf3ae947b35144c88709595064ae3478aa1645e012c6d9acc319f8a43c6
+  metadata.gz: 638a7e6f9dc580d1f7aba4aa8202ae9915c9511c76048418fd6759e5380b8365
+  data.tar.gz: ee215e8c1fe7f07045f493d6139d2cbf8f004abf3b3c947166e9c093e5a50929
 SHA512:
-  metadata.gz: 322ddb75d16500e333627f947bb617fa187b61db5d48014811a2b10898ce6ba70afed4191a6fa703f2e8554049a42666708cbcb4517acdcc7cf2194dfc07fbe9
-  data.tar.gz: 84f0915e94b18e8f53eab749232312baa3126b6760a2285c3fb4c9e5cc9ef583d751915640982fde056dacde6eab9e0f713bc9f8a845167ac74eca8cc2fd241e
+  metadata.gz: 319c08b425e75e48c7cf402d5c977b584b17e6e967c62e53c0819e76ad58b95c80b5939ca4e57b1a6a631511b7f6c1448c5bf4e5489bef37e58b76f48a553de2
+  data.tar.gz: 09ba6ebbfc6462c94c420f7471a5435982090edac0fac9ab01e6a2166bf41edc71ce0ecac7fe2cd74be2351b2fd7b9f647243b0daecdc37e8ddabcf36fe5eb90

data/pageflow/edit_lock_test_helper.rb

@@ -0,0 +1,8 @@
+module Pageflow
+  module EditLockTestHelpers
+    def acquire_edit_lock(user, entry)
+      edit_lock = FactoryBot.create(:edit_lock, user: user, entry: entry)
+      request.headers['X-Edit-Lock'] = edit_lock.id
+    end
+  end
+end

data/pageflow/editor_controller_test_helper.rb

@@ -0,0 +1,24 @@
+require 'pageflow/edit_lock_test_helper'
+
+module Pageflow
+  # Helpers to test controllers that include
+  # {Pageflow::EditorController}.
+  #
+  # @since 15.1
+  module EditorControllerTestHelper
+    extend ActiveSupport::Concern
+
+    include EditLockTestHelpers
+    include Devise::Test::ControllerHelpers
+
+    # Sign in with user that has permission to edit the entry and
+    # acquire an edit lock.
+    def authorize_for_editor_controller(entry)
+      user = FactoryBot.create(:user)
+      FactoryBot.create(:membership, user: user, entity: entry, role: :editor)
+
+      sign_in(user, scope: :user)
+      acquire_edit_lock(user, entry)
+    end
+  end
+end

data/pageflow/entries_controller_test_helper.rb

@@ -0,0 +1,50 @@
+module Pageflow
+  # Helpers to test entry type controllers.
+  #
+  # @since 15.1
+  module EntriesControllerTestHelper
+    extend ActiveSupport::Concern
+
+    included do
+      # Entry type controllers are delegated to by
+      # `Pagefow::EntriesController`. Therefore they do not have their
+      # own routes. Controller specs only allow calling actions that
+      # have a route. So we create a fake route to work aroung this.
+
+      controller_name = described_class.name.sub(/Controller$/, '').underscore
+
+      routes do
+        ActionDispatch::Routing::RouteSet.new.tap do |routes|
+          routes.draw do
+            get '/test/entry', to: "#{controller_name}#show"
+          end
+        end
+      end
+    end
+
+    # Invoke an action of the entries controller with the request env
+    # set up just like when Pageflow delegates to the entry type's
+    # frontend app.
+    #
+    # @param action [Symbol] Name of the action to invoke
+    #
+    # @param entry [Entry] Entry to render.
+    #
+    # @param mode [:published|:preview] Whether to render the
+    #   published revision or the draft.
+    def get_with_entry_env(action, entry:, mode: :published, params: {})
+      revision =
+        if mode == :published
+          entry.published_revision
+        else
+          entry.draft
+        end
+
+      published_entry = PublishedEntry.new(entry, revision)
+      EntriesControllerEnvHelper.add_entry_info_to_env(request.env,
+                                                       entry: published_entry,
+                                                       mode: mode)
+      get(action, params: {**params})
+    end
+  end
+end

data/pageflow/json_test_helper.rb

@@ -0,0 +1,46 @@
+module Pageflow
+  module JsonTestHelper
+    def json_response(options = {})
+      json_get(response.body, options)
+    end
+
+    def json_get(text, options = {})
+      object = JSON.parse(text)
+      path = options[:path] || []
+      pretty_path = nil
+
+      Array.wrap(path).inject(object) do |component, key|
+        case key
+        when Integer, '*'
+          expect(component).to be_a(Array),
+                               "Expected json response to have array at '#{pretty_path || 'root'}'"
+          pretty_path = [pretty_path, "[#{key}]"].compact.join
+
+          if key == '*'
+            component
+          else
+            expect(component[key]).to be_present,
+                                      "Expected json response to have item at '#{pretty_path}'"
+            component[key]
+          end
+        when String, Symbol
+          key = key.to_s
+          pretty_path = [pretty_path, key].compact * '.'
+
+          case component
+          when Array
+            component.map do |c|
+              expect(c).to have_key(key),
+                           "Expected json response to have key '#{pretty_path}'"
+              c[key]
+            end
+          else
+            expect(component).to have_key(key),
+                                 "Expected json response to have key '#{pretty_path}'"
+            component[key]
+          end
+        end
+      end
+    end
+  end
+end

data/pageflow/lint.rb

@@ -1,6 +1,7 @@
 require 'pageflow/global_config_api_test_helper'
 require 'pageflow/test_page_type'
 
+require 'pageflow/lint/entry_type'
 require 'pageflow/lint/file_type'
 require 'pageflow/lint/page_type'
 require 'pageflow/lint/file_import'
@@ -11,6 +12,23 @@ module Pageflow
   #
   # @since 13.0
   module Lint
+    # Contract specs for page types. Ensure editor fragments render
+    # without error.
+    #
+    # @param entry_type [EntryType] Page type to run specs for
+    #
+    # @since 15.1
+    #
+    # @example
+    #
+    #   require 'spec_helper'
+    #   require 'pageflow/lint'
+    #
+    #   Pageflow::Lint.entry_type(SomePlugin.entry_type)
+    def self.entry_type(*args)
+      Lint::EntryType.lint(*args)
+    end
+
     # Ensure file type json partials render correctly.
     #
     # @param name [String] File type name to use in spec descriptions

data/pageflow/lint/entry_type.rb

@@ -0,0 +1,40 @@
+require 'pageflow/global_config_api_test_helper'
+
+module Pageflow
+  module Lint
+    # @api private
+    module EntryType
+      def self.lint(entry_type)
+        RSpec.describe "entry type #{entry_type.name}" do
+          let(:entry_type) { entry_type }
+
+          describe '#editor_fragment_renderer' do
+            it 'renders head fragment without error' do
+              entry = DraftEntry.new(FactoryBot.create(:entry))
+
+              expect {
+                entry_type.editor_fragment_renderer.head_fragment(entry)
+              }.not_to raise_error
+            end
+
+            it 'renders body fragment without error' do
+              entry = DraftEntry.new(FactoryBot.create(:entry))
+
+              expect {
+                entry_type.editor_fragment_renderer.body_fragment(entry)
+              }.not_to raise_error
+            end
+
+            it 'renders seed fragment without error' do
+              entry = DraftEntry.new(FactoryBot.create(:entry))
+
+              expect {
+                entry_type.editor_fragment_renderer.seed_fragment(entry)
+              }.not_to raise_error
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/pageflow/lint/file_import.rb

@@ -11,7 +11,7 @@ module Pageflow
         RSpec.describe "file importer #{file_importer.name}" do
           before do
             pageflow_configure do |config|
-              config.file_importers.register(file_importer.name, file_importer)
+              config.file_importers.register(file_importer)
             end
           end
 
@@ -36,13 +36,21 @@ module Pageflow
             }.not_to raise_error
           end
 
+          it 'has a logo_source method which returns string source' do
+            expect(file_importer.class.method_defined?(:logo_source)).to be(true)
+            expect {
+              source = file_importer.logo_source
+              expect(source).to be_instance_of(String)
+            }.not_to raise_error
+          end
+
           it 'has a authentication_provider method' do
             expect(file_importer.class.method_defined?(:authentication_provider)).to be(true)
             provider = file_importer.authentication_provider
             expect(provider).to be_nil.or be_a(Symbol)
           end
 
-          it 'has a search method' do
+          it 'has a search method', :vcr do
             expect(file_importer.class.method_defined?(:search)).to be(true)
             expect {
               provider = file_importer.authentication_provider

data/pageflow/lint/file_type.rb

@@ -46,6 +46,7 @@ module Pageflow
 
           it 'renders editor json without error' do
             helper.extend(FilesHelper)
+            helper.extend(Editor::FilesHelper)
             helper.render(partial: 'pageflow/editor/files/file',
                           formats: [:json],
                           locals: {

data/pageflow/matchers/have_json_ld.rb

@@ -0,0 +1,17 @@
+RSpec::Matchers.define :have_json_ld do |expected_attributes|
+  match do |html|
+    expect(json_ld_objects(html)).to include(a_hash_including(expected_attributes))
+  end
+
+  failure_message do |html|
+    "expected\n\n#{JSON.pretty_generate(json_ld_objects(html))}\n\n" \
+      "to contain a JSON-LD object with attributes\n\n#{JSON.pretty_generate(expected_attributes)}"
+  end
+
+  def json_ld_objects(html)
+    Capybara
+      .string(html)
+      .all('script[type="application/ld+json"]', visible: false)
+      .map { |element| JSON.parse(element.text(:all)) }
+  end
+end

data/pageflow/matchers/have_meta_tag.rb

@@ -0,0 +1,21 @@
+RSpec::Matchers.define :have_meta_tag do
+  match do |body|
+    Capybara.string(body).has_selector?(selectors.join(''), visible: false)
+  end
+
+  chain :with_name do |value|
+    selectors << "[name='#{value}']"
+  end
+
+  chain :for_property do |value|
+    selectors << "[property='#{value}']"
+  end
+
+  chain :with_content_including do |value|
+    selectors << "[content~='#{value}']"
+  end
+
+  def selectors
+    @selectors ||= ['head meta']
+  end
+end

data/pageflow/support/config/capybara.rb

@@ -0,0 +1,61 @@
+require 'capybara/rspec'
+require 'selenium-webdriver'
+require 'capybara/chromedriver/logger'
+require 'webdrivers/chromedriver'
+
+Capybara.register_driver :selenium_chrome_headless_no_sandbox do |app|
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new
+  browser_options.args << '--headless'
+  browser_options.args << '--disable-gpu'
+  # Required for chrome to work in container based Travis environment
+  # (see https://docs.travis-ci.com/user/chrome)
+  browser_options.args << '--no-sandbox'
+
+  capabilities = {
+    # see https://github.com/SeleniumHQ/selenium/issues/3738
+    loggingPrefs: {browser: 'ALL'},
+    # see https://github.com/dbalatero/capybara-chromedriver-logger/issues/11
+    chromeOptions: {
+      w3c: false
+    }
+  }
+
+  Capybara::Selenium::Driver.new(app,
+                                 browser: :chrome,
+                                 options: browser_options,
+                                 desired_capabilities: capabilities)
+end
+
+Capybara.javascript_driver = :selenium_chrome_headless_no_sandbox
+
+Capybara::Chromedriver::Logger.raise_js_errors = true
+Capybara::Chromedriver::Logger.filters = [
+  # Bandwidth probe files are not available in tests
+  /bandwidth_probe.*Failed to load resource/i,
+
+  # Logged by Pageflow after legacy bandwidth detection
+  /Detected bandwidth/,
+
+  # Not helpful in specs
+  /Download the React DevTools/,
+
+  # Caused by sign in form
+  /Input elements should have autocomplete attributes/,
+
+  # React does not like the server rendered "back to top" link inside
+  # page sections.
+  /Target node has markup rendered by React/i,
+
+  # Ignore failure of debounced request to save order of storylines
+  %r{storylines/order - Failed to load resource: the server responded with a status of 401},
+
+  # Ignore failure of debounced request to refresh partials while db
+  # has already been cleaned
+  /partials - Failed to load resource: the server responded with a status of 401/
+]
+
+RSpec.configure do |config|
+  config.after :each, js: true do
+    Capybara::Chromedriver::Logger::TestHooks.after_example!
+  end
+end

data/pageflow/support/config/paperclip.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    Dir.glob(Rails.root.join('public', 'system', 's3', '*')).each do |f|
+      FileUtils.rm_r(f)
+    end
+  end
+
+  config.before(:each, stub_paperclip: true) do
+    allow_any_instance_of(Paperclip::Attachment).to receive(:post_process)
+    allow(Paperclip).to receive(:run).and_return('100x100')
+  end
+end
+
+module Paperclip
+  class Attachment
+    def bucket_name
+      'test'
+    end
+  end
+end

data/pageflow/support/config/webmock.rb

@@ -0,0 +1,8 @@
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    driver_urls = Webdrivers::Common.subclasses.map(&:base_url)
+    WebMock.disable_net_connect!(allow_localhost: true, allow: driver_urls)
+  end
+end

data/pageflow/test_widget_type.rb

@@ -0,0 +1,39 @@
+module Pageflow
+  class TestWidgetType < WidgetType
+    attr_reader :name, :roles
+
+    def initialize(options = {})
+      @name = options.fetch(:name, 'test_widget')
+      @roles = options.fetch(:roles, [])
+      @insert_point = options[:insert_point]
+      @enabled_in_editor = options.fetch(:enabled_in_editor, true)
+      @enabled_in_preview = options.fetch(:enabled_in_preview, true)
+      @rendered = options.fetch(:rendered, '')
+      @rendered_head_fragment = options.fetch(:rendered_head_fragment, '')
+    end
+
+    def enabled_in_editor?
+      @enabled_in_editor
+    end
+
+    def enabled_in_preview?
+      @enabled_in_preview
+    end
+
+    def insert_point
+      @insert_point || super
+    end
+
+    def render(_template, _entry)
+      if @rendered.respond_to?(:call)
+        @rendered.call.html_safe
+      else
+        @rendered.html_safe
+      end
+    end
+
+    def render_head_fragment(_template, _entry)
+      @rendered_head_fragment.html_safe
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pageflow-support
 version: !ruby/object:Gem::Version
-  version: 15.1.0.beta2
+  version: 15.1.0.beta4
 platform: ruby
 authors:
 - Codevise Solutions Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pageflow
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 15.1.0.beta2
+        version: 15.1.0.beta4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 15.1.0.beta2
+        version: 15.1.0.beta4
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
 description: 
 email:
 - info@codevise.de
@@ -208,15 +208,26 @@ files:
 - pageflow/dummy/templates/database.yml
 - pageflow/dummy/templates/test_theme.scss
 - pageflow/dummy/templates/test_theme_preview.png
+- pageflow/edit_lock_test_helper.rb
+- pageflow/editor_controller_test_helper.rb
+- pageflow/entries_controller_test_helper.rb
 - pageflow/global_config_api_test_helper.rb
+- pageflow/json_test_helper.rb
 - pageflow/lint.rb
+- pageflow/lint/entry_type.rb
 - pageflow/lint/file_import.rb
 - pageflow/lint/file_type.rb
 - pageflow/lint/page_type.rb
+- pageflow/matchers/have_json_ld.rb
+- pageflow/matchers/have_meta_tag.rb
 - pageflow/rails_version.rb
 - pageflow/render_page_test_helper.rb
 - pageflow/support.rb
+- pageflow/support/config/capybara.rb
+- pageflow/support/config/paperclip.rb
+- pageflow/support/config/webmock.rb
 - pageflow/test_page_type.rb
+- pageflow/test_widget_type.rb
 - pageflow/used_file_test_helper.rb
 homepage: https://pageflow.io
 licenses: []