thingfish-metastore-pg 0.1.0.pre20160627113019

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d965280761dc25444cd36fb1e0ac88099d5d3c57
+  data.tar.gz: f556f30655cc4012e7dd45cbc4050b2ef4c448e7
+SHA512:
+  metadata.gz: aa6c3d6eca82612625762a33eaa1d29076863da10f7f0d04b50a03715c1a6bdc2e806b6e838505e439104018800225119fa118865e094980cef6aa72e990efc8
+  data.tar.gz: f0bdc7e987b43f9cbf9c7415978ddd65d0eaaaf121c919a8934b0e5df16a8a16c1a53e1e86faa536d47bd5f78dcbb1b7db859f947f6de4113eb702a631d0983e

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+���e�?�Ю�=��`y$����֕�7�F����[�g���'�z򗣖��\Z�!	3=�b��]�N?r0�����c9Ǵ}�KXV�%V����xO4���H?Cqܻ�s~J'z�H��yU5�R7���X�Xҧ�@WsL���2la50/���)8��V�Ȋ�L���;�\ix3G���+�&�5_׋j� �&G؜7|2Ux�0�$ll���gG��p#K`r�u�>��f��*n9� A;l��M�7��-�����#�_ii�?�ǐG7�b���]�x����ƾ$�O��y�~O�#�y

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

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,95 @@
+2016-06-27  Michael Granger  <ged@FaerieMUD.org>
+
+	* .gems, .ruby-gemset, .ruby-version, .rvmrc, Gemfile, History.md,
+	History.rdoc, README.md, README.rdoc, Rakefile, thingfish-metastore-
+	pg.gemspec:
+	Update build env
+	[0a1c87687905] [tip]
+
+2015-12-14  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/thingfish/metastore/pg.rb,
+	lib/thingfish/metastore/pg/metadata.rb:
+	Consider user metadata for ordering, too
+	[d69c38e41d05] [github/master]
+
+2015-12-10  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/thingfish/metastore/pg.rb:
+	Don't raise a NoMethodError on missing metadata keys
+	[99ac5402317a]
+
+	* Rakefile:
+	Use latest semantic versioning for the gemspec
+	[7c7236fda1e2]
+
+2015-11-02  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/thingfish/metastore/pg.rb:
+	Rename obsoleted metastore API to correct name.
+	[993664929f87]
+
+	* LICENSE.rdoc, README.rdoc, Rakefile:
+	Fix README and LICENSE file.
+	[e9c83aeb5889]
+
+2015-04-01  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* .gems, .rvm.gems, .rvmrc:
+	Bump development default ruby version, rename rvm gems file.
+	[3e762af58fc9]
+
+2015-01-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/thingfish/metastore/pg.rb:
+	Fix the #apply_search_order method
+	[41dec81585a4]
+
+	* lib/thingfish/metastore/pg.rb:
+	Make the return from #search not use a lazy enumerator.
+
+	It was an interesting experiment, but I don't think it's going to
+	work without retooling the handler to support enumerators.
+	[7e3215bec4f4]
+
+	* lib/thingfish/metastore/pg/metadata.rb:
+	Ensure the "uploadaddress" is a string
+	[e367a26e6d3b]
+
+	* lib/thingfish/metastore/pg.rb:
+	Rearrange the config methods.
+
+	The `::configure` method needs to be below the methods it calls in
+	case it's called upon definition.
+	[485bf6854980]
+
+	* .hgignore:
+	Ignore the package directory.
+	[21423daeb9ce]
+
+2015-01-28  Michael Granger  <ged@FaerieMUD.org>
+
+	* data/thingfish-metastore-pg/migrations/20150114_initial.rb,
+	lib/thingfish/metastore/pg.rb,
+	lib/thingfish/metastore/pg/metadata.rb, spec/spec_helper.rb:
+	Add initial Thingfish::Metastore API
+	[3b0d1b844ad6]
+
+	* .hgignore, .pryrc, Manifest.txt:
+	Update some project files
+	[95106fe17011]
+
+2015-01-14  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, data/thingfish-metastore-
+	pg/migrations/20150114_initial.rb, lib/thingfish/metastore/pg.rb,
+	spec/spec_helper.rb, spec/thingfish/metastore/pg_spec.rb:
+	Got the schema loading and spec helpers set up
+	[62f8eaf03619]
+
+	* .document, .gitignore, .hgignore, .pryrc, .rvm.gems, .rvmrc,
+	.simplecov, History.rdoc, LICENSE.rdoc, README.rdoc, Rakefile,
+	lib/thingfish/metastore/pg.rb, spec/spec_helper.rb,
+	spec/thingfish/metastore/pg_spec.rb:
+	Initial boilerplate
+	[d4cb46c1f0b5]

