db_mod 0.0.5 → 0.0.6

data/lib/db_mod/statements/prepared.rb

@@ -46,7 +46,8 @@ module DbMod
       # Defines a module-specific +def_prepared+ function
       # for a module that has just had {DbMod} included.
       #
-      # @param mod [Module]
+      # @param mod [Module] module including {DbMod}
+      # @see DbMod.included
       def self.setup(mod)
         Prepared.define_def_prepared(mod)
         Prepared.define_prepared_statements(mod)
@@ -63,15 +64,17 @@ module DbMod
       # method with the same name.
       #
       # @param mod [Module] a module with {DbMod} included
+      # @raise ArgumentError if there is a problem parsing
+      #   method parameters from the SQL statement
       def self.define_def_prepared(mod)
-        mod.class.instance_eval do
+        class << mod
           define_method(:def_prepared) do |name, sql, &block|
             sql = sql.dup
             name = name.to_sym
 
             params = Parameters.parse_params! sql
             prepared_statements[name] = sql
-            Prepared.define_prepared_method(mod, name, params, &block)
+            Prepared.define_prepared_method(self, name, params, &block)
           end
         end
       end
@@ -82,8 +85,9 @@ module DbMod
       # module or any of its included modules.
       #
       # @param mod [Module] module that has {DbMod} included
+      # @see DbMod#db_connect
       def self.define_prepare_all_statements(mod)
-        mod.class.instance_eval do
+        class << mod
           define_method(:prepare_all_statements) do |conn|
             inherited_prepared_statements.each do |name, sql|
               conn.prepare(name.to_s, sql)
@@ -99,6 +103,7 @@ module DbMod
       # @param statements [Hash] named list of prepared statements
       # @param klass [Class,Module] ancestor (hopefully a DbMod module)
       #   to collect prepared statements from
+      # @see Prepared.define_inherited_prepared_statements
       def self.merge_statements(statements, klass)
         return unless klass.respond_to? :prepared_statements
         return if klass.prepared_statements.nil?
@@ -119,8 +124,9 @@ module DbMod
       # @param params [Fixnum,Array<Symbol>]
       #   expected parameter count, or a list of argument names.
       #   An empty array produces a no-argument method.
-      # @yield dsl block may be passed, which will be evaluated using a
-      #   {Configuration::MethodConfiguration} object as scope
+      # @param block [Proc] A dsl block may be passed, which will be evaluated
+      #   using a {Configuration::MethodConfiguration} object as scope
+      # @see Configurable.def_configurable
       def self.define_prepared_method(mod, name, params, &block)
         if params == []
           define_no_args_prepared_method(mod, name, &block)
@@ -137,12 +143,18 @@ module DbMod
       #   where the method will be defined
       # @param name [Symbol] name of the method to be defined
       #   and the prepared query to be called.
+      # @param block [Proc] see {Configuration::MethodConfiguration}
       # @yield dsl method configuration object may be passed
       def self.define_no_args_prepared_method(mod, name, &block)
         method = ->(*) { conn.exec_prepared(name.to_s) }
         Configuration.def_configurable mod, name, method, &block
       end
 
+      # Define a method on the given module with the given name
+      # and parameters that will call the prepared statement with
+      # the same name. Additional method configuration settings may
+      # be passed via a block.
+      #
       # @param mod [Module] {DbMod} enabled module
       #   where the method will be defined
       # @param name [Symbol] name of the method to be defined
@@ -150,6 +162,8 @@ module DbMod
       # @param params [Fixnum,Array<Symbol>]
       #   expected parameter count, or a list of argument names.
       #   An empty array produces a no-argument method.
+      # @param block [Proc] see {Configuration::MethodConfiguration}
+      # @yield dsl method configuration object may be passed
       def self.define_prepared_method_with_args(mod, name, params, &block)
         method = ->(*args) { conn.exec_prepared(name.to_s, args) }
         Configuration.def_configurable(mod, name, method, params, &block)
@@ -160,8 +174,9 @@ module DbMod
       # {DbMod#db_connect} is called.
       #
       # @param mod [Module]
+      # @see Prepared.define_inherited_prepared_statements
       def self.define_prepared_statements(mod)
