jekyll-contentful-data-import 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c1c1b1bddb8164bcc950d2e370ae3e15327c44c5d4c34cbd5f7b38429414d7
-  data.tar.gz: c5aed758e4839abb2bc8dfe08ba883cd437d7c0c1c908b44a6362d35e84cac54
+  metadata.gz: 462c56e5cdfd73612d643ab860e3390149fc360462ab6027d63b54106fb99894
+  data.tar.gz: 1926f296f8fc998dceec8b221c1000b610a25c5167713a15e1764f719ee1d08d
 SHA512:
-  metadata.gz: 3ceb1ae089f35241ff5b64a7069d5e00f0c13d890ca0608f2b63a2f0e20f110c013024893a629c4f1b1c7440169830365d234365ed76eae8535671bcdace34b4
-  data.tar.gz: d11c17b6f0a9479fe7e036bc424eb14b8b542764c9ce354e730db94f62859356b5feee21bdd55433c59884d27fdcf6a642c6994b81f1d32351b14917ea629015
+  metadata.gz: 8b7a6998dc83466dc49f0058b3341901342d687c2c9abe6e5033425e11543f999cc6e60a769d1a471af08fb6bcf0094b552b8aa8bf9d1fe4b404c4d08f1fa7ce
+  data.tar.gz: bbe933c2c443d34ab33efdcca9fb2d97b3a22ebd8aec23aa2503473a18c228919b719ce9e5a134ad3993477c85336a1f4d4bd0d083f8339b2165430b9b917d4c

data/.rubocop_todo.yml

@@ -23,7 +23,7 @@ Metrics/CyclomaticComplexity:
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 100
+  Max: 120
 
 # Offense count: 3
 # Configuration parameters: CountComments.
