Implemented Categories Support #293

manikmagar · 2016-06-25T02:54:22Z

Implemented Categories Support for Posts.

Categories configuration controls -

template.category.file=category.ftl (This is for rendering individual category page)
template.categories.file=categories.ftl (This is for rendering all categories list page to prevent directory listing on {site.host}/categories/ url.
categories.enable=true
render.categories=true
category.default=Uncategorized
categories.path=categories
categories.sanitize=false

Adding categories in content

Add an attribute categories=Category1, Category2

If categories.enable is not false and no categories are provided for post then category.default is applied to post.
First category is also available with primary_category key in model.
If categories.enable is false and categories are still provided in content, then those are ignored with a warning in log.

Accessing categories in templates

all_categories - All categories from all published content. This variable is available on templates.
category_posts - On a single category page template.category.file, this variable is available and provides access to posts marked with category being displayed on page.

Extensionless Support

If uri.noExtension is set to true then all category pages are rendered without extension.

Test cases

Appropriate test cases have been added under src/test/java with its resources under src/test/resources.

coveralls · 2016-06-25T02:57:15Z

Coverage increased (+1.3%) to 66.279% when pulling c252f14 on manikmagar:mm-jbake-categories into 6e4a165 on jbake-org:master.

coveralls · 2016-07-04T22:22:35Z

Coverage increased (+1.7%) to 69.226% when pulling e8299cd on manikmagar:mm-jbake-categories into 7248d37 on jbake-org:master.

coveralls · 2016-07-04T22:22:36Z

Coverage increased (+1.8%) to 69.325% when pulling e8299cd on manikmagar:mm-jbake-categories into 7248d37 on jbake-org:master.

coveralls · 2016-07-04T22:22:36Z

Coverage increased (+1.8%) to 69.325% when pulling e8299cd on manikmagar:mm-jbake-categories into 7248d37 on jbake-org:master.

coveralls · 2016-07-04T22:45:49Z

Coverage increased (+1.6%) to 69.141% when pulling b192546 on manikmagar:mm-jbake-categories into 7248d37 on jbake-org:master.

jonbullock · 2016-09-26T12:29:14Z

Thanks for taking the time to submit this @manikmagar I'll review this properly once v2.5.0 is out and planning starts for the next release.

manikmagar · 2017-05-08T14:15:07Z

@jonbullock Any date for 3.0 release? This is one of the few things that's either requiring me to use my own version of jbake or just skip categories and use tags (not so much good option). I would prefer to use standard jbake version :) Thanks.

jonbullock · 2017-05-12T18:44:25Z

No date planned at present. However I'm leaning towards having a 2.7.0 release, especially as some big changes are lined up for 3.0.0 and this would be an ideal candidate for another 2.x release.

manikmagar · 2017-05-12T19:33:22Z

Thank you @jonbullock , I will eagerly be waiting for 2.7.0 👍

manikmagar · 2017-05-25T14:03:17Z

This was implemented a while back (on maven), I think I will rebase to current master and update it.

jonbullock · 2017-06-05T21:41:49Z

It would be great if you could thanks @manikmagar

coveralls · 2017-06-08T04:00:51Z

Coverage increased (+0.6%) to 79.068% when pulling d602719 on manikmagar:mm-jbake-categories into 1733a2a on jbake-org:master.

georgleber

The category view is a very good extension. I want to make only a few suggestions.

georgleber · 2017-07-03T14:53:44Z

src/main/java/org/jbake/app/ContentStore.java

+    	DocumentList docs = this.getAllCategoriesFromPublishedPosts();
+	    Set<String> result = new HashSet<String>();
+	    for (Map<String, Object> document : docs) {
+	        String[] categories = DBUtil.toStringArray(document.get("categories"));


Better to reference the crawler attribute instead of using a hard coded string value: Crawler.Attributes.CATEGORIES

Good catch @GeorgHenkel, Thanks. I will make the changes.

georgleber · 2017-07-03T14:55:13Z

src/main/java/org/jbake/parser/MarkupEngine.java

@@ -140,6 +141,31 @@ public void processBody(final ParserContext context) {}
            content.put(Crawler.Attributes.TAGS, tags);
        }

+    	// If categories are not disabled then add a default category
+		if(config.getBoolean(Keys.CATEGORIES_ENABLE)){
+			if (content.get("categories") != null) {


Also here it would be better to use Crawler.Attributes.CATEGORIES instead of a string.

georgleber · 2017-07-03T14:55:36Z

src/main/java/org/jbake/parser/MarkupEngine.java

+	                	categories[i]=categories[i].replace(" ", "-");
+	                }
+	            }
+	            content.put("categories", categories);


Also here it would be better to use Crawler.Attributes.CATEGORIES instead of the string value "categories"

georgleber · 2017-07-03T15:06:26Z

src/main/java/org/jbake/parser/MarkupEngine.java

+        		if (config.getBoolean(Keys.CATEGORY_SANITIZE,false)) {
+        			defaultCategory = defaultCategory.replace(" ", "-");
+                }
+        		content.put("categories", ArrayUtils.toArray(defaultCategory));


Also here it would be better to use Crawler.Attributes.CATEGORIES instead of the string value "categories"

georgleber · 2017-07-03T15:06:54Z

src/main/java/org/jbake/parser/MarkupEngine.java

+	        }
+			content.put("primary_category", ((String[])content.get("categories"))[0]);
+        } else {
+        	if (content.get("categories") != null) {


Also here it would be better to use Crawler.Attributes.CATEGORIES instead of the string value "categories"

…bake into mm-jbake-categories

manikmagar mentioned this pull request Jun 27, 2016

Implementing JBake Categories Support manikmagar/jbake#1

Merged

manikmagar mentioned this pull request Sep 14, 2016

Permlinks, Categories and Pagination? #284

Closed

jonbullock added the enhancement label Sep 26, 2016

jonbullock added this to the v3.0.0 milestone Sep 26, 2016

jonbullock self-assigned this Sep 26, 2016

This was referenced May 8, 2017

Make tagged documents data available as global data. #350

Closed

Add rendering support to generate /tags homepage #351

Closed

manikmagar added 3 commits May 24, 2017 23:14

Implemented Categories feature

c56e6c8

Updated for extensionless categories

78ef260

Corrected the root path for categories

5c8fd60

manikmagar added 2 commits June 7, 2017 23:40

Rebased with master

d602719

Merge branch 'master' into mm-jbake-categories

f07b85b

manikmagar force-pushed the mm-jbake-categories branch from b192546 to d602719 Compare June 8, 2017 03:56

georgleber suggested changes Jul 3, 2017

View reviewed changes

manikmagar added 3 commits July 5, 2017 20:24

Removed hardcoded strings and added test cases

f6cd76d

Removed hardcoded strings and added test cases

8415647

Merge branch 'mm-jbake-categories' of https://github.com/manikmagar/j…

27f41eb

…bake into mm-jbake-categories

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented Categories Support #293

Implemented Categories Support #293

manikmagar commented Jun 25, 2016

coveralls commented Jun 25, 2016 •

edited

coveralls commented Jul 4, 2016

coveralls commented Jul 4, 2016

coveralls commented Jul 4, 2016

coveralls commented Jul 4, 2016 •

edited

jonbullock commented Sep 26, 2016

manikmagar commented May 8, 2017

jonbullock commented May 12, 2017 •

edited

manikmagar commented May 12, 2017

manikmagar commented May 25, 2017

jonbullock commented Jun 5, 2017

coveralls commented Jun 8, 2017

georgleber left a comment

georgleber Jul 3, 2017

manikmagar Jul 4, 2017

georgleber Jul 3, 2017

georgleber Jul 3, 2017

georgleber Jul 3, 2017

georgleber Jul 3, 2017

Implemented Categories Support #293

Are you sure you want to change the base?

Implemented Categories Support #293

Conversation

manikmagar commented Jun 25, 2016

Categories configuration controls -

Adding categories in content

Accessing categories in templates

Extensionless Support

Test cases

coveralls commented Jun 25, 2016 • edited

coveralls commented Jul 4, 2016

coveralls commented Jul 4, 2016

coveralls commented Jul 4, 2016

coveralls commented Jul 4, 2016 • edited

jonbullock commented Sep 26, 2016

manikmagar commented May 8, 2017

jonbullock commented May 12, 2017 • edited

manikmagar commented May 12, 2017

manikmagar commented May 25, 2017

jonbullock commented Jun 5, 2017

coveralls commented Jun 8, 2017

georgleber left a comment

Choose a reason for hiding this comment

georgleber Jul 3, 2017

Choose a reason for hiding this comment

manikmagar Jul 4, 2017

Choose a reason for hiding this comment

georgleber Jul 3, 2017

Choose a reason for hiding this comment

georgleber Jul 3, 2017

Choose a reason for hiding this comment

georgleber Jul 3, 2017

Choose a reason for hiding this comment

georgleber Jul 3, 2017

Choose a reason for hiding this comment

coveralls commented Jun 25, 2016 •

edited

coveralls commented Jul 4, 2016 •

edited

jonbullock commented May 12, 2017 •

edited