data/History.md

@@ -0,0 +1,4 @@
+## v0.0.1 [YYYY-MM-DD] Michael Granger <ged@FaerieMUD.org>
+
+Initial release.
+

data/LICENSE.md

@@ -0,0 +1,29 @@
+Copyright (c) 2014-2016, Michael Granger and Mahlon E. Smith.
+
+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 authors, nor the names of its 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/Manifest.txt

@@ -0,0 +1,13 @@
+.document
+.simplecov
+ChangeLog
+History.md
+LICENSE.md
+Manifest.txt
+README.md
+Rakefile
+data/thingfish-metastore-pg/migrations/20150114_initial.rb
+lib/thingfish/metastore/pg.rb
+lib/thingfish/metastore/pg/metadata.rb
+spec/spec_helper.rb
+spec/thingfish/metastore/pg_spec.rb

data/README.md

@@ -0,0 +1,69 @@
+# Thingfish PostgreSQL Metastore
+
+home
+: https://bitbucket.org/projects/thingfish-metastore-pg
+
+code
+: https://bitbucket.org/ged/thingfish-metastore-pg
+
+github
+: https://github.com/ged/thingfish-metastore-pg
+
+docs
+: https://deveiate.org/code/thingfish-metastore-pg
+
+
+## Description
+
+This is a metadata storage plugin for the Thingfish digital asset manager. It provides persistent storage for uploaded data to a PostgreSQL table.
+
+
+## Authors
+
+* Michael Granger <ged@FaerieMUD.org>
+* Mahlon E. Smith <mahlon@martini.nu>
+
+
+## Installation
+
+    $ gem install thingfish-metastore-pg
+
+
+##  Usage
+
+As with Thingfish itself, this plugin uses Configurability[https://rubygems.org/gems/configurability] to modify default behaviors.
+
+Here's an example configuration file that enables this plugin.
+
+	---
+	thingfish:
+	  metastore: pg
+
+	pg_metastore:
+	  uri: postgres://thingfish:password@db.example.com/database
+
+
+When Thingfish starts, it will install the necessary database schema automatically.
+
+
+## License
+
+Copyright (c) 2014-2016, Michael Granger and Mahlon E. Smith.
+
+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 authors, nor the names of its 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,93 @@
+#!/usr/bin/env rake
+
+begin
+	require 'hoe'
+rescue LoadError
+	abort "This Rakefile requires hoe (gem install hoe)"
+end
+
+GEMSPEC = 'thingfish-metastore-pg.gemspec'
+
+
+Hoe.plugin :mercurial
+Hoe.plugin :signing
+Hoe.plugin :deveiate
+Hoe.plugin :bundler
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugins.delete :gemcutter
+
+hoespec = Hoe.spec 'thingfish-metastore-pg' 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:   'https://bitbucket.org/ged/thingfish-metastore-pg',
+		code:   'https://bitbucket.org/ged/thingfish-metastore-pg',
+		docs:   'https://deveiate.org/code/thingfish-metastore-pg',
+		github: 'https://github.com/ged/thingfish-metastore-pg',
+	}
+
+	spec.developer 'Michael Granger', 'ged@FaerieMUD.org'
+	spec.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
+
+	spec.dependency 'thingfish', '~> 0.5'
+	spec.dependency 'loggability', '~> 0.10'
+	spec.dependency 'configurability', '~> 2.2'
+	spec.dependency 'sequel', '~> 4.35'
+	spec.dependency 'pg', '~> 0.18'
+
+	spec.dependency 'rspec', '~> 3.0', :developer
+
+	spec.require_ruby_version( '>=2.3.0' )
+	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
+
+	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 ]
+
+# 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
+
+
+# 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.rdoc_files.include( "*.rdoc", "*.md", "ChangeLog", "lib/**/*.rb" )
+	    rdoc.generator = :fivefish
+		rdoc.title = 'Arborist'
+	    rdoc.rdoc_dir = 'doc'
+	end
+end
+
+
+task :gemspec => GEMSPEC
+file GEMSPEC => [ __FILE__, 'ChangeLog' ] do |task|
+	spec = $hoespec.spec
+	spec.files.delete( '.gemtest' )
+	spec.signing_key = nil
+	spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
+	File.open( task.name, 'w' ) do |fh|
+		fh.write( spec.to_ruby )
+	end
+end
+
+task :default => :gemspec
+CLOBBER.include( GEMSPEC.to_s )

