phpjs/_octopress/source/functions/str_shuffle/_comments.html

php.js offers community built php functions in javascript

<!-- Generated by Rakefile:build -->

<strong>
Hans B PUFAL
</strong>
on 2010-06-20 18:56:21 <br />
On reviewing the code I note an error 
the line 
<pre><code>
newStr.push (str.splice (Math.floor (Math.random () * (str.length - 1)) , 1)[0]);
</code></pre>
should read
<pre><code>
newStr.push (str.splice (Math.floor (Math.random () * (str.length)) , 1)[0]);
</code></pre>
<hr />


<strong>
Hans B PUFAL
</strong>
on 2010-06-20 16:05:00 <br />
<pre><code>
function str_shuffle (str) {
    // http://kevin.vanzonneveld.net
    // +   original by: Brett Zamir (http://brett-zamir.me)
    // *     example 1: shuffled = str_shuffle(&quot;abcdef&quot;);
    // *     results 1: shuffled.length == 6

    var newStr = [];
    
    if (arguments.length &lt; 1) {
        throw 'str_shuffle : Parameter str not specified';
    }
        
    if (typeof str !== 'string') {
        throw 'str_shuffle : Parameter str ( = ' + str + ') is not a string';
    }
    
    str = str.split (''); 
    while (str.length) {
        newStr.push (str.splice (Math.floor (Math.random () * (str.length - 1)) , 1)[0]);
    }
    
    return newStr.join ('');
}
</code></pre>

In my version (above) I check the argument type explicitly (simply checking for undefined does not ensure that a parameter was passed nor that it is a string). I also provide the actual parameter value in the exception since this usually makes debugging much easier.

Perhaps php.js could adopt a standard in this area.

I use array splice to extract the random character from str (which is split into a character array) which returns the extracted character to be added to newStr. This means that the rand variable is no longer needed. Putting getRandInt inline saves time and characters.

Finally newStr is built in an array and converted at the return since (for long strings) this is more efficient than the str +=  char construct.

<hr />