simple-sql 0.5.26 → 0.5.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fab09e2181d6826802076b03cf71b0c742862ab1bf58e730403eee0eed1bb1c6
-  data.tar.gz: 4f64d6025f76fec82d72f83cc936072cb092fa51f5fa0ad4ea37da1e70b045a3
+  metadata.gz: 7490b50fc301d6e1a8c424e46a21f4a5cb97767ca2a99c7bdeed94b7c499a0d6
+  data.tar.gz: 3e1ec456a008d2abee6260b84beb1c17ca4b5934c1b934f00298ad6263b0f849
 SHA512:
-  metadata.gz: e8d383d973a2564e5e841e3820c24dc8aa9438c1ce3629f9508538e53c9775ef9ec16e8b7979933d1fed09bdc9389c71b2ce31122347f096f0e604bba2b20184
-  data.tar.gz: 8a8caf53d1e973c8d762e725e7a7f91ea2fc5295d092c024db4227bda1c92976b0600f1f62d80d1d98794b5f35dc0eea3639ef887dbb2506b1cfdf20b8d7a055
+  metadata.gz: 5c4ff2ac25d314393ff79a5f8ff3171508b05f30a99f37d1681a5b4af0fe3f07f247623321e235fc70de4d384d8e994935fc69eaf592c41b8459ceb0c875adf7
+  data.tar.gz: e59f00c7d6a3f00d1f4c2ca101985e8a01b453cc80b774f5f95b867eebea3e1dddf70a341fd4bf8904e497b19738d58e2a66d20a08372a138bf2302d918af1cb

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'byebug'
+gem 'pry-byebug'
 gem 'rubocop', '~> 0.57.2'
 
 # Specify your gem's dependencies in {gemname}.gemspec

data/Makefile

@@ -1,15 +1,15 @@
 tests: test4 test5 test6
 
 test4:
-	SIMPLE_SQL_ACTIVERECORD_SPECS="< 5" bundle
+	SIMPLE_SQL_ACTIVERECORD_SPECS="> 4,< 5" bundle
 	rspec
 
 test5:
-	SIMPLE_SQL_ACTIVERECORD_SPECS="< 6" bundle
+	SIMPLE_SQL_ACTIVERECORD_SPECS="> 5,< 6" bundle update activerecord
 	rspec
 
 test6:
-	SIMPLE_SQL_ACTIVERECORD_SPECS="< 7" bundle
+	SIMPLE_SQL_ACTIVERECORD_SPECS="> 6,< 7" bundle update activerecord
 	rspec
 
 stats:

data/VERSION

@@ -1 +1 @@
-0.5.26
+0.5.31

data/config/database.yml

@@ -2,7 +2,8 @@ defaults: &defaults
   adapter: postgresql
   encoding: utf8
   host: '127.0.0.1'
-  # username: postgres
+  username: admin
+  password: admin
   pool: 5
   timeout: 5000
 

data/lib/simple/sql.rb

@@ -12,6 +12,7 @@ require_relative "sql/config"
 require_relative "sql/logging"
 require_relative "sql/connection"
 require_relative "sql/table_print"
+require_relative "sql/monkey_patches"
 
 module Simple
   # The Simple::SQL module

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

@@ -84,6 +84,7 @@ class Simple::SQL::Connection::Scope
     dupe.instance_variable_set :@page, @page
     dupe.instance_variable_set :@order_by_fragment, @order_by_fragment
     dupe.instance_variable_set :@limit, @limit
+    dupe.instance_variable_set :@offset, @offset
     dupe
   end
 

data/lib/simple/sql/connection/scope/order.rb

@@ -3,8 +3,16 @@ class Simple::SQL::Connection::Scope
     duplicate.send(:order_by!, sql_fragment)
   end
 
-  def limit(count)
-    duplicate.send(:limit!, count)
+  def limit(limit)
+    raise ArgumentError, "limit must be >= 0" unless limit >= 0
+
+    duplicate.send(:limit!, limit)
+  end
+
+  def offset(offset)
+    raise ArgumentError, "offset must be >= 0" unless offset >= 0
+
+    duplicate.send(:offset!, offset)
   end
 
   private
