activerecord-refined 0.9.0 → 0.10.0

data/.rubocop.yml

@@ -1,393 +0,0 @@
-plugins:
-  - rubocop-minitest
-  - rubocop-packaging
-  - rubocop-performance
-  - rubocop-rails
-  - rubocop-md
-
-AllCops:
-  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
-  # to ignore them, so only the ones explicitly set in this file are enabled.
-  DisabledByDefault: true
-  SuggestExtensions: false
-  # Inferring from the gemspec would stumble over 4.1.0.dev, so say it plainly.
-  TargetRubyVersion: 4.1
-  Exclude:
-    - "**/tmp/**/*"
-    - "**/vendor/**/*"
-    - "**/node_modules/**/*"
-    - "pkg/**/*"
-    # A site rather than the library, and partly vendored from wasmify-rails.
-    - "sandbox/**/*"
-
-Performance:
-  Exclude:
-    - '**/test/**/*'
-
-Rails/IndexBy:
-  Enabled: true
-
-Rails/IndexWith:
-  Enabled: true
-
-# Prefer &&/|| over and/or.
-Style/AndOr:
-  Enabled: true
-
-Layout/ClosingHeredocIndentation:
-  Enabled: true
-
-Layout/ClosingParenthesisIndentation:
-  Enabled: true
-
-# Align comments with method definitions.
-Layout/CommentIndentation:
-  Enabled: true
-
-Layout/DefEndAlignment:
-  Enabled: true
-
-Layout/ElseAlignment:
-  Enabled: true
-
-# Align `end` with the matching keyword or starting expression except for
-# assignments, where it should be aligned with the LHS.
-Layout/EndAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: variable
-  AutoCorrect: true
-
-Layout/EndOfLine:
-  Enabled: true
-
-Layout/EmptyLineAfterMagicComment:
-  Enabled: true
-
-Layout/EmptyLinesAroundAccessModifier:
-  Enabled: true
-  EnforcedStyle: only_before
-
-Layout/EmptyLinesAroundBlockBody:
-  Enabled: true
-
-# In a regular class definition, no empty lines around the body.
-Layout/EmptyLinesAroundClassBody:
-  Enabled: true
-
-# In a regular method definition, no empty lines around the body.
-Layout/EmptyLinesAroundMethodBody:
-  Enabled: true
-
-# In a regular module definition, no empty lines around the body.
-Layout/EmptyLinesAroundModuleBody:
-  Enabled: true
-
-# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
-Style/HashSyntax:
-  Enabled: true
-  EnforcedShorthandSyntax: either
-
-# Method definitions after `private` or `protected` isolated calls need one
-# extra level of indentation.
-Layout/IndentationConsistency:
-  Enabled: true
-  EnforcedStyle: indented_internal_methods
-  Exclude:
-    - '**/*.md'
-
-# Two spaces, no tabs (for indentation).
-Layout/IndentationWidth:
-  Enabled: true
-
-Layout/LeadingCommentSpace:
-  Enabled: true
-
-Layout/SpaceAfterColon:
-  Enabled: true
-
-Layout/SpaceAfterComma:
-  Enabled: true
-
-Layout/SpaceAfterSemicolon:
-  Enabled: true
-
-Layout/SpaceAroundEqualsInParameterDefault:
-  Enabled: true
-
-Layout/SpaceAroundKeyword:
-  Enabled: true
-
-Layout/SpaceAroundOperators:
-  Enabled: true
-
-Layout/SpaceBeforeComma:
-  Enabled: true
-
-Layout/SpaceBeforeComment:
-  Enabled: true
-
-Layout/SpaceBeforeFirstArg:
-  Enabled: true
-
-Style/DefWithParentheses:
-  Enabled: true
-
-# Defining a method with parameters needs parentheses.
-Style/MethodDefParentheses:
-  Enabled: true
-
-Style/ExplicitBlockArgument:
-  Enabled: true
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  EnforcedStyle: always
-  Exclude:
-    - '**/*.md'
-
-Style/MutableConstant:
-  Enabled: true
-  EnforcedStyle: literals
-  Exclude:
-    - '**/*.md'
-
-Style/MapToHash:
-  Enabled: true
-
-Style/RedundantFreeze:
-  Enabled: true
-
-# Use `foo {}` not `foo{}`.
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-
-# Use `foo { bar }` not `foo {bar}`.
-Layout/SpaceInsideBlockBraces:
-  Enabled: true
-  EnforcedStyleForEmptyBraces: space
-
-# Use `{ a: 1 }` not `{a:1}`.
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-
-Layout/SpaceInsideParens:
-  Enabled: true
-
-# Check quotes usage according to lint rule below.
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-# Detect hard tabs, no hard tabs.
-Layout/IndentationStyle:
-  Enabled: true
-
-# Empty lines should not have any spaces.
-Layout/TrailingEmptyLines:
-  Enabled: true
-
-# No trailing whitespace.
-Layout/TrailingWhitespace:
-  Enabled: true
-
-# Use quotes for string literals when they are enough.
-Style/RedundantPercentQ:
-  Enabled: true
-
-Lint/NestedMethodDefinition:
-  Enabled: true
-
-Lint/AmbiguousOperator:
-  Enabled: true
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: true
-
-Lint/Debugger:
-  Enabled: true
-  DebuggerRequires:
-    - debug
-
-Lint/DuplicateRequire:
-  Enabled: true
-
-Lint/DuplicateMagicComment:
-  Enabled: true
-
-Lint/DuplicateMethods:
-  Enabled: true
-
-Lint/ErbNewArguments:
-  Enabled: true
-
-Lint/EnsureReturn:
-  Enabled: true
-
-Lint/MissingCopEnableDirective:
-  Enabled: true
-
-# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
-Lint/RequireParentheses:
-  Enabled: true
-
-Lint/RedundantCopDisableDirective:
-  Enabled: true
-
-Lint/RedundantCopEnableDirective:
-  Enabled: true
-
-Lint/RedundantRequireStatement:
-  Enabled: true
-
-Lint/RedundantStringCoercion:
-  Enabled: true
-
-Lint/RedundantSafeNavigation:
-  Enabled: true
-
-Lint/UriEscapeUnescape:
-  Enabled: true
-
-Lint/UselessAssignment:
-  Enabled: true
-
-Lint/DeprecatedClassMethods:
-  Enabled: true
-
-Lint/InterpolationCheck:
-  Enabled: true
-  Exclude:
-    - '**/test/**/*'
-
-Lint/SafeNavigationChain:
-  Enabled: true
-
-Style/EvalWithLocation:
-  Enabled: true
-  Exclude:
-    - '**/test/**/*'
-
-Style/ParenthesesAroundCondition:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/RedundantBegin:
-  Enabled: true
-
-Style/RedundantReturn:
-  Enabled: true
-  AllowMultipleReturnValues: true
-
-Style/RedundantRegexpEscape:
-  Enabled: true
-
-Style/Semicolon:
-  Enabled: true
-  AllowAsExpressionSeparator: true
-
-# Prefer Foo.method over Foo::method
-Style/ColonMethodCall:
-  Enabled: true
-
-Style/TrivialAccessors:
-  Enabled: true
-
-# Prefer a = b || c over a = b ? b : c
-Style/RedundantCondition:
-  Enabled: true
-
-Style/RedundantDoubleSplatHashBraces:
-  Enabled: true
-
-Style/OpenStructUse:
-  Enabled: true
-
-Style/ArrayIntersect:
-  Enabled: true
-
-Style/KeywordArgumentsMerging:
-  Enabled: true
-
-Performance/BindCall:
-  Enabled: true
-
-Performance/FlatMap:
-  Enabled: true
-
-Performance/MapCompact:
-  Enabled: true
-
-# Off, unlike Rails: select {}.map {} here is almost always Active Record's
-# select -- the query DSL -- and filter_map would break it, which the cop
-# cannot tell from Enumerable's.
-Performance/SelectMap:
-  Enabled: false
-
-Performance/RedundantMerge:
-  Enabled: true
-
-Performance/StartWith:
-  Enabled: true
-
-Performance/EndWith:
-  Enabled: true
-
-Performance/RegexpMatch:
-  Enabled: true
-
-Performance/ReverseEach:
-  Enabled: true
-
-Performance/StringReplacement:
-  Enabled: true
-
-Performance/DeletePrefix:
-  Enabled: true
-
-Performance/DeleteSuffix:
-  Enabled: true
-
-Performance/InefficientHashSearch:
-  Enabled: true
-
-Performance/ConstantRegexp:
-  Enabled: true
-
-Performance/RedundantStringChars:
-  Enabled: true
-
-Performance/StringInclude:
-  Enabled: true
-
-Minitest/AssertNil:
-  Enabled: true
-
-Minitest/AssertRaisesWithRegexpArgument:
-  Enabled: true
-
-Minitest/AssertWithExpectedArgument:
-  Enabled: true
-
-Minitest/LiteralAsActualArgument:
-  Enabled: true
-
-Minitest/NonExecutableTestMethod:
-  Enabled: true
-
-Minitest/SkipEnsure:
-  Enabled: true
-
-Minitest/UnreachableAssertion:
-  Enabled: true
-
-Markdown:
-  # Off, unlike Rails: README abbreviates a snippet to its shape --
-  # with_recursive(tree: [...]) -- which is not Ruby and means not to be.
-  WarnInvalid: false
-  # Whether to lint codeblocks without code attributes
-  Autodetect: false

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in activerecord-refined.gemspec
-gemspec
-
-# Only ADAPTER=postgresql and ADAPTER=mysql2 need these, and building them
-# needs the client libraries installed.  `rake test` runs on SQLite, so a
-# checkout without them is still usable: bundle config set --local without db
-group :db do
-  gem "mysql2"
-  gem "pg"
-end

