jekyll-contentful-data-import 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 117c6b44c14c191f720ab4aeaf2f35d02db27d73
-  data.tar.gz: 9fe2e0d728401af419da7757ffbc315683e98665
+  metadata.gz: 507dfdec0af831cf69432858fa3bd9621c6467a7
+  data.tar.gz: 37ff563f3bcc5f664b968a2512b0e5444f953f41
 SHA512:
-  metadata.gz: 6f89f6ec31a0c43da8db98d3a8f6b935137131f6ebc7487d7d1369af142cf34a3ebbc036bb1a2bfe21566eb788ed1ec5b89362fd293c41f494f9f824ab1395ce
-  data.tar.gz: 49c16f616c0a11a9b6a23a4f0284a5ba1067e42f2b8115c6418a5ce90a9dccb6c2a44f69fcf3ccba461a43ffe92eb3157eefd9620b6636ec28d028f7f55ac6f2
+  metadata.gz: 1db27059f3fd320f1782ec9a70db90d03e40b799602c19d76d90fedc52980b7acfd7f9a26490e180d3697bebde0140d3d99e0e2a7d3c7c0d9fe1f493121f5fad
+  data.tar.gz: 7976a3fafc41fcda41b86bf4b22ff60696c8bc99c831283ff05e6aa905173c8fdce57964dac02af75a2ea4ee9a4ce7e4e931a9866f6123f9789f549a1c6a963d

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 ## Unreleased
 
