surus 0.3.0 → 0.3.2

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.3.2 (March 10, 2012)
+
+* No changes. Had to bump version to get around partially failed upload to RubyGems.org.
+
+# 0.3.1 (March 10, 2012)
+
+* Added generator for hstore migration (Tad Thorley)
+
 # 0.3.0 (February 16, 2012)
 
 * Can now round-trip any value YAML can dump and load as an hstore key or value

data/README.md

@@ -3,9 +3,11 @@ Surus
 
 # Description
 
-Surus extends ActiveRecord with PostgreSQL specific functionality. It includes
-hstore and array serializers and helper scopes. It also includes a helper to
-control PostgreSQL synchronous commit behavior.
+Surus accelerates ActiveRecord with PostgreSQL specific types and
+functionality. It enables indexed searching of serialized arrays and hashes.
+It also can control PostgreSQL synchronous commit behavior. By relaxing
+PostgreSQL's durability guarantee, transaction commit rate can be increased by
+50% or more. 
 
 # Installation
 
@@ -45,6 +47,11 @@ Hstores can be searched with helper scopes.
     User.hstore_has_all_keys(:properties, "favorite_color", "gender")
     User.hstore_has_any_keys(:properties, "favorite_color", "favorite_artist")
     
+Hstore is a PostgreSQL extension. You can generate a migration to install it.
+
+    rails g surus:hstore:install
+    rake db:migrate
+    
     
 Read more in the [PostgreSQL hstore documentation](http://www.postgresql.org/docs/9.1/static/hstore.html).
     

data/lib/generators/surus/hstore/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Surus
+  module Hstore
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      desc "creates a migration to install the hstore module"
+      def install
+        migration_template 'install_hstore.rb', 'db/migrate/install_hstore.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/surus/hstore/templates/install_hstore.rb

@@ -0,0 +1,304 @@
+class InstallHstore < ActiveRecord::Migration
+  def self.up
+    version = ActiveRecord::Base.connection.send(:postgresql_version)
+    # check for newer versions
+    if version >= 90100
+      sql = "CREATE EXTENSION hstore"
+    # use the hstore.sql file on the system, if found
+    elsif(path = hstore_sql_path)
+      sql = File.read(path)
+    # run a default hstore.sql
+    else
+      sql = default_sql
+    end
+
+    execute sql
+  end
+
+  def self.down
+    version = ActiveRecord::Base.connection.send(:postgresql_version)
+    execute "DROP EXTENSION hstore" if version >= 90100
+  end
+
+
+private
+  def hstore_sql_path
+    pg_share_dir = (`pg_config --sharedir`).strip
+    file_path = File.join(pg_share_dir, "contrib/hstore.sql")
+    File.exists?(file_path) ? file_path : nil
+  rescue Errno::ENOENT # if `pg_config` fails
+    nil
+  end
+  
+  def default_sql
+    hstore_sql = <<-HSTORE_SQL
+/* $PostgreSQL: pgsql/contrib/hstore/hstore.sql.in,v 1.11 2009/06/11 18:30:03 tgl Exp $ */
+
+-- Adjust this setting to control where the objects get created.
+SET search_path = public;
+
+CREATE TYPE hstore;
+
+CREATE OR REPLACE FUNCTION hstore_in(cstring)
+RETURNS hstore
+AS '$libdir/hstore'
+LANGUAGE C STRICT;
+
+CREATE OR REPLACE FUNCTION hstore_out(hstore)
+RETURNS cstring
+AS '$libdir/hstore'
+LANGUAGE C STRICT;
+
+CREATE TYPE hstore (
+        INTERNALLENGTH = -1,
+        INPUT = hstore_in,
+        OUTPUT = hstore_out,
+        STORAGE = extended
+);
+
+CREATE OR REPLACE FUNCTION fetchval(hstore,text)
+RETURNS text
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OPERATOR -> (
+	LEFTARG = hstore,
+	RIGHTARG = text,
+	PROCEDURE = fetchval
+);
+
+CREATE OR REPLACE FUNCTION isexists(hstore,text)
+RETURNS bool
+AS '$libdir/hstore','exists'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION exist(hstore,text)
+RETURNS bool
+AS '$libdir/hstore','exists'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OPERATOR ? (
+	LEFTARG = hstore,
+	RIGHTARG = text,
+	PROCEDURE = exist,
+	RESTRICT = contsel,
+	JOIN = contjoinsel
+);
+
+CREATE OR REPLACE FUNCTION isdefined(hstore,text)
+RETURNS bool
+AS '$libdir/hstore','defined'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION defined(hstore,text)
+RETURNS bool
+AS '$libdir/hstore','defined'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION delete(hstore,text)
+RETURNS hstore
+AS '$libdir/hstore','delete'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION hs_concat(hstore,hstore)
+RETURNS hstore
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OPERATOR || (
+	LEFTARG = hstore,
+	RIGHTARG = hstore,
+	PROCEDURE = hs_concat
+);
+
+CREATE OR REPLACE FUNCTION hs_contains(hstore,hstore)
+RETURNS bool
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION hs_contained(hstore,hstore)
+RETURNS bool
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OPERATOR @> (
+	LEFTARG = hstore,
+	RIGHTARG = hstore,
+	PROCEDURE = hs_contains,
+	COMMUTATOR = '<@',
+	RESTRICT = contsel,
+	JOIN = contjoinsel
+);
+
+CREATE OPERATOR <@ (
+	LEFTARG = hstore,
+	RIGHTARG = hstore,
+	PROCEDURE = hs_contained,
+	COMMUTATOR = '@>',
+	RESTRICT = contsel,
+	JOIN = contjoinsel
+);
+
+-- obsolete:
+CREATE OPERATOR @ (
+	LEFTARG = hstore,
+	RIGHTARG = hstore,
+	PROCEDURE = hs_contains,
+	COMMUTATOR = '~',
+	RESTRICT = contsel,
+	JOIN = contjoinsel
+);
+
+CREATE OPERATOR ~ (
+	LEFTARG = hstore,
+	RIGHTARG = hstore,
+	PROCEDURE = hs_contained,
+	COMMUTATOR = '@',
+	RESTRICT = contsel,
+	JOIN = contjoinsel
+);
+
+CREATE OR REPLACE FUNCTION tconvert(text,text)
+RETURNS hstore
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE; -- not STRICT
+
+CREATE OPERATOR => (
+	LEFTARG = text,
+	RIGHTARG = text,
+	PROCEDURE = tconvert
+);
+
+CREATE OR REPLACE FUNCTION akeys(hstore)
+RETURNS _text
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION avals(hstore)
+RETURNS _text
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION skeys(hstore)
+RETURNS setof text
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION svals(hstore)
+RETURNS setof text
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION each(IN hs hstore,
+    OUT key text,
+    OUT value text)
+RETURNS SETOF record
+AS '$libdir/hstore'
+LANGUAGE C STRICT IMMUTABLE;
+
+
+
+-- define the GiST support methods
+
+CREATE TYPE ghstore;
+
+CREATE OR REPLACE FUNCTION ghstore_in(cstring)
+RETURNS ghstore
+AS '$libdir/hstore'
+LANGUAGE C STRICT;
+
+CREATE OR REPLACE FUNCTION ghstore_out(ghstore)
+RETURNS cstring
+AS '$libdir/hstore'
+LANGUAGE C STRICT;
+
+CREATE TYPE ghstore (
+        INTERNALLENGTH = -1,
+        INPUT = ghstore_in,
+        OUTPUT = ghstore_out
+);
+
+CREATE OR REPLACE FUNCTION ghstore_compress(internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION ghstore_decompress(internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION ghstore_penalty(internal,internal,internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION ghstore_picksplit(internal, internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION ghstore_union(internal, internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION ghstore_same(internal, internal, internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION ghstore_consistent(internal,internal,int,oid,internal)
+RETURNS bool
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+-- register the opclass for indexing (not as default)
+CREATE OPERATOR CLASS gist_hstore_ops
+DEFAULT FOR TYPE hstore USING gist
+AS
+       	OPERATOR        7       @> ,
+       	OPERATOR        9       ?(hstore,text) ,
+        --OPERATOR        8       <@ ,
+        OPERATOR        13      @ ,
+        --OPERATOR        14      ~ ,
+        FUNCTION        1       ghstore_consistent (internal, internal, int, oid, internal),
+        FUNCTION        2       ghstore_union (internal, internal),
+        FUNCTION        3       ghstore_compress (internal),
+        FUNCTION        4       ghstore_decompress (internal),
+        FUNCTION        5       ghstore_penalty (internal, internal, internal),
+        FUNCTION        6       ghstore_picksplit (internal, internal),
+        FUNCTION        7       ghstore_same (internal, internal, internal),
+        STORAGE         ghstore;
+
+-- define the GIN support methods
+
+CREATE OR REPLACE FUNCTION gin_extract_hstore(internal, internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION gin_extract_hstore_query(internal, internal, int2, internal, internal)
+RETURNS internal
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OR REPLACE FUNCTION gin_consistent_hstore(internal, int2, internal, int4, internal, internal)
+RETURNS bool
+AS '$libdir/hstore'
+LANGUAGE C IMMUTABLE STRICT;
+
+CREATE OPERATOR CLASS gin_hstore_ops
+DEFAULT FOR TYPE hstore USING gin
+AS
+	OPERATOR        7       @> ,
+	OPERATOR        9       ?(hstore,text),
+	FUNCTION        1       bttextcmp(text,text),
+	FUNCTION        2       gin_extract_hstore(internal, internal),
+	FUNCTION        3       gin_extract_hstore_query(internal, internal, int2, internal, internal),
+	FUNCTION        4       gin_consistent_hstore(internal, int2, internal, int4, internal, internal),
+STORAGE         text;
+HSTORE_SQL
+    
+  end
+end

data/lib/surus/version.rb

@@ -1,3 +1,3 @@
 module Surus
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/surus.gemspec

@@ -8,8 +8,12 @@ Gem::Specification.new do |s|
   s.authors     = ["Jack Christensen"]
   s.email       = ["jack@jackchristensen.com"]
   s.homepage    = "https://github.com/JackC/surus"
-  s.summary     = %q{PostgreSQL extensions for ActiveRecord}
-  s.description = %q{Includes serializers and search scopes for hstore and array. Also includes control over synchronous_commit to boost insert and update speed.}
+  s.summary     = %q{PostgreSQL Acceleration for ActiveRecord}
+  s.description = %q{Surus accelerates ActiveRecord with PostgreSQL specific types and
+                    functionality. It enables indexed searching of serialized arrays and hashes.
+                    It also can control PostgreSQL synchronous commit behavior. By relaxing
+                    PostgreSQL's durability guarantee, transaction commit rate can be increased by
+                    50% or more. }
 
   s.rubyforge_project = ""
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-16 00:00:00.000000000 Z
+date: 2012-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &11662280 !ruby/object:Gem::Requirement
+  requirement: &9002920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11662280
+  version_requirements: *9002920
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &11661280 !ruby/object:Gem::Requirement
+  requirement: &9002400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *11661280
+  version_requirements: *9002400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11660340 !ruby/object:Gem::Requirement
+  requirement: &9018280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *11660340
+  version_requirements: *9018280
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &11659560 !ruby/object:Gem::Requirement
+  requirement: &9017820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *11659560
+  version_requirements: *9017820
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &11624780 !ruby/object:Gem::Requirement
+  requirement: &9017360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,9 +65,12 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *11624780
-description: Includes serializers and search scopes for hstore and array. Also includes
-  control over synchronous_commit to boost insert and update speed.
+  version_requirements: *9017360
+description: ! "Surus accelerates ActiveRecord with PostgreSQL specific types and\n
+  \                   functionality. It enables indexed searching of serialized arrays
+  and hashes.\n                    It also can control PostgreSQL synchronous commit
+  behavior. By relaxing\n                    PostgreSQL's durability guarantee, transaction
+  commit rate can be increased by\n                    50% or more. "
 email:
 - jack@jackchristensen.com
 executables: []
@@ -92,6 +95,8 @@ files:
 - bench/hstore_find.rb
 - bench/hstore_serialize.rb
 - bench/synchronous_commit.rb
+- lib/generators/surus/hstore/install_generator.rb
+- lib/generators/surus/hstore/templates/install_hstore.rb
 - lib/surus.rb
 - lib/surus/array/decimal_serializer.rb
 - lib/surus/array/float_serializer.rb
@@ -136,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ''
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: PostgreSQL extensions for ActiveRecord
+summary: PostgreSQL Acceleration for ActiveRecord
 test_files: []