sequel-inline_schema 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0586820d7a0cb25e530b431dee73a22dc205296a1cf15a945602f554ba9b3608'
-  data.tar.gz: 4646d1e2a538da9554864bb15db471b2eb9a2c6e920b8bdcbb462883d1724517
+  metadata.gz: ba38d991fa938c8b49fd8d6b395609ed80191ea733dcbfc91adc539b23a1ad2c
+  data.tar.gz: 58cac869e2b380e53b47e17ba0aa8f8bb47e5553cf5a9ac57b499bd962d76c4e
 SHA512:
-  metadata.gz: 06013b428fbd164f5717a815391d65723033648ef301621b7d551ebcfb8e18c6c0c64a31678a0e36885f89ee3d7e3f3e717fbeab9722f2537dbfb9e26d16c37d
-  data.tar.gz: 92cf82542922e762fc32971cce5b16cdeebc6922940a019bc4b2e80ac8e01ae40a6cea8d2863d3da2fbd71761ee9022b5587fa6b3ac471a62a57cddf3f31129e
+  metadata.gz: cc518f2f4548126ce2e79c7c5fa619b4d2be33e0db757b6cd90a05bb8b5804938819352225c0ce60b9871e1b526e0d90dff743ca3304215ce33f3eef98c9ae88
+  data.tar.gz: f67ec3eca4fb4e65f1e66b1494d61e0c5f3b636074b88becfb3f28a70e107f3be44b67b613a50dbf63def6778b70f0befd5eb39b043b96ddc34f760ca2d16c73

data/History.md

@@ -2,6 +2,13 @@
 
 ---
 
+## v0.3.0 [2020-02-10] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Add inline view declaration
+
+
 ## v0.2.0 [2020-01-18] Michael Granger <ged@faeriemud.org>
 
 Improvements:

data/Rakefile

@@ -4,6 +4,6 @@ require 'rake/deveiate'
 
 Rake::DevEiate.setup( 'sequel-inline_schema' ) do |project|
 	project.publish_to = 'deveiate:/usr/local/www/public/code'
-	project.required_ruby_version = '~> 2.4'
+	project.required_ruby_version = '~> 2.5'
 end
 

data/lib/sequel/inline_schema.rb

@@ -7,7 +7,7 @@ require 'sequel/plugins/inline_schema'
 module Sequel::InlineSchema
 
 	# Package version
-	VERSION = '0.2.0'
+	VERSION = '0.3.0'
 
 	# Version control revision
 	REVISION = %q$Revision$

data/lib/sequel/plugins/inline_migrations.rb

@@ -212,6 +212,7 @@ module Sequel::Plugins::InlineMigrations
 			end
 		end
 
+
 		### Create any new tables and run any pending migrations. If the optional +target+ is
 		### supplied, the migrations up to (and including) that one will be applied. If
 		### it has already been applied, any from the currently-applied one to it
@@ -220,6 +221,8 @@ module Sequel::Plugins::InlineMigrations
 			migrator = self.migrator( target )
 			classes_to_install = self.uninstalled_tables
 			self.db.log_info "Classes with tables that need to be installed: %p" % [ classes_to_install ]
+			views_to_install = self.uninstalled_views
+			self.db.log_info "Views to install: %p" % [ views_to_install.map(&:table_name) ]
 
 			self.db.transaction do
 				self.before_migration
@@ -229,6 +232,9 @@ module Sequel::Plugins::InlineMigrations
 				self.db.log_info "Running any pending migrations..."
 				migrator.run
 				self.after_migration
+
+				self.db.log_info "(Re)-creating any modeled views..."
+				views_to_install.each( &:create_view )
 			end
 		end
 
@@ -477,4 +483,5 @@ module Sequel::Plugins::InlineMigrations
 
 	end # class Migrator
 
+
 end # Sequel::Plugins::InlineMigrations

data/lib/sequel/plugins/inline_schema.rb

