forgery 0.2.2 → 0.3.0

data/lib/forgery/forgery.rb

@@ -0,0 +1,23 @@
+class Forgery
+
+  def self.dictionaries
+    @@dictionaries ||= Dictionaries.new
+  end
+
+  def self.formats
+    @@formats ||= Formats.new
+  end
+
+  def self.rails_root
+    if defined?(RAILS_ROOT)
+      RAILS_ROOT
+    elsif defined?(Rails)
+      Rails.root.to_s
+    end
+  end
+
+  def self.rails?
+    !rails_root.nil?
+  end
+
+end

data/lib/{forgeries/address_forgery.rb → forgery/forgery/address.rb}

@@ -1,11 +1,12 @@
 # Generates random address information.
-class AddressForgery < Forgery
+class Forgery::Address < Forgery
+
   # Gets a random street name out of the 'streets' dictionary.
   #
-  #   AddressForgery.street_name
+  #   Forgery(:address).street_name
   #   # => "Atwood"
   #
-  #   AddressForgery.street_name
+  #   Forgery(:address).street_name
   #   # => "Fordem"
   def self.street_name
     dictionaries[:streets].random
@@ -14,10 +15,10 @@ class AddressForgery < Forgery
   # Gets one of the formats from 'street_number_formats' and converts it to
   # numbers.
   #
-  #   AddressForgery.street_number
+  #   Forgery(:address).street_number
   #   # => 1
   #
-  #   AddressForgery.street_number
+  #   Forgery(:address).street_number
   #   # => 1234
   def self.street_number
     formats[:street_number].random.to_numbers
@@ -25,10 +26,10 @@ class AddressForgery < Forgery
 
   # Gets a random street suffix out of the 'street_suffixes' dictionary.
   #
-  #   AddressForgery.street_suffix
+  #   Forgery(:address).street_suffix
   #   # => "Street"
   #
-  #   AddressForgery.street_suffix
+  #   Forgery(:address).street_suffix
   #   # => "Parkway"
   def self.street_suffix
     dictionaries[:street_suffixes].random
@@ -37,10 +38,10 @@ class AddressForgery < Forgery
   # Gets a full street address, including street number, street name, and
   # street suffix.
   #
-  #   AddressForgery.street_address
+  #   Forgery(:address).street_address
   #   # => "92 West Circle"
   #
-  #   AddressForgery.street_address
+  #   Forgery(:address).street_address
   #   # => "93265 Harper Lane"
   def self.street_address
     "#{street_number} #{street_name} #{street_suffix}"
@@ -48,10 +49,10 @@ class AddressForgery < Forgery
 
   # Gets a random city out of the 'cities' dictionary.
   #
-  #   AddressForgery.city
+  #   Forgery(:address).city
   #   # => "Anaheim"
   #
-  #   AddressForgery.city
+  #   Forgery(:address).city
   #   # => "Sacramento"
   def self.city
     dictionaries[:cities].random
@@ -59,10 +60,10 @@ class AddressForgery < Forgery
 
   # Gets a random state out of the 'states' dictionary.
   #
-  #   AddressForgery.state
+  #   Forgery(:address).state
   #   # => "Mississippi"
   #
-  #   AddressForgery.state
+  #   Forgery(:address).state
   #   # => "Minnesota"
   def self.state
     dictionaries[:states].random
@@ -70,10 +71,10 @@ class AddressForgery < Forgery
 
   # Gets a random state abbreviation out of the 'state_abbrev' dictionary.
   #
-  #   AddressForgery.state_abbrev
+  #   Forgery(:address).state_abbrev
   #   # => "GA"
   #
-  #   AddressForgery.state_abbrev
+  #   Forgery(:address).state_abbrev
   #   # => "TX"
   def self.state_abbrev
     dictionaries[:state_abbrevs].random
@@ -81,10 +82,10 @@ class AddressForgery < Forgery
 
   # Gets a random Canadian province or territory out of the 'provinces' dictionary.
   #
-  #   AddressForgery.province
+  #   Forgery(:address).province
   #   # => "Ontario"
   #
