lib/memorable_strings.rb lib/memorable_strings/consonant.rb lib/memorable_strings/digit.rb lib/memorable_strings/extensions/string.rb lib/memorable_strings/phoneme.rb lib/memorable_strings/vowel.rb test/consonant_test.rb test/digit_test.rb test/phoneme_test.rb test/string_test.rb test/vowel_test.rb @@ -1,5 +1,11 @@ == master +* Add better tests +* Add more documentation +* Redesign phoneme / consonant / vowel / digit logic to be in separate classes +* Move Password.generate to String.memorable +* Rename to memorable_strings + == 0.0.3 / 2009-01-11 * Add compatibility with Ruby 1.9+ CHANGELOG.rdoc @@ -1,54 +1,43 @@ -= password_generator += memorable_strings -+password_generator+ generates memorable passwords that can be easily remembered. ++memorable_strings+ generates strings that can be easily remembered. == Resources API -* http://api.pluginaweek.org/password_generator +* http://api.pluginaweek.org/memorable_strings Bugs -* http://pluginaweek.lighthouseapp.com/projects/13282-password_generator +* http://pluginaweek.lighthouseapp.com/projects/13282-memorable_strings Development -* http://github.com/pluginaweek/password_generator +* http://github.com/pluginaweek/memorable_strings Source -* git://github.com/pluginaweek/password_generator.git +* git://github.com/pluginaweek/memorable_strings.git == Description -Passwords are often difficult to remember, especially if they are simply a random -combination of letters and numbers. With +password_generator+, passwords are -generated based on phonemic combinations. These combinations make it easier for -users to recall the password without having to refer back to the message that -contained the password. These types of passwords help improve the overall user -experience. - -This implementation is based entirely off Ian Macdonald's ruby-password library, -repackaged to make it more easily portable and easier to invoke. +Certain strings like passwords are often difficult to remember, especially if +they are simply a random combination of letters and numbers. With ++memorable_strings+, strings are generated based on a set of rules that +combine phonemes in a manner that makes the sequence of characters more +memorable. When used in combination with features like generating passwords, +this can help improve the user experience. == Usage -=== Passwords with lowercase letters - - Password.generate # => areemoni - -=== Passwords with a digit - - Password.generate(8, Password::ONE_DIGIT) # => thohk8tu - -=== Passwords with a capital letter - - Password.generate(8, Password::ONE_CASE) => Hjowecug - -=== Passwords with both a digit and a capital letter + String.memorable # => "maikipeo" + String.memorable(:length => 5) # => "quoge" + String.memorable(:capital => true) # => "Bukievai" + String.memorable(:digit => true) # => "ood4yosa" + String.memorable(:capital => true, :digit => true) # => "Goodah5e" - Password.generate(8, Password::ONE_DIGIT | Password::ONE_CASE) # => Kzgth0il +See MemorableStrings::Extensions::String for more information. == Dependencies README.rdoc @@ -4,10 +4,10 @@ require 'rake/gempackagetask' require 'rake/contrib/sshpublisher' spec = Gem::Specification.new do |s| - s.name = 'password_generator' + s.name = 'memorable_strings' s.version = '0.0.3' s.platform = Gem::Platform::RUBY - s.summary = 'Generates memorable passwords that can be easily remembered' + s.summary = 'Generates strings that can be easily remembered' s.files = FileList['{lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc) s.require_path = 'lib' Rakefile @@ -1 +1 @@ -require 'password_generator' +require 'memorable_strings' init.rb @@ -2,3 +2,30 @@ require 'test/unit' $:.unshift(File.dirname(__FILE__) + '/../lib') require File.dirname(__FILE__) + '/../init' + +# Force mocha to be installed +begin + require 'rubygems' + require 'mocha' +rescue LoadError + $stderr.puts "Mocha is not installed. `gem install mocha` and try again." + exit +end + +Test::Unit::TestCase.class_eval do + def setup_phonemes + @vowels = MemorableStrings::Vowel.all.dup + @consonants = MemorableStrings::Consonant.all.dup + @digits = MemorableStrings::Digit.all.dup + + MemorableStrings::Vowel.all.clear + MemorableStrings::Consonant.all.clear + MemorableStrings::Digit.all.clear + end + + def teardown_phonemes + MemorableStrings::Vowel.all.replace(@vowels) + MemorableStrings::Consonant.all.replace(@consonants) + MemorableStrings::Digit.all.replace(@digits) + end +end test/test_helper.rb lib/password_generator.rb test/password_generation_test.rb d9dc3e311cdfb2f528eadd23aa21783adbc64375 Aaron Pfeifer aaron.pfeifer@gmail.com http://github.com/pluginaweek/memorable_strings/commit/250cd7ec072dade89c95efa15d47207c89f9e6bb 250cd7ec072dade89c95efa15d47207c89f9e6bb 2009-04-18T14:16:54-07:00 2009-04-18T14:16:54-07:00 Rename to memorable_strings Move Password.generate to String.memorable Redesign phoneme / consonant / vowel / digit logic to be in separate classes Add more documentation Add better tests 169e1ade9ff4fe43b23e571ff410e458fae0d2a4 Aaron Pfeifer aaron.pfeifer@gmail.com