pgxn_utils 0.1.3 → 0.1.4

data/lib/pgxn_utils/cli.rb

@@ -23,20 +23,24 @@ module PgxnUtils
     method_option :generated_by,      :aliases => "-b", :type => :string, :desc => "Name of extension's generator"
     method_option :tags,              :aliases => "-t", :type => :array,  :desc => "Defines extension's tags"
     method_option :release_status,    :aliases => "-r", :type => :string, :desc => "Initial extension's release status"
+	method_option :git,				  :type => :boolean, :default => false, :desc => "Initialize a git repository after create the extension"
+	method_option :template,		  :type => :string, :default => "sql", :desc => "The template that will be used to create the extension. Expected values are: sql, c, fdw"
 
     def skeleton(extension_name,target=nil)
       self.target = options[:target] || target || "."
 
       if is_extension?("#{self.target}/#{extension_name}")
         say "'#{extension_name}' already exists. Please, use 'change' instead 'skeleton'.", :red
-      elsif is_extension?(".")
+      elsif is_extension?(self.target)
         say "You are inside a extension directory, already. Consider use 'change' instead.", :red
       elsif is_dir?("#{self.target}/#{extension_name}")
         say "Can't create an extension overwriting an existing directory.", :red
       else
         self.set_accessors extension_name
 
-        directory "root", extension_name
+        directory selected_template, extension_name
+
+		init_repository("#{self.target}/#{extension_name}") if options[:git]
       end
     end
 
@@ -59,14 +63,16 @@ module PgxnUtils
     def change(extension_name=".")
       extension_path, extension_name = resolve_extension_path_and_name(extension_name)
 
+	  template_type = File.read("#{extension_path}/.template").chomp
+
       self.target = extension_path
       self.extension_name = extension_name
 
       set_accessors(extension_name)
 
       if is_extension?(extension_path)
-        template "root/META.json.tt", "#{extension_path}/META.json"
-        template "root/%extension_name%.control.tt", "#{extension_path}/%extension_name%.control"
+        template "#{template_type}/META.json.tt", "#{extension_path}/META.json"
+        template "#{template_type}/%extension_name%.control.tt", "#{extension_path}/%extension_name%.control"
       else
         say "'#{extension_name}' doesn't appears to be an extension. Please, supply the extension's name", :red
       end
@@ -83,21 +89,30 @@ module PgxnUtils
 
         self.target = path
         archive_name = "#{path}-#{config_options['version']}"
-        ext = "zip"
-        archive = "#{archive_name}.#{ext}"
-
-        if can_zip?(archive)
-          make_dist_clean(path)
-
-          Zippy.create(archive) do |zip|
-            Dir["#{path}/**/**"].each do |file|
-              zip["#{extension_name}-#{config_options['version']}/#{file.sub(path+'/','')}"] = File.open(file) unless File.directory?(file)
-            end
-          end
-          say_status :create, archive, :green
-        end
-      end
-    end
+		prefix_name  = "#{extension_name}-#{config_options['version']}/"
+
+		archive = "#{archive_name}.zip"
+		archived = false
+
+		if has_scm?(path)
+			if is_dirty?(path)
+				say "Your repository is dirty! You should commit or stash before continue.", :red
+			else
+				if can_zip?(archive)
+					scm_archive(path, archive, prefix_name)
+					archived = true
+				end
+			end
+		else
+			if can_zip?(archive)
+				make_dist_clean(path)
+				zip_archive(path, archive, prefix_name)
+				archived = true
+			end
+		end
+		say_status(:create, archive, :green) if archived
+	  end
+	end
 
     desc "release filename", "Release an extension to PGXN"
 

data/lib/pgxn_utils/no_tasks.rb

@@ -2,6 +2,47 @@ module PgxnUtils
   module NoTasks
 
     include PgxnUtils::Constants
+	include Grit
+
+	def selected_template
+		template = options[:template]
+
+		unless [ 'sql', 'c', 'fdw' ].include?(template)
+			if Dir["#{template}/*"].include?("#{template}/META.json") or
+			   Dir["#{template}/*"].include?("#{template}/META.json.tt")
+				template = File.expand_path(options[:template])
+			else
+				raise "invalid template: #{template}"
+			end
+		end
+		template
+	end
+
+	def init_repository(extension_dir)
+		repo = Repo.init(extension_dir)
+		original_dir = File.expand_path "."
+
+		if repo
+			say_status :init, "#{extension_dir}", :green
+
+			FileUtils.chdir extension_dir
+			repo.add "."
+			if repo.commit_index("initial commit")
+				say_status :commit, "initial commit", :green
+			else
+				say_status :failed, "initial commit", :red
+			end
+		else
+			say_status :error, " initializing #{extension_dir}", :red
+		end
+
+		FileUtils.chdir original_dir
+	end
+
+	def is_dirty?(extension_dir)
+		repo = Repo.init(extension_dir)
+		repo.status.map(&:type).uniq != [nil]
+	end
 
     def make_dist_clean(path)
       inside path do
