activerecord-postgresql-cursors 2.0.0 → 3.0.0

data/.rubocop_todo.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-08-06 02:41:08 UTC using RuboCop version 1.65.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/activerecord-postgresql-cursors.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/activerecord-postgresql-cursors.rb'

data/FUNDING.yml

@@ -0,0 +1,2 @@
+github:
+  - dark-panda

data/Gemfile

@@ -1,21 +1,18 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-if RUBY_PLATFORM == "java"
-  gem "activerecord-jdbcpostgresql-adapter"
-else
-  gem "pg", '~> 0.21'
-end
-
-gem "rdoc"
-gem "rake"
-gem "minitest"
-gem "minitest-reporters"
-gem "guard-minitest"
-gem "simplecov"
-
-if File.exists?('Gemfile.local')
-  instance_eval File.read('Gemfile.local')
-end
+gem 'guard'
+gem 'guard-minitest'
+gem 'minitest'
+gem 'minitest-reporters'
+gem 'pg'
+gem 'rake'
+gem 'rubocop', require: false
+gem 'rubocop-minitest', require: false
+gem 'simplecov', require: false
+gem 'simplecov_json_formatter', require: false
 
+instance_eval File.read('Gemfile.local') if File.exist?('Gemfile.local')

data/Guardfile

@@ -1,17 +1,15 @@
+# frozen_string_literal: true
 
-guard 'minitest', :test_folders => 'test', :test_file_patterns => '*_tests.rb' do
-  watch(%r|^test/(.+)_tests\.rb|)
+guard 'minitest', test_folders: 'test', test_file_patterns: '*_tests.rb' do
+  watch(%r{^test/(.+)_tests\.rb})
 
-  watch(%r|^lib/(.*)([^/]+)\.rb|) do |m|
-    "test/cursor_tests.rb"
+  watch(%r{^lib/(.*)([^/]+)\.rb}) do |_m|
+    'test/cursor_tests.rb'
   end
 
-  watch(%r|^test/test_helper\.rb|) do
-    "test"
+  watch(%r{^test/test_helper\.rb}) do
+    'test'
   end
 end
 
-if File.exists?('Guardfile.local')
-  instance_eval File.read('Guardfile.local')
-end
-
+instance_eval File.read('Guardfile.local') if File.exist?('Guardfile.local')

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2018 J Smith <dark.panda@gmail.com>
+Copyright (c) 2008-2024 J Smith <dark.panda@gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -20,4 +20,3 @@ 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.rdoc → README.md}

@@ -1,4 +1,4 @@
-= ActiveRecord PostgreSQL Cursors
+# ActiveRecord PostgreSQL Cursors
 
 This extension allows you to loop through record sets using cursors in an
 Enumerable fashion. This allows you to cut down memory usage by only pulling
@@ -9,21 +9,23 @@ To use a cursor, just change the first parameter to an
 ActiveRecord::Base.find to :cursor instead of :first or :all or
 whatever or use the ActiveRecord::Base.cursor method directly.
 
-  MyModel.find(:cursor, :conditions => 'some_column = true').each do |r|
-    puts r.inspect
-  end
+```ruby
+MyModel.find(:cursor, :conditions => 'some_column = true').each do |r|
+  puts r.inspect
+end
 
-  MyModel.find(:cursor).collect { |r| r.foo / PI }.avg
+MyModel.find(:cursor).collect { |r| r.foo / PI }.avg
 
-  MyModel.cursor.each do |r|
-    puts r.inspect
-  end
+MyModel.cursor.each do |r|
+  puts r.inspect
+end
+```
 
 All ActiveRecord::Base.find options are available and should work as-is.
 As a bonus, the PostgreSQLCursor object returned includes Enumerable,
 so you can iterate to your heart's content.
 
-This extension should work with Rails 4.2+. For older versions of Rails, try
+This extension should work with Rails 6.1+. For older versions of Rails, try
 out older versions of the gem.
 
 At the moment, this is a non-scrollable cursor -- it will only fetch
