squixtures 0.0.2

data/lib/squixtures/fixtures.rb

@@ -0,0 +1,17 @@
+#! /usr/bin/env ruby
+# Copyright (c), 2012 Peter Wood
+
+module Squixtures
+	# This module is intended for inclusion into other classes to enable them
+	# with fixture functionality.
+	module Fixtures
+		# This method is really just a wrapper around the Suxtures::fixtures
+		# method.
+		#
+		# === Parameters
+		# names::  The name of the fixtures to be loaded.
+		def fixtures(*names)
+			Squixtures.fixtures(*names)
+		end
+	end
+end

data/lib/squixtures/helper_factory.rb

@@ -0,0 +1,29 @@
+#! /usr/bin/env ruby
+# Copyright (c), 2012 Peter Wood
+
+module Squixtures
+   module HelperFactory
+      # This method fetches an appropriate database helper instance based on the
+      # database connection details provided. The method will raise an exception
+      # if an unrecognised database type is encountered.
+      #
+      # ==== Parameters
+      # settings::  A Hash of the database connection settings.
+      def self.create_helper(settings)
+         adapter = settings['adapter']
+         helper  = nil
+         case adapter
+            when 'postgresql'
+               helper = PostgresHelper.new
+
+            when 'sqlite3'
+               helper = SQLite3Helper.new
+         end
+
+         if helper.nil?
+            raise SquixturesError.new("Unrecognised database adapter '#{adapter}' encountered.")
+         end
+         helper
+      end
+   end
+end

data/lib/squixtures/loader.rb

@@ -0,0 +1,74 @@
+#! /usr/bin/env ruby
+# Copyright (c), 2012 Peter Wood
+
+require 'stringio'
+
+module Squixtures
+   # This class encapsulates the functionality to load multiple fixtures.
+   class Loader
+      # Add logging to the class.
+      LogJam.apply(self, "squixtures")
+
+      # Constructor the Loader class.
+      #
+      # ==== Parameters
+      # configuration::  The configuration to be used by the loader to load
+      #                  fixtures.
+      def initialize(configuration)
+         @configuration = configuration
+      end
+
+      # This method performs the actual work of loading the fixture data
+      # specified.
+      #
+      # ==== Parameters
+      # *names::  A collection of the fixture names to be loaded.
+      def load(*names)
+         # Generate the list of fixtures to be loaded.
+         fixtures = []
+
+         # Expand :all to a list of fixture names.
+         if names.size == 1 && names[0] == :all
+            names         = []
+            fixtures_path = Squixtures.find_fixtures_dir
+            if !fixtures_path.nil?
+               Dir.glob("#{fixtures_path}/*.yml").each do |file_path|
+                  file_name = File.basename(file_path)
+                  extension = File.extname(file_name)
+                  names << file_name[0, file_name.length - extension.length].intern
+               end
+            end
+         end
+
+         names.each do |name|
+            fixtures << Fixture.new(name, @configuration)
+         end
+
+         # Connect to the database.
+         url        = Squixtures.get_connection_url(@configuration[:database])
+         Loader.log.debug "Database Connection URL: #{url}"
+         connection = Sequel.connect(url)
+
+         # Create the database helper class.
+         helper = HelperFactory.create_helper(@configuration[:database])
+
+         # Perform the actual load.
+         begin
+            Loader.log.debug "Calling before_load as precursor to fixture load."
+            helper.before_load(fixtures, connection)
+
+            Loader.log.debug "Starting fixtures load."
+            fixtures.each do |fixture|
+               if @configuration[:transactional]
+                  connection.transaction {fixture.load(connection)}
+               else
+                  fixture.load(connection)
+               end                  
+            end
+
+            Loader.log.debug "Calling after_load after fixtures have been loaded."
+            helper.after_load(fixtures, connection)
+         end
+      end
+   end
+end

data/lib/squixtures/postgres_helper.rb