@@ -33,6 +33,6 @@ Metrics/MethodLength:
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Style/FileName:
+Naming/FileName:
   Exclude:
     - 'lib/jekyll-contentful-data-import.rb'

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## v1.8.0
+### Added
+* Added capability to autoload mappers [#22](https://github.com/contentful/jekyll-contentful-data-import/issues/22)
+* *This feature is currently in BETA state, changes may occur as patch fixes* Added support for RichText and added the `rich_text` view filter.
+
 ## v1.7.0
 ### Added
 * Added top-level environment assignment, with support for `ENV_` access [#61](https://github.com/contentful/jekyll-contentful-data-import/issues/61)

data/README.md

@@ -43,23 +43,25 @@ To configure the extension, add the following configuration block to Jekyll's `_
 ```yaml
 contentful:
   spaces:
-    - example: # Jekyll _data folder identifier - Required
-        space: cfexampleapi         # Required
-        access_token: b4c0n73n7fu1  # Required
-        environment: master         # Optional
-        cda_query:                  # Optional
+    - example:                              # Jekyll _data folder identifier - Required
+        space: cfexampleapi                 # Required
+        access_token: b4c0n73n7fu1          # Required
+        environment: master                 # Optional
+        cda_query:                          # Optional
           include: 2
           limit: 100
-        all_entries: true           # Optional - Defaults to false, only grabbing the amount set on CDA Query
-        all_entries_page_size: 1000 # Optional - Defaults to 1000, maximum amount of entries per CDA Request for all_entries
-        content_types:              # Optional
+        all_entries: true                   # Optional - Defaults to false, only grabbing the amount set on CDA Query
+        all_entries_page_size: 1000         # Optional - Defaults to 1000, maximum amount of entries per CDA Request for all_entries
+        content_types:                      # Optional
           cat: MyCoolMapper
-        client_options:             # Optional
+        client_options:                     # Optional
           api_url: 'preview.contentful.com' # Defaults to 'api.contentful.com' which is Production
-          max_include_resolution_depth: 5 # Optional - Defaults to 20, maximum amount of levels to resolve includes
-        base_path: app_path         # Optional - Defaults to Current directory
-        destination: destination_in_data # Optional - Defaults to _data/contentful/spaces
-        individual_entry_files: true # Optional - Defaults to false
+          max_include_resolution_depth: 5   # Optional - Defaults to 20, maximum amount of levels to resolve includes
+        base_path: app_path                 # Optional - Defaults to Current directory
+        destination: destination_in_data    # Optional - Defaults to _data/contentful/spaces
+        individual_entry_files: true        # Optional - Defaults to false
+        rich_text_mappings:                 # Optional - Defaults to {}
+          embedded-entry-block: MyEntryRenderer
 ```
 
 Parameter              | Description
@@ -71,10 +73,11 @@ cda_query              | Hash describing query configuration. See [contentful.rb
 all_entries            | Boolean, if true will run multiple queries to the API until it fetches all entries for the space
 all_entries_page_size  | Integer, the amount of maximum entries per CDA Request when fetching :all_entries
 content_types          | Hash describing the mapping applied to entries of the imported content types
-client_options         | Hash describing Contentful::Client configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info.
+client_options         | Hash describing `Contentful::Client` configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info.
 base_path              | String with path to your Jekyll Application, defaults to current directory. Path is relative to your current location.
 destination            | String with path within `_data` under which to store the output yaml file. Defaults to contentful/spaces
 individual_entry_files | Boolean, if true will create an individual file per entry separated in folders by content type, file path will be `{space_alias}/{content_type_id}/{entry_id}.yaml`. Default behavior is to create a file per space. Usage is affected when this is set to true, please look in the section below.
+rich_text_mappings     | Hash with `'nodeTyoe' => RendererClass` pairs determining overrides for the [`RichTextRenderer` library](https://github.com/contentful/rich-text-renderer.rb) configuration.
 
 You can add multiple spaces to your configuration
 
@@ -109,21 +112,51 @@ end
 
 #### Caveats
 
-Jekyll itself only allows you to import code as plugins only for its recognized plugin entry points.
-Therefore we need to use a custom [Rakefile](https://github.com/contentful/contentful_jekyll_examples/blob/master/examples/custom_mapper/example/Rakefile) to import the mapper and required files:
+**Note:** This has changed since previous version.
 
-```ruby
-require 'jekyll'
-require 'jekyll-contentful-data-import'
-require './_plugins/mappers'
+When creating custom mappers, you should create them in a file under `#{source_dir}/_plugins/mappers/`.
+This will allow the autoload mechanism that has been included in the latest version.
 
-desc "Import Contentful Data with Custom Mappers"
-task :contentful do
-  Jekyll::Commands::Contentful.process([], {}, Jekyll.configuration['contentful'])
-end
+With the autoload mechanism, there is no longer a need to create a `rake` task for importing using custom mappers.
+
+If you already have a custom `rake` task, the new autoload mechanism will not affect it from working as it was working previously.
+
+### Rich Text *Beta*
+
+To render rich text in your views, you can use the `rich_text` filter:
+
+```liquid
+{{ entry.rich_text_field | rich_text }}
+```
+
+This will output the generated HTML generated by the [`RichTextRenderer` library](https://github.com/contentful/rich-text-renderer.rb).
+
+#### Adding custom renderers
+
+When using rich text, if you're planning to embed entries, then you need to create your custom renderer for them. You can read how create your own renderer classes [here](https://github.com/contentful/rich-text-renderer.rb#using-different-renderers).
+
+To configure the mappings, you need to add them in your `contentful` block like follows:
+
+```yaml
+contentful:
+  spaces:
+    - example:
+      # ... all the regular config ...
+      rich_text_mappings:
+        embedded-entry-block: MyCustomRenderer
 ```
 
-Then proceed to run: `bundle exec rake contentful`
+You can also add renderers for all other types of nodes if you want to have more granular control over the rendering.
+
+This will use the same autoload strategy included for custom entry mappers, therefore, you should include your mapper classes in `#{source_dir}/_plugins/mappers/`.
+
+#### Using the helper with multiple Contentful spaces
+
+In case you have multiple configured spaces, and have different mapping configurations for them. You can specify which space you want to pull the configuration from when using the helper.
+
+The helper receives an additional optional parameter for the space name. By default it is `nil`, indicating the first available space.
+
+So, if for example you have 2 spaces with different configurations, to use the space called `foo`, you should call the helper as: `{{ entry.field | rich_text: "foo" }}`.
 
 ### Hiding Space and Access Token in Public Repositories
 

data/jekyll-contentful.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
 
   # Additional dependencies
   s.add_dependency("contentful", '~> 2.1')
+  s.add_dependency("rich_text_renderer", '~> 0.1')
 
   s.add_development_dependency 'rubygems-tasks', '~> 0.2'
   s.add_development_dependency "guard"

data/lib/jekyll-contentful-data-import.rb

@@ -1,4 +1,5 @@
 require 'jekyll-contentful-data-import/version'
+require 'jekyll-contentful-data-import/helpers'
 
 %w[contentful].each do |file|
   require File.expand_path("jekyll/commands/#{file}.rb", File.dirname(__FILE__))

data/lib/jekyll-contentful-data-import/helpers.rb

@@ -0,0 +1,35 @@
+require 'rich_text_renderer'
+
+module Jekyll
+  module Contentful
+    # Liquid filter for the RichText field.
+    module RichTextFilter
+      def rich_text(field, space = nil)
+        return if field.nil?
+
+        RichTextRenderer::Renderer.new(mappings_for(space)).render(field)
+      end
+
+      private
+
+      def mappings_for(space)
+        mappings = {}
+        config_for(space).fetch('rich_text_mappings', {}).each do |k, v|
+          mappings[k.to_s] = Module.const_get(v)
+        end
+
+        mappings
+      end
+
+      def config_for(space)
+        config = @context.registers[:site].config['contentful']['spaces']
+
+        # Spaces is a list of hashes indexed by space alias
+        return config.first.first[1] if space.nil? # Return the first available configuration
+        config.find { |sc| sc.key?(space) }[space]
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Contentful::RichTextFilter)

data/lib/jekyll-contentful-data-import/importer.rb

@@ -10,8 +10,11 @@ module Jekyll
     class Importer
       attr_reader :config
 
-      def initialize(config)
-        @config = config
+      def initialize(jekyll_config)
+        @jekyll_config = jekyll_config
+        @config = jekyll_config['contentful']
+
+        autoload_mappers!
       end
 
       def run
@@ -117,6 +120,14 @@ module Jekyll
         options.delete(:raise_errors)
         options
       end
+
+      def autoload_mappers!
+        mapper_search_path = File.join(@jekyll_config['source'], @jekyll_config['plugins_dir'], 'mappers')
+        mapper_files = Jekyll::Utils.safe_glob(mapper_search_path, File.join('**', '*.rb'))
+        Jekyll::External.require_with_graceful_fail(mapper_files)
+      rescue StandardError
+        Jekyll.logger.debug "Couldn't find custom mappers"
+      end
     end
   end
 end

data/lib/jekyll-contentful-data-import/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Contentful
-    VERSION = '1.7.0'.freeze
+    VERSION = '1.8.0'.freeze
   end
 end

data/lib/jekyll/commands/contentful.rb

@@ -30,15 +30,14 @@ module Jekyll
       def self.command_action(command)
         command.action do |args, options|
           jekyll_options = configuration_from_options(options)
-          contentful_config = jekyll_options['contentful']
-          process args, options, contentful_config
+          process args, options, jekyll_options
         end
       end
 
-      def self.process(_args = [], options = {}, contentful_config = {})
+      def self.process(_args = [], options = {}, config = {})
         Jekyll.logger.info 'Starting Contentful import'
 
-        Jekyll::Contentful::Importer.new(contentful_config).run
+        Jekyll::Contentful::Importer.new(config).run
 
         Jekyll.logger.info 'Contentful import finished'
 

data/spec/jekyll-contentful/helpers_spec.rb

@@ -0,0 +1,695 @@
+require 'spec_helper'
+
+class MockSite
+  attr_reader :config
+
+  def initialize(config)
+    @config = config
+  end
+end
+
+class MockContext
+  attr_reader :registers
+  def initialize(config)
+    @registers = {
+      site: MockSite.new(config)
+    }
+  end
+end
+
+class MockSiteContext
+  include Jekyll::Contentful::RichTextFilter
+
+  def initialize(config)
+    @context = MockContext.new(config)
+  end
+end
+
+class MyRenderer < RichTextRenderer::BaseNodeRenderer
+  def render(node)
+    return "<div>I eat nodes for breakfast</div>"
+  end
+end
+
+describe Jekyll::Contentful::RichTextFilter do
+  let(:config) do
+    {
+      'contentful' => {
+        'spaces' => [
+          'foo' => {
+            'rich_text_mappings' => {
+              'embedded-entry-block' => 'MyRenderer'
+            }
+          },
+          'bar' => {
+          }
+        ]
+      }
+    }
+  end
+
+  let(:rt_field) do
+    {
+      "content" => [
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "Some heading",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "heading-1",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+            "sys" => {
+              "id" => "49rofLvvxCOiIMIi6mk8ai",
+              "created_at" => "2018-08-22T10:45:20+00:00",
+              "updated_at" => "2018-08-22T10:45:20+00:00",
+              "content_type_id" => "embedded",
+              "revision" => 1
+            },
+            "body" => "Embedded 1"
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "embedded-entry-block",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "Some subheading",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "heading-2",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+                {
+                  "data" => {
+                  },
+                  "type" => "bold",
+                  "object" => "mark"
+                }
+              ],
+              "value" => "Some bold",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+                {
+                  "data" => {
+                  },
+                  "type" => "italic",
+                  "object" => "mark"
+                }
+              ],
+              "value" => "Some italics",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+                {
+                  "data" => {
+                  },
+                  "type" => "underline",
+                  "object" => "mark"
+                }
+              ],
+              "value" => "Some underline",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+            "sys" => {
+              "id" => "5ZF9Q4K6iWSYIU2OUs0UaQ",
+              "created_at" => "2018-08-22T10:45:29+00:00",
+              "updated_at" => "2018-08-22T10:45:29+00:00",
+              "content_type_id" => "embedded",
+              "revision" => 1
+            },
+            "body" => "Embedded 2"
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "embedded-entry-block",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "Some raw content",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "An unpublished embed:",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "Some more content",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+                {
+                  "data" => {
+                  },
+                  "type" => "code",
+                  "object" => "mark"
+                }
+              ],
+              "value" => "Some code",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            },
+            {
+              "data" => {
+                "uri" => "https://www.contentful.com"
+              },
+              "content" => [
+                {
+                  "marks" => [
+
+                  ],
+                  "value" => "A hyperlink",
+                  "nodeType" => "text",
+                  "nodeClass" => "text"
+                }
+              ],
+              "nodeType" => "hyperlink",
+              "nodeClass" => "inline"
+            },
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "data" => {
+              },
+              "content" => [
+                {
+                  "data" => {
+                  },
+                  "content" => [
+                    {
+                      "marks" => [
+
+                      ],
+                      "value" => "Ul list",
+                      "nodeType" => "text",
+                      "nodeClass" => "text"
+                    }
+                  ],
+                  "nodeType" => "paragraph",
+                  "nodeClass" => "block"
+                }
+              ],
+              "nodeType" => "list-item",
+              "nodeClass" => "block"
+            },
+            {
+              "data" => {
+              },
+              "content" => [
+                {
+                  "data" => {
+                  },
+                  "content" => [
+                    {
+                      "marks" => [
+
+                      ],
+                      "value" => "A few ",
+                      "nodeType" => "text",
+                      "nodeClass" => "text"
+                    },
+                    {
+                      "marks" => [
+                        {
+                          "data" => {
+                          },
+                          "type" => "bold",
+                          "object" => "mark"
+                        }
+                      ],
+                      "value" => "items",
+                      "nodeType" => "text",
+                      "nodeClass" => "text"
+                    }
+                  ],
+                  "nodeType" => "paragraph",
+                  "nodeClass" => "block"
+                },
+                {
+                  "data" => {
+                  },
+                  "content" => [
+                    {
+                      "data" => {
+                      },
+                      "content" => [
+                        {
+                          "data" => {
+                          },
+                          "content" => [
+                            {
+                              "marks" => [
+
+                              ],
+                              "value" => "Ordered list nested inside an Unordered list item",
+                              "nodeType" => "text",
+                              "nodeClass" => "text"
+                            }
+                          ],
+                          "nodeType" => "paragraph",
+                          "nodeClass" => "block"
+                        }
+                      ],
+                      "nodeType" => "list-item",
+                      "nodeClass" => "block"
+                    }
+                  ],
+                  "nodeType" => "ordered-list",
+                  "nodeClass" => "block"
+                }
+              ],
+              "nodeType" => "list-item",
+              "nodeClass" => "block"
+            }
+          ],
+          "nodeType" => "unordered-list",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "data" => {
+              },
+              "content" => [
+                {
+                  "data" => {
+                  },
+                  "content" => [
+                    {
+                      "marks" => [
+
+                      ],
+                      "value" => "Ol list",
+                      "nodeType" => "text",
+                      "nodeClass" => "text"
+                    }
+                  ],
+                  "nodeType" => "paragraph",
+                  "nodeClass" => "block"
+                }
+              ],
+              "nodeType" => "list-item",
+              "nodeClass" => "block"
+            },
+            {
+              "data" => {
+              },
+              "content" => [
+                {
+                  "data" => {
+                  },
+                  "content" => [
+                    {
+                      "marks" => [
+
+                      ],
+                      "value" => "two",
+                      "nodeType" => "text",
+                      "nodeClass" => "text"
+                    }
+                  ],
+                  "nodeType" => "paragraph",
+                  "nodeClass" => "block"
+                }
+              ],
+              "nodeType" => "list-item",
+              "nodeClass" => "block"
+            },
+            {
+              "data" => {
+              },
+              "content" => [
+                {
+                  "data" => {
+                  },
+                  "content" => [
+                    {
+                      "marks" => [
+
+                      ],
+                      "value" => "three",
+                      "nodeType" => "text",
+                      "nodeClass" => "text"
+                    }
+                  ],
+                  "nodeType" => "paragraph",
+                  "nodeClass" => "block"
+                }
+              ],
+              "nodeType" => "list-item",
+              "nodeClass" => "block"
+            }
+          ],
+          "nodeType" => "ordered-list",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "hr",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "data" => {
+              },
+              "content" => [
+                {
+                  "marks" => [
+
+                  ],
+                  "value" => "An inspirational quote",
+                  "nodeType" => "text",
+                  "nodeClass" => "text"
+                }
+              ],
+              "nodeType" => "paragraph",
+              "nodeClass" => "block"
+            },
+            {
+              "data" => {
+              },
+              "content" => [
+                {
+                  "marks" => [
+
+                  ],
+                  "value" => "",
+                  "nodeType" => "text",
+                  "nodeClass" => "text"
+                }
+              ],
+              "nodeType" => "paragraph",
+              "nodeClass" => "block"
+            }
+          ],
+          "nodeType" => "blockquote",
+          "nodeClass" => "block"
+        },
+        {
+          "data" => {
+          },
+          "content" => [
+            {
+              "marks" => [
+
+              ],
+              "value" => "",
+              "nodeType" => "text",
+              "nodeClass" => "text"
+            }
+          ],
+          "nodeType" => "paragraph",
+          "nodeClass" => "block"
+        }
+      ],
+      "nodeType" => "document",
+      "nodeClass" => "document"
+    }
+  end
+
+  subject { MockSiteContext.new(config) }
+
+  describe 'renders rich text' do
+    it 'by defaults uses first available config' do
+      result = subject.rich_text(rt_field)
+
+      expect(result).to include("<div>I eat nodes for breakfast</div>")
+    end
+
+    it 'can define which space configuration to use' do
+      result = subject.rich_text(rt_field, 'foo')
+      expect(result).to include("<div>I eat nodes for breakfast</div>")
+
+      result = subject.rich_text(rt_field, 'bar')
+      expect(result).not_to include("<div>I eat nodes for breakfast</div>")
+    end
+  end
+end

