Violent Ruby: Unix Password Cracker Base

violent_ruby_unix_password_cracker_base.rb

# Unix Password Cracker
# @author Kent 'picat' Gruber
class UnixPasswordCracker
  # @!attribute file 
  #   @return [String] Path to the /etc/passwd file. 
  attr_accessor :file
  # @!attribute dictionary 
  #   @return dictionary [String] Path to dictionary file.
  attr_accessor :dictionary
  
  # Same same, but different, but still same.
  alias etc file
  
  # Create a new Unix Password Cracker.
  # 
  # @param  args [Hash]   The options to create a new Unix Password Cracker.
  # @option args [String] :file       The path to an /etc/passwd file.
  # @option args [String] :dictionary The path to a dictionry of passwords.
  #
  # @return [UnixPasswordCracker]
  def initialize(args = {})
     @file       = args[:file]       if args[:file]
     @dictionary = args[:dictionary] if args[:dictionary]
  end
end