Update Readme and pretty-print examples

envato · May 10, 2018 · 134c4a3 · 134c4a3
1 parent e47b763
commit 134c4a3
Showing 1 changed file with 71 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -18,10 +18,41 @@ Example usage:
 $ irb
 >> require 'zxcvbn'
 => true
->> Zxcvbn.test('@lfred2004', ['alfred'])
-=> #<Zxcvbn::Score:0x007fd467803098 @entropy=7.895, @crack_time=0.012, @crack_time_display="instant", @score=0, @match_sequence=[#<Zxcvbn::Match matched_word="alfred", token="@lfred", i=0, j=5, rank=1, pattern="dictionary", dictionary_name="user_inputs", l33t=true, sub={"@"=>"a"}, sub_display"@ -> a", base_entropy0.0, uppercase_entropy0.0, l33t_entropy1, entropy1.0, #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944], @password="@lfred2004", @calc_time=0.003436>
->> Zxcvbn.test('asdfghju7654rewq', ['alfred'])
-=> #<Zxcvbn::Score:0x007fd4689c1168 @entropy=29.782, @crack_time=46159.451, @crack_time_display="14 hours", @score=2, @match_sequence=[#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>], password"asdfghju7654rewq", calc_time0.00526
+>> pp Zxcvbn.test('@lfred2004', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f590610c8
+ @calc_time=0.0055760000250302255,
+ @crack_time=0.012,
+ @crack_time_display="instant",
+ @entropy=7.895,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f59060150
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Predictable substitutions like '@' instead of 'a' don't help very much"],
+   @warning=nil>,
+ @match_sequence=
+  [#<Zxcvbn::Match matched_word="alfred", token="@lfred", i=0, j=5, rank=1, pattern="dictionary", dictionary_name="user_inputs", l33t=true, sub={"@"=>"a"}, sub_display="@ -> a", base_entropy=0.0, uppercase_entropy=0.0, l33t_entropy=1, entropy=1.0>,
+   #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944>],
+ @password="@lfred2004",
+ @score=0>
+=> #<Zxcvbn::Score:0x00007f7f59060150>
+>> pp Zxcvbn.test('asdfghju7654rewq', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f5a9e9248
+ @calc_time=0.007504999986849725,
+ @crack_time=46159.451,
+ @crack_time_display="14 hours",
+ @entropy=29.782,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f5a9e9130
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Use a longer keyboard pattern with more turns"],
+   @warning="Short keyboard patterns are easy to guess">,
+ @match_sequence=
+  [#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>],
+ @password="asdfghju7654rewq",
+ @score=2>
+=> #<Zxcvbn::Score:0x00007f7f5a9e9248>
 ```
 
 ## Testing Multiple Passwords
@@ -34,10 +65,42 @@ $ irb
 => true
 >> tester = Zxcvbn::Tester.new
 => #<Zxcvbn::Tester:0x3fe99d869aa4>
->> tester.test('@lfred2004', ['alfred'])
-=> #<Zxcvbn::Score:0x007fd4689c1168 @entropy=29.782, @crack_time=46159.451, @crack_time_display="14 hours", @score=2, @match_sequence=[#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>], password"asdfghju7654rewq", calc_time0.00526
->> tester.test('@lfred2004', ['alfred'])
-=> #<Zxcvbn::Score:0x007fd4689c1168 @entropy=29.782, @crack_time=46159.451, @crack_time_display="14 hours", @score=2, @match_sequence=[#<Zxcvbn::Match pattern="spatial", i=0, j=15, token="asdfghju7654rewq", graph="qwerty", turns=5, shifted_count=0, entropy=29.7820508329166>], password"asdfghju7654rewq", calc_time0.00526
+>> pp tester.test('@lfred2004', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f586fcf50
+ @calc_time=0.00631899997824803,
+ @crack_time=0.012,
+ @crack_time_display="instant",
+ @entropy=7.895,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f586fcac8
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Predictable substitutions like '@' instead of 'a' don't help very much"],
+   @warning=nil>,
+ @match_sequence=
+  [#<Zxcvbn::Match matched_word="alfred", token="@lfred", i=0, j=5, rank=1, pattern="dictionary", dictionary_name="user_inputs", l33t=true, sub={"@"=>"a"}, sub_display="@ -> a", base_entropy=0.0, uppercase_entropy=0.0, l33t_entropy=1, entropy=1.0>,
+   #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944>],
+ @password="@lfred2004",
+ @score=0>
+=> #<Zxcvbn::Score:0x00007f7f586fcf50>
+>> pp tester.test('@lfred2004', ['alfred'])
+#<Zxcvbn::Score:0x00007f7f56d57438
+ @calc_time=0.001986999996006489,
+ @crack_time=0.012,
+ @crack_time_display="instant",
+ @entropy=7.895,
+ @feedback=
+  #<Zxcvbn::Feedback:0x00007f7f56d56bf0
+   @suggestions=
+    ["Add another word or two. Uncommon words are better.",
+     "Predictable substitutions like '@' instead of 'a' don't help very much"],
+   @warning=nil>,
+ @match_sequence=
+  [#<Zxcvbn::Match matched_word="alfred", token="@lfred", i=0, j=5, rank=1, pattern="dictionary", dictionary_name="user_inputs", l33t=true, sub={"@"=>"a"}, sub_display="@ -> a", base_entropy=0.0, uppercase_entropy=0.0, l33t_entropy=1, entropy=1.0>,
+   #<Zxcvbn::Match i=6, j=9, token="2004", pattern="year", entropy=6.894817763307944>],
+ @password="@lfred2004",
+ @score=0>
+=> #<Zxcvbn::Score:0x00007f7f56d57438>
 ```
 
 **Note**: Storing the entropy of an encrypted or hashed value provides