data/data/thingfish-metastore-pg/migrations/20150114_initial.rb

@@ -0,0 +1,23 @@
+# vim: set nosta noet ts=4 sw=4:
+
+### The initial Thingfish::Metastore::PG DDL.
+###
+class Initial < Sequel::Migration
+
+	def up
+		create_schema( :thingfish, if_not_exists: true )
+		create_table( :thingfish__metadata ) do
+			uuid        :oid,           primary_key: true
+			text        :format,        null: false
+			int         :extent,        null: false
+			timestamptz :created,       null: false, default: Sequel.function(:now)
+			inet        :uploadaddress, null: false
+			jsonb       :user_metadata, null: false, default: '{}'
+		end
+	end
+
+	def down
+		drop_table( :thingfish__metadata )
+	end
+end
+

data/lib/thingfish/metastore/pg.rb

@@ -0,0 +1,305 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'loggability'
+require 'configurability'
+require 'sequel'
+require 'strelka'
+require 'strelka/mixins'
+
+require 'thingfish'
+require 'thingfish/mixins'
+require 'thingfish/metastore'
+
+# Toplevel namespace
+class Thingfish::Metastore::PG < Thingfish::Metastore
+	extend Loggability,
+	       Configurability,
+	       Strelka::MethodUtilities
+	include Thingfish::Normalization
+
+
+	# Load Sequel extensions/plugins
+	Sequel.extension :migration
+
+
+	# Package version
+	VERSION = '0.0.1'
+
+	# Version control revision
+	REVISION = %q$Revision: d69c38e41d05 $
+
+	# The data directory that contains migration files.
+	#
+	DATADIR = if ENV['THINGFISH_METASTORE_PG_DATADIR']
+			Pathname.new( ENV['THINGFISH_METASTORE_PG_DATADIR'] )
+		elsif Gem.datadir( 'thingfish-metastore-pg' )
+			Pathname.new( Gem.datadir('thingfish-metastore-pg') )
+		else
+			Pathname.new( __FILE__ ).dirname.parent.parent.parent +
+				'data' + 'thingfish-metastore-pg'
+		end
+
+	# The default config values
+	DEFAULT_CONFIG = {
+		uri: 'postgres:/thingfish',
+		slow_query_seconds: 0.01,
+	}
+
+
+	# Loggability API -- use a separate logger
+	log_as :thingfish_metastore_pg
+
+	# Configurability API -- load the `pg_metastore`
+	config_key :pg_metastore
+
+	##
+	# The URI of the database to use for the metastore
+	singleton_attr_accessor :uri
+
+	##
+	# The Sequel::Database that's used to access the metastore tables
+	singleton_attr_accessor :db
+
+	##
+	# The number of seconds to consider a "slow" query
+	singleton_attr_accessor :slow_query_seconds
+
+
+	### Set up the metastore database and migrate to the latest version.
+	def self::setup_database
+		Sequel.extension :pg_json_ops
+
+		self.db = Sequel.connect( self.uri )
+
+		self.db.logger = Loggability[ Thingfish::Metastore::PG ]
+		self.db.sql_log_level = :debug
+		self.db.extension( :pg_json )
+		self.db.log_warn_duration = self.slow_query_seconds
+
+		# Ensure the database is current.
+		#
+		unless Sequel::Migrator.is_current?( self.db, self.migrations_dir.to_s )
+			self.log.info "Installing database schema..."
+			Sequel::Migrator.apply( self.db, self.migrations_dir.to_s )
+		end
+	end
+
+
+	### Tear down the configured metastore database.
+	def self::teardown_database
+		self.log.info "Tearing down database schema..."
+		Sequel::Migrator.apply( self.db, self.migrations_dir.to_s, 0 )
+	end
+
+
+	### Return the current database migrations directory as a Pathname
+	def self::migrations_dir
+		return DATADIR + 'migrations'
+	end
+
+
+	### Configurability API -- set up the metastore with the `pg_metastore` section of
+	### the config file.
+	def self::configure( config=nil )
+		config = self.defaults.merge( config || {} )
+
+		self.uri                = config[:uri]
+		self.slow_query_seconds = config[:slow_query_seconds]
+
+		self.setup_database
+	end
+
+
+	### Set up the metastore.
+	def initialize( * ) # :notnew:
+		require 'thingfish/metastore/pg/metadata'
+		Thingfish::Metastore::PG::Metadata.db = self.class.db
+		@model = Thingfish::Metastore::PG::Metadata
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The Sequel model representing the metadata rows.
+	attr_reader :model
+
+
+	#
+	# :section: Thingfish::Metastore API
+	#
+
+	### Return an Array of all stored oids.
+	def oids
+		return self.each_oid.to_a
+	end
+
+
+	### Iterate over each of the store's oids, yielding to the block if one is given
+	### or returning an Enumerator if one is not.
+	def each_oid( &block )
+		return self.model.select_map( :oid ).each( &block )
+	end
+
+
+	### Save the +metadata+ Hash for the specified +oid+.
+	def save( oid, metadata )
+		md = self.model.from_hash( metadata )
+		md.oid = oid
+		md.save
+	end
+
+
+	### Fetch the data corresponding to the given +oid+ as a Hash-ish object.
+	def fetch( oid, *keys )
+		metadata = self.model[ oid ] or return nil
+
+		if keys.empty?
+			return metadata.to_hash
+		else
+			keys = normalize_keys( keys )
+			values = metadata.to_hash.values_at( *keys )
+			return Hash[ [keys, values].transpose ]
+		end
+	end
+
+
+	### Fetch the value of the metadata associated with the given +key+ for the
+	### specified +oid+.
+	def fetch_value( oid, key )
+		metadata = self.model[ oid ] or return nil
+		key = key.to_sym
+		return metadata[ key ] || metadata.user_metadata[ key ]
+	end
+
+
+	### Fetch UUIDs related to the given +oid+.
+	def fetch_related_oids( oid )
+		oid = normalize_oid( oid )
+		return self.model.related_to( oid ).select_map( :oid )
+	end
+
+
+	### Search the metastore for UUIDs which match the specified +criteria+ and
+	### return them as an iterator.
+	def search( options={} )
+		ds = self.model.naked.select( :oid )
+		self.log.debug "Starting search with %p" % [ ds ]
+
+		ds = self.omit_related_resources( ds, options )
+		ds = self.apply_search_criteria( ds, options )
+		ds = self.apply_search_order( ds, options )
+		ds = self.apply_search_direction( ds, options )
+		ds = self.apply_search_limit( ds, options )
+
+		self.log.debug "Dataset for search is: %s" % [ ds.sql ]
+
+		return ds.map {|row| row[:oid] }
+	end
+
+
+	### Update the metadata for the given +oid+ with the specified +values+ hash.
+	def merge( oid, values )
+		values = normalize_keys( values )
+
+		md = self.model[ oid ] or return nil
+		md.merge!( values )
+		md.save
+	end
+
+
+	### Remove all metadata associated with +oid+ from the Metastore.
+	def remove( oid, *keys )
+		self.model[ oid: oid ].destroy
+	end
+
+
+	### Remove all metadata associated with +oid+ except for the specified +keys+.
+	def remove_except( oid, *keys )
+		keys = normalize_keys( keys )
+
+		md = self.model[ oid ] or return nil
+		md.user_metadata.keep_if {|key,_| keys.include?(key) }
+		md.save
+	end
+
+
+	### Returns +true+ if the metastore has metadata associated with the specified +oid+.
+	def include?( oid )
+		return self.model.count( oid: oid ).nonzero?
+	end
+
+
+	### Returns the number of objects the store contains.
+	def size
+		return self.model.count
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Omit related resources from the search dataset +ds+ unless the given
+	### +options+ specify otherwise.
+	def omit_related_resources( ds, options )
+		unless options[:include_related]
+			self.log.debug "  omitting entries for related resources"
+			ds = ds.unrelated
+		end
+		return ds
+	end
+
+
+	### Apply the search :criteria from the specified +options+ to the collection
+	### in +ds+ and return the modified dataset.
+	def apply_search_criteria( ds, options )
+		if (( criteria = options[:criteria] ))
+			criteria.each do |field, value|
+				self.log.debug "  applying criteria: %p => %p" % [ field.to_s, value ]
+				ds = ds.where_metadata( field => value )
+			end
+		end
+
+		return ds
+	end
+
+
+	### Apply the search :order from the specified +options+ to the collection in
+	### +ds+ and return the modified dataset.
+	def apply_search_order( ds, options )
+		if options[:order]
+			columns = Array( options[:order] )
+			self.log.debug "  ordering results by columns: %p" % [ columns ]
+			ds = ds.order_metadata( columns )
+		end
+
+		return ds
+	end
+
+
+	### Apply the search :direction from the specified +options+ to the collection
+	### in +ds+ and return the modified dataset.
+	def apply_search_direction( ds, options )
+		ds = ds.reverse if options[:direction] && options[:direction] == 'desc'
+		return ds
+	end
+
+
+	### Apply the search :limit from the specified +options+ to the collection in
+	### +ds+ and return the modified dataset.
+	def apply_search_limit( ds, options )
+		if (( limit = options[:limit] ))
+			self.log.debug "  limiting to %s results" % [ limit ]
+			offset = options[:offset] || 0
+			ds = ds.limit( limit, offset )
+		end
+
+		return ds
+	end
+
+end # class Thingfish::Metastore::PG
+

