Fetching contributors…
Cannot retrieve contributors at this time
184 lines (129 sloc) 6.29 KB
require 'bundler'
#include Rake::DSL
require 'rspec/core/rake_task'
def format_cmd_output(cmd)
`./bin/pgxn-utils #{cmd} | sed 's/^/ /' | sed 's/\[[0-9]*m//g'`
desc "Run RSpec" do |t|
t.verbose = false
t.rspec_opts = %w(--color)
desc "CTag Files"
task :ctag do
#system("ctags -R --exclude=.git --exclude=log * ~/.rvm/gems/")
system("ctags -R --exclude=.git --exclude=log *")
desc "Generate"
task :generate_readme do
rm_r "/tmp/my_cool_extension" if File.exist?("/tmp/my_cool_extension")
rm_r "/tmp/my_cool_c_extension" if File.exist?("/tmp/my_cool_c_extension")
rm_r "/tmp/my_cool_fdw_extension" if File.exist?("/tmp/my_cool_fdw_extension")
rm_r "/tmp/my_cool_versioned_extension" if File.exist?("/tmp/my_cool_versioned_extension")
readme ="", 'w')
readme.puts <<-README
pgxn utils
What is it?
It is a set of task that help developers to create PostgreSQL's extensions, putting
the extension's files in the recomended places and supplying tasks to help bundle
and release your extension to PGXN.
How to install it?
If you have pgxn client installed you can do:
pgxn install pgxn_utils
Or you can install it by rubygems:
gem install pgxn_utils
How it works?
It is all about tasks. Let's see them:
$ pgxn-utils help
# Creating a new extension
$ pgxn-utils skeleton my_cool_extension
#{format_cmd_output("skeleton my_cool_extension -p /tmp")}
Thats it! Just start coding! ":)
## Git support
You can start a new extension with or without version control. By default `pgxn-utils`
supports [git]( but it will not create a repository unless you
use `--git` option in the skeleton task.
$ pgxn-utils skeleton my_cool_versioned_extension --git
#{format_cmd_output("skeleton my_cool_versioned_extension --git -p /tmp")}
When you create a new extension with git support in addition to create skeleton,
`pgxn-utils` will initialize a git repository and create the initial commit.
Once you have your extension in a git repository your `bundle` will use only the
commited files to create the archive, but if your repository is dirty then `pgxn-utils`
will hint you to commit or stash your changes, before bundle.
You must be careful with new files not added to repository, because they will NOT
be archived.
## Default templates
`pgxn-utils` has three templates: `sql`, `c` and `fdw`. If you call `skeleton` without
specifying a template the `sql` is the default. But if your extension will supply some C
modules or you will create a FDW, you can create the extension calling `skeleton` with a
`--template` option.
$ pgxn-utils skeleton my_cool_c_extension --template=c
#{format_cmd_output("skeleton my_cool_c_extension --template=c -p /tmp")}
$ pgxn-utils skeleton my_cool_fdw_extension --template=fdw
#{format_cmd_output("skeleton my_cool_fdw_extension --template=fdw -p /tmp")}
The templates contains examples codes and some links to PostgreSQL documentation
that will try to help you to start coding. SQL and C templates contains some tests
examples, and the example code will compiles and pass `make installcheck`, but they
are examples and you must write your own tests and code.
## Custom templates
If you don't like the templates provided by `pgxn-utils` you can create you own
templates. Just create a directory where you want with at least a META.json or file then you can use your directory as argument to the `--template`
To see how create your own template, you can use, as example, the
[templates directory](
# Changing something
Well suppose you want to change the default maintainer's name and the license, just do:
$ pgxn-utils change my_cool_extension --maintainer "Dickson Guedes" --license bsd
#{format_cmd_output("change my_cool_extension -p /tmp --maintainer 'Dickson Guedes' --license bsd")}
It will wait until you decide what to do.
For all switches that you can use with *change*, type:
$ pgxn-utils help change
#{format_cmd_output("help change")}
# Bundling and Releasing!
Well, since you finished your work you can bundle it to send to [PGXN](
Note that if you have your extension in a git repository `bundle` will use only the
commited files to create the archive, but if your repository is dirty then `pgxn-utils`
will hint you to commit or stash your changes, before bundle.
Let's bundle it:
$ pgxn-utils bundle my_cool_extension
create /home/guedes/extensions/
and release it:
$ pgxn-utils release
Enter your PGXN username: guedes
Enter your PGXN password: ******
Trying to release ... released successfully!
You can export `PGXN_USER` and `PGXN_PASSWORD` environment variables to avoid
type username and password everytime.
# Working in progress
* improve [git]( support
* proxy support
* custom templates
Copyright and License
Copyright (c) 2011 Dickson S. Guedes.
This module is free software; you can redistribute it and/or modify it under
the [PostgreSQL License](
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose, without fee, and without a written agreement is
hereby granted, provided that the above copyright notice and this paragraph
and the following two paragraphs appear in all copies.
In no event shall Dickson S. Guedes be liable to any party for direct,
indirect, special, incidental, or consequential damages, including lost
profits, arising out of the use of this software and its documentation, even
if Dickson S. Guedes has been advised of the possibility of such damage.
Dickson S. Guedes specifically disclaims any warranties, including, but not
limited to, the implied warranties of merchantability and fitness for a
particular purpose. The software provided hereunder is on an "as is" basis,
and Dickson S. Guedes has no obligations to provide maintenance, support,
updates, enhancements, or modifications.
task :default => :spec