squirm_rails 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+spec/coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+coverage
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include "pkg", "test/coverage", "doc", "*.gem"
+
+task default: :test
+
+task :gem do
+  sh "gem build squirm_rails.gemspec"
+end
+
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/*_test.rb"]
+    t.verbose = false
+  end
+end

data/lib/squirm/rails.rb

@@ -0,0 +1,23 @@
+require "squirm"
+require "squirm/rails/connection_pool"
+require "squirm/rails/active_record_support"
+
+module Squirm
+  module Rails
+
+    class Railtie < ::Rails::Railtie
+      initializer "squirm.setup" do
+        Squirm.connect pool: ConnectionPool.new
+        ActiveRecord::Base.extend ActiveRecordSupport
+      end
+
+      rake_tasks do
+        load File.expand_path("../rails/squirm.rake", __FILE__)
+      end
+
+      generators do
+        require File.expand_path("../rails/generator", __FILE__)
+      end
+    end
+  end
+end

data/lib/squirm/rails/active_record_support.rb

@@ -0,0 +1,33 @@
+module Squirm
+
+  module Rails
+
+    # Support for working with procedures inside Active Record models. This
+    # exists primarily to ensure that stored procedure calls are done inside the
+    # same connection  used by the AR model, to avoid transaction opacity issues
+    # that could arise if AR and Squirm are used different connections.
+    module ActiveRecordSupport
+
+      def procedure(name, options = {}, &block)
+        name = options[:as] || name
+
+        self.class_eval(<<-EOM, __FILE__, __LINE__ + 1)
+          @@__squirm ||= {}
+          @@__squirm[:#{name}] = Squirm.procedure("#{name}")
+
+          def self.#{name}(options = {})
+            Squirm.use(connection.raw_connection) do
+              @@__squirm[:#{name}].call(options)
+            end
+          end
+
+          def #{name}(options = {})
+            proc_args = @@__squirm[:#{name}].arguments
+            args = proc_args.inject({}) {|m, o| m[o] ||= try(o); m}
+            self.class.#{name}(args.merge(options))
+          end
+        EOM
+      end
+    end
+  end
+end

data/lib/squirm/rails/connection_pool.rb

@@ -0,0 +1,22 @@
+module Squirm
+  module Rails
+    class ConnectionPool
+
+      def initialize
+        @pool = ActiveRecord::Base.connection_pool
+        @map  = {}
+      end
+
+      def checkout
+        conn = @pool.checkout
+        raw_connection = conn.raw_connection
+        @map[raw_connection.object_id] = conn
+        raw_connection
+      end
+
+      def checkin(raw_connection)
+        @pool.checkin @map[raw_connection.object_id]
+      end
+    end
+  end
+end

data/lib/squirm/rails/functions.sql

@@ -0,0 +1,11 @@
+/*
+This is the functions.sql file used by Squirm-Rails. Define your Postgres stored
+procedures in this file and they will be loaded at the end of any calls to the
+db:schema:load Rake task.
+*/
+
+CREATE OR REPLACE FUNCTION hello_world() RETURNS TEXT AS $$
+  BEGIN
+    RETURN 'hello world!';
+  END;
+$$ LANGUAGE 'PLPGSQL'

data/lib/squirm/rails/generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators"
+
+module Squirm
+  class Install < ::Rails::Generators::Base
+    source_root File.dirname(__FILE__)
+    def install_functions
+      copy_file "functions.sql", "db/functions.sql"
+      copy_file "unit_test.rb", "test/unit/stored_procedures/hello_world_test.rb"
+    end
+  end
+end

data/lib/squirm/rails/squirm.rake

@@ -0,0 +1,14 @@
+namespace :db do
+  namespace :functions do
+    task :load => :environment do
+      functions = File.read(Rails.root.join("db", "functions.sql"))
+      ActiveRecord::Base.connection.execute functions
+    end
+  end
+
+  namespace :schema do
+    task :load do
+      Rake::Task["db:functions:load"].invoke
+    end
+  end
+end

data/lib/squirm/rails/unit_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module StoredProcedureTests
+
+  class HelloWorldTest < ActiveSupport::TestCase
+    def setup
+      @procedure = Squirm.procedure "hello_world"
+    end
+
+    test "hello_world should emit a greeting" do
+      assert_equal "hello world!", @procedure.call
+    end
+  end
+
+end

data/lib/squirm/rails/version.rb

