assembly_line 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sandro Turriate
+
+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,97 @@
+Assembly Line
+=============
+
+Assembly Line allows you to group together a series of rspec `let` statements which can later be evaluated to set up a specific state for your specs. It's an excellent compliment to factory_girl because you can use your factories to build up each component, then use AssemblyLine to bring them all together.
+
+As a system grows in complexity, more objects are required to set up the necessary state to write tests. Sometimes you'll need to write a test that requires access to the beginning, middle, and end of a very large hierarchy, and AssemblyLine can expose each part of the hierarchy that you care about.  
+
+Installation
+------------
+    gem install assembly_line
+
+Edit your *spec/spec_helper.rb*  
+
+    require 'assembly_line' # unnecessary if you've used config.gem 'assembly_line'
+    require 'spec/support/assemblies' # unnecessary if your spec_helper already requires spec/support/*
+
+    Spec::Runner.configure do |config|
+	  config.extend AssemblyLine
+	end
+	
+Define an AssemblyLine
+
+	Assembly.define(:user_with_payment_address) do
+	  let(:user) { Factory(:user)}
+	  let(:payment_address) { Factory(:payment_address, :user => user) }
+	end
+	
+Example
+-------
+	
+Place your AssemblyLine definitions in *spec/support/assemblies.rb*
+
+	AssemblyLine.define(:drinks) do
+	  let(:drinks) { [:gin, :vodka] }
+	end
+
+	AssemblyLine.define(:party) do
+	  depends_on :drinks
+
+	  let(:host) { :rochelle }
+	  let(:attendees) { [:nick, :ellis, :coach] }
+	  let(:party) { @party = Party.new(host, attendees) }
+	  let(:party_crasher) { attendees << :crasher; :crasher }
+	end
+	
+Use your AssemblyLine in a test
+
+	describe "README example" do
+	  context "attendees" do
+	    Assemble(:party)
+
+	    it "does not count the host as an attendee" do
+	      party.attendees.should_not include(host)
+	    end
+	  end
+
+	  context "party crasher" do
+	    Assemble(:party).invoke(:party_crasher)
+
+	    it "exemplifies method invocation after assembly" do
+	      party.attendees.should include(:crasher)
+	    end
+	  end
+
+	  context "drinks" do
+	    Assemble(:party)
+
+	    it "does not include the list of standard drinks" do
+	      party.drinks.should_not include(drinks)
+	    end
+	  end
+	end
+
+Thanks!
+-------
+
+- l4rk     (initial spike declaring modules and including them in the rspec context)
+- veezus   (code contributions, introduced modular design / dependencies)
+- bigtiger (named the project)
+- leshill  (support and testing)
+
+
+Note on Patches/Pull Requests
+-----------------------------
+
+- Fork the project.
+- Make your feature addition or bug fix.
+- Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+- Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+- Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2010 Sandro Turriate. See MIT_LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "assembly_line"
+    gem.summary = %Q{Modularize setup blocks for rspec}
+    gem.description = %Q{Assembly Line allows you to group together a series of rspec `let` statements which can later be evaluated to set up a specific state for your specs.}
+    gem.email = "sandro.turriate@gmail.com"
+    gem.homepage = "http://github.com/sandro/assembly_line"
+    gem.authors = ["Sandro Turriate"]
+    gem.add_development_dependency "rspec", "1.2.9"
+    gem.add_development_dependency "yard", "0.5.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/assembly_line.rb

@@ -0,0 +1,19 @@
+require 'forwardable'
+require 'assembly_line/registry'
+require 'assembly_line/constructor'
+
+module AssemblyLine
+  VERSION = "0.1.0".freeze
+
+  def self.define(name, &block)
+    Registry.add(name, block)
+  end
+
+  def self.assemble(name, rspec_context, options={})
+    Registry.locate(name).assemble(rspec_context, options)
+  end
+
+  def Assemble(name, options={})
+    AssemblyLine.assemble(name, self, options)
+  end
+end

data/lib/assembly_line/constructor.rb

@@ -0,0 +1,48 @@
+module AssemblyLine
+  class Constructor
+    extend Forwardable
+
+    def_delegators :rspec_context, :let, :before
+
+    attr_reader :name, :code_block, :rspec_context, :options
+
+    def initialize(name, code_block)
+      @name = name
+      @code_block = code_block
+    end
+
+    def assemble(context, options)
+      @options = options
+      @rspec_context = context
+      instance_eval(&code_block)
+      self
+    end
+
+    def invoke(*methods)
+      if methods.any?
+        invoke_in_setup *methods
+      else
+        invoke_in_setup name
+      end
+    end
+
+    def depends_on(*constructors)
+      if options[:depends_on]
+        constructors = Array(options[:depends_on])
+      end
+      constructors.each do |name|
+        AssemblyLine.assemble(name, rspec_context)
+      end
+    end
+
+    protected
+
+    def invoke_in_setup(*methods)
+      before(:all) do
+        methods.each do |method_name|
+          send(method_name)
+        end
+      end
+    end
+  end
+end

