pageflow-support 13.5.0 → 13.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bcd9468297749bb25a96fb57e665e7c8c8150a66fa93899d168e910745a8576
-  data.tar.gz: ef1c49e58888f9c989f969f594baef5b6337487e8fc9765b709595df33bd4b19
+  metadata.gz: 1e237e3c395bafa9b407240566bbdd43148b54a9fc2f7e0fbe285d8a80d839ed
+  data.tar.gz: 18c04c9fa9b0ac8f7b82f33fb5aad83d96d1a0ac54b1d1e32734290e1eb3e5c1
 SHA512:
-  metadata.gz: 76f6dec7705867509a53393b38b673fc65981456e94819740775b0e2d4c171b85823d310ddedb20152460b35215a7ff424661f0baa8fa79d446a6b8d062749d2
-  data.tar.gz: ecb20b6e47deed0f321a3c53aa795385656cf4361430fa9e466e13404038245dcdb0f44dfa83661282c12041ad9680f34f136469ef2c6829ad5131d7281eac28
+  metadata.gz: 81b3ab9faa2059cc990de500197deaba30fb0bee3b8688af26050684a236ccebc8b86ce997fed06daeb2fe217c3bc6018cc84c4f1e0b1bed86982a33aeb9abe4
+  data.tar.gz: 150194efb591b54ffe3a32b6688a3d153d1d7c4e999046776b5fd4b8aaeaf82e1f4247f1deb8c3a76c389a32b98049a36ba8d3b580d459998b00d31872d52bea

data/pageflow/lint/file_type.rb

@@ -0,0 +1,58 @@
+require 'pageflow/global_config_api_test_helper'
+require 'pageflow/test_page_type'
+
+module Pageflow
+  module Lint
+    # @api private
+    module FileType
+      def self.lint(name, create_file_type:, create_file:)
+        GlobalConfigApiTestHelper.setup
+
+        RSpec.describe "file type #{name}", type: :helper do
+          let(:file_type, &create_file_type)
+
+          let(:file, &create_file)
+
+          before do
+            pageflow_configure do |config|
+              page_type = TestPageType.new(name: :test,
+                                           file_types: [file_type])
+              config.page_types.clear
+              config.page_types.register(page_type)
+            end
+          end
+
+          it 'renders seed json without error' do
+            expect {
+              helper.extend(FilesHelper)
+              helper.render(partial: 'pageflow/files/file',
+                            formats: [:json],
+                            locals: {
+                              file: UsedFile.new(file, FileUsage.new),
+                              file_type: file_type
+                            })
+            }.not_to raise_error
+          end
+
+          it 'renders editor json without error' do
+            helper.extend(FilesHelper)
+            helper.render(partial: 'pageflow/editor/files/file',
+                          formats: [:json],
+                          locals: {
+                            file: UsedFile.new(file, FileUsage.new),
+                            file_type: file_type
+                          })
+          end
+
+          it 'provides css_background_image_urls that returns hash if present' do
+            if file_type.css_background_image_urls
+              result = file_type.css_background_image_urls.call(file)
+
+              expect(result).to be_a(Hash)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/pageflow/lint/page_type.rb

@@ -0,0 +1,51 @@
+require 'pageflow/render_page_test_helper'
+
+module Pageflow
+  module Lint
+    # @api private
+    module PageType
+      def self.lint(page_type)
+        GlobalConfigApiTestHelper.setup
+
+        RSpec.describe "page type #{page_type.name}", type: :helper do
+          include RenderPageTestHelper
+
+          before do
+            pageflow_configure do |config|
+              config.page_types.register(page_type)
+            end
+          end
+
+          it 'renderer page template without error' do
+            expect {
+              render_page(page_type)
+            }.not_to raise_error
+          end
+
+          it 'renders json seed template without error' do
+            helper.extend(PageTypesHelper)
+
+            expect {
+              JbuilderTemplate.encode(helper) do |json|
+                helper.page_type_json_seed(json, page_type)
+              end
+            }.not_to raise_error
+          end
+
+          it 'defines all required translations' do
+            expect(page_type.translation_key).to have_translation
+            expect(page_type.description_translation_key).to have_translation
+            expect(page_type.category_translation_key).to have_translation
+            expect(page_type.help_entry_translation_key).to have_translation
+          end
+
+          matcher :have_translation do
+            match do |key|
+              I18n.t(key, exception_handler: ->(*) { false })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/pageflow/lint.rb

