forgery 0.2.2 → 0.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+/coverage
+/doc
+/pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Sevenwire LLC
+
+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 copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -15,21 +15,21 @@ plugin includes a generator providing directories to make your own forgeries.
 Install
 =======
 
-    config.gem "sevenwire-forgery", :lib => "forgery", :source => "http://gems.github.com"
+    config.gem 'forgery', :source => 'http://gemcutter.org'
 
 
 Generator
 =========
 
-    ./script/generate forgery
+    ruby script/generate forgery
 
 In a rails project this generator creates:
 
-* RAILS\_ROOT/lib/forgery
-* RAILS\_ROOT/lib/forgery/dictionaries
-* RAILS\_ROOT/lib/forgery/extensions
-* RAILS\_ROOT/lib/forgery/forgeries
-* RAILS\_ROOT/lib/forgery/formats
+* Rails.root/lib/forgery
+* Rails.root/lib/forgery/dictionaries
+* Rails.root/lib/forgery/extensions
+* Rails.root/lib/forgery/forgeries
+* Rails.root/lib/forgery/formats
 
 You can then use these directories to write your own dictionaries, class
 extensions, forgeries, and formats.
@@ -49,13 +49,13 @@ Here I'll supply a few examples of how it works, in general.  See each forgery
 for individual examples.
 
     # Traditional syntax
-    BasicForgery.password # => "wYMYvq"
-    BasicForgery.password :allow_special => true # => ";Qo^N[T"
-    BasicForgery.hex_color # => "#f4d841"
+    Forgery::Basic.password # => "wYMYvq"
+    Forgery::Basic.password :allow_special => true # => ";Qo^N[T"
+    Forgery::Basic.hex_color # => "#f4d841"
     
-    MonetaryForgery.money # => "8.21"
-    MonetaryForgery.formatted_money # => "$3.25"
-    MonetaryForgery.money :min => 100, :max => 1000 # => "848.97"
+    Forgery::Monetary.money # => "8.21"
+    Forgery::Monetary.formatted_money # => "$3.25"
+    Forgery::Monetary.money :min => 100, :max => 1000 # => "848.97"
     
     # Alternate syntax
     Forgery(:basic).password # => "b6qZTQEH"

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'sdoc_helpers'
+rescue LoadError
+  puts "sdoc support not enabled. Please gem install sdoc-helpers."
+end
+
+
+desc 'Default: run specs with rcov.'
+task :default => :rcov_spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Run the specs with rcov'
+Spec::Rake::SpecTask.new("rcov_spec") do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--color']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', '^spec,/gems/']
+end
+
+Rake::RDocTask.new do |t|
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include('lib/**/*.rb')
+  t.options << '--inline-source'
+  t.options << '--all'
+  t.options << '--line-numbers'
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "forgery"
+    s.summary = "Easy and customizable generation of forged data."
+    s.email = "nate@sevenwire.com"
+    s.homepage = "http://github.com/sevenwire/forgery"
+    s.description = "Easy and customizable generation of forged data. Can be used as a gem or a rails plugin. Includes rails generators for creating your own forgeries."
+    s.authors = ["Nathan Sutton"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:minor: 2
-:patch: 2
+:minor: 3
+:patch: 0
+:build: 
 :major: 0

data/forgery.gemspec

@@ -0,0 +1,120 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{forgery}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Sutton"]
+  s.date = %q{2009-11-13}
+  s.description = %q{Easy and customizable generation of forged data. Can be used as a gem or a rails plugin. Includes rails generators for creating your own forgeries.}
+  s.email = %q{nate@sevenwire.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "forgery.gemspec",
+     "generators/forgery/USAGE",
+     "generators/forgery/forgery_generator.rb",
+     "init.rb",
+     "lib/forgery.rb",
+     "lib/forgery/dictionaries.rb",
+     "lib/forgery/dictionaries/cities",
+     "lib/forgery/dictionaries/colors",
+     "lib/forgery/dictionaries/company_names",
+     "lib/forgery/dictionaries/countries",
+     "lib/forgery/dictionaries/female_first_names",
+     "lib/forgery/dictionaries/frequencies",
+     "lib/forgery/dictionaries/genders",
+     "lib/forgery/dictionaries/languages",
+     "lib/forgery/dictionaries/last_names",
+     "lib/forgery/dictionaries/lorem_ipsum",
+     "lib/forgery/dictionaries/male_first_names",
+     "lib/forgery/dictionaries/name_suffixes",
+     "lib/forgery/dictionaries/name_titles",
+     "lib/forgery/dictionaries/province_abbrevs",
+     "lib/forgery/dictionaries/provinces",
+     "lib/forgery/dictionaries/races",
+     "lib/forgery/dictionaries/shirt_sizes",
+     "lib/forgery/dictionaries/state_abbrevs",
+     "lib/forgery/dictionaries/states",
+     "lib/forgery/dictionaries/street_suffixes",
+     "lib/forgery/dictionaries/streets",
+     "lib/forgery/dictionaries/top_level_domains",
+     "lib/forgery/extensions/array.rb",
+     "lib/forgery/extensions/hash.rb",
+     "lib/forgery/extensions/range.rb",
+     "lib/forgery/extensions/string.rb",
+     "lib/forgery/file_reader.rb",
+     "lib/forgery/forgery.rb",
+     "lib/forgery/forgery/address.rb",
+     "lib/forgery/forgery/basic.rb",
+     "lib/forgery/forgery/internet.rb",
+     "lib/forgery/forgery/lorem_ipsum.rb",
+     "lib/forgery/forgery/monetary.rb",
+     "lib/forgery/forgery/name.rb",
+     "lib/forgery/forgery/personal.rb",
+     "lib/forgery/forgery_api.rb",
+     "lib/forgery/formats.rb",
+     "lib/forgery/formats/phone",
+     "lib/forgery/formats/street_number",
+     "lib/forgery/formats/zip",
+     "spec/dictionaries_spec.rb",
+     "spec/extensions/array_spec.rb",
+     "spec/extensions/range_spec.rb",
+     "spec/extensions/string_spec.rb",
+     "spec/file_reader_spec.rb",
+     "spec/forgery/address_spec.rb",
+     "spec/forgery/basic_spec.rb",
+     "spec/forgery/internet_spec.rb",
+     "spec/forgery/lorem_ipsum_spec.rb",
+     "spec/forgery/monetary_spec.rb",
+     "spec/forgery/name_spec.rb",
+     "spec/forgery/personal_spec.rb",
+     "spec/forgery_spec.rb",
+     "spec/formats_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/sevenwire/forgery}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easy and customizable generation of forged data.}
+  s.test_files = [
+    "spec/dictionaries_spec.rb",
+     "spec/extensions/array_spec.rb",
+     "spec/extensions/range_spec.rb",
+     "spec/extensions/string_spec.rb",
+     "spec/file_reader_spec.rb",
+     "spec/forgery/address_spec.rb",
+     "spec/forgery/basic_spec.rb",
+     "spec/forgery/internet_spec.rb",
+     "spec/forgery/lorem_ipsum_spec.rb",
+     "spec/forgery/monetary_spec.rb",
+     "spec/forgery/name_spec.rb",
+     "spec/forgery/personal_spec.rb",
+     "spec/forgery_spec.rb",
+     "spec/formats_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/forgery'

data/lib/forgery.rb

@@ -1,47 +1,33 @@
 # Require forgeries at the bottom of the file so Forgery works as a gem both
 # within rails and outside of it.
 
+current_path = File.expand_path(File.dirname(__FILE__))
+
 # Loading forgery helpers.
-require File.expand_path(File.dirname(__FILE__) + '/file_reader')
-require File.expand_path(File.dirname(__FILE__) + '/dictionaries')
-require File.expand_path(File.dirname(__FILE__) + '/formats')
+require current_path + '/forgery/file_reader'
+require current_path + '/forgery/dictionaries'
+require current_path + '/forgery/formats'
 
 # Loading class extensions
-Dir[File.expand_path(File.dirname(__FILE__) + '/extensions/**/*.rb')].uniq.each do |file|
+Dir[current_path + '/forgery/extensions/**/*.rb'].uniq.each do |file|
   require file
 end
 
-class Forgery
-
-  def self.dictionaries
-    @@dictionaries ||= Dictionaries.new
-  end
-
-  def self.formats
-    @@formats ||= Formats.new
-  end
+# Load the forgery base class
+require current_path + '/forgery/forgery'
 
-end
-
-# Alternate Forgery api, see spec/forgery_spec.rb for examples.
-def Forgery(forgery, method=nil, *args)
-  klass = "#{forgery.to_s.camelize}Forgery".constantize
-  if method
-    klass.send(method, *args)
-  else
-    klass
-  end
-end
+# Load the forgery api method
+require current_path + '/forgery/forgery_api'
 
-# Loading the other forgeries AFTER the initial Forgery class is defined.
-Dir[File.expand_path(File.dirname(__FILE__) + '/forgeries/**/*.rb')].uniq.each do |file|
+# Loading the other forgeries AFTER the initial forgery class is defined.
+Dir[current_path + '/forgery/forgery/**/*.rb'].uniq.each do |file|
   require file
 end
 
 # Loading rails forgeries to override current forgery methods and add new
 # forgeries
-if defined?(RAILS_ROOT)
-  Dir[File.expand_path(RAILS_ROOT + '/lib/forgery/**/*.rb')].uniq.each do |file|
+if Forgery.rails?
+  Dir[File.expand_path(Forgery.rails_root + '/lib/forgery/**/*.rb')].uniq.each do |file|
     require file
   end
 end

data/lib/forgery/dictionaries.rb

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

data/lib/{extensions → forgery/extensions}/string.rb

@@ -3,6 +3,7 @@ class String
     self.gsub(/#{replace}/){ Kernel.rand(10) }
   end
 
+  # Ripped right out of rails
   if !defined?(RAILS_ROOT)
     def camelize(first_letter = :upper)
       case first_letter

data/lib/forgery/file_reader.rb

@@ -0,0 +1,69 @@
+class Forgery
+
+  class FileReader
+
+    # Returns an array of strings containing each line in the dictionary
+    def self.read_dictionary(dictionary)
+      read_file(path_to_dictionary(dictionary))
+    end
+
+    # Returns an array of strings containing each line in the format
+    def self.read_format(format)
+      read_file(path_to_format(format))
+    end
+
+  protected
+
+    # Reads a file while stripping leading and trailing whitespace, including
+    # newlines
+    def self.read_file(file)
+      lines = []
+      IO.foreach(file) do |line|
+        lines << line.strip unless line.strip == ''
+      end
+      lines
+    end
+
+    # Returns the path to a format. It will return the external path if the
+    # file exists, otherwise it will return the internal path.
+    def self.path_to_format(format)
+      if external_path_to_format(format) && File.exists?(external_path_to_format(format))
+        external_path_to_format(format)
+      else
+        internal_path_to_format(format)
+      end
+    end
+
+    # Returns the path to a format outside of forgery
+    def self.external_path_to_format(format)
+      Forgery.rails_root + '/lib/forgery/formats/' + format.to_s if Forgery.rails?
+    end
+
+    # Returns the path to a format inside of forgery
+    def self.internal_path_to_format(format)
+      File.dirname(__FILE__) + '/formats/' + format.to_s
+    end
+
+    # Returns the path to a dictionary. It will return the external path if
+    # the file exists, otherwise it will return the internal path.
+    def self.path_to_dictionary(dictionary)
+      if external_path_to_dictionary(dictionary) && File.exists?(external_path_to_dictionary(dictionary))
+        external_path_to_dictionary(dictionary)
+      else
+        internal_path_to_dictionary(dictionary)
+      end
+    end
+
+    # Returns the path to a dictionary outside of forgery
+    def self.external_path_to_dictionary(dictionary)
+      Forgery.rails_root + '/lib/forgery/dictionaries/' + dictionary.to_s if Forgery.rails?
+    end
+
+    # Returns the path to a dictionary within forgery
+    def self.internal_path_to_dictionary(dictionary)
+      File.dirname(__FILE__) + '/dictionaries/' + dictionary.to_s
+    end
+
+  end
+
+end