contentful-middleman-pages 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +22 -0
- data/CHANGELOG.md +16 -0
- data/CONTRIBUTING.md +43 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +202 -0
- data/README.md +186 -0
- data/Rakefile +2 -0
- data/contentful-middleman-pages.gemspec +27 -0
- data/lib/contentful-middleman-pages.rb +3 -0
- data/lib/contentful/middleman-pages/extension.rb +174 -0
- data/lib/contentful/middleman-pages/version.rb +5 -0
- metadata +139 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: f2500f004a02e3c89568a27d6f9dd426d2e4b3ec
|
|
4
|
+
data.tar.gz: d046f34003b8dae1c373a608a6d76003c0192915
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: a39dcd0a423ffc2e0d0a1c2b3ece46428a0c7211b2ca4a437f91fb60d1e6b51563036d58327344bc7cf8bd88e4c3fbf37256411ff07893ed7d914d0fc6c07cff
|
|
7
|
+
data.tar.gz: db53018f8b4dcfd1b76a83ca23738fea864c62ae900058d5807b05dccc16bc91af437a0cc5297a80b950b648466ef7c223610a939791feeff3c18295b7f34336
|
data/.gitignore
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
*.gem
|
|
2
|
+
*.rbc
|
|
3
|
+
.bundle
|
|
4
|
+
.config
|
|
5
|
+
.yardoc
|
|
6
|
+
Gemfile.lock
|
|
7
|
+
InstalledFiles
|
|
8
|
+
_yardoc
|
|
9
|
+
coverage
|
|
10
|
+
doc/
|
|
11
|
+
lib/bundler/man
|
|
12
|
+
pkg
|
|
13
|
+
rdoc
|
|
14
|
+
spec/reports
|
|
15
|
+
test/tmp
|
|
16
|
+
test/version_tmp
|
|
17
|
+
tmp
|
|
18
|
+
*.bundle
|
|
19
|
+
*.so
|
|
20
|
+
*.o
|
|
21
|
+
*.a
|
|
22
|
+
mkmf.log
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Change Log
|
|
2
|
+
|
|
3
|
+
## Unreleased
|
|
4
|
+
|
|
5
|
+
## 0.1.0
|
|
6
|
+
### Added
|
|
7
|
+
* Add contentful variable to resource templates
|
|
8
|
+
* Add warning when resource template is not found
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
* Removed unneccesary dependencies and updated some version requirements
|
|
12
|
+
* Fixed documentation to use the proper `activate` parameters.
|
|
13
|
+
|
|
14
|
+
## 0.0.2
|
|
15
|
+
### Fixed
|
|
16
|
+
* Do not create duplicated resources on development mode
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
In the spirit of [free software][free-sw], **everyone** is encouraged to help
|
|
3
|
+
improve this project.
|
|
4
|
+
|
|
5
|
+
[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
|
|
6
|
+
|
|
7
|
+
Here are some ways *you* can contribute:
|
|
8
|
+
|
|
9
|
+
* by using alpha, beta, and prerelease versions
|
|
10
|
+
* by reporting bugs
|
|
11
|
+
* by suggesting new features
|
|
12
|
+
* by writing or editing documentation
|
|
13
|
+
* by writing specifications
|
|
14
|
+
* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
|
|
15
|
+
* by refactoring code
|
|
16
|
+
* by closing [issues][]
|
|
17
|
+
* by reviewing patches
|
|
18
|
+
|
|
19
|
+
[issues]: https://github.com/contentful/contentful-middleman-pages/issues
|
|
20
|
+
|
|
21
|
+
## Submitting an Issue
|
|
22
|
+
We use the [GitHub issue tracker][issues] to track bugs and features. Before
|
|
23
|
+
submitting a bug report or feature request, check to make sure it hasn't
|
|
24
|
+
already been submitted. When submitting a bug report, please include a [Gist][]
|
|
25
|
+
that includes a stack trace and any details that may be necessary to reproduce
|
|
26
|
+
the bug, including your gem version, Ruby version, and operating system.
|
|
27
|
+
Ideally, a bug report should include a pull request with failing specs.
|
|
28
|
+
|
|
29
|
+
[gist]: https://gist.github.com/
|
|
30
|
+
|
|
31
|
+
## Submitting a Pull Request
|
|
32
|
+
1. [Fork the repository.][fork]
|
|
33
|
+
2. [Create a topic branch.][branch]
|
|
34
|
+
3. Add specs for your unimplemented feature or bug fix.
|
|
35
|
+
4. Run `bundle exec rake test`. If your specs pass, return to step 3.
|
|
36
|
+
5. Implement your feature or bug fix.
|
|
37
|
+
6. Run `bundle exec rake test`. If your specs fail, return to step 5.
|
|
38
|
+
7. Add, commit, and push your changes.
|
|
39
|
+
8. [Submit a pull request.][pr]
|
|
40
|
+
|
|
41
|
+
[fork]: http://help.github.com/fork-a-repo/
|
|
42
|
+
[branch]: http://learn.github.com/p/branching.html
|
|
43
|
+
[pr]: http://help.github.com/send-pull-requests/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
# Contentful Middleman Pages
|
|
2
|
+
|
|
3
|
+
This gem bundles an extension to [Middleman](https://middlemanapp.com/).
|
|
4
|
+
The goal of this extension is to simplify the usage withing Middleman of data imported from Contentul
|
|
5
|
+
(using the [contentful_middleman](https://github.com/contentful/contentful_middlema) gem).
|
|
6
|
+
|
|
7
|
+
> The main release works for Middleman v3 - The most used version
|
|
8
|
+
>
|
|
9
|
+
> If you want support for Middleman v4 - Please create an issue so we can discuss about it
|
|
10
|
+
|
|
11
|
+
## Table of contents
|
|
12
|
+
* [Installation](#installation)
|
|
13
|
+
* [Usage](#usage)
|
|
14
|
+
* [Extension configuration](#extension-configuration)
|
|
15
|
+
* [Template locals](#template-locals)
|
|
16
|
+
* [Blogging](#blogging)
|
|
17
|
+
* [Pagination](#pagination)
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
Add this line to your application's Gemfile:
|
|
22
|
+
|
|
23
|
+
gem 'contentful-middleman-pages'
|
|
24
|
+
|
|
25
|
+
And then execute:
|
|
26
|
+
|
|
27
|
+
$ bundle
|
|
28
|
+
|
|
29
|
+
## Usage
|
|
30
|
+
|
|
31
|
+
### Extension configuration
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
```ruby
|
|
35
|
+
activate :contentful_pages do |extension|
|
|
36
|
+
extension.data = 'blog.post'
|
|
37
|
+
extension.prefix = 'blog'
|
|
38
|
+
extension.template = 'random.html.erb'
|
|
39
|
+
extension.permalink = 'my/nice/permalink/{title}.html'
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
Parameter | Required | Description
|
|
45
|
+
----------|----------|------------
|
|
46
|
+
data | `true` | Concatenation of the space name and content type (same names used when configuring the contentful_middleman extension) that identifies the entries to be used
|
|
47
|
+
template | `true` | Path to the template used to render every entry
|
|
48
|
+
prefix | `false` | String that will be prepended to the value specified in `template` and `permalink`
|
|
49
|
+
permalink | `false` | Uri template to specify a custom destination path for the resulting pages. Can interpolate values available in the entries
|
|
50
|
+
|
|
51
|
+
#### Extension configuration: example
|
|
52
|
+
|
|
53
|
+
Consider the following configuration of the `contentful_middleman` gem.
|
|
54
|
+
On this case we are assigning the name partners to the space and name partner to the content type.
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
activate :contentful do |f|
|
|
58
|
+
f.space = {partners: '7ujlxwexazta'}
|
|
59
|
+
f.access_token = '437fcca0ac3ec11728782c51cc559c0dfd0d2c568b7da5345c67a1ce31de5a8f'
|
|
60
|
+
f.cda_query = { content_type: '1EVL9Bl48Euu28QEOa44ai', include: 1 }
|
|
61
|
+
f.content_types = { partner: {mapper: PartnerMapper, id:'1EVL9Bl48Euu28QEOa44ai'}}
|
|
62
|
+
end
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
On the activation below we are fetching the entries stored under the key `partners.partner`.
|
|
66
|
+
We will render each of the entries using the template `source/random.html.erb`.
|
|
67
|
+
|
|
68
|
+
```ruby
|
|
69
|
+
activate :contentful_pages do |extension|
|
|
70
|
+
extension.data = 'partners.partner'
|
|
71
|
+
extension.template = 'random.html.erb'
|
|
72
|
+
end
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
On the activation below we are using the same entries.
|
|
76
|
+
We have set the prefix to `partners` and so we will render each of the entries using the template `source/partners/random/html.erb`.
|
|
77
|
+
|
|
78
|
+
```ruby
|
|
79
|
+
activate :contentful_pages do |extension|
|
|
80
|
+
extension.data = 'partners.partner'
|
|
81
|
+
extension.prefix = 'partners'
|
|
82
|
+
extension.template = 'random.html.erb'
|
|
83
|
+
end
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
On the activation below we are using the same entries.
|
|
88
|
+
We have again set the prefix but this time we are using a custom permalink.
|
|
89
|
+
Resulting pages will be available under `partners/my/nice/permalink/xyz.html` where `xyz` is the title of the entry used to render the page.
|
|
90
|
+
|
|
91
|
+
```ruby
|
|
92
|
+
activate :contentful_pages do |extension|
|
|
93
|
+
extension.data = 'partners.partner'
|
|
94
|
+
extension.prefix = 'partners'
|
|
95
|
+
extension.template = 'random.html.erb'
|
|
96
|
+
extension.permalink = 'my/nice/permalink/{title}.html'
|
|
97
|
+
end
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Template locals
|
|
101
|
+
|
|
102
|
+
Inside every template you will have access to the followig set of local variables:
|
|
103
|
+
|
|
104
|
+
* One local variable for each one of the properties stored for every entry in the local data.
|
|
105
|
+
* Access to all the configured resources under the variable `contentful`.
|
|
106
|
+
|
|
107
|
+
#### Template locals: example
|
|
108
|
+
|
|
109
|
+
Consider the following Middleman configuration:
|
|
110
|
+
|
|
111
|
+
```ruby
|
|
112
|
+
activate :contentful_pages do |extension|
|
|
113
|
+
extension.data = 'partners.partner'
|
|
114
|
+
extension.template = 'random.html.erb'
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
activate :contentful_pages do |extension|
|
|
118
|
+
extension.data = 'blog.post'
|
|
119
|
+
extension.template = 'post.html.erb'
|
|
120
|
+
end
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
And that:
|
|
124
|
+
|
|
125
|
+
* For every entry in `data.partner` the following properties are stored: id, name, location
|
|
126
|
+
* For every entry in `blog.post` the following properties are stored: id, slug, author_name
|
|
127
|
+
|
|
128
|
+
So inside the `source/random.html.erb` template you will have access the partner properties as local variables:
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
```html
|
|
132
|
+
<h1><%= name %></h1>
|
|
133
|
+
|
|
134
|
+
Partner location: <%= location %>
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
And inside of every template you will have access to `contentful.partners.partner` and to `contentful.blog.post`. You could write something like this:
|
|
138
|
+
|
|
139
|
+
```html
|
|
140
|
+
<ul>
|
|
141
|
+
<% contentful.partners.partner do |partner| %>
|
|
142
|
+
<li> <%= partner.name %> , <%= partner.location %></li>
|
|
143
|
+
<%end%>
|
|
144
|
+
</ul>
|
|
145
|
+
|
|
146
|
+
<ul>
|
|
147
|
+
<% contentful.blog.post do |post| %>
|
|
148
|
+
<li> <%= post.slug %> , <%= post.author_name %></li>
|
|
149
|
+
<%end%>
|
|
150
|
+
</ul>
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Please note that all the elements in `contentful.partners.partner` and `contentful.blog.post` are
|
|
154
|
+
Middleman [resources](http://www.rubydoc.info/github/middleman/middleman/Middleman/Sitemap/Resource) and so all its methods are available to use.
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
### Blogging
|
|
158
|
+
|
|
159
|
+
If you want to create a blog with Middleman you should use the officially supported extension
|
|
160
|
+
[middleman-blog](https://github.com/middleman/middleman-blog). To use the `middleman-blog` extension
|
|
161
|
+
with data imported from contentful you will have to start writing a configuration like this:
|
|
162
|
+
|
|
163
|
+
```ruby
|
|
164
|
+
activate :blog do |blog|
|
|
165
|
+
blog.prefix = "blog"
|
|
166
|
+
blog.sources = "posts/:year-:month-:day-:title"
|
|
167
|
+
end
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
The relevant part of the previous snippet is the `blog.source` configuration parameter.
|
|
171
|
+
This parameter is used by the `middleman-blog` extension to know which resources it has to use to
|
|
172
|
+
create the blog. To make resources created with the `contentful-middleman-pages` available to
|
|
173
|
+
the blog extension set the permalink of each of these resources to a value that matches the `blog.sources` expression. For example:
|
|
174
|
+
|
|
175
|
+
```ruby
|
|
176
|
+
activate :contentful_pages do |extension|
|
|
177
|
+
extension.data = 'blog.post'
|
|
178
|
+
extension.prefix = 'blog'
|
|
179
|
+
extension.permalink = "posts/{year}-{month}-{day}-{slug}.html"
|
|
180
|
+
extension.template = 'post.html.erb'
|
|
181
|
+
end
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Pagination
|
|
185
|
+
|
|
186
|
+
Pagination is not built into this extension. Use [middleman-pagination](https://github.com/Aupajo/middleman-pagination) instead.
|
data/Rakefile
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
4
|
+
require 'contentful/middleman-pages/version'
|
|
5
|
+
|
|
6
|
+
Gem::Specification.new do |spec|
|
|
7
|
+
spec.name = "contentful-middleman-pages"
|
|
8
|
+
spec.version = Contentful::MiddlemanPages::VERSION
|
|
9
|
+
spec.authors = ["Farruco Sanjurjo"]
|
|
10
|
+
spec.email = ["madtrick@gmail.com"]
|
|
11
|
+
spec.summary = %q{Create pages in middleman using data imported with contentful_middleman}
|
|
12
|
+
spec.homepage = ""
|
|
13
|
+
spec.license = "Apache 2.0"
|
|
14
|
+
|
|
15
|
+
spec.files = `git ls-files -z`.split("\x0")
|
|
16
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
|
18
|
+
spec.require_paths = ["lib"]
|
|
19
|
+
|
|
20
|
+
spec.add_development_dependency "bundler", "~> 1.6"
|
|
21
|
+
spec.add_development_dependency "rake"
|
|
22
|
+
|
|
23
|
+
spec.add_dependency "hashugar", "~> 1.0"
|
|
24
|
+
spec.add_dependency "addressable", "~> 2.3"
|
|
25
|
+
spec.add_dependency "middleman-core", "~> 3.0"
|
|
26
|
+
spec.add_dependency "contentful_middleman", "~> 1.3"
|
|
27
|
+
end
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
require 'addressable/template'
|
|
2
|
+
require 'pathname'
|
|
3
|
+
require 'hashugar'
|
|
4
|
+
|
|
5
|
+
module Contentful
|
|
6
|
+
module MiddlemanPages
|
|
7
|
+
module ResourceInstanceMethods
|
|
8
|
+
attr_accessor :data
|
|
9
|
+
|
|
10
|
+
def ignored?
|
|
11
|
+
# As we are ignoring the template used to render this resource
|
|
12
|
+
# the resources won't be rendered. We have to force it.
|
|
13
|
+
false
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
def respond_to?(symbol)
|
|
17
|
+
key_in_data(symbol) || super
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def method_missing(symbol, *args, &block)
|
|
21
|
+
return data.fetch(symbol.to_s) if key_in_data(symbol)
|
|
22
|
+
super
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
private
|
|
26
|
+
def key_in_data(key)
|
|
27
|
+
data.key? key.to_s
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
module UriTemplate
|
|
33
|
+
def uri_template(uri)
|
|
34
|
+
Addressable::Template.new uri
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def apply_uri_template(template, data)
|
|
38
|
+
template.expand data
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
class Extension < ::Middleman::Extension
|
|
43
|
+
include UriTemplate
|
|
44
|
+
|
|
45
|
+
SOURCE_PATH = 'source'
|
|
46
|
+
|
|
47
|
+
self.supports_multiple_instances = true
|
|
48
|
+
|
|
49
|
+
option :data, nil,
|
|
50
|
+
'The name of the Space and the Content Type to be used as the source of data'
|
|
51
|
+
|
|
52
|
+
option :prefix, nil,
|
|
53
|
+
'The prefix that will be prepended to the values in template and permalink options'
|
|
54
|
+
|
|
55
|
+
option :template, nil,
|
|
56
|
+
'The path to the template that will be used to generate a file for every entry in the given data'
|
|
57
|
+
|
|
58
|
+
option :permalink, nil,
|
|
59
|
+
'The template used to generate the destination path of an entry'
|
|
60
|
+
|
|
61
|
+
def initialize(app, options, &block)
|
|
62
|
+
super
|
|
63
|
+
|
|
64
|
+
@contentful_resources = []
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
#
|
|
68
|
+
# Middleman hooks
|
|
69
|
+
#
|
|
70
|
+
def after_configuration
|
|
71
|
+
massage_options
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
def manipulate_resource_list(resources)
|
|
75
|
+
new_resources_list = resources
|
|
76
|
+
@contentful_resources += options.data.map do |entry_id, entry_data|
|
|
77
|
+
expanded_permalink = expand_permalink entry_data
|
|
78
|
+
resource = ::Middleman::Sitemap::Resource.new(
|
|
79
|
+
@app.sitemap,
|
|
80
|
+
expanded_permalink,
|
|
81
|
+
options.template
|
|
82
|
+
)
|
|
83
|
+
|
|
84
|
+
resource.extend ResourceInstanceMethods
|
|
85
|
+
resource.data = entry_data
|
|
86
|
+
resource.add_metadata locals: entry_data
|
|
87
|
+
|
|
88
|
+
if (index = is_existing_resource?(resource, new_resources_list))
|
|
89
|
+
new_resources_list[index] = resource
|
|
90
|
+
else
|
|
91
|
+
new_resources_list << resource
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
resource
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
(resources + @contentful_resources).map do |resource|
|
|
98
|
+
contentful_metadata = resource.metadata.fetch(:locals).fetch(:contentful, {}.to_hashugar)
|
|
99
|
+
contentful_metadata[@space_name] = {@content_type_name => @contentful_resources}.to_hashugar
|
|
100
|
+
resource.add_metadata locals: {contentful: contentful_metadata}
|
|
101
|
+
resource
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
new_resources_list
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
private
|
|
108
|
+
def apply_prefix_option
|
|
109
|
+
unless options.prefix.nil?
|
|
110
|
+
options.template = ::File.join(options.prefix, options.template)
|
|
111
|
+
|
|
112
|
+
template_path = ::File.join(::File.expand_path(::Dir.pwd), SOURCE_PATH, options.template)
|
|
113
|
+
app.logger.warn "contentful_pages: template not found at #{template_path}" unless ::File.exist?(template_path)
|
|
114
|
+
|
|
115
|
+
options.permalink = ::File.join(options.prefix, options.permalink) unless options.permalink.nil?
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
def expand_permalink(entry_data)
|
|
120
|
+
apply_uri_template(uri_template, entry_data).to_s
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
def is_existing_resource?(resource, resources)
|
|
124
|
+
resource_id = resource.data.fetch("id")
|
|
125
|
+
resources.find_index do |existing_resource|
|
|
126
|
+
existing_resource.data["id"] == resource_id
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
def uri_template
|
|
131
|
+
@path_template ||= super options.permalink
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
def massage_options
|
|
135
|
+
apply_prefix_option
|
|
136
|
+
|
|
137
|
+
massage_data_option
|
|
138
|
+
massage_permalink_option
|
|
139
|
+
massage_template_option
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
def massage_data_option
|
|
143
|
+
data_option = options.data
|
|
144
|
+
space_name, content_type_name = *data_option.split(".")
|
|
145
|
+
|
|
146
|
+
@space_name = space_name
|
|
147
|
+
@content_type_name = content_type_name
|
|
148
|
+
|
|
149
|
+
unless app.data[space_name] && app.data[space_name][content_type_name]
|
|
150
|
+
app.logger.warn "contentful_pages: no local data for key #{data_option}"
|
|
151
|
+
options.data = []
|
|
152
|
+
return
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
options.data = app.data[space_name].fetch(content_type_name)
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
def massage_permalink_option
|
|
159
|
+
if options.permalink.nil?
|
|
160
|
+
template_dirname = Pathname(options.template).dirname
|
|
161
|
+
options.permalink = ::File.join(template_dirname, "{id}.html" )
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
def massage_template_option
|
|
166
|
+
# Ignore the template used to render this page. Otherwise
|
|
167
|
+
# Middleman will try to render it but the resource won't have
|
|
168
|
+
# the required local variables and there'll be an error
|
|
169
|
+
app.ignore options.template
|
|
170
|
+
options.template = ::File.join(app.source_dir, options.template)
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: contentful-middleman-pages
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Farruco Sanjurjo
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2017-01-02 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: bundler
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '1.6'
|
|
20
|
+
type: :development
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '1.6'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: rake
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '0'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - ">="
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '0'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: hashugar
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '1.0'
|
|
48
|
+
type: :runtime
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '1.0'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: addressable
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '2.3'
|
|
62
|
+
type: :runtime
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '2.3'
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: middleman-core
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '3.0'
|
|
76
|
+
type: :runtime
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '3.0'
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: contentful_middleman
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '1.3'
|
|
90
|
+
type: :runtime
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '1.3'
|
|
97
|
+
description:
|
|
98
|
+
email:
|
|
99
|
+
- madtrick@gmail.com
|
|
100
|
+
executables: []
|
|
101
|
+
extensions: []
|
|
102
|
+
extra_rdoc_files: []
|
|
103
|
+
files:
|
|
104
|
+
- ".gitignore"
|
|
105
|
+
- CHANGELOG.md
|
|
106
|
+
- CONTRIBUTING.md
|
|
107
|
+
- Gemfile
|
|
108
|
+
- LICENSE.txt
|
|
109
|
+
- README.md
|
|
110
|
+
- Rakefile
|
|
111
|
+
- contentful-middleman-pages.gemspec
|
|
112
|
+
- lib/contentful-middleman-pages.rb
|
|
113
|
+
- lib/contentful/middleman-pages/extension.rb
|
|
114
|
+
- lib/contentful/middleman-pages/version.rb
|
|
115
|
+
homepage: ''
|
|
116
|
+
licenses:
|
|
117
|
+
- Apache 2.0
|
|
118
|
+
metadata: {}
|
|
119
|
+
post_install_message:
|
|
120
|
+
rdoc_options: []
|
|
121
|
+
require_paths:
|
|
122
|
+
- lib
|
|
123
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
124
|
+
requirements:
|
|
125
|
+
- - ">="
|
|
126
|
+
- !ruby/object:Gem::Version
|
|
127
|
+
version: '0'
|
|
128
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
129
|
+
requirements:
|
|
130
|
+
- - ">="
|
|
131
|
+
- !ruby/object:Gem::Version
|
|
132
|
+
version: '0'
|
|
133
|
+
requirements: []
|
|
134
|
+
rubyforge_project:
|
|
135
|
+
rubygems_version: 2.5.1
|
|
136
|
+
signing_key:
|
|
137
|
+
specification_version: 4
|
|
138
|
+
summary: Create pages in middleman using data imported with contentful_middleman
|
|
139
|
+
test_files: []
|