sequel-inline_schema 0.0.1

data/spec/sequel/plugins/inline_schema_spec.rb

@@ -0,0 +1,401 @@
+#!/usr/bin/env rspec -cfd
+#encoding: utf-8
+
+require_relative '../../spec_helper'
+
+require 'securerandom'
+
+require 'loggability'
+require 'pg'
+require 'rspec'
+require 'sequel/plugins/inline_schema'
+
+
+describe Sequel::Plugins::InlineSchema do
+
+	let( :db ) do
+		Sequel.mock( host: 'postgres', columns: nil, logger: Loggability.logger )
+	end
+
+	let( :table ) do
+		name = "test_table_%s" % [ SecureRandom.hex(8) ]
+		name.to_sym
+	end
+
+	let( :model_class ) do
+		mclass = Class.new( Sequel::Model )
+		mclass.set_dataset( db[table] )
+		mclass.plugin( :inline_schema )
+		mclass
+	end
+
+	let( :valid_pg_attributes ) do
+		[
+			{
+				name: "id",
+				oid: 23,
+				base_oid: nil,
+				db_base_type: nil,
+				db_type: "integer",
+				default: "nextval('people_id_seq'::regclass)",
+				allow_null: false,
+				primary_key: true,
+			},
+			{
+				name: "name",
+				oid: 25,
+				base_oid: nil,
+				db_base_type: nil,
+				db_type: "text",
+				default: nil,
+				allow_null: false,
+				primary_key: false,
+			},
+			{
+				name: "age",
+				oid: 23,
+				base_oid: nil,
+				db_base_type: nil,
+				db_type: "integer",
+				default: nil,
+				allow_null: false,
+				primary_key: false,
+			}
+		]
+	end
+
+	let( :fake_db_fetcher ) do
+		created = false
+		Proc.new do |query|
+			case query
+			when /pg_attribute/
+				created ? [] : valid_pg_attributes
+			when /SELECT \* FROM "test_table/
+				if created
+					[{ id: 1, name: 'name', age: 20}]
+				else
+					raise PG::UndefinedTable.new( "No such table." )
+				end
+			when /SELECT NULL/
+				if created
+					{nil: nil}
+				else
+					raise PG::UndefinedTable.new("No such table.")
+				end
+			when /CREATE TABLE/
+				created = true
+			else
+				fail "Unhandled query"
+			end
+		end
+	end
+
+
+	it "sets require_valid_table to false when it declares a schema" do
+		model_class.set_schema { primary_key :id }
+		expect( model_class.require_valid_table ).to be_falsey
+	end
+
+
+	it "doesn't set require_valid_table if require_table is true" do
+		model_class.set_schema( require_table: true ) { primary_key :id }
+		expect( model_class.require_valid_table ).to be_truthy
+	end
+
+
+	it "allows a model to create its table" do
+		model_class.set_schema do
+			primary_key :id
+			String :name
+			Integer :age
+		end
+		db.fetch = fake_db_fetcher
+
+		model_class.create_table
+
+		expect( db.sqls ).to include(
+			%{CREATE TABLE "#{table}" ("id" serial PRIMARY KEY, "name" text, "age" integer)}
+		)
+	end
+
+
+	it "allows a model to re-create its table" do
+		model_class.set_schema do
+			primary_key :id
+			String :name
+			Integer :age
+		end
+		db.fetch = fake_db_fetcher
+
+		model_class.create_table!
+
+		expect( db.sqls ).to include(
+			%{DROP TABLE IF EXISTS "#{table}"},
+			%{CREATE TABLE "#{table}" ("id" serial PRIMARY KEY, "name" text, "age" integer)}
+		)
+	end
+
+
+	it "allows a model to create its table if it doesn't yet exist" do
+		model_class.set_schema do
+			primary_key :id
+			String :name
+			Integer :age
+		end
+		db.fetch = fake_db_fetcher
+
+		model_class.create_table?
+
+		expect( db.sqls ).to include(
+			%{CREATE TABLE "#{table}" ("id" serial PRIMARY KEY, "name" text, "age" integer)}
+		)
+	end
+
+
+	it "allows a model to declare its schema when it creates its table" do
+		model_class.create_table do
+			primary_key :id
+			String :name
+			Integer :age
+		end
+
+		expect( db.sqls ).to include(
+			%{CREATE TABLE "#{table}" ("id" serial PRIMARY KEY, "name" text, "age" integer)}
+		)
+	end
+
+
+	it "allows a model to determine whether its table exists or not" do
+		model_class.table_exists?
+		expect( db.sqls ).to include(
+			%{SELECT NULL AS "nil" FROM "#{table}" LIMIT 1}
+		)
+	end
+
+
+	it "allows a model to drop its table" do
+		model_class.drop_table
+		expect( db.sqls ).to include( %{DROP TABLE "#{table}"} )
+	end
+
+
+	describe "table-creation ordering" do
+
+		let( :fake_db_fetcher ) do
+			created = false
+			Proc.new do |query|
+				case query
+				when /pg_attribute/
+					created ? [] : valid_pg_attributes
+				when /SELECT \* FROM "test_table/
+					if created
+						[{ id: 1, name: 'name'}]
+					else
+						raise PG::UndefinedTable.new( "No such table." )
+					end
+				when /SELECT NULL/
+					if created
+						{nil: nil}
+					else
+						raise PG::UndefinedTable.new("No such table.")
+					end
+				when /CREATE TABLE/
+					created = true
+				else
+					fail "Unhandled query"
+				end
+			end
+		end
+
+		let( :base_class ) do
+			mclass = Class.new( Sequel::Model )
+			mclass.plugin( :inline_schema )
+			mclass
+		end
+
+		let!( :artist_class ) do
+			mclass = Class.new( base_class ) do
+				def self::name; "Artist"; end
+			end
+			mclass.set_dataset( db[:artists] )
+			mclass.set_schema do
+				primary_key :id
+				String :name
+			end
+			mclass
+		end
+
+		let!( :song_class ) do
+			mclass = Class.new( base_class ) do
+				def self::name; "Song"; end
+			end
+			mclass.set_dataset( db[:songs] )
+			mclass.set_schema do
+				primary_key :id
+				String :name
+				foreign_key :album_id, :albums
+			end
+			mclass.many_to_one :album, class: album_class
+			mclass
+		end
+
+		let!( :album_class ) do
+			mclass = Class.new( base_class ) do
+				def self::name; "Album"; end
+			end
+			mclass.set_dataset( db[:albums] )
+			mclass.set_schema do
+				primary_key :id
+				String :name
+				foreign_key :artist_id, :artists
+			end
+			mclass.many_to_one :artist, class: artist_class
+			mclass
+		end
+
+
+
+		it "returns model classes whose tables need to be created in dependency order" do
+			db.fetch = fake_db_fetcher
+			expect( base_class.uninstalled_tables ).to eq([
+				artist_class, album_class, song_class
+			])
+		end
+
+
+	end
+
+
+	describe "hooks" do
+
+		let( :model_class ) do
+			class_obj = super()
+			class_obj.singleton_class.send( :attr_accessor, :called )
+			class_obj.called = {}
+			class_obj
+		end
+
+
+		it "calls a hook before creating the model's table" do
+			def model_class.before_create_table
+				self.called[ :before_create_table ] = true
+				super
+			end
+
+			model_class.create_table
+
+			expect( model_class.called ).to include( :before_create_table )
+		end
+
+
+		it "allows cancellation of create_table from the before_create_table hook" do
+			def model_class.before_create_table
+				self.called[ :before_create_table ] = true
+				cancel_action
+			end
+
+			expect {
+				model_class.create_table
+			}.to raise_error( Sequel::HookFailed, /hook failed/i )
+		end
+
+
+		it "allows cancellation of create_table with a message from the before_create_table hook" do
+			def model_class.before_create_table
+				self.called[ :before_create_table ] = true
+				cancel_action( "Wait, don't create yet!" )
+			end
+
+			expect {
+				model_class.create_table
+			}.to raise_error( Sequel::HookFailed, "Wait, don't create yet!" )
+		end
+
+
+		it "allows cancellation of create_table with a Symbol from the before_create_table hook" do
+			def model_class.before_create_table
+				self.called[ :before_create_table ] = true
+				cancel_action( :before_create_table )
+			end
+
+			expect {
+				model_class.create_table
+			}.to raise_error( Sequel::HookFailed, /before_create_table/ )
+		end
+
+
+		it "calls a hook after table creation" do
+			def model_class.after_create_table
+				super
+				self.called[ :after_create_table ] = true
+			end
+
+			model_class.create_table
+
+			expect( model_class.called ).to include( :after_create_table )
+		end
+
+
+		it "calls a hook before dropping the model's table" do
+			def model_class.before_drop_table
+				self.called[ :before_drop_table ] = true
+				super
+			end
+
+			model_class.drop_table
+
+			expect( model_class.called ).to include( :before_drop_table )
+		end
+
+
+		it "allows cancellation of drop_table from the before_drop_table hook" do
+			def model_class.before_drop_table
+				self.called[ :before_drop_table ] = true
+				cancel_action
+			end
+
+			expect {
+				model_class.drop_table
+			}.to raise_error( Sequel::HookFailed, /hook failed/i )
+		end
+
+
+		it "allows cancellation of drop_table with a message from the before_drop_table hook" do
+			def model_class.before_drop_table
+				self.called[ :before_drop_table ] = true
+				cancel_action( "Wait, don't drop yet!" )
+			end
+
+			expect {
+				model_class.drop_table
+			}.to raise_error( Sequel::HookFailed, "Wait, don't drop yet!" )
+		end
+
+
+		it "allows cancellation of drop_table with a Symbol from the before_drop_table hook" do
+			def model_class.before_drop_table
+				self.called[ :before_drop_table ] = true
+				cancel_action( :before_drop_table )
+			end
+
+			expect {
+				model_class.drop_table
+			}.to raise_error( Sequel::HookFailed, /before_drop_table/ )
+		end
+
+
+		it "calls a hook after a class's table is dropped" do
+			def model_class.after_drop_table
+				super
+				self.called[ :after_drop_table ] = true
+			end
+
+			model_class.drop_table
+
+			expect( model_class.called ).to include( :after_drop_table )
+		end
+
+	end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'simplecov' if ENV['COVERAGE']
+
+require 'pg'
+require 'rspec'
+require 'sequel'
+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,217 @@
+--- !ruby/object:Gem::Specification
+name: sequel-inline_schema
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMTcwOTI3MDAzMDQ0WhcNMTgwOTI3MDAzMDQ0WjA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC/JWGRHO+USzR97vXjkFgt
+  83qeNf2KHkcvrRTSnR64i6um/ziin0I0oX23H7VYrDJC9A/uoUa5nGRJS5Zw/+wW
+  ENcvWVZS4iUzi4dsYJGY6yEOsXh2CcF46+QevV8iE+UmbkU75V7Dy1JCaUOyizEt
+  TH5UHsOtUU7k9TYARt/TgYZKuaoAMZZd5qyVqhF1vV+7/Qzmp89NGflXf2xYP26a
+  4MAX2qqKX/FKXqmFO+AGsbwYTEds1mksBF3fGsFgsQWxftG8GfZQ9+Cyu2+l1eOw
+  cZ+lPcg834G9DrqW2zhqUoLr1MTly4pqxYGb7XoDhoR7dd1kFE2a067+DzWC/ADt
+  +QkcqWUm5oh1fN0eqr7NsZlVJDulFgdiiYPQiIN7UNsii4Wc9aZqBoGcYfBeQNPZ
+  soo/6za/bWajOKUmDhpqvaiRv9EDpVLzuj53uDoukMMwxCMfgb04+ckQ0t2G7wqc
+  /D+K9JW9DDs3Yjgv9k4h7YMhW5gftosd+NkNC/+Y2CkCAwEAAaN1MHMwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFHKN/nkRusdqCJEuq3lgB3fJvyTg
+  MBwGA1UdEQQVMBOBEWdlZEBGYWVyaWVNVUQub3JnMBwGA1UdEgQVMBOBEWdlZEBG
+  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBBQUAA4IBgQB/qyi5pCjK8ceoKalfVAjS
+  vG64FEnLnD1bm39T5UaFIRmo+abZtfpg2QhwKvPbPjOicau2+m+MDQ2Cc3tgyaC3
+  dZxcP6w8APFg4AId09uWAZKf0xajvBMS2aOz8Bbmag6fwqRRkTMqsNYnmqcF7aRT
+  DuEzbEMfaOUYjU9RuB48vr4q8yRft0ww+3jq5iwNkrX1buL2pwBbyvgms6D/BV41
+  MaTVMjsHqJUwU2xVfhGtxGAWAer5S1HGYHkbio6mGVtiie0uWjmnzi7ppIlMr48a
+  7BNTsoZ+/JRk3iQWmmNsyFT7xfqBKye7cH11BX8V8P4MeGB5YWlMI+Myj5DZY3fQ
+  st2AGD4rb1l0ia7PfubcBThSIdz61eCb8gRi/RiZZwb3/7+eyEncLJzt2Ob9fGSF
+  X0qdrKi+2aZZ0NGuFj9AItBsVmAvkBGIpX4TEKQp5haEbPpmaqO5nIIhV26PXmyT
+  OMKv6pWsoS81vw5KAGBmfX8nht/Py90DQrbRvakATGI=
+  -----END CERTIFICATE-----
+date: 2018-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-fivefish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !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: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: |-
+  This is a set of plugins for Sequel for declaring a model's table schema and
+  any migrations in the class itself (similar to the legacy `schema` plugin).
+
+  It has only really been tested with PostgreSQL, but patches that make it more generic are welcomed.
+
+  The two plugins are:
+
+  * Sequel::Plugins::InlineSchema
+  * Sequel::Plugins::InlineMigrations
+
+  Examples and usage documentation are included there.
+email:
+- ged@FaerieMUD.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.md
+- LICENSE.txt
+- Manifest.txt
+- README.md
+files:
+- ".document"
+- ".editorconfig"
+- ".rdoc_options"
+- ".simplecov"
+- ChangeLog
+- History.md
+- LICENSE.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/sequel/inline_schema.rb
+- lib/sequel/plugins/inline_migrations.rb
+- lib/sequel/plugins/inline_schema.rb
+- spec/sequel/plugins/inline_migrations_spec.rb
+- spec/sequel/plugins/inline_schema_spec.rb
+- spec/spec_helper.rb
+homepage: http://bitbucket.org/ged/sequel-inline_schema
+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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: This is a set of plugins for Sequel for declaring a model's table schema
+  and any migrations in the class itself (similar to the legacy `schema` plugin)
+test_files: []