-        mod.class.instance_eval do
+        class << mod
           define_method(:prepared_statements) do
             @prepared_statements ||= {}
           end
@@ -172,8 +187,12 @@ module DbMod
       # of named prepared statements declared on this module and all
       # included modules will be added to the connection when
       # {DbMod#db_connect} is called.
+      #
+      # @param mod [Module] where +inherited_prepared_statements+
+      #   should be defined
+      # @see Prepared.define_prepare_all_statements
       def self.define_inherited_prepared_statements(mod)
-        mod.class.instance_eval do
+        class << mod
           define_method(:inherited_prepared_statements) do
             inherited = {}
             ancestors.each do |klass|

data/lib/db_mod/statements/statement.rb

@@ -46,7 +46,8 @@ module DbMod
       # Defines a module-specific +def_statement+ function
       # for a module that has just had {DbMod} included.
       #
-      # @param mod [Module]
+      # @param mod [Module] module with {DbMod} included
+      # @see DbMod.included
       def self.setup(mod)
         Statement.define_def_statement(mod)
       end
@@ -59,14 +60,16 @@ module DbMod
       # arbitrary name.
       #
       # @param mod [Module] a module with {DbMod} included
+      # @raise ArgumentError if there is a problem parsing
+      #   method parameters from the SQL statement
       def self.define_def_statement(mod)
-        mod.class.instance_eval do
+        class << mod
           define_method(:def_statement) do |name, sql, &block|
             sql = sql.dup
             name = name.to_sym
 
             params = Parameters.parse_params! sql
-            Statement.define_statement_method(mod, name, params, sql, &block)
+            Statement.define_statement_method(self, name, params, sql, &block)
           end
         end
       end
@@ -80,8 +83,10 @@ module DbMod
       # @param params [Fixnum,Array<Symbol>]
       #   expected parameter count, or a list of argument names.
       #   An empty array produces a no-argument method.
-      # @yield dsl block may be passed, which will be evaluated using a
-      #   {Configuration::MethodConfiguration} object as scope
+      # @param sql [String] sql statement to execute
+      # @param block [Proc] A dsl block may be passed, which will be evaluated
+      #   using a {Configuration::MethodConfiguration} object as scope
+      # @see Configuration.def_configurable
       def self.define_statement_method(mod, name, params, sql, &block)
         if params == []
           Configuration.def_configurable(mod, name, ->(*) { query sql }, &block)

data/lib/db_mod/transaction.rb

@@ -32,6 +32,9 @@ module DbMod
 
     # Start the database transaction, or fail if
     # one is already open.
+    #
+    # @raise [Exceptions::AlreadyInTransaction]
+    # @see #transaction
     def start_transaction!
       fail DbMod::Exceptions::AlreadyInTransaction if @in_transaction
       @in_transaction = true
@@ -40,6 +43,8 @@ module DbMod
     end
 
     # End the database transaction
+    #
+    # @see #transaction
     def end_transaction!
       @in_transaction = false
     end

data/lib/db_mod/version.rb

@@ -1,5 +1,5 @@
 # Version information
 module DbMod
   # The current version of db_mod.
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

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

@@ -136,6 +136,67 @@ describe DbMod::Statements::Configuration::Defaults do
     end
   end
 