@@ -1,6 +1,9 @@
 require 'pageflow/global_config_api_test_helper'
 require 'pageflow/test_page_type'
 
+require 'pageflow/lint/file_type'
+require 'pageflow/lint/page_type'
+
 module Pageflow
   # Shared examples providing integration level specs for Pageflow
   # components commonly defined by plugins.
@@ -24,53 +27,26 @@ module Pageflow
     #                              create_file_type: -> { SomePlugin.file_type },
     #                              create_file: -> { create(:some_file) })
     #   end
-    def self.file_type(name, create_file_type:, create_file:)
-      GlobalConfigApiTestHelper.setup
-
-      RSpec.describe "file type #{name}", type: :helper do
-        let(:file_type, &create_file_type)
-
-        let(:file, &create_file)
-
-        before do
-          pageflow_configure do |config|
-            page_type = TestPageType.new(name: :test,
-                                         file_types: [file_type])
-            config.page_types.clear
-            config.page_types.register(page_type)
-          end
-        end
-
-        it 'renders seed json without error' do
-          expect {
-            helper.extend(FilesHelper)
-            helper.render(partial: 'pageflow/files/file',
-                          formats: [:json],
-                          locals: {
-                            file: UsedFile.new(file, FileUsage.new),
-                            file_type: file_type
-                          })
-          }.not_to raise_error
-        end
-
-        it 'renders editor json without error' do
-          helper.extend(FilesHelper)
-          helper.render(partial: 'pageflow/editor/files/file',
-                        formats: [:json],
-                        locals: {
-                          file: UsedFile.new(file, FileUsage.new),
-                          file_type: file_type
-                        })
-        end
-
-        it 'provides css_background_image_urls that returns hash if present' do
-          if file_type.css_background_image_urls
-            result = file_type.css_background_image_urls.call(file)
+    def self.file_type(*args)
+      Lint::FileType.lint(*args)
+    end
 
-            expect(result).to be_a(Hash)
-          end
-        end
-      end
+    # Contract specs for page types
+    #
+    # @param page_type [PageType] Page type to run specs for
+    #
+    # @since 13.6
+    #
+    # @example
+    #
+    #   require 'spec_helper'
+    #   require 'pageflow/lint'
+    #
+    #   module SomePlugin
+    #     Pageflow::Lint.page_type(SomePLugin.page_type)
+    #   end
+    def self.page_type(*args)
+      Lint::PageType.lint(*args)
     end
   end
 end

data/pageflow/render_page_test_helper.rb

@@ -0,0 +1,25 @@
+require 'pageflow/global_config_api_test_helper'
+require 'factory_bot_rails'
+
+module Pageflow
+  module RenderPageTestHelper
+    def render_page(page_type, configuration = {})
+      page = FactoryBot.create(:page, template: page_type.name, configuration: configuration)
+      revision = page.chapter.storyline.revision
+      entry = PublishedEntry.new(revision.entry, revision)
+
+      helper.extend(InfoBoxHelper)
+      helper.extend(BackgroundImageHelper)
+      helper.extend(EntryJsonSeedHelper)
+      helper.extend(PageBackgroundAssetHelper)
+      helper.extend(PagesHelper)
+      helper.extend(VideoFilesHelper)
+
+      page_type.view_helpers.each do |page_type_helper|
+        helper.extend(page_type_helper)
+      end
+
+      helper.render_page_template(page, entry: entry)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pageflow-support
 version: !ruby/object:Gem::Version
-  version: 13.5.0
+  version: 13.6.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pageflow
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 13.5.0
+        version: 13.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 13.5.0
+        version: 13.6.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -189,7 +189,10 @@ files:
 - pageflow/dummy/templates/test_theme_preview.png
 - pageflow/global_config_api_test_helper.rb
 - pageflow/lint.rb
+- pageflow/lint/file_type.rb
+- pageflow/lint/page_type.rb
 - pageflow/rails_version.rb
+- pageflow/render_page_test_helper.rb
 - pageflow/support.rb
 - pageflow/test_page_type.rb
 homepage: https://pageflow.io