-  #   AddressForgery.province
+  #   Forgery(:address).province
   #   # => "Northwest Territories"
   def self.province
     dictionaries[:provinces].random
@@ -92,10 +93,10 @@ class AddressForgery < Forgery
 
   # Gets a random Canadian province or territory abbreviation out of the 'province_abbrev' dictionary.
   #
-  #   AddressForgery.province_abbrev
+  #   Forgery(:address).province_abbrev
   #   # => "ON"
   #
-  #   AddressForgery.province_abbrev
+  #   Forgery(:address).province_abbrev
   #   # => "NT"
   def self.province_abbrev
     dictionaries[:province_abbrevs].random
@@ -103,10 +104,10 @@ class AddressForgery < Forgery
 
   # Gets one of the formats from 'zip_formats' and converts it to numbers.
   #
-  #   AddressForgery.zip
+  #   Forgery(:address).zip
   #   # => "52474"
   #
-  #   AddressForgery.zip
+  #   Forgery(:address).zip
   #   # => "66702-4349"
   def self.zip
     formats[:zip].random.to_numbers
@@ -114,10 +115,10 @@ class AddressForgery < Forgery
 
   # Gets one of the formats from 'phone_formats' and converts it to numbers.
   #
-  #   AddressForgery.phone
+  #   Forgery(:address).phone
   #   # => "1-(416)185-8799"
   #
-  #   AddressForgery.phone
+  #   Forgery(:address).phone
   #   # => "1-(589)248-0418"
   def self.phone
     formats[:phone].random.to_numbers
@@ -125,12 +126,13 @@ class AddressForgery < Forgery
 
   # Gets a random country out of the 'countries' dictionary.
   #
-  #   AddressForgery.country
+  #   Forgery(:address).country
   #   # => "Uruguay"
   #
-  #   AddressForgery.country
+  #   Forgery(:address).country
   #   # => "Romania"
   def self.country
     dictionaries[:countries].random
   end
+
 end

data/lib/{forgeries/basic_forgery.rb → forgery/forgery/basic.rb}

@@ -1,6 +1,7 @@
 require 'digest/sha1'
 
-class BasicForgery < Forgery
+class Forgery::Basic < Forgery
+
   HEX_DIGITS = %w{0 1 2 3 4 5 6 7 8 9 a b c d e f}
   UPPER_ALPHA = ('A'..'Z').to_a
   LOWER_ALPHA = ('a'..'z').to_a
