haddock 0.2.1 → 0.2.2

data/README.rdoc

@@ -56,27 +56,20 @@ Or:
 
 == INSTALL
 
-RubyForge:
-
-  % gem install haddock
-
-
-GitHub:
-
-  % gem install stephencelis-haddock --source=http://gems.github.com
+  % [sudo] gem install haddock
 
 
 == LICENSE
 
 (The MIT License)
 
-(c) 2009-* Stephen Celis, stephen@stephencelis.com.
+(c) 2009-2010 Stephen Celis, stephen@stephencelis.com.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy 
-of this software and associated documentation files (the "Software"), to deal 
-in the Software without restriction, including without limitation the rights 
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
-copies of the Software, and to permit persons to whom the Software is 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all

data/Rakefile

@@ -1,11 +1,16 @@
 $: << File.dirname(__FILE__) + "/lib"
 require "rubygems"
-require "hoe"
 require "haddock"
 
-Hoe.new('haddock', Haddock::VERSION) do |p|
-  p.developer('Stephen Celis', 'stephen@stephencelis.com')
-  p.remote_rdoc_dir = ''
-  p.readme_file = "README.rdoc"
-  p.history_file = "History.rdoc"
+require "rake/testtask"
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Run unit tests."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
 end

data/bin/ha-gen

@@ -5,7 +5,7 @@ require "optparse"
 require "haddock"
 include Haddock
 
-parser = OptionParser.new do |opts|
+OptionParser.new do |opts|
   opts.banner = "usage: #{File.basename($0)} [options]"
 
   opts.on("-V", "--version") do
@@ -18,27 +18,30 @@ parser = OptionParser.new do |opts|
     exit
   end
 
-  opts.on("-l", "--length [length]") do |value|
-    raise Password::LengthError, "Invalid length" if value.match(/\D/)
-    @length = value.to_i
+  opts.on("-l", "--length [length]", Integer) do |value|
+    @length = value
   end
 
   opts.on("-f", "--words [words file]") do |value|
     Password.diction = value
   end
-end
 
-begin
-  parser.parse!
-  puts @length ? Password.generate(@length) : Password.generate
-rescue OptionParser::ParseError, Password::LengthError => error
-  warn "#{File.basename($0)}: #{error.message} " +
-    "(must be between #{Password::MINIMUM} and #{Password::MAXIMUM})."
-  puts parser
-  exit 1
-rescue Password::NoWordsError => error
-  warn "#{File.basename($0)}: #{error.message}."
-  puts "Word lists are available here: http://wordlist.sourceforge.net"
-  puts parser
-  exit 1
+  opts.on("-d", "--delimiters [symbols]") do |value|
+    Password.delimiters = value
+  end
+
+  begin
+    opts.parse!
+    puts @length ? Password.generate(@length) : Password.generate
+  rescue OptionParser::ParseError, Password::LengthError => error
+    warn "#{File.basename($0)}: #{error.message} " +
+      "(must be between #{Password::MINIMUM} and #{Password::MAXIMUM})."
+    puts opts
+    abort
+  rescue Password::NoWordsError => error
+    warn "#{File.basename($0)}: #{error.message}."
+    puts "Word lists are available here: http://wordlist.sourceforge.net"
+    puts opts
+    abort
+  end
 end

data/lib/haddock.rb

@@ -1,18 +1,24 @@
 # A more memorable password generator. Swordfish? No, I got tired of that. I
 # changed it.
 module Haddock
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 
   module Password
+    # The minimum password legnth.
     MINIMUM = 8
+
+    # The maximum password length.
     MAXIMUM = 31
+
+    # The default password length.
     DEFAULT = 12
 
-    SYMBOLS = '`~!@#$%^&*()-_=+[{]}\\|;:\'",<.>/?'
+    # Paths used to detect default words files.
+    PATHS = %w(/usr/share/dict/words /usr/share/words)
 
-    class << self
-      @@paths = %w(/usr/share/dict/words /usr/share/words)
+    @@delimiters = '`~!@#$%^&*()-_=+[{]}\\|;:\'",<.>/?'
 
+    class << self
       # Generates a more memorable password. Its one optional argument
       # determines the length of the generated password, and cannot be less
       # than 8 or greater than 31 characters (default: 12).
@@ -22,7 +28,7 @@ module Haddock
       #   Password.generate(8)  # => "amy7@rax"
       def generate(length = DEFAULT)
         unless defined? @@diction
-          self.diction = @@paths.find { |path| File.exist? path }
+          self.diction = PATHS.find { |path| File.exist? path }
         end
 
         raise LengthError, "Invalid length" unless length.is_a? Integer
@@ -32,7 +38,7 @@ module Haddock
         words_limit = length * 0.75 # Ensure over-proportionate word lengths.
 
         begin
-          words = %W(#{random_word} #{random_symbol}#{random_word})
+          words = %W(#{random_word} #{random_delimiter}#{random_word})
           words_length = words.join.length
         end until words_length < length && words_length > words_limit
 
@@ -51,14 +57,21 @@ module Haddock
         raise NoWordsError, "No words file at #{path.inspect}"
       end
 
+      # Sets the list of characters that can delimit words. Default:
+      #
+      #   `~!@#$%^&*()-_=+[{]}\|;:'",<.>/?
+      def delimiters=(string)
+        @@delimiters = string
+      end
+
       private
 
       def random_word
         @@diction[rand(@@diction.length)].chomp
       end
 
-      def random_symbol
-        SYMBOLS[rand(SYMBOLS.length), 1]
+      def random_delimiter
+        @@delimiters[rand(@@delimiters.length), 1]
       end
 
       def random_number(digits)

data/test/test_haddock.rb

@@ -11,7 +11,8 @@ class TestHaddock < Test::Unit::TestCase
   end
 
   def test_password_format
-    symbols = "[#{Regexp.quote Password::SYMBOLS}]"
+    symbols = Password.send :class_variable_get, :@@delimiters
+    symbols = "[#{Regexp.quote symbols}]"
     pattern = /^[a-z]+[0-9]+#{symbols}{1}[a-z]+/i
     assert_match(pattern, Password.generate)
   end
@@ -28,6 +29,11 @@ class TestHaddock < Test::Unit::TestCase
     Password.diction = "/usr/share/dict/words"
   end
 
+  def test_accepts_alternate_symbols_list
+    Password.delimiters = "!"
+    assert_equal "!", Password.send(:random_delimiter)
+  end
+
   def test_fail_on_too_short
     assert_raise Password::LengthError do
       Password.generate(Password::MINIMUM - 1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: haddock
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Stephen Celis
@@ -9,24 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-14 00:00:00 -05:00
+date: 2010-01-04 00:00:00 -06:00
 default_executable: ha-gen
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.12.2
-    version: 
-description: |-
-  A more memorable password generator. Swordfish? No, I got tired of that. I
-  changed it.
-email: 
-- stephen@stephencelis.com
+dependencies: []
+
+description: A more memorable password generator. Swordfish? No, I got tired of that. I changed it.
+email: stephen@stephencelis.com
 executables: 
 - ha-gen
 extensions: []