├── .gitignore ├── LICENSE ├── README.markdown └── posts-word-count.rb /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | /.config 4 | /coverage/ 5 | /InstalledFiles 6 | /pkg/ 7 | /spec/reports/ 8 | /test/tmp/ 9 | /test/version_tmp/ 10 | /tmp/ 11 | 12 | ## Specific to RubyMotion: 13 | .dat* 14 | .repl_history 15 | build/ 16 | 17 | ## Documentation cache and generated files: 18 | /.yardoc/ 19 | /_yardoc/ 20 | /doc/ 21 | /rdoc/ 22 | 23 | ## Environment normalisation: 24 | /.bundle/ 25 | /lib/bundler/man/ 26 | 27 | # for a library or gem, you might want to ignore these files since the code is 28 | # intended to run in multiple environments; otherwise, check them in: 29 | # Gemfile.lock 30 | # .ruby-version 31 | # .ruby-gemset 32 | 33 | # unless supporting rvm < 1.11.0 or doing something fancy, ignore this: 34 | .rvmrc 35 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | -------------------------------------------------------------------------------- /README.markdown: -------------------------------------------------------------------------------- 1 | # Jekyll-Posts-Word-Count 2 | 3 | [Jekyll](http://jekyllrb.com) plugin to give you the total / average word count, as well as shortest & longest post information across all posts. 4 | 5 | *By [Matt Gemmell](https://mattgemmell.com) / [Jake Lee](https://jakelee.co.uk), license: [CC0 Universal (public domain)](https://creativecommons.org/publicdomain/zero/1.0/deed.en)* 6 | 7 | ## Installation 8 | 9 | To install, copy the `posts-word-count.rb` file into your Jekyll `_plugins` folder. 10 | 11 | ## Usage 12 | 13 | For only published posts: `{% published_posts_word_count PARAM %}` 14 | 15 | For published & draft posts `{% posts_word_count PARAM %}` 16 | 17 | Where `PARAM` is one of: 18 | 19 | * `total` (total word count of all posts) 20 | * `average` (average word count across all posts) 21 | * `total_characters` (total character count of all posts) 22 | * `average_characters` (total average count of all posts) 23 | * `longest` (longest word count of any post) 24 | * `longest_post_index` (index in site.posts of longest post) 25 | * `longest_post_title` (title of longest post) 26 | * `longest_post_url` (url of longest post) 27 | * `shortest` (shortest word count of any post) 28 | * `shortest_post_index` (index in site.posts of shortest post) 29 | * `shortest_post_title` (title of shortest post) 30 | * `shortest_post_url` (url of shortest post) 31 | 32 | ## Example 33 | 34 | For example, a page displaying overall stats and the shortest & longest posts could include: 35 | 36 | ``` 37 | ### Totals 38 | 39 | Total site words: {% posts_word_count total %} (average {% posts_word_count average %} per post) 40 | 41 | Total site characters: {% posts_word_count total_characters %} (average {% posts_word_count average_characters %} per post) 42 | 43 | ### Published post records 44 | 45 | Longest post: {% published_posts_word_count longest_post_title %} ({% published_posts_word_count longest %} words) 46 | 47 | Shortest post: {% published_posts_word_count shortest_post_title %} ({% published_posts_word_count shortest %} words) 48 | ``` 49 | -------------------------------------------------------------------------------- /posts-word-count.rb: -------------------------------------------------------------------------------- 1 | # {% posts_word_count %} 2 | # Output some interesting word-count stats for your posts. 3 | # 4 | # To install, copy this file into your Jekyll/Octopress plugins folder 5 | # To use: {% posts_word_count PARAM %} for all posts, 6 | # or: {% published_posts_word_count PARAM %} for only non-draft posts. 7 | # 8 | # PARAM can be: 9 | # total (total word count of all posts) 10 | # average (average word count across all posts) 11 | # total_characters (total character count of all posts) 12 | # average_characters (total average count of all posts) 13 | # longest (longest word count of any post) 14 | # longest_post_index (index in site.posts of longest post) 15 | # longest_post_title (title of longest post) 16 | # longest_post_url (url of longest post) 17 | # shortest (shortest word count of any post) 18 | # shortest_post_index (index in site.posts of shortest post) 19 | # shortest_post_title (title of shortest post) 20 | # shortest_post_url (url of shortest post) 21 | 22 | class PostsWordCount < Liquid::Tag 23 | def initialize(tag, text, tokens) 24 | @total_word_count = 0 25 | @average_word_count = 0 26 | @total_character_count = 0 27 | @average_character_count = 0 28 | @longest_word_count = 0 29 | @longest_post_index = 0 30 | @shortest_word_count = 0 31 | @shortest_post_index = 0 32 | @tag = tag 33 | @text = text.strip 34 | @tokens = tokens 35 | end 36 | 37 | def render(context) 38 | the_result = nil 39 | all_posts = context.registers[:site].posts.docs # OLDEST first! 40 | all_posts.each_with_index { |this_post, index| 41 | next if all_posts[index].data["draft"] && @tag == "published_posts_word_count" 42 | 43 | num_words = word_count(this_post.content) 44 | @total_word_count += num_words 45 | 46 | num_chars = this_post.content.length 47 | @total_character_count += num_chars 48 | 49 | if num_words > @longest_word_count 50 | @longest_word_count = num_words 51 | @longest_post_index = all_posts.count - (index + 1) 52 | @longest_post_title = all_posts[index].data["title"] 53 | @longest_post_url = this_post.url 54 | end 55 | 56 | if num_words < @shortest_word_count || @shortest_word_count == 0 57 | @shortest_word_count = num_words 58 | @shortest_post_index = all_posts.count - (index + 1) 59 | @shortest_post_title = all_posts[index].data["title"] 60 | @shortest_post_url = this_post.url 61 | end 62 | } 63 | @average_word_count = @total_word_count / all_posts.count 64 | @average_character_count = @total_character_count / all_posts.count 65 | 66 | if @text == "total" 67 | the_result = @total_word_count 68 | elsif @text == "average" 69 | the_result = @average_word_count 70 | elsif @text == "total_characters" 71 | the_result = @total_character_count 72 | elsif @text == "average_characters" 73 | the_result = @average_character_count 74 | elsif @text == "longest" 75 | the_result = @longest_word_count 76 | elsif @text == "longest_post_index" 77 | the_result = @longest_post_index 78 | elsif @text == "longest_post_title" 79 | the_result = @longest_post_title 80 | elsif @text == "longest_post_url" 81 | the_result = @longest_post_url 82 | elsif @text == "shortest" 83 | the_result = @shortest_word_count 84 | elsif @text == "shortest_post_index" 85 | the_result = @shortest_post_index 86 | elsif @text == "shortest_post_title" 87 | the_result = @shortest_post_title 88 | elsif @text == "shortest_post_url" 89 | the_result = @shortest_post_url 90 | end 91 | 92 | return the_result 93 | end 94 | 95 | def word_count(string) 96 | # Simplistic, but agrees with Jekyll's number_of_words filter. 97 | return string.scan(/\S+/).count 98 | end 99 | end 100 | 101 | Liquid::Template.register_tag('posts_word_count', PostsWordCount) 102 | Liquid::Template.register_tag('published_posts_word_count', PostsWordCount) 103 | --------------------------------------------------------------------------------