peteshow 0.8.4 → 0.8.5

data/Gruntfile.js

@@ -24,6 +24,7 @@ module.exports = function(grunt) {
       srcFiles : [
         'src/peteshow.js',
         'src/peteshow-helpers.js',
+        'src/peteshow-storage.js',
         'src/peteshow-core.js'
       ]
     },

data/README.md

@@ -1,25 +1,102 @@
 # Peteshow
 
-Peteshow is a javascript plugin for filling out forms with fake data for testing purposes. You can configure the functionality by creating a custom plugin.
+> a customizable javascript framework for filling out forms with fake data
 
-![Imgur](http://i.imgur.com/E4OLrIx.png)
 
 ![Imgur](http://i.imgur.com/JcT5eMS.png)
 
-
 ## Getting Started
 See the [Wiki on GitHub](https://github.com/brousalis/peteshow/wiki) for documentation.
 
 - [Setup](https://github.com/brousalis/peteshow/wiki/Setup)
 - [Usage](https://github.com/brousalis/peteshow/wiki/Usage)
 - [Custom plugins](https://github.com/brousalis/peteshow/wiki/Custom-plugins)
-- [Customization](https://github.com/brousalis/peteshow/wiki/Customization)
 - [Plugin example](https://github.com/brousalis/peteshow/wiki/Plugin-example)
 - [Change log](https://github.com/brousalis/peteshow/wiki/Change-log)
 
 Also specific pages for frameworks:
 - [Ruby on Rails](https://github.com/brousalis/peteshow/wiki/Ruby-on-Rails-gem)
 
+## API
+
+#### `Peteshow.init()`
+
+Adds the seen above menu to the top left of your page. Press backtick <code>`</code> to toggle the menu.
+
+#### `Peteshow.fillOutForms()`
+
+Using the [default rules](https://github.com/brousalis/peteshow/blob/master/src/peteshow-core.js#L2), fills out inputs, checkboxes, selects, and radio buttons. While the menu is open, press `f` to call this method.
+
+#### `Peteshow.fillOutFormsAndSubmit()`
+
+Does the same as above, but also submits the form. Press `q` to call this method.
+
+---
+
+It also has several other methods exposed:
+
+Methods             | Description
+--------------------|------------------------------------------------
+`submitForm()`                | Submits the form on the page, can be customized
+`destroy()`                   | Removes the Peteshow menu from the dom
+`hide()`                      | Hides the Peteshow menu
+`show()`                      | Shows the Peteshow menu
+`formatDate(format, Date)`    | Returns a string with the specified format
+`randomChars(length, chars)`  | Returns a string made up of specific characters
+`randomDate(format)`          | Returns a random date string
+`randomEmail()`               | Returns a random email, customized using init options
+`randomLetters(length)`       | Returns random letters
+`randomNumber(length)`        | Returns a random number, you can pass an optional prefix
+`randomNumberRange(min,max)`  | Returns a number between `min` and `max`
+
+To access the stored values used in the [reuse](https://github.com/brousalis/peteshow/wiki/Custom-plugins#reuse) option, use `Peteshow.storage`:
+
+Methods             | Description
+--------------------|------------------------------------------------
+`storage.clear()`             | Clears saved fields from cookies and localstorage
+`storage.get()`               | Prints out the saved fields used in the `reuse` option
+`storage.set(hash)`           | Sets either cookie or localstorage, takes a hash
+
+## Default options
+
+Peteshow can be customized by creating a [custom plugin](https://github.com/brousalis/peteshow/wiki/Custom-plugins). Here are the default options:
+
+```javascript
+options = {
+  emailPrefix : 'test-',
+  emailDomain : 'example.com',
+  form        : '',
+  blur        : false,
+  cookies     : false,
+  rules       : {},
+  ignore      : [],
+  filter      : [],
+  force       : {},
+  reuse       : {},
+  commands    : '',
+  special     : function(){},
+  events      : function(){},
+}
+$(function() {
+  Peteshow.init(options)
+})
+```
+
+Name                  |  Description
+----------------------|---------------------------------------------------------------
+`emailPrefix`  | Prefix for your generated email addresses. Random numbers are added to the end
+`emailDomain`  | The domain for your generated email addresses
+`form`         | The selector of the form/forms you want to be filled out, defaults to last form on page
+`blur`         | Triggers blur() event after filling out an input
+`cookies`      | Store saved fields (from [reuse](https://github.com/brousalis/peteshow/wiki/Custom-plugins#reuse)) in cookies rather than localStorage
+[rules](https://github.com/brousalis/peteshow/wiki/Custom-plugins#rules)       | A hash of selectors to values that you want to be used when filling out forms. It ignores hidden inputs
+[special](https://github.com/brousalis/peteshow/wiki/Custom-plugins#special)   | Called after the rules are applied and can include custom javascript
+[ignore](https://github.com/brousalis/peteshow/wiki/Custom-plugins#ignore)     | An array of input IDs you wish to have fill out forms ignore
+[force](https://github.com/brousalis/peteshow/wiki/Custom-plugins#force)       | Similar to rules, but can be used for hidden inputs
+[filters](https://github.com/brousalis/peteshow/wiki/Custom-plugins#filter)    | Filters out options from select boxes
+[reuse](https://github.com/brousalis/peteshow/wiki/Custom-plugins#reuse)       | Define input selectors to be saved and reused on certain URLs
+[events](https://github.com/brousalis/peteshow/wiki/Custom-plugins#events)     | Used in the off chance you need to add extra javascript on Peteshow's init
+
 ### Further notes
 [![enova](https://www.enova.com/wp-content/uploads/2014/01/Enova-logo.jpg)](http://www.enova.com)
 
@@ -27,4 +104,4 @@ Developed by [Pete Brousalis](http://twitter.com/brousalis) in his spare time fo
 
 Special thanks to Matthew Bergman & Marak Squires for [Faker.js](http://github.com/marak/Faker.js/), Adam Gschwender for [jquery.formatDateTime](https://github.com/agschwender/jquery.formatDateTime), Klaus Hartl for [jquery.cookie](https://github.com/carhartl/jquery-cookie), all used by Peteshow.
 
-And to Donnie Hall for creating the original `Peepshow`, which I rewrote and rebranded.
+And especially Donnie Hall for creating the original `Peepshow`

data/dist/peteshow.js

@@ -1083,16 +1083,18 @@ Peteshow.defaults = {
   blur        : false,
   cookies     : false,
 
-  rules     : {},
-  ignore    : [],
-  filter    : [],
-  force     : {},
-  reuse     : {},
-  commands  : '',
-  special   : function(){},
-  events    : function(){},
+  rules       : {},
+  ignore      : [],
+  filter      : [],
+  force       : {},
+  reuse       : {},
+  commands    : '',
+  special     : function(){},
+  events      : function(){},
 }
 
+Peteshow.storage = {};
+
 window.Peteshow = Peteshow;
 
 +function($) {
@@ -1115,7 +1117,7 @@ window.Peteshow = Peteshow;
 
   Peteshow.randomNumberRange = function (min, max) {
     return function() {
-      return Math.floor(Math.random() * (max - min + 1)) + min;
+      return Math.floor(Math.random() * (max - min + 1)) + min
     }
   }
 
@@ -1156,6 +1158,76 @@ window.Peteshow = Peteshow;
 
 }(jQuery)
 
++function($) {
+  var cookies = false
+
+  Peteshow.storage.init = function(options) {
+    cookies = options.cookies
+  }
+
+  Peteshow.storage.set = function(data) {
+    data = JSON.stringify(data)
+
+    if(cookies)  $.cookie('peteshow', data, {domain: getDomain()})
+    else         localStorage.setItem('peteshow', data)
+  }
+
+  Peteshow.storage.get = function() {
+    var saved = cookies ? $.cookie('peteshow') : localStorage.getItem('peteshow')
+    return (saved != undefined || saved != null) ? JSON.parse(saved) : {}
+  }
+
+  Peteshow.storage.output = function() {
+    var base = ''
+
+    if(savedFieldsExist()) {
+      base += "<li class='list'>"
+        base += "<div class='inner'>"
+          $.each(Peteshow.storage.get(), function(k,v) {
+            base += '<div>' + k + '<span>' + v + '</span></div>'
+          })
+        base += "</div>"
+      base += "</li>"
+      base += "<li><a data-command='R' href='#' id='clear'>Clear stored</a></li>"
+    }
+
+    return base
+  }
+
+  Peteshow.storage.clear = function() {
+    clearLocalStorage()
+    clearCookies()
+    Peteshow.initCommands()
+  }
+
+  savedFieldsExist = function() {
+    var saved = cookies ? $.cookie('peteshow') : localStorage.getItem('peteshow')
+    return (saved != undefined || saved != null)
+  }
+
+  getDomain = function() {
+    // http://rossscrivener.co.uk/blog/javascript-get-domain-exclude-subdomain
+    var i=0, domain=document.domain, p=domain.split('.'), s='_gd'+(new Date()).getTime()
+    while(i<(p.length-1) && document.cookie.indexOf(s+'='+s)==-1){
+      domain = p.slice(-1-(++i)).join('.')
+      document.cookie = s+"="+s+";domain="+domain+";"
+    }
+    document.cookie = s+"=;expires=Thu, 01 Jan 1970 00:00:01 GMT;domain="+domain+";"
+    return domain == 'localhost' ? '' : domain
+  }
+
+  clearLocalStorage = function() {
+    localStorage.removeItem('peteshow')
+    Peteshow.initCommands()
+  }
+
+  clearCookies = function() {
+    $.removeCookie('peteshow', {domain: getDomain()})
+    Peteshow.initCommands()
+  }
+
+}(jQuery)
+
 +function($) {
   getDefaultRules = function() {
     return {
@@ -1205,28 +1277,9 @@ window.Peteshow = Peteshow;
 
     $('body').append($div)
 
-    initCommands()
-  }
+    Peteshow.initCommands()
 
-  Peteshow.destroy = function() {
-    Peteshow.hide()
-    $div.remove();
-  }
-
-  Peteshow.hide = function() {
-    $div.hide()
-    $div.removeClass('active')
-  }
-
-  Peteshow.toggle = function() {
-    $tools.toggle()
-    $div.toggleClass('active')
-  }
-
-  Peteshow.show = function() {
-    $div.show()
-    $tools.show()
-    if(!$div.hasClass('active')) $div.addClass('active')
+    Peteshow.storage.init(_options)
   }
 
   handleKeypress = function(e) {
@@ -1240,7 +1293,7 @@ window.Peteshow = Peteshow;
     if($.inArray(e.keyCode, [9,16,17,18, 91, 93, 224]) != -1) return
     if(e.metaKey) return
 
-    if(e.keyCode == 192) // `
+    if(e.keyCode == 192) // backtick
       Peteshow.toggle()
 
     var action  = $("[data-command='"+code+"']"),
@@ -1250,72 +1303,57 @@ window.Peteshow = Peteshow;
       action.click()
   }
 
-  initCommands = function() {
+  Peteshow.initCommands = function() {
     var base =  "<li><a data-command='F' href='#' id='fill-out-forms'>Fill Out Forms</a></li>"
         base += "<li><a data-command='Q' href='#' id='fill-out-forms-and-submit'>Fill Out and Submit</a></li>"
-        base += outputSavedFields()
+        base += Peteshow.storage.output()
         base += "<li><a data-command='H' href='#' id='hide-peteshow'>Hide</a></li>"
 
-    $div.find($commands).html(_options.commands + base)
-
-    bindEvents()
-  }
+    $commands.html(_options.commands + base)
 
-  bindEvents = function() {
+    // bind events
     var commands = [
-      [ $toggle,                          function() { Peteshow.toggle() } ],
-      [ $('#fill-out-forms'),             function() { Peteshow.fillOutForms() } ],
-      [ $('#fill-out-forms-and-submit'),  function() { Peteshow.fillOutForms(); Peteshow.submitForm() } ],
-      [ $('#clear'),                      function() { Peteshow.clearSaved(); } ],
-      [ $('#hide-peteshow'),              function() { Peteshow.hide() } ]
+      [ $toggle,                          Peteshow.toggle ],
+      [ $('#fill-out-forms'),             Peteshow.fillOutForms ],
+      [ $('#fill-out-forms-and-submit'),  Peteshow.fillOutFormsAndSubmit ],
+      [ $('#clear'),                      Peteshow.storage.clear ],
+      [ $('#hide-peteshow'),              Peteshow.hide ]
     ]
 
     $.each(commands, function() {
       var command = $(this)
       $(command[0]).on('click', function() {
-        command[1]()
-        return false
-      });
-    });
+        command[1](); return false
+      })
+    })
 
     _options.events()
   }
 
-  Peteshow.submitForm = function() {
-    $(_options.form).submit()
-    $('form[name*=registration], .simple_form').submit()
-    $('form').last().submit()
-  };
-
   Peteshow.fillOutForms = function() {
-    // checkbox
-    $('input[type=checkbox]').prop('checked', true)
+    var rules  = $.extend(true, getDefaultRules(), _options.rules || {})
 
-    // radio button
-    randomRadioValue()
+    $('input:checkbox').filterFields().prop('checked', true)
+
+    $('input:radio').each(randomRadioValue)
 
-    // select
     $('select').each(randomSelectValue)
 
-    // force rules
+    // force rules (for hidden fields)
     $.each(_options.force, function(element,v) {
       $(element)
-        .filter(function() { return _options.ignore.indexOf(this.id) === -1 })
+        .filterFields()
         .val($.isFunction(v) ? v() : v)
 
       if(_options.blur) $(element).blur()
     })
 
-    // apply rules
-    var rules   = $.extend(true, getDefaultRules(), _options.rules || {})
-        reused  = {},
-        saved   = Peteshow.getSavedFields()
-
-    // apply value to rule element, if visible and not in ignore list
+    // fill out fields with rules
     $.each(rules, function(element,v) {
-      $(element).filter(':visible')
-                .filter(function() { return _options.ignore.indexOf(this.id) === -1 })
-                .val($.isFunction(v) ? v() : v)
+      $(element)
+        .filter(':visible')
+        .filterFields()
+        .val($.isFunction(v) ? v() : v)
 
       if(_options.blur) $(element).blur()
     })
@@ -1323,15 +1361,24 @@ window.Peteshow = Peteshow;
     // special rules
     _options.special()
 
-    // reuse values
+    // localstorage functionality
+    reuseLocalStorage()
+  }
+
+  reuseLocalStorage = function() {
+    var reused  = {},
+        saved   = Peteshow.storage.get()
+
     $.each(_options.reuse, function(element,v) {
       var url = _options.reuse[element]
 
+      // exists on page
       if($(element).length > 0) {
-        // if element isnt in saved, save it
-        if(!(element in saved)) reused[element] = $(element).val()
+        // element isnt in saved, save it
+        if(!(element in saved))
+          reused[element] = $(element).val()
 
-        // if element is saved and we're not on the reused url, save it
+        // element is saved and we're not on the reused url, save it
         if((element in saved) && window.location.href.indexOf(url) < 0)
           reused[element] = $(element).val()
       }
@@ -1340,79 +1387,22 @@ window.Peteshow = Peteshow;
     // save if found rules to reuse
     if(!$.isEmptyObject(reused)) {
       $.extend(saved, reused)
-      Peteshow.setSavedFields(JSON.stringify(saved))
+      Peteshow.storage.set(saved)
     }
 
     // apply saved rule values if they exist and on the right page
     if(savedFieldsExist()) {
-      $.each(Peteshow.getSavedFields(), function(element,v) {
+      $.each(Peteshow.storage.get(), function(element,v) {
         var url = _options.reuse[element]
         if(window.location.href.indexOf(url) > -1) $(element).val(v)
       })
-      // reinit menu
-      initCommands()
-    }
-  }
-
-  outputSavedFields = function() {
-    var base = ''
 
-    if(savedFieldsExist()) {
-      base += "<li class='list'>"
-        base += "<div class='inner'>"
-          $.each(Peteshow.getSavedFields(), function(k,v) {
-            base += '<div>' + k + '<span>' + v + '</span></div>'
-          })
-        base += "</div>"
-      base += "</li>"
-      base += "<li><a data-command='R' href='#' id='clear'>Clear stored</a></li>"
+      // redraw menu
+      Peteshow.initCommands()
     }
-
-    return base
-  }
-
-  savedFieldsExist = function() {
-    var saved = _options.cookies ? $.cookie('peteshow') : localStorage.getItem('peteshow')
-    return saved != undefined || saved != null
-  }
-
-  Peteshow.setSavedFields = function(data) {
-    _options.cookies ? $.cookie('peteshow', data, {domain: getDomain()}) : localStorage.setItem('peteshow', data)
-  }
-
-  Peteshow.getSavedFields = function() {
-    var saved = _options.cookies ? $.cookie('peteshow') : localStorage.getItem('peteshow')
-    return (saved != undefined || saved != null) ? JSON.parse(saved) : {}
-  }
-
-  getDomain = function() {
-    // http://rossscrivener.co.uk/blog/javascript-get-domain-exclude-subdomain
-    var i=0, domain=document.domain, p=domain.split('.'), s='_gd'+(new Date()).getTime();
-    while(i<(p.length-1) && document.cookie.indexOf(s+'='+s)==-1){
-      domain = p.slice(-1-(++i)).join('.');
-      document.cookie = s+"="+s+";domain="+domain+";";
-    }
-    document.cookie = s+"=;expires=Thu, 01 Jan 1970 00:00:01 GMT;domain="+domain+";";
-    return domain;
-  }
-
-  Peteshow.clearSaved = function() {
-    Peteshow.clearLocalStorage()
-    Peteshow.clearCookies()
-    initCommands()
-  }
-
-  Peteshow.clearLocalStorage = function() {
-    localStorage.removeItem('peteshow')
-    initCommands()
-  }
-
-  Peteshow.clearCookies = function() {
-    $.removeCookie('peteshow', {domain: getDomain()})
-    initCommands()
   }
 
-  randomSelectValue = function(i,select) {
+  randomSelectValue = function(i, select) {
     var options   = $(select).find('option'),
         filters   = _options.filter.toString().replace(new RegExp(',', 'g'), '|'),
         regex     = new RegExp('other|select'+(filters == '' ? '' : '|' + filters),'gi'),
@@ -1423,18 +1413,18 @@ window.Peteshow = Peteshow;
 
       if(value.match(regex) == null && value != '')
         filtered.push(value)
-    });
+    })
 
     var random = Math.floor(Math.random() * filtered.length)
 
     $(select)
-      .filter(function() { return _options.ignore.indexOf(this.id) === -1 })
+      .filterFields()
       .val(filtered[random])
       .change()
   }
 
-  randomRadioValue = function() {
-    var names = $('input:radio').map(function() {
+  randomRadioValue = function(i, radios) {
+    var names = $(radios).map(function() {
       return $(this).attr('name')
     })
 
@@ -1444,12 +1434,52 @@ window.Peteshow = Peteshow;
       var radios = $('input:radio[name="'+name+'"]')
 
       $(radios[Math.floor(Math.random() * radios.length)])
-        .filter(function() { return _options.ignore.indexOf(this.id) === -1 })
+        .filterFields()
         .prop('checked', true)
         .change()
     })
   }
 
-  $(document).keydown(handleKeypress);
+  $.fn.filterFields = function() {
+    return this.filter(function() {
+      return _options.ignore.indexOf(this.name) === -1
+    })
+  }
+
+  Peteshow.submitForm = function() {
+    $(_options.form).submit()
+    $('form[name*=registration], .simple_form').submit()
+    $('form').last().submit()
+  }
+
+  Peteshow.fillOutFormsAndSubmit = function() {
+    Peteshow.fillOutForms()
+    Peteshow.submitForm()
+  }
+
+  Peteshow.destroy = function() {
+    Peteshow.hide()
+    $div.remove()
+  }
+
+  Peteshow.hide = function() {
+    $div.hide()
+    $div.removeClass('active')
+  }
+
+  Peteshow.toggle = function() {
+    $tools.toggle()
+    $div.toggleClass('active')
+  }
+
+  Peteshow.show = function() {
+    $div.show()
+    $tools.show()
+
+    if(!$div.hasClass('active'))
+      $div.addClass('active')
+  }
+
+  $(document).keydown(handleKeypress)
 }(jQuery)