@@ -100,6 +100,55 @@ module Sequel::Plugins::InlineSchema
 	# Sequel plugin API -- add these methods to model classes which load the plugin.
 	module ClassMethods
 
+		### Extension callback -- add some class instance variables to keep track of
+		### schema info.
+		def self::extended( model_class )
+			super
+
+			model_class.require_valid_table = false
+
+			# The Sequel::Dataset used to create the model's view (if it's modelling a view
+			# instead of a table). Setting this causes the model's schema to be ignored when
+			# its table is created, creating a view by the same name instead.
+			model_class.singleton_class.attr_accessor( :view_dataset )
+
+			# The options used when creating the view for the model.
+			model_class.singleton_class.attr_accessor( :view_options )
+		end
+
+
+		### Returns the table schema created with set_schema.
+		def schema
+			if !@schema && @schema_block
+				self.set_dataset( self.db[@schema_name] ) if @schema_name
+				@schema = self.db.create_table_generator( &@schema_block )
+				self.set_primary_key( @schema.primary_key_name ) if @schema.primary_key_name
+			end
+			return @schema || ( superclass.schema unless superclass == Sequel::Model )
+		end
+
+
+		### Defines a table schema (see Schema::CreateTableGenerator for more information).
+		###
+		### This will also set the dataset if you provide a +name+, as well as setting
+		### the primary key if you define one in the passed block.
+		###
+		### Since this plugin allows you to declare the schema inline with the model
+		### class that acts as its interface, the table will not always exist when the
+		### class loads, so calling #set_schema will call require_valid_table to `false`
+		### for you. You can disable this by passing `require_table: true`.
+		def set_schema( name=nil, require_table: false, &block )
+			self.require_valid_table = require_table
+			@schema = nil
+			@schema_name = name
+			@schema_block = block
+		end
+
+
+		#
+		# Table utilities
+		#
+
 		### Creates table, using the column information from set_schema.
 		def create_table( *args, &block )
 			self.set_schema( *args, &block ) if block
@@ -125,18 +174,6 @@ module Sequel::Plugins::InlineSchema
 		end
 
 
-		### Called before the table is created.
-		def before_create_table
-			# No-op
-		end
-
-
-		### Called after the table is created.
-		def after_create_table
-			# No-op
-		end
-
-
 		### Drops table. If the table doesn't exist, this will probably raise an error.
 		def drop_table
 			self.before_drop_table
@@ -145,58 +182,96 @@ module Sequel::Plugins::InlineSchema
 		end
 
 
-		### Drops table if it already exists, do nothing if it doesn't exist.
+		### Drops table if it already exists, do nothing.
 		def drop_table?
-			self.db.drop_table?( self.table_name )
+			self.drop_table if self.table_exists?
 		end
 
 
-		### Called before the table is dropped.
-		def before_drop_table
-			# No-op
+		### Returns true if table exists, false otherwise.
+		def table_exists?
+			return self.db.table_exists?( self.table_name )
 		end
 
 
-		### Called after the table is dropped.
-		def after_drop_table
-			# No-op
+		### Set the dataset to use for the model to +ds+. If a +block+ is provided, it will be
+		### called with the specified +ds+, and should return the modified dataset to use. Any
+		### +options+ that are given will be passed to Sequel::Database#create_or_replace_view
+		def set_view_dataset( ds=nil, **options ) # :yield: ds
+			ds = yield( ds ) if block_given?
+
+			self.view_dataset = ds
+			self.view_options = options
 		end
 
 
-		### Returns the table schema created with set_schema.
-		def schema
-			if !@schema && @schema_block
-				self.set_dataset( self.db[@schema_name] ) if @schema_name
-				@schema = self.db.create_table_generator( &@schema_block )
-				self.set_primary_key( @schema.primary_key_name ) if @schema.primary_key_name
-			end
-			return @schema || ( superclass.schema unless superclass == Sequel::Model )
+		### Create the view for this model class.
+		def create_view( options={} )
+			dataset = self.view_dataset or raise "No view declared for this model."
+			options = self.view_options.merge( options )
+
+			self.db.log_info "Creating view %s(%p): %s" % [ self.table_name, options, dataset.sql ]
+			self.db.create_or_replace_view( self.table_name, dataset, options )
 		end
 
 