@@ -21,10 +29,16 @@ class Simple::SQL::Connection::Scope
     self
   end
 
+  def offset!(offset)
+    @offset = offset
+    self
+  end
+
   # called from to_sql
   def apply_order_and_limit(sql)
     sql = "#{sql} ORDER BY #{@order_by_fragment}" if @order_by_fragment
     sql = "#{sql} LIMIT #{@limit}" if @limit
+    sql = "#{sql} OFFSET #{@offset}" if @offset
 
     sql
   end

data/lib/simple/sql/connection/scope/pagination.rb

@@ -3,6 +3,9 @@
 class Simple::SQL::Connection::Scope
   # Set pagination
   def paginate(per:, page:)
+    raise ArgumentError, "per must be > 0" unless per > 0
+    raise ArgumentError, "page must be > 0" unless page > 0
+
     duplicate.send(:paginate!, per: per, page: page)
   end
 
@@ -23,8 +26,7 @@ class Simple::SQL::Connection::Scope
   def apply_pagination(sql, pagination:)
     return sql unless pagination == :auto && @per && @page
 
-    raise ArgumentError, "per must be > 0" unless @per > 0
-    raise ArgumentError, "page must be > 0" unless @page > 0
+    raise ArgumentError, "You cannot mix 'paginate' and 'offset'/'limit'" if @offset || @limit
 
     "#{sql} LIMIT #{@per} OFFSET #{(@page - 1) * @per}"
   end

data/lib/simple/sql/connection/scope/search.rb

@@ -75,6 +75,12 @@ module Simple::SQL::Connection::Scope::Search
 
   # -- apply dynamic filters --------------------------------------------------
 
+  def empty_filter?(_key, value)
+    return true if value.nil?
+    return true if value.is_a?(Enumerable) && value.empty? # i.e. Hash, Array
+    false
+  end
+
   def apply_dynamic_filters(scope, filters, dynamic_column:)
     # we translate a condition of "foo => []" into a SQL fragment like this:
     #
@@ -82,7 +88,7 @@ module Simple::SQL::Connection::Scope::Search
     #
     # i.e. we check for non-existing columns and columns that exist but have a
     # value of null (i.e. column->'key' IS NULL).
-    empty_filters, filters = filters.partition { |_key, value| value.nil? || value.empty? }
+    empty_filters, filters = filters.partition { |key, value| empty_filter?(key, value) }
     empty_filters.each do |key, _|
       scope = scope.where("(NOT #{dynamic_column} ? '#{key}' OR #{dynamic_column} @> '#{::JSON.generate(key => nil)}'::jsonb)")
     end

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

@@ -1,152 +1,10 @@
+require "simple-immutable"
+
 module Simple
   module SQL
     module Helpers
+      # for backwards compatibility
+      Immutable = ::Simple::Immutable
     end
   end
 end
