contentful_middleman 2.1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4e1ca29530fe1fccd43b993eaa8851f74d806aa
-  data.tar.gz: 7b0e5e24f95b21aec66d8c30599483f9eb75e6bc
+  metadata.gz: 1f2caf1c451b4d1c5775bd1febbf4132438a02c2
+  data.tar.gz: 36e15755edb936f0736c165d035584f12f9b1bb1
 SHA512:
-  metadata.gz: d9285bf41c9aafbfdde8b803d89df58fab1a5b03d916a705d4ceee176398be1d123cb3013e1540ce6cb1718d81fb7c872950725deecc3c1655da0c7daeb02e29
-  data.tar.gz: dd322ff7267683d0b2b9ed502a6cb075e172dd75d0036ec0989dd9cc89df221e39ba40e10a68456e43735c6c704ab83a73d5dd11d729abcf9b8f704d59cf97a3
+  metadata.gz: f3a1a10b30f596340df8fc0fc83993a82372f084984266289d682020a072919dec93adf1563de3251bbb7829b1d2c011642192283e6f8e1098a50302818d5332
+  data.tar.gz: 4bd32921dc5d64ffb4254f0d0d5898bdf47105ff8eb5776c546249599a165d628eea2ed8b2cef4a1d93f0f1417277d9ea7822889f0c9e4013f8f15023f8a018c

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 ## Unreleased
 
+## 3.0.0
+
+This is an atificial version bump, no new features have been added and no breaking change introduced.
+We use this upgrade as an opportunity to match the version of this gem with the Middleman version this release
+will stay compatible with.
+
 ## 2.1.3
 ### Fixed
 * `#map_location` properly maps locations

data/README.md

@@ -75,8 +75,21 @@ The default mapper will map fields, assets and linked entries.
 
 ### 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(context, entry)` instance method. This method will take as parameters:
+You can create your own mappers if you need so. The only requirements for a class to behave as a
+mapper are an initializer and a `map(context, entry)` instance method.
+
+The initializer takes two parameters:
+
+  * A `Contentful::Array` of all entries for the current content model
+  * A `Middleman::Configuration::ConfigurationManager` object containing the Contentful configuration options set in `config.rb`
+
+[See BackrefMapper](https://github.com/contentful/contentful_middleman/blob/master/examples/mappers/backref.rb)
+for an example use of entries.
+
+[See the Base mapper](https://github.com/contentful/contentful_middleman/blob/master/lib/contentful_middleman/mappers/base.rb)
+for an example use of options.
+
+The `map` method takes two parameters:
 
   * A context object. All properties set on this object will be written to the yaml file
   * An entry
@@ -85,6 +98,11 @@ Following is an example of such custom mapper:
 
 ```ruby
 class MyAwesomeMapper
+  def initialize(entries, options)
+    @entries = entries
+    @options = options
+  end
+
   def map(context, entry)
     context.slug = entry.title.parameterize
     #... more transformations

data/lib/contentful_middleman/version.rb

@@ -1,3 +1,3 @@
 module ContentfulMiddleman
-  VERSION = "2.1.3"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful_middleman
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Sascha Konietzke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -298,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Include mangablable content from the Contentful CMS and API into your Middleman