fluent_fixtures 0.0.2

data/spec/fluent_fixtures/dsl_spec.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'fluent_fixtures/dsl'
+require 'faker'
+
+
+describe FluentFixtures::DSL do
+
+	let( :collection ) { Module.new {extend FluentFixtures::Collection} }
+
+	let( :fixtured_class ) do
+		Class.new do
+			def initialize( params={} )
+				@saved = false
+				params.each do |name, value|
+					self.send( "#{name}=", value )
+				end
+			end
+			attr_accessor :name, :login, :email
+			def save; @saved = true; end
+			def saved?; @saved; end
+			def bizarroify
+				self.name = "Bizarro #{self.name}"
+				self.email = "bizarro+#{self.email}"
+				self.login = "__#{self.login}__"
+				self
+			end
+		end
+	end
+
+
+	let!( :fixture_module ) do
+		mod = Module.new do
+			def self::name ; "UsageTests"; end
+		end
+		mod.extend( collection )
+		mod.fixtured_class( fixtured_class )
+		mod.base( :fixture ) do
+			self.name  ||= Faker::Name.name
+			self.login ||= Faker::Internet.user_name
+			self.email ||= Faker::Internet.email( self.login )
+		end
+		mod
+	end
+
+
+	it "allows the declaration of decorator blocks" do
+		no_email_block = Proc.new { self.email = nil }
+		fixture_module.decorator( :with_no_email, &no_email_block )
+		no_login_block = Proc.new  { self.login = nil }
+		fixture_module.decorator( :with_no_login, &no_login_block )
+
+		expect( fixture_module ).to have_decorator( :with_no_email )
+		expect( fixture_module ).to have_decorator( :with_no_login )
+
+		expect( fixture_module.decorators[:with_no_email] ).to be( no_email_block )
+		expect( fixture_module.decorators[:with_no_login] ).to be( no_login_block )
+	end
+
+
+	it "can register a creation hook to allow for unusual models" do
+		expect {
+			fixture_module.before_saving do |obj|
+				obj
+			end
+		}.to change { fixture_module.respond_to?(:call_before_saving) }.
+			from( false ).to( true )
+	end
+
+
+	it "can declare an alias for an already-declared decorator" do
+		fixture_module.decorator( :with_no_email ) { self.email = nil }
+		fixture_module.alias_decorator( :emailless, :with_no_email )
+
+		expect( fixture_module ).to have_decorator( :with_no_email )
+		expect( fixture_module ).to have_decorator( :emailless )
+	end
+
+
+	it "raises an error when an alias for a non-existent decorator is declared" do
+		expect {
+			fixture_module.alias_decorator( :an_alias, :nonexistent_decorator )
+		}.to raise_error( ScriptError, /undefined decorator.*nonexistent_decorator/ )
+	end
+
+
+	it "constructs the factory with the arguments passed to the base fixture" do
+		args = { name: 'Phil', login: 'phil', email: 'phil@phil.org' }
+
+		factory = collection.fixture( args )
+
+		expect( factory.constructor_args ).to eq([ args ])
+	end
+
+
+	it "constructs the factory with a block passed to the base fixture" do
+		block = Proc.new { self.tie = true }
+
+		factory = collection.fixture( &block )
+
+		expect( factory.constructor_block ).to eq( block )
+	end
+
+
+end
+

data/spec/fluent_fixtures/factory_spec.rb