-
-class Simple::SQL::Helpers::Immutable
-  SELF = self
-
-  # turns an object, which can be a hash or array of hashes, arrays, and scalars
-  # into an object which you can use to access with dot methods.
-  def self.create(object, max_depth = 5)
-    case object
-    when Array
-      raise ArgumentError, "Object nested too deep (or inner loop?)" if max_depth < 0
-
-      object.map { |obj| create obj, max_depth - 1 }
-    when Hash
-      new(object)
-    else
-      object
-    end
-  end
-
-  private
-
-  def initialize(hsh)
-    @hsh = hsh
-  end
-
-  def method_missing(sym, *args, &block)
-    if args.empty? && !block
-      begin
-        value = @hsh.fetch(sym.to_sym) { @hsh.fetch(sym.to_s) }
-        return SELF.create(value)
-      rescue KeyError
-        # STDERR.puts "Missing attribute #{sym} for Immutable w/#{@hsh.inspect}"
-        nil
-      end
-    end
-
-    super
-  end
-
-  public
-
-  def respond_to_missing?(method_name, include_private = false)
-    @hsh.key?(method_name.to_sym) ||
-      @hsh.key?(method_name.to_s) ||
-      super
-  end
-
-  def inspect
-    "<Immutable: #{@hsh.inspect}>"
-  end
-
-  def respond_to?(sym)
-    super || @hsh.key?(sym.to_s) || @hsh.key?(sym.to_sym)
-  end
-
-  def ==(other)
-    @hsh == other
-  end
-end
-
-if $PROGRAM_NAME == __FILE__
-
-  # rubocop:disable Metrics/AbcSize
-
-  require "test-unit"
-
-  class Simple::SQL::Helpers::Immutable::TestCase < Test::Unit::TestCase
-    Immutable = ::Simple::SQL::Helpers::Immutable
-
-    def hsh
-      {
-        a: "a-value",
-        "b": "b-value",
-        "child": {
-          name: "childname",
-          grandchild: {
-            name: "grandchildname"
-          }
-        },
-        "children": [
-          "anna",
-          "arthur",
-          {
-            action: {
-              keep_your_mouth_shut: true
-            }
-          }
-        ]
-      }
-    end
-
-    def immutable
-      Immutable.create hsh
-    end
-
-    def test_hash_access
-      assert_equal "a-value", immutable.a
-      assert_equal "b-value", immutable.b
-    end
-
-    def test_comparison
-      immutable = Immutable.create hsh
-
-      assert_equal immutable, hsh
-      assert_not_equal({}, immutable)
-    end
-
-    def test_child_access
-      child = immutable.child
-      assert_kind_of(Immutable, child)
-      assert_equal "childname", immutable.child.name
-      assert_equal "grandchildname", immutable.child.grandchild.name
-    end
-
-    def test_array_access
-      assert_kind_of(Array, immutable.children)
-      assert_equal 3, immutable.children.length
-      assert_equal "anna", immutable.children[0]
-
-      assert_kind_of(Immutable, immutable.children[2])
-      assert_equal true, immutable.children[2].action.keep_your_mouth_shut
-    end
-
-    def test_base_class
-      assert_nothing_raised do
-        immutable.object_id
-      end
-    end
-
-    def test_missing_keys
-      assert_raise(NoMethodError) do
-        immutable.foo
-      end
-    end
-
-    def test_skip_when_args_or_block
-      assert_raise(NoMethodError) do
-        immutable.a(1, 2, 3)
-      end
-      assert_raise(NoMethodError) do
-        immutable.a { :dummy }
-      end
-    end
-  end
-
-end

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

@@ -1,4 +1,5 @@
 require_relative "./immutable"
+require "simple/immutable"
 
 module Simple::SQL::Helpers::RowConverter
   SELF = self
@@ -57,7 +58,7 @@ module Simple::SQL::Helpers::RowConverter
   end
 
   class ImmutableConverter < TypeConverter #:nodoc:
-    Immutable = ::Simple::SQL::Helpers::Immutable
+    Immutable = ::Simple::Immutable
 
     def build_row_in_target_type(hsh)
       Immutable.create hsh

data/lib/simple/sql/monkey_patches.rb