-		### Defines a table schema (see Schema::CreateTableGenerator for more information).
-		###
-		### This will also set the dataset if you provide a +name+, as well as setting
-		### the primary key if you define one in the passed block.
-		###
-		### Since this plugin allows you to declare the schema inline with the model
-		### class that acts as its interface, the table will not always exist when the
-		### class loads, so calling #set_schema will call require_valid_table to `false`
-		### for you. You can disable this by passing `require_table: true`.
-		def set_schema( name=nil, require_table: false, &block )
-			self.require_valid_table = require_table
-			@schema = nil
-			@schema_name = name
-			@schema_block = block
+		### Drops the view if it exists and then runs #create_view.
+		def create_view!( options={} )
+			self.drop_view?
+			return self.create_view
 		end
 
 
-		### Returns true if table exists, false otherwise.
-		def table_exists?
-			return self.db.table_exists?( self.table_name )
+		### Creates the view unless it already exists.
+		def create_view?( options={} )
+			self.create_view( options ) unless self.view_exists?
 		end
 
 
+		### Refresh the view for this model class. This can only
+		### be called on materialized views.
+		def refresh_view
+			self.db.refresh_view( self.table_name )
+		end
+
+
+		### Drop the view backing this model.
+		def drop_view
+			self.before_drop_view
+			self.db.drop_view( self.table_name )
+			self.after_drop_view
+		end
+
+
+		### Drop the view if it already exists, otherwise do nothing.
+		def drop_view?
+			self.drop_view if self.view_exists?
+		end
+
+
+		### Returns true if the view associated with this model exists, false otherwise.
+		def view_exists?
+			# Make shortcuts for fully-qualified names
+			class_table = Sequel[:pg_catalog][:pg_class].as( :c )
+			ns_table = Sequel[:pg_catalog][:pg_namespace].as( :n )
+			is_visible = Sequel[:pg_catalog][:pg_table_is_visible]
+
+			ds = db[ class_table ].
+				join( ns_table, oid: :relnamespace )
+			ds = ds.where( Sequel[:c][:relkind] => ['v', 'm'] ).
+				exclude( Sequel[:n][:nspname] => /^pg_toast/ ).
+				where( Sequel[:c][:relname] => self.table_name ).
+				where( Sequel.function(is_visible, Sequel[:c][:oid]) )
+
+			return ds.count == 1
+		end
+
+
+
+		#
+		# Hooks
+		#
+
 		### Table-creation hook; called on a model class before its table is created.
 		def before_create_table
 			return true
@@ -209,18 +284,71 @@ module Sequel::Plugins::InlineSchema
 		end
 
 
-		### Return an Array of model table names that don't yet exist, in the order they
+		### View-creation hook; called before the backing view is created.
+		def before_create_view
+			return true
+		end
+
+
+		### View-creation hook; called after the backing view is created.
+		def after_create_view
+			return true
+		end
+
+
+		### Table-drop hook; called before the table is dropped.
+		def before_drop_table
+			return true
+		end
+
+
+		### Table-drop hook; called after the table is dropped.
+		def after_drop_table
+			return true
+		end
+
+
+		### View-creation hook; called before the backing view is created.
+		def before_create_view
+			return true
+		end
+
+
+		### View-creation hook; called after the backing view is created.
+		def after_create_view
+			return true
+		end
+
+
+		#
+		# Schema-state introspection
+		#
+
+		### Return an Array of model classes whose tables don't yet exist, in the order they
 		### need to be created to satisfy foreign key constraints.
 		def uninstalled_tables
 			self.db.log_info "  searching for unbacked model classes..."
 
 			self.tsort.find_all do |modelclass|