data/lib/thingfish/metastore/pg/metadata.rb

@@ -0,0 +1,154 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'sequel/model'
+
+require 'thingfish/mixins'
+require 'thingfish/metastore/pg' unless defined?( Thingfish::Metastore::PG )
+
+
+# A row of metadata describing an asset in a Thingfish store.
+class Thingfish::Metastore::PG::Metadata < Sequel::Model( :thingfish__metadata )
+	include Thingfish::Normalization
+
+	# Allow instances to be created with a primary key
+	unrestrict_primary_key
+
+
+	# Dataset methods
+	dataset_module do
+
+		### Dataset method: Limit results to metadata which is for a related resource.
+		def related
+			return self.exclude( self.user_metadata_expr('relation') => nil )
+		end
+
+
+		### Dataset method: Limit results to metadata which is not for a related resource.
+		def unrelated
+			return self.where_metadata( relation: nil )
+		end
+
+
+		### Return a dataset which will select metadata of resources related to the
+		### resource with the given +oid+.
+		def related_to( oid )
+			oid = oid.oid if oid.respond_to?( :oid ) # Support query by model object
+			oid = Thingfish::Normalization.normalize_oid( oid )
+
+			return self.where_metadata( relation: oid )
+		end
+
+
+		### Dataset method: Limit results to records whose operational or user
+		### metadata matches the values from the specified +hash+.
+		def where_metadata( hash )
+			ds = self
+			hash.each do |field, value|
+				if Thingfish::Metastore::PG::Metadata.metadata_columns.include?( field.to_sym )
+					ds = ds.where( field.to_sym => value )
+				else
+					ds = ds.where( self.user_metadata_expr(field) => value )
+				end
+			end
+
+			return ds
+		end
+
+
+		### Dataset method: Order results by the specified +columns+.
+		def order_metadata( *columns )
+			columns.flatten!
+			ds = self
+			columns.each do |column|
+				if Thingfish::Metastore::PG::Metadata.metadata_columns.include?( column.to_sym )
+					ds = ds.order_append( column.to_sym )
+				else
+					ds = ds.order_append( self.user_metadata_expr(column) )
+				end
+			end
+
+			return ds
+		end
+
+
+		#########
+		protected
+		#########
+
+		### Returns a Sequel expression suitable for use as the key of a query against
+		### the specified user metadata field.
+		def user_metadata_expr( field )
+			return Sequel.pg_jsonb( :user_metadata ).get_text( field.to_s )
+		end
+
+	end # dataset_module
+
+
+	### Return a new Metadata object from the given +oid+ and one-dimensional +hash+
+	### used by Thingfish.
+	def self::from_hash( hash )
+		metadata = Thingfish::Normalization.normalize_keys( hash )
+
+		md = new
+
+		md.format        = metadata.delete( 'format' )
+		md.extent        = metadata.delete( 'extent' )
+		md.created       = metadata.delete( 'created' )
+		md.uploadaddress = metadata.delete( 'uploadaddress' ).to_s
+
+		md.user_metadata = Sequel.pg_jsonb( metadata )
+
+		return md
+	end
+
+
+	### Return the columns of the table that are used for resource metadata.
+	def self::metadata_columns
+		return self.columns - [self.primary_key, :user_metadata]
+	end
+
+
+	### Do some initial attribute setup for new objects.
+	def initialize( * )
+		super
+		self[ :user_metadata ] ||= Sequel.pg_jsonb({})
+	end
+
+
+	### Return the metadata as a Hash; overridden from Sequel::Model to
+	### merge the user and system pairs together.
+	def to_hash
+		hash = self.values
+
+		hash.delete( :oid )
+		hash.merge!( hash.delete(:user_metadata) )
+
+		return normalize_keys( hash )
+	end
+
+
+	### Merge new metadata +values+ into the metadata for the resource
+	def merge!( values )
+
+		# Extract and set the column-metadata values first
+		self.class.metadata_columns.each do |col|
+			next unless values.key?( col.to_s )
+			self[ col ] = values.delete( col.to_s )
+		end
+
+		self.user_metadata.merge!( values )
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Proxy method -- fetch a value from the metadata hash if it exists.
+	def method_missing( sym, *args, &block )
+		return self.user_metadata[ sym.to_s ] || super
+	end
+
+end # Thingfish::Metastore::PG::Metadata
+