@@ -0,0 +1,77 @@
+#! /usr/bin/env ruby
+# Copyright (c), 2012 Peter Wood
+
+require 'stringio'
+
+module Squixtures
+   # A class to contain elements specific to the Postgres system.
+   class PostgresHelper
+      # Add logging to the class.
+      LogJam.apply(self, "squixtures")
+
+      # This method is invoked immediately before a fixture load starts and
+      # performs all work necessary to facilitate the load.
+      #
+      # ==== Parameters
+      # fixtures::    A collection of the fixture objects to be loaded.
+      # connection::  The database connection that the load will be performed
+      #               through.
+      def before_load(fixtures, connection)
+         PostgresHelper.log.debug "PostgresHelper.before_load called."
+         fixtures.each do |fixture|
+           begin
+             connection.run("alter table #{fixture.table_name} disable trigger all")
+           rescue
+             connection.run("alter table #{fixture.table_name} disable trigger user")
+           end
+         end
+      end
+
+      # This method is invoked immediately after a fixture load completes and
+      # performs all clean up necessary.
+      #
+      # ==== Parameters
+      # fixtures::    A collection of the fixture objects to be loaded.
+      # connection::  The database connection that the load will be performed
+      #               through.
+      def after_load(fixtures, connection)
+         PostgresHelper.log.debug "PostgresHelper.after_load called."
+         fixtures.each do |fixture|
+           begin
+             connection.run("alter table #{fixture.table_name} enable trigger all")
+           rescue
+             connection.run("alter table #{fixture.table_name} enable trigger user")
+           end
+         end
+      end
+
+      # This method is an instance level version of the get_connection_url
+      # method declared at the class level.
+      def get_connection_url(settings)
+         PostgresHelper.get_connection_url(settings)
+      end
+
+      # This method converts a typical set of database connection settings, such
+      # as those in a Rails database.yml file, into the URL to be used to connect
+      # to a Postgres database using the Sequel library.
+      #
+      # ==== Parameters
+      # settings::  A Hash of the settings that will be used to generate the
+      #             connection URL.
+      def self.get_connection_url(settings)
+         url = StringIO.new
+         url << "postgres://"
+         if settings.include?("username")
+            url << settings["username"]
+            url << ":#{settings['password']}" if settings.include?("password")
+         end
+         url << "@"
+         if settings.include?("host")
+            url << "#{settings['host']}"
+            url << ":#{settings['port']}" if settings.include?("port")
+         end
+         url << "/#{settings['database']}" if settings.include?("database")
+         url.string
+      end
+   end
+end

data/lib/squixtures/sqlite3_helper.rb

@@ -0,0 +1,51 @@
+#! /usr/bin/env ruby
+# Copyright (c), 2012 Peter Wood
+
+module Squixtures
+   # A class to contain elements specific to the SQLite3 system.
+   class SQLite3Helper
+      # Add logging to the class.
+      LogJam.apply(self, "squixtures")
+
+      # This method is invoked immediately before a fixture load starts and
+      # performs all work necessary to facilitate the load.
+      #
+      # ==== Parameters
+      # fixtures::    A collection of the fixture objects to be loaded.
+      # connection::  The database connection that the load will be performed
+      #               through.
+      def before_load(fixtures, connection)
+         SQLite3Helper.log.debug "SQLite3Helper.before_load called."
+         connection.run("PRAGMA foreign_keys = OFF")
+      end
+
+      # This method is invoked immediately after a fixture load completes and
+      # performs all clean up necessary.
+      #
+      # ==== Parameters
+      # fixtures::    A collection of the fixture objects to be loaded.
+      # connection::  The database connection that the load will be performed
+      #               through.
+      def after_load(fixtures, connection)
+         SQLite3Helper.log.debug "SQLite3Helper.after_load called."
+         connection.run("PRAGMA foreign_keys = ON")
+      end
+
+      # This method is an instance level version of the get_connection_url
+      # method declared at the class level.
+      def get_connection_url(settings)
+         SQLite3Helper.get_connection_url(settings)
+      end
+
+      # This method converts a typical set of database connection settings, such
+      # as those in a Rails database.yml file, into the URL to be used to connect
+      # to a Postgres database using the Sequel library.
+      #
+      # ==== Parameters
+      # settings::  A Hash of the settings that will be used to generate the
+      #             connection URL.
+      def self.get_connection_url(settings)
+         "sqlite://#{settings['database']}"
+      end
+   end
+end

data/lib/squixtures/version.rb

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+# Copyright (c), 2012 Peter Wood
+
+module Squixtures
+   VERSION = "0.0.2"
+end

data/squixtures.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/squixtures/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Wood"]
+  gem.email         = ["ruby@blacknorth.com"]
+  gem.description   = %q{Squixtures is a library that provides a data fixtures facility ala the fixtures typically used in unit tests. The library makes use of the Sequel library to provide a degree of database independence (needs more work) and use the LogJam library to unify logging output.}
+  gem.summary       = %q{Simple fixtures functionality.}
+  gem.homepage      = ""
+
+  gem.add_dependency('sequel', '>= 3.36.1')
+  gem.add_dependency('logjam', '>= 0.0.3')
+
+  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.name          = "squixtures"
+  gem.require_paths = ["lib"]
+  gem.version       = Squixtures::VERSION
+end

data/test/README.md