data/spec/jekyll-contentful/importer_spec.rb

@@ -21,8 +21,12 @@ class ExporterDouble
 end
 
 describe Jekyll::Contentful::Importer do
+  before :each do
+    allow(Jekyll.logger).to receive(:debug).with("Couldn't find custom mappers")
+  end
+
   let(:config) do
-    {
+    { 'contentful' => {
       'spaces' => [
         {
           'example' => {
@@ -31,7 +35,7 @@ describe Jekyll::Contentful::Importer do
           }
         }
       ]
-    }
+    }}
   end
   subject { described_class.new(config) }
 
@@ -94,27 +98,29 @@ describe Jekyll::Contentful::Importer do
       it 'runs exporter with correct arguments' do
         allow(subject).to receive(:client).and_return(ClientDouble.new)
 
-        expect(Jekyll::Contentful::SingleFileDataExporter).to receive(:new).with('example', [], config['spaces'].first['example']).and_return(ExporterDouble.new)
+        expect(Jekyll::Contentful::SingleFileDataExporter).to receive(:new).with('example', [], config['contentful']['spaces'].first['example']).and_return(ExporterDouble.new)
 
         subject.run
       end
 
       it 'runs multifile exporter when passed :individual_entry_files flag' do
         config = {
-          'spaces' => [
-            {
-              'example' => {
-                'space' => 'cfexampleapi',
-                'access_token' => 'b4c0n73n7fu1',
-                'individual_entry_files' => true
+          'contentful' => {
+            'spaces' => [
+              {
+                'example' => {
+                  'space' => 'cfexampleapi',
+                  'access_token' => 'b4c0n73n7fu1',
+                  'individual_entry_files' => true
+                }
               }
-            }
-          ]
+            ]
+          }
         }
         subject = described_class.new(config)
         allow(subject).to receive(:client).and_return(ClientDouble.new)
 
-        expect(Jekyll::Contentful::MultiFileDataExporter).to receive(:new).with('example', [], config['spaces'].first['example']).and_return(ExporterDouble.new)
+        expect(Jekyll::Contentful::MultiFileDataExporter).to receive(:new).with('example', [], config['contentful']['spaces'].first['example']).and_return(ExporterDouble.new)
 
         subject.run
       end
@@ -143,4 +149,40 @@ describe Jekyll::Contentful::Importer do
       end
     end
   end
+
+  describe 'mappers are autoloaded' do
+    let(:jekyll_config) do
+      { 'contentful' => {
+        'spaces' => [
+          {
+            'example' => {
+              'space' => 'cfexampleapi',
+              'access_token' => 'b4c0n73n7fu1'
+            }
+          }
+        ]
+      }}
+    end
+
+    it 'custom mappers are autoloaded' do
+      config = jekyll_config.merge('source' => '.', 'plugins_dir' => '_plugins')
+
+      allow(subject).to receive(:spaces).and_return([['foo', {'space' => 'foo', 'access_token' => 'bar'}], ['bar', {'space' => 'bar', 'access_token' => 'foo'}]])
+      allow(subject).to receive(:client).and_return(ClientDouble.new)
+
+      expect(Jekyll::Utils).to receive(:safe_glob).with(File.join('.', '_plugins', 'mappers'), File.join('**', '*.rb')) { ['some_mapper.rb'] }
+      expect(Jekyll::External).to receive(:require_with_graceful_fail).with(['some_mapper.rb'])
+
+      described_class.new(config)
+    end
+
+    it 'raises a warning if no mappers found' do
+      allow(subject).to receive(:spaces).and_return([['foo', {'space' => 'foo', 'access_token' => 'bar'}], ['bar', {'space' => 'bar', 'access_token' => 'foo'}]])
+      allow(subject).to receive(:client).and_return(ClientDouble.new)
+
+      expect(Jekyll.logger).to receive(:debug).with("Couldn't find custom mappers")
+
+      described_class.new(config)
+    end
+  end
 end

data/spec/jekyll/commands/contentful_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe Jekyll::Commands::Contentful do
+  before :each do
+    allow(Jekyll.logger).to receive(:debug).with("Couldn't find custom mappers")
+  end
+
   describe 'class methods' do
     describe '::init_with_program' do
       it 'implements jekyll command interface' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-contentful-data-import
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Contentful GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rich_text_renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +248,7 @@ files:
 - jekyll-contentful.gemspec
 - lib/jekyll-contentful-data-import.rb
 - lib/jekyll-contentful-data-import/base_data_exporter.rb
+- lib/jekyll-contentful-data-import/helpers.rb
 - lib/jekyll-contentful-data-import/importer.rb
 - lib/jekyll-contentful-data-import/mappers.rb
 - lib/jekyll-contentful-data-import/mappers/base.rb
@@ -243,6 +258,7 @@ files:
 - lib/jekyll-contentful-data-import/version.rb
 - lib/jekyll/commands/contentful.rb
 - spec/fixtures/vcr_fixtures/entries.yml
+- spec/jekyll-contentful/helpers_spec.rb
 - spec/jekyll-contentful/importer_spec.rb
 - spec/jekyll-contentful/mappers/base_spec.rb
 - spec/jekyll-contentful/multi_file_data_exporter_spec.rb
@@ -277,6 +293,7 @@ summary: Include mangablable content from the Contentful CMS and API into your J
   projects
 test_files:
 - spec/fixtures/vcr_fixtures/entries.yml
+- spec/jekyll-contentful/helpers_spec.rb
 - spec/jekyll-contentful/importer_spec.rb
 - spec/jekyll-contentful/mappers/base_spec.rb
 - spec/jekyll-contentful/multi_file_data_exporter_spec.rb