squirm 0.0.5 → 0.0.6

data/.gitignore

@@ -11,6 +11,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage
 
 # YARD artifacts
 .yardoc

data/MIT-LICENSE

@@ -1,19 +1,18 @@
 Copyright (c) 2011 Norman Clarke and Business Vision S.A.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -42,23 +42,11 @@ Here's a quick demo of how you might use it:
     id = create.call(email: "johndoe@example.com", name: "John Doe")
 
 In and of itself, Squirm offers very little, but is meant to be a basic building
-block for other libraries, such as [Squirm
+block for other libraries, such as [Squirm Rails](https://github.com/bvision/squirm_rails),
+which adds stored procedure support to Active Record, or [Squirm
 Model](https://github.com/bvision/squirm_model), which supplies an Active Model
 compatible ORM based on stored procedures.
 
-## Using it with Rails
-
-Squirm comes with built-in support to make it work seamlessly with Active Record:
-
-    class Person < ActiveRecord::Base
-      procedure :say_hello
-    end
-    
-    p = Person.find(23)
-    p.say_hello
-
-More documentation coming soon.
-
 ## Author
 
 Norman Clarke <nclarke@bvision.com>

data/lib/squirm.rb

@@ -1,6 +1,7 @@
 require "squirm/core"
 require "squirm/pool"
 require "squirm/procedure"
+require "squirm/executor"
 
 =begin
 Squirm is an experimental anti-ORM for database-loving programmers who want to
@@ -68,8 +69,6 @@ end
 
 module Kernel
   def Squirm(&block)
-    Squirm.instance_eval(&block)
+    Squirm::Executor.eval(&block)
   end
-end
-
-require "squirm/rails" if defined? Rails
+end

data/lib/squirm/core.rb

@@ -6,6 +6,8 @@ module Squirm
   # The core DSL used by Squirm.
   module Core
 
+    attr :pool
+
     # Establishes a connection pool.
     # @param [Hash] options The connection options
     # @option options [String] :pool Use the given pool rather than Squirm's.
@@ -34,8 +36,7 @@ module Squirm
     # Executes the query and passes the result to the block you specify.
     def exec(*args, &block)
       if current = Thread.current[:squirm_connection]
-        conn = current.respond_to?(:raw_connection) ? current.raw_connection : current
-        conn.exec(*args, &block)
+        current.exec(*args, &block)
       else
         use {|conn| conn.exec(*args, &block)}
       end
@@ -45,12 +46,6 @@ module Squirm
       Procedure.load(*args)
     end
 
-    # Gets the connection pool.
-    # @return [Squirm::Pool] The connection pool.
-    def pool
-      @pool if defined? @pool
-    end
-
     # Performs a #use inside a transaction.
     def transaction
       use do |connection|
@@ -78,8 +73,7 @@ module Squirm
       conn_given = !!conn
       conn = conn_given ? conn : @pool.checkout
       begin
-        Thread.current[:squirm_connection] = conn
-        yield conn.respond_to?(:raw_connection) ? conn.raw_connection : conn
+        yield Thread.current[:squirm_connection] = conn
       ensure
         Thread.current[:squirm_connection] = nil
         @pool.checkin conn unless conn_given

data/lib/squirm/executor.rb

@@ -0,0 +1,17 @@
+module Squirm
+
+  # This class exists simply to provide a space in which to evaluate blocked
+  # passed to the Kernel.Squirm method.
+  class Executor
+    include Core
+
+    def self.eval(&block)
+      executor = new(Squirm.pool)
+      executor.instance_eval(&block)
+    end
+
+    def initialize(pool)
+      @pool = pool
+    end
+  end
+end

data/lib/squirm/procedure.rb

@@ -163,14 +163,14 @@ module Squirm
         @hash   = self.class.hashify(string)
       end
 
-      # Formats arguments used to call the stored procedure.
+      # Formats the arguments used to call the stored procedure.
       #
-      # When given a anything other than a hash, the arguments are returned
+      # When given anything other than a hash, the arguments are returned
       # without modification.
       #
-      # When given a hash, the return value is an array or arguments in the
+      # When given a hash, the return value is an array of arguments in the
       # order needed when calling the procedure. Missing values are replaced by
-      # nil.
+      # +nil+.
       #
       # @example
       #   # Assume a stored procedure with a definition like the following:

data/lib/squirm/version.rb

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

data/spec/core_spec.rb

@@ -10,6 +10,26 @@ describe Squirm do
     assert_equal '"table"', Squirm.quote_ident("table")
   end
 
+  it "should be a module" do
+    assert Squirm.is_a? Module
+  end
+
+  it "should evaluate a block inside an Executor instance" do
+    assert_raises RuntimeError do
+      Squirm do
+        raise "SUCCESS" if self.class == Squirm::Executor
+      end
+    end
+  end
+
+  describe "#procedure" do
+    it "should get a procedure instance and load it" do
+      Squirm.connect $squirm_test_connection
+      proc = Squirm.procedure "date", args: "abstime", schema: "pg_catalog"
+      assert proc.kind_of? Squirm::Procedure
+    end
+  end
+
   describe "#connect" do
     it "should use a pool if given" do
       pool = OpenStruct.new
@@ -53,6 +73,13 @@ describe Squirm do
       end
       assert_nil Thread.current[:squirm_connection]
     end
+
+    it "should use connection if given as an argument" do
+      mock = Object.new
+      Squirm.use(mock) do |conn|
+        assert mock == conn
+      end
+    end
   end
 
   describe "#exec" do

data/spec/procedure_spec.rb

@@ -93,24 +93,31 @@ describe Squirm::Procedure do
     end
 
     it "should load an overloaded functions if instance was initialized with :args" do
-      assert Squirm::Procedure.new("date", :args => "abstime", :schema => "pg_catalog").load
+      assert Squirm::Procedure.new("date", args: "abstime", schema: "pg_catalog").load
     end
 
   end
 
+  describe "#to_proc" do
+    before {Squirm.connect $squirm_test_connection}
+
+    it "should return a proc which calls the procedure" do
+      proc = Squirm::Procedure.new("date", args: "abstime", schema: "pg_catalog").load.to_proc
+      proc.call("Jan 1, 2011") {|result| assert_instance_of PGresult, result}
+    end
+  end
+
   describe "#call" do
 
     before {Squirm.connect $squirm_test_connection}
 
     it "should yield the result to a block if given" do
-      proc = Squirm::Procedure.new("date", :args => "abstime", :schema => "pg_catalog").load
-      proc.call("Jan 1, 2011") do |result|
-        assert_instance_of PGresult, result
-      end
+      proc = Squirm::Procedure.new("date", args: "abstime", schema: "pg_catalog").load
+      proc.call("Jan 1, 2011") {|result| assert_instance_of PGresult, result}
     end
 
     it "should return the value of a single-row result" do
-      proc = Squirm::Procedure.new("date", :args => "abstime", :schema => "pg_catalog").load
+      proc = Squirm::Procedure.new("date", args: "abstime", schema: "pg_catalog").load
       assert_equal "2011-01-01", proc.call("Jan 1, 2011")
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: squirm
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000 Z
+date: 2011-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70228168578720 !ruby/object:Gem::Requirement
+  requirement: &70292131700860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70228168578720
+  version_requirements: *70292131700860
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &70228168571760 !ruby/object:Gem::Requirement
+  requirement: &70292131700180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 0.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *70228168571760
+  version_requirements: *70292131700180
 description: ! '"Squirm is an anti-ORM for database-loving programmers"'
 email:
 - norman@njclarke.com
@@ -47,14 +47,10 @@ files:
 - Rakefile
 - lib/squirm.rb
 - lib/squirm/core.rb
+- lib/squirm/executor.rb
 - 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

data/lib/squirm/rails.rb

@@ -1,54 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,11 +0,0 @@
-/*
-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

@@ -1,10 +0,0 @@
-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