dm-sweatshop 0.9.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Burkert
+
+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/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+LICENSE
+Manifest.txt
+README.textile
+Rakefile
+TODO
+lib/dm-sweatshop.rb
+lib/dm-sweatshop/sweatshop.rb
+lib/dm-sweatshop/model.rb
+lib/dm-sweatshop/version.rb
+spec/dm-sweatshop/model_spec.rb
+spec/dm-sweatshop/sweatshop_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.textile

@@ -0,0 +1,224 @@
+h1. dm-sweatshop
+
+h2. Overview
+
+dm-sweatshop is a model factory for DataMapper.  It makes it easy & painless to crank out complex pseudo random models -- useful for tests and seed data.  Production Goals:
+
+* Easy generation of random models with data that fits the application domain.
+* Simple syntax for declaring and generating model patterns.
+* Add context to model patterns, allowing grouping and 
+* Effortlessly generate or fill in associations for creating complex models with few lines of code.
+
+h2. Examples
+
+Starting off with a simple user model.
+<pre>
+<code>
+  class User
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :username, String
+    property :email,    String
+    property :password, String
+  end
+</code>
+</pre>
+
+A fixture for the user model can be defined using the @fixture@ method.
+<pre>
+<code>
+  User.fixture {{
+    :username             => (username = /\w+/.gen),
+    :email                => "#{username}@example.com",
+    :password             => (password = /\w+/.gen),
+    :pasword_confirmation => password
+    
+    # The /\w+/.gen notation is part of the randexp gem:
+    # http://github.com/benburkert/randexp/
+  }}
+</code>
+</pre>
+
+Notice the double curly brace (@{{@), a quick little way to pass a block that returns a hash to the fixture method.  This is important because it ensures the data is random when we generate a new instance of the model, by calling the block every time.
+
+And here's how you generate said model.
+<pre>
+<code>
+  User.generate
+</code>
+</pre>
+
+That's it.  In fact, it can even be shortened.
+<pre>
+<code>
+  User.gen
+</code>
+</pre>
+
+h3. Associations
+
+The real power of sweatshop is generating working associations.
+<pre>
+<code>
+  DataMapper.setup(:default, "sqlite3::memory:")
+  
+  class Tweet
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :message,  String, :length => 140
+    property :user_id,  Integer
+
+    belongs_to :user
+    has n, :tags, :through => Resource
+  end
+  
+  class Tag
+    include DataMapper::Resource
+
+    property :id, Serial
+    property :name, String
+
+    has n, :tweets, :through => Resource
+  end
+  
+  class User
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :username, String
+    
+    has n, :tweets
+  end
+
+  DataMapper.auto_migrate!
+
+  User.fix {{
+    :username => /\w+/.gen,
+    :tweets   => 500.of {Tweet.make}
+  }}
+  
+  Tweet.fix {{
+    :message => /[:sentence:]/.gen[0..140],
+    :tags    => (0..10).of {Tag.make}
+  }}
+
+  Tag.fix {{
+    :name => /\w+/.gen
+  }}
+  
+  # now lets generate 100 users, each with 500 tweets.  Also, the tweet's have 0 to 10 tags!
+  users = 10.of {User.gen}
+</code>
+</pre>
+
+That's going to generate alot of tags, way more than you would see in the production app.  Let's recylce some already generated tags instead.
+
+<pre>
+<code>
+  User.fix {{
+    :username => /\w+/.gen,
+    :tweets   => 500.of {Tweet.make}
+  }}
+  
+  Tweet.fix {{
+    :message => /[:sentence:]/.gen[0..140],
+    :tags    => (0..10).of {Tag.pick}           #lets pick, not make this time
+  }}
+  
+  Tag.fix {{
+    :name => /\w+/.gen
+  }}
+  
+  50.times {Tag.gen}
+  
+  users = 10.of {User.gen}
+</code>
+</pre>
+
+h3. Contexts
+
+You can add multiple fixtures to a mode, dm-sweatshop will randomly pick between the available fixtures when it generates a new model.
+
+<pre>
+<code>
+  Tweet.fix {{
+    :message  => /\@#{User.pick.name} [:sentence:]/.gen[0..140],   #an @reply for some user
+    :tags     => (0..10).of {Tag.pick}
+  }}
+</code>
+</pre>
+
+To keep track of all of our new fixtures, we can even give them a context.
+
+<pre>
+<code>
+  Tweet.fix(:at_reply) {{
+    :message  => /\@#{User.pick.name} [:sentence:]/.gen[0..140],
+    :tags     => (0..10).of {Tag.pick}
+  }}
+  
+  Tweet.fix(:conversation) {{
+    :message  => /\@#{(tweet = Tweet.pick(:at_reply)).user.name} [:sentence:]/.gen[0..140],
+    :tags     => tweet.tags
+  }}
+</code>
+</pre>
+
+h3. Overriding a fixture
+
+Sometimes you will want to change one of your fixtures a little bit.  You create a new fixture with a whole new context, but this can be overkill.  The other option is to specify attributes in the call to @generate@.
+
+<pre>
+<code>
+  User.gen(:username => 'datamapper')  #uses 'datamapper' as the user name instead of the randomly generated word
+</code>
+</pre>
+
+This works with contexts too.
+
+<pre>
+<code>
+  User.gen(:conversation, :tags => Tag.all)       #a very, very broad conversation
+</code>
+</pre>
+
+Go forth, and populate your data.
+
+h2. Best Practices
+
+h3. Specs
+
+The suggested way to use dm-sweatshop with test specs is to create a @spec/spec_fixtures.rb@ file, then declare your fixtures in there.  Next, @require@ it in your @spec/spec_helper.rb@ file, after your models have loaded.
+
+<pre>
+<code>
+  Merb.start_environment(:testing => true, :adapter => 'runner', :environment => ENV['MERB_ENV'] || 'test')
+
+  require File.join(File.dirname(__FILE__), 'spec_fixtures')
+</code>
+</pre>
+
+Add the @.generate@ calls in your @before@ setup.  Make sure to clear your tables or @auto_migrate@ your models after each spec!
+
+h2. Possible Improvements
+
+h3. Enforcing Validations
+
+Enforce validations at generation time, before the call to @new@/@create@.
+
+<pre>
+<code>
+  User.fix {{
+    :username.unique  => /\w+/.gen,
+    :tweets           => 500.of {Tweet.make}
+  }}
+</code>
+</pre>
+
+h3. Better Exception Handling
+
+h3. Smarter @pick@
+
+Add multiple contexts to pick, or an ability to _fall back_ if one context has no generated models.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'spec'
+require 'spec/rake/spectask'
+require 'pathname'
+
+ROOT = Pathname(__FILE__).dirname.expand_path
+require ROOT + 'lib/dm-sweatshop/version'
+
+AUTHOR = "Ben Burkert"
+EMAIL  = "ben@benburkert.com"
+GEM_NAME = "dm-sweatshop"
+GEM_VERSION = DataMapper::Sweatshop::VERSION
+GEM_DEPENDENCIES = [["dm-core", GEM_VERSION], "randexp"]
+GEM_CLEAN = ["log", "pkg"]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.textile LICENSE TODO ] }
+
+PROJECT_NAME = "datamapper"
+PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/dm-Sweatshop"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = "DataMapper plugin for building pseudo random models"
+
+require ROOT.parent + 'tasks/hoe'
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+desc "Install #{GEM_NAME} #{GEM_VERSION} (default ruby)"
+task :install => [ :package, :install_randexp ] do
+  sh "#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources", :verbose => false
+end
+
+desc "Install the randexp gem from rubyforge"
+task :install_randexp do
+  sh "#{SUDO} gem install randexp --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{GEM_NAME} -v#{GEM_VERSION} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{GEM_NAME} #{GEM_VERSION} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}, :verbose => false
+  end
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/lib/dm-sweatshop.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+gem 'dm-core', '=0.9.6'
+require 'dm-core'
+require 'randexp'
+
+dir = Pathname(__FILE__).dirname.expand_path / 'dm-sweatshop'
+
+require dir / "version"
+require dir / "sweatshop"
+require dir / "model"

