auto_preload 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b400e79944285da53bdd3246948248bdef10323e536761b38794fa7c774a085
-  data.tar.gz: 222fcad81c801c6f33f1ae91e005b6402f87549b30e4f62d5e587b800e888f2d
+  metadata.gz: b4ea3f1c85774246755120cb7697b3e8340562753aad2ea1161aad16d412221b
+  data.tar.gz: ff06dc6aafa7dfa3209a40b88322a6b07b2ce7e5d95cb1c78cbf66d7461a343a
 SHA512:
-  metadata.gz: 46b10d83dde0c430ff36e0a4a0ac49daab14426240c696a396e7687e762ebed642a06a7a0a97feb08707552f6723174837a99c36bcfb29b92206f262f9c45afe
-  data.tar.gz: 294bd08145cd0712de2899c2366b7e8c6783292cb837a1b397502410965cdb501e2c53198dcbd0a5814caecee87821be5d7b3cee9661193f0fc1cae3cca33e4a
+  metadata.gz: b1e66474138847aa04278a2295c67e5051eea4ffb11868badb64a020fd508bcb0bc2d72bc5cc66997d5cad3f862e558f40499112a1cf266d1107eecd6ef7c928
+  data.tar.gz: 762af4554836aef3df571b5977c60d2a37236ae8c4aee7fa0a0a74d4c60626e933df2057b88020ac6f741af15dfda1e935ab9478c1de29cf16085247309be5fb

data/.github/workflows/gem-push.yml

@@ -16,9 +16,9 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby 3.0
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.x
+        ruby-version: '3.0'
 
     - name: Publish to GPR
       run: |

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.7, '3.0', 3.1, head, truffleruby]
+        ruby: ['3.0', 3.1, 3.2, 3.3, head, truffleruby]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2025-01-20
+
+### Added
+- Support for Rails 8
+
+### Removed
+- Support for Rails 6
+- Dropped support for ruby 2.7
+- gem `solargraph`
+
+## [0.1.2] - 2022-12-10
+
+### Added
+- Documentation to all methods
+- `solargraph` gem for development
+
 ## [0.1.1] - 2022-11-30
 
 ### Fixed

data/auto_preload.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = "A gem to run nested preloads/includes from string."
   spec.homepage      = "https://github.com/monade/auto_preload"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.7"
+  spec.required_ruby_version = ">= 3.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "activerecord", [">= 5", "< 8"]
-  spec.add_dependency "activesupport", [">= 5", "< 8"]
+  spec.add_dependency "activerecord", [">= 6", "< 9"]
+  spec.add_dependency "activesupport", [">= 6", "< 9"]
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/auto_preload/active_record.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 module AutoPreload
+  # Extensions to ActiveRecord::Base
   module ActiveRecord
     extend ActiveSupport::Concern
 
     included do
+      # @param [String, Array<String>] inclusions
+      # @param [Hash] options
+      # @return [ActiveRecord::Relation]
       scope :auto_includes, lambda { |inclusions, options = {}|
         if inclusions.present?
           resolved = Resolver.new(options).resolve(self, inclusions)
@@ -13,6 +17,9 @@ module AutoPreload
           self
         end
       }
+      # @param [String, Array<String>] inclusions
+      # @param [Hash] options
+      # @return [ActiveRecord::Relation]
       scope :auto_preload, lambda { |inclusions, options = {}|
         if inclusions.present?
           resolved = Resolver.new(options).resolve(self, inclusions)
@@ -21,6 +28,9 @@ module AutoPreload
           self
         end
       }
+      # @param [String, Array<String>] inclusions
+      # @param [Hash] options
+      # @return [ActiveRecord::Relation]
       scope :auto_eager_load, lambda { |inclusions, options = {}|
         if inclusions.present?
           resolved = Resolver.new(options).resolve(self, inclusions)
@@ -30,6 +40,7 @@ module AutoPreload
         end
       }
 