@@ -0,0 +1,49 @@
+# This file contains some monkey patches
+
+module Simple::SQL::MonkeyPatches
+  def self.warn(msg)
+    @@warned ||= {}
+    return if @@warned[msg]
+
+    @@warned[msg] = true
+
+    STDERR.puts "== monkeypatch warning: #{msg}"
+  end
+end
+
+case ActiveRecord.gem_version.to_s
+when /^4/
+  :nop
+when /^5.2/
+  unless defined?(ActiveRecord::ConnectionAdapters::ConnectionPool::Reaper)
+    raise "Make sure to properly require active-record first"
+  end
+
+  # Rails5 introduced a Reaper which starts a Thread which checks for unused connections. However,
+  # these threads are never cleaned up. This monkey patch disables the creation of those threads
+  # in the first place, consequently preventing leakage of threads.
+  #
+  # see see https://github.com/rails/rails/issues/33600 and related commits and issues.
+  class ActiveRecord::ConnectionAdapters::ConnectionPool::Reaper
+    def run
+      return unless frequency && frequency > 0
+      Simple::SQL::MonkeyPatches.warn "simple-sql disables reapers for all connection pools, see https://github.com/rails/rails/issues/33600"
+    end
+  end
+
+when /^6/
+  unless defined?(ActiveRecord::ConnectionAdapters::ConnectionPool::Reaper)
+    raise "Make sure to properly require active-record first"
+  end
+
+  # Rails6 fixes the issue w/reapers leaking threads; by properly cleaning up these threads
+  # (or  so one hopes after looking at connection_pool.rb). However, in the interest of simple-sql
+  # being more or less ActiveRecord agnostic we disable reaping here as well. (Also, that code
+  # looks pretty complex to me).
+  class ActiveRecord::ConnectionAdapters::ConnectionPool::Reaper
+    def run
+      return unless frequency && frequency > 0
+      Simple::SQL::MonkeyPatches.warn "simple-sql disables reapers for all connection pools, see https://github.com/rails/rails/issues/33600"
+    end
+  end
+end

data/simple-sql.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'expectation', '~> 1'
 
   gem.add_dependency 'digest-crc', '~> 0'
+  gem.add_dependency 'simple-immutable', '~> 1.0'
 
   # during tests we check the SIMPLE_SQL_ACTIVERECORD_SPECS environment setting.
   # Run make tests to run all tests

data/spec/simple/sql/each_spec.rb

@@ -61,7 +61,7 @@ describe "Simple::SQL.each" do
 
       expect(received.first.id).to eq(1)
       expect(received[1].dupe).to eq(2)
-      expect(received.map(&:class).uniq).to eq([Simple::SQL::Helpers::Immutable])
+      expect(received.map(&:class).uniq).to eq([Simple::Immutable])
     end
   end
 end

data/spec/simple/sql/search_spec.rb

@@ -20,10 +20,14 @@ describe "Simple::SQL.search" do
     scope.search(*args).all
   end
 
-  it "filters by one dynamic attribute and one match" do
+  it "filters by one dynamic attribute matching a String" do
     expect(search(even_str: "yes").map(&:id)).to contain_exactly(2,4,6,8,10)
   end
 
+  it "filters by one dynamic attribute matching an Integer" do
+    expect(search(user_id_squared: 4).map(&:id)).to contain_exactly(2)
+  end
+
   it "filters by one dynamic attribute and multiple matches" do
     expect(search(user_id_squared: [1, 3, 9]).map(&:id)).to contain_exactly(1,3)
   end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ end
 ENV["RACK_ENV"] = "test"
 ENV["RAILS_ENV"] = "test"
 
-require "byebug"
+require "pry-byebug"
 require "rspec"
 
 Dir.glob("./spec/support/**/*.rb").sort.each { |path| load path }

data/spec/support/001_database.rb

@@ -1,5 +1,9 @@
 # connect to the database and setup the schema
 require "active_record"
+
+# it is important to require simple-sql here to activate monkey patches
+require "simple-sql"
+
 require "yaml"
 abc = YAML.load_file("config/database.yml")
 ActiveRecord::Base.establish_connection(abc["test"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-sql
 version: !ruby/object:Gem::Version
-  version: 0.5.26
+  version: 0.5.31
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_array_parser
@@ -73,6 +73,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple-immutable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +226,7 @@ files:
 - lib/simple/sql/helpers/immutable.rb
 - lib/simple/sql/helpers/row_converter.rb
 - lib/simple/sql/logging.rb
+- lib/simple/sql/monkey_patches.rb
 - lib/simple/sql/result.rb
 - lib/simple/sql/result/association_loader.rb
 - lib/simple/sql/result/records.rb