@@ -0,0 +1,234 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'faker'
+require 'fluent_fixtures/factory'
+
+
+describe FluentFixtures::Factory do
+
+	let( :collection ) { Module.new {extend FluentFixtures::Collection} }
+
+	let( :fixtured_class ) do
+		Class.new do
+			def initialize( params={} )
+				@saved = false
+				params.each do |name, value|
+					self.send( "#{name}=", value )
+				end
+				yield if block_given?
+			end
+			attr_accessor :name, :login, :email
+			def save; @saved = true; end
+			def saved?; @saved; end
+			def bizarroify
+				self.name = "Bizarro #{self.name}"
+				self.email = "bizarro+#{self.email}"
+				self.login = "__#{self.login}__"
+				self
+			end
+		end
+	end
+
+
+	let( :fixture_module ) do
+		mod = Module.new
+		mod.extend( collection )
+		mod.fixtured_class( fixtured_class )
+		mod.base( :fixture ) do
+			self.name  ||= Faker::Name.name
+			self.login ||= Faker::Internet.user_name
+			self.email ||= Faker::Internet.email( self.login )
+		end
+		mod
+	end
+
+
+	let( :factory ) { described_class.new(fixture_module) }
+
+
+	it "can create an unsaved instance of the fixtured class" do
+		object = factory.instance
+		expect( object ).to be_a( fixtured_class )
+		expect( object ).to_not be_saved
+	end
+
+
+	it "can create a saved instance of the fixtured class" do
+		object = factory.create
+		expect( object ).to be_a( fixtured_class )
+		expect( object ).to be_saved
+	end
+
+
+	it "applies the base fixture decorator to all instances" do
+		object = factory.instance
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to_not be_nil
+		expect( object.login ).to_not be_nil
+		expect( object.email ).to_not be_nil
+	end
+
+
+	it "applies named decorators via fluent interface on the factory" do
+		fixture_module.decorator( :with_no_email ) { self.email = nil }
+		fixture_module.decorator( :with_no_login ) { self.login = nil }
+
+		object = factory.with_no_email.with_no_login.instance
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to_not be_nil
+		expect( object.login ).to be_nil
+		expect( object.email ).to be_nil
+	end
+
+
+	it "forwards constructor arguments to the class's constructor" do
+		factory = described_class.new( fixture_module, name: 'Phil', login: 'phil', email: 'phil@phil.org' )
+		object = factory.instance
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to eq( 'Phil' )
+		expect( object.login ).to eq( 'phil' )
+		expect( object.email ).to eq( 'phil@phil.org' )
+		expect( object ).to_not be_saved
+	end
+
+
+	it "forwards a constructor block to the class's constructor" do
+		called = false
+		factory = described_class.new( fixture_module ) do
+			called = true
+		end
+
+		expect { factory.instance }.to change { called }.to( true )
+	end
+
+
+	it "executes a block passed to #instance in the context of the new object if it doesn't declare arguments" do
+		object = factory.instance do
+			self.name = 'Dan'
+			self.login = 'danp'
+			self.email = 'danp@example.com'
+		end
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to eq( 'Dan' )
+		expect( object.login ).to eq( 'danp' )
+		expect( object.email ).to eq( 'danp@example.com' )
+		expect( object ).to_not be_saved
+	end
+
+
+	it "passes the new object to an #instance block if it accepts arguments" do
+		object = factory.instance do |instance|
+			instance.name = 'Dan'
+			instance.login = 'danp'
+			instance.email = 'danp@example.com'
+		end
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to eq( 'Dan' )
+		expect( object.login ).to eq( 'danp' )
+		expect( object.email ).to eq( 'danp@example.com' )
+		expect( object ).to_not be_saved
+	end
+
+
+	it "executes a block passed to #create in the context of the new object" do
+		object = factory.create do
+			self.name = 'Jenn'
+			self.login = 'jennnn'
+			self.email = 'jennnn@allthejennifers.org'
+		end
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to eq( 'Jenn' )
+		expect( object.login ).to eq( 'jennnn' )
+		expect( object.email ).to eq( 'jennnn@allthejennifers.org' )
+		expect( object ).to be_saved
+	end
+
+
+	it "passes the new object to a #create block if it accepts arguments" do
+		object = factory.create do |instance|
+			instance.name = 'Jenn'
+			instance.login = 'jennnn'
+			instance.email = 'jennnn@allthejennifers.org'
+		end
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to eq( 'Jenn' )
+		expect( object.login ).to eq( 'jennnn' )
+		expect( object.email ).to eq( 'jennnn@allthejennifers.org' )
+		expect( object ).to be_saved
+	end
+
+
+	it "allows ad-hoc decorators that call fluent mutator methods on the new object" do
+		object = factory.bizarroify.instance
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.name ).to start_with( 'Bizarro ')
+		expect( object.login ).to match( /\A__.*__\z/ )
+		expect( object.email ).to start_with( 'bizarro+' )
+		expect( object ).to_not be_saved
+	end
+
+
+	it "supports decorators that take one or more arguments" do
+		fixture_module.decorator( :with_email ) do |new_email|
+			self.email = new_email
+		end
+
+		object = factory.with_email( 'herzepholina@paquisod.org' ).instance
+
+		expect( object ).to be_a( fixtured_class )
+		expect( object.email ).to eq( 'herzepholina@paquisod.org' )
+		expect( object ).to_not be_saved
+	end
+
+
+	it "calls its fixture module's #call_before_saving method before creating if it implements it" do
+		def fixture_module.call_before_saving( instance )
+			:not_the_instance
+		end
+
+		result = factory.create
+
+		expect( result ).to be( :not_the_instance )
+	end
+
+
+	it "allows ad-hoc decorators declared as inline blocks" do
+		counter = 0
+		result = factory.decorated_with do |obj|
+			counter += 1
+		end
+
+		5.times do
+			expect {
+				result.instance
+			}.to change { counter }.by( 1 )
+		end
+	end
+
+
+	it "raises when asked for an instance if its fixture module doesn't declare a fixtured class" do
+		fixmod = Module.new
+		fixmod.extend( collection )
+		fixmod.base( :no_fixclass_fixture )
+
+		factory = described_class.new( fixmod )
+
+		expect {
+			factory.instance
+		}.to raise_error( ScriptError, /#{Regexp.escape fixmod.inspect}/ )
+	end
+
+
+
+end
+

data/spec/fluent_fixtures_spec.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative 'spec_helper'
+
+require 'fluent_fixtures'
+
+
+describe FluentFixtures do
+
+	it "has a semver version" do
+		expect( described_class::VERSION ).to match( /\A\d+\.\d+\.\d+(-[\p{Alnum}-]+)?/ )
+	end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'simplecov' if ENV['COVERAGE']
+
+require 'rspec'
+
+require 'loggability/spechelpers'
+
+
+### Mock with RSpec
+RSpec.configure do |config|
+	config.run_all_when_everything_filtered = true
+	config.filter_run :focus
+	config.order = 'random'
+	config.mock_with( :rspec ) do |mock|
+		mock.syntax = :expect
+	end
+
+	config.include( Loggability::SpecHelpers )
+end
+
+

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: fluent_fixtures
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMDCCAhigAwIBAgIBAjANBgkqhkiG9w0BAQUFADA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMTYwNjAyMDE1NTQ2WhcNMTcwNjAyMDE1NTQ2WjA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDb92mkyYwuGBg1oRxt2tkH
+  +Uo3LAsaL/APBfSLzy8o3+B3AUHKCjMUaVeBoZdWtMHB75X3VQlvXfZMyBxj59Vo
+  cDthr3zdao4HnyrzAIQf7BO5Y8KBwVD+yyXCD/N65TTwqsQnO3ie7U5/9ut1rnNr
+  OkOzAscMwkfQxBkXDzjvAWa6UF4c5c9kR/T79iA21kDx9+bUMentU59aCJtUcbxa
+  7kcKJhPEYsk4OdxR9q2dphNMFDQsIdRO8rywX5FRHvcb+qnXC17RvxLHtOjysPtp
+  EWsYoZMxyCDJpUqbwoeiM+tAHoz2ABMv3Ahie3Qeb6+MZNAtMmaWfBx3dg2u+/WN
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSZ0hCV
+  qoHr122fGKelqffzEQBhszANBgkqhkiG9w0BAQUFAAOCAQEAF2XCzjfTFxkcVvuj
+  hhBezFkZnMDYtWezg4QCkR0RHg4sl1LdXjpvvI59SIgD/evD1hOteGKsXqD8t0E4
+  OPAWWv/z+JRma72zeYsBZLSDRPIUvBoul6qCpvY0MiWTh496mFwOxT5lvSAUoh+U
+  pQ/MQeH/yC6hbGp7IYska6J8T4z5XkYqafYZ3eKQ8H+xPd/z+gYx+jd0PfkWf1Wk
+  QQdziL01SKBHf33OAH/p/puCpwS+ZDfgnNx5oMijWbc671UXkrt7zjD0kGakq+9I
+  hnfm736z8j1wvWddqf45++gwPpDr1E4zoAq2PgRl/WBNyR0hfoZLpi3TnHu3eC0x
+  uALKNA==
+  -----END CERTIFICATE-----
+date: 2016-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-mercurial
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: hoe-deveiate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: hoe-highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-fivefish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+description: |-
+  A toolkit for building a collection of composable testing fixtures with a fluent interface.
+
+  To get started using the library, check out the [Getting Started](GettingStarted_md.html) guide.
+email:
+- ged@FaerieMUD.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- GettingStarted.md
+- History.md
+- LICENSE.txt
+- Manifest.txt
+- README.md
+files:
+- ".document"
+- ".rdoc_options"
+- ".simplecov"
+- ChangeLog
+- GettingStarted.md
+- History.md
+- LICENSE.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/fluent_fixtures.rb
+- lib/fluent_fixtures/collection.rb
+- lib/fluent_fixtures/dsl.rb
+- lib/fluent_fixtures/factory.rb
+- spec/fluent_fixtures/collection_spec.rb
+- spec/fluent_fixtures/dsl_spec.rb
+- spec/fluent_fixtures/factory_spec.rb
+- spec/fluent_fixtures_spec.rb
+- spec/spec_helper.rb
+homepage: http://deveiate.org/projects/fluent_fixtures
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: A toolkit for building a collection of composable testing fixtures with a
+  fluent interface
+test_files: []