db_mod 0.0.4 → 0.0.5

data/spec/db_mod/statements/configuration/as_spec.rb

@@ -7,7 +7,7 @@ describe DbMod::Statements::Configuration::As do
       Module.new do
         include DbMod
 
-        def_statement(:foo, 'SELECT 1').as(:lolwut)
+        def_statement(:foo, 'SELECT 1') { as(:lolwut) }
       end
     end.to raise_exception ArgumentError
   end
@@ -17,7 +17,7 @@ describe DbMod::Statements::Configuration::As do
       Module.new do
         include DbMod
 
-        def_statement(:foo, 'SELECT 1').as(:json).as(:csv)
+        def_statement(:foo, 'SELECT 1') { as(:json).as(:csv) }
       end
     end.to raise_exception DbMod::Exceptions::BadMethodConfiguration
   end

data/spec/db_mod/statements/configuration/defaults_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+describe DbMod::Statements::Configuration::Defaults do
+  before do
+    @conn = instance_double 'PGconn'
+    allow(@conn).to receive(:prepare)
+    allow(PGconn).to receive(:connect).and_return(@conn)
+  end
+
+  context 'named arguments' do
+    subject do
+      Module.new do
+        include DbMod
+
+        def_statement(:a, %(
+          SELECT *
+            FROM foo
+           WHERE id = $id
+             AND x > $min
+        )) { defaults min: 10 }
+
+        def_prepared(:b, %(
+          INSERT INTO foo
+            (x, name)
+          VALUES
+            ($x, $name)
+        )) { single(:value!).defaults x: 100, name: 'dunno' }
+      end.create db: 'testdb'
+    end
+
+    it 'defines default method arguments' do
+      expect(@conn).to receive(:exec_params) do |_, params|
+        expect(params).to eq([1, 10])
+      end
+      subject.a id: 1
+
+      expect(@conn).to(
+        receive(:exec_prepared).with('b', [100, 'dunno']).and_return(
+          [{ 'id' => '1' }]
+        )
+      )
+      expect(subject.b).to eq('1')
+    end
+
+    it 'defers to provided values' do
+      expect(@conn).to receive(:exec_params) do |_, params|
+        expect(params).to eq([2, 20])
+      end
+      subject.a id: 2, min: 20
+
+      expect(@conn).to(
+        receive(:exec_prepared).with('b', [200, 'name']).and_return(
+          [{ 'id' => '7' }]
+        )
+      )
+      subject.b name: 'name', x: 200
+    end
+
+    it 'allows explicit nil' do
+      expect(@conn).to(
+        receive(:exec_prepared).with('b', [nil, 'dunno']).and_return(
+          [{ 'id' => '8' }]
+        )
+      )
+      subject.b x: nil
+    end
+
+    it 'requires parameters without defaults' do
+      expect(@conn).not_to receive(:exec_params)
+      expect { subject.a }.to raise_exception ArgumentError
+    end
+  end
+
+  context 'indexed arguments' do
+    subject do
+      Module.new do
+        include DbMod
+
+        def_statement(:a, %(
+          SELECT *
+            FROM foo
+           WHERE id = $1
+             AND x > $2
+        )) { defaults 10 }
+
+        def_prepared(:b, %(
+          INSERT INTO foo
+            (x, name)
+          VALUES
+            ($1, $2)
+          RETURNING id
+        )) { defaults(100, 'huh?').single(:row!).as(:json) }
+      end.create db: 'testdb'
+    end
+
+    it 'defines default method arguments' do
+      expect(@conn).to(
+        receive(:exec_prepared).with('b', [100, 'huh?']).and_return(
+          [{ 'id' => '2' }]
+        )
+      )
+      expect(subject.b).to eq('{"id":"2"}')
+    end
+
+    it 'fills in arguments from the right hand side' do
+      expect(@conn).to receive(:exec_params) do |_, params|
+        expect(params).to eq([4, 10])
+      end
+      subject.a 4
+
+      expect(@conn).to(
+        receive(:exec_prepared).with('b', [102, 'huh?']).and_return(
+          [{ 'id' => '5' }]
+        )
+      )
+      subject.b 102
+    end
+
+    it 'defers to provided values' do
+      expect(@conn).to receive(:exec_params) do |_, params|
+        expect(params).to eq([5, 11])
+      end
+      subject.a 5, 11
+
+      expect(@conn).to(
+        receive(:exec_prepared).with('b', [101, 'nom']).and_return(
+          [{ 'id' => '6' }]
+        )
+      )
+      subject.b 101, 'nom'
+    end
+
+    it 'asserts correct parameter count' do
+      expect { subject.a }.to raise_exception ArgumentError
+      expect { subject.b 1, 2, 3 }.to raise_exception ArgumentError
+    end
+  end
+
+  context 'definition-time validation' do
+    it 'must use named or indexed parameters appropriately' do
+      expect do
+        Module.new do
+          include DbMod
+
+          def_statement(:a, 'SELECT * FROM foo WHERE x = $1') do
+            defaults id: 1
+          end
+        end
+      end.to raise_exception ArgumentError
+
+      expect do
+        Module.new do
+          include DbMod
+
+          def_prepared(:a, 'SELECT * FROM foo WHERE id = $id') { defaults 1 }
+        end
+      end.to raise_exception ArgumentError
+    end
+
+    it 'asserts that mixed default types are not given' do
+      expect do
+        Module.new do
+          include DbMod
+
+          def_statement(:a, 'SELECT * FROM foo WHERE id = $id') do
+            defaults 1, id: 2
+          end
+        end
+      end.to raise_exception ArgumentError
+    end
+
+    it 'may not be specified more than once' do
+      expect do
+        Module.new do
+          include DbMod
+
+          def_statement(:a, 'SELECT * FROM foo WHERE x = $1') do
+            defaults 1
+            defaults 2
+          end
+        end
+      end.to raise_exception DbMod::Exceptions::BadMethodConfiguration
+    end
+
+    it 'disallows too many defaults' do
+      expect do
+        Module.new do
+          include DbMod
+
+          def_statement(:a, 'SELECT * FROM foo WHERE x=$1') { defaults 1, 2 }
+        end
+      end.to raise_exception ArgumentError
+
+      expect do
+        Module.new do
+          include DbMod
+
+          def_statement(:a, 'SELECT 1') { defaults 10 }
+        end
+      end.to raise_exception ArgumentError
+    end
+  end
+end