data/lib/dm-sweatshop/model.rb

@@ -0,0 +1,35 @@
+module DataMapper
+  module Model
+    def fixture(name = default_fauxture_name, &blk)
+      Sweatshop.add(self, name, &blk)
+    end
+
+    alias_method :fix, :fixture
+
+    def generate(name = default_fauxture_name, attributes = {})
+      name, attributes = default_fauxture_name, name if name.is_a? Hash
+      Sweatshop.create(self, name, attributes)
+    end
+
+    alias_method :gen, :generate
+
+    def generate_attributes(name = default_fauxture_name)
+      Sweatshop.attributes(self, name)
+    end
+
+    alias_method :gen_attrs, :generate_attributes
+
+    def make(name = default_fauxture_name, attributes = {})
+      name, attributes = default_fauxture_name, name if name.is_a? Hash
+      Sweatshop.make(self, name, attributes)
+    end
+
+    def pick(name = default_fauxture_name)
+      Sweatshop.pick(self, name)
+    end
+
+    def default_fauxture_name
+      :default
+    end
+  end
+end

data/lib/dm-sweatshop/sweatshop.rb

@@ -0,0 +1,49 @@
+module DataMapper
+  class Sweatshop
+    class << self
+      attr_accessor :model_map
+      attr_accessor :record_map
+    end
+
+    self.model_map = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = []}}
+    self.record_map = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = []}}
+
+    def self.add(klass, name, &proc)
+      self.model_map[klass][name.to_sym] << proc
+    end
+
+    def self.record(klass, name, instance)
+      self.record_map[klass][name.to_sym] << instance
+      instance
+    end
+
+    def self.create(klass, name, attributes = {})
+      begin
+        record(klass, name, klass.create(attributes(klass, name).merge(attributes)))
+      rescue StandardError => e
+        retry if e.message =~ /^column \w+ is not unique$/
+        raise e
+      end
+    end
+
+    def self.make(klass, name, attributes = {})
+      record(klass, name, klass.new(attributes(klass, name).merge(attributes)))
+    end
+
+    def self.pick(klass, name)
+      self.record_map[klass][name.to_sym].pick || raise(NoFixturesExist, "no #{name} context fixtures have been generated for the #{klass} class")
+    end
+
+    def self.attributes(klass, name)
+      proc = model_map[klass][name.to_sym].pick
+
+      if not proc.nil?
+        proc.call
+      elsif klass.superclass.is_a?(DataMapper::Model)
+        attributes(klass.superclass, name)
+      else
+        raise "#{name} fixture was not found"
+      end
+    end
+  end
+end