+  context 'procs as defaults' do
+    MINS_FOR = {
+      1 => 10,
+      2 => 20
+    }
+
+    subject do
+      Module.new do
+        include DbMod
+
+        def min_for(args)
+          MINS_FOR[args[:id]]
+        end
+
+        def_prepared(:a, %(
+          SELECT *
+            FROM foo
+           WHERE id = $1
+             AND x > $2
+        )) { defaults ->(args) { MINS_FOR[args.first] } }
+
+        def_prepared(:b, %(
+          SELECT *
+            FROM foo
+           WHERE id = $id
+             AND x > $min
+        )) { defaults min: ->(args) { min_for(args) } }
+      end.create db: 'testdb'
+    end
+
+    it 'works with indexed parameters' do
+      expect(@conn).to receive(:exec_prepared).with('a', [1, 10])
+      subject.a(1)
+
+      expect(@conn).to receive(:exec_prepared).with('a', [2, 20])
+      subject.a(2)
+
+      expect(@conn).to receive(:exec_prepared).with('a', [1, 11])
+      subject.a(1, 11)
+
+      expect(@conn).to receive(:exec_prepared).with('a', [3, nil])
+      subject.a(3)
+    end
+
+    it 'works with named parameters' do
+      expect(@conn).to receive(:exec_prepared).with('b', [1, 10])
+      subject.b(id: 1)
+
+      expect(@conn).to receive(:exec_prepared).with('b', [2, 20])
+      subject.b(id: 2)
+
+      expect(@conn).to receive(:exec_prepared).with('b', [1, 11])
+      subject.b(id: 1, min: 11)
+
+      expect(@conn).to receive(:exec_prepared).with('b', [3, nil])
+      subject.b(id: 3)
+
+      expect { subject.b }.to raise_exception ArgumentError
+    end
+  end
+
   context 'definition-time validation' do
     it 'must use named or indexed parameters appropriately' do
       expect do

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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe DbMod::Statements::Configuration::MethodConfiguration do
+  it 'can be constructed with a block' do
+    config = subject.class.new { single(:row!).as(:json) }
+
+    expect(config.to_hash).to eq(single: :row!, as: :json)
+  end
+
+  it 'can be constructed with named args' do
+    config = subject.class.new as: :json
+
+    expect(config.to_hash).to eq(as: :json)
+  end
+
+  it 'can be constructed from another config object' do
+    base = subject.class.new { single(:row!).as(:json) }
+    config = subject.class.new base
+
+    expect(config.to_hash).to eq(single: :row!, as: :json)
+  end
+
+  it 'can be constructed from a lambda proc' do
+    base = ->() { as(:csv) }
+    config = subject.class.new base
+
+    expect(config.to_hash).to eq(as: :csv)
+  end
+
+  it 'can be assembled from multiple sources' do
+    base = { as: :json, single: :row, defaults: [1, 2, 3] }
+    csv = ->() { as(:csv) }
+
+    config = subject.class.new(base, csv) { defaults 3, 4, 5 }
+    expect(config.to_hash).to eq(single: :row, as: :csv, defaults: [3, 4, 5])
+  end
+
+  it 'validates arguments' do
+    expect { subject.class.new 1, 2, 3 }.to raise_exception ArgumentError
+  end
+end

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

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'csv'
+
+describe DbMod::Statements::Configuration::Returning do
+  before do
+    @conn = instance_double 'PGconn'
+    allow(@conn).to receive(:prepare)
+    allow(PGconn).to receive(:connect).and_return(@conn)
+
+    allow(@conn).to receive(:exec_prepared).with('a').and_return([
+      { 'name' => 'cow', 'sound' => 'moo' },
+      { 'name' => 'dog', 'sound' => 'woof' }
+    ])
+  end
+
+  subject do
+    Module.new do
+      include DbMod
+
+      def_prepared(:a, 'SELECT name, sound FROM animals') do
+        returning do |animals|
+          animals.map do |animal|
+            "the #{animal['name']} goes #{animal['sound']}"
+          end.join ' and '
+        end
+      end
+
+      def send_email(*); end
+
+      def_prepared(:b, 'SELECT address FROM email WHERE id = $1') do
+        single(:value)
+
+        returning { |email| send_email(email, a) }
+      end
+
+      def_prepared(:c, 'SELECT * FROM bar') do
+        as(:csv)
+
+        returning { |json| send_email('som@body', json) }
+      end
+    end.create db: 'test'
+  end
+
+  it 'performs arbitrary result transformations' do
+    expect(subject.a).to eq(
+      'the cow goes moo and the dog goes woof'
+    )
+  end
+
+  it 'has access to module instance scope' do
+    allow(@conn).to receive(:exec_prepared).with('b', [1]).and_return([
+      { 'address' => 'ex@mple' }
+    ])
+    expect(subject).to receive(:send_email).with(
+      'ex@mple',
+      'the cow goes moo and the dog goes woof'
+    )
+    subject.b(1)
+  end
+
+  it 'works with as' do
+    allow(@conn).to receive(:exec_prepared).and_return([
+      { 'a' => '1', 'b' => '2' },
+      { 'a' => '3', 'b' => '4' }
+    ])
+    expect(subject).to receive(:send_email).with('som@body', "a,b\n1,2\n3,4\n")
+    subject.c
+  end
+end