data/spec/db_mod/statements/configuration/single_spec.rb

@@ -5,13 +5,13 @@ describe DbMod::Statements::Configuration::Single do
     Module.new do
       include DbMod
 
-      def_statement(:v, 'SELECT a FROM foo').single(:value)
-      def_prepared(:v!, 'SELECT c FROM d WHERE e = $f').single(:value!)
+      def_statement(:v, 'SELECT a FROM foo') { single(:value) }
+      def_prepared(:v!, 'SELECT c FROM d WHERE e = $f') { single(:value!) }
 
-      def_prepared(:r, 'SELECT a, b FROM foo WHERE c = $1').single(:row)
-      def_statement(:r!, 'SELECT a, b FROM foo').single(:row!)
+      def_prepared(:r, 'SELECT a, b FROM foo WHERE c = $1') { single(:row) }
+      def_statement(:r!, 'SELECT a, b FROM foo') { single(:row!) }
 
-      def_statement(:c, 'SELECT a FROM foo WHERE c > $min').single(:column)
+      def_statement(:c, 'SELECT a FROM foo WHERE c > $min') { single(:column) }
     end.create(db: 'testdb')
   end
 
@@ -89,7 +89,7 @@ describe DbMod::Statements::Configuration::Single do
       Module.new do
         include DbMod
 
-        def_statement(:a, 'SELECT 1').single(:lolwut)
+        def_statement(:a, 'SELECT 1') { single(:lolwut) }
       end
     end.to raise_exception ArgumentError
   end
@@ -99,7 +99,7 @@ describe DbMod::Statements::Configuration::Single do
       Module.new do
         include DbMod
 
