squirm 0.0.4 → 0.0.5

data/README.md

@@ -48,11 +48,16 @@ compatible ORM based on stored procedures.
 
 ## Using it with Rails
 
-Squirm can use Active Record's connection pool rather than its own, all you have
-to do is pass in the pool to `Squirm.connect`:
+Squirm comes with built-in support to make it work seamlessly with Active Record:
 
-    # in config/initializers/squirm.rb
-    Squirm.connect pool: ActiveRecord::Base.connection_pool
+    class Person < ActiveRecord::Base
+      procedure :say_hello
+    end
+    
+    p = Person.find(23)
+    p.say_hello
+
+More documentation coming soon.
 
 ## Author
 

data/lib/squirm.rb

@@ -70,4 +70,6 @@ module Kernel
   def Squirm(&block)
     Squirm.instance_eval(&block)
   end
-end
+end
+
+require "squirm/rails" if defined? Rails

data/lib/squirm/rails.rb

@@ -0,0 +1,54 @@
+module Squirm
+
+  # 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 ActiveRecord
+    class Procedure < ::Squirm::Procedure
+      attr_accessor :connector
+
+      def call(*args, &block)
+        Squirm.use(connector.call) do
+          super
+        end
+      end
+    end
+
+    def self.included(model_class)
+      model_class.extend ClassMethods
+    end
+
+    module ClassMethods
+      def procedure(name, options = {}, &block)
+        self.class_eval(<<-EOM, __FILE__, __LINE__ + 1)
+          @@__squirm ||= {}
+          @@__squirm[:#{name}] = Squirm::ActiveRecord::Procedure.new("#{name}")
+          @@__squirm[:#{name}].connector = ->{connection}
+          @@__squirm[:#{name}].load
+          def #{options[:as] or name}(options = {})
+            options[:id] ||= id if @@__squirm[:#{name}].arguments.hash.has_key?(:id)
+            @@__squirm[:#{name}].call(options)
+          end
+        EOM
+      end
+    end
+  end
+
+  class Railtie < Rails::Railtie
+    initializer "squirm.setup" do
+      Squirm.connect pool: ::ActiveRecord::Base.connection_pool
+      ::ActiveRecord::Base.send :include, Squirm::ActiveRecord
+    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
+

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 "stored_procedures.sql", "db/stored_procedures.sql"
+      copy_file "unit_test.rb", "test/unit/stored_procedures_test.rb"
+    end
+  end
+end

data/lib/squirm/rails/squirm.rake

@@ -0,0 +1,8 @@
+namespace :db do
+  namespace :schema do
+    task :load do
+      functions = File.read(Rails.root.join("db", "stored_procedures.sql"))
+      ActiveRecord::Base.connection.execute functions
+    end
+  end
+end

data/lib/squirm/rails/stored_procedures.sql

@@ -0,0 +1,11 @@
+/*
+This is the stored_procedures.sql file used by Squirm. 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/unit_test.rb

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

data/lib/squirm/version.rb

@@ -1,3 +1,3 @@
 module Squirm
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: squirm
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-22 00:00:00.000000000 Z
+date: 2011-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70112879161580 !ruby/object:Gem::Requirement
+  requirement: &70228168578720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70112879161580
+  version_requirements: *70228168578720
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &70112879182280 !ruby/object:Gem::Requirement
+  requirement: &70228168571760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 0.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *70112879182280
+  version_requirements: *70228168571760
 description: ! '"Squirm is an anti-ORM for database-loving programmers"'
 email:
 - norman@njclarke.com
@@ -50,6 +50,11 @@ files:
 - lib/squirm/pool.rb
 - lib/squirm/procedure.rb
 - lib/squirm/procedure.sql
+- lib/squirm/rails.rb
+- lib/squirm/rails/generator.rb
+- lib/squirm/rails/squirm.rake
+- lib/squirm/rails/stored_procedures.sql
+- lib/squirm/rails/unit_test.rb
 - lib/squirm/version.rb
 - spec/core_spec.rb
 - spec/helper.rb