data/lib/assembly_line/registry.rb

@@ -0,0 +1,27 @@
+module AssemblyLine
+  module Registry
+    extend self
+
+    def add(name, block)
+      constructors[name] = Constructor.new(name, block)
+    end
+
+    def list
+      constructors.keys.dup
+    end
+
+    def locate(name)
+      constructors[name] || raise(ArgumentError, "AssemblyLine could not find definition for: '#{name.inspect}'")
+    end
+
+    def clear
+      constructors.clear
+    end
+
+    protected
+
+    def constructors
+      @constructors ||= {}
+    end
+  end
+end

data/spec/assembly_line/constructor_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe AssemblyLine::Constructor do
+  let(:code_block) do
+    lambda do
+      depends_on :drinks
+
+      let(:host) { :rochelle }
+      let(:attendees) { [] }
+    end
+  end
+  let(:constructor) { AssemblyLine::Constructor.new(:gathering, code_block) }
+  let(:rspec_context) { mock('rspec_context', :let => nil, :depends_on => nil) }
+  let(:options) { {:depends_on => :location} }
+
+  describe "#assemble" do
+    before do
+      constructor.stub(:depends_on => nil)
+    end
+    it "persists context" do
+      constructor.assemble(rspec_context, options)
+      constructor.rspec_context.should == rspec_context
+    end
+
+    it "persists context" do
+      constructor.assemble(rspec_context, options)
+      constructor.options.should == options
+    end
+
+    it "evaluates the code block" do
+      rspec_context.should_receive(:let).twice
+      constructor.assemble(rspec_context, options)
+    end
+
+    it "returns itself" do
+      constructor.assemble(rspec_context, options).should == constructor
+    end
+  end
+
+  describe "#invoke" do
+    context "no arguments provided" do
+      it "calls the 'gathering' method" do
+        constructor.should_receive(:invoke_in_setup).with(:gathering)
+        constructor.invoke
+      end
+    end
+
+    context "arguments provided" do
+      it "calls the 'host' method" do
+        constructor.should_receive(:invoke_in_setup).with(:host)
+        constructor.invoke :host
+      end
+
+      it "calls the 'host' method followed by the 'attendees' method" do
+        constructor.should_receive(:invoke_in_setup).with(:host, :attendees)
+        constructor.invoke :host, :attendees
+      end
+    end
+  end
+
+  describe "#depends_on" do
+    context "declared in the assembly" do
+      it "attempts to assemble the 'drinks' dependency" do
+        AssemblyLine.should_receive(:assemble).with(:drinks, rspec_context)
+        constructor.assemble(rspec_context, {})
+      end
+    end
+
+    context "passed in from options" do
+      it "attempts to assemble the 'location' assembly" do
+        AssemblyLine.should_receive(:assemble).with(:location, rspec_context)
+        constructor.assemble(rspec_context, options)
+      end
+    end
+  end
+end

data/spec/assembly_line/registry_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe AssemblyLine::Registry do
+  let(:registry) { AssemblyLine::Registry.dup }
+  let(:code_block) { lambda {} }
+
+  after do
+    registry.clear
+  end
+
+  describe "#add" do
+    it "adds a new constructor to the list of registered assembly lines" do
+      registry.add(:party, code_block)
+      registry.list.should include(:party)
+    end
+  end
+
+  describe "#list" do
+    it "lists the registered assembly lines by name" do
+      registry.add(:one, code_block)
+      registry.add(:two, code_block)
+      registry.list.should =~ [:one, :two]
+    end
+  end
+
+  describe "#clear" do
+    it "clears the registry" do
+      registry.add(:one, code_block)
+      registry.add(:two, code_block)
+      expect do
+        registry.clear
+      end.to change { registry.list.size }.from(2).to(0)
+    end
+  end
+
+  describe "#locate" do
+    context "when AssemblyLine has been registered" do
+      before do
+        registry.add(:party, code_block)
+      end
+
+      it "returns the registered Constructor" do
+        registry.locate(:party).should be_instance_of(AssemblyLine::Constructor)
+      end
+    end
+
+    context "when AssemblyLine has not been registered" do
+      it "raises an ArgumentError" do
+        expect do
+          registry.locate(:does_not_exist)
+        end.to raise_error(ArgumentError, "AssemblyLine could not find definition for: ':does_not_exist'")
+      end
+    end
+  end
+end