@@ -77,12 +118,34 @@ module PgxnUtils
       [ extension_path, extension_name ]
     end
 
+	def has_scm?(path)
+		begin
+			Repo.new(path)
+		rescue Grit::InvalidGitRepositoryError
+			false
+		end
+	end
+
+	def scm_archive(path, archive, prefix, treeish='master')
+		git = Git.new(Repo.new(path).path)
+		git.archive({:format => "zip", :prefix => prefix, :output => archive}, treeish)
+	end
+
+	def zip_archive(path, archive, prefix)
+		Zip::ZipFile.open(archive, Zip::ZipFile::CREATE) do |zip|
+			Dir["#{path}/**/**"].each do |file|
+				zip.add("#{prefix}#{file.sub(path+'/','')}", file) unless File.directory?(file)
+			end
+		end
+	end
+
     def can_zip?(archive)
       can_zip = false
 
       if File.exists?(archive)
         say_status :conflict, archive, :red
         if yes? "Overwrite #{archive}? [yN]"
+		  FileUtils.rm_f archive
           can_zip = true
         else
           can_zip = false

data/lib/pgxn_utils/templates/c/%extension_name%.control.tt

@@ -0,0 +1,5 @@
+# <%= extension_name %> extension
+comment = '<%= abstract %>'
+default_version = '<%= version %>'
+module_pathname = '$libdir/<%= extension_name %>'
+relocatable = true

data/lib/pgxn_utils/templates/c/.gitignore.tt

@@ -0,0 +1,8 @@
+results/
+*.so
+tmp/
+*.o
+regression.diffs
+regression.out
+/sql/<%= extension_name =>--*
+!/sql/<%= extension_name =>--*--*.sql

data/lib/pgxn_utils/templates/c/.template

@@ -0,0 +1 @@
+c

data/lib/pgxn_utils/templates/c/META.json.tt

@@ -0,0 +1,37 @@
+{
+    "name": "<%= extension_name %>",
+    "abstract": "<%= abstract %>",
+    "description": "<%= description %>",
+    "version": "<%= version %>",
+    "maintainer": "<%= maintainer %>",
+    "license": "<%= license %>",
+    "provides": {
+        "<%= extension_name %>": {
+            "abstract": "<%= abstract %>",
+            "file": "sql/<%= extension_name %>.sql",
+            "docfile": "doc/<%= extension_name %>.md",
+            "version": "<%= version %>"
+        }
+    },
+    "release_status": "<%= release_status %>",
+    "resources": {
+        "bugtracker": {
+            "web": "http://change.me"
+        },
+        "repository": {
+          "url":  "git://change.me/<%= extension_name %>.git",
+          "web":  "http://change.me",
+          "type": "git"
+        }
+    },
+<% if generated_by %>
+    "generated_by": "<%= generated_by %>",
+<% end %>
+<% if tags %>
+    "tags": [ <%= tags.collect { |t| %Q|"#{t}"| }.join(",") %> ],
+<% end %>
+    "meta-spec": {
+        "version": "1.0.0",
+        "url": "http://pgxn.org/meta/spec.txt"
+    }
+}

data/lib/pgxn_utils/templates/c/Makefile.tt

@@ -0,0 +1,24 @@
+EXTENSION    = <%= extension_name %>
+EXTVERSION   = $(shell grep default_version $(EXTENSION).control | sed -e "s/default_version[[:space:]]*=[[:space:]]*'\([^']*\)'/\1/")
+
+DATA         = $(filter-out $(wildcard sql/*--*.sql),$(wildcard sql/*.sql))
+DOCS         = $(wildcard doc/*.md)
+TESTS        = $(wildcard test/sql/*.sql)
+REGRESS      = $(patsubst test/sql/%.sql,%,$(TESTS))
+REGRESS_OPTS = --inputdir=test --load-language=plpgsql
+MODULES      = $(patsubst %.c,%,$(wildcard src/*.c))
+PG_CONFIG    = pg_config
+PG91         = $(shell $(PG_CONFIG) --version | grep -qE " 8\.| 9\.0" && echo no || echo yes)
+
+ifeq ($(PG91),yes)
+all: sql/$(EXTENSION)--$(EXTVERSION).sql
+
+sql/$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
+	cp $< $@
+
+DATA = $(wildcard sql/*--*.sql) sql/$(EXTENSION)--$(EXTVERSION).sql
+EXTRA_CLEAN = sql/$(EXTENSION)--$(EXTVERSION).sql
+endif
+
+PGXS := $(shell $(PG_CONFIG) --pgxs)
+include $(PGXS)

data/lib/pgxn_utils/templates/c/README.md.tt

@@ -0,0 +1,80 @@
+<%= extension_name %>
+<%= extension_name.gsub(/./,"=") %>
+
+<%= description %>
+
+To build it, just do this:
+
+    make
+    make installcheck
+    make install
+
+If you encounter an error such as:
+
+    "Makefile", line 8: Need an operator
+
+You need to use GNU make, which may well be installed on your system as
+`gmake`:
+
+    gmake
+    gmake install
+    gmake installcheck
+
+If you encounter an error such as:
+
+    make: pg_config: Command not found
+
+Be sure that you have `pg_config` installed and in your path. If you used a
+package management system such as RPM to install PostgreSQL, be sure that the
+`-devel` package is also installed. If necessary tell the build process where
+to find it:
+
+    env PG_CONFIG=/path/to/pg_config make && make installcheck && make install
+
+And finally, if all that fails (and if you're on PostgreSQL 8.1 or lower, it
+likely will), copy the entire distribution directory to the `contrib/`
+subdirectory of the PostgreSQL source tree and try it there without
+`pg_config`:
+
+    env NO_PGXS=1 make && make installcheck && make install
+
+If you encounter an error such as:
+
+    ERROR:  must be owner of database regression
+
+You need to run the test suite using a super user, such as the default
+"postgres" super user:
+
+    make installcheck PGUSER=postgres
+
+Once <%= extension_name %> is installed, you can add it to a database. If you're running
+PostgreSQL 9.1.0 or greater, it's a simple as connecting to a database as a
+super user and running:
+
+    CREATE EXTENSION <%= extension_name %>;
+
+If you've upgraded your cluster to PostgreSQL 9.1 and already had <%= extension_name %>
+installed, you can upgrade it to a properly packaged extension with:
+
+    CREATE EXTENSION <%= extension_name %> FROM unpackaged;
+
+For versions of PostgreSQL less than 9.1.0, you'll need to run the
+installation script:
+
+    psql -d mydb -f /path/to/pgsql/share/contrib/<%= extension_name %>.sql
+
+If you want to install <%= extension_name %> and all of its supporting objects into a specific
+schema, use the `PGOPTIONS` environment variable to specify the schema, like
+so:
+
+    PGOPTIONS=--search_path=extensions psql -d mydb -f <%= extension_name %>.sql
+
+Dependencies
+------------
+The `<%= extension_name %>` data type has no dependencies other than PostgreSQL.
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+

data/lib/pgxn_utils/templates/c/doc/%extension_name%.md.tt

@@ -0,0 +1,33 @@
+<%= extension_name %>
+<%= extension_name.gsub(/./,"=") %>
+
+Synopsis
+--------
+
+  Show a brief synopsis of the extension.
+
+Description
+-----------
+
+<%= description %>
+
+Usage
+-----
+
+  Show usage.
+
+Support
+-------
+
+  There is issues tracker? Github? Put this information here.
+
+Author
+------
+
+[<%= maintainer %>]
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+

data/lib/pgxn_utils/templates/c/sql/%extension_name%.sql.tt

@@ -0,0 +1,17 @@
+/*
+ * Author: <%= maintainer %>
+ * Created at: <%= Time.now %>
+ *
+ */
+
+--
+-- This is a example code genereted automaticaly
+-- by pgxn-utils.
+
+-- This is how you define a C function in PostgreSQL.
+CREATE OR REPLACE FUNCTION <%= extension_name %>(text)
+RETURNS text
+AS '<%= extension_name %>'
+LANGUAGE C IMMUTABLE STRICT;
+
+-- See more: http://www.postgresql.org/docs/current/static/xfunc-c.html

data/lib/pgxn_utils/templates/c/sql/uninstall_%extension_name%.sql.tt

@@ -0,0 +1 @@
+DROP FUNCTION <%= extension_name %>(text);

data/lib/pgxn_utils/templates/c/src/%extension_name%.c.tt

@@ -0,0 +1,26 @@
+#include "postgres.h"
+#include "fmgr.h"
+/*
+ * You can include more files here if needed.
+ * To use some types, you must include the
+ * correct file here based on:
+ * http://www.postgresql.org/docs/current/static/xfunc-c.html#XFUNC-C-TYPE-TABLE
+ */
+
+PG_MODULE_MAGIC;
+
+PG_FUNCTION_INFO_V1(<%= extension_name %>);
+Datum <%= extension_name %>(PG_FUNCTION_ARGS);
+
+Datum
+<%= extension_name %>(PG_FUNCTION_ARGS)
+{
+	/*
+	 * This is an empty body and will return NULL
+	 *
+	 * You should remove this comment and type
+	 * cool code here!
+	 */
+
+	PG_RETURN_NULL();
+}

data/lib/pgxn_utils/templates/c/test/expected/base.out.tt

@@ -0,0 +1,9 @@
+\set ECHO 0
+-- You should write your tests
+SELECT <%= extension_name %>('test');
+ <%= extension_name %> 
+<%= '-' * (extension_name.length + 2) %>
+ 
+(1 row)
+
+ROLLBACK;

data/lib/pgxn_utils/templates/c/test/sql/base.sql.tt

@@ -0,0 +1,10 @@
+\set ECHO 0
+BEGIN;
+\i sql/<%= extension_name %>.sql
+\set ECHO all
+
+-- You should write your tests
+
+SELECT <%= extension_name %>('test');
+
+ROLLBACK;

data/lib/pgxn_utils/templates/fdw/%extension_name%.control.tt

@@ -0,0 +1,5 @@
+# <%= extension_name %> extension
+comment = '<%= abstract %>'
+default_version = '<%= version %>'
+module_pathname = '$libdir/<%= extension_name %>'
+relocatable = true

data/lib/pgxn_utils/templates/fdw/.gitignore.tt

@@ -0,0 +1,8 @@
+results/
+*.so
+tmp/
+*.o
+regression.diffs
+regression.out
+/sql/<%= extension_name =>--*
+!/sql/<%= extension_name =>--*--*.sql

data/lib/pgxn_utils/templates/fdw/.template

@@ -0,0 +1 @@
+fdw

data/lib/pgxn_utils/templates/fdw/META.json.tt

@@ -0,0 +1,37 @@
+{
+    "name": "<%= extension_name %>",
+    "abstract": "<%= abstract %>",
+    "description": "<%= description %>",
+    "version": "<%= version %>",
+    "maintainer": "<%= maintainer %>",
+    "license": "<%= license %>",
+    "provides": {
+        "<%= extension_name %>": {
+            "abstract": "<%= abstract %>",
+            "file": "sql/<%= extension_name %>.sql",
+            "docfile": "doc/<%= extension_name %>.md",
+            "version": "<%= version %>"
+        }
+    },
+    "release_status": "<%= release_status %>",
+    "resources": {
+        "bugtracker": {
+            "web": "http://change.me"
+        },
+        "repository": {
+          "url":  "git://change.me/<%= extension_name %>.git",
+          "web":  "http://change.me",
+          "type": "git"
+        }
+    },
+<% if generated_by %>
+    "generated_by": "<%= generated_by %>",
+<% end %>
+<% if tags %>
+    "tags": [ <%= tags.collect { |t| %Q|"#{t}"| }.join(",") %> ],
+<% end %>
+    "meta-spec": {
+        "version": "1.0.0",
+        "url": "http://pgxn.org/meta/spec.txt"
+    }
+}

data/lib/pgxn_utils/templates/fdw/Makefile.tt

@@ -0,0 +1,24 @@
+EXTENSION    = <%= extension_name %>
+EXTVERSION   = $(shell grep default_version $(EXTENSION).control | sed -e "s/default_version[[:space:]]*=[[:space:]]*'\([^']*\)'/\1/")
+
+DATA         = $(filter-out $(wildcard sql/*--*.sql),$(wildcard sql/*.sql))
+DOCS         = $(wildcard doc/*.md)
+TESTS        = $(wildcard test/sql/*.sql)
+REGRESS      = $(patsubst test/sql/%.sql,%,$(TESTS))
+REGRESS_OPTS = --inputdir=test --load-language=plpgsql
+MODULES      = $(patsubst %.c,%,$(wildcard src/*.c))
+PG_CONFIG    = pg_config
+PG91         = $(shell $(PG_CONFIG) --version | grep -qE " 8\.| 9\.0" && echo no || echo yes)
+
+ifeq ($(PG91),yes)
+all: sql/$(EXTENSION)--$(EXTVERSION).sql
+
+sql/$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
+	cp $< $@
+
+DATA = $(wildcard sql/*--*.sql) sql/$(EXTENSION)--$(EXTVERSION).sql
+EXTRA_CLEAN = sql/$(EXTENSION)--$(EXTVERSION).sql
+endif
+
+PGXS := $(shell $(PG_CONFIG) --pgxs)
+include $(PGXS)

data/lib/pgxn_utils/templates/fdw/README.md.tt

@@ -0,0 +1,80 @@
+<%= extension_name %>
+<%= extension_name.gsub(/./,"=") %>
+
+<%= description %>
+
+To build it, just do this:
+
+    make
+    make installcheck
+    make install
+
+If you encounter an error such as:
+
+    "Makefile", line 8: Need an operator
+
+You need to use GNU make, which may well be installed on your system as
+`gmake`:
+
+    gmake
+    gmake install
+    gmake installcheck
+
+If you encounter an error such as:
+
+    make: pg_config: Command not found
+
+Be sure that you have `pg_config` installed and in your path. If you used a
+package management system such as RPM to install PostgreSQL, be sure that the
+`-devel` package is also installed. If necessary tell the build process where
+to find it:
+
+    env PG_CONFIG=/path/to/pg_config make && make installcheck && make install
+
+And finally, if all that fails (and if you're on PostgreSQL 8.1 or lower, it
+likely will), copy the entire distribution directory to the `contrib/`
+subdirectory of the PostgreSQL source tree and try it there without
+`pg_config`:
+
+    env NO_PGXS=1 make && make installcheck && make install
+
+If you encounter an error such as:
+
+    ERROR:  must be owner of database regression
+
+You need to run the test suite using a super user, such as the default
+"postgres" super user:
+
+    make installcheck PGUSER=postgres
+
+Once <%= extension_name %> is installed, you can add it to a database. If you're running
+PostgreSQL 9.1.0 or greater, it's a simple as connecting to a database as a
+super user and running:
+
+    CREATE EXTENSION <%= extension_name %>;
+
+If you've upgraded your cluster to PostgreSQL 9.1 and already had <%= extension_name %>
+installed, you can upgrade it to a properly packaged extension with:
+
+    CREATE EXTENSION <%= extension_name %> FROM unpackaged;
+
+For versions of PostgreSQL less than 9.1.0, you'll need to run the
+installation script:
+
+    psql -d mydb -f /path/to/pgsql/share/contrib/<%= extension_name %>.sql
+
+If you want to install <%= extension_name %> and all of its supporting objects into a specific
+schema, use the `PGOPTIONS` environment variable to specify the schema, like
+so:
+
+    PGOPTIONS=--search_path=extensions psql -d mydb -f <%= extension_name %>.sql
+
+Dependencies
+------------
+The `<%= extension_name %>` data type has no dependencies other than PostgreSQL.
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+

data/lib/pgxn_utils/templates/fdw/doc/%extension_name%.md.tt

@@ -0,0 +1,33 @@
+<%= extension_name %>
+<%= extension_name.gsub(/./,"=") %>
+
+Synopsis
+--------
+
+  Show a brief synopsis of the extension.
+
+Description
+-----------
+
+<%= description %>
+
+Usage
+-----
+
+  Show usage.
+
+Support
+-------
+
+  There is issues tracker? Github? Put this information here.
+
+Author
+------
+
+[<%= maintainer %>]
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+

data/lib/pgxn_utils/templates/fdw/sql/%extension_name%.sql.tt

@@ -0,0 +1,31 @@
+/*
+ * Author: <%= maintainer %>
+ * Created at: <%= Time.now %>
+ *
+ */
+
+--
+-- This is a example code genereted automaticaly
+-- by pgxn-utils.
+
+CREATE OR REPLACE FUNCTION <%= extension_name %>_fdw_validator (text[], oid)
+RETURNS bool
+AS 'MODULE_PATHNAME'
+LANGUAGE C STRICT;
+
+CREATE OR REPLACE FUNCTION <%= extension_name %>_fdw_handler ()
+RETURNS fdw_handler
+AS 'MODULE_PATHNAME'
+LANGUAGE C STRICT;
+
+CREATE FOREIGN DATA WRAPPER <%= extension_name %>_fdw
+VALIDATOR <%= extension_name %>_fdw_validator HANDLER <%= extension_name %>_fdw_handler;
+
+CREATE SERVER <%= extension_name %>_local_service
+FOREIGN DATA WRAPPER <%= extension_name %>_fdw
+OPTIONS ( server_address 'localhost', server_port '389');
+
+-- See more:
+--  http://www.postgresql.org/docs/current/static/sql-createserver.html
+--  http://www.postgresql.org/docs/current/static/sql-createusermapping.html
+--  http://www.postgresql.org/docs/current/static/sql-createforeigndatawrapper.html