@@ -0,0 +1,5 @@
+module Squirm
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/squirm_rails.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path("../lib/squirm/rails/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "squirm_rails"
+  s.version       = Squirm::Rails::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Norman Clarke"]
+  s.email         = ["norman@njclarke.com"]
+  s.homepage      = "http://github.com/bvision/squirm_rails"
+  s.summary       = %q{"Easily use and manage Postgres stored procedures with Active Record."}
+  s.description   = %q{"Squirm facilitates using Postgres stored procedures with Active Record."}
+  s.bindir        = "bin"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_development_dependency "minitest"
+  s.add_runtime_dependency "squirm", ">= 0.0.6"
+  s.add_runtime_dependency "activerecord", ">= 3.0.0"
+  s.add_runtime_dependency "railties"
+
+end

data/test/active_record_support_test.rb

@@ -0,0 +1,27 @@
+require File.expand_path("../helper", __FILE__)
+
+class ActiveRecordSupportTest < MiniTest::Unit::TestCase
+  test "#procedure should define an instance method that invokes a procuedure of the same name" do
+    model_class = Class.new(Person) do
+      procedure "hello_world"
+    end
+    assert model_class.public_instance_methods.include? :hello_world
+    assert_equal "hello world!", model_class.new.hello_world
+  end
+
+  test "#procedure should define class method that invokes a procuedure of the same name" do
+    model_class = Class.new(Person) do
+      procedure "hello_world"
+    end
+    assert model_class.public_methods.include? :hello_world
+    assert_equal "hello world!", model_class.hello_world
+  end
+
+  test "#procedure should pass instance variables matching procedure argument names" do
+    model_class = Class.new(Person) do
+      procedure "return_name_and_email"
+    end
+    person = model_class.new name: "foo", email: "bar"
+    assert_equal "foo bar", person.return_name_and_email
+  end
+end

data/test/generator_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path("../helper", __FILE__)
+
+class SquirmRailsGeneratorTest < Rails::Generators::TestCase
+
+  tests Squirm::Install
+  destination File.expand_path("../../tmp", __FILE__)
+
+  setup :prepare_destination
+
+  def teardown
+    FileUtils.rm_rf self.destination_root
+  end
+
+  test "should generate functions.sql" do
+    run_generator
+    assert_file "db/functions.sql"
+  end
+
+  test "should generate unit test" do
+    run_generator
+    assert_file "test/unit/stored_procedures/hello_world_test.rb"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,56 @@
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require "bundler/setup"
+require "minitest/unit"
+require 'minitest/autorun'
+
+require "active_record"
+require "rails"
+
+ActiveRecord::Base.establish_connection \
+  :adapter   => "postgresql",
+  :host      => "localhost",
+  :database  => "squirm_test",
+  :pool_size => 2
+
+# $VERBOSE = true
+
+require "squirm/rails"
+require "squirm/rails/generator"
+
+ActiveRecord::Base.extend Squirm::Rails::ActiveRecordSupport
+
+Squirm.connect pool: Squirm::Rails::ConnectionPool.new
+
+Squirm do
+  exec "DROP TABLE IF EXISTS people"
+  exec "CREATE TABLE people(id SERIAL, name VARCHAR(126), email VARCHAR(128))"
+  exec %q{
+    CREATE OR REPLACE FUNCTION hello_world() RETURNS TEXT AS $$
+      BEGIN
+        RETURN 'hello world!';
+      END;
+    $$ LANGUAGE 'PLPGSQL'
+  }
+  exec %q{
+    CREATE OR REPLACE FUNCTION return_name_and_email(_name text, _email text) RETURNS TEXT AS $$
+      BEGIN
+        RETURN _name || ' ' || _email;
+      END;
+    $$ LANGUAGE 'PLPGSQL'
+  }
+end
+
+class Module
+  def test(name, &block)
+    define_method("test_#{name.gsub(/[^a-z0-9']/i, "_")}".to_sym, &block)
+  end
+end
+
+class Person < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: squirm_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Norman Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70309450323300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70309450323300
+- !ruby/object:Gem::Dependency
+  name: squirm
+  requirement: &70309450322460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70309450322460
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70309450321680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70309450321680
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70309450337060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70309450337060
+description: ! '"Squirm facilitates using Postgres stored procedures with Active Record."'
+email:
+- norman@njclarke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/squirm/rails.rb
+- lib/squirm/rails/active_record_support.rb
+- lib/squirm/rails/connection_pool.rb
+- lib/squirm/rails/functions.sql
+- lib/squirm/rails/generator.rb
+- lib/squirm/rails/squirm.rake
+- lib/squirm/rails/unit_test.rb
+- lib/squirm/rails/version.rb
+- squirm_rails.gemspec
+- test/active_record_support_test.rb
+- test/generator_test.rb
+- test/helper.rb
+homepage: http://github.com/bvision/squirm_rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ! '"Easily use and manage Postgres stored procedures with Active Record."'
+test_files:
+- test/active_record_support_test.rb
+- test/generator_test.rb
+- test/helper.rb
+has_rdoc: