├── .gitignore
├── LICENSE
├── jquery.ghostrelated.min.js
├── README.md
└── jquery.ghostrelated.js


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | .DS_Store
3 | index.html
4 | test.xml


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2014 Dane Grant
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/jquery.ghostrelated.min.js:
--------------------------------------------------------------------------------
1 | (function($){defaults={feed:"/rss",titleClass:".post-title",tagsClass:".post-meta",limit:5,debug:false,template:'<li><a href="{url}">{title}</a></li>',messages:{noRelated:"No related posts were found."}};function RelatedPosts(element,options){this.element=element;this.options=$.extend({},defaults,options);this.parseRss()}RelatedPosts.prototype.displayRelated=function(posts){var self=this,count=0;this._currentPostTags=this.getCurrentPostTags(this.options.tagsClass);var related=this.matchByTag(this._currentPostTags,posts);var options=this.options;related.forEach(function(post){var template=options.template.replace(/{[^{}]+}/g,function(key){return post[key.replace(/[{}]+/g,"")]||""});if(count<self.options.limit){$(self.element).append($(template))}count++});if(count==0){$(this.element).append($("<li>"+this.messages.noRelated+"</li>"))}};RelatedPosts.prototype.parseRss=function(pageNum,prevId,feeds){var page=pageNum||1,prevId=prevId||"",feeds=feeds||[],self=this;$.ajax({url:this.options.feed+"/"+page,type:"GET"}).done(function(data,textStatus,xhr){var curId=$(data).find("item > guid").text();if(curId!=prevId){feeds.push(data);self.parseRss(page+1,curId,feeds)}else{var posts=self.getPosts(feeds);self.displayRelated(posts)}}).fail(function(e){self.reportError(e)})};RelatedPosts.prototype.getCurrentPostTitle=function(titleClass){if(titleClass[0]!="."){titleClass="."+titleClass}var postTitle=$(titleClass).text();if(postTitle.length<1){this.reportError("Couldn't find the post title with class: "+titleClass)}return postTitle};RelatedPosts.prototype.getCurrentPostTags=function(tagsClass){if(tagsClass[0]!="."){tagsClass="."+tagsClass}var tags=[];$(tagsClass+" a").each(function(){tags.push($(this).text())});if(tags.length<1){this.reportError("Couldn't find any tags in this post")}return tags};RelatedPosts.prototype.getPosts=function(feeds){var posts=[],items=[];feeds.forEach(function(feed){items=$.merge(items,$(feed).find("item"))});for(var i=0;i<items.length;i++){var item=$(items[i]);if(item.find("title").text()!==this.getCurrentPostTitle(this.options.titleClass)){posts.push({title:item.find("title").text(),url:item.find("link").text(),content:item.find("description").text(),tags:$.map(item.find("category"),function(elem){return $(elem).text()})})}}if(posts.length<1){this.reportError("Couldn't find any posts in feed: "+feed)}return posts};RelatedPosts.prototype.matchByTag=function(postTags,posts){var matches=[];posts.forEach(function(post){var beenAdded=false;post.tags.forEach(function(tag){postTags.forEach(function(postTag){if(postTag.toLowerCase()===tag.toLowerCase()&&!beenAdded){matches.push(post);beenAdded=true}})})});if(matches.length<1){this.reportError("There are no closely related posts")}return matches};RelatedPosts.prototype.reportError=function(error){if(this.options.debug){$(this.element).append($("<li>"+error+"</li>"))}};$.fn.ghostRelated=function(options){return this.each(function(){new RelatedPosts(this,options)})}})(jQuery);


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | jquery.ghostrelated
  2 | ===================
  3 | 
  4 | This jQuery plugin displays a list of related posts for the Ghost blogging platform. 
  5 | 
  6 | ## How it works
  7 | 
  8 | Ghost Related parses your blogs rss feed and matches the current post with posts from your blog that have any tags in common. You will need to attach the plugin to an unordered or ordered list in your post.hbs template to output the related posts
  9 | 
 10 | ## Installation
 11 | 
 12 | 1. Download jquery.ghostrelated.js or jquery.ghostrelated.min.js and save it to the js folder in your theme directory.
 13 | 2. Include the script below `{{ghost_foot}}` in your themes default.hbs file `<script src="/assets/js/jquery.ghostrelated.min.js"></script>`
 14 | ```html
 15 | {{! Ghost outputs important scripts and data with this tag (jquery is included in ghost_foot) }}
 16 | {{ghost_foot}}
 17 | ```
 18 | 
 19 | <script type="text/javascript" src="/assets/js/main.js"></script>
 20 | <script type="text/javascript" src="/assets/js/ghostrelated.min.js"></script>
 21 | 
 22 | 3. Add an ordered or unordered list with a class identifier (related-posts is the default class identifier) in your post.hbs template file. 
 23 | ```html
 24 |     <ul class="related-posts">
 25 |     </ul>
 26 | </footer>
 27 | {{/post}}
 28 | ```
 29 |         
 30 | 4. Call the ghostrelated plugin on the list class identifier that you created in step 3 somewhere in your main js file
 31 | ```javascript
 32 | $('.related-posts').ghostRelated();
 33 | ```
 34 |         
 35 | 
 36 | ## Options
 37 | The theme has some default options defined for you. Based on your theme you may need to override some of these when you initiate the plugin
 38 | ```javascript
 39 | defaults = {
 40 |     feed: '/rss',
 41 |     titleClass: '.post-title',
 42 |     tagsClass: '.post-meta',
 43 |     debug: false,
 44 |     template: '<li><a href="{url}">{title}</a></li>',
 45 |     messages: {
 46 |         noRelated: 'No related posts were found.'
 47 |     }
 48 | }
 49 | ```
 50 |             
 51 | #### feed:
 52 | This is the location of the rss feed for your blog. Ghost uses /rss, so you shouldn't need to change this.
 53 | 
 54 | #### titleClass:
 55 | This is the class identifier for the heading element for your single post title. This makes sure that the post that is currently being read does not come back as a related post.
 56 | 
 57 | Ghost's default casper theme uses: `<h2 class="post-title">Title of current post</h2>` by default.
 58 | 
 59 | #### tagsClass: 
 60 | This is the class identifier for the element that the current post tags are in. This is used to grab the current post tags and match them against other posts.
 61 | 
 62 | It looks like this in casper: 
 63 | ```html
 64 | <span class="post-meta">
 65 |     <time datetime="2014-07-03">03 Jul 2014</time> on 
 66 |     <a href="/tag/getting-started/">Getting Started</a> | 
 67 |     <a href="/tag/another-tag/">Another Tag</a>
 68 | </span>
 69 | ```
 70 |         
 71 | So the option uses .post-meta and the plugin looks for the anchor tags inside of it
 72 | 
 73 | #### limit:
 74 | 
 75 | Limit amount of related posts to be displayed
 76 | 
 77 | #### debug:
 78 | 
 79 | If the plugin isn't returning any related posts, set this option to true. This option will output error information to the list you created to help you figure out why the plugin is failing.
 80 | 
 81 | #### template:
 82 | 
 83 | Specify the template for the related posts. You have access to all variables within the `post` object from the RSS feed, and you can echo them by wrapping them in braces.
 84 | 
 85 | ## Start with custom options
 86 | 
 87 | ```javascript
 88 | $('.related-posts').ghostRelated({
 89 |     titleClass: '.my-title',
 90 |     tagsClass: '.my-tags-class',
 91 |     template: '<a href="{url}" class="panel panel-default"><div class="panel-heading">{title}</div></div>'
 92 | });
 93 | ```
 94 |             
 95 |             
 96 | ## Roadmap
 97 | * More advanced post matching
 98 | 
 99 | ## Browser Support
100 | This plugin officially supports IE9+. You can include this [polyfill](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach#Polyfill) in your theme for any browsers that don't support the JavaScript forEach() funciton.
101 | 
102 | ## Credits
103 | * Inspired by [jquery.ghostHunter](https://github.com/i11ume/ghostHunter) - *an amazing search plugin for Ghost* 
104 | 


--------------------------------------------------------------------------------
/jquery.ghostrelated.js:
--------------------------------------------------------------------------------
  1 | /*!
  2 |  * @package jquery.ghostrelated
  3 |  * @version 0.2.0
  4 |  * @Copyright (C) 2014 Dane Grant (danecando@gmail.com)
  5 |  * @License MIT
  6 |  */
  7 | ;(function($) {
  8 | 
  9 |     defaults = {
 10 |         feed: '/rss',
 11 |         titleClass: '.post-title',
 12 |         tagsClass: '.post-meta',
 13 |         limit: 5,
 14 |         debug: false,
 15 |         template: '<li><a href="{url}">{title}</a></li>',
 16 |         messages: {
 17 |             noRelated: 'No related posts were found.'
 18 |         }
 19 |     };
 20 | 
 21 | 
 22 |     function RelatedPosts(element, options) {
 23 | 
 24 |         this.element = element;
 25 |         this.options = $.extend({}, defaults, options);
 26 | 
 27 |         this.parseRss();
 28 |     };
 29 | 
 30 |     RelatedPosts.prototype.displayRelated = function(posts) {
 31 | 
 32 |         var self = this,
 33 |             count = 0;
 34 | 
 35 |         this._currentPostTags = this.getCurrentPostTags(this.options.tagsClass);
 36 | 
 37 |         var related = this.matchByTag(this._currentPostTags, posts);
 38 | 
 39 |         var options = this.options;
 40 | 
 41 |         related.forEach(function(post) {
 42 |             var template = options.template.replace(/{[^{}]+}/g, function (key) {
 43 |                 return post[key.replace(/[{}]+/g, '')] || '';
 44 |             });
 45 | 
 46 |             if (count < self.options.limit) {
 47 |                 $(self.element).append($(template));
 48 |             }
 49 |             count++;
 50 |         });
 51 | 
 52 |         if (count == 0) {
 53 |             $(this.element).append($('<li>' + this.messages.noRelated + '</li>'));
 54 |         }
 55 | 
 56 |     };
 57 | 
 58 |     RelatedPosts.prototype.parseRss = function(pageNum, prevId, feeds) {
 59 | 
 60 |         var page = pageNum || 1,
 61 |             prevId = prevId || '',
 62 |             feeds = feeds || [],
 63 |             self = this;
 64 | 
 65 |         $.ajax({
 66 |             url: this.options.feed + '/' + page,
 67 |             type: 'GET'
 68 |         })
 69 |         .done(function(data, textStatus, xhr) {
 70 | 
 71 |             var curId = $(data).find('item > guid').text();
 72 | 
 73 |             if (curId != prevId) {
 74 |                 feeds.push(data);
 75 |                 self.parseRss(page+1, curId, feeds);
 76 |             } else {
 77 |                 var posts = self.getPosts(feeds);
 78 |                 self.displayRelated(posts);
 79 |             }
 80 | 
 81 |         })
 82 |         .fail(function(e) {
 83 |             self.reportError(e);
 84 |         });
 85 | 
 86 |     };
 87 | 
 88 |     RelatedPosts.prototype.getCurrentPostTitle = function(titleClass) {
 89 | 
 90 |         if (titleClass[0] != '.') {
 91 |             titleClass = '.' + titleClass;
 92 |         }
 93 | 
 94 |         var postTitle = $(titleClass).text();
 95 | 
 96 |         if (postTitle.length < 1) {
 97 |             this.reportError("Couldn't find the post title with class: " + titleClass);
 98 |         }
 99 | 
100 |         return postTitle;
101 |     };
102 | 
103 | 
104 |     RelatedPosts.prototype.getCurrentPostTags = function(tagsClass) {
105 | 
106 |         if (tagsClass[0] != '.') {
107 |             tagsClass = '.' + tagsClass;
108 |         }
109 | 
110 |         var tags = [];
111 |         $(tagsClass + ' a').each(function() {
112 |             tags.push($(this).text());
113 |         });
114 | 
115 |         if (tags.length < 1) {
116 |             this.reportError("Couldn't find any tags in this post");
117 |         }
118 | 
119 |         return tags;
120 |     };
121 | 
122 | 
123 |     RelatedPosts.prototype.getPosts = function(feeds) {
124 | 
125 |         var posts = [], items = [];
126 | 
127 |         feeds.forEach(function(feed) {
128 |             items = $.merge(items, $(feed).find('item'));
129 |         });
130 | 
131 |         for (var i = 0; i < items.length; i++) {
132 | 
133 |             var item = $(items[i]);
134 | 
135 |             if (item.find('title').text() !== this.getCurrentPostTitle(this.options.titleClass)) {
136 | 
137 |                 posts.push({
138 |                     title: item.find('title').text(),
139 |                     url: item.find('link').text(),
140 |                     content: item.find('description').text(),
141 |                     tags: $.map(item.find('category'), function(elem) {
142 |                         return $(elem).text();
143 |                     })
144 |                 });
145 |             }
146 |         }
147 | 
148 |         if (posts.length < 1) {
149 |             this.reportError("Couldn't find any posts in feed: " + feed);
150 |         }
151 | 
152 |         return posts;
153 |     };
154 | 
155 | 
156 |     RelatedPosts.prototype.matchByTag = function(postTags, posts) {
157 | 
158 |         var matches = [];
159 | 
160 |         posts.forEach(function(post) {
161 | 
162 |             var beenAdded = false;
163 |             post.tags.forEach(function(tag) {
164 | 
165 |                 postTags.forEach(function(postTag) {
166 | 
167 |                     if (postTag.toLowerCase() === tag.toLowerCase() && !beenAdded) {
168 |                         matches.push(post);
169 |                         beenAdded = true;
170 |                     }
171 |                 });
172 |             });
173 |         });
174 | 
175 |         if (matches.length < 1) {
176 |             this.reportError("There are no closely related posts");
177 |         }
178 | 
179 |         return matches;
180 |     };
181 | 
182 | 
183 |     RelatedPosts.prototype.reportError = function(error) {
184 |         if (this.options.debug) {
185 |             $(this.element).append($('<li>' + error + '</li>'));
186 |         }
187 |     };
188 | 
189 | 
190 |     $.fn.ghostRelated = function(options) {
191 | 
192 |         return this.each(function() {
193 |             new RelatedPosts(this, options);
194 |         });
195 |     };
196 | 
197 | 
198 | })(jQuery);


--------------------------------------------------------------------------------