@@ -8,6 +9,27 @@ class BasicForgery < Forgery
   SPECIAL_CHARACTERS = %w{! ' @ # $ % ^ & * ( ) _ + - = [ ] { } ; : " , . / ?}
   BOOLEAN = [true, false]
 
+  # Gets a random string for use as a password
+  #
+  #   Forgery(:basic).password
+  #   # => "1MbyMQhU"
+  #
+  #   Forgery(:basic).password(:at_least => 3, :at_most => 5)
+  #   # => "WbgP"
+  #
+  # Supported Options
+  # [:at_least]
+  #   The minimum length the password may be. Defaults to 6.
+  # [:at_most]
+  #   The maximum length the password may be. Defaults to 12.
+  # [:allow_lower]
+  #   Allow lowercase characters. Defaults to true.
+  # [:allow_upper]
+  #   Allow uppercase characters. Defaults to true.
+  # [:allow_numeric]
+  #   Allow numbers. Defaults to true.
+  # [:allow_special]
+  #   Allow special characters. Defaults to false.
   def self.password(options={})
     options = {:at_least => 6,
                :at_most => 12,
@@ -18,10 +40,27 @@ class BasicForgery < Forgery
     self.text(options)
   end
 
+  # SHA1 hexdigests a password salted with the current time
+  #
+  #   Forgery(:basic).encrypt
+  #   # => "b2fbd3955a36068e93e0b9db45bcb178f08336f5"
+  #
+  #   Forgery(:basic).encrypt('your-password')
+  #   # => "00932bafce4a9391f888ca77f81f98b8e89d3aa6"
+  #
+  #   Forgery(:basic).encrypt('your-password', Time.utc(2009))
+  #   # => "4b157c2fbf430b962842d21926eaa887c3a12f81"
   def self.encrypt(password="password", salt=Time.now.to_s)
     Digest::SHA1.hexdigest("--#{salt}--#{password}--")
   end
 
+  # Gets a random boolean value
+  #
+  #   Forgery(:basic).boolean
+  #   # => true
+  #
+  #   Forgery(:basic).boolean
+  #   # => false
   def self.boolean
     BOOLEAN.random
   end
@@ -68,4 +107,5 @@ class BasicForgery < Forgery
   def self.frequency
     dictionaries[:frequencies].random
   end
+
 end

data/lib/{forgeries/internet_forgery.rb → forgery/forgery/internet.rb}

@@ -1,4 +1,5 @@
-class InternetForgery < Forgery
+class Forgery::Internet < Forgery
+
   def self.user_name
     (dictionaries[:male_first_names].random[0,1] + dictionaries[:last_names].random).downcase
   end
@@ -10,8 +11,9 @@ class InternetForgery < Forgery
   def self.domain_name
     dictionaries[:company_names].random.downcase + '.' + self.top_level_domain
   end
-  
+
   def self.email_address
     self.user_name + '@' + self.domain_name
   end
+
 end

data/lib/{forgeries/lorem_ipsum_forgery.rb → forgery/forgery/lorem_ipsum.rb}

@@ -1,4 +1,4 @@
-class LoremIpsumForgery < Forgery
+class Forgery::LoremIpsum < Forgery
 
   def self.text(what=:sentence, quantity=2, options={})
     case what
@@ -21,7 +21,6 @@ class LoremIpsumForgery < Forgery
     end
   end
 
-
   def self.character(options={})
     self.characters(1, options)
   end

data/lib/{forgeries/monetary_forgery.rb → forgery/forgery/monetary.rb}

@@ -1,4 +1,5 @@
-class MonetaryForgery < Forgery
+class Forgery::Monetary < Forgery
+
   def self.formatted_money(options={})
     "$%1.2f" % money(options)
   end
@@ -10,4 +11,5 @@ class MonetaryForgery < Forgery
     value = ((options[:min] * 100)..(options[:max] * 100)).random
     "%1.2f" % (value.to_f / 100)
   end
+
 end

data/lib/{forgeries/name_forgery.rb → forgery/forgery/name.rb}

@@ -1,4 +1,4 @@
-class NameForgery < Forgery
+class Forgery::Name < Forgery
 
   def self.last_name
     dictionaries[:last_names].random
@@ -31,4 +31,5 @@ class NameForgery < Forgery
   def self.suffix
     dictionaries[:name_suffixes].random
   end
+
 end

data/lib/{forgeries/personal_forgery.rb → forgery/forgery/personal.rb}

@@ -1,4 +1,4 @@
-class PersonalForgery < Forgery
+class Forgery::Personal < Forgery
 
   def self.gender
     dictionaries[:genders].random
@@ -19,4 +19,5 @@ class PersonalForgery < Forgery
   def self.language
     dictionaries[:languages].random
   end
+
 end

data/lib/forgery/forgery_api.rb

@@ -0,0 +1,9 @@
+# Alternate Forgery api, see spec/forgery_spec.rb for examples.
+def Forgery(forgery, method=nil, *args)
+  klass = "Forgery::#{forgery.to_s.camelize}".constantize
+  if method
+    klass.send(method, *args)
+  else
+    klass
+  end
+end

data/lib/forgery/formats.rb

@@ -0,0 +1,24 @@
+class Forgery
+
+  class Formats
+
+    def initialize
+      @formats = {}
+    end
+
+    def [](key)
+      symbolized_key = key.to_sym
+      @formats[symbolized_key] ||= FileReader.read_format(symbolized_key)
+    end
+
+    def loaded?(key)
+      @formats.has_key?(key.to_sym)
+    end
+
+    def reset!
+      @formats = {}
+    end
+
+  end
+
+end

data/spec/dictionaries_spec.rb

@@ -1,8 +1,8 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe Dictionaries do
+describe Forgery::Dictionaries do
   it "should check if the dictionary is loaded" do
-    dictionaries = Dictionaries.new
+    dictionaries = Forgery::Dictionaries.new
 
     dictionaries[:colors]
 
@@ -10,7 +10,7 @@ describe Dictionaries do
   end
 
   it "should load a dictionary when called by the key" do
-    dictionaries = Dictionaries.new
+    dictionaries = Forgery::Dictionaries.new
 
     dictionaries.reset!
 
@@ -22,7 +22,7 @@ describe Dictionaries do
   end
 
   it "should clear the loaded dictionaries when calling reset!" do
-    dictionaries = Dictionaries.new
+    dictionaries = Forgery::Dictionaries.new
 
     dictionaries[:colors]
 

data/spec/file_reader_spec.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe FileReader do
+describe Forgery::FileReader do
   it "should return an array when calling read_dictionary" do
-    FileReader.read_dictionary(:colors).should be_is_a(Array)
+    Forgery::FileReader.read_dictionary(:colors).should be_is_a(Array)
   end
 
   it "should return an array when calling read_format" do
-    FileReader.read_format(:phone).should be_is_a(Array)
+    Forgery::FileReader.read_format(:phone).should be_is_a(Array)
   end
 end

data/spec/{forgeries/address_forgery_spec.rb → forgery/address_spec.rb}

@@ -1,22 +1,22 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe AddressForgery do
+describe Forgery::Address do
   it "should return a random street" do
-    Forgery.dictionaries[:streets].should include(AddressForgery.street_name)
+    Forgery.dictionaries[:streets].should include(Forgery::Address.street_name)
   end
 
   it "should return a random street number" do
-    original_format = AddressForgery.street_number.gsub(/\d/, '#')
+    original_format = Forgery::Address.street_number.gsub(/\d/, '#')
     Forgery.formats[:street_number].should include(original_format)
   end
 
   it "should return a random street suffix" do
-    Forgery.dictionaries[:street_suffixes].should include(AddressForgery.street_suffix)
+    Forgery.dictionaries[:street_suffixes].should include(Forgery::Address.street_suffix)
   end
 
   describe ".street_address" do
     before do
-      @split_address = AddressForgery.street_address.split
+      @split_address = Forgery::Address.street_address.split
     end
 
     it "should return a random street suffix" do
@@ -38,42 +38,42 @@ describe AddressForgery do
   end
 
   it "should return a random city" do
-    city = AddressForgery.city
+    city = Forgery::Address.city
     Forgery.dictionaries[:cities].should include(city)
   end
 
   it "should return a random state" do
-    state = AddressForgery.state
+    state = Forgery::Address.state
     Forgery.dictionaries[:states].should include(state)
   end
 
   it "should return a random state abbreviation" do
-    state_abbrev = AddressForgery.state_abbrev
+    state_abbrev = Forgery::Address.state_abbrev
     Forgery.dictionaries[:state_abbrevs].should include(state_abbrev)
   end
 
   it "should return a random Canadian province or territory" do
-    province = AddressForgery.province
+    province = Forgery::Address.province
     Forgery.dictionaries[:provinces].should include(province)
   end
 
   it "should return a random Canadian province or territory abbreviation" do
-    province_abbrev = AddressForgery.province_abbrev
+    province_abbrev = Forgery::Address.province_abbrev
     Forgery.dictionaries[:province_abbrevs].should include(province_abbrev)
   end
 
   it "should return a random country" do
-    country = AddressForgery.country
+    country = Forgery::Address.country
     Forgery.dictionaries[:countries].should include(country)
   end
 
   it "should return a random zip code" do
-    zip_format = AddressForgery.zip.gsub(/\d/, '#')
+    zip_format = Forgery::Address.zip.gsub(/\d/, '#')
     Forgery.formats[:zip].should include(zip_format)
   end
 
   it "should return a random phone number" do
-    phone_format = AddressForgery.phone.gsub(/\d/, '#')
+    phone_format = Forgery::Address.phone.gsub(/\d/, '#')
     Forgery.formats[:phone].should include(phone_format)
   end
 end