notahat-machinist 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Peter Yandell
+
+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

@@ -0,0 +1,201 @@
+Machinist
+=========
+
+*Fixtures aren't fun. Machinist is.*
+
+Machinist lets you construct test data on the fly, but instead of doing this:
+
+    describe Comment do
+      before do
+        @user = User.create!(:name => "Test User")
+        @post = Post.create!(:title => "Test Post", :author => @user, :body => "Lorem ipsum...")
+        @comment = Comment.create!(
+          :post => @post, :author_name => "Test Commenter", :author_email => "commenter@example.com",
+          :spam => true
+        )
+      end
+    
+      it "should not include comments marked as spam in the without_spam named scope" do
+        Comment.without_spam.should_not include(@comment)
+      end
+    end
+  
+you can just do this:
+
+    describe Comment do
+      before do
+        @comment = Comment.make(:spam => true)
+      end
+    
+      it "should not include comments marked as spam in the without_spam named scope" do
+        Comment.without_spam.should_not include(@comment)
+      end
+    end
+  
+Machinist generates data for the fields you don't care about, and constructs any necessary associated objects.
+
+You tell Machinist how to do this with blueprints:
+
+    require 'faker'
+  
+    Sham.name  { Faker::Name.name }
+    Sham.email { Faker::Internet.email }
+    Sham.title { Faker::Lorem.sentence }
+    Sham.body  { Faker::Lorem.paragraph }
+  
+    User.blueprint do
+      name { Sham.name }
+    end
+  
+    Post.blueprint do
+      title  { Sham.title }
+      author { User.make }
+      body   { Sham.body }
+    end
+  
+    Comment.blueprint do
+      post
+      author_name  { Sham.name }
+      author_email { Sham.email }
+      body         { Sham.body }
+    end
+
+
+Installation
+------------
+
+Install the plugin:
+
+    ./script/plugin install git://github.com/notahat/machinist.git
+  
+Create a blueprints.rb in your test (or spec) directory, and require it in your test\_helper.rb (or spec\_helper.rb):
+
+    require File.expand_path(File.dirname(__FILE__) + "/blueprints")
+
+Set Sham to reset before each test. In the `class Test::Unit::TestCase` block in your test\_helper.rb, add:
+    
+    setup { Sham.reset }
+    
+or, if you're on RSpec, in the `Spec::Runner.configure` block in your spec\_helper.rb, add:
+
+    config.before(:each) { Sham.reset }
+    
+    
+Sham - Generating Attribute Values
+----------------------------------
+
+Sham lets you generate random but repeatable unique attributes values.
+
+For example, you could define a way to generate random names as:
+
+    Sham.name { (1..10).map { ('a'..'z').to_a.rand } }
+
+Then, to generate a name, call:
+
+    Sham.name
+
+So why not just define a method? Sham ensures two things for you:
+
+1. You get the same sequence of values each time your test is run
+2. You don't get any duplicate values
+    
+Sham works very well with the excellent [Faker gem](http://faker.rubyforge.org/) by Benjamin Curtis. Using this, a much nicer way to generate names is:
+    
+    Sham.name { Faker::Name.name }
+    
+Sham also supports generating numbered sequences if you prefer.
+
+    Sham.name {|index| "Name #{index}" }
+    
+If you want to allow duplicate values for a sham, you can pass the `:unique` option:
+
+    Sham.coin_toss(:unique => false) { rand(2) == 0 : 'heads' : 'tails' }
+
+
+Blueprints - Generating ActiveRecord Objects
+--------------------------------------------
+
+A blueprint describes how to build a generic object for an ActiveRecord model. The idea is that you let the blueprint take care of constructing all the objects and attributes that you don't care about in your test, leaving you to focus on the just the things that you're testing.
+
+A simple blueprint might look like this:
+
+    Comment.blueprint do
+      body "A comment!"
+    end
+
+Once that's defined, you can construct a comment from this blueprint with:
+    
+    Comment.make
+    
+Machinist calls `save!` on your ActiveRecord model to create the comment, so it will throw an exception if the blueprint doesn't pass your validations. It also calls `reload` after the `save!`.
+
+You can override values defined in the blueprint by passing parameters to make:
+
+    Comment.make(:body => "A different comment!")
+    
+Rather than providing a constant value for an attribute, you can use Sham to generate a value for each new object:
+
+    Sham.body { Faker::Lorem.paragraph }
+    Comment.blueprint do
+      body { Sham.body }
+    end
+    
+Notice the curly braces around `Sham.body`. If you call `Comment.make` with your own body attribute, this block will not be executed.
+
+You can use this same syntax to generate associated objects:
+    
+    Comment.blueprint do
+      post { Post.make }
+    end
+    
+If the associated model has the same name as the field, you can abbreviate this to:
+    
+    Comment.blueprint do
+      post
+    end
+    
+You can refer to already assigned attributes when constructing a new attribute:
+    
+    Comment.blueprint do
+      post
+      body { "Comment on " + post.name }
+    end
+    
+You can also override associated objects when calling make:
+
+    post = Post.make
+    3.times { Comment.make(:post => post) }
+
+It's common to need to construct an object with particular attributes, or a particular object graph, in a number of tests. The best way to abstract out the construction is to put something like this in your blueprints.rb:
+
+    class Post
+      def self.make_with_comments(attributes = {})
+        Post.make(attributes) do |post|
+          3.times { Comment.make(:post => post) }
+        end
+      end
+    end
+    
+Note that make can take a block, into which it will pass the newly constructed object.
+
+If you want to generate an object graph without saving to the database, use make\_unsaved:
+
+    Comment.make_unsaved
+    
+This will generate both the Comment and the associated Post without saving either.
+
+
+Credits
+-------
+
+Written by [Pete Yandell](http://notahat.com/).
+    
+Contributors:
+
+- [Roland Swingler](http://github.com/knaveofdiamonds)
+
+Thanks to Thoughtbot's [Factory Girl](http://github.com/thoughtbot/factory_girl/tree/master). Machinist was written because I loved the idea behind Factory Girl, but I thought the philosophy wasn't quite right, and I hated the syntax.
+
+---
+    
+Copyright (c) 2008 Peter Yandell, released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+require 'echoe'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run all the specs for the machinist plugin.'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--colour']
+  t.rcov = true
+end
+
+Echoe.new('machinist', '0.1.0') do |p|
+  p.description = "Fixtures aren't fun. Machinist is."
+  p.url         = "http://github.com/notahat/machinist"
+  p.author      = "Pete Yandell"
+  p.email       = "pete@notahat.com"
+  p.ignore_pattern = ["coverage/*", "pkg/**/*", "spec/*"]
+  p.has_rdoc = false
+  p.development_dependencies = []
+end

data/init.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+
+if RAILS_ENV == 'test'
+  require 'machinist'
+  require 'sham'
+
+  class ActiveRecord::Base
+    include Machinist::ActiveRecordExtensions
+  end
+end

data/lib/machinist.rb

@@ -0,0 +1,77 @@
+require 'active_support'
+
+module Machinist
+  def self.with_save_nerfed
+    begin
+      @@nerfed = true
+      yield
+    ensure
+      @@nerfed = false
+    end
+  end
+  
+  @@nerfed = false
+  def self.nerfed?
+    @@nerfed
+  end
+  
+  module ActiveRecordExtensions
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def blueprint(&blueprint)
+        @blueprint = blueprint
+      end
+  
+      def make(attributes = {})
+        raise "No blueprint for class #{self}" if @blueprint.nil?
+        lathe = Lathe.new(self.new, attributes)
+        lathe.instance_eval(&@blueprint)
+        unless Machinist.nerfed?
+          lathe.object.save!
+          lathe.object.reload
+        end
+        returning(lathe.object) do |object|
+          yield object if block_given?
+        end
+      end
+    
+      def make_unsaved(attributes = {})
+        returning(Machinist.with_save_nerfed { make(attributes) }) do |object|
+          yield object if block_given?
+        end
+      end
+    end
+  end
+  
+  class Lathe
+    def initialize(object, attributes)
+      @object = object
+      @assigned_attributes = []
+      attributes.each do |key, value|
+        @object.send("#{key}=", value)
+        @assigned_attributes << key
+      end
+    end
+
+    attr_reader :object
+
+    def method_missing(symbol, *args, &block)
+      if @assigned_attributes.include?(symbol)
+        @object.send(symbol)
+      else
+        value = if block
+          block.call
+        elsif args.first.is_a?(Hash) || args.empty?
+          symbol.to_s.camelize.constantize.make(args.first || {})
+        else
+          args.first
+        end
+        @object.send("#{symbol}=", value)
+        @assigned_attributes << symbol
+      end
+    end
+  end
+end

data/lib/sham.rb

@@ -0,0 +1,65 @@
+require 'active_support'
+
+class Sham
+  @@shams = {}
+  
+  # Over-ride module's built-in name method, so we can re-use it for
+  # generating names. This is a bit of a no-no, but we get away with
+  # it in this context.
+  def self.name(*args, &block)
+    method_missing(:name, *args, &block)
+  end
+  
+  def self.method_missing(symbol, *args, &block)
+    if block_given?
+      @@shams[symbol] = Sham.new(symbol, args.pop || {}, &block)
+    else
+      sham = @@shams[symbol]
+      raise "No sham defined for #{symbol}" if sham.nil?
+      sham.fetch_value
+    end
+  end
+
+  def self.reset
+    @@shams.values.each(&:reset)
+  end
+  
+  def initialize(name, options = {}, &block)
+    @name      = name
+    @generator = block
+    @offset    = 0
+    @unique    = options.has_key?(:unique) ? options[:unique] : true
+    generate_values(12)
+  end
+  
+  def reset
+    @offset = 0
+  end
+  
+  def fetch_value
+    # Generate more values if we need them.
+    if @offset >= @values.length
+      generate_values(2 * @values.length)
+      raise "Can't generate more unique values for Sham.#{@name}" if @offset >= @values.length
+    end
+    returning @values[@offset] do
+      @offset += 1
+    end
+  end
+    
+private
+  
+  def generate_values(count)
+    @values = seeded { (1..count).map(&@generator) }
+    @values.uniq! if @unique
+  end
+  
+  def seeded
+    begin
+      srand(1)
+      yield
+    ensure
+      srand
+    end
+  end
+end

data/machinist.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name = %q{machinist}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pete Yandell"]
+  s.date = %q{2008-11-18}
+  s.description = %q{Fixtures aren't fun. Machinist is.}
+  s.email = %q{pete@notahat.com}
+  s.extra_rdoc_files = ["lib/machinist.rb", "lib/sham.rb", "README.markdown"]
+  s.files = ["init.rb", "lib/machinist.rb", "lib/sham.rb", "machinist.gemspec", "Manifest", "MIT-LICENSE", "rails/init.rb", "Rakefile", "README.markdown"]
+  s.homepage = %q{http://github.com/notahat/machinist}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Machinist", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{machinist}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Fixtures aren't fun. Machinist is.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/rails/init.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+
+if RAILS_ENV == 'test'
+  require 'machinist'
+  require 'sham'
+
+  class ActiveRecord::Base
+    include Machinist::ActiveRecordExtensions
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: notahat-machinist
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete Yandell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-18 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Fixtures aren't fun. Machinist is.
+email: pete@notahat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/machinist.rb
+- lib/sham.rb
+- README.markdown
+files: 
+- init.rb
+- lib/machinist.rb
+- lib/sham.rb
+- machinist.gemspec
+- Manifest
+- MIT-LICENSE
+- rails/init.rb
+- Rakefile
+- README.markdown
+has_rdoc: false
+homepage: http://github.com/notahat/machinist
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Machinist
+- --main
+- README.markdown
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: machinist
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Fixtures aren't fun. Machinist is.
+test_files: []
+