-				next unless modelclass.name && modelclass.name != ''
+				next unless modelclass.name && modelclass.name != '' && !modelclass.is_view_class?
 				!modelclass.table_exists?
 			end.uniq( &:table_name )
 		end
 
 
+		### Return an Array of model classes whose views don't yet exist, in the order
+		### they need to be created.
+		def uninstalled_views
+			return self.tsort.find_all( &:is_view_class? ).reject( &:table_exists? )
+		end
+
+
+		### Returns +true+ if the receiver is defined via a view rather than a table.
+		def is_view_class?
+			return self.respond_to?( :view_dataset ) && self.view_dataset ? true : false
+		end
+
+
 		#########
 		protected
 		#########
@@ -275,7 +403,6 @@ module Sequel::Plugins::InlineSchema
 			end
 		end
 
-
 	end # module ClassMethods
 
 end # module Sequel::Plugin::Schema

data/spec/sequel/plugins/inline_schema_spec.rb

@@ -22,6 +22,11 @@ describe Sequel::Plugins::InlineSchema do
 		name.to_sym
 	end
 
+	let( :view ) do
+		name = "test_view_%s" % [ SecureRandom.hex(8) ]
+		name.to_sym
+	end
+
 	let( :model_class ) do
 		mclass = Class.new( Sequel::Model )
 		mclass.set_dataset( db[table] )
@@ -29,6 +34,8 @@ describe Sequel::Plugins::InlineSchema do
 		mclass
 	end
 
+	let ( :view_dataset ) { model_class.dataset.group_and_count( :age ) }
+
 	let( :valid_pg_attributes ) do
 		[
 			{
@@ -85,7 +92,7 @@ describe Sequel::Plugins::InlineSchema do
 			when /CREATE TABLE/
 				created = true
 			else
-				fail "Unhandled query"
+				fail "Unhandled query %p" % [ query ]
 			end
 		end
 	end
@@ -130,7 +137,6 @@ describe Sequel::Plugins::InlineSchema do
 		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
@@ -179,6 +185,42 @@ describe Sequel::Plugins::InlineSchema do
 	end
 
 
+
+	it "allows a model to create a view instead of a table" do
+		view_class = Class.new( Sequel::Model )
+		view_class.plugin( :inline_schema )
+		view_class.set_dataset( db[view] )
+		view_class.set_view_dataset { view_dataset.naked }
+
+		db.fetch = fake_db_fetcher
+		db.sqls.clear
+
+		view_class.create_view
+
+		expect( db.sqls ).to include(
+			%{CREATE OR REPLACE VIEW "#{view}" AS SELECT "age", count(*) AS "count" FROM "#{table}" GROUP BY "age"}
+		)
+	end
+
+
+	it "allows a model to craete a materialized view instead of a table" do
+		materialized_view_class = Class.new( Sequel::Model )
+		materialized_view_class.plugin( :inline_schema )
+		materialized_view_class.set_dataset( db[view] )
+		materialized_view_class.set_view_dataset( materialized: true ) { view_dataset.naked }
+
+		db.fetch = fake_db_fetcher
+		db.sqls.clear
+
+		materialized_view_class.create_view
+
+		expect( db.sqls ).to include(
+			%{CREATE OR REPLACE MATERIALIZED VIEW "#{view}" AS SELECT "age", count(*) AS "count" } +
+			%{FROM "#{table}" GROUP BY "age"}
+		)
+	end
+
+
 	describe "table-creation ordering" do
 
 		let( :fake_db_fetcher ) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-inline_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   jBZSA+N+xUTgUWpXjjwsLZjzJkhWATJWq+krNXcqpwXo6HsjmdUxoFMt63RBb+sI
   XrxOxp8o0uOkU7FdLSGsyqJ2LzsR4obN
   -----END CERTIFICATE-----
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -140,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="