@@ -51,7 +53,7 @@ created and the time it is executed. In these cases, it may be wise to wrap
 your use or cursors in your own transaction to ensure that changes made to
 the underlying data don't interfere with your cursor's visibility.
 
-== License
+## License
 
 This gem is licensed under an MIT-style license. See the +MIT-LICENSE+ file for
 details.

data/Rakefile

@@ -1,5 +1,4 @@
-
-# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'rubygems/package_task'
@@ -7,24 +6,24 @@ require 'rake/testtask'
 require 'rdoc/task'
 require 'bundler/gem_tasks'
 
-$:.push File.expand_path(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__), 'lib')
 
 version = ActiveRecord::PostgreSQLCursors::VERSION
 
 desc 'Test PostgreSQL extensions'
 Rake::TestTask.new(:test) do |t|
   t.libs << "#{File.dirname(__FILE__)}/test"
-  t.test_files = FileList['test/**/*_tests.rb']
+  t.test_files = FileList['test/**/*_test.rb']
   t.verbose = !!ENV['VERBOSE_TESTS']
   t.warning = !!ENV['WARNINGS']
 end
 
-task :default => :test
+task default: :test
 
 desc 'Build docs'
 Rake::RDocTask.new do |t|
   t.title = "ActiveRecord PostgreSQL Cursors #{version}"
-  t.main = 'README.rdoc'
+  t.main = 'README.md'
   t.rdoc_dir = 'doc'
   t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb')
 end

data/activerecord-postgresql-cursors.gemspec

@@ -1,26 +1,26 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-require File.expand_path('../lib/active_record/postgresql_cursors/version', __FILE__)
+require File.expand_path('lib/active_record/postgresql_cursors/version', __dir__)
 
 Gem::Specification.new do |s|
-  s.name = "activerecord-postgresql-cursors"
+  s.name = 'activerecord-postgresql-cursors'
   s.version = ActiveRecord::PostgreSQLCursors::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["J Smith"]
-  s.description = "Provides some support for PostgreSQL cursors in ActiveRecord."
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = '>= 3.0'
+  s.authors = ['J Smith']
+  s.description = 'Provides some support for PostgreSQL cursors in ActiveRecord.'
   s.summary = s.description
-  s.email = "dark.panda@gmail.com"
-  s.license = "MIT"
+  s.email = 'dark.panda@gmail.com'
+  s.license = 'MIT'
   s.extra_rdoc_files = [
-    "README.rdoc"
+    'README.md'
   ]
-  s.files = `git ls-files`.split($\)
+  s.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
-  s.homepage = "http://github.com/dark-panda/activerecord-postgresql-cursors"
-  s.require_paths = ["lib"]
+  s.homepage = 'http://github.com/dark-panda/activerecord-postgresql-cursors'
+  s.require_paths = ['lib']
 
-  s.add_dependency("activerecord", [">= 2.3"])
+  s.add_dependency('activerecord', ['>= 6.1'])
+  s.metadata['rubygems_mfa_required'] = 'true'
 end
-

data/lib/active_record/postgresql_cursors/cursors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecord
   module CursorExtensions
@@ -28,19 +29,14 @@ module ActiveRecord
       # ActiveRecord::Base#find_every method, except it returns a
       # PostgreSQLCursor object that can be used to loop through records.
       def find_cursor(cursor_name, options)
-        unless connection.is_a? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
-          raise CursorsNotSupported, "#{connection.class} doesn't support cursors"
-        end
+        raise CursorsNotSupported, "#{connection.class} doesn't support cursors" unless connection.is_a? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
 
         relation = merge(options.slice(:readonly, :references, :order, :limit, :joins, :group, :having, :offset, :select, :uniq))
         including = (relation.eager_load_values + relation.includes_values).uniq
 
         if including.present?