data/spec/spec_helper.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/ruby
+# coding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname( __FILE__ ).dirname.parent
+
+	thingfishdir = basedir.parent + 'Thingfish'
+	thingfishlib = thingfishdir + 'lib'
+
+	$LOAD_PATH.unshift( thingfishlib.to_s ) if thingfishlib.exist?
+}
+
+
+# SimpleCov test coverage reporting; enable this using the :coverage rake task
+require 'simplecov' if ENV['COVERAGE']
+
+require 'loggability'
+require 'loggability/spechelpers'
+require 'configurability'
+require 'configurability/behavior'
+
+require 'rspec'
+require 'thingfish'
+require 'thingfish/spechelpers'
+require 'thingfish/behaviors'
+require 'thingfish/metastore'
+
+Loggability.format_with( :color ) if $stdout.tty?
+
+# Some helper functions for testing. Usage:
+#
+#    # in spec/spec_helper.rb
+#    RSpec.configure do |c|
+#      c.include( Thingfish::Metastore::PG::SpecHelpers )
+#    end
+#
+#    # in my_class_spec.rb; mark an example as needing database setup
+#    describe MyClass, db: true do
+#    end
+#
+module Thingfish::MetastorePGSpecHelpers
+
+	TESTDB_ENV_VAR = 'THINGFISH_DB_URI'
+
+	### Inclusion callback -- install some hooks
+	def self::included( context )
+
+		context.before( :all ) do
+			if ((db_uri = ENV[ TESTDB_ENV_VAR ]))
+				Thingfish::Metastore::PG.configure( uri: db_uri )
+			end
+		end
+
+		context.after( :all ) do
+			Thingfish::Metastore::PG.teardown_database if Thingfish::Metastore::PG.db
+		end
+
+		context.around( :each ) do |example|
+			if (( setting = example.metadata[:db] ))
+				Loggability[ Thingfish::Metastore::PG ].debug "DB setting: %p" % [ setting ]
+
+				if ((db = Thingfish::Metastore::PG.db))
+					if setting == :no_transaction || setting == :without_transaction
+						Loggability[ Thingfish::Metastore::PG ].debug "  running without a transaction"
+						example.run
+					else
+						Loggability[ Thingfish::Metastore::PG ].debug "  running with a transaction"
+						db.transaction( rollback: :always ) do
+							example.run
+						end
+					end
+				elsif setting.to_s == 'pending'
+					example.metadata[:pending] ||=
+						"a configured database URI in #{TESTDB_ENV_VAR}"
+				else
+					fail "No database connection! " +
+					     "Ensure you have the #{TESTDB_ENV_VAR} ENV variable set to " +
+						 "the URI of an (empty) test database you have write permissions to."
+				end
+			else
+				example.run
+			end
+		end
+
+		super
+	end
+
+end # module Thingfish::Metastore::PG::SpecHelpers
+
+
+### Mock with RSpec
+RSpec.configure do |c|
+	include Thingfish::SpecHelpers
+	include Thingfish::SpecHelpers::Constants
+
+	c.run_all_when_everything_filtered = true
+	c.filter_run :focus
+	# c.order = 'random'
+	c.mock_with( :rspec ) do |mock|
+		mock.syntax = :expect
+	end
+
+	c.include( Loggability::SpecHelpers )
+	c.include( Thingfish::SpecHelpers )
+	c.include( Thingfish::MetastorePGSpecHelpers )
+end
+
+# vim: set nosta noet ts=4 sw=4:
+