data/Rakefile

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "socket"
-
-ADAPTERS = %w[sqlite3 postgresql mysql2].freeze
-
-# The devcontainer serves Oracle's MySQL beside MariaDB, on 3307.  A
-# container from before it existed serves nothing there, and test:all says
-# so rather than failing or keeping quiet.
-def mysql8_reachable?
-  Socket.tcp("127.0.0.1", 3307, connect_timeout: 1) { true }
-rescue SystemCallError
-  false
-end
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList["test/test_*.rb"]
-end
-
-namespace :test do
-  ADAPTERS.each do |adapter|
-    desc "Run the tests against #{adapter}"
-    task adapter do
-      puts "==== #{adapter} ===="
-      ENV["ADAPTER"] = adapter
-      ENV.delete("DB_PORT")
-      Rake::Task[:test].reenable
-      Rake::Task[:test].invoke
-    end
-  end
-
-  desc "Run the tests against MySQL, which the devcontainer serves on 3307"
-  task :mysql8 do
-    puts "==== mysql2 (MySQL, port 3307) ===="
-    ENV["ADAPTER"] = "mysql2"
-    ENV["DB_PORT"] = "3307"
-    Rake::Task[:test].reenable
-    Rake::Task[:test].invoke
-  end
-
-  desc "Run the tests against every adapter in turn"
-  task all: ADAPTERS do
-    if mysql8_reachable?
-      Rake::Task["test:mysql8"].invoke
-    else
-      puts "MySQL is not listening on 3307; skipped"
-    end
-  end
-end
-
-task default: :test

