fluent_fixtures 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d33bbaa00f8e53051894c6cdfa9696965a1fb73
+  data.tar.gz: 1cf3f1e78b8ae7532782df1b657ae5b0ef365d88
+SHA512:
+  metadata.gz: da3d7e7e75da53dccd23a834f6eeeec0a531203b51c5385b4dda469eb4a39eb60040df7d0244465a3e24d7f455a53c4c3b76f7288686e035edf38141f40bb9ac
+  data.tar.gz: 4def254094af54a2f4f4c72f1425a7d124717d552e588226c5c6f8ba48e40e4634dc3067287ae2f7b0216a96a3f7a40e45b835f0378f6aa52956a3c65b0575f1

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+�)�i	?
+nݣ�N��E�D����Ce�hԱc��}g"ܰ�٩g�H�ޕ�h�eFb�so�	�s�er5�(N��=}�N鹜@��	83�Q#�ȑ}l�?yDT���&�,��Wwf�wx4�$��X��O�y|��.@7D'�Y�sW��(�

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+ChangeLog.md
+
+LICENSE.txt

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: fluent_fixtures Documentation
+visibility: :protected
+webcvs:

data/.simplecov

@@ -0,0 +1,9 @@
+# Simplecov config
+
+SimpleCov.start do
+	add_filter 'spec'
+	add_filter 'integration'
+	add_group "Needing tests" do |file|
+		file.covered_percent < 90
+	end
+end

data/ChangeLog

@@ -0,0 +1,48 @@
+2016-06-01  Michael Granger  <ged@FaerieMUD.org>
+
+	* History.md, lib/fluent_fixtures.rb:
+	Bump the patch version, update history.
+	[e500071dd9c0] [tip]
+
+	* Rakefile, fluent_fixtures.gemspec:
+	Remove the release failsafe from the Rakefile
+	[61698db3838e]
+
+	* .hgtags:
+	Added tag v0.0.1 for changeset cd547b1e30a8
+	[e26dbd686588]
+
+	* .hgsigs:
+	Added signature for changeset 588b8ccc042c
+	[cd547b1e30a8] [v0.0.1]
+
+	* History.md:
+	Update history
+	[588b8ccc042c]
+
+	* .hgignore, .hoerc, ChangeLog, Manifest.txt, fluent_fixtures.gemspec,
+	lib/fluent_fixtures/dsl.rb, lib/fluent_fixtures/factory.rb:
+	Clean up the manifest a bit.
+	[41b90ff8e6d0]
+
+	* .editorconfig, .hgignore, ChangeLog, GettingStarted.md, README.md,
+	Rakefile, examples/acme_fixtures.rb, examples/lib/acme.rb,
+	examples/lib/acme/base.rb, examples/lib/acme/fixtures.rb,
+	examples/lib/acme/fixtures/groups.rb,
+	examples/lib/acme/fixtures/users.rb, examples/lib/acme/group.rb,
+	examples/lib/acme/user.rb:
+	Add the start of examples and a "Getting Started" guide
+	[2230db2a4a5a] [github/master]
+
+	* .document, .editorconfig, .gems, .gitignore, .hgignore, .pryrc,
+	.rdoc_options, .ruby-gemset, .ruby-version, .simplecov, Gemfile,
+	History.md, LICENSE.txt, Manifest.txt, README.md, Rakefile,
+	certs/ged.pem, fluent_fixtures.gemspec, 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:
+	Initial import
+	[76c036a3676b]

data/GettingStarted.md

@@ -0,0 +1,26 @@
+# Getting Started With Fluent Fixtures
+
+Declare a module that will act as a collection of fixtures:
+
+    # lib/acme/fixtures.rb
+    require 'fluent_fixtures'
+    module Acme::Fixtures
+        extend FluentFixtures::Collection
+        fixture_path_prefix 'acme/fixtures'
+    end
+
+This module will act as the main interface to all of ACME's fixtures.
+
+First, we'll add a bare-bones `user` fixture for creating instances of a hypothetical `Acme::User` class:
+
+    # lib/acme/fixtures/users.rb
+    require 'acme/fixtures'
+    require 'acme/user
+    module Acme::Fixtures::Users
+        extend Acme::Fixtures
+        fixtured_class Acme::User 
+    end
+
+[...more soon]
+
+

data/History.md

@@ -0,0 +1,9 @@
+## v0.0.2 [2016-06-01] Michael Granger <ged@FaerieMUD.org>
+
+Remove the release failsafe from the Rakefile
+
+
+## v0.0.1 [2016-06-01] Michael Granger <ged@FaerieMUD.org>
+
+Initial release.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Michael Granger
+
+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/Manifest.txt