data/spec/thingfish/metastore/pg_spec.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env rspec -cfd
+#encoding: utf-8
+
+require_relative '../../spec_helper'
+
+require 'rspec'
+
+require 'thingfish/behaviors'
+require 'thingfish/metastore/pg'
+
+describe Thingfish::Metastore::PG, db: true do
+
+	it_should_behave_like "a Thingfish metastore"
+
+end
+

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: thingfish-metastore-pg
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre20160627113019
+platform: ruby
+authors:
+- Michael Granger
+- Mahlon E. Smith
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMTYwODIwMTgxNzQyWhcNMTcwODIwMTgxNzQyWjA+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
+  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBCwUAA4IBgQAPJzKiT0zBU7kpqe0aS2qb
+  FI0PJ4y5I8buU4IZGUD5NEt/N7pZNfOyBxkrZkXhS44Fp+xwBH5ebLbq/WY78Bqd
+  db0z6ZgW4LMYMpWFfbXsRbd9TU2f52L8oMAhxOvF7Of5qJMVWuFQ8FPagk2iHrdH
+  inYLQagqAF6goWTXgAJCdPd6SNeeSNqA6vlY7CV1Jh5kfNJJ6xu/CVij1GzCLu/5
+  DMOr26DBv+qLJRRC/2h34uX71q5QgeOyxvMg+7V3u/Q06DXyQ2VgeeqiwDFFpEH0
+  PFkdPO6ZqbTRcLfNH7mFgCBJjsfSjJrn0sPBlYyOXgCoByfZnZyrIMH/UY+lgQqS
+  6Von1VDsfQm0eJh5zYZD64ZF86phSR7mUX3mXItwH04HrZwkWpvgd871DZVR3i1n
+  w8aNA5re5+Rt/Vvjxj5AcEnZnZiz5x959NaddQocX32Z1unHw44pzRNUur1GInfW
+  p4vpx2kUSFSAGjtCbDGTNV2AH8w9OU4xEmNz8c5lyoA=
+  -----END CERTIFICATE-----
+date: 2016-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thingfish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: configurability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.35'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.35'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: This is a metadata storage plugin for the Thingfish digital asset manager.
+  It provides persistent storage for uploaded data to a PostgreSQL table.
+email:
+- ged@FaerieMUD.org
+- mahlon@martini.nu
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+files:
+- ".document"
+- ".simplecov"
+- ChangeLog
+- History.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+- Rakefile
+- data/thingfish-metastore-pg/migrations/20150114_initial.rb
+- lib/thingfish/metastore/pg.rb
+- lib/thingfish/metastore/pg/metadata.rb
+- spec/spec_helper.rb
+- spec/thingfish/metastore/pg_spec.rb
+homepage: https://bitbucket.org/ged/thingfish-metastore-pg
+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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This is a metadata storage plugin for the Thingfish digital asset manager
+test_files: []

metadata.gz.sig

@@ -0,0 +1 @@
+``�b��qV7Q��µY�Oz�R8B����?Ī'��m���3�6N[�^��I!E�ظR&vk��K���#�I6�<���'�w�R�)od�����A���<3�� �����2�H�M�w}A�x�v$­���نQ�vV.�E��b�Lv�BE1���������9(�������j��pz@�i)�mȴ���c��^BdHUz��Y؜u-@zF[�ңQĩ$}�3�Ɏ�K�F��2P3P��a�8��2�E���y���x4p>�<�;ƘJ�^�^DB~i�K�@�����h�R/��	��x�@́�M�aD����/`��B���J*ES�8�Svz�i7��g��&ZV���.��Bm�+<�c��\g�=