-          join_dependency = construct_join_dependency(joins_values)
-
-          aliases = join_dependency.aliases
-          join_relation = select(aliases.columns)
-          join_relation = apply_join_dependency(join_relation, join_dependency)
+          join_dependency = construct_join_dependency(joins_values, nil)
+          join_relation = apply_join_dependency
 
           ActiveRecord::PostgreSQLCursor.new(self, cursor_name, join_relation, join_dependency)
         else

data/lib/active_record/postgresql_cursors/version.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 
 module ActiveRecord
   module PostgreSQLCursors
-    VERSION = '2.0.0'.freeze
+    VERSION = '3.0.0'
   end
 end
-

data/lib/activerecord-postgresql-cursors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveRecord
   # Exception raised when database cursors aren't supported, which they
@@ -17,9 +18,7 @@ module ActiveRecord
       @relation = relation
       @join_dependency = join_dependency
 
-      @cursor_name = if cursor_name
-        @model.connection.quote_table_name(cursor_name.gsub(/"/, '\"'))
-      end
+      @cursor_name = (@model.connection.quote_table_name(cursor_name.gsub('"', '\"')) if cursor_name)
 
       @query = model.connection.unprepared_statement do
         relation.to_sql
@@ -34,38 +33,43 @@ module ActiveRecord
     # record as a parameter.
     def each
       @model.transaction do
-        begin
-          declare_cursor
-          if @join_dependency
-            rows = Array.new
-            last_id = nil
-
-            while row = fetch_forward
-              instantiated_row = @join_dependency.instantiate([row], @join_dependency.aliases).first
-
-              current_id = instantiated_row[@join_dependency.join_root.primary_key]
-              last_id ||= current_id
-              if last_id == current_id
-                rows << row
-                last_id = current_id
-              else
-                yield @join_dependency.instantiate(rows, @join_dependency.aliases).first
-                rows = [ row ]
-              end
+        declare_cursor
+
+        if @join_dependency
+          rows = []
+          last_id = nil
+
+          until (row = fetch_forward).empty?
+            instantiated_row = @join_dependency.instantiate(row, true).first
+            current_id = instantiated_row[@join_dependency.send(:join_root).primary_key]
+            last_id ||= current_id
+
+            if last_id == current_id
+              rows << row.first.values
               last_id = current_id
-            end
+            else
+              result_set = ActiveRecord::Result.new(row.columns, rows, row.column_types)
 
-            if !rows.empty?
-              yield @join_dependency.instantiate(rows, @join_dependency.aliases).first
-            end
-          else
-            while row = fetch_forward
-              yield @model.instantiate(row)
+              yield @join_dependency.instantiate(result_set, true).first
+
+              rows = [row.first.values]
             end
+
+            last_id = current_id
+          end
+
+          unless rows.empty?
+            result_set = ActiveRecord::Result.new(row.columns, rows, row.column_types)
+
+            yield @join_dependency.instantiate(result_set, true).first
+          end
+        else
+          until (row = fetch_forward).empty?
+            yield @model.instantiate(row.first)
           end
-        ensure
-          close_cursor
         end
+      ensure
+        close_cursor
       end
       nil
     end
@@ -76,15 +80,17 @@ module ActiveRecord
         @cursor_name ||= "cursor_#{(rand * 1_000_000).ceil}"
       end
 
-      def fetch_forward #:nodoc:
-        @relation.connection.select_all(%{FETCH FORWARD FROM #{cursor_name}}).first
+      def fetch_forward # :nodoc:
+        @relation.uncached do
+          @relation.connection.select_all(%{FETCH FORWARD FROM #{cursor_name}})
+        end
       end
 
-      def declare_cursor #:nodoc:
+      def declare_cursor # :nodoc:
         @model.connection.execute(%{DECLARE #{cursor_name} CURSOR FOR #{@query}})
       end
 
-      def close_cursor #:nodoc:
+      def close_cursor # :nodoc:
         @model.connection.execute(%{CLOSE #{cursor_name}})
       end
   end

data/sonar-project.properties

@@ -0,0 +1,17 @@
+sonar.projectKey=dark-panda_activerecord-postgresql-cursors
+sonar.organization=dark-panda
+
+# This is the name and version displayed in the SonarCloud UI.
+sonar.projectName=activerecord-postgresql-cursors
+sonar.projectVersion=1.0
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+sonar.sources=lib, test
+sonar.coverage.exclusions=test
+
+# Encoding of the source code. Default is default system encoding
+sonar.sourceEncoding=UTF-8
+
+# Additional reports
+sonar.ruby.rubocop.reportPaths=rubocop-report.json
+sonar.ruby.coverage.reportPaths=coverage/coverage.json

data/test/ci/github/database.yml

@@ -0,0 +1,10 @@
+
+arunit:
+  encoding: unicode
+  min_messages: WARNING
+  database: postgresql_cursors_unit_tests
+  adapter: postgresql
+  user: appuser
+  password: password
+  host: localhost
+  port: 5432

data/test/{cursor_tests.rb → cursor_test.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'test_helper'
 
@@ -7,7 +8,7 @@ class PostgreSQLCursorTests < Minitest::Test
   def test_cursor_scoped
     cursor = Foo.cursor(order: 'id')
 
-    assert(cursor.is_a?(ActiveRecord::PostgreSQLCursor))
+    assert_kind_of(ActiveRecord::PostgreSQLCursor, cursor)
 
     assert_equal(%w{ one two three four five }, cursor.collect(&:name))
   end
@@ -17,6 +18,7 @@ class PostgreSQLCursorTests < Minitest::Test
 
     cursor.each do |row|
       row.name = "#{row.name}_updated"
+
       assert(row.save)
     end
 
@@ -27,9 +29,9 @@ class PostgreSQLCursorTests < Minitest::Test
     cursor = Foo.cursor(order: 'id')
 
     cursor.each do |row|
-      assert(row.is_a?(Foo))
+      assert_kind_of(Foo, row)
       row.bars.each do |bar|
-        assert(bar.is_a?(Bar))
+        assert_kind_of(Bar, bar)
       end
     end
   end
@@ -38,9 +40,9 @@ class PostgreSQLCursorTests < Minitest::Test
     cursor = Foo.cursor(order: 'foos.id', include: :bars)
 
     cursor.each do |row|
-      assert(row.is_a?(Foo))
+      assert_kind_of(Foo, row)
       row.bars.each do |bar|
-        assert(bar.is_a?(Bar))
+        assert_kind_of(Bar, bar)
       end
     end
   end
@@ -50,36 +52,39 @@ class PostgreSQLCursorTests < Minitest::Test
 
     cursor.each do |row|
       bars_cursor = row.bars.cursor
-      assert(bars_cursor.is_a?(ActiveRecord::PostgreSQLCursor))
+
+      assert_kind_of(ActiveRecord::PostgreSQLCursor, bars_cursor)
 
       bars_cursor.each do |bar|
-        assert(bar.is_a?(Bar))
+        assert_kind_of(Bar, bar)
       end
     end
   end
 
   def test_as_relation
     cursor = Foo.order('foos.id').where('foos.id >= 3').cursor
+
     assert_equal(3, cursor.to_a.length)
 
     cursor.each do |row|
-      assert(row.is_a?(Foo))
+      assert_kind_of(Foo, row)
       assert_equal(2, row.bars.length)
       row.bars.each do |bar|
-        assert(bar.is_a?(Bar))
+        assert_kind_of(Bar, bar)
       end
     end
   end
 
   def test_as_relation_with_associations
     cursor = Foo.includes(:bars).order('foos.id').where('foos.id >= 3').cursor
+
     assert_equal(3, cursor.to_a.length)
 
     cursor.each do |row|
-      assert(row.is_a?(Foo))
+      assert_kind_of(Foo, row)
       assert_equal(2, row.bars.length)
       row.bars.each do |bar|
-        assert(bar.is_a?(Bar))
+        assert_kind_of(Bar, bar)
       end
     end
   end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'simplecov'
 
@@ -17,29 +18,15 @@ require 'minitest/reporters'
 require File.join(File.dirname(__FILE__), *%w{ .. lib activerecord-postgresql-cursors })
 
 ActiveRecord::Base.logger = Logger.new('debug.log') if ENV['ENABLE_LOGGER']
-ActiveRecord::Base.configurations = {
-  'arunit' => {}
-}
 
-%w{
-  database.yml
-  local_database.yml
-}.each do |file|
-  file = File.join('test', file)
+configurations = {}
 
-  next unless File.exist?(file)
-
-  configuration = YAML.safe_load(File.read(file))
-
-  if configuration['arunit']
-    ActiveRecord::Base.configurations['arunit'] = configuration['arunit']
-  end
-
-  if defined?(JRUBY_VERSION) && configuration['jdbc']
-    ActiveRecord::Base.configurations['arunit'].merge!(configuration['jdbc'])
-  end
-end
+file = File.join('test', 'database.yml')
+configuration = YAML.safe_load_file(file)
+configurations['arunit'] = configuration['arunit'] if configuration['arunit']
+configurations['arunit'].merge!(configuration['jdbc']) if defined?(JRUBY_VERSION) && configuration['jdbc']
 
+ActiveRecord::Base.configurations = configurations
 ActiveRecord::Base.establish_connection :arunit
 ARBC = ActiveRecord::Base.connection
 
@@ -48,9 +35,7 @@ puts "Testing against ActiveRecord #{Gem.loaded_specs['activerecord'].version}"
 
 postgresql_version = ARBC.select_rows('SELECT version()').flatten.to_s
 
-if postgresql_version
-  puts "PostgreSQL info from version(): #{postgresql_version}"
-end
+puts "PostgreSQL info from version(): #{postgresql_version}" if postgresql_version
 
 unless ARBC.data_source_exists?('foos')
   ActiveRecord::Migration.create_table(:foos) do |t|
@@ -86,10 +71,20 @@ module PostgreSQLCursorTestHelper
 
     %w{ one two three four five }.each_with_index do |name, i|
       foo = Foo.new(name: name)
-      foo.bar_ids = [ i + 1, i + 6 ]
+      foo.bar_ids = [i + 1, i + 6]
       foo.save
     end
   end
 end
 
-Minitest::Reporters.use!(MiniTest::Reporters::SpecReporter.new)
+Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
+
+if ENV['CI']
+  require 'simplecov_json_formatter'
+
+  SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
+elsif ENV.fetch('COVERAGE', nil) == 'console'
+  require_relative 'support/rspec_console'
+
+  SimpleCov.formatter = SecuricyApp::SimpleCov::Formatter::RSpecConsole
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgresql-cursors
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - J Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,40 +16,47 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '6.1'
 description: Provides some support for PostgreSQL cursors in ActiveRecord.
 email: dark.panda@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop-minitest.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- FUNDING.yml
 - Gemfile
 - Guardfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - activerecord-postgresql-cursors.gemspec
 - lib/active_record/postgresql_cursors/cursors.rb
 - lib/active_record/postgresql_cursors/version.rb
 - lib/activerecord-postgresql-cursors.rb
-- test/cursor_tests.rb
+- sonar-project.properties
+- test/ci/github/database.yml
+- test/cursor_test.rb
 - test/database.yml
 - test/test_helper.rb
 homepage: http://github.com/dark-panda/activerecord-postgresql-cursors
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -57,19 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Provides some support for PostgreSQL cursors in ActiveRecord.
-test_files:
-- test/cursor_tests.rb
-- test/database.yml
-- test/test_helper.rb
+test_files: []