barn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46fea679db70558d95e5db74e670a33a57e400d8
+  data.tar.gz: 93fd295b38be5e6fdf479b385f1db050f542d289
+SHA512:
+  metadata.gz: c8bbd9f3c336207bb12fd2427361e5e2f128aea2e62519a2f2155be6cf2045d1bbd6ebb7c1b4f56cb3030b297ae9f7107e97bdd87a05d805024375562fe3b1d3
+  data.tar.gz: d1b34e51048f4e60e58fb915921a7bc9839dd345095d5dddb45cfe62096dbabdd320e5fcd8d25f44c29591cfacfc5c2ed058e5d5638399781223098afe41fead

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 barn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jerry Cheung
+
+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,111 @@
+# Barn
+
+Store lazily evaluated blocks for building test fixtures.
+
+## Usage
+
+```ruby
+# Define factories with lazily evaluated blocks
+Barn.define :post do
+  :title => "What's Your Dream Barn Find?",
+  :published_at => Time.now
+end
+
+# Build instances and override default attributes
+Barn.build(:post, :title => "Original Owner Jaguar E-Type For Sale")
+
+# Compose complex objects
+Barn.define :comment do
+  :post => build(:post),
+  :body => "That's a lot of hay for a little pay."
+end
+```
+
+## Namespacing
+
+When you define factories, they are stored in the global `Barn` namespace by
+default. But we do allow you to create your own namespaces.
+
+```ruby
+module Factory
+  module Post
+    extend Barn::Namespace
+
+    define :draft {...}
+    define :published {...}
+  end
+end
+
+Factory::Post.build(:draft)
+```
+
+## Build Chains
+
+A build chain is a list of builders that are called to instantiate an instance.
+It's the same concept as Rack middleware, but we build object instances instead
+of HTTP responses. A builder is anything that responds to `build` and returns a
+contructed object. An environment hash of available options to passed to
+`build`. The default build chain has one builder, [Barn::Builders::HashMerge],
+that merges attributes into a hash. See [/lib/barn/builders] for more examples.
+
+```ruby
+# Inspect a build chain
+Barn.build_chain
+=> [Barn::Builders::HashMerge]  # Default is to merge hash attributes
+
+# After building hash attributes, instantiates an ActiveRecord object
+Barn.build_chain.unshift Barn::Builders::ActiveRecord
+
+# Instrument the time it takes to run a build chain
+Barn.build_chain.unshift Barn::Builders::Instrumentation
+
+Barn.build_chain
+=> [Barn::Builders::Instrumentation, Barn::Builders::ActiveRecord, Barn::Builders::HashMerge]
+```
+
+## Helpers
+
+Barn provides helpers to let you type less in your tests. Include
+`Barn.helpers` to skip typing `Barn.build` and `Barn.define`.
+
+```ruby
+# RSpec
+RSpec.configure { |c| c.include Barn::Helpers }
+
+describe "Post" do
+  it "requires a title" do
+    post = build(:post)
+  end
+end
+
+# ActiveSupport::TestCase
+class PostTest < ActiveSupport::TestCase
+  include Barn::Helpers
+
+  test "requires a title" do
+    post = build(:post)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'barn'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barn
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/barn.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "barn"
+  spec.version       = Barn::VERSION
+  spec.authors       = ["Jerry Cheung"]
+  spec.email         = ["jch@whatcodecraves.com"]
+  spec.description   = %q{Store lazily evaluated blocks for building test fixtures}
+  spec.summary       = %q{Small no-magic library for building test factories}
+  spec.homepage      = "https://github.com/jch/barn"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "debugger"
+end

data/lib/barn.rb

@@ -0,0 +1,10 @@
+require "barn/version"
+require "barn/factory"
+require "barn/namespace"
+require "barn/helpers"
+
+require "barn/builders/hash"
+
+module Barn
+  extend Namespace
+end

data/lib/barn/builders/hash.rb

@@ -0,0 +1,18 @@
+module Barn
+  module Builders
+    class Hash
+      def initialize(app)
+        @app = app
+      end
+
+      # `env` is a hash with:
+      #    :name    - symbol name of the factory
+      #    :options - optional params passed to `Barn.define`
+      #    :args    - parameters passed to the block of`Barn.build`
+      def call(env)
+        object = @app.call(env)
+        object.merge(env[:args])
+      end
+    end
+  end
+end

data/lib/barn/factory.rb

@@ -0,0 +1,20 @@
+module Barn
+  # maybe Proc already defines __FILENAME__ and __LINENUMBER__
+  class Factory
+    # help with debugging where something was defined
+    attr_accessor :filename, :line
+
+    attr_reader :name, :options
+
+    def initialize(name, options = {}, &blk)
+      @name    = name
+      @options = options
+      @blk     = blk
+    end
+
+    # Returns built object
+    def call(env)
+      @blk.call(env)
+    end
+  end
+end

data/lib/barn/helpers.rb

@@ -0,0 +1,29 @@
+require 'forwardable'
+
+module Barn
+  # Forwards all `define` and `build` calls to a barn configured on the class.
+  #
+  # class SomeTest
+  #   include Barn::Helpers
+  #   self.barn = MyCustomBarn
+  # end
+  module Helpers
+    def self.included(base)
+      base.class_eval do
+        extend Forwardable
+        def_delegators :"self.class.barn", :define, :build
+
+        class <<self
+          extend Forwardable
+          def_delegators :"self.barn", :define, :build
+
+          attr_writer :barn
+          def barn
+            @barn || ::Barn
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/barn/namespace.rb

@@ -0,0 +1,33 @@
+module Barn
+  module Namespace
+    def define(name, factory_options = {}, &blk)
+      blk ||= Proc.new {}
+      factories[name] = Factory.new(name, factory_options, &blk)
+    end
+
+    def build(name, build_options = {})
+      factory = factories[name]
+
+      chained_builder = build_chain.reverse.reduce(factory) do |final, builder|
+        builder.new(final)
+      end  # not caching this for simplicity
+
+      chained_builder.call \
+        :factory => factory,
+        :args    => build_options
+    end
+
+    def build_chain
+      @build_chain ||= [Barn::Builders::Hash]
+    end
+
+    def factories
+      @factories ||= {}
+    end
+
+    def reset
+      @computed_chain = nil
+      @factories = {}
+    end
+  end
+end

data/lib/barn/version.rb

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

data/test/barn_test.rb

@@ -0,0 +1,50 @@
+require 'barn'
+require 'minitest/autorun'
+
+class BarnTest < MiniTest::Test
+  def setup
+    Barn.reset
+    Barn.define :user do
+      {:email => "jollyjerry@gmail.com"}
+    end
+  end
+
+  def test_define
+    assert Barn.factories[:user]
+  end
+
+  def test_double_define_error
+  end
+
+  def test_build
+    user = Barn.build(:user)
+    assert_equal 'jollyjerry@gmail.com', user[:email]
+  end
+
+  def test_build_override
+    user = Barn.build(:user, :email => 'jch@whatcodecraves.com')
+    assert_equal 'jch@whatcodecraves.com', user[:email]
+  end
+
+  def test_build_unknown
+
+  end
+
+  def test_helpers
+    custom_barn = Module.new do
+      extend Barn::Namespace
+
+      define :foo
+    end
+
+    klass = Class.new do
+      include Barn::Helpers
+      self.barn = custom_barn
+
+      define :bar
+    end
+
+    assert custom_barn.factories[:foo]
+    assert custom_barn.factories[:bar]
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: barn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jerry Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Store lazily evaluated blocks for building test fixtures
+email:
+- jch@whatcodecraves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- barn.gemspec
+- lib/barn.rb
+- lib/barn/builders/hash.rb
+- lib/barn/factory.rb
+- lib/barn/helpers.rb
+- lib/barn/namespace.rb
+- lib/barn/version.rb
+- test/barn_test.rb
+homepage: https://github.com/jch/barn
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Small no-magic library for building test factories
+test_files:
+- test/barn_test.rb