forge-factories 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in forge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matte Noble
+
+MIT License
+
+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.md

@@ -0,0 +1,60 @@
+# Forge
+
+A Factory library that's about as barebones as you can get.
+
+## Define Factories
+
+```ruby
+Forge.define(:user, User) do |u|
+  u.name = "Spike Spiegel"
+  u.location = "Mars"
+end
+```
+
+## Defining Factories That Use Other Factories
+
+```ruby
+Forge.define(:ship, Ship) do |s|
+  s.name = "Bebop"
+end
+
+Forge.define(:user, User) do |u|
+  u.name = "Spike Spiegel"
+  u.ship = Forge.build(:ship)
+end
+```
+
+## Building Objects
+
+```ruby
+Forge.build(:user)
+```
+
+## Building Objects and Overriding Attributes
+
+```ruby
+Forge.build(:user, name: "Jet")
+```
+
+## DSL
+
+You can drop the `Forge` part of the methods if you include
+`Forge::DSL`.
+
+```ruby
+RSpec.configure do |config|
+  config.include Forge::DSL
+end
+
+it "..." do
+  build(:user).should be_awesome
+end
+```
+
+## Errors
+
+`Forge::DuplicateFactoryError`
+Raised when you try to define two factories using the same name.
+
+`Forge::MissingFactoryError`
+Raised when you try to build a factory that has not been defined.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/forge.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forge/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "forge-factories"
+  gem.version       = Forge::VERSION
+  gem.authors       = ["Matte Noble"]
+  gem.email         = ["me@mattenoble.com"]
+  gem.description   = %q{Barebones factories}
+  gem.summary       = %q{Barebones factories}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/forge/version.rb

@@ -0,0 +1,3 @@
+module Forge
+  VERSION = "0.0.1"
+end

data/lib/forge.rb

@@ -0,0 +1,71 @@
+require "forge/version"
+
+module Forge
+  class ForgeError < StandardError
+  end
+
+  class DuplicateFactoryError < ForgeError
+  end
+
+  class MissingFactoryError < ForgeError
+  end
+
+  class << self
+    attr_accessor :registry
+  end
+
+  def self.reset!
+    @registry = {}
+  end
+
+  def self.define(name, klass, &block)
+    @registry ||= {}
+    raise DuplicateFactoryError if @registry[name]
+    @registry[name] = Definition.new(klass, &block)
+  end
+
+  def self.build(name, attrs={})
+    raise MissingFactoryError unless @registry[name]
+    @registry[name].build(attrs)
+  end
+
+  def self.create(name, attrs={})
+    raise MissingFactoryError unless @registry[name]
+    @registry[name].create(attrs)
+  end
+
+  class Definition
+    attr_accessor :klass, :block
+
+    def initialize(klass, &block)
+      @klass = klass
+      @block = block
+    end
+
+    def build(attrs={})
+      instance = @klass.new.tap { |o| @block.call(o) }
+      attrs.each { |k,v| instance.public_send(:"#{k}=", v) }
+      instance
+    end
+
+    def create(attrs={})
+      build(attrs).tap { |o| o.save }
+    end
+  end
+
+  module DSL
+    def define(*args, &block)
+      Forge.define(*args, &block)
+    end
+
+    def build(*args)
+      Forge.build(*args)
+    end
+
+    alias_method :forge, :build
+
+    def create(*args)
+      Forge.create(*args)
+    end
+  end
+end

data/spec/forge_spec.rb

@@ -0,0 +1,48 @@
+require "ostruct"
+require_relative "../lib/forge"
+
+describe Forge do
+  class User < OpenStruct; end
+
+  before do
+    Forge.reset!
+    Forge.define(:user, User) do |u|
+      u.name = "Spike"
+      u.location = "Mars"
+    end
+  end
+
+  it "saves factory definitions to a registry" do
+    Forge.registry[:user].should_not be_nil
+  end
+
+  it "raises an error when defining the same factory twice" do
+    expect { Forge.define(:user, User) }.to raise_error(Forge::DuplicateFactoryError)
+  end
+
+  it "builds a forged object of the type specified when defining it" do
+    Forge.build(:user).should be_a User
+  end
+
+  it "sets attributes on the forged objects based on the block passed during definition" do
+    Forge.build(:user).name.should == "Spike"
+  end
+
+  it "allows attributes to be overwritten via build" do
+    Forge.build(:user, name: "Jet").name.should == "Jet"
+  end
+
+  it "raises an error when trying to build a non-existent factory" do
+    expect { Forge.build(:not_a_thing) }.to raise_error(Forge::MissingFactoryError)
+  end
+
+  it "creates factories with an attribute that is another factory to be built" do
+    Forge.define(:bounty_hunter, User) do |f|
+      f.name = "Spike"
+      f.location = "Mars"
+      f.partner = Forge.build(:user, name: "Jet")
+    end
+
+    Forge.build(:bounty_hunter).partner.name.should == "Jet"
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: forge-factories
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matte Noble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Barebones factories
+email:
+- me@mattenoble.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- forge.gemspec
+- lib/forge.rb
+- lib/forge/version.rb
+- spec/forge_spec.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2953300044199411992
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2953300044199411992
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Barebones factories
+test_files:
+- spec/forge_spec.rb