@@ -0,0 +1,19 @@
+.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

data/README.md

@@ -0,0 +1,77 @@
+# fluent_fixtures
+
+home
+: http://deveiate.org/projects/FluentFixtures
+
+code
+: http://bitbucket.org/ged/fluent_fixtures
+
+github
+: https://github.com/ged/fluent_fixtures
+
+docs
+: http://deveiate.org/code/fluent_fixtures
+
+
+## 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.
+
+
+## Prerequisites
+
+* Ruby
+
+
+## Installation
+
+    $ gem install fluent_fixtures
+
+
+## Contributing
+
+You can check out the current development source with Mercurial via its
+{project page}[http://bitbucket.org/ged/fluent_fixtures]. Or if you prefer Git, via 
+{its Github mirror}[https://github.com/ged/fluent_fixtures].
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
+
+
+## License
+
+Copyright (c) 2016, Michael Granger
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

data/Rakefile

@@ -0,0 +1,97 @@
+#!/usr/bin/env rake
+
+begin
+	require 'hoe'
+rescue LoadError
+	abort "This Rakefile requires hoe (gem install hoe)"
+end
+
+GEMSPEC = 'fluent_fixtures.gemspec'
+
+
+Hoe.plugin :mercurial
+Hoe.plugin :signing
+Hoe.plugin :deveiate
+
+Hoe.plugins.delete :rubyforge
+
+hoespec = Hoe.spec 'fluent_fixtures' do |spec|
+	spec.readme_file = 'README.md'
+	spec.history_file = 'History.md'
+	spec.extra_rdoc_files = FileList[ '*.rdoc', '*.md' ]
+	spec.license 'BSD-3-Clause'
+	spec.urls = {
+		home:   'http://deveiate.org/projects/fluent_fixtures',
+		code:   'http://bitbucket.org/ged/fluent_fixtures',
+		docs:   'http://deveiate.org/code/fluent_fixtures',
+		github: 'http://github.com/ged/fluent_fixtures',
+	}
+
+	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
+
+	spec.dependency 'loggability', '~> 0.11'
+	spec.dependency 'inflecto', '~> 0.0'
+
+	spec.dependency 'faker',                   '~> 1.6', :developer
+	spec.dependency 'hoe-deveiate',            '~> 0.3', :developer
+	spec.dependency 'simplecov',               '~> 0.7', :developer
+	spec.dependency 'rdoc-generator-fivefish', '~> 0.1', :developer
+
+	spec.require_ruby_version( '>=2.2.0' )
+	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
+	spec.check_history_on_release = true if spec.respond_to?( :check_history_on_release= )
+
+	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+end
+
+
+ENV['VERSION'] ||= hoespec.spec.version.to_s
+
+# Run the tests before checking in
+task 'hg:precheckin' => [ :check_history, :check_manifest, :gemspec, :spec ]
+
+task :test => :spec
+
+# Rebuild the ChangeLog immediately before release
+task :prerelease => 'ChangeLog'
+CLOBBER.include( 'ChangeLog' )
+
+desc "Build a coverage report"
+task :coverage do
+	ENV["COVERAGE"] = 'yes'
+	Rake::Task[:spec].invoke
+end
+CLOBBER.include( 'coverage' )
+
+
+# Use the fivefish formatter for docs generated from development checkout
+if File.directory?( '.hg' )
+	require 'rdoc/task'
+
+	Rake::Task[ 'docs' ].clear
+	RDoc::Task.new( 'docs' ) do |rdoc|
+	    rdoc.main = "README.md"
+		rdoc.markup = 'markdown'
+	    rdoc.rdoc_files.include( "*.md", "ChangeLog", "lib/**/*.rb" )
+	    rdoc.generator = :fivefish
+		rdoc.title = 'fluent_fixtures'
+	    rdoc.rdoc_dir = 'doc'
+	end
+end
+
+task :gemspec => GEMSPEC
+file GEMSPEC => __FILE__
+task GEMSPEC do |task|
+	spec = $hoespec.spec
+	spec.files.delete( '.gemtest' )
+	spec.signing_key = nil
+	spec.cert_chain = ['certs/ged.pem']
+	spec.version = "#{spec.version}.pre.#{Time.now.strftime("%Y%m%d%H%M%S")}"
+	puts "Spec version is set to: %s" % [ spec.version ]
+	File.open( task.name, 'w' ) do |fh|
+		fh.write( spec.to_ruby )
+	end
+end
+
+CLOBBER.include( GEMSPEC.to_s )
+

data/lib/fluent_fixtures/collection.rb

@@ -0,0 +1,137 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'inflecto'
+require 'loggability'
+
+require 'fluent_fixtures' unless defined?( FluentFixtures )
+
+
+# Extension module for fixture collection modules
+module FluentFixtures::Collection
+	extend Loggability
+
+
+	# The glob pattern to use when matching files in the search_path.
+	FIXTURE_FILE_PATTERN = '*.rb'
+
+
+	# Loggability API -- log to the FluentFixtures logger
+	log_to :fluent_fixtures
+
+
+	### Extension callback for the +collection_mod+. Sets up data structures for new
+	### +collection_mod+s.
+	def self::extended( collection_mod )
+		super
+
+		prefix = collection_mod.name || nil
+		prefix &&= prefix.sub( /::.*\z/, '' ).downcase
+		default_fixture_path_prefix = File.join( *[prefix, 'fixtures'].compact )
+
+		collection_mod.extend( Loggability )
+		collection_mod.log_to( :fluent_fixtures )
+
+		collection_mod.instance_variable_set( :@modules, {} )
+		collection_mod.instance_variable_set( :@fixture_path_prefix, default_fixture_path_prefix )
+	end
+
+
+	##
+	# The Hash of fixture modules declared within this Collection
+	attr_reader :modules
+
+
+	### Declare one or more +prefixes+ to use when searching for fixtures to load
+	### for the Collection.
+	def fixture_path_prefix( new_prefix=nil )
+		@fixture_path_prefix = new_prefix if new_prefix
+		return @fixture_path_prefix
+	end
+
+
+	### Load fixtures of the specified +types+.
+	def load( *types )
+		types.each do |type|
+			requirename = File.join( self.fixture_path_prefix, type.to_s )
+			require( requirename )
+		end
+	end
+
+
+	### Load all available fixture modules from loaded gems.
+	def load_all
+		pattern = File.join( self.fixture_path_prefix, FIXTURE_FILE_PATTERN )
+		Gem.find_files( pattern ).each do |fixture_path|
+			fixture_name = File.basename( fixture_path, '.rb' )
+			self.load( fixture_name )
+		end
+	end
+
+
+	### Extension callback -- add some stuff to every fixture module. Note that this is called
+	### by fixtures which extend a collection module, not by the collection itself.
+	def extended( fixture_mod )
+		super
+
+		fixture_mod.extend( Loggability )
+		fixture_mod.log_to( :fluent_fixtures )
+
+		fixture_mod.extend( FluentFixtures::DSL )
+		fixture_mod.instance_variable_set( :@decorators, {} )
+		fixture_mod.instance_variable_set( :@fixtured_class, nil )
+		fixture_mod.instance_variable_set( :@base_fixture, nil )
+
+		fixture_mod.collection = self
+
+		if default_name = self.default_base_fixture_name( fixture_mod )
+			self.add_base_fixture( default_name, fixture_mod )
+		end
+	end
+
+
+	### Add a global fixture method with the specified +name+ to the top-level
+	### Fixtures module.
+	def add_base_fixture( name, fixture_mod )
+		self.log.debug "Adding a base fixture to %p: %p as %p" % [ self, fixture_mod, name ]
+
+		if previous_name = self.modules.key( fixture_mod )
+			self.modules.delete( previous_name )
+			# ugh, no remove_singleton_method
+			self.singleton_class.instance_exec( previous_name ) do |methodname|
+				remove_method( methodname )
+			end
+		end
+
+		if self.modules.key?( name )
+			raise ScriptError,
+				"Already have a base fixture called %s: %p" % [ name, self.modules[name] ]
+		end
+
+		self.modules[ name ] = fixture_mod
+		define_singleton_method( name, &fixture_mod.method(:factory) )
+	end
+
+
+	### Return the default base fixture name based on the name of the given +mod+ (a Module).
+	def default_base_fixture_name( mod )
+		modname = mod.name or return nil
+		name = Inflecto.singularize( Inflecto.demodulize(modname).downcase )
+		return name.to_sym
+	end
+
+
+	### Clear all declared fixtures from the Cozy::FluentFixtures namespace. Mostly used for
+	### testing the fixtures system itself.
+	def reset!
+		self.modules.each do |name, mod|
+			self.log.warn "Removing base fixture method for %p: %p" % [ mod, name ]
+			self.singleton_class.instance_exec( name ) do |methodname|
+				remove_method( methodname ) if method_defined?( methodname )
+			end
+		end
+		self.modules.clear
+	end
+
+
+end # module FluentFixtures::Collection