+## v1.2.0
+### Added
+* Customizable Data Path [#1](https://github.com/contentful/jekyll-contentful-data-import/issues/1)
+
 ## v1.1.0
 ### Added
 * Nested Entries are now serialized completely

data/README.md

@@ -1,6 +1,6 @@
 # Jekyll-Contentful-Data-Import
 
-[![Build Status](https://travis-ci.com/contentful/jekyll-contentful.svg?token=Nx7fXKYs7PbM7CcY2dS1)](https://travis-ci.org/contentful/jekyll-contentful)
+[![Build Status](https://travis-ci.org/contentful/jekyll-contentful-data-import.svg?branch=master)](https://travis-ci.org/contentful/jekyll-contentful-data-import)
 
 Jekyll-Contentful-Data-Import is a [Jekyll](http://jekyllrb.com/) extension to use the Jekyll static site generator together with the API-driven [Contentful CMS](https://www.contentful.com). It is powered by the [Contentful Ruby Gem](https://github.com/contentful/contentful.rb).
 
@@ -51,6 +51,8 @@ contentful:
           :preview: false
           :raise_errors: true
           :dynamic_entries: :auto
+        base_path: app_path        # Optional - Defaults to Current directory
+
 ```
 
 Parameter           | Description
@@ -60,6 +62,7 @@ access_token        | Contentful Delivery API access token
 cda_query           | Hash describing query configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info (look for filter options there). Note that by default only 100 entries will be fetched, this can be configured to up to 1000 entries using the `limit` option.
 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.
+base_path           | String with path to your Jekyll Application, defaults to current directory. Path is relative to your current location.
 
 You can add multiple spaces to your configuration
 
@@ -70,7 +73,7 @@ data folder. If a custom mapper is not specified a default one will be used.
 
 The default mapper will map fields, assets and linked entries.
 
-### Custom mappers
+### Custom Mappers
 
 You can create your own mappers if you need so. The only requirement for a class to behave as a
 mapper is to have a `map` instance method.
@@ -92,3 +95,29 @@ class MySysMapper < ::Jekyll::Contentful::Mappers::Base
 end
 ```
 
+#### Caveats
+
+Jekyll itself only allows to import code as plugins only for it's 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:
+
+```ruby
+require 'jekyll'
+require 'jekyll-contentful-data-import'
+require './_plugins/mappers'
+
+desc "Import Contentful Data with Custom Mappers"
+task :contentful do
+  Jekyll::Commands::Contentful.process([], {}, Jekyll.configuration['contentful'])
+end
+```
+
+Then proceed to run: `bundle exec rake contentful`
+
+## Examples
+
+You can find working examples of multiple uses [here](https://github.com/contentful/contentful_jekyll_examples).
+
+## Contributing
+
+Feel free to add your own examples by submitting a Pull Request. For more information,
+please check [CONTRIBUTING.md](./CONTRIBUTING.md)

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

@@ -23,8 +23,14 @@ module Jekyll
         end
       end
 
+      def base_directory
+        directory = File.expand_path(Dir.pwd)
+        directory = File.join(directory, config['base_path']) if config.key?('base_path')
+
+        directory
+      end
+
       def destination_directory
-        base_directory = File.expand_path(Dir.pwd)
         File.join(base_directory, DATA_FOLDER, CONTENTFUL_FOLDER, SPACES_FOLDER)
       end
 
@@ -33,14 +39,7 @@ module Jekyll
       end
 
       def setup_directory
-        data_folder = File.join(Dir.pwd, DATA_FOLDER)
-        Dir.mkdir(data_folder) unless Dir.exist?(data_folder)
-
-        contentful_folder = File.join(data_folder, CONTENTFUL_FOLDER)
-        Dir.mkdir(contentful_folder) unless Dir.exist?(contentful_folder)
-
-        spaces_folder = File.join(contentful_folder, SPACES_FOLDER)
-        Dir.mkdir(spaces_folder) unless Dir.exist?(spaces_folder)
+        FileUtils.mkdir_p destination_directory
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Jekyll
   module Contentful
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/spec/jekyll-contentful/data_exporter_spec.rb

@@ -5,22 +5,62 @@ describe Jekyll::Contentful::DataExporter do
   subject { described_class.new('foo', []) }
 
   describe 'instance methods' do
-    it '#destination_directory' do
-      expected = File.join(Dir.pwd, '_data', 'contentful', 'spaces')
-      expect(subject.destination_directory).to eq(expected)
+    describe '#base_directory' do
+      it 'default directory' do
+        expect(subject.base_directory).to eq(Dir.pwd)
+      end
+
+      it 'overriden directory' do
+        subject = described_class.new('foo', [], {'base_path' => 'foo_dir'})
+
+        expect(subject.base_directory).to eq(File.join(Dir.pwd, 'foo_dir'))
+      end
     end
 
-    it '#destination_file' do
-      expected = File.join(Dir.pwd, '_data', 'contentful', 'spaces', 'foo.yaml')
-      expect(subject.destination_file).to eq(expected)
+    describe '#destination_directory' do
+      it 'default directory' do
+        expected = File.join(Dir.pwd, '_data', 'contentful', 'spaces')
+        expect(subject.destination_directory).to eq(expected)
+      end
+
+      it 'overriden directory' do
+        subject = described_class.new('foo', [], {'base_path' => 'foo_dir'})
+
+        expected = File.join(Dir.pwd, 'foo_dir', '_data', 'contentful', 'spaces')
+        expect(subject.destination_directory).to eq(expected)
+      end
     end
 
-    it '#setup_directory' do
-      expect(Dir).to receive(:mkdir).with(File.join(Dir.pwd, '_data'))
-      expect(Dir).to receive(:mkdir).with(File.join(Dir.pwd, '_data', 'contentful'))
-      expect(Dir).to receive(:mkdir).with(File.join(Dir.pwd, '_data', 'contentful', 'spaces'))
+    describe '#destination_file' do
+      it 'default directory' do
+        expected = File.join(Dir.pwd, '_data', 'contentful', 'spaces', 'foo.yaml')
+        expect(subject.destination_file).to eq(expected)
+      end
+
+      it 'overridden directory' do
+        subject = described_class.new('foo', [], {'base_path' => 'foo_dir'})
 
-      subject.setup_directory
+        expected = File.join(Dir.pwd, 'foo_dir', '_data', 'contentful', 'spaces', 'foo.yaml')
+        expect(subject.destination_file).to eq(expected)
+      end
+    end
+
+    describe '#setup_directory' do
+      it 'default directory' do
+        expected = File.join(Dir.pwd, '_data', 'contentful', 'spaces')
+        expect(FileUtils).to receive(:mkdir_p).with(expected)
+
+        subject.setup_directory
+      end
+
+      it 'overridden directory' do
+        subject = described_class.new('foo', [], {'base_path' => 'foo_dir'})
+
+        expected = File.join(Dir.pwd, 'foo_dir', '_data', 'contentful', 'spaces')
+        expect(FileUtils).to receive(:mkdir_p).with(expected)
+
+        subject.setup_directory
+      end
     end
 
     describe '#run' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-contentful-data-import
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Contentful GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-24 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll