public
Description: Easy and customizable generation of forged data.
Homepage: http://sevenwire.com
Clone URL: git://github.com/sevenwire/forgery.git
nate (author)
Thu Nov 12 23:27:56 -0800 2009
commit  6e799f573616a87988118c810cdc728efc346809
tree    4110a1c62eac96b7406a0890cf301b2c0ea49b5d
parent  86c0b2d56a2a2c0887ab270c2fd7786ef3b80be9
name age message
file .gitignore Loading commit data...
file LICENSE
file README.markdown
file Rakefile
file VERSION.yml
file forgery.gemspec
directory generators/ Thu Apr 03 18:19:30 -0700 2008 Adding rails support. [nate]
file init.rb
directory lib/
directory spec/ Thu Nov 12 23:04:28 -0800 2009 Better tests for rails env and root [nate]
README.markdown

Forgery

The Problem: Making meaningful development data for your application.

The Solution: A fake data generator that does more than just lorem ipsum and random text (well, it does those too, but also does much more).

Forgery generates fake data from dictionaries, formats, and recipes. The plugin includes a generator providing directories to make your own forgeries.

Install

config.gem "sevenwire-forgery", :lib => "forgery", :source => "http://gems.github.com"

Generator

./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

You can then use these directories to write your own dictionaries, class extensions, forgeries, and formats.

Forgery will look first here for dictionaries and formats, so you can override the ones used in the plugin.

See the forgeries in the plugin for examples of how to write your own.

See which dictionaries each forgery uses to override them with your own.

Examples

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"

MonetaryForgery.money # => "8.21"
MonetaryForgery.formatted_money # => "$3.25"
MonetaryForgery.money :min => 100, :max => 1000 # => "848.97"

# Alternate syntax
Forgery(:basic).password # => "b6qZTQEH"
Forgery(:basic).password :allow_special => true # => "XlrhV%An"
Forgery(:basic).hex_color # => "#46b73f"

Forgery(:monetary).money # => "1.58"
Forgery(:monetary).formatted_money # => "$3.48"
Forgery(:monetary).money :min => 100, :max => 1000 # => "923.36"

DOCUMENTATION

Documentation can be found at http://docs.github.com/sevenwire/forgery

TODO

  • Add instanced forgeries for more relative information generation.
  • Add markov chains.
  • Add a way to use probability in forgeries.

Thanks

Thanks to the authors and contributors:

  • Nate Sutton (nate aka fowlduck)
  • Brandon Arbini (brandonarbini)
  • Josh Nichols (technicalpickles)
  • Jeremy Stephens (viking aka crookshanks)

Notes

This is a work in progress. If you find bugs or have forgeries to contribute, we'll gladly take them and give credit.

Enjoy.

Nate Sutton (nate@sevenwire.com)