@@ -0,0 +1,41 @@
+# Squixtures Test
+This directory contains files used in testing the Squixtures library. The
+process of preparing for and running these tests is outlined below.
+
+## Preparing The Test Database
+The test files expect that a test database will have been created before they
+are run. To assist in this process the details needed to create the test
+database have been encapsulated into a set of Sequel migrations that are stored
+in the db/migrations sudirectory of the test folder. To create the database for
+testing the library with SQLite3 you would use a command such as the following
+to create the test database...
+
+    $> sequel -m db/migrations sqlite://db/squixtures.db
+
+The command given above assumes that it is being executed from the test folder
+with the main project folder. This will create a new database file in a file
+called squixtures.db in the db subdirectory. To create the test database for
+Postgres is a little more convoluted but would following a series of commands
+such as the following...
+
+    $> createdb -E UTF-8 -U postgres squixtures
+    $> sequel -m db/migrations postgres://postgres:password@localhost:5432/squixtures
+
+The second command assumes that the password for the postgres user is password,
+alter this as necessary. To roll a migration back completely you can use a
+command such as...
+
+    $> sequel -m db/migrations postgres://postgres:password@localhost:5432/squixtures -M 0
+
+## Executing A Test
+All of the tests are stored as Ruby source files within the test subdirectory
+of the main project folder. To execute any of the tests you would use a command
+such as the following...
+
+    $> ruby -I../lib squixtures_include_tests.rb
+
+Again, it is assumed this command is executed from within the test folder. The
+command specifies an include path to the squixtures lib folder which allows for
+execution of the tests without the library actually being installed. If you have
+the library installed and simply want to execute the tests then drop the '-I'
+parameter from the command.

data/test/config/database.yml

@@ -0,0 +1,17 @@
+# SQLite3 configuration.
+# test:
+#    adapter: sqlite3
+#    database: db/squixtures.db
+#    pool: 5
+#    timeout: 5000
+
+# Postgres configuration.
+test:
+  adapter: postgresql
+  database: squixtures
+  username: postgres
+  password:
+  port: 5432  
+  host: localhost
+  pool: 5
+  timeout: 5000

data/test/db/migrations/0001_create_users.rb

@@ -0,0 +1,16 @@
+Sequel.migration do
+	up do
+		create_table(:users) do
+			primary_key :id
+			String :email, :null => false, :size => 255, :unique => true
+			String :passwd, :null => false, :size => 100
+			Integer :status, :null => false
+			Time :created, :null => false
+			Time :updated, :null => true
+		end
+	end
+
+	down do
+		drop_table(:users)
+	end
+end

data/test/db/migrations/0002_create_orders.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+	up do
+		create_table(:orders) do
+			primary_key :id
+			foreign_key :user_id, :users
+			Integer :status, :null => false
+			Time :created, :null => false
+			Time :updated, :null => true
+		end
+	end
+
+	down do
+		drop_table(:orders)
+	end
+end

data/test/db/migrations/0003_create_categories.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+	up do
+		create_table(:categories) do
+			primary_key :id
+			String :name, :limit => 100, :null => false
+			Time :created, :null => false
+			Time :updated, :null => true
+		end
+	end
+
+	down do
+		drop_table(:categories)
+	end
+end

data/test/db/migrations/0004_create_products.rb

@@ -0,0 +1,16 @@
+Sequel.migration do
+	up do
+		create_table(:products) do
+			primary_key :id
+			foreign_key :category_id, :categories
+			String :name, :size => 200
+			Float :cost, :null => false, :precision => 6, :scale => 2
+			Time :created, :null => false
+			Time :updated, :null => true
+		end
+	end
+
+	down do
+		drop_table(:products)
+	end
+end

data/test/db/migrations/0005_create_order_products.rb

@@ -0,0 +1,16 @@
+Sequel.migration do
+	up do
+		create_table(:order_products) do
+			primary_key :id
+			foreign_key :order_id, :orders
+			foreign_key :product_id, :products
+			Integer :quantity, :null => false
+			Time :created, :null => false
+			Time :updated, :null => true
+		end
+	end
+
+	down do
+		drop_table(:order_products)
+	end
+end

data/test/test/fixtures/alternative/categories.yml

@@ -0,0 +1,10 @@
+one:
+   id: 1
+   name: Jackets
+   created: <%= Time.now %>
+
+two:
+   id: 1
+   name: Footwear
+   created: <%= Time.now - 5400 %>
+   updated: <%= Time.now %>

data/test/test/fixtures/alternative/users.yml

@@ -0,0 +1,12 @@
+ten:
+   id: 10
+   email: a.dent@end-of-universe.com
+   passwd: password
+   status: 1
+   created: <%= Time.now %>
+eleven:
+   id: 11
+   email: f.prefect@end-of-universe.com
+   passwd: password
+   status: 1
+   created: <%= Time.now %>