+      # @return [nil, Array<Symbol>]
       class_attribute :auto_preloadable
     end
   end

data/lib/auto_preload/adapters/active_record.rb

@@ -4,6 +4,8 @@ module AutoPreload
   module Adapters
     # This class takes a model and finds all the preloadable associations.
     class ActiveRecord
+      # @param [ActiveRecord::Base] model
+      # @return [Array<ActiveRecord::Reflection>] The preloadable associations.
       def resolve_preloadables(model, _options = {})
         if model.auto_preloadable
           model.auto_preloadable.map { |w| model.reflect_on_association(w) }.compact

data/lib/auto_preload/adapters/serializer.rb

@@ -24,6 +24,11 @@ module AutoPreload
         end.compact
       end
 
+      # @param model [ActiveRecord::Base]
+      # @param options [Hash]
+      # @option options [Boolean] :root
+      # @option options [ActiveModel::Serializer] :serializer
+      # @return [ActiveModel::Serializer]
       def resolve_serializer(model, options = {})
         if options[:root]
           options[:serializer] || ActiveModel::Serializer.serializer_for(model)

data/lib/auto_preload/adapters.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module AutoPreload
+  # This module contains the adapters used to parse JSON::API include strings.
   module Adapters
     extend ActiveSupport::Autoload
 

data/lib/auto_preload/config.rb

@@ -3,7 +3,7 @@
 module AutoPreload
   # This class handles the gem configurations.
   class Config
-    # @attr_writr [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] adapter The adapter to use.
+    # @return [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] The adapter to use.
     attr_writer :adapter
 
     # @return [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] The adapter to use.

data/lib/auto_preload/resolver.rb

@@ -3,8 +3,13 @@
 module AutoPreload
   # This class parses a string in the format "articles,comments" and returns an array of symbols.
   class Resolver
+    # Default max number of iterations
+    # @return [Integer]
     MAX_ITERATIONS = 100
 
+    # @param options [Hash]
+    # @option options [Integer] :max_iterations
+    # @option options [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] :adapter
     def initialize(options = {})
       @iterations = 0
       @options = options
@@ -43,7 +48,7 @@ module AutoPreload
       objects.present? ? (symbols << objects) : symbols
     end
 
-    # @param list [Array<Hash>]
+    # @param objects [Array<Hash>]
     # @return [Hash]
     def merge(objects)
       objects.reduce({}) do |result, object|

data/lib/auto_preload/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module AutoPreload
-  VERSION = "0.1.1"
+  # @return [String] The version of the gem.
+  VERSION = "0.2.0"
 end

data/lib/auto_preload.rb

@@ -3,6 +3,8 @@
 require "active_support"
 require "active_record"
 
+# Provides methods to run `preload`/`includes`/`eager_load` on your model
+# from a JSON::API include string.
 module AutoPreload
   extend ActiveSupport::Autoload
 
@@ -11,13 +13,18 @@ module AutoPreload
   autoload :Resolver
   autoload :Config
 
+  # @yield [AutoPreload::Config]
+  # @return [AutoPreload::Config]
   def self.configure
     yield(config)
   end
 
+  # @return [AutoPreload::Config]
   def self.config
     @config ||= Config.new
   end
 end
 
-ActiveRecord::Base.include AutoPreload::ActiveRecord
+# rubocop:disable Lint/SendWithMixinArgument
+ActiveRecord::Base.send(:include, AutoPreload::ActiveRecord)
+# rubocop:enable Lint/SendWithMixinArgument

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto_preload
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Mònade
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 description: A gem to run nested preloads/includes from string.
 email:
 - team@monade.io
@@ -85,7 +85,7 @@ metadata:
   homepage_uri: https://github.com/monade/auto_preload
   source_code_uri: https://github.com/monade/auto_preload
   changelog_uri: https://github.com/monade/auto_preload/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A gem to run nested preloads/includes from string.
 test_files: []