data/benchmark/query_building.rb

@@ -1,129 +0,0 @@
-# frozen_string_literal: true
-
-# Compares the cost of building the same queries through this gem's block
-# DSL and through Active Record's other argument styles: hash conditions,
-# string conditions, raw Arel, and relation and/or chains.  Only query
-# construction (through to_sql) is measured; every style produces the same
-# SQL, which the script prints first as a sanity check.
-#
-# The profiling gems are development dependencies, so:
-#
-#   bundle exec ruby benchmark/query_building.rb
-
-require "benchmark/ips"
-require "memory_profiler"
-require "active_record"
-require "activerecord-refined"
-
-ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
-ActiveRecord::Schema.verbose = false
-ActiveRecord::Schema.define do
-  create_table(:users) { |t| t.string :name; t.integer :age }
-end
-
-class User < ActiveRecord::Base; end
-
-T = User.arel_table
-
-# Each variant must generate equivalent SQL; sanity-print once.
-VARIANTS = {
-  "simple equality" => {
-    "hash"   => -> { User.where(name: "alice").to_sql },
-    "string" => -> { User.where("name = ?", "alice").to_sql },
-    "arel"   => -> { User.where(T[:name].eq("alice")).to_sql },
-    "block"  => -> { User.where { :name == "alice" }.to_sql },
-  },
-  "range (BETWEEN)" => {
-    "hash"   => -> { User.where(age: 20..40).to_sql },
-    "arel"   => -> { User.where(T[:age].between(20..40)).to_sql },
-    "block"  => -> { User.where { :age.in?(20..40) }.to_sql },
-  },
-  "LIKE" => {
-    "string" => -> { User.where("name LIKE ?", "ma%").to_sql },
-    "arel"   => -> { User.where(T[:name].matches("ma%", nil, true)).to_sql },
-    "block"  => -> { User.where { :name.like?("al%") }.to_sql },
-  },
-  "compound AND/OR" => {
-    "string"   => -> { User.where("age >= ? AND (name = ? OR name = ?)", 18, "alice", "bob").to_sql },
-    "arel"     => -> { User.where(T[:age].gteq(18).and(T[:name].eq("alice").or(T[:name].eq("bob")))).to_sql },
-    "relation" => -> { User.where(age: 18..).and(User.where(name: "alice").or(User.where(name: "bob"))).to_sql },
-    "block"    => -> { User.where { (:age >= 18) & ((:name == "alice") | (:name == "bob")) }.to_sql },
-  },
-}.freeze
-
-puts "=== generated SQL (sanity) ==="
-VARIANTS.each do |group, variants|
-  puts "--- #{group} ---"
-  variants.each { |name, thunk| puts "  #{name.ljust(8)} #{thunk.call}" }
-end
-
-puts
-puts "=== speed (queries built per second) ==="
-VARIANTS.each do |group, variants|
-  puts "--- #{group} ---"
-  Benchmark.ips do |x|
-    x.config(warmup: 0.5, time: 2)
-    variants.each { |name, thunk| x.report(name, &thunk) }
-    x.compare!
-  end
-end
-
-puts
-puts "=== memory (per single call) ==="
-fmt = "%-18s %-9s %12s %12s"
-puts format(fmt, "group", "variant", "allocated B", "objects")
-VARIANTS.each do |group, variants|
-  variants.each do |name, thunk|
-    thunk.call # warm caches (schema, statement caches) outside the report
-    report = MemoryProfiler.report { thunk.call }
-    puts format(fmt, group, name, report.total_allocated_memsize, report.total_allocated)
-  end
-end
-
-puts
-puts "=== Proc#refined ISeq copy (memory) ==="
-require "objspace"
-
-# Proc#refined runs the block under the refinements by deep-copying its
-# instruction sequence, nested blocks included.  The copy is made lazily on
-# the refined proc's first call and memoized per source iseq and refinement
-# list for the life of the VM, so it is paid once per block call site, not
-# per query.
-iseq_count = -> {
-  counts = ObjectSpace.count_imemo_objects
-  counts[:imemo_iseq] || counts[:iseq]
-}
-context = ActiveRecord::Refined::BlockContext.new(User)
-syntax = ActiveRecord::Refined::BlockSyntax
-
-{
-  "simple equality" => proc { :name == "alice" },
-  "compound AND/OR" => proc { (:age >= 18) & ((:name == "alice") | (:name == "bob")) },
-}.each do |label, blk|
-  refined = blk.refined(syntax)
-  context.instance_exec(&refined) # the copy is made here, on the first call
-  original = ObjectSpace.memsize_of(RubyVM::InstructionSequence.of(blk))
-  copy = ObjectSpace.memsize_of(RubyVM::InstructionSequence.of(refined))
-  puts "#{label}: original iseq #{original} B, refined copy #{copy} B"
-end
-
-make_proc = -> { proc { :age > 20 } }
-context.instance_exec(&make_proc.call.refined(syntax))
-before = iseq_count.call
-1000.times { context.instance_exec(&make_proc.call.refined(syntax)) }
-puts "1000 more calls from the same call site copied #{iseq_count.call - before} iseqs"
-
-puts
-puts "=== where the block path spends its time ==="
-block = proc { :name == "alice" }
-refined_block = block.refined(ActiveRecord::Refined::BlockSyntax)
-context = ActiveRecord::Refined::BlockContext.new(User)
-Benchmark.ips do |x|
-  x.config(warmup: 0.5, time: 2)
-  x.report("Proc#refined alone") { block.refined(ActiveRecord::Refined::BlockSyntax) }
-  x.report("instance_exec of pre-refined proc") { context.instance_exec(&refined_block) }
-  x.report("refined + instance_exec") {
-    ActiveRecord::Refined::BlockContext.new(User).instance_exec(&block.refined(ActiveRecord::Refined::BlockSyntax))
-  }
-  x.compare!
-end