simple-sql 0.5.9 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 913129df1de6aab1bd350652782ea671e56f6a396dd8c6a2e7a8cebc972fab0e
-  data.tar.gz: 6aca39154c90cdfa0cb089c3358afa0f3c28ab261c837c99536c1fa39c3569f9
+  metadata.gz: 4f76ba8aa94983b8943cc358fbf15e9b66939b68b10e19d15336edc62fbc3c35
+  data.tar.gz: a5947013464489d1b5c9ce70dfc359c737fe59f7fffaac4cb8512ccb4c040653
 SHA512:
-  metadata.gz: '019f7c7b5c0b9364858b0af3a4cbf4ccffc69ae961610cbe5b552d4d646a2df0870c0e20d990dd77a36821a2c6395d05687464093b030cef7bbdc7115c9af3bb'
-  data.tar.gz: 4cf3ec7ff055cb174ca25043c46f714086483e73908d30daf723df062ed809c747500251555823eba676d6e4c747bdb80a2cb34c303e1ed904d4ef752e4f619d
+  metadata.gz: 38839f6a20c97edb9ee06a432db292c2cc620fdc0d01cb794a0caaf2e8bb542651f33850b9937b8e8e8ccd8139050a3c39a9d44dcef349ac8ccca9462025c26c
+  data.tar.gz: b8663891f150b32cf7f13550a231eb7fc962c95ec2dbcd9b1f1605bebe32319b6d9b7e7556b6d089ac3c18f698cf4c9e31e8a17417ba00d8beaa503e7ddc06e4

data/lib/simple/sql.rb

@@ -18,7 +18,7 @@ module Simple
     extend self
 
     extend Forwardable
-    delegate [:ask, :all, :each, :exec, :locked, :print, :transaction, :wait_for_notify, :estimate_cost] => :default_connection
+    delegate [:ask, :all, :each, :exec, :locked, :lock!, :print, :transaction, :wait_for_notify, :estimate_cost] => :default_connection
     delegate [:reflection] => :default_connection
     delegate [:duplicate] => :default_connection
     delegate [:insert] => :default_connection

data/lib/simple/sql/connection.rb

@@ -5,6 +5,7 @@ require_relative "connection/raw_connection"
 require_relative "connection/active_record_connection"
 
 require_relative "connection/base"
+require_relative "connection/lock"
 require_relative "connection/scope"
 require_relative "connection/reflection"
 require_relative "connection/insert"

data/lib/simple/sql/connection/base.rb

@@ -64,9 +64,8 @@ class Simple::SQL::Connection
   def print(sql, *args, into: nil)
     raise ArgumentError, "You cannot call Simple::SQL.print with into: #{into.inspect}" unless into.nil?
 
-    require "table_print"
     records = all sql, *args, into: Hash
-    tp records
+    Simple::SQL::Helpers::Printer.print records
     records
   end
 
@@ -91,19 +90,6 @@ class Simple::SQL::Connection
     explanation.first.dig "Plan", "Total Cost"
   end
 
-  # Executes a block, usually of db insert code, while holding an
-  # advisory lock.
-  #
-  # Examples:
-  #
-  # - <tt>Simple::SQL.locked(4711) { puts 'do work while locked' }
-  def locked(lock_id)
-    ask("SELECT pg_advisory_lock(#{lock_id})")
-    yield
-  ensure
-    ask("SELECT pg_advisory_unlock(#{lock_id})")
-  end
-
   private
 
   Result = ::Simple::SQL::Result

data/lib/simple/sql/connection/lock.rb

@@ -0,0 +1,86 @@
+require "digest/crc32"
+
+class Simple::SQL::Connection
+  # Executes a block, usually of db insert code, while holding an
+  # advisory lock.
+  #
+  # This code is deprecated; one should use lock! instead.
+  #
+  # Examples:
+  #
+  # - <tt>Simple::SQL.locked(4711) { puts 'do work while locked' }
+  def locked(lock_id)
+    lock! lock_id
+    yield
+  end
+
+  # Returns true if we are inside a transaction.
+  def in_transaction?
+    # This works because each SELECT is run either inside an existing transaction
+    # or inside a temporary, for this statement only, transaction which gets
+    # deleted after the statement - and which results in different txids.
+    txid1 = ask "select txid_current()"
+    txid2 = ask "select txid_current()"
+    txid1 == txid2
+  end
+
+  # Acquire an advisory lock.
+  #
+  # This uses the pg_*_xact_lock locks - that once acquired, cannot be released,
+  # but will release automatically once the transaction ends. This is safer than
+  # the pg_advisory_lock group of functions.
+  #
+  # For ease of use the key argument can also be a string - in which case we use
+  # a hash function to derive a key value. Usage example:
+  #
+  #     Simple::SQL.lock! "products", 12
+  #     Simple::SQL.ask "UPDATE products SET ... WHERE id=12"
+  #
+  # Note that passing in a timeout value sets timeouts for all lock! invocations
+  # in this transaction.
+  def lock!(key, key2 = nil, timeout: nil)
+    unless in_transaction?
+      raise "You cannot use lock! outside of a transaction"
+    end
+
+    if key.is_a?(String)
+      # calculate a 31 bit checksum < 0
+      key = Digest::CRC32.hexdigest(key).to_i(16) # get a 32-bit stable checksum
+      key &= ~0x80000000 # reset bit 31
+      key = -key # make it negative
+    end
+
+    if timeout
+      lock_w_timeout(key, key2, timeout)
+    else
+      lock_wo_timeout(key, key2)
+    end
+  end
+
+  private
+
+  def lock_wo_timeout(key, key2)
+    ask("SET LOCAL lock_timeout TO DEFAULT")
+
+    if key2
+      ask("SELECT pg_advisory_xact_lock($1, $2)", key, key2)
+    else
+      ask("SELECT pg_advisory_xact_lock($1)", key)
+    end
+  end
+
+  def lock_w_timeout(key, key2, timeout)
+    expect! timeout => 0..3600
+
+    timeout_string = "%dms" % (timeout * 1000)
+    ask("SET LOCAL lock_timeout = '#{timeout_string}'")
+
+    if key2
+      return if ask("SELECT pg_try_advisory_xact_lock($1, $2)", key, key2)
+    else
+      return if ask("SELECT pg_try_advisory_xact_lock($1)", key)
+    end
+
+    raise "Cannot get lock w/key #{key.inspect} and key2 #{key2.inspect} within #{timeout} seconds"
+  end
+end