data/spec/assembly_line_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe AssemblyLine do
+  context "API" do
+    subject { AssemblyLine }
+    it { should respond_to(:define) }
+    it { should respond_to(:assemble) }
+
+  end
+
+  describe ".define" do
+    it "adds the AssemblyLine to the Registry" do
+      definition = lambda {}
+      AssemblyLine::Registry.should_receive(:add).with(:user_with_address, definition)
+      AssemblyLine.define(:user_with_address, &definition)
+    end
+  end
+
+  describe ".assemble" do
+    let(:rspec_context) { mock('rspec context') }
+
+    context "cannot locate the AssemblyLine" do
+      it "raises an error" do
+        expect do
+          AssemblyLine.assemble(:does_not_exist, rspec_context)
+        end.to raise_error(ArgumentError)
+      end
+    end
+
+    context "AssemblyLine exists" do
+      it "assembles the AssemblyLine" do
+        constructor = mock('constructor')
+        constructor.should_receive(:assemble).with(rspec_context, options)
+        AssemblyLine::Registry.stub(:locate => constructor)
+        AssemblyLine.assemble(:party, rspec_context)
+      end
+    end
+  end
+
+  describe "#Assemble" do
+    it "delegates to AssemblyLine.assemble" do
+      klass = Class.new do
+        extend AssemblyLine
+      end
+      AssemblyLine.should_receive(:assemble).with(:party, klass, {})
+      klass.Assemble(:party)
+    end
+  end
+end

data/spec/functional/assemble_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe "AssemblyLine in practice" do
+  extend AssemblyLine
+
+  class Party < Struct.new(:host, :attendees)
+    attr_writer :drinks
+    def drinks
+      @drinks ||= []
+    end
+  end
+
+  AssemblyLine.define(:before_block) do
+    before(:each) do
+      @feedback = "before called"
+    end
+  end
+
+  AssemblyLine.define(:location) do
+    let(:location) { "123 main st." }
+  end
+
+  AssemblyLine.define(:drinks) do
+    let(:drinks) { [:gin, :vodka] }
+  end
+
+  AssemblyLine.define(:party) do
+    depends_on :drinks
+
+    let(:host) { :rochelle }
+    let(:attendees) { [:nick, :ellis, :coach] }
+    let(:party) { @party = Party.new(host, attendees) }
+    let(:party_crasher) { attendees << :crasher; :crasher }
+    let(:new_host) { party.host = :bob }
+  end
+
+  describe "invoking a method at assembly time" do
+    context "default invocation" do
+      Assemble(:party).invoke
+      it "has set up a party instance variable without explicitly calling 'party'" do
+        @party.should be_instance_of(Party)
+      end
+    end
+
+    context "invoking one method" do
+      Assemble(:party).invoke(:party_crasher)
+      it "added a party crasher to the party" do
+        attendees.should include(:crasher)
+      end
+    end
+
+    context "invoking many methods" do
+      Assemble(:party).invoke(:party_crasher, :new_host)
+      it "added a party crasher to the party" do
+        attendees.should include(:crasher)
+      end
+
+      it "changed the host to 'bob'" do
+        party.host.should == :bob
+      end
+    end
+  end
+
+  describe "dependencies" do
+    context "loading the built-in dependency" do
+      Assemble(:party)
+      it "loads the 'drinks' dependency when loading the party assembly" do
+        party
+        drinks.should == [:gin, :vodka]
+      end
+    end
+
+    context "overriding the dependency" do
+      Assemble(:party, :depends_on => :location)
+
+      it "loads the 'location' assembly line when loading the party assembly" do
+        party
+        location.should == "123 main st."
+      end
+
+      it "does not load the built-in 'drinks' dependency" do
+        party
+        expect do
+          drinks
+        end.to raise_error(NameError)
+      end
+    end
+  end
+
+  describe "before blocks" do
+    Assemble(:before_block)
+    it "invoked the before block" do
+      @feedback.should == "before called"
+    end
+  end
+
+  describe "README example" do
+    context "attendees" do
+      Assemble(:party)
+
+      it "does not count the host as an attendee" do
+        party.attendees.should_not include(host)
+      end
+    end
+
+    context "party crasher" do
+      Assemble(:party).invoke(:party_crasher)
+
+      it "exemplifies method invocation after assembly" do
+        party.attendees.should include(:crasher)
+      end
+    end
+
+    context "drinks" do
+      Assemble(:party)
+
+      it "does not include the list of standard drinks" do
+        party.drinks.should_not include(drinks)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'assembly_line'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: assembly_line
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sandro Turriate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+description: Assembly Line allows you to group together a series of rspec `let` statements which can later be evaluated to set up a specific state for your specs.
+email: sandro.turriate@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- .gitignore
+- MIT_LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/assembly_line.rb
+- lib/assembly_line/constructor.rb
+- lib/assembly_line/registry.rb
+- spec/assembly_line/constructor_spec.rb
+- spec/assembly_line/registry_spec.rb
+- spec/assembly_line_spec.rb
+- spec/functional/assemble_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sandro/assembly_line
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Modularize setup blocks for rspec
+test_files: 
+- spec/assembly_line/constructor_spec.rb
+- spec/assembly_line/registry_spec.rb
+- spec/assembly_line_spec.rb
+- spec/functional/assemble_spec.rb
+- spec/spec_helper.rb