-        def_statement(:a, 'SELECT 1').single(:row).single(:value)
+        def_statement(:a, 'SELECT 1') { single(:row).single(:value) }
       end
     end.to raise_exception DbMod::Exceptions::BadMethodConfiguration
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_mod
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Doug Hammond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -129,7 +129,8 @@ files:
 - lib/db_mod/statements/configuration/as.rb
 - lib/db_mod/statements/configuration/as/csv.rb
 - lib/db_mod/statements/configuration/as/json.rb
-- lib/db_mod/statements/configuration/configurable_method.rb
+- lib/db_mod/statements/configuration/defaults.rb
+- lib/db_mod/statements/configuration/method_configuration.rb
 - lib/db_mod/statements/configuration/single.rb
 - lib/db_mod/statements/configuration/single/column.rb
 - lib/db_mod/statements/configuration/single/required_row.rb
@@ -145,6 +146,7 @@ files:
 - spec/db_mod/statements/configuration/as/csv_spec.rb
 - spec/db_mod/statements/configuration/as/json_spec.rb
 - spec/db_mod/statements/configuration/as_spec.rb
+- spec/db_mod/statements/configuration/defaults_spec.rb
 - spec/db_mod/statements/configuration/single_spec.rb
 - spec/db_mod/statements/prepared_spec.rb
 - spec/db_mod/statements/statement_spec.rb
@@ -180,6 +182,7 @@ test_files:
 - spec/db_mod/statements/configuration/as/csv_spec.rb
 - spec/db_mod/statements/configuration/as/json_spec.rb
 - spec/db_mod/statements/configuration/as_spec.rb
+- spec/db_mod/statements/configuration/defaults_spec.rb
 - spec/db_mod/statements/configuration/single_spec.rb
 - spec/db_mod/statements/prepared_spec.rb
 - spec/db_mod/statements/statement_spec.rb

data/lib/db_mod/statements/configuration/configurable_method.rb

@@ -1,78 +0,0 @@
-require_relative 'as'
-require_relative 'single'
-
-module DbMod
-  module Statements
-    module Configuration
-      # Encapsulates a method that has just been defined
-      # via the dsl exposed in {DbMod::Statements} so that
-      # it can be extended with additional processing such
-      # as result coercion.
-      #
-      # The pattern here is something similar to rack's middleware.
-      # Calling any of the extension methods below will replace
-      # the original method defined by +def_prepared+ or +def_statement+
-      # with a wrapper function that may perform processing on given
-      # arguments, pass them to the original function, then perform
-      # additional processing on the result.
-      class ConfigurableMethod
-        # Encapsulate a method that has been newly defined
-        # by a {DbMod} dsl function, for additional configuration.
-        #
-        # @param mod [Module] the {DbMod} enabled module
-        #   where the method was defined
-        # @param name [Symbol] the method name
-        def initialize(mod, name)
-          @mod = mod
-          @name = name
-          @already_called = {}
-        end
-
-        # Extend the method by converting results into a given
-        # format, using one of the coercion methods defined
-        # under {DbMod::Statements::Configuration::As}.
-        #
-        # @param type [:csv,:json] output format for the method
-        # @return [self]
-        def as(type)
-          called! :as
-
-          Configuration::As.extend_method(@mod, @name, type)
-
-          self
-        end
-
-        # Extend the method by extracting a singular part of
-        # the result set, for queries expected to only return
-        # one row, one column, or one row with a single value.
-        # See {DbMod::Statements::Configuration::Single} for
-        # more details.
-        #
-        # @param type [Symbol] see {SINGLE_TYPES}
-        # @return [self]
-        def single(type)
-          called! :single
-
-          Configuration::Single.extend_method(@mod, @name, type)
-
-          self
-        end
-
-        private
-
-        # Guard method which asserts that a configuration method
-        # may not be called more than once, or else raises
-        # {DbMod::Exceptions::BadMethodConfiguration}.
-        #
-        # @param method [Symbol] method being called
-        def called!(method)
-          if @already_called[method]
-            fail Exceptions::BadMethodConfiguration, "#{method} already called"
-          end
-
-          @already_called[method] = true
-        end
-      end
-    end
-  end
-end