2017-04-24 20:21:47 +03:00
|
|
|
// Usage:
|
|
|
|
// `{{img_url feature_image}}`
|
|
|
|
// `{{img_url profile_image absolute="true"}}`
|
2017-08-27 20:06:53 +03:00
|
|
|
// Note:
|
|
|
|
// `{{img_url}}` - does not work, argument is required
|
2017-04-24 20:21:47 +03:00
|
|
|
//
|
|
|
|
// Returns the URL for the current object scope i.e. If inside a post scope will return image permalink
|
|
|
|
// `absolute` flag outputs absolute URL, else URL is relative.
|
|
|
|
|
|
|
|
var proxy = require('./proxy'),
|
✨Dynamic Routing Beta (#9596)
refs #9601
### Dynamic Routing
This is the beta version of dynamic routing.
- we had a initial implementation of "channels" available in the codebase
- we have removed and moved this implementation
- there is now a centralised place for dynamic routing - server/services/routing
- each routing component is represented by a router type e.g. collections, routes, static pages, taxonomies, rss, preview of posts
- keep as much as possible logic of routing helpers, middlewares and controllers
- ensure test coverage
- connect all the things together
- yaml file + validation
- routing + routers
- url service
- sitemaps
- url access
- deeper implementation of yaml validations
- e.g. hard require slashes
- ensure routing hierarchy/order
- e.g. you enable the subscriber app
- you have a custom static page, which lives under the same slug /subscribe
- static pages are stronger than apps
- e.g. the first collection owns the post it has filtered
- a post cannot live in two collections
- ensure apps are still working and hook into the routers layer (or better said: and register in the routing service)
- put as much as possible comments to the code base for better understanding
- ensure a clean debug log
- ensure we can unmount routes
- e.g. you have a collection permalink of /:slug/ represented by {globals.permalink}
- and you change the permalink in the admin to dated permalink
- the express route get's refreshed from /:slug/ to /:year/:month/:day/:slug/
- unmount without server restart, yey
- ensure we are backwards compatible
- e.g. render home.hbs for collection index if collection route is /
- ensure you can access your configured permalink from the settings table with {globals.permalink}
### Render 503 if url service did not finish
- return 503 if the url service has not finished generating the resource urls
### Rewrite sitemaps
- we have rewritten the sitemaps "service", because the url generator does no longer happen on runtime
- we generate all urls on bootstrap
- the sitemaps service will consume created resource and router urls
- these urls will be shown on the xml pages
- we listen on url events
- we listen on router events
- we no longer have to fetch the resources, which is nice
- the urlservice pre-fetches resources and emits their urls
- the urlservice is the only component who knows which urls are valid
- i made some ES6 adaptions
- we keep the caching logic -> only regenerate xml if there is a change
- updated tests
- checked test coverage (100%)
### Re-work usage of Url utility
- replace all usages of `urlService.utils.urlFor` by `urlService.getByResourceId`
- only for resources e.g. post, author, tag
- this is important, because with dynamic routing we no longer create static urls based on the settings permalink on runtime
- adapt url utility
- adapt tests
2018-06-05 20:02:20 +03:00
|
|
|
urlService = proxy.urlService;
|
2017-04-24 20:21:47 +03:00
|
|
|
|
|
|
|
module.exports = function imgUrl(attr, options) {
|
2017-08-27 20:06:53 +03:00
|
|
|
// CASE: if no attribute is passed, e.g. `{{img_url}}` we show a warning
|
|
|
|
if (arguments.length < 2) {
|
2017-12-12 00:47:46 +03:00
|
|
|
proxy.logging.warn(proxy.i18n.t('warnings.helpers.img_url.attrIsRequired'));
|
2017-08-27 20:06:53 +03:00
|
|
|
return;
|
2017-04-24 20:21:47 +03:00
|
|
|
}
|
|
|
|
|
2017-08-27 20:06:53 +03:00
|
|
|
var absolute = options && options.hash && options.hash.absolute;
|
2017-04-24 20:21:47 +03:00
|
|
|
|
2017-08-27 20:06:53 +03:00
|
|
|
// CASE: if attribute is passed, but it is undefined, then the attribute was
|
|
|
|
// an unknown value, e.g. {{img_url feature_img}} and we also show a warning
|
2017-04-24 20:21:47 +03:00
|
|
|
if (attr === undefined) {
|
2017-12-12 00:47:46 +03:00
|
|
|
proxy.logging.warn(proxy.i18n.t('warnings.helpers.img_url.attrIsRequired'));
|
2017-08-27 20:06:53 +03:00
|
|
|
return;
|
2017-04-24 20:21:47 +03:00
|
|
|
}
|
|
|
|
|
2017-08-27 20:06:53 +03:00
|
|
|
if (attr) {
|
✨Dynamic Routing Beta (#9596)
refs #9601
### Dynamic Routing
This is the beta version of dynamic routing.
- we had a initial implementation of "channels" available in the codebase
- we have removed and moved this implementation
- there is now a centralised place for dynamic routing - server/services/routing
- each routing component is represented by a router type e.g. collections, routes, static pages, taxonomies, rss, preview of posts
- keep as much as possible logic of routing helpers, middlewares and controllers
- ensure test coverage
- connect all the things together
- yaml file + validation
- routing + routers
- url service
- sitemaps
- url access
- deeper implementation of yaml validations
- e.g. hard require slashes
- ensure routing hierarchy/order
- e.g. you enable the subscriber app
- you have a custom static page, which lives under the same slug /subscribe
- static pages are stronger than apps
- e.g. the first collection owns the post it has filtered
- a post cannot live in two collections
- ensure apps are still working and hook into the routers layer (or better said: and register in the routing service)
- put as much as possible comments to the code base for better understanding
- ensure a clean debug log
- ensure we can unmount routes
- e.g. you have a collection permalink of /:slug/ represented by {globals.permalink}
- and you change the permalink in the admin to dated permalink
- the express route get's refreshed from /:slug/ to /:year/:month/:day/:slug/
- unmount without server restart, yey
- ensure we are backwards compatible
- e.g. render home.hbs for collection index if collection route is /
- ensure you can access your configured permalink from the settings table with {globals.permalink}
### Render 503 if url service did not finish
- return 503 if the url service has not finished generating the resource urls
### Rewrite sitemaps
- we have rewritten the sitemaps "service", because the url generator does no longer happen on runtime
- we generate all urls on bootstrap
- the sitemaps service will consume created resource and router urls
- these urls will be shown on the xml pages
- we listen on url events
- we listen on router events
- we no longer have to fetch the resources, which is nice
- the urlservice pre-fetches resources and emits their urls
- the urlservice is the only component who knows which urls are valid
- i made some ES6 adaptions
- we keep the caching logic -> only regenerate xml if there is a change
- updated tests
- checked test coverage (100%)
### Re-work usage of Url utility
- replace all usages of `urlService.utils.urlFor` by `urlService.getByResourceId`
- only for resources e.g. post, author, tag
- this is important, because with dynamic routing we no longer create static urls based on the settings permalink on runtime
- adapt url utility
- adapt tests
2018-06-05 20:02:20 +03:00
|
|
|
return urlService.utils.urlFor('image', {image: attr}, absolute);
|
2017-04-24 20:21:47 +03:00
|
|
|
}
|
2017-11-01 16:44:54 +03:00
|
|
|
|
|
|
|
// CASE: if you pass e.g. cover_image, but it is not set, then attr is null!
|
|
|
|
// in this case we don't show a warning
|
2017-04-24 20:21:47 +03:00
|
|
|
};
|