├── .gitignore ├── LICENSE ├── README.md ├── jekyll-random.gemspec └── lib └── jekyll-random.rb /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | /.config 4 | /coverage/ 5 | /InstalledFiles 6 | /pkg/ 7 | /spec/reports/ 8 | /spec/examples.txt 9 | /test/tmp/ 10 | /test/version_tmp/ 11 | /tmp/ 12 | .idea/ 13 | 14 | # Used by dotenv library to load environment variables. 15 | # .env 16 | 17 | ## Specific to RubyMotion: 18 | .dat* 19 | .repl_history 20 | build/ 21 | *.bridgesupport 22 | build-iPhoneOS/ 23 | build-iPhoneSimulator/ 24 | 25 | ## Specific to RubyMotion (use of CocoaPods): 26 | # 27 | # We recommend against adding the Pods directory to your .gitignore. However 28 | # you should judge for yourself, the pros and cons are mentioned at: 29 | # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control 30 | # 31 | # vendor/Pods/ 32 | 33 | ## Documentation cache and generated files: 34 | /.yardoc/ 35 | /_yardoc/ 36 | /doc/ 37 | /rdoc/ 38 | 39 | ## Environment normalization: 40 | /.bundle/ 41 | /vendor/bundle 42 | /lib/bundler/man/ 43 | 44 | # for a library or gem, you might want to ignore these files since the code is 45 | # intended to run in multiple environments; otherwise, check them in: 46 | # Gemfile.lock 47 | # .ruby-version 48 | # .ruby-gemset 49 | 50 | # unless supporting rvm < 1.11.0 or doing something fancy, ignore this: 51 | .rvmrc 52 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 Paweł Kuna 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. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jekyll-Random 2 | 3 | A Jekyll plugin that generates _pseudo-random_ data. Very useful when you want to generate a large amount of random data. The plugin is prepared to work with other Jekyll plugins like `jekyll-timeago` or `jekyll-humanize`. 4 | 5 | **The data is generated based on index, so that every time when you run `jekyll build`, the generated data is the same.** 6 | 7 | [![Gem Version](https://badge.fury.io/rb/jekyll-random.svg)](https://badge.fury.io/rb/jekyll-random) 8 | 9 | 10 | ## Installation 11 | 12 | 1. Add the following to your site's `Gemfile`: 13 | 14 | ```ruby 15 | gem 'jekyll-random' 16 | ``` 17 | 18 | 2. Add the following to your site's `_config.yml`: 19 | 20 | ```yml 21 | plugins: 22 | - jekyll-random 23 | ``` 24 | 25 | If you are using a Jekyll version less than `3.5.0`, use the `gems` key instead of `plugins`. 26 | 27 | ### Manual installation 28 | 29 | Simply download the `lib/jekyll-random.rb` file and place it in the `_plugins` directory of your Jekyll site. 30 | 31 | 32 | ## Usage 33 | 34 | Each of the methods in the file presents an available Fluid type filter to be used in Jekyll templates. Thanks to this you can manipulate the generated data. 35 | 36 | ### random_number(_index_, _min=0_, _max=100_, _round=0_) 37 | 38 | Return a number between _min_ and _max_ based on _index_. By default it returns a number between 0 and 100. 39 | 40 | ```ruby 41 | {% for i in (1..100) %} 42 | {{ i }} - {{ forloop.index | random_number: 0, 10 }} 43 | {% endfor %} 44 | ``` 45 | 46 | The code above returns random numbers like: 47 | 48 | ``` 49 | 1 - 6 50 | 2 - 1 51 | 3 - 6 52 | 4 - 8 53 | 5 - 4 54 | 6 - 7 55 | 7 - 1 56 | ... 57 | ``` 58 | 59 | You can also change the `round` parameter to generate fractions: 60 | 61 | ```ruby 62 | {% for i in (1..100) %} 63 | {{ i }} - {{ forloop.index | random_number: 0, 100, 2 }} 64 | {% endfor %} 65 | ``` 66 | 67 | The result of code above: 68 | 69 | ``` 70 | 1 - 42.98 71 | 2 - 0.08 72 | 3 - 96.59 73 | 4 - 6.81 74 | 5 - 36.91 75 | 6 - 7.06 76 | 7 - 80.38 77 | ... 78 | ``` 79 | 80 | ### random_item(_index_, _items_) 81 | 82 | Return random item from _items_ array based on _index_. _items_ can be array, collection, or data file. 83 | 84 | ```ruby 85 | {% assign colors = 'red|green|blue|yellow|orange' | split: '|' %} 86 | {% for i in (1..100) %} 87 | {{ i }} - {{ forloop.index | random_item: colors }} 88 | {% endfor %} 89 | ``` 90 | 91 | The results: 92 | 93 | ``` 94 | 1 - blue 95 | 2 - blue 96 | 3 - red 97 | 4 - yellow 98 | 5 - yellow 99 | 6 - red 100 | 7 - red 101 | 8 - yellow 102 | ... 103 | ``` 104 | 105 | ### random_date(_index_, _start_date=false_, _end_date=false_) 106 | 107 | Return random date between _start_date_ and _end_date_. By default, it returns the date between 100 days ago and now. Returned date you can format by `date` filter to get expected result. This filter is useful when you generate birth date or register date. 108 | 109 | ```ruby 110 | {% for i in (1..100) %} 111 | {{ i }} - {{ forloop.index | random_date: "2010-01-01", "2018-01-01" | date: '%B %d, %Y' }} 112 | {% endfor %} 113 | ``` 114 | 115 | ``` 116 | 1 - May 23, 2016 117 | 2 - January 31, 2017 118 | 3 - August 10, 2014 119 | 4 - December 08, 2016 120 | 5 - January 22, 2016 121 | 6 - November 16, 2015 122 | 7 - June 09, 2013 123 | ... 124 | ``` 125 | 126 | ### random_date_ago(_index_, _days_ago=100_) 127 | 128 | This filter works similar to `random_date`, but returns random date between today and date _days_ago_ ago. By default return date between now and 100 days ago. It is helpful to generate random data like last login date. If you additionally use the `jekyll-timeago` filter you can get date in _2 days ago_ format. 129 | 130 | ```ruby 131 | {% for i in (1..100) %} 132 | {{ i }} - {{ forloop.index | random_date_ago: 10 | timeago }} 133 | {% endfor %} 134 | ``` 135 | 136 | Results: 137 | 138 | ``` 139 | 1 - 6 days ago 140 | 2 - yesterday 141 | 3 - 6 days ago 142 | 4 - 1 week ago 143 | 5 - 4 days ago 144 | 6 - 1 week ago 145 | 7 - yesterday 146 | ... 147 | ``` 148 | 149 | You can also change _days_ago_ parameter to negative number like `{{ forloop.index | random_date_ago: -10 | timeago }}` to get date in future: 150 | 151 | ``` 152 | 1 - today 153 | 2 - in 1 week 154 | 3 - tomorrow 155 | 4 - tomorrow 156 | 5 - in 2 days 157 | 6 - in 2 days 158 | 7 - in 4 days 159 | 8 - in 5 days 160 | 9 - in 1 week 161 | ... 162 | ``` 163 | 164 | ## Generate data based on the same index 165 | 166 | Sometimes you want to generate data in the same row with the same parameters. Because this plugin generate pseudo-random data every returned number will be the same: 167 | 168 | ```ruby 169 | {% for i in (1..5) %} 170 | {{ i }} - {{ forloop.index | random_number }}, {{ forloop.index | random_number }}, {{ forloop.index | random_number }} 171 | {% endfor %} 172 | ``` 173 | 174 | The above code returns a code that does not meet our expectations, because every time returns the same data: 175 | 176 | ``` 177 | 1 - 42, 42, 42 178 | 2 - 0, 0, 0 179 | 3 - 96, 96, 96 180 | 4 - 6, 6, 6 181 | 5 - 36, 36, 36 182 | ... 183 | ``` 184 | 185 | To fix it, simply add a random number to `index` parameter: `{{ forloop.index | plus: 156 | random_number }}`. Thanks to this the results will be different to every index. 186 | 187 | ``` 188 | 1 - 42 - 47 - 55 189 | 2 - 0 - 87 - 96 190 | 3 - 96 - 15 - 81 191 | 4 - 6 - 12 - 59 192 | 5 - 36 - 8 - 20 193 | ... 194 | ``` 195 | 196 | ## Sample code 197 | 198 | To see how useful this plugin is, try to run the code below. Remember to set few random data in `_config.yml` file: 199 | 200 | ```yml 201 | users: 202 | - name: Tate 203 | surname: Nesfield 204 | email: tnesfield0@scribd.com 205 | - name: Thelma 206 | surname: Muirden 207 | email: tmuirden1@google.com 208 | ... 209 | 210 | commits: 211 | - Push poorly written test can down the road another ten years 212 | - This will definitely break in 2020 (TODO) 213 | ... 214 | ``` 215 | 216 | _index.html_ 217 | 218 | ```html 219 | {% assign colors = 'red|green|blue|yellow|orange' | split: '|' %} 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | {% for user in site.users %} 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | {% endfor %} 245 |
IDNameEmailPercentageAgeStatusRegister dateLast loginCommit
{{ forloop.index }}{{ user.name }} {{ user.surname }}{{ user.email }}{{ forloop.index | random_number }}%{{ forloop.index | random_number: 25, 55 }}{{ forloop.index | random_item: colors }}{{ forloop.index | random_date: "2010-01-01", "2018-01-01" | date: '%B %d, %Y' }}{{ forloop.index | random_date_ago: 10 | timeago }}{{ site.commits[forloop.index] }}
246 | ``` 247 | 248 | Results: 249 | 250 | ``` 251 | ID Name Email Percentage Age Status Register date Last login Commit 252 | 1 Tate Nesfield tnesfield0@scribd.com 42% 31 blue May 23, 2016 6 days ago This will definitely break in 2020 (TODO) 253 | 2 Thelma Muirden tmuirden1@google.com 0% 50 green January 31, 2017 yesterday yet another quality commit 254 | 3 Ros Rawstorne rrawstorne2@furl.net 96% 37 red August 10, 2014 6 days ago fuckup. 255 | 4 Marco Newburn mnewburn3@eventbrite.com 6% 47 blue December 08, 2016 1 week ago some brief changes 256 | 5 Tessie Lack tlack4@nytimes.com 36% 33 green January 22, 2016 4 days ago herpderp (redux) 257 | 6 Cinderella Illwell cillwell5@mayoclinic.com 7% 28 red November 16, 2015 1 week ago PEBKAC 258 | 7 Jermaine Marston jmarston6@independent.co.uk 80% 40 green June 09, 2013 yesterday Hide those navs, boi! 259 | 8 Harlan Oliveti holiveti7@cam.ac.uk 83% 26 blue May 31, 2013 2 days ago I'm totally adding this to epic win. +300 260 | 9 Lillis Riddler lriddler8@de.vu 73% 27 green July 31, 2011 1 week ago Bit Bucket is down. What should I do now? 261 | 10 Marlowe Rabson mrabson9@wufoo.com 79% 31 green October 08, 2013 3 days ago This really should not take 19 minutes to build. 262 | 11 Vera Doggart vdoggarta@fastcompany.com 94% 36 red July 28, 2014 6 days ago This is why the cat shouldn't sit on my keyboard. 263 | 12 Lari Webling lweblingb@umn.edu 90% 39 red April 29, 2013 3 days ago The same thing we do every night, Pinky - try to take over the world! 264 | 13 Annabela Apps aappsc@lulu.com 8% 32 green December 02, 2013 1 week ago Does this work 265 | 14 Hurlee Teaser hteaserd@webeden.co.uk 44% 31 green August 03, 2011 4 days ago Some bugs fixed 266 | 15 Natty Blois nbloise@zdnet.com 0% 36 green June 16, 2016 5 days ago I was wrong... 267 | ``` 268 | 269 | ## Development 270 | 271 | Any kind of feedback, bug report, idea or enhancement are really appreciated. To contribute, just fork the repo, hack on it and send a pull request. 272 | 273 | ## License 274 | 275 | Copyright (c) Paweł Kuna. Jekyll-Random is released under the MIT License. 276 | 277 | ## Contribute 278 | 279 | 1. [Fork](https://github.com/codecalm/jekyll-random/fork) this repo. 280 | 2. Create a branch `git checkout -b my_feature` 281 | 3. Commit your changes `git commit -am "Added Feature"` 282 | 4. Push to the branch `git push origin my_feature` 283 | 5. Open a [Pull Request](https://github.com/codecalm/jekyll-random/pulls) -------------------------------------------------------------------------------- /jekyll-random.gemspec: -------------------------------------------------------------------------------- 1 | Gem::Specification.new do |s| 2 | s.name = "jekyll-random" 3 | s.version = "0.1" 4 | s.licenses = ['MIT'] 5 | s.summary = "A Jekyll plugin that generates pseudo-random data" 6 | s.description = "A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data." 7 | s.authors = ["Paweł Kuna"] 8 | s.email = 'codecalm@gmail.com' 9 | s.files = [ 10 | "lib/jekyll-random.rb" 11 | ] 12 | s.require_paths = ['lib'] 13 | s.homepage = 'https://github.com/codecalm/jekyll-random' 14 | 15 | s.add_runtime_dependency "jekyll", ">= 3.3", "< 5.0" 16 | end 17 | -------------------------------------------------------------------------------- /lib/jekyll-random.rb: -------------------------------------------------------------------------------- 1 | require "jekyll" 2 | 3 | module Jekyll 4 | module RandomFilter 5 | 6 | def random_number(x, min=0, max=100, round=0) 7 | value = ((x * x * Math::PI * Math::E * (max + 1) * (Math.sin(x) / Math.cos(x * x)) ) % (max + 1 - min)) + min 8 | 9 | value = value > max ? max : value 10 | value = value < min ? min : value 11 | 12 | if round != 0 13 | value = (('%.' + round.to_s + 'f') % value) 14 | else 15 | value = value.to_i 16 | end 17 | 18 | value 19 | end 20 | 21 | def random_item(x, items) 22 | index = random_number(x, 0, items.size) 23 | 24 | items[index] 25 | end 26 | 27 | def random_date(x, start_date=false, end_date=false) 28 | start_date = start_date ? Time.parse(start_date) : (Time.now - 60*60*24*100) 29 | end_date = end_date ? Time.parse(end_date) : Time.now 30 | 31 | Time.at(random_number(x, start_date.to_i, end_date.to_i)) 32 | end 33 | 34 | def random_date_ago(x, days_ago=100) 35 | Date.today.prev_day(random_number(x, 0, days_ago)) 36 | end 37 | end 38 | end 39 | 40 | Liquid::Template.register_filter(Jekyll::RandomFilter) 41 | --------------------------------------------------------------------------------