data/lib/dm-sweatshop/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  class Sweatshop
+    VERSION = "0.9.5"
+  end
+end

data/spec/dm-sweatshop/model_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DataMapper::Model do
+
+  class Widget
+    include DataMapper::Resource
+
+    property :id, Integer, :serial => true
+    property :type, Discriminator
+    property :name, String
+    property :price, Integer
+
+    belongs_to :order
+  end
+
+  class Wonket < Widget
+    property :size, String
+  end
+
+  class Order
+    include DataMapper::Resource
+
+    property :id, Integer, :serial => true
+
+    has n, :widgets
+  end
+
+  before(:each) do
+    DataMapper.auto_migrate!
+    DataMapper::Sweatshop.model_map.clear
+    DataMapper::Sweatshop.record_map.clear
+  end
+
+  describe ".fixture" do
+    it "should add a fixture proc for the model" do
+      Widget.fixture {{
+        :name => /\w+/.gen.capitalize,
+        :price => /\d{4,5}/.gen.to_i
+      }}
+
+      DataMapper::Sweatshop.model_map[Widget][:default].should_not be_empty
+    end
+  end
+
+  it "should allow handle complex named fixtures" do
+    Wonket.fix {{
+      :name => /\w+ Wonket/.gen.capitalize,
+      :price => /\d{2,3}99/.gen.to_i,
+      :size => %w[small medium large xl].pick
+    }}
+
+    Order.fix {{
+      :widgets => (1..5).of { Widget.gen }
+    }}
+
+    Order.fix(:wonket_order) {{
+      :widgets => (5..10).of { Wonket.gen }
+    }}
+
+    wonket_order = Order.gen(:wonket_order)
+    wonket_order.widgets.should_not be_empty
+  end
+
+  it "should allow for STI fixtures" do
+    Widget.fix {{
+      :name => /\w+/.gen.capitalize,
+      :price => /\d{4,5}/.gen.to_i
+    }}
+
+    Order.fix {{
+      :widgets => (1..5).of { Wonket.gen }
+    }}
+
+    Order.gen.widgets.should_not be_empty
+  end
+end

data/spec/dm-sweatshop/sweatshop_spec.rb

@@ -0,0 +1,143 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DataMapper::Sweatshop do
+
+  class Parent
+    include DataMapper::Resource
+    property :id, Integer, :serial => true
+    property :type, Discriminator
+    property :first_name, String
+    property :last_name, String
+  end
+
+  class Child < Parent
+    property :age, Integer
+  end
+
+  before(:each) do
+    DataMapper.auto_migrate!
+    DataMapper::Sweatshop.model_map.clear
+    DataMapper::Sweatshop.record_map.clear
+  end
+
+  describe ".model_map" do
+    it "should return a Hash if the model is not mapped" do
+      DataMapper::Sweatshop.model_map[Class.new].should be_is_a(Hash)
+    end
+
+    it "should return a map for names to an array of procs if the model is not mapped" do
+      DataMapper::Sweatshop.model_map[Class.new][:unnamed].should be_is_a(Array)
+    end
+  end
+
+  describe ".add" do
+    it "should app a generator proc to the model map" do
+      proc = lambda {}
+      lambda {
+        DataMapper::Sweatshop.add(Parent, :default, &proc)
+      }.should change {
+        DataMapper::Sweatshop.model_map[Parent][:default].first
+      }.from(nil).to(proc)
+    end
+
+    it "should push repeat procs onto the mapped array" do
+      proc1, proc2 = lambda {}, lambda {}
+
+      DataMapper::Sweatshop.add(Parent, :default, &proc1)
+      DataMapper::Sweatshop.add(Parent, :default, &proc2)
+
+      DataMapper::Sweatshop.model_map[Parent][:default].first.should == proc1
+      DataMapper::Sweatshop.model_map[Parent][:default].last.should == proc2
+    end
+  end
+
+  describe ".attributes" do
+    it "should return an attributes hash" do
+      DataMapper::Sweatshop.add(Parent, :default) {{
+        :first_name => /\w+/.gen.capitalize,
+        :last_name => /\w+/.gen.capitalize
+      }}
+
+      DataMapper::Sweatshop.attributes(Parent, :default).should be_is_a(Hash)
+    end
+
+    it "should call the attribute proc on each call to attributes" do
+      calls = 0
+      proc = lambda {{:calls => (calls += 1)}}
+
+      DataMapper::Sweatshop.add(Parent, :default, &proc)
+      DataMapper::Sweatshop.attributes(Parent, :default).should == {:calls => 1}
+      DataMapper::Sweatshop.attributes(Parent, :default).should == {:calls => 2}
+    end
+
+    it "should call attributes with the superclass if the class is not mapped" do
+      DataMapper::Sweatshop.add(Parent, :default) {{:first_name => 'Bob'}}
+      DataMapper::Sweatshop.attributes(Child, :default).should == {:first_name => 'Bob'}
+    end
+
+    it "should raise an error if neither the class or it's parent class(es) have been mapped" do
+      lambda { DataMapper::Sweatshop.attributes(Child, :default) }.should raise_error("default fixture was not found")
+    end
+  end
+
+  describe ".create" do
+    it "should call create on the model class with the attributes generated from a mapped proc" do
+      DataMapper::Sweatshop.add(Parent, :default) {{
+        :first_name => 'Kenny',
+        :last_name => 'Rogers'
+      }}
+
+      Parent.should_receive(:create).with(:first_name => 'Kenny', :last_name => 'Rogers')
+
+      DataMapper::Sweatshop.create(Parent, :default)
+    end
+
+    it "should call create on the model with a parent class' mapped attributes proc when the original class has not been maped" do
+      DataMapper::Sweatshop.add(Parent, :default) {{
+        :first_name => 'Kenny',
+        :last_name => 'Rogers'
+      }}
+
+      Child.should_receive(:create).with(:first_name => 'Kenny', :last_name => 'Rogers')
+
+      DataMapper::Sweatshop.create(Child, :default)
+    end
+
+    it "should merge in any attributes as an argument" do
+      DataMapper::Sweatshop.add(Parent, :default) {{
+        :first_name => 'Kenny',
+        :last_name => 'Rogers'
+      }}
+
+      Parent.should_receive(:create).with(:first_name => 'Roddy', :last_name => 'Rogers')
+
+      DataMapper::Sweatshop.create(Parent, :default, :first_name => 'Roddy')
+    end
+  end
+
+  describe ".make" do
+    it "should call new on the model class with the attributes generated from a mapped proc" do
+      DataMapper::Sweatshop.add(Parent, :default) {{
+        :first_name => 'Kenny',
+        :last_name => 'Rogers'
+      }}
+
+      Parent.should_receive(:new).with(:first_name => 'Kenny', :last_name => 'Rogers')
+
+      DataMapper::Sweatshop.make(Parent, :default)
+    end
+  end
+
+  describe ".pick" do
+    it "should return a pre existing instance of a model from the record map" do
+      DataMapper::Sweatshop.add(Parent, :default) {{
+        :first_name => 'George',
+        :last_name => 'Clinton'
+      }}
+
+      DataMapper::Sweatshop.create(Parent, :default)
+
+      DataMapper::Sweatshop.pick(Parent, :default).should be_is_a(Parent)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'dm-sweatshop'
+
+DataMapper.setup(:default, 'sqlite3::memory:')
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: dm-sweatshop
+version: !ruby/object:Gem::Version 
+  version: 0.9.5
+platform: ruby
+authors: 
+- Ben Burkert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: randexp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+    version: 
+description: DataMapper plugin for building pseudo random models
+email: 
+- ben@benburkert.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+- TODO
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.textile
+- Rakefile
+- TODO
+- lib/dm-sweatshop.rb
+- lib/dm-sweatshop/sweatshop.rb
+- lib/dm-sweatshop/model.rb
+- lib/dm-sweatshop/version.rb
+- spec/dm-sweatshop/model_spec.rb
+- spec/dm-sweatshop/sweatshop_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-Sweatshop
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: datamapper
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin for building pseudo random models
+test_files: []
+