data/lib/simple/sql/helpers.rb

@@ -1,6 +1,7 @@
 module ::Simple::SQL::Helpers
 end
 
+require_relative "helpers/printer.rb"
 require_relative "helpers/decoder.rb"
 require_relative "helpers/encoder.rb"
 require_relative "helpers/row_converter.rb"

data/lib/simple/sql/helpers/printer.rb

@@ -0,0 +1,56 @@
+# rubocop:disable Metrics/AbcSize
+
+# private
+module Simple::SQL::Helpers::Printer
+  extend self
+
+  def print(records)
+    if table_print?
+      tp records
+    else
+      lp records
+    end
+  end
+
+  def lp(records)
+    return if records.empty?
+
+    keys = records.first.keys
+    return if keys.empty?
+
+    rows = []
+    rows << keys
+
+    records.each do |rec|
+      rows << rec.values_at(*keys).map(&:to_s)
+    end
+
+    max_lengths = rows.inject([0] * keys.count) do |ary, row|
+      ary.zip(row.map(&:length)).map(&:max)
+    end
+
+    rows.each_with_index do |row, idx|
+      parts = row.zip(max_lengths).map do |value, max_length|
+        " %-#{max_length}s " % value
+      end
+
+      STDERR.puts parts.join("|")
+
+      if idx == 0
+        STDERR.puts parts.join("|").gsub(/[^|]/, "-")
+      end
+    end
+  end
+
+  def table_print?
+    load_table_print unless instance_variable_defined? :@table_print
+    @table_print
+  end
+
+  def load_table_print
+    require "table_print"
+    @table_print = true
+  rescue LoadError
+    @table_print = false
+  end
+end

data/lib/simple/sql/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module SQL
-    VERSION = "0.5.9"
+    VERSION = "0.5.10"
   end
 end

data/simple-sql.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'pg', '~> 0.20'
   gem.add_dependency 'expectation', '~> 1'
 
+  gem.add_dependency 'digest-crc', '~> 0'
+
   # optional gems (required by some of the parts)
 
   # development gems

data/spec/simple/sql/lock_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe "Simple::SQL.lock" do
+  it "raises an error if not inside a transaction" do
+    expect { Simple::SQL.lock!(1) }.to raise_error("You cannot use lock! outside of a transaction")
+  end
+
+  def number_of_locks
+    SQL.ask "SELECT count(*) FROM pg_locks WHERE locktype = 'advisory'"
+  end
+
+  it "locks with 2 ints" do
+    SQL.transaction do
+      expect { SQL.lock!(1, 2) }.to change { number_of_locks }.by(1)
+    end
+  end
+  
+  it "locks with 1 int" do
+    SQL.transaction do
+      expect { SQL.lock!(1) }.to change { number_of_locks }.by(1)
+    end
+  end
+
+  it "locks converts a string key into an int key" do
+    SQL.transaction do
+      expect { SQL.lock!("foo", 1) }.to change { number_of_locks }.by(1)
+      expect { SQL.lock!("foo") }.to change { number_of_locks }.by(1)
+    end
+  end
+  
+  it "accepts a timeout value" do
+    SQL.transaction do
+      SQL.lock!("foo", timeout: 0.000)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-sql
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_array_parser
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: digest-crc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,7 @@ files:
 - lib/simple/sql/connection/base.rb
 - lib/simple/sql/connection/duplicate.rb
 - lib/simple/sql/connection/insert.rb
+- lib/simple/sql/connection/lock.rb
 - lib/simple/sql/connection/raw_connection.rb
 - lib/simple/sql/connection/reflection.rb
 - lib/simple/sql/connection/scope.rb
@@ -221,6 +236,7 @@ files:
 - lib/simple/sql/helpers/decoder.rb
 - lib/simple/sql/helpers/encoder.rb
 - lib/simple/sql/helpers/immutable.rb
+- lib/simple/sql/helpers/printer.rb
 - lib/simple/sql/helpers/row_converter.rb
 - lib/simple/sql/logging.rb
 - lib/simple/sql/result.rb
@@ -245,6 +261,7 @@ files:
 - spec/simple/sql/duplicate_unique_spec.rb
 - spec/simple/sql/each_spec.rb
 - spec/simple/sql/insert_spec.rb
+- spec/simple/sql/lock_spec.rb
 - spec/simple/sql/logging_spec.rb
 - spec/simple/sql/reflection_spec.rb
 - spec/simple/sql/result_count_spec.rb
@@ -296,6 +313,7 @@ test_files:
 - spec/simple/sql/duplicate_unique_spec.rb
 - spec/simple/sql/each_spec.rb
 - spec/simple/sql/insert_spec.rb
+- spec/simple/sql/lock_spec.rb
 - spec/simple/sql/logging_spec.rb
 - spec/simple/sql/reflection_spec.rb
 - spec/simple/sql/result_count_spec.rb