data/spec/db_mod/statements/default_method_settings_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'json'
+require 'csv'
+
+describe DbMod::Statements::DefaultMethodSettings do
+  subject do
+    Module.new do
+      include DbMod
+
+      default_method_settings do
+        single(:row).as(:json).returning(&:inspect)
+      end
+
+      def_prepared(:a, 'SELECT * FROM a WHERE id = $1')
+      def_prepared(:b, 'SELECT * FROM b WHERE id = $1')
+      def_prepared(:c, 'SELECT * FROM c WHERE id = $1') { single(:column) }
+    end
+  end
+
+  before do
+    @conn = instance_double('PGconn')
+    allow(@conn).to receive(:prepare)
+    allow(PGconn).to receive(:connect).and_return(@conn)
+
+    allow(@conn).to receive(:exec_prepared) do |name, args|
+      [{ 'id' => args.first, name => (args.first * 2) }]
+    end
+  end
+
+  it 'applies settings to all defined methods' do
+    db = subject.create db: 'x'
+
+    expect(db.a('1')).to eq('"{\"id\":\"1\",\"a\":\"11\"}"')
+    expect(db.b('2')).to eq('"{\"id\":\"2\",\"b\":\"22\"}"')
+  end
+
+  it 'allows overrides to be provided for settings' do
+    db = subject.create db: 'x'
+
+    allow(@conn).to receive(:exec_prepared).and_return([
+      { 'x' => '1' },
+      { 'x' => '2' }
+    ])
+    expect(db.c('3')).to eq('"[\"1\",\"2\"]"')
+  end
+
+  it 'does not cascade to other modules' do
+    parent = subject
+    db = Module.new do
+      include parent
+
+      def_prepared(:d, 'SELECT * FROM d WHERE id = $1')
+      def_statement(:e, 'SELECT id FROM e WHERE x = $y') do
+        single(:value).returning { |id| a(id) }
+      end
+    end.create db: 'x'
+
+    expect(db.d('4')).to eq([{ 'id' => '4', 'd' => '44' }])
+
+    allow(@conn).to receive(:exec_params).and_return([{ 'id' => '5' }])
+    expect(db.e(y: 'y')).to eq('"{\"id\":\"5\",\"a\":\"55\"}"')
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
-require 'simplecov'
-SimpleCov.start
+# Send coverage report to codeclimate when a repo token is given
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start
+end
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_mod
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Doug Hammond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -25,7 +25,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -131,12 +201,14 @@ files:
 - lib/db_mod/statements/configuration/as/json.rb
 - lib/db_mod/statements/configuration/defaults.rb
 - lib/db_mod/statements/configuration/method_configuration.rb
+- lib/db_mod/statements/configuration/returning.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
 - lib/db_mod/statements/configuration/single/required_value.rb
 - lib/db_mod/statements/configuration/single/row.rb
 - lib/db_mod/statements/configuration/single/value.rb
+- lib/db_mod/statements/default_method_settings.rb
 - lib/db_mod/statements/parameters.rb
 - lib/db_mod/statements/prepared.rb
 - lib/db_mod/statements/statement.rb
@@ -147,7 +219,10 @@ files:
 - 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/method_configuration_spec.rb
+- spec/db_mod/statements/configuration/returning_spec.rb
 - spec/db_mod/statements/configuration/single_spec.rb
+- spec/db_mod/statements/default_method_settings_spec.rb
 - spec/db_mod/statements/prepared_spec.rb
 - spec/db_mod/statements/statement_spec.rb
 - spec/db_mod/transaction_spec.rb
@@ -183,7 +258,10 @@ test_files:
 - 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/method_configuration_spec.rb
+- spec/db_mod/statements/configuration/returning_spec.rb
 - spec/db_mod/statements/configuration/single_spec.rb
+- spec/db_mod/statements/default_method_settings_spec.rb
 - spec/db_mod/statements/prepared_spec.rb
 - spec/db_mod/statements/statement_spec.rb